cst1/openstreetmap-website
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make api create relation path resourceful

Browse source
This commit is contained in:
Anton Khorev 2025-02-01 13:45:57 +03:00
parent 2ad75d72af
commit b6c2a39363
2 changed files with 26 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

4
config/routes.rb
View file

@ -48,7 +48,6 @@ OpenStreetMap::Application.routes.draw do
put "way/:id" => "ways#update", :id => /\d+/ put "way/:id" => "ways#update", :id => /\d+/
delete "way/:id" => "ways#delete", :id => /\d+/ delete "way/:id" => "ways#delete", :id => /\d+/
put "relation/create" => "relations#create"
get "relation/:id/relations" => "relations#relations_for_relation", :as => :relation_relations, :id => /\d+/ get "relation/:id/relations" => "relations#relations_for_relation", :as => :relation_relations, :id => /\d+/
get "relation/:id/history" => "old_relations#history", :as => :api_relation_history, :id => /\d+/ get "relation/:id/history" => "old_relations#history", :as => :api_relation_history, :id => /\d+/
get "relation/:id/full" => "relations#full", :as => :relation_full, :id => /\d+/ get "relation/:id/full" => "relations#full", :as => :relation_full, :id => /\d+/
@ -66,7 +65,8 @@ OpenStreetMap::Application.routes.draw do
resources :ways, :only => [:index, :create] resources :ways, :only => [:index, :create]
put "way/create" => "ways#create", :as => nil put "way/create" => "ways#create", :as => nil
resources :relations, :only => :index resources :relations, :only => [:index, :create]
put "relation/create" => "relations#create", :as => nil
resource :map, :only => :show resource :map, :only => :show

43
test/controllers/api/relations_controller_test.rb
View file

