]> git.openstreetmap.org Git - rails.git/blobdiff - test/controllers/api/old_relations_controller_test.rb
Convert api element history actions to versions resources
[rails.git] / test / controllers / api / old_relations_controller_test.rb
index 892e52991a1feef0a5df0386c32d3c710444780d..506c6a1ed5314cf50cb397edfca95d052978c8e6 100644 (file)
@@ -7,15 +7,15 @@ module Api
     def test_routes
       assert_routing(
         { :path => "/api/0.6/relation/1/history", :method => :get },
-        { :controller => "api/old_relations", :action => "history", :id => "1" }
+        { :controller => "api/old_relations", :action => "index", :relation_id => "1" }
       )
       assert_routing(
-        { :path => "/api/0.6/relation/1/2", :method => :get },
-        { :controller => "api/old_relations", :action => "show", :id => "1", :version => "2" }
+        { :path => "/api/0.6/relation/1/history.json", :method => :get },
+        { :controller => "api/old_relations", :action => "index", :relation_id => "1", :format => "json" }
       )
       assert_routing(
-        { :path => "/api/0.6/relation/1/history.json", :method => :get },
-        { :controller => "api/old_relations", :action => "history", :id => "1", :format => "json" }
+        { :path => "/api/0.6/relation/1/2", :method => :get },
+        { :controller => "api/old_relations", :action => "show", :id => "1", :version => "2" }
       )
       assert_routing(
         { :path => "/api/0.6/relation/1/2.json", :method => :get },
@@ -27,19 +27,52 @@ module Api
       )
     end
 
-    # -------------------------------------
-    # Test reading old relations.
-    # -------------------------------------
-    def test_history
-      # check that a visible relations is returned properly
-      get api_relation_history_path(create(:relation, :with_history))
+    ##
+    # check that a visible relations is returned properly
+    def test_index
+      relation = create(:relation, :with_history, :version => 2)
+
+      get api_relation_versions_path(relation)
+
       assert_response :success
+      assert_dom "osm:root", 1 do
+        assert_dom "> relation", 2 do |dom_relations|
+          assert_dom dom_relations[0], "> @id", relation.id.to_s
+          assert_dom dom_relations[0], "> @version", "1"
+
+          assert_dom dom_relations[1], "> @id", relation.id.to_s
+          assert_dom dom_relations[1], "> @version", "2"
+        end
+      end
+    end
 
-      # check chat a non-existent relations is not returned
-      get api_relation_history_path(0)
+    ##
+    # check that a non-existent relations is not returned
+    def test_index_invalid
+      get api_relation_versions_path(0)
       assert_response :not_found
     end
 
+    ##
+    # test that redacted relations aren't visible in the history
+    def test_index_redacted
+      relation = create(:relation, :with_history, :version => 2)
+      relation_v1 = relation.old_relations.find_by(:version => 1)
+      relation_v1.redact!(create(:redaction))
+
+      get api_relation_versions_path(relation)
+      assert_response :success, "Redaction shouldn't have stopped history working."
+      assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 0,
+                    "redacted relation #{relation_v1.relation_id} version #{relation_v1.version} shouldn't be present in the history."
+
+      # not even to a logged-in user
+      auth_header = bearer_authorization_header
+      get api_relation_versions_path(relation), :headers => auth_header
+      assert_response :success, "Redaction shouldn't have stopped history working."
+      assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 0,
+                    "redacted relation #{relation_v1.relation_id} version #{relation_v1.version} shouldn't be present in the history, even when logged in."
+    end
+
     ##
     # test the redaction of an old version of a relation, while not being
     # authorised.
@@ -58,7 +91,7 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 
-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header
 
       do_redact_relation(relation_v3, create(:redaction), auth_header)
       assert_response :forbidden, "should need to be moderator to redact."
@@ -71,45 +104,32 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_latest = relation.old_relations.last
 
-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)
 
       do_redact_relation(relation_latest, create(:redaction), auth_header)
       assert_response :bad_request, "shouldn't be OK to redact current version as moderator."
     end
 
-    def test_redact_relation_by_regular_with_read_prefs_scope
-      auth_header = create_bearer_auth_header(create(:user), %w[read_prefs])
-      do_redact_redactable_relation(auth_header)
-      assert_response :forbidden, "should need to be moderator to redact."
-    end
-
-    def test_redact_relation_by_regular_with_write_api_scope
-      auth_header = create_bearer_auth_header(create(:user), %w[write_api])
+    def test_redact_relation_by_regular_without_write_redactions_scope
+      auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api])
       do_redact_redactable_relation(auth_header)
       assert_response :forbidden, "should need to be moderator to redact."
     end
 
     def test_redact_relation_by_regular_with_write_redactions_scope
-      auth_header = create_bearer_auth_header(create(:user), %w[write_redactions])
+      auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions])
       do_redact_redactable_relation(auth_header)
       assert_response :forbidden, "should need to be moderator to redact."
     end
 
-    def test_redact_relation_by_moderator_with_read_prefs_scope
-      auth_header = create_bearer_auth_header(create(:moderator_user), %w[read_prefs])
+    def test_redact_relation_by_moderator_without_write_redactions_scope
+      auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api])
       do_redact_redactable_relation(auth_header)
       assert_response :forbidden, "should need to have write_redactions scope to redact."
     end
 
-    def test_redact_relation_by_moderator_with_write_api_scope
-      auth_header = create_bearer_auth_header(create(:moderator_user), %w[write_api])
-      do_redact_redactable_relation(auth_header)
-      assert_response :success, "should be OK to redact old version as moderator with write_api scope."
-      # assert_response :forbidden, "should need to have write_redactions scope to redact."
-    end
-
     def test_redact_relation_by_moderator_with_write_redactions_scope
