Convert api element history actions to versions resources

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

diff --git a/test/controllers/api/old_relations_controller_test.rb b/test/controllers/api/old_relations_controller_test.rb
index 8e0907f928af284458d6c630c50f8208c6448918..506c6a1ed5314cf50cb397edfca95d052978c8e6 100644 (file)
--- a/test/controllers/api/old_relations_controller_test.rb
+++ b/test/controllers/api/old_relations_controller_test.rb
@@ -1,17 +1,25 @@
 require "test_helper"
 
 module Api
 require "test_helper"
 
 module Api

-  class OldRelationsControllerTest < ActionController::TestCase
+  class OldRelationsControllerTest < ActionDispatch::IntegrationTest

     ##
     # test all routes which lead to this controller
     def test_routes
       assert_routing(
         { :path => "/api/0.6/relation/1/history", :method => :get },
     ##
     # test all routes which lead to this controller
     def test_routes
       assert_routing(
         { :path => "/api/0.6/relation/1/history", :method => :get },

-        { :controller => "api/old_relations", :action => "history", :id => "1", :format => "xml" }
+        { :controller => "api/old_relations", :action => "index", :relation_id => "1" }
+      )
+      assert_routing(
+        { :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/2", :method => :get },
       )
       assert_routing(
         { :path => "/api/0.6/relation/1/2", :method => :get },

-        { :controller => "api/old_relations", :action => "version", :id => "1", :version => "2", :format => "xml" }
+        { :controller => "api/old_relations", :action => "show", :id => "1", :version => "2" }
+      )
+      assert_routing(
+        { :path => "/api/0.6/relation/1/2.json", :method => :get },
+        { :controller => "api/old_relations", :action => "show", :id => "1", :version => "2", :format => "json" }

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


@@ -19,19 +27,52 @@ module Api
       )
     end
 
       )
     end
 

-    # -------------------------------------
-    # Test reading old relations.
-    # -------------------------------------
-    def test_history
-      # check that a visible relations is returned properly
-      get :history, :params => { :id => create(:relation, :with_history).id }, :format => :xml
+    ##
+    # 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_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 :history, :params => { :id => 0 }, :format => :xml
+    ##
+    # check that a non-existent relations is not returned
+    def test_index_invalid
+      get api_relation_versions_path(0)

       assert_response :not_found
     end
 
       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.
     ##
     # test the redaction of an old version of a relation, while not being
     # authorised.


@@ -50,9 +91,9 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 

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

 
 

-      do_redact_relation(relation_v3, create(:redaction))
+      do_redact_relation(relation_v3, create(:redaction), auth_header)

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


@@ -63,12 +104,36 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_latest = relation.old_relations.last
 
       relation = create(:relation, :with_history, :version => 4)
       relation_latest = relation.old_relations.last
 

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

 
 

-      do_redact_relation(relation_latest, create(:redaction))
+      do_redact_relation(relation_latest, create(:redaction), auth_header)

       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
 

+    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 = 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_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_redactions_scope
+      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
+

     ##
     # test that redacted relations aren't visible, regardless of
     # authorisation except as moderator...
     ##
     # test that redacted relations aren't visible, regardless of
     # authorisation except as moderator...


@@ -77,34 +142,15 @@ module Api
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 

-      get :version, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }, :format => :xml
+      get api_old_relation_path(relation_v1.relation_id, relation_v1.version)

       assert_response :forbidden, "Redacted relation shouldn't be visible via the version API."
 
       # not even to a logged-in user
       assert_response :forbidden, "Redacted relation shouldn't be visible via the version API."
 
       # not even to a logged-in user

-      basic_authorization create(:user).email, "test"
-      get :version, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }, :format => :xml
+      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
 
       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 :history, :params => { :id => relation_v1.relation_id }, :format => :xml
-      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
-      basic_authorization create(:user).email, "test"
-      get :version, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }, :format => :xml
-      get :history, :params => { :id => relation_v1.relation_id }, :format => :xml
-      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.
     ##
     # test the redaction of an old version of a relation, while being
     # authorised as a moderator.


@@ -112,25 +158,27 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 

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

 
 

-      do_redact_relation(relation_v3, create(:redaction))
+      do_redact_relation(relation_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
       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 :version, :params => { :id => relation_v3.relation_id, :version => relation_v3.version }, :format => :xml
+      get api_old_relation_path(relation_v3.relation_id, relation_v3.version), :headers => auth_header

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

-      get :version, :params => { :id => relation_v3.relation_id, :version => relation_v3.version, :show_redactions => "true" }, :format => :xml
+      get api_old_relation_path(relation_v3.relation_id, relation_v3.version, :show_redactions => "true"), :headers => auth_header

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

-      get :history, :params => { :id => relation_v3.relation_id }, :format => :xml
+      get api_relation_versions_path(relation), :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 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 :history, :params => { :id => relation_v3.relation_id, :show_redactions => "true" }, :format => :xml
+      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_versions_path(relation, :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 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."
+      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."

     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


@@ -139,22 +187,23 @@ module Api
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 
       relation = create(:relation, :with_history, :version => 4)
       relation_v3 = relation.old_relations.find_by(:version => 3)
 

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

 
 

-      do_redact_relation(relation_v3, create(:redaction))
+      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
       assert_response :success, "should be OK to redact old version as moderator."
 
       # re-auth as non-moderator

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

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

-      get :version, :params => { :id => relation_v3.relation_id, :version => relation_v3.version }, :format => :xml
+      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
       assert_response :forbidden, "Redacted relation shouldn't be visible via the version API."
 
       # and when accessed via history

-      get :history, :params => { :id => relation_v3.relation_id }, :format => :xml
+      get api_relation_versions_path(relation), :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 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."
+      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."

     end
 
     ##
     end
 
     ##


@@ -165,7 +214,7 @@ module Api
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 

-      post :redact, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }
+      post relation_version_redact_path(relation_v1.relation_id, relation_v1.version)

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


@@ -177,9 +226,9 @@ module Api
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 

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

 
 

-      post :redact, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }
+      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."
     end
 
       assert_response :forbidden, "should need to be moderator to unredact."
     end
 


