Merge remote-tracking branch 'upstream/pull/5403'

[rails.git] / test / controllers / api / old_ways_controller_test.rb

diff --git a/test/controllers/api/old_ways_controller_test.rb b/test/controllers/api/old_ways_controller_test.rb
index c77117589956772af585e40a3ab2cb98c566a72c..6cfa1d3d8b960e6bc9d362644a8b5cbde59eeccf 100644 (file)
--- a/test/controllers/api/old_ways_controller_test.rb
+++ b/test/controllers/api/old_ways_controller_test.rb
@@ -7,51 +7,82 @@ module Api
     def test_routes
       assert_routing(
         { :path => "/api/0.6/way/1/history", :method => :get },
     def test_routes
       assert_routing(
         { :path => "/api/0.6/way/1/history", :method => :get },

-        { :controller => "api/old_ways", :action => "history", :id => "1" }
+        { :controller => "api/old_ways", :action => "index", :way_id => "1" }

       )
       assert_routing(
       )
       assert_routing(

-        { :path => "/api/0.6/way/1/2", :method => :get },
-        { :controller => "api/old_ways", :action => "version", :id => "1", :version => "2" }
+        { :path => "/api/0.6/way/1/history.json", :method => :get },
+        { :controller => "api/old_ways", :action => "index", :way_id => "1", :format => "json" }

       )
       assert_routing(
       )
       assert_routing(

-        { :path => "/api/0.6/way/1/history.json", :method => :get },
-        { :controller => "api/old_ways", :action => "history", :id => "1", :format => "json" }
+        { :path => "/api/0.6/way/1/2", :method => :get },
+        { :controller => "api/old_ways", :action => "show", :way_id => "1", :version => "2" }

       )
       assert_routing(
         { :path => "/api/0.6/way/1/2.json", :method => :get },
       )
       assert_routing(
         { :path => "/api/0.6/way/1/2.json", :method => :get },

-        { :controller => "api/old_ways", :action => "version", :id => "1", :version => "2", :format => "json" }
+        { :controller => "api/old_ways", :action => "show", :way_id => "1", :version => "2", :format => "json" }

       )
       assert_routing(
         { :path => "/api/0.6/way/1/2/redact", :method => :post },
       )
       assert_routing(
         { :path => "/api/0.6/way/1/2/redact", :method => :post },

-        { :controller => "api/old_ways", :action => "redact", :id => "1", :version => "2" }
+        { :controller => "api/old_ways", :action => "redact", :way_id => "1", :version => "2" }

       )
     end
 
       )
     end
 

-    # -------------------------------------
-    # Test reading old ways.
-    # -------------------------------------
+    ##
+    # check that a visible way is returned properly
+    def test_index
+      way = create(:way, :with_history, :version => 2)
+
+      get api_way_versions_path(way)

 
 

-    def test_history_visible
-      # check that a visible way is returned properly
-      get api_way_history_path(create(:way, :with_history))

       assert_response :success
       assert_response :success

+      assert_dom "osm:root", 1 do
+        assert_dom "> way", 2 do |dom_ways|
+          assert_dom dom_ways[0], "> @id", way.id.to_s
+          assert_dom dom_ways[0], "> @version", "1"
+
+          assert_dom dom_ways[1], "> @id", way.id.to_s
+          assert_dom dom_ways[1], "> @version", "2"
+        end
+      end

     end
 
     end
 

-    def test_history_invisible
-      # check that an invisible way's history is returned properly
-      get api_way_history_path(create(:way, :with_history, :deleted))
+    ##
+    # check that an invisible way's history is returned properly
+    def test_index_invisible
+      get api_way_versions_path(create(:way, :with_history, :deleted))

       assert_response :success
     end
 
       assert_response :success
     end
 

-    def test_history_invalid
-      # check chat a non-existent way is not returned
-      get api_way_history_path(:id => 0)
+    ##
+    # check chat a non-existent way is not returned
+    def test_index_invalid
+      get api_way_versions_path(0)

       assert_response :not_found
     end
 
       assert_response :not_found
     end
 

