# test all routes which lead to this controller
def test_routes
assert_routing(
- { :path => "/api/0.6/way/create", :method => :put },
- { :controller => "api/ways", :action => "create" }
+ { :path => "/api/0.6/ways", :method => :get },
+ { :controller => "api/ways", :action => "index" }
)
assert_routing(
- { :path => "/api/0.6/way/1/full", :method => :get },
- { :controller => "api/ways", :action => "full", :id => "1" }
+ { :path => "/api/0.6/ways.json", :method => :get },
+ { :controller => "api/ways", :action => "index", :format => "json" }
)
assert_routing(
- { :path => "/api/0.6/way/1/full.json", :method => :get },
- { :controller => "api/ways", :action => "full", :id => "1", :format => "json" }
+ { :path => "/api/0.6/ways", :method => :post },
+ { :controller => "api/ways", :action => "create" }
)
assert_routing(
{ :path => "/api/0.6/way/1", :method => :get },
{ :controller => "api/ways", :action => "show", :id => "1", :format => "json" }
)
assert_routing(
- { :path => "/api/0.6/way/1", :method => :put },
- { :controller => "api/ways", :action => "update", :id => "1" }
+ { :path => "/api/0.6/way/1/full", :method => :get },
+ { :controller => "api/ways", :action => "full", :id => "1" }
)
assert_routing(
- { :path => "/api/0.6/way/1", :method => :delete },
- { :controller => "api/ways", :action => "delete", :id => "1" }
+ { :path => "/api/0.6/way/1/full.json", :method => :get },
+ { :controller => "api/ways", :action => "full", :id => "1", :format => "json" }
)
assert_routing(
- { :path => "/api/0.6/ways", :method => :get },
- { :controller => "api/ways", :action => "index" }
+ { :path => "/api/0.6/way/1", :method => :put },
+ { :controller => "api/ways", :action => "update", :id => "1" }
)
assert_routing(
- { :path => "/api/0.6/ways.json", :method => :get },
- { :controller => "api/ways", :action => "index", :format => "json" }
+ { :path => "/api/0.6/way/1", :method => :delete },
+ { :controller => "api/ways", :action => "destroy", :id => "1" }
)
- end
-
- # -------------------------------------
- # Test showing ways.
- # -------------------------------------
-
- def test_show
- # check that a visible way is returned properly
- get api_way_path(create(:way))
- assert_response :success
-
- # check that an invisible way is not returned
- get api_way_path(create(:way, :deleted))
- assert_response :gone
-
- # check chat a non-existent way is not returned
- get api_way_path(:id => 0)
- assert_response :not_found
- end
- ##
- # check the "full" mode
- def test_full
- way = create(:way_with_nodes, :nodes_count => 3)
-
- get way_full_path(way)
-
- assert_response :success
-
- # Check the way is correctly returned
- assert_select "osm way[id='#{way.id}'][version='1'][visible='true']", 1
-
- # check that each node in the way appears once in the output as a
- # reference and as the node element.
- way.nodes.each do |n|
- assert_select "osm way nd[ref='#{n.id}']", 1
- assert_select "osm node[id='#{n.id}'][version='1'][lat='#{format('%<lat>.7f', :lat => n.lat)}'][lon='#{format('%<lon>.7f', :lon => n.lon)}']", 1
- end
- end
-
- def test_full_deleted
- way = create(:way, :deleted)
-
- get way_full_path(way)
-
- assert_response :gone
+ assert_recognizes(
+ { :controller => "api/ways", :action => "create" },
+ { :path => "/api/0.6/way/create", :method => :put }
+ )
end
##
way4 = create(:way)
# check error when no parameter provided
- get ways_path
+ get api_ways_path
assert_response :bad_request
# check error when no parameter value provided
- get ways_path, :params => { :ways => "" }
+ get api_ways_path(:ways => "")
assert_response :bad_request
# test a working call
- get ways_path, :params => { :ways => "#{way1.id},#{way2.id},#{way3.id},#{way4.id}" }
+ get api_ways_path(:ways => "#{way1.id},#{way2.id},#{way3.id},#{way4.id}")
assert_response :success
assert_select "osm" do
assert_select "way", :count => 4
end
# test a working call with json format
- get ways_path, :params => { :ways => "#{way1.id},#{way2.id},#{way3.id},#{way4.id}", :format => "json" }
+ get api_ways_path(:ways => "#{way1.id},#{way2.id},#{way3.id},#{way4.id}", :format => "json")
js = ActiveSupport::JSON.decode(@response.body)
assert_not_nil js
assert_equal 1, (js["elements"].count { |a| a["id"] == way4.id && a["visible"].nil? })
# check error when a non-existent way is included
- get ways_path, :params => { :ways => "#{way1.id},#{way2.id},#{way3.id},#{way4.id},0" }
+ get api_ways_path(:ways => "#{way1.id},#{way2.id},#{way3.id},#{way4.id},0")
assert_response :not_found
end
+ # -------------------------------------
+ # Test showing ways.
+ # -------------------------------------
+
+ def test_show_not_found
+ get api_way_path(0)
+ assert_response :not_found
+ end
+
+ def test_show_deleted
+ get api_way_path(create(:way, :deleted))
+ assert_response :gone
+ end
+
+ def test_show
+ way = create(:way, :timestamp => "2021-02-03T00:00:00Z")
+ node = create(:node, :timestamp => "2021-04-05T00:00:00Z")
+ create(:way_node, :way => way, :node => node)
+
+ get api_way_path(way)
+
+ assert_response :success
+ assert_not_nil @response.header["Last-Modified"]
+ assert_equal "2021-02-03T00:00:00Z", Time.parse(@response.header["Last-Modified"]).utc.xmlschema
+ end
+
+ def test_show_json
+ way = create(:way_with_nodes, :nodes_count => 3)
+
+ get api_way_path(way, :format => "json")
+
+ assert_response :success
+
+ js = ActiveSupport::JSON.decode(@response.body)
+ assert_not_nil js
+ assert_equal 1, js["elements"].count
+ js_ways = js["elements"].filter { |e| e["type"] == "way" }
+ assert_equal 1, js_ways.count
+ assert_equal way.id, js_ways[0]["id"]
+ assert_equal 1, js_ways[0]["version"]
+ end
+
+ ##
+ # check the "full" mode
+ def test_full
+ way = create(:way_with_nodes, :nodes_count => 3)
+
+ get way_full_path(way)
+
+ assert_response :success
+
+ # Check the way is correctly returned
+ assert_select "osm way[id='#{way.id}'][version='1'][visible='true']", 1
+
+ # check that each node in the way appears once in the output as a
+ # reference and as the node element.
+ way.nodes.each do |n|
+ assert_select "osm way nd[ref='#{n.id}']", 1
+ assert_select "osm node[id='#{n.id}'][version='1'][lat='#{format('%<lat>.7f', :lat => n.lat)}'][lon='#{format('%<lon>.7f', :lon => n.lon)}']", 1
+ end
+ end
+
+ def test_full_deleted
+ way = create(:way, :deleted)
+
+ get way_full_path(way)
+
+ assert_response :gone
+ end
+
# -------------------------------------
# Test simple way creation.
# -------------------------------------
changeset = create(:changeset, :user => user)
## First check that it fails when creating a way using a non-public user
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# use the first user's open changeset
changeset_id = private_changeset.id
xml = "<osm><way changeset='#{changeset_id}'>" \
"<nd ref='#{node1.id}'/><nd ref='#{node2.id}'/>" \
"<tag k='test' v='yes' /></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# hope for failure
assert_response :forbidden,
"way upload did not return forbidden status"
## Now use a public user
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# use the first user's open changeset
changeset_id = changeset.id
xml = "<osm><way changeset='#{changeset_id}'>" \
"<nd ref='#{node1.id}'/><nd ref='#{node2.id}'/>" \
"<tag k='test' v='yes' /></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# hope for success
assert_response :success,
"way upload did not return success status"
closed_changeset = create(:changeset, :closed, :user => user)
## First test with a private user to make sure that they are not authorized
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# use the first user's open changeset
# create a way with non-existing node
xml = "<osm><way changeset='#{private_open_changeset.id}'>" \
"<nd ref='0'/><tag k='test' v='yes' /></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :forbidden,
"way upload with invalid node using a private user did not return 'forbidden'"
# create a way with no nodes
xml = "<osm><way changeset='#{private_open_changeset.id}'>" \
"<tag k='test' v='yes' /></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :forbidden,
"way upload with no node using a private userdid not return 'forbidden'"
# create a way inside a closed changeset
xml = "<osm><way changeset='#{private_closed_changeset.id}'>" \
"<nd ref='#{node.id}'/></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :forbidden,
"way upload to closed changeset with a private user did not return 'forbidden'"
## Now test with a public user
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# use the first user's open changeset
# create a way with non-existing node
xml = "<osm><way changeset='#{open_changeset.id}'>" \
"<nd ref='0'/><tag k='test' v='yes' /></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :precondition_failed,
"way upload with invalid node did not return 'precondition failed'"
# create a way with no nodes
xml = "<osm><way changeset='#{open_changeset.id}'>" \
"<tag k='test' v='yes' /></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :precondition_failed,
"way upload with no node did not return 'precondition failed'"
# create a way inside a closed changeset
xml = "<osm><way changeset='#{closed_changeset.id}'>" \
"<nd ref='#{node.id}'/></way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :conflict,
"way upload to closed changeset did not return 'conflict'"
"<nd ref='#{node.id}'/>" \
"<tag k='foo' v='#{'x' * 256}'/>" \
"</way></osm>"
- put way_create_path, :params => xml, :headers => auth_header
+ post api_ways_path, :params => xml, :headers => auth_header
# expect failure
assert_response :bad_request,
"way upload to with too long tag did not return 'bad_request'"
# Test deleting ways.
# -------------------------------------
- def test_delete
+ def test_destroy
private_user = create(:user, :data_public => false)
private_open_changeset = create(:changeset, :user => private_user)
private_closed_changeset = create(:changeset, :closed, :user => private_user)
assert_response :unauthorized
# now set auth using the private user
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# this shouldn't work as with the 0.6 api we need pay load to delete
delete api_way_path(private_way), :headers => auth_header
"shouldn't be able to delete a way used in a relation (#{@response.body}), when done by a private user"
# this won't work since the way never existed
- delete api_way_path(:id => 0), :headers => auth_header
+ delete api_way_path(0), :headers => auth_header
assert_response :forbidden
### Now check with a public user
# now set auth
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# this shouldn't work as with the 0.6 api we need pay load to delete
delete api_way_path(way), :headers => auth_header
# check the returned value - should be the new version number
# valid delete should return the new version number, which should
# be greater than the old version number
- assert @response.body.to_i > way.version,
- "delete request should return a new version number for way"
+ assert_operator @response.body.to_i, :>, way.version, "delete request should return a new version number for way"
# this won't work since the way is already deleted
xml = xml_for_way(deleted_way)
assert_equal "Precondition failed: Way #{used_way.id} is still used by relations #{relation.id}.", @response.body
# this won't work since the way never existed
- delete api_way_path(:id => 0), :params => xml.to_s, :headers => auth_header
+ delete api_way_path(0), :params => xml.to_s, :headers => auth_header
assert_response :not_found
end
## Second test with the private user
# setup auth
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
## trying to break changesets
## Finally test with the public user
# setup auth
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
## trying to break changesets
## Try with the non-public user
# setup auth
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# add an identical tag to the way
tag_xml = XML::Node.new("tag")
## Now try with the public user
# setup auth
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# add an identical tag to the way
tag_xml = XML::Node.new("tag")
## Try with the non-public user
# setup auth
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# add an identical tag to the way
tag_xml = XML::Node.new("tag")
## Now try with the public user
# setup auth
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# add an identical tag to the way
tag_xml = XML::Node.new("tag")
## First test with the non-public user so should be rejected
# setup auth
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# create duplicate tag
tag_xml = XML::Node.new("tag")
## Now test with the public user
# setup auth
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# create duplicate tag
tag_xml = XML::Node.new("tag")
## First make sure that you can't with a non-public user
# setup auth
- auth_header = basic_authorization_header private_user.email, "test"
+ auth_header = bearer_authorization_header private_user
# add the tag into the existing xml
way_str = "<osm><way changeset='#{private_changeset.id}'>"
way_str << "</way></osm>"
# try and upload it
- put way_create_path, :params => way_str, :headers => auth_header
+ post api_ways_path, :params => way_str, :headers => auth_header
assert_response :forbidden,
"adding new duplicate tags to a way with a non-public user should fail with 'forbidden'"
## Now do it with a public user
# setup auth
- auth_header = basic_authorization_header user.email, "test"
+ auth_header = bearer_authorization_header user
# add the tag into the existing xml
way_str = "<osm><way changeset='#{changeset.id}'>"
way_str << "</way></osm>"
# try and upload it
- put way_create_path, :params => way_str, :headers => auth_header
+ post api_ways_path, :params => way_str, :headers => auth_header
assert_response :bad_request,
"adding new duplicate tags to a way should fail with 'bad request'"
assert_equal "Element way/ has duplicate tags with key addr:housenumber", @response.body
end
end
+ ##
+ # test initial rate limit
+ def test_initial_rate_limit
+ # create a user
+ user = create(:user)
+
+ # create some nodes
+ node1 = create(:node)
+ node2 = create(:node)
+
+ # create a changeset that puts us near the initial rate limit
+ changeset = create(:changeset, :user => user,
+ :created_at => Time.now.utc - 5.minutes,
+ :num_changes => Settings.initial_changes_per_hour - 1)
+
+ # create authentication header
+ auth_header = bearer_authorization_header user
+
+ # try creating a way
+ xml = "<osm><way changeset='#{changeset.id}'>" \
+ "<nd ref='#{node1.id}'/><nd ref='#{node2.id}'/>" \
+ "<tag k='test' v='yes' /></way></osm>"
+ post api_ways_path, :params => xml, :headers => auth_header
+ assert_response :success, "way create did not return success status"
+
+ # get the id of the way we created
+ wayid = @response.body
+
+ # try updating the way, which should be rate limited
+ xml = "<osm><way id='#{wayid}' version='1' changeset='#{changeset.id}'>" \
+ "<nd ref='#{node2.id}'/><nd ref='#{node1.id}'/>" \
+ "<tag k='test' v='yes' /></way></osm>"
+ put api_way_path(wayid), :params => xml, :headers => auth_header
+ assert_response :too_many_requests, "way update did not hit rate limit"
+
+ # try deleting the way, which should be rate limited
+ xml = "<osm><way id='#{wayid}' version='2' changeset='#{changeset.id}'/></osm>"
+ delete api_way_path(wayid), :params => xml, :headers => auth_header
+ assert_response :too_many_requests, "way delete did not hit rate limit"
+
+ # try creating a way, which should be rate limited
+ xml = "<osm><way changeset='#{changeset.id}'>" \
+ "<nd ref='#{node1.id}'/><nd ref='#{node2.id}'/>" \
+ "<tag k='test' v='yes' /></way></osm>"
+ post api_ways_path, :params => xml, :headers => auth_header
+ assert_response :too_many_requests, "way create did not hit rate limit"
+ end
+
+ ##
+ # test maximum rate limit
+ def test_maximum_rate_limit
+ # create a user
+ user = create(:user)
+
+ # create some nodes
+ node1 = create(:node)
+ node2 = create(:node)
+
+ # create a changeset to establish our initial edit time
+ changeset = create(:changeset, :user => user,
+ :created_at => Time.now.utc - 28.days)
+
+ # create changeset to put us near the maximum rate limit
+ total_changes = Settings.max_changes_per_hour - 1
+ while total_changes.positive?
+ changes = [total_changes, Changeset::MAX_ELEMENTS].min
+ changeset = create(:changeset, :user => user,
+ :created_at => Time.now.utc - 5.minutes,
+ :num_changes => changes)
+ total_changes -= changes
+ end
+
+ # create authentication header
+ auth_header = bearer_authorization_header user
+
+ # try creating a way
+ xml = "<osm><way changeset='#{changeset.id}'>" \
+ "<nd ref='#{node1.id}'/><nd ref='#{node2.id}'/>" \
+ "<tag k='test' v='yes' /></way></osm>"
+ post api_ways_path, :params => xml, :headers => auth_header
+ assert_response :success, "way create did not return success status"
+
+ # get the id of the way we created
+ wayid = @response.body
+
+ # try updating the way, which should be rate limited
+ xml = "<osm><way id='#{wayid}' version='1' changeset='#{changeset.id}'>" \
+ "<nd ref='#{node2.id}'/><nd ref='#{node1.id}'/>" \
+ "<tag k='test' v='yes' /></way></osm>"
+ put api_way_path(wayid), :params => xml, :headers => auth_header
+ assert_response :too_many_requests, "way update did not hit rate limit"
+
+ # try deleting the way, which should be rate limited
+ xml = "<osm><way id='#{wayid}' version='2' changeset='#{changeset.id}'/></osm>"
+ delete api_way_path(wayid), :params => xml, :headers => auth_header
+ assert_response :too_many_requests, "way delete did not hit rate limit"
+
+ # try creating a way, which should be rate limited
+ xml = "<osm><way changeset='#{changeset.id}'>" \
+ "<nd ref='#{node1.id}'/><nd ref='#{node2.id}'/>" \
+ "<tag k='test' v='yes' /></way></osm>"
+ post api_ways_path, :params => xml, :headers => auth_header
+ assert_response :too_many_requests, "way create did not hit rate limit"
+ end
+
private
##