@@ -191,31 +240,33 @@ module Api
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 
       relation_v1 = relation.old_relations.find_by(:version => 1)
       relation_v1.redact!(create(:redaction))
 

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

 
 

-      post :redact, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }
+      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."
 
       # check moderator can still see the redacted data, without passing
       # the appropriate flag
       assert_response :success, "should be OK to unredact old version as moderator."
 
       # check moderator can still see the redacted data, without passing
       # the appropriate flag

-      get :version, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }, :format => :xml
+      get api_old_relation_path(relation_v1.relation_id, relation_v1.version), :headers => auth_header

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

-      get :history, :params => { :id => relation_v1.relation_id }, :format => :xml
+      get api_relation_versions_path(relation), :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 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."
+      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."

 
 

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

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

-      get :version, :params => { :id => relation_v1.relation_id, :version => relation_v1.version }, :format => :xml
+      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
       assert_response :success, "After redaction, node should not be gone for normal user."
 
       # and when accessed via history

-      get :history, :params => { :id => relation_v1.relation_id }, :format => :xml
+      get api_relation_versions_path(relation), :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 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."
+      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."

     end
 
     private
     end
 
     private


@@ -226,14 +277,14 @@ module Api
     def check_current_version(relation_id)
       # get the current version
       current_relation = with_controller(RelationsController.new) do
     def check_current_version(relation_id)
       # get the current version
       current_relation = with_controller(RelationsController.new) do

-        get :show, :params => { :id => relation_id }, :format => :xml
+        get :show, :params => { :id => relation_id }

         assert_response :success, "can't get current relation #{relation_id}"
         Relation.from_xml(@response.body)
       end
       assert_not_nil current_relation, "getting relation #{relation_id} returned nil"
 
       # get the "old" version of the relation from the version method
         assert_response :success, "can't get current relation #{relation_id}"
         Relation.from_xml(@response.body)
       end
       assert_not_nil current_relation, "getting relation #{relation_id} returned nil"
 
       # get the "old" version of the relation from the version method

-      get :version, :params => { :id => relation_id, :version => current_relation.version }, :format => :xml
+      get :version, :params => { :id => relation_id, :version => current_relation.version }

       assert_response :success, "can't get old relation #{relation_id}, v#{current_relation.version}"
       old_relation = Relation.from_xml(@response.body)
 
       assert_response :success, "can't get old relation #{relation_id}, v#{current_relation.version}"
       old_relation = Relation.from_xml(@response.body)
 


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

-      get :history, :params => { :id => relation_id }, :format => :xml
+      get :history, :params => { :id => relation_id }

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


@@ -254,7 +305,7 @@ module Api
         history_relation = Relation.from_xml_node(relation_doc)
         assert_not_nil history_relation, "parsing relation #{relation_id} version failed"
 
         history_relation = Relation.from_xml_node(relation_doc)
         assert_not_nil history_relation, "parsing relation #{relation_id} version failed"
 

-        get :version, :params => { :id => relation_id, :version => history_relation.version }, :format => :xml
+        get :version, :params => { :id => relation_id, :version => history_relation.version }

         assert_response :success, "couldn't get relation #{relation_id}, v#{history_relation.version}"
         version_relation = Relation.from_xml(@response.body)
         assert_not_nil version_relation, "failed to parse #{relation_id}, v#{history_relation.version}"
         assert_response :success, "couldn't get relation #{relation_id}, v#{history_relation.version}"
         version_relation = Relation.from_xml(@response.body)
         assert_not_nil version_relation, "failed to parse #{relation_id}, v#{history_relation.version}"


@@ -263,12 +314,18 @@ module Api
       end
     end
 
       end
     end
 

-    def do_redact_relation(relation, redaction)
-      get :version, :params => { :id => relation.relation_id, :version => relation.version }, :format => :xml
+    def do_redact_redactable_relation(headers = {})
+      relation = create(:relation, :with_history, :version => 4)
+      relation_v3 = relation.old_relations.find_by(:version => 3)
+      do_redact_relation(relation_v3, create(:redaction), headers)
+    end
+
+    def do_redact_relation(relation, redaction, headers = {})
+      get api_old_relation_path(relation.relation_id, relation.version)

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

-      post :redact, :params => { :id => relation.relation_id, :version => relation.version, :redaction => redaction.id }
+      post relation_version_redact_path(relation.relation_id, relation.version), :params => { :redaction => redaction.id }, :headers => headers

     end
   end
 end
     end
   end
 end