+    ##
+    # test that redacted ways aren't visible in the history
+    def test_index_redacted
+      way = create(:way, :with_history, :version => 2)
+      way_v1 = way.old_ways.find_by(:version => 1)
+      way_v1.redact!(create(:redaction))
+
+      get api_way_versions_path(way)
+      assert_response :success, "Redaction shouldn't have stopped history working."
+      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 0,
+                    "redacted way #{way_v1.way_id} version #{way_v1.version} shouldn't be present in the history."
+
+      # not even to a logged-in user
+      auth_header = bearer_authorization_header
+      get api_way_versions_path(way), :headers => auth_header
+      assert_response :success, "Redaction shouldn't have stopped history working."
+      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 0,
+                    "redacted node #{way_v1.way_id} version #{way_v1.version} shouldn't be present in the history, even when logged in."
+    end
+

     ##
     # check that we can retrieve versions of a way
     ##
     # check that we can retrieve versions of a way

-    def test_version
+    def test_show

       way = create(:way, :with_history)
       used_way = create(:way, :with_history)
       create(:relation_member, :member => used_way)
       way = create(:way, :with_history)
       used_way = create(:way, :with_history)
       create(:relation_member, :member => used_way)


@@ -69,6 +100,23 @@ module Api
       check_current_version(way_with_versions.id)
     end
 
       check_current_version(way_with_versions.id)
     end
 

+    ##
+    # test that redacted ways aren't visible, regardless of
+    # authorisation except as moderator...
+    def test_show_redacted
+      way = create(:way, :with_history, :version => 2)
+      way_v1 = way.old_ways.find_by(:version => 1)
+      way_v1.redact!(create(:redaction))
+
+      get api_way_version_path(way_v1.way_id, way_v1.version)
+      assert_response :forbidden, "Redacted way shouldn't be visible via the version API."
+
+      # not even to a logged-in user
+      auth_header = bearer_authorization_header
+      get api_way_version_path(way_v1.way_id, way_v1.version), :headers => auth_header
+      assert_response :forbidden, "Redacted way shouldn't be visible via the version API, even when logged in."
+    end
+

     ##
     # check that returned history is the same as getting all
     # versions of a way from the api.
     ##
     # check that returned history is the same as getting all
     # versions of a way from the api.


@@ -98,7 +146,7 @@ module Api
     # test the redaction of an old version of a way, while being
     # authorised as a normal user.
     def test_redact_way_normal_user
     # test the redaction of an old version of a way, while being
     # authorised as a normal user.
     def test_redact_way_normal_user

-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header

       way = create(:way, :with_history, :version => 4)
       way_v3 = way.old_ways.find_by(:version => 3)
 
       way = create(:way, :with_history, :version => 4)
       way_v3 = way.old_ways.find_by(:version => 3)
 


@@ -110,7 +158,7 @@ module Api
     # test that, even as moderator, the current version of a way
     # can't be redacted.
     def test_redact_way_current_version
     # test that, even as moderator, the current version of a way
     # can't be redacted.
     def test_redact_way_current_version

-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)

       way = create(:way, :with_history, :version => 4)
       way_latest = way.old_ways.last
 
       way = create(:way, :with_history, :version => 4)
       way_latest = way.old_ways.last
 


@@ -118,40 +166,28 @@ module Api
       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
     end
 
       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
     end
 

-    ##
-    # test that redacted ways aren't visible, regardless of
-    # authorisation except as moderator...
-    def test_version_redacted
-      way = create(:way, :with_history, :version => 2)
-      way_v1 = way.old_ways.find_by(:version => 1)
-      way_v1.redact!(create(:redaction))
-
-      get way_version_path(:id => way_v1.way_id, :version => way_v1.version)
-      assert_response :forbidden, "Redacted way shouldn't be visible via the version API."
-
-      # not even to a logged-in user
-      auth_header = basic_authorization_header create(:user).email, "test"
-      get way_version_path(:id => way_v1.way_id, :version => way_v1.version), :headers => auth_header
-      assert_response :forbidden, "Redacted way shouldn't be visible via the version API, even when logged in."
+    def test_redact_way_by_regular_without_write_redactions_scope
+      auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api])
+      do_redact_redactable_way(auth_header)
+      assert_response :forbidden, "should need to be moderator to redact."

     end
 
     end
 

-    ##
-    # test that redacted ways aren't visible in the history
-    def test_history_redacted
-      way = create(:way, :with_history, :version => 2)
-      way_v1 = way.old_ways.find_by(:version => 1)
-      way_v1.redact!(create(:redaction))
+    def test_redact_way_by_regular_with_write_redactions_scope
+      auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions])
+      do_redact_redactable_way(auth_header)
+      assert_response :forbidden, "should need to be moderator to redact."
+    end

 
 

