From 984dd624dd27140ea554c305117fd5a175a595a2 Mon Sep 17 00:00:00 2001 From: Anton Khorev Date: Tue, 11 Feb 2025 04:33:27 +0300 Subject: [PATCH] Create node version redaction resource --- app/abilities/api_ability.rb | 2 +- .../api/old_nodes/redactions_controller.rb | 11 ++ config/routes.rb | 7 +- .../old_nodes/redactions_controller_test.rb | 171 ++++++++++++++++++ .../api/old_nodes_controller_test.rb | 127 ------------- 5 files changed, 187 insertions(+), 131 deletions(-) create mode 100644 app/controllers/api/old_nodes/redactions_controller.rb create mode 100644 test/controllers/api/old_nodes/redactions_controller_test.rb diff --git a/app/abilities/api_ability.rb b/app/abilities/api_ability.rb index 179c2531a..08ec993dc 100644 --- a/app/abilities/api_ability.rb +++ b/app/abilities/api_ability.rb @@ -44,7 +44,7 @@ class ApiAbility can :destroy, Note if scopes.include?("write_notes") - can :redact, [OldNode, OldWay, OldRelation] if user.terms_agreed? && scopes.include?("write_redactions") + can :redact, [OldWay, OldRelation] if user.terms_agreed? && scopes.include?("write_redactions") can [:create, :destroy], :element_version_redaction if user.terms_agreed? && scopes.include?("write_redactions") can :create, UserBlock if scopes.include?("write_blocks") diff --git a/app/controllers/api/old_nodes/redactions_controller.rb b/app/controllers/api/old_nodes/redactions_controller.rb new file mode 100644 index 000000000..037c3ae45 --- /dev/null +++ b/app/controllers/api/old_nodes/redactions_controller.rb @@ -0,0 +1,11 @@ +module Api + module OldNodes + class RedactionsController < OldElements::RedactionsController + private + + def lookup_old_element + @old_element = OldNode.find([params[:node_id], params[:version]]) + end + end + end +end diff --git a/config/routes.rb b/config/routes.rb index 0ffd0a546..db67eed98 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -30,8 +30,6 @@ OpenStreetMap::Application.routes.draw do post "changeset/comment/:id/hide" => "changeset_comments#destroy", :as => :changeset_comment_hide, :id => /\d+/ post "changeset/comment/:id/unhide" => "changeset_comments#restore", :as => :changeset_comment_unhide, :id => /\d+/ - post "node/:node_id/:version/redact" => "old_nodes#redact", :as => :node_version_redact, :version => /\d+/, :node_id => /\d+/ - post "way/:way_id/:version/redact" => "old_ways#redact", :as => :way_version_redact, :version => /\d+/, :id => /\d+/ post "relation/:relation_id/:version/redact" => "old_relations#redact", :as => :relation_version_redact, :version => /\d+/, :id => /\d+/ @@ -47,9 +45,12 @@ OpenStreetMap::Application.routes.draw do resources :relations, :only => :index end resources :versions, :path => "history", :controller => :old_nodes, :only => :index - resources :versions, :path => "", :version => /\d+/, :param => :version, :controller => :old_nodes, :only => :show + resource :version, :path => ":version", :version => /\d+/, :controller => :old_nodes, :only => :show do + resource :redaction, :module => :old_nodes, :only => [:create, :destroy] + end end put "node/create" => "nodes#create", :as => nil + post "node/:node_id/:version/redact" => "old_nodes/redactions#create", :node_id => /\d+/, :version => /\d+/, :allow_delete => true, :as => nil resources :ways, :only => [:index, :create] resources :ways, :path => "way", :id => /\d+/, :only => [:show, :update, :destroy] do diff --git a/test/controllers/api/old_nodes/redactions_controller_test.rb b/test/controllers/api/old_nodes/redactions_controller_test.rb new file mode 100644 index 000000000..8a4ab79ba --- /dev/null +++ b/test/controllers/api/old_nodes/redactions_controller_test.rb @@ -0,0 +1,171 @@ +require "test_helper" + +module Api + module OldNodes + class RedactionsControllerTest < ActionDispatch::IntegrationTest + ## + # test all routes which lead to this controller + def test_routes + assert_routing( + { :path => "/api/0.6/node/1/2/redaction", :method => :post }, + { :controller => "api/old_nodes/redactions", :action => "create", :node_id => "1", :version => "2" } + ) + assert_routing( + { :path => "/api/0.6/node/1/2/redaction", :method => :delete }, + { :controller => "api/old_nodes/redactions", :action => "destroy", :node_id => "1", :version => "2" } + ) + + assert_recognizes( + { :controller => "api/old_nodes/redactions", :action => "create", :node_id => "1", :version => "2", :allow_delete => true }, + { :path => "/api/0.6/node/1/2/redact", :method => :post } + ) + end + + ## + # test that, even as moderator, the current version of a node + # can't be redacted. + def test_create_on_current_version + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 2) + redaction = create(:redaction) + auth_header = bearer_authorization_header create(:moderator_user) + + post api_node_version_redaction_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :bad_request, "shouldn't be OK to redact current version as moderator." + assert_nil old_node.reload.redaction + end + + def test_create_without_redaction_id + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + auth_header = bearer_authorization_header create(:moderator_user) + + post api_node_version_redaction_path(*old_node.id), :headers => auth_header + + assert_response :bad_request, "should need redaction ID to redact." + assert_nil old_node.reload.redaction + end + + ## + # test the redaction of an old version of a node, while not being + # authorised. + def test_create_by_unauthorised + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + + post api_node_version_redaction_path(*old_node.id), :params => { :redaction => redaction.id } + + assert_response :unauthorized, "should need to be authenticated to redact." + assert_nil old_node.reload.redaction + end + + def test_create_by_normal_user_without_write_redactions_scope + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header create(:user), :scopes => %w[read_prefs write_api] + + post api_node_version_redaction_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :forbidden, "should need to be moderator to redact." + assert_nil old_node.reload.redaction + end + + def test_create_by_normal_user_with_write_redactions_scope + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header create(:user), :scopes => %w[write_redactions] + + post api_node_version_redaction_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :forbidden, "should need to be moderator to redact." + assert_nil old_node.reload.redaction + end + + def test_create_by_moderator_without_write_redactions_scope + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[read_prefs write_api] + + post api_node_version_redaction_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :forbidden, "should need to have write_redactions scope to redact." + assert_nil old_node.reload.redaction + end + + def test_create_by_moderator_with_write_redactions_scope + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + auth_header = bearer_authorization_header create(:moderator_user), :scopes => %w[write_redactions] + + post api_node_version_redaction_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header + + assert_response :success, "should be OK to redact old version as moderator with write_redactions scope." + assert_equal redaction, old_node.reload.redaction + end + + ## + # test the unredaction of an old version of a node, while not being + # authorised. + def test_destroy_by_unauthorised + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + old_node.redact!(redaction) + + delete api_node_version_redaction_path(*old_node.id) + + assert_response :unauthorized, "should need to be authenticated to unredact." + assert_equal redaction, old_node.reload.redaction + end + + ## + # test the unredaction of an old version of a node, while being + # authorised as a normal user. + def test_destroy_by_normal_user + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + redaction = create(:redaction) + old_node.redact!(redaction) + auth_header = bearer_authorization_header + + delete api_node_version_redaction_path(*old_node.id), :headers => auth_header + + assert_response :forbidden, "should need to be moderator to unredact." + assert_equal redaction, old_node.reload.redaction + end + + ## + # test the unredaction of an old version of a node, while being + # authorised as a moderator. + def test_destroy_by_moderator + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + old_node.redact!(create(:redaction)) + auth_header = bearer_authorization_header create(:moderator_user) + + delete api_node_version_redaction_path(*old_node.id), :headers => auth_header + + assert_response :success, "should be OK to unredact old version as moderator." + assert_nil old_node.reload.redaction + end + + def test_destroy_at_legacy_route + node = create(:node, :with_history, :version => 2) + old_node = node.old_nodes.find_by(:version => 1) + old_node.redact!(create(:redaction)) + auth_header = bearer_authorization_header create(:moderator_user) + + post "/api/0.6/node/#{old_node.node_id}/#{old_node.version}/redact", :headers => auth_header + + assert_response :success, "should be OK to unredact old version as moderator." + assert_nil old_node.reload.redaction + end + end + end +end diff --git a/test/controllers/api/old_nodes_controller_test.rb b/test/controllers/api/old_nodes_controller_test.rb index 0c5faa9f9..312bae5dd 100644 --- a/test/controllers/api/old_nodes_controller_test.rb +++ b/test/controllers/api/old_nodes_controller_test.rb @@ -21,10 +21,6 @@ module Api { :path => "/api/0.6/node/1/2.json", :method => :get }, { :controller => "api/old_nodes", :action => "show", :node_id => "1", :version => "2", :format => "json" } ) - assert_routing( - { :path => "/api/0.6/node/1/2/redact", :method => :post }, - { :controller => "api/old_nodes", :action => "redact", :node_id => "1", :version => "2" } - ) end def test_index @@ -193,129 +189,6 @@ module Api assert_match(/lon="0.0000800"/, response.body) end - ## - # test that, even as moderator, the current version of a node - # can't be redacted. - def test_redact_node_current_version - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 2) - redaction = create(:redaction) - auth_header = bearer_authorization_header create(:moderator_user) - - post node_version_redact_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header - - assert_response :bad_request, "shouldn't be OK to redact current version as moderator." - assert_nil old_node.reload.redaction - end - - ## - # test the redaction of an old version of a node, while not being - # authorised. - def test_redact_node_unauthorised - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - - post node_version_redact_path(*old_node.id), :params => { :redaction => redaction.id } - - assert_response :unauthorized, "should need to be authenticated to redact." - assert_nil old_node.reload.redaction - end - - def test_redact_node_by_regular_without_write_redactions_scope - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - auth_header = bearer_authorization_header(create(:user), :scopes => %w[read_prefs write_api]) - - post node_version_redact_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header - - assert_response :forbidden, "should need to be moderator to redact." - assert_nil old_node.reload.redaction - end - - def test_redact_node_by_regular_with_write_redactions_scope - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - auth_header = bearer_authorization_header(create(:user), :scopes => %w[write_redactions]) - - post node_version_redact_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header - - assert_response :forbidden, "should need to be moderator to redact." - assert_nil old_node.reload.redaction - end - - def test_redact_node_by_moderator_without_write_redactions_scope - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[read_prefs write_api]) - - post node_version_redact_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header - - assert_response :forbidden, "should need to have write_redactions scope to redact." - assert_nil old_node.reload.redaction - end - - def test_redact_node_by_moderator_with_write_redactions_scope - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - auth_header = bearer_authorization_header(create(:moderator_user), :scopes => %w[write_redactions]) - - post node_version_redact_path(*old_node.id), :params => { :redaction => redaction.id }, :headers => auth_header - - assert_response :success, "should be OK to redact old version as moderator with write_redactions scope." - assert_equal redaction, old_node.reload.redaction - end - - ## - # test the unredaction of an old version of a node, while not being - # authorised. - def test_unredact_node_unauthorised - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - old_node.redact!(redaction) - - post node_version_redact_path(*old_node.id) - - assert_response :unauthorized, "should need to be authenticated to unredact." - assert_equal redaction, old_node.reload.redaction - end - - ## - # test the unredaction of an old version of a node, while being - # authorised as a normal user. - def test_unredact_node_normal_user - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - redaction = create(:redaction) - old_node.redact!(redaction) - auth_header = bearer_authorization_header - - post node_version_redact_path(*old_node.id), :headers => auth_header - - assert_response :forbidden, "should need to be moderator to unredact." - assert_equal redaction, old_node.reload.redaction - end - - ## - # test the unredaction of an old version of a node, while being - # authorised as a moderator. - def test_unredact_node_moderator - node = create(:node, :with_history, :version => 2) - old_node = node.old_nodes.find_by(:version => 1) - old_node.redact!(create(:redaction)) - auth_header = bearer_authorization_header create(:moderator_user) - - post node_version_redact_path(*old_node.id), :headers => auth_header - - assert_response :success, "should be OK to unredact old version as moderator." - assert_nil old_node.reload.redaction - end - private def check_not_found_id_version(id, version) -- 2.39.5