@ -14,7 +14,7 @@ module Api
{ :controller => "api/relations", :action => "index", :format => "json" } { :controller => "api/relations", :action => "index", :format => "json" }
) )
assert_routing( assert_routing(
{ :path => "/api/0.6/relation/create", :method => :put }, { :path => "/api/0.6/relations", :method => :post },
{ :controller => "api/relations", :action => "create" } { :controller => "api/relations", :action => "create" }
) )
assert_routing( assert_routing(
@ -66,6 +66,11 @@ module Api
{ :path => "/api/0.6/relation/1/relations.json", :method => :get }, { :path => "/api/0.6/relation/1/relations.json", :method => :get },
{ :controller => "api/relations", :action => "relations_for_relation", :id => "1", :format => "json" } { :controller => "api/relations", :action => "relations_for_relation", :id => "1", :format => "json" }
) )
assert_recognizes(
{ :controller => "api/relations", :action => "create" },
{ :path => "/api/0.6/relation/create", :method => :put }
)
end end
## ##
@ -225,7 +230,7 @@ module Api
# create an relation without members # create an relation without members
xml = "<osm><relation changeset='#{private_changeset.id}'><tag k='test' v='yes' /></relation></osm>" xml = "<osm><relation changeset='#{private_changeset.id}'><tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for forbidden, due to user # hope for forbidden, due to user
assert_response :forbidden, assert_response :forbidden,
"relation upload should have failed with forbidden" "relation upload should have failed with forbidden"
@ -236,7 +241,7 @@ module Api
xml = "<osm><relation changeset='#{private_changeset.id}'>" \ xml = "<osm><relation changeset='#{private_changeset.id}'>" \
"<member ref='#{node.id}' type='node' role='some'/>" \ "<member ref='#{node.id}' type='node' role='some'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for forbidden due to user # hope for forbidden due to user
assert_response :forbidden, assert_response :forbidden,
"relation upload did not return forbidden status" "relation upload did not return forbidden status"
@ -246,7 +251,7 @@ module Api
# need a role attribute to be included # need a role attribute to be included
xml = "<osm><relation changeset='#{private_changeset.id}'>" \ xml = "<osm><relation changeset='#{private_changeset.id}'>" \
"<member ref='#{node.id}' type='node'/><tag k='test' v='yes' /></relation></osm>" "<member ref='#{node.id}' type='node'/><tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for forbidden due to user # hope for forbidden due to user
assert_response :forbidden, assert_response :forbidden,
"relation upload did not return forbidden status" "relation upload did not return forbidden status"
@ -257,7 +262,7 @@ module Api
"<member type='node' ref='#{node.id}' role='some'/>" \ "<member type='node' ref='#{node.id}' role='some'/>" \
"<member type='way' ref='#{way.id}' role='other'/>" \ "<member type='way' ref='#{way.id}' role='other'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for forbidden, due to user # hope for forbidden, due to user
assert_response :forbidden, assert_response :forbidden,
"relation upload did not return success status" "relation upload did not return success status"
@ -267,7 +272,7 @@ module Api
# create an relation without members # create an relation without members
xml = "<osm><relation changeset='#{changeset.id}'><tag k='test' v='yes' /></relation></osm>" xml = "<osm><relation changeset='#{changeset.id}'><tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for success # hope for success
assert_response :success, assert_response :success,
"relation upload did not return success status" "relation upload did not return success status"
@ -295,7 +300,7 @@ module Api
xml = "<osm><relation changeset='#{changeset.id}'>" \ xml = "<osm><relation changeset='#{changeset.id}'>" \
"<member ref='#{node.id}' type='node' role='some'/>" \ "<member ref='#{node.id}' type='node' role='some'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for success # hope for success
assert_response :success, assert_response :success,
"relation upload did not return success status" "relation upload did not return success status"
@ -323,7 +328,7 @@ module Api
# need a role attribute to be included # need a role attribute to be included
xml = "<osm><relation changeset='#{changeset.id}'>" \ xml = "<osm><relation changeset='#{changeset.id}'>" \
"<member ref='#{node.id}' type='node'/><tag k='test' v='yes' /></relation></osm>" "<member ref='#{node.id}' type='node'/><tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for success # hope for success
assert_response :success, assert_response :success,
"relation upload did not return success status" "relation upload did not return success status"
@ -352,7 +357,7 @@ module Api
"<member type='node' ref='#{node.id}' role='some'/>" \ "<member type='node' ref='#{node.id}' role='some'/>" \
"<member type='way' ref='#{way.id}' role='other'/>" \ "<member type='way' ref='#{way.id}' role='other'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# hope for success # hope for success
assert_response :success, assert_response :success,
"relation upload did not return success status" "relation upload did not return success status"
@ -472,7 +477,7 @@ module Api
xml = "<osm><relation changeset='#{changeset.id}'>" \ xml = "<osm><relation changeset='#{changeset.id}'>" \
"<member type='node' ref='0'/><tag k='test' v='yes' />" \ "<member type='node' ref='0'/><tag k='test' v='yes' />" \
"</relation></osm>" "</relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# expect failure # expect failure
assert_response :precondition_failed, assert_response :precondition_failed,
"relation upload with invalid node did not return 'precondition failed'" "relation upload with invalid node did not return 'precondition failed'"
@ -493,7 +498,7 @@ module Api
xml = "<osm><relation changeset='#{changeset.id}'>" \ xml = "<osm><relation changeset='#{changeset.id}'>" \
"<member type='type' ref='#{node.id}' role=''/>" \ "<member type='type' ref='#{node.id}' role=''/>" \
"<tag k='tester' v='yep'/></relation></osm>" "<tag k='tester' v='yep'/></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
# expect failure # expect failure
assert_response :bad_request assert_response :bad_request
assert_match(/Cannot parse valid relation from xml string/, @response.body) assert_match(/Cannot parse valid relation from xml string/, @response.body)
@ -757,7 +762,7 @@ module Api
OSM OSM
doc = XML::Parser.string(doc_str).parse doc = XML::Parser.string(doc_str).parse
put relation_create_path, :params => doc.to_s, :headers => auth_header post api_relations_path, :params => doc.to_s, :headers => auth_header
assert_response :success, "can't create a relation: #{@response.body}" assert_response :success, "can't create a relation: #{@response.body}"
relation_id = @response.body.to_i relation_id = @response.body.to_i
@ -818,13 +823,13 @@ module Api
## First try with the private user ## First try with the private user
auth_header = bearer_authorization_header private_user auth_header = bearer_authorization_header private_user
put relation_create_path, :params => doc.to_s, :headers => auth_header post api_relations_path, :params => doc.to_s, :headers => auth_header
assert_response :forbidden assert_response :forbidden
## Now try with the public user ## Now try with the public user
auth_header = bearer_authorization_header user auth_header = bearer_authorization_header user
put relation_create_path, :params => doc.to_s, :headers => auth_header post api_relations_path, :params => doc.to_s, :headers => auth_header
assert_response :success, "can't create a relation: #{@response.body}" assert_response :success, "can't create a relation: #{@response.body}"
relation_id = @response.body.to_i relation_id = @response.body.to_i
@ -857,7 +862,7 @@ module Api
doc = XML::Parser.string(doc_str).parse doc = XML::Parser.string(doc_str).parse
auth_header = bearer_authorization_header user auth_header = bearer_authorization_header user
put relation_create_path, :params => doc.to_s, :headers => auth_header post api_relations_path, :params => doc.to_s, :headers => auth_header
assert_response :success, "can't create a relation: #{@response.body}" assert_response :success, "can't create a relation: #{@response.body}"
relation_id = @response.body.to_i relation_id = @response.body.to_i
@ -929,7 +934,7 @@ module Api
"<member ref='#{node1.id}' type='node' role='some'/>" \ "<member ref='#{node1.id}' type='node' role='some'/>" \
"<member ref='#{node2.id}' type='node' role='some'/>" \ "<member ref='#{node2.id}' type='node' role='some'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
assert_response :success, "relation create did not return success status" assert_response :success, "relation create did not return success status"
# get the id of the relation we created # get the id of the relation we created
@ -953,7 +958,7 @@ module Api
"<member ref='#{node1.id}' type='node' role='some'/>" \ "<member ref='#{node1.id}' type='node' role='some'/>" \
"<member ref='#{node2.id}' type='node' role='some'/>" \ "<member ref='#{node2.id}' type='node' role='some'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
assert_response :too_many_requests, "relation create did not hit rate limit" assert_response :too_many_requests, "relation create did not hit rate limit"
end end
@ -989,7 +994,7 @@ module Api
"<member ref='#{node1.id}' type='node' role='some'/>" \ "<member ref='#{node1.id}' type='node' role='some'/>" \
"<member ref='#{node2.id}' type='node' role='some'/>" \ "<member ref='#{node2.id}' type='node' role='some'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
assert_response :success, "relation create did not return success status" assert_response :success, "relation create did not return success status"
# get the id of the relation we created # get the id of the relation we created
@ -1013,7 +1018,7 @@ module Api
"<member ref='#{node1.id}' type='node' role='some'/>" \ "<member ref='#{node1.id}' type='node' role='some'/>" \
"<member ref='#{node2.id}' type='node' role='some'/>" \ "<member ref='#{node2.id}' type='node' role='some'/>" \
"<tag k='test' v='yes' /></relation></osm>" "<tag k='test' v='yes' /></relation></osm>"
put relation_create_path, :params => xml, :headers => auth_header post api_relations_path, :params => xml, :headers => auth_header
assert_response :too_many_requests, "relation create did not hit rate limit" assert_response :too_many_requests, "relation create did not hit rate limit"
end end