-      get api_way_history_path(:id => way_v1.way_id)
-      assert_response :success, "Redaction shouldn't have stopped history working."
-      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 0, "redacted way #{way_v1.way_id} version #{way_v1.version} shouldn't be present in the history."
+    def test_redact_way_by_moderator_without_write_redactions_scope
+      auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api])
+      do_redact_redactable_way(auth_header)
+      assert_response :forbidden, "should need to have write_redactions scope to redact."
+    end

 
 

-      # not even to a logged-in user
-      auth_header = basic_authorization_header create(:user).email, "test"
-      get way_version_path(:id => way_v1.way_id, :version => way_v1.version), :headers => auth_header
-      get api_way_history_path(:id => way_v1.way_id), :headers => auth_header
-      assert_response :success, "Redaction shouldn't have stopped history working."
-      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 0, "redacted node #{way_v1.way_id} version #{way_v1.version} shouldn't be present in the history, even when logged in."
+    def test_redact_way_by_moderator_with_write_redactions_scope
+      auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions])
+      do_redact_redactable_way(auth_header)
+      assert_response :success, "should be OK to redact old version as moderator with write_redactions scope."

     end
 
     ##
     end
 
     ##


@@ -160,25 +196,27 @@ module Api
     def test_redact_way_moderator
       way = create(:way, :with_history, :version => 4)
       way_v3 = way.old_ways.find_by(:version => 3)
     def test_redact_way_moderator
       way = create(:way, :with_history, :version => 4)
       way_v3 = way.old_ways.find_by(:version => 3)

-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)

 
       do_redact_way(way_v3, create(:redaction), auth_header)
       assert_response :success, "should be OK to redact old version as moderator."
 
       # check moderator can still see the redacted data, when passing
       # the appropriate flag
 
       do_redact_way(way_v3, create(:redaction), auth_header)
       assert_response :success, "should be OK to redact old version as moderator."
 
       # check moderator can still see the redacted data, when passing
       # the appropriate flag

-      get way_version_path(:id => way_v3.way_id, :version => way_v3.version), :headers => auth_header
+      get api_way_version_path(way_v3.way_id, way_v3.version), :headers => auth_header

       assert_response :forbidden, "After redaction, node should be gone for moderator, when flag not passed."
       assert_response :forbidden, "After redaction, node should be gone for moderator, when flag not passed."

-      get way_version_path(:id => way_v3.way_id, :version => way_v3.version), :params => { :show_redactions => "true" }, :headers => auth_header
+      get api_way_version_path(way_v3.way_id, way_v3.version, :show_redactions => "true"), :headers => auth_header

       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 
       # and when accessed via history
       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 
       # and when accessed via history

-      get api_way_history_path(:id => way_v3.way_id), :headers => auth_header
+      get api_way_versions_path(way), :headers => auth_header

       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_response :success, "Redaction shouldn't have stopped history working."

-      assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 0, "way #{way_v3.way_id} version #{way_v3.version} should not be present in the history for moderators when not passing flag."
-      get api_way_history_path(:id => way_v3.way_id), :params => { :show_redactions => "true" }, :headers => auth_header
+      assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 0,
+                    "way #{way_v3.way_id} version #{way_v3.version} should not be present in the history for moderators when not passing flag."
+      get api_way_versions_path(way, :show_redactions => "true"), :headers => auth_header

       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_response :success, "Redaction shouldn't have stopped history working."

-      assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 1, "way #{way_v3.way_id} version #{way_v3.version} should still be present in the history for moderators when passing flag."
+      assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 1,
+                    "way #{way_v3.way_id} version #{way_v3.version} should still be present in the history for moderators when passing flag."

     end
 
     # testing that if the moderator drops auth, he can't see the
     end
 
     # testing that if the moderator drops auth, he can't see the


@@ -186,22 +224,23 @@ module Api
     def test_redact_way_is_redacted
       way = create(:way, :with_history, :version => 4)
       way_v3 = way.old_ways.find_by(:version => 3)
     def test_redact_way_is_redacted
       way = create(:way, :with_history, :version => 4)
       way_v3 = way.old_ways.find_by(:version => 3)