-      auth_header = create_bearer_auth_header(create(:moderator_user), %w[write_redactions])
+      auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions])
       do_redact_redactable_relation(auth_header)
       assert_response :success, "should be OK to redact old version as moderator with write_redactions scope."
     end
@@ -126,32 +146,11 @@ module Api
       assert_response :forbidden, "Redacted relation shouldn't be visible via the version API."
 
       # not even to a logged-in user
-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header
       get api_old_relation_path(relation_v1.relation_id, relation_v1.version), :headers => auth_header
       assert_response :forbidden, "Redacted relation shouldn't be visible via the version API, even when logged in."
     end
 
-    ##
-    # test that redacted relations aren't visible in the history
-    def test_history_redacted
-      relation = create(:relation, :with_history, :version => 2)
-      relation_v1 = relation.old_relations.find_by(:version => 1)
-      relation_v1.redact!(create(:redaction))
-
-      get api_relation_history_path(relation)
-      assert_response :success, "Redaction shouldn't have stopped history working."
-      assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 0,
-                    "redacted relation #{relation_v1.relation_id} version #{relation_v1.version} shouldn't be present in the history."
-
-      # not even to a logged-in user
-      auth_header = basic_authorization_header create(:user).email, "test"
-      get api_old_relation_path(relation_v1.relation_id, relation_v1.version), :headers => auth_header
-      get api_relation_history_path(relation), :headers => auth_header
-      assert_response :success, "Redaction shouldn't have stopped history working."
-      assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 0,
-                    "redacted relation #{relation_v1.relation_id} version #{relation_v1.version} shouldn't be present in the history, even when logged in."
-    end
-
     ##
     # test the redaction of an old version of a relation, while being
     # authorised as a moderator.
@@ -159,7 +158,7 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 
-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)
 
       do_redact_relation(relation_v3, create(:redaction), auth_header)
       assert_response :success, "should be OK to redact old version as moderator."
@@ -172,11 +171,11 @@ module Api
       assert_response :success, "After redaction, relation should not be gone for moderator, when flag passed."
 
       # and when accessed via history
-      get api_relation_history_path(relation), :headers => auth_header
+      get api_relation_versions_path(relation), :headers => auth_header
       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_select "osm relation[id='#{relation_v3.relation_id}'][version='#{relation_v3.version}']", 0,
                     "relation #{relation_v3.relation_id} version #{relation_v3.version} should not be present in the history for moderators when not passing flag."
-      get api_relation_history_path(relation, :show_redactions => "true"), :headers => auth_header
+      get api_relation_versions_path(relation, :show_redactions => "true"), :headers => auth_header
       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_select "osm relation[id='#{relation_v3.relation_id}'][version='#{relation_v3.version}']", 1,
                     "relation #{relation_v3.relation_id} version #{relation_v3.version} should still be present in the history for moderators when passing flag."
@@ -188,20 +187,20 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 
-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)
 
       do_redact_relation(relation_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
       get api_old_relation_path(relation_v3.relation_id, relation_v3.version), :headers => auth_header
       assert_response :forbidden, "Redacted relation shouldn't be visible via the version API."
 
       # and when accessed via history
-      get api_relation_history_path(relation), :headers => auth_header
+      get api_relation_versions_path(relation), :headers => auth_header
       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_select "osm relation[id='#{relation_v3.relation_id}'][version='#{relation_v3.version}']", 0,
                     "redacted relation #{relation_v3.relation_id} version #{relation_v3.version} shouldn't be present in the history."
@@ -227,7 +226,7 @@ module Api
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 
-      auth_header = basic_authorization_header create(:user).email, "test"
+      auth_header = bearer_authorization_header
 
       post relation_version_redact_path(relation_v1.relation_id, relation_v1.version), :headers => auth_header
       assert_response :forbidden, "should need to be moderator to unredact."
@@ -241,7 +240,7 @@ module Api
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 
-      auth_header = basic_authorization_header create(:moderator_user).email, "test"
+      auth_header = bearer_authorization_header create(:moderator_user)
 
       post relation_version_redact_path(relation_v1.relation_id, relation_v1.version), :headers => auth_header
       assert_response :success, "should be OK to unredact old version as moderator."
@@ -252,19 +251,19 @@ module Api
       assert_response :success, "After unredaction, relation should not be gone for moderator."
 
       # and when accessed via history
-      get api_relation_history_path(relation), :headers => auth_header
+      get api_relation_versions_path(relation), :headers => auth_header
       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 1,
                     "relation #{relation_v1.relation_id} version #{relation_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 redacted data
       get api_old_relation_path(relation_v1.relation_id, relation_v1.version), :headers => auth_header
       assert_response :success, "After redaction, node should not be gone for normal user."
 
       # and when accessed via history
-      get api_relation_history_path(relation), :headers => auth_header
+      get api_relation_versions_path(relation), :headers => auth_header
       assert_response :success, "Redaction shouldn't have stopped history working."
       assert_select "osm relation[id='#{relation_v1.relation_id}'][version='#{relation_v1.version}']", 1,
                     "relation #{relation_v1.relation_id} version #{relation_v1.version} should still be present in the history for normal users."
@@ -315,13 +314,6 @@ module Api
       end
     end
 
-    def create_bearer_auth_header(user, scopes)
-      token = create(:oauth_access_token,
-                     :resource_owner_id => user.id,
-                     :scopes => scopes)
-      bearer_authorization_header(token.token)
-    end
-
     def do_redact_redactable_relation(headers = {})
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)