From 5444af981c8c3161ed7991d0fb0fd7463175fc7e Mon Sep 17 00:00:00 2001 From: Andy Allan Date: Wed, 10 Apr 2019 16:52:20 +0200 Subject: [PATCH] Resourceful route names for api/trace_controller --- app/abilities/api_ability.rb | 2 +- app/abilities/api_capability.rb | 4 +- app/controllers/api/traces_controller.rb | 20 ++-- config/routes.rb | 12 +- .../controllers/api/traces_controller_test.rb | 110 +++++++++--------- 5 files changed, 74 insertions(+), 74 deletions(-) diff --git a/app/abilities/api_ability.rb b/app/abilities/api_ability.rb index 54bc8fb4c..074a7f95d 100644 --- a/app/abilities/api_ability.rb +++ b/app/abilities/api_ability.rb @@ -33,7 +33,7 @@ class ApiAbility can [:new, :create, :reply, :show, :inbox, :outbox, :mark, :destroy], Message can [:close, :reopen], Note can [:new, :create], Report - can [:api_create, :api_read, :api_update, :api_delete, :api_data], Trace + can [:create, :show, :update, :destroy, :data], Trace can [:api_details, :api_gpx_files], User can [:read, :read_one, :update, :update_one, :delete_one], UserPreference diff --git a/app/abilities/api_capability.rb b/app/abilities/api_capability.rb index 9f59b1f24..c3544136b 100644 --- a/app/abilities/api_capability.rb +++ b/app/abilities/api_capability.rb @@ -6,8 +6,8 @@ class ApiCapability def initialize(token) if Settings.status != "database_offline" can [:create, :comment, :close, :reopen], Note if capability?(token, :allow_write_notes) - can [:api_read, :api_data], Trace if capability?(token, :allow_read_gpx) - can [:api_create, :api_update, :api_delete], Trace if capability?(token, :allow_write_gpx) + can [:show, :data], Trace if capability?(token, :allow_read_gpx) + can [:create, :update, :destroy], Trace if capability?(token, :allow_write_gpx) can [:api_details], User if capability?(token, :allow_read_prefs) can [:api_gpx_files], User if capability?(token, :allow_read_gpx) can [:read, :read_one], UserPreference if capability?(token, :allow_read_prefs) diff --git a/app/controllers/api/traces_controller.rb b/app/controllers/api/traces_controller.rb index 49db41076..86f1370f6 100644 --- a/app/controllers/api/traces_controller.rb +++ b/app/controllers/api/traces_controller.rb @@ -8,14 +8,14 @@ module Api authorize_resource - before_action :check_database_readable, :except => [:api_read, :api_data] - before_action :check_database_writable, :only => [:api_create, :api_update, :api_delete] - before_action :check_api_readable, :only => [:api_read, :api_data] - before_action :check_api_writable, :only => [:api_create, :api_update, :api_delete] - before_action :offline_redirect, :only => [:api_create, :api_delete, :api_data] + before_action :check_database_readable, :except => [:show, :data] + before_action :check_database_writable, :only => [:create, :update, :destroy] + before_action :check_api_readable, :only => [:show, :data] + before_action :check_api_writable, :only => [:create, :update, :destroy] + before_action :offline_redirect, :only => [:create, :destroy, :data] around_action :api_call_handle_error - def api_read + def show trace = Trace.visible.find(params[:id]) if trace.public? || trace.user == current_user @@ -25,7 +25,7 @@ module Api end end - def api_update + def update trace = Trace.visible.find(params[:id]) if trace.user == current_user @@ -38,7 +38,7 @@ module Api end end - def api_delete + def destroy trace = Trace.visible.find(params[:id]) if trace.user == current_user @@ -52,7 +52,7 @@ module Api end end - def api_data + def data trace = Trace.visible.find(params[:id]) if trace.public? || trace.user == current_user @@ -68,7 +68,7 @@ module Api end end - def api_create + def create tags = params[:tags] || "" description = params[:description] || "" visibility = params[:visibility] diff --git a/config/routes.rb b/config/routes.rb index 32cd397aa..98869abf7 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -77,12 +77,12 @@ OpenStreetMap::Application.routes.draw do put "user/preferences/:preference_key" => "api/user_preferences#update_one" delete "user/preferences/:preference_key" => "api/user_preferences#delete_one" - post "gpx/create" => "api/traces#api_create" - get "gpx/:id" => "api/traces#api_read", :id => /\d+/ - put "gpx/:id" => "api/traces#api_update", :id => /\d+/ - delete "gpx/:id" => "api/traces#api_delete", :id => /\d+/ - get "gpx/:id/details" => "api/traces#api_read", :id => /\d+/ - get "gpx/:id/data" => "api/traces#api_data" + post "gpx/create" => "api/traces#create" + get "gpx/:id" => "api/traces#show", :id => /\d+/ + put "gpx/:id" => "api/traces#update", :id => /\d+/ + delete "gpx/:id" => "api/traces#destroy", :id => /\d+/ + get "gpx/:id/details" => "api/traces#show", :id => /\d+/ + get "gpx/:id/data" => "api/traces#data" # AMF (ActionScript) API post "amf/read" => "api/amf#amf_read" diff --git a/test/controllers/api/traces_controller_test.rb b/test/controllers/api/traces_controller_test.rb index 0466ac996..24ff6ee66 100644 --- a/test/controllers/api/traces_controller_test.rb +++ b/test/controllers/api/traces_controller_test.rb @@ -13,177 +13,177 @@ module Api def test_routes assert_routing( { :path => "/api/0.6/gpx/create", :method => :post }, - { :controller => "api/traces", :action => "api_create" } + { :controller => "api/traces", :action => "create" } ) assert_routing( { :path => "/api/0.6/gpx/1", :method => :get }, - { :controller => "api/traces", :action => "api_read", :id => "1" } + { :controller => "api/traces", :action => "show", :id => "1" } ) assert_routing( { :path => "/api/0.6/gpx/1", :method => :put }, - { :controller => "api/traces", :action => "api_update", :id => "1" } + { :controller => "api/traces", :action => "update", :id => "1" } ) assert_routing( { :path => "/api/0.6/gpx/1", :method => :delete }, - { :controller => "api/traces", :action => "api_delete", :id => "1" } + { :controller => "api/traces", :action => "destroy", :id => "1" } ) assert_recognizes( - { :controller => "api/traces", :action => "api_read", :id => "1" }, + { :controller => "api/traces", :action => "show", :id => "1" }, { :path => "/api/0.6/gpx/1/details", :method => :get } ) assert_routing( { :path => "/api/0.6/gpx/1/data", :method => :get }, - { :controller => "api/traces", :action => "api_data", :id => "1" } + { :controller => "api/traces", :action => "data", :id => "1" } ) assert_routing( { :path => "/api/0.6/gpx/1/data.xml", :method => :get }, - { :controller => "api/traces", :action => "api_data", :id => "1", :format => "xml" } + { :controller => "api/traces", :action => "data", :id => "1", :format => "xml" } ) end # Check getting a specific trace through the api - def test_api_read + def test_show public_trace_file = create(:trace, :visibility => "public") # First with no auth - get :api_read, :params => { :id => public_trace_file.id } + get :show, :params => { :id => public_trace_file.id } assert_response :unauthorized # Now with some other user, which should work since the trace is public basic_authorization create(:user).display_name, "test" - get :api_read, :params => { :id => public_trace_file.id } + get :show, :params => { :id => public_trace_file.id } assert_response :success # And finally we should be able to do it with the owner of the trace basic_authorization public_trace_file.user.display_name, "test" - get :api_read, :params => { :id => public_trace_file.id } + get :show, :params => { :id => public_trace_file.id } assert_response :success end # Check an anoymous trace can't be specifically fetched by another user - def test_api_read_anon + def test_show_anon anon_trace_file = create(:trace, :visibility => "private") # First with no auth - get :api_read, :params => { :id => anon_trace_file.id } + get :show, :params => { :id => anon_trace_file.id } assert_response :unauthorized # Now try with another user, which shouldn't work since the trace is anon basic_authorization create(:user).display_name, "test" - get :api_read, :params => { :id => anon_trace_file.id } + get :show, :params => { :id => anon_trace_file.id } assert_response :forbidden # And finally we should be able to get the trace details with the trace owner basic_authorization anon_trace_file.user.display_name, "test" - get :api_read, :params => { :id => anon_trace_file.id } + get :show, :params => { :id => anon_trace_file.id } assert_response :success end # Check the api details for a trace that doesn't exist - def test_api_read_not_found + def test_show_not_found deleted_trace_file = create(:trace, :deleted) # Try first with no auth, as it should require it - get :api_read, :params => { :id => 0 } + get :show, :params => { :id => 0 } assert_response :unauthorized # Login, and try again basic_authorization deleted_trace_file.user.display_name, "test" - get :api_read, :params => { :id => 0 } + get :show, :params => { :id => 0 } assert_response :not_found # Now try a trace which did exist but has been deleted basic_authorization deleted_trace_file.user.display_name, "test" - get :api_read, :params => { :id => deleted_trace_file.id } + get :show, :params => { :id => deleted_trace_file.id } assert_response :not_found end # Test downloading a trace through the api - def test_api_data + def test_data public_trace_file = create(:trace, :visibility => "public", :fixture => "a") # First with no auth - get :api_data, :params => { :id => public_trace_file.id } + get :data, :params => { :id => public_trace_file.id } assert_response :unauthorized # Now with some other user, which should work since the trace is public basic_authorization create(:user).display_name, "test" - get :api_data, :params => { :id => public_trace_file.id } + get :data, :params => { :id => public_trace_file.id } check_trace_data public_trace_file, "848caa72f2f456d1bd6a0fdf228aa1b9" # And finally we should be able to do it with the owner of the trace basic_authorization public_trace_file.user.display_name, "test" - get :api_data, :params => { :id => public_trace_file.id } + get :data, :params => { :id => public_trace_file.id } check_trace_data public_trace_file, "848caa72f2f456d1bd6a0fdf228aa1b9" end # Test downloading a compressed trace through the api - def test_api_data_compressed + def test_data_compressed identifiable_trace_file = create(:trace, :visibility => "identifiable", :fixture => "d") # Authenticate as the owner of the trace we will be using basic_authorization identifiable_trace_file.user.display_name, "test" # First get the data as is - get :api_data, :params => { :id => identifiable_trace_file.id } + get :data, :params => { :id => identifiable_trace_file.id } check_trace_data identifiable_trace_file, "c6422a3d8750faae49ed70e7e8a51b93", "application/x-gzip", "gpx.gz" # Now ask explicitly for XML format - get :api_data, :params => { :id => identifiable_trace_file.id, :format => "xml" } + get :data, :params => { :id => identifiable_trace_file.id, :format => "xml" } check_trace_data identifiable_trace_file, "abd6675fdf3024a84fc0a1deac147c0d", "application/xml", "xml" # Now ask explicitly for GPX format - get :api_data, :params => { :id => identifiable_trace_file.id, :format => "gpx" } + get :data, :params => { :id => identifiable_trace_file.id, :format => "gpx" } check_trace_data identifiable_trace_file, "abd6675fdf3024a84fc0a1deac147c0d" end # Check an anonymous trace can't be downloaded by another user through the api - def test_api_data_anon + def test_data_anon anon_trace_file = create(:trace, :visibility => "private", :fixture => "b") # First with no auth - get :api_data, :params => { :id => anon_trace_file.id } + get :data, :params => { :id => anon_trace_file.id } assert_response :unauthorized # Now with some other user, which shouldn't work since the trace is anon basic_authorization create(:user).display_name, "test" - get :api_data, :params => { :id => anon_trace_file.id } + get :data, :params => { :id => anon_trace_file.id } assert_response :forbidden # And finally we should be able to do it with the owner of the trace basic_authorization anon_trace_file.user.display_name, "test" - get :api_data, :params => { :id => anon_trace_file.id } + get :data, :params => { :id => anon_trace_file.id } check_trace_data anon_trace_file, "66179ca44f1e93d8df62e2b88cbea732" end # Test downloading a trace that doesn't exist through the api - def test_api_data_not_found + def test_data_not_found deleted_trace_file = create(:trace, :deleted) # Try first with no auth, as it should require it - get :api_data, :params => { :id => 0 } + get :data, :params => { :id => 0 } assert_response :unauthorized # Login, and try again basic_authorization create(:user).display_name, "test" - get :api_data, :params => { :id => 0 } + get :data, :params => { :id => 0 } assert_response :not_found # Now try a trace which did exist but has been deleted basic_authorization deleted_trace_file.user.display_name, "test" - get :api_data, :params => { :id => deleted_trace_file.id } + get :data, :params => { :id => deleted_trace_file.id } assert_response :not_found end # Test creating a trace through the api - def test_api_create + def test_create # Get file to use fixture = Rails.root.join("test", "gpx", "fixtures", "a.gpx") file = Rack::Test::UploadedFile.new(fixture, "application/gpx+xml") user = create(:user) # First with no auth - post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" } + post :create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" } assert_response :unauthorized # Rewind the file @@ -193,7 +193,7 @@ module Api create(:user_preference, :user => user, :k => "gps.trace.visibility", :v => "identifiable") assert_not_equal "trackable", user.preferences.where(:k => "gps.trace.visibility").first.v basic_authorization user.display_name, "test" - post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" } + post :create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :visibility => "trackable" } assert_response :success trace = Trace.find(response.body.to_i) assert_equal "a.gpx", trace.name @@ -211,7 +211,7 @@ module Api # Now authenticated, with the legacy public flag assert_not_equal "public", user.preferences.where(:k => "gps.trace.visibility").first.v basic_authorization user.display_name, "test" - post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 1 } + post :create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 1 } assert_response :success trace = Trace.find(response.body.to_i) assert_equal "a.gpx", trace.name @@ -230,7 +230,7 @@ module Api second_user = create(:user) assert_nil second_user.preferences.where(:k => "gps.trace.visibility").first basic_authorization second_user.display_name, "test" - post :api_create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 0 } + post :create, :params => { :file => file, :description => "New Trace", :tags => "new,trace", :public => 0 } assert_response :success trace = Trace.find(response.body.to_i) assert_equal "a.gpx", trace.name @@ -244,33 +244,33 @@ module Api end # Check updating a trace through the api - def test_api_update + def test_update public_trace_file = create(:trace, :visibility => "public", :fixture => "a") deleted_trace_file = create(:trace, :deleted) anon_trace_file = create(:trace, :visibility => "private") # First with no auth - put :api_update, :params => { :id => public_trace_file.id }, :body => public_trace_file.to_xml.to_s + put :update, :params => { :id => public_trace_file.id }, :body => public_trace_file.to_xml.to_s assert_response :unauthorized # Now with some other user, which should fail basic_authorization create(:user).display_name, "test" - put :api_update, :params => { :id => public_trace_file.id }, :body => public_trace_file.to_xml.to_s + put :update, :params => { :id => public_trace_file.id }, :body => public_trace_file.to_xml.to_s assert_response :forbidden # Now with a trace which doesn't exist basic_authorization create(:user).display_name, "test" - put :api_update, :params => { :id => 0 }, :body => public_trace_file.to_xml.to_s + put :update, :params => { :id => 0 }, :body => public_trace_file.to_xml.to_s assert_response :not_found # Now with a trace which did exist but has been deleted basic_authorization deleted_trace_file.user.display_name, "test" - put :api_update, :params => { :id => deleted_trace_file.id }, :body => deleted_trace_file.to_xml.to_s + put :update, :params => { :id => deleted_trace_file.id }, :body => deleted_trace_file.to_xml.to_s assert_response :not_found # Now try an update with the wrong ID basic_authorization public_trace_file.user.display_name, "test" - put :api_update, :params => { :id => public_trace_file.id }, :body => anon_trace_file.to_xml.to_s + put :update, :params => { :id => public_trace_file.id }, :body => anon_trace_file.to_xml.to_s assert_response :bad_request, "should not be able to update a trace with a different ID from the XML" @@ -279,7 +279,7 @@ module Api t = public_trace_file t.description = "Changed description" t.visibility = "private" - put :api_update, :params => { :id => t.id }, :body => t.to_xml.to_s + put :update, :params => { :id => t.id }, :body => t.to_xml.to_s assert_response :success nt = Trace.find(t.id) assert_equal nt.description, t.description @@ -287,12 +287,12 @@ module Api end # Test that updating a trace doesn't duplicate the tags - def test_api_update_tags + def test_update_tags tracetag = create(:tracetag) trace = tracetag.trace basic_authorization trace.user.display_name, "test" - put :api_update, :params => { :id => trace.id }, :body => trace.to_xml.to_s + put :update, :params => { :id => trace.id }, :body => trace.to_xml.to_s assert_response :success updated = Trace.find(trace.id) @@ -303,31 +303,31 @@ module Api end # Check deleting a trace through the api - def test_api_delete + def test_destroy public_trace_file = create(:trace, :visibility => "public") # First with no auth - delete :api_delete, :params => { :id => public_trace_file.id } + delete :destroy, :params => { :id => public_trace_file.id } assert_response :unauthorized # Now with some other user, which should fail basic_authorization create(:user).display_name, "test" - delete :api_delete, :params => { :id => public_trace_file.id } + delete :destroy, :params => { :id => public_trace_file.id } assert_response :forbidden # Now with a trace which doesn't exist basic_authorization create(:user).display_name, "test" - delete :api_delete, :params => { :id => 0 } + delete :destroy, :params => { :id => 0 } assert_response :not_found # And finally we should be able to do it with the owner of the trace basic_authorization public_trace_file.user.display_name, "test" - delete :api_delete, :params => { :id => public_trace_file.id } + delete :destroy, :params => { :id => public_trace_file.id } assert_response :success # Try it a second time, which should fail basic_authorization public_trace_file.user.display_name, "test" - delete :api_delete, :params => { :id => public_trace_file.id } + delete :destroy, :params => { :id => public_trace_file.id } assert_response :not_found end -- 2.43.2