-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)

 
       do_redact_way(way_v3, create(:redaction), auth_header)
       assert_response :success, "should be OK to redact old version as moderator."
 
       # re-auth as non-moderator
 
       do_redact_way(way_v3, create(:redaction), auth_header)
       assert_response :success, "should be OK to redact old version as moderator."
 
       # re-auth as non-moderator

-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header

 
       # check can't see the redacted data
 
       # check can't see the redacted data

-      get way_version_path(:id => way_v3.way_id, :version => way_v3.version), :headers => auth_header
+      get api_way_version_path(way_v3.way_id, way_v3.version), :headers => auth_header

       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 
       # and when accessed via history
       assert_response :forbidden, "Redacted node shouldn't be visible via the version API."
 
       # and when accessed via history

-      get api_way_history_path(:id => way_v3.way_id), :headers => auth_header
+      get api_way_versions_path(way), :headers => auth_header

       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_response :success, "Redaction shouldn't have stopped history working."

-      assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 0, "redacted way #{way_v3.way_id} version #{way_v3.version} shouldn't be present in the history."
+      assert_select "osm way[id='#{way_v3.way_id}'][version='#{way_v3.version}']", 0,
+                    "redacted way #{way_v3.way_id} version #{way_v3.version} shouldn't be present in the history."

     end
 
     ##
     end
 
     ##


@@ -212,7 +251,7 @@ module Api
       way_v1 = way.old_ways.find_by(:version => 1)
       way_v1.redact!(create(:redaction))
 
       way_v1 = way.old_ways.find_by(:version => 1)
       way_v1.redact!(create(:redaction))
 

-      post way_version_redact_path(:id => way_v1.way_id, :version => way_v1.version)
+      post way_version_redact_path(way_v1.way_id, way_v1.version)

       assert_response :unauthorized, "should need to be authenticated to unredact."
     end
 
       assert_response :unauthorized, "should need to be authenticated to unredact."
     end
 


@@ -224,9 +263,9 @@ module Api
       way_v1 = way.old_ways.find_by(:version => 1)
       way_v1.redact!(create(:redaction))
 
       way_v1 = way.old_ways.find_by(:version => 1)
       way_v1.redact!(create(:redaction))
 

-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header

 
 

-      post way_version_redact_path(:id => way_v1.way_id, :version => way_v1.version), :headers => auth_header
+      post way_version_redact_path(way_v1.way_id, way_v1.version), :headers => auth_header

       assert_response :forbidden, "should need to be moderator to unredact."
     end
 
       assert_response :forbidden, "should need to be moderator to unredact."
     end
 


@@ -239,31 +278,33 @@ module Api
       way_v1 = way.old_ways.find_by(:version => 1)
       way_v1.redact!(create(:redaction))
 
       way_v1 = way.old_ways.find_by(:version => 1)
       way_v1.redact!(create(:redaction))
 

-      auth_header = basic_authorization_header moderator_user.email, "test"
+      auth_header = bearer_authorization_header moderator_user

 
 

-      post way_version_redact_path(:id => way_v1.way_id, :version => way_v1.version), :headers => auth_header
+      post way_version_redact_path(way_v1.way_id, way_v1.version), :headers => auth_header

       assert_response :success, "should be OK to unredact old version as moderator."
 
       # check moderator can still see the unredacted data, without passing
       # the appropriate flag
       assert_response :success, "should be OK to unredact old version as moderator."
 
       # check moderator can still see the unredacted data, without passing
       # the appropriate flag

-      get way_version_path(:id => way_v1.way_id, :version => way_v1.version), :headers => auth_header
+      get api_way_version_path(way_v1.way_id, way_v1.version), :headers => auth_header

       assert_response :success, "After unredaction, node should not be gone for moderator."
 
       # and when accessed via history
       assert_response :success, "After unredaction, node should not be gone for moderator."
 
       # and when accessed via history

-      get api_way_history_path(:id => way_v1.way_id), :headers => auth_header
+      get api_way_versions_path(way), :headers => auth_header

       assert_response :success, "Unredaction shouldn't have stopped history working."
       assert_response :success, "Unredaction shouldn't have stopped history working."

-      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 1, "way #{way_v1.way_id} version #{way_v1.version} should still be present in the history for moderators."
+      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 1,
+                    "way #{way_v1.way_id} version #{way_v1.version} should still be present in the history for moderators."

 
 

-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header

 
       # check normal user can now see the unredacted data
 
       # check normal user can now see the unredacted data

-      get way_version_path(:id => way_v1.way_id, :version => way_v1.version), :headers => auth_header
+      get api_way_version_path(way_v1.way_id, way_v1.version), :headers => auth_header

       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 
       # and when accessed via history
       assert_response :success, "After redaction, node should not be gone for moderator, when flag passed."
 
       # and when accessed via history

-      get api_way_history_path(:id => way_v1.way_id), :headers => auth_header
+      get api_way_versions_path(way), :headers => auth_header

       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_response :success, "Redaction shouldn't have stopped history working."

-      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 1, "way #{way_v1.way_id} version #{way_v1.version} should still be present in the history for normal users."
+      assert_select "osm way[id='#{way_v1.way_id}'][version='#{way_v1.version}']", 1,
+                    "way #{way_v1.way_id} version #{way_v1.version} should still be present in the history for normal users."

     end
 
     private
     end
 
     private


@@ -281,7 +322,7 @@ module Api
       assert_not_nil current_way, "getting way #{way_id} returned nil"
 
       # get the "old" version of the way from the version method
       assert_not_nil current_way, "getting way #{way_id} returned nil"
 
       # get the "old" version of the way from the version method

-      get way_version_path(:id => way_id, :version => current_way.version)
+      get api_way_version_path(way_id, current_way.version)

       assert_response :success, "can't get old way #{way_id}, v#{current_way.version}"
       old_way = Way.from_xml(@response.body)
 
       assert_response :success, "can't get old way #{way_id}, v#{current_way.version}"
       old_way = Way.from_xml(@response.body)
 


@@ -293,7 +334,7 @@ module Api
     # look at all the versions of the way in the history and get each version from
     # the versions call. check that they're the same.
     def check_history_equals_versions(way_id)
     # look at all the versions of the way in the history and get each version from
     # the versions call. check that they're the same.
     def check_history_equals_versions(way_id)

-      get api_way_history_path(:id => way_id)
+      get api_way_versions_path(way_id)

       assert_response :success, "can't get way #{way_id} from API"
       history_doc = XML::Parser.string(@response.body).parse
       assert_not_nil history_doc, "parsing way #{way_id} history failed"
       assert_response :success, "can't get way #{way_id} from API"
       history_doc = XML::Parser.string(@response.body).parse
       assert_not_nil history_doc, "parsing way #{way_id} history failed"


@@ -302,7 +343,7 @@ module Api
         history_way = Way.from_xml_node(way_doc)
         assert_not_nil history_way, "parsing way #{way_id} version failed"
 
         history_way = Way.from_xml_node(way_doc)
         assert_not_nil history_way, "parsing way #{way_id} version failed"
 

-        get way_version_path(:id => way_id, :version => history_way.version)
+        get api_way_version_path(way_id, history_way.version)

         assert_response :success, "couldn't get way #{way_id}, v#{history_way.version}"
         version_way = Way.from_xml(@response.body)
         assert_not_nil version_way, "failed to parse #{way_id}, v#{history_way.version}"
         assert_response :success, "couldn't get way #{way_id}, v#{history_way.version}"
         version_way = Way.from_xml(@response.body)
         assert_not_nil version_way, "failed to parse #{way_id}, v#{history_way.version}"


@@ -311,12 +352,18 @@ module Api
       end
     end
 
       end
     end
 

+    def do_redact_redactable_way(headers = {})
+      way = create(:way, :with_history, :version => 4)
+      way_v3 = way.old_ways.find_by(:version => 3)
+      do_redact_way(way_v3, create(:redaction), headers)
+    end
+

     def do_redact_way(way, redaction, headers = {})
     def do_redact_way(way, redaction, headers = {})

-      get way_version_path(:id => way.way_id, :version => way.version)
+      get api_way_version_path(way.way_id, way.version)

       assert_response :success, "should be able to get version #{way.version} of way #{way.way_id}."
 
       # now redact it
       assert_response :success, "should be able to get version #{way.version} of way #{way.way_id}."
 
       # now redact it

-      post way_version_redact_path(:id => way.way_id, :version => way.version), :params => { :redaction => redaction.id }, :headers => headers
+      post way_version_redact_path(way.way_id, way.version), :params => { :redaction => redaction.id }, :headers => headers

     end
 
     def propagate_tags(way, old_way)
     end
 
     def propagate_tags(way, old_way)