]> git.openstreetmap.org Git - rails.git/commitdiff
Merge pull request #4610 from AntonKhorev/no-old-note-api
authorAndy Allan <git@gravitystorm.co.uk>
Wed, 26 Jun 2024 13:17:39 +0000 (14:17 +0100)
committerGitHub <noreply@github.com>
Wed, 26 Jun 2024 13:17:39 +0000 (14:17 +0100)
Remove old note api endpoints

1  2 
config/routes.rb
test/controllers/api/notes_controller_test.rb

diff --combined config/routes.rb
index acf2256a30c1963485a8d7752bf83534ad9bc958,32cb7dab8051d425e030890d548c628777e7430a..98c8ba15e07459a08e4c420d7a4f9289316b1023
@@@ -25,7 -25,7 +25,7 @@@ OpenStreetMap::Application.routes.draw 
      post "changeset/:id/unsubscribe" => "changesets#unsubscribe", :as => :api_changeset_unsubscribe, :id => /\d+/
      put "changeset/:id" => "changesets#update", :id => /\d+/
      put "changeset/:id/close" => "changesets#close", :as => :changeset_close, :id => /\d+/
 -    get "changesets" => "changesets#query"
 +    get "changesets" => "changesets#index"
      post "changeset/:id/comment" => "changeset_comments#create", :as => :changeset_comment, :id => /\d+/
      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+/
        end
      end
  
-     post "notes/addPOIexec" => "notes#create"
-     post "notes/closePOIexec" => "notes#close"
-     post "notes/editPOIexec" => "notes#comment"
-     get "notes/getGPX" => "notes#index", :format => "gpx"
-     get "notes/getRSSfeed" => "notes#feed", :format => "rss"
      resources :user_blocks, :only => [:show], :constraints => { :id => /\d+/ }, :controller => "user_blocks", :as => :api_user_blocks
    end
  
      match :subscribe, :unsubscribe, :on => :member, :via => [:get, :post]
    end
    get "/changeset/:id/comments/feed" => "changeset_comments#index", :as => :changeset_comments_feed, :id => /\d*/, :defaults => { :format => "rss" }
 -  resources :notes, :path => "note", :only => [:show, :new]
 +  resources :notes, :path => "note", :id => /\d+/, :only => [:show, :new]
  
    get "/user/:display_name/history" => "changesets#index"
    get "/user/:display_name/history/feed" => "changesets#feed", :defaults => { :format => :atom }
    get "/user/:display_name/traces/tag/:tag/rss" => "traces#georss", :defaults => { :format => :rss }
    get "/user/:display_name/traces/rss" => "traces#georss", :defaults => { :format => :rss }
    get "/user/:display_name/traces/:id" => "traces#show", :as => "show_trace"
 -  get "/user/:display_name/traces/:id/picture" => "traces#picture", :as => "trace_picture"
 -  get "/user/:display_name/traces/:id/icon" => "traces#icon", :as => "trace_icon"
 +  scope "/user/:display_name/traces/:trace_id", :module => :traces do
 +    get "picture" => "pictures#show", :as => "trace_picture"
 +    get "icon" => "icons#show", :as => "trace_icon"
 +  end
    get "/traces/tag/:tag/page/:page", :page => /[1-9][0-9]*/, :to => redirect(:path => "/traces/tag/%{tag}")
    get "/traces/tag/:tag" => "traces#index"
    get "/traces/page/:page", :page => /[1-9][0-9]*/, :to => redirect(:path => "/traces")
    get "/user/:display_name/diary/rss" => "diary_entries#rss", :defaults => { :format => :rss }
    get "/diary/:language/rss" => "diary_entries#rss", :defaults => { :format => :rss }
    get "/diary/rss" => "diary_entries#rss", :defaults => { :format => :rss }
 -  get "/user/:display_name/diary/comments/:page" => "diary_entries#comments", :page => /[1-9][0-9]*/
 -  get "/user/:display_name/diary/comments/" => "diary_entries#comments", :as => :diary_comments
 +  get "/user/:display_name/diary/comments/:page", :page => /[1-9][0-9]*/, :to => redirect(:path => "/user/%{display_name}/diary/comments")
 +  get "/user/:display_name/diary/comments" => "diary_comments#index", :as => :diary_comments
    get "/user/:display_name/diary" => "diary_entries#index"
    get "/diary/:language" => "diary_entries#index"
    scope "/user/:display_name" do
    post "/user/:display_name/diary/:id/newcomment" => "diary_entries#comment", :id => /\d+/, :as => :comment_diary_entry
    post "/user/:display_name/diary/:id/hide" => "diary_entries#hide", :id => /\d+/, :as => :hide_diary_entry
    post "/user/:display_name/diary/:id/unhide" => "diary_entries#unhide", :id => /\d+/, :as => :unhide_diary_entry
 -  post "/user/:display_name/diary/:id/hidecomment/:comment" => "diary_entries#hidecomment", :id => /\d+/, :comment => /\d+/, :as => :hide_diary_comment
 -  post "/user/:display_name/diary/:id/unhidecomment/:comment" => "diary_entries#unhidecomment", :id => /\d+/, :comment => /\d+/, :as => :unhide_diary_comment
 +  post "/user/:display_name/diary/:id/hidecomment/:comment" => "diary_comments#hide", :id => /\d+/, :comment => /\d+/, :as => :hide_diary_comment
 +  post "/user/:display_name/diary/:id/unhidecomment/:comment" => "diary_comments#unhide", :id => /\d+/, :comment => /\d+/, :as => :unhide_diary_comment
    match "/user/:display_name/diary/:id/subscribe" => "diary_entries#subscribe", :via => [:get, :post], :as => :diary_entry_subscribe, :id => /\d+/
    match "/user/:display_name/diary/:id/unsubscribe" => "diary_entries#unsubscribe", :via => [:get, :post], :as => :diary_entry_unsubscribe, :id => /\d+/
  
    resources :redactions
  
    # errors
 +  match "/400", :to => "errors#bad_request", :via => :all
    match "/403", :to => "errors#forbidden", :via => :all
    match "/404", :to => "errors#not_found", :via => :all
    match "/500", :to => "errors#internal_server_error", :via => :all
index 045e3bf434fe8b6dc36054379e5a4561c7f2fc63,6f768eac076e91c47197b9acf9a0d66eb9b974db..42972e494d85033c13f90b23faea40bef0c88f2f
@@@ -99,27 -99,6 +99,6 @@@ module Ap
          { :path => "/api/0.6/notes/feed", :method => :get },
          { :controller => "api/notes", :action => "feed", :format => "rss" }
        )
-       assert_recognizes(
-         { :controller => "api/notes", :action => "create" },
-         { :path => "/api/0.6/notes/addPOIexec", :method => :post }
-       )
-       assert_recognizes(
-         { :controller => "api/notes", :action => "close" },
-         { :path => "/api/0.6/notes/closePOIexec", :method => :post }
-       )
-       assert_recognizes(
-         { :controller => "api/notes", :action => "comment" },
-         { :path => "/api/0.6/notes/editPOIexec", :method => :post }
-       )
-       assert_recognizes(
-         { :controller => "api/notes", :action => "index", :format => "gpx" },
-         { :path => "/api/0.6/notes/getGPX", :method => :get }
-       )
-       assert_recognizes(
-         { :controller => "api/notes", :action => "feed", :format => "rss" },
-         { :path => "/api/0.6/notes/getRSSfeed", :method => :get }
-       )
      end
  
      def test_create_success
        assert_nil js["properties"]["comments"].last["user"]
        id = js["properties"]["id"]
  
 -      get api_note_path(:id => id, :format => "json")
 +      get api_note_path(id, :format => "json")
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
        assert_difference "NoteComment.count", 1 do
          assert_no_difference "ActionMailer::Base.deliveries.size" do
            perform_enqueued_jobs do
 -            post comment_api_note_path(:id => open_note_with_comment, :text => "This is an additional comment", :format => "json"), :headers => auth_header
 +            post comment_api_note_path(open_note_with_comment, :text => "This is an additional comment", :format => "json"), :headers => auth_header
            end
          end
        end
        assert_equal "This is an additional comment", js["properties"]["comments"].last["text"]
        assert_equal user.display_name, js["properties"]["comments"].last["user"]
  
 -      get api_note_path(:id => open_note_with_comment, :format => "json")
 +      get api_note_path(open_note_with_comment, :format => "json")
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
        assert_difference "NoteComment.count", 1 do
          assert_difference "ActionMailer::Base.deliveries.size", 2 do
            perform_enqueued_jobs do
 -            post comment_api_note_path(:id => note_with_comments_by_users, :text => "This is an additional comment", :format => "json"), :headers => auth_header
 +            post comment_api_note_path(note_with_comments_by_users, :text => "This is an additional comment", :format => "json"), :headers => auth_header
            end
          end
        end
        assert_equal 1, email.to.length
        assert_equal "[OpenStreetMap] #{third_user.display_name} has commented on a note you are interested in", email.subject
  
 -      get api_note_path(:id => note_with_comments_by_users, :format => "json")
 +      get api_note_path(note_with_comments_by_users, :format => "json")
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
        user = create(:user)
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => open_note_with_comment)
 +        post comment_api_note_path(open_note_with_comment)
          assert_response :unauthorized
        end
  
        auth_header = basic_authorization_header user.email, "test"
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => open_note_with_comment), :headers => auth_header
 +        post comment_api_note_path(open_note_with_comment), :headers => auth_header
        end
        assert_response :bad_request
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => open_note_with_comment, :text => ""), :headers => auth_header
 +        post comment_api_note_path(open_note_with_comment, :text => ""), :headers => auth_header
        end
        assert_response :bad_request
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => 12345, :text => "This is an additional comment"), :headers => auth_header
 +        post comment_api_note_path(12345, :text => "This is an additional comment"), :headers => auth_header
        end
        assert_response :not_found
  
        hidden_note_with_comment = create(:note_with_comments, :status => "hidden")
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => hidden_note_with_comment, :text => "This is an additional comment"), :headers => auth_header
 +        post comment_api_note_path(hidden_note_with_comment, :text => "This is an additional comment"), :headers => auth_header
        end
        assert_response :gone
  
        closed_note_with_comment = create(:note_with_comments, :closed)
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => closed_note_with_comment, :text => "This is an additional comment"), :headers => auth_header
 +        post comment_api_note_path(closed_note_with_comment, :text => "This is an additional comment"), :headers => auth_header
        end
        assert_response :conflict
  
        assert_no_difference "NoteComment.count" do
 -        post comment_api_note_path(:id => open_note_with_comment, :text => "x\u0000y"), :headers => auth_header
 +        post comment_api_note_path(open_note_with_comment, :text => "x\u0000y"), :headers => auth_header
        end
        assert_response :bad_request
      end
        open_note_with_comment = create(:note_with_comments)
        user = create(:user)
  
 -      post close_api_note_path(:id => open_note_with_comment, :text => "This is a close comment", :format => "json")
 +      post close_api_note_path(open_note_with_comment, :text => "This is a close comment", :format => "json")
        assert_response :unauthorized
  
        auth_header = basic_authorization_header user.email, "test"
  
 -      post close_api_note_path(:id => open_note_with_comment, :text => "This is a close comment", :format => "json"), :headers => auth_header
 +      post close_api_note_path(open_note_with_comment, :text => "This is a close comment", :format => "json"), :headers => auth_header
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
        assert_equal "This is a close comment", js["properties"]["comments"].last["text"]
        assert_equal user.display_name, js["properties"]["comments"].last["user"]
  
 -      get api_note_path(:id => open_note_with_comment.id, :format => "json")
 +      get api_note_path(open_note_with_comment.id, :format => "json")
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
      end
  
      def test_close_fail
 -      post close_api_note_path(:id => 12345)
 +      post close_api_note_path(12345)
        assert_response :unauthorized
  
        auth_header = basic_authorization_header create(:user).email, "test"
  
 -      post close_api_note_path(:id => 12345), :headers => auth_header
 +      post close_api_note_path(12345), :headers => auth_header
        assert_response :not_found
  
        hidden_note_with_comment = create(:note_with_comments, :status => "hidden")
  
 -      post close_api_note_path(:id => hidden_note_with_comment), :headers => auth_header
 +      post close_api_note_path(hidden_note_with_comment), :headers => auth_header
        assert_response :gone
  
        closed_note_with_comment = create(:note_with_comments, :closed)
  
 -      post close_api_note_path(:id => closed_note_with_comment), :headers => auth_header
 +      post close_api_note_path(closed_note_with_comment), :headers => auth_header
        assert_response :conflict
      end
  
        closed_note_with_comment = create(:note_with_comments, :closed)
        user = create(:user)
  
 -      post reopen_api_note_path(:id => closed_note_with_comment, :text => "This is a reopen comment", :format => "json")
 +      post reopen_api_note_path(closed_note_with_comment, :text => "This is a reopen comment", :format => "json")
        assert_response :unauthorized
  
        auth_header = basic_authorization_header user.email, "test"
  
 -      post reopen_api_note_path(:id => closed_note_with_comment, :text => "This is a reopen comment", :format => "json"), :headers => auth_header
 +      post reopen_api_note_path(closed_note_with_comment, :text => "This is a reopen comment", :format => "json"), :headers => auth_header
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
        assert_equal "This is a reopen comment", js["properties"]["comments"].last["text"]
        assert_equal user.display_name, js["properties"]["comments"].last["user"]
  
 -      get api_note_path(:id => closed_note_with_comment, :format => "json")
 +      get api_note_path(closed_note_with_comment, :format => "json")
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
      def test_reopen_fail
        hidden_note_with_comment = create(:note_with_comments, :status => "hidden")
  
 -      post reopen_api_note_path(:id => hidden_note_with_comment)
 +      post reopen_api_note_path(hidden_note_with_comment)
        assert_response :unauthorized
  
        auth_header = basic_authorization_header create(:user).email, "test"
  
 -      post reopen_api_note_path(:id => 12345), :headers => auth_header
 +      post reopen_api_note_path(12345), :headers => auth_header
        assert_response :not_found
  
 -      post reopen_api_note_path(:id => hidden_note_with_comment), :headers => auth_header
 +      post reopen_api_note_path(hidden_note_with_comment), :headers => auth_header
        assert_response :gone
  
        open_note_with_comment = create(:note_with_comments)
  
 -      post reopen_api_note_path(:id => open_note_with_comment), :headers => auth_header
 +      post reopen_api_note_path(open_note_with_comment), :headers => auth_header
        assert_response :conflict
      end
  
      def test_show_success
        open_note = create(:note_with_comments)
  
 -      get api_note_path(:id => open_note, :format => "xml")
 +      get api_note_path(open_note, :format => "xml")
        assert_response :success
        assert_equal "application/xml", @response.media_type
        assert_select "osm", :count => 1 do
          end
        end
  
 -      get api_note_path(:id => open_note, :format => "rss")
 +      get api_note_path(open_note, :format => "rss")
        assert_response :success
        assert_equal "application/rss+xml", @response.media_type
        assert_select "rss", :count => 1 do
          end
        end
  
 -      get api_note_path(:id => open_note, :format => "json")
 +      get api_note_path(open_note, :format => "json")
        assert_response :success
        assert_equal "application/json", @response.media_type
        js = ActiveSupport::JSON.decode(@response.body)
        assert_equal open_note.created_at.to_s, js["properties"]["date_created"]
        assert_equal open_note.status, js["properties"]["status"]
  
 -      get api_note_path(:id => open_note, :format => "gpx")
 +      get api_note_path(open_note, :format => "gpx")
        assert_response :success
        assert_equal "application/gpx+xml", @response.media_type
        assert_select "gpx", :count => 1 do
          create(:note_comment, :note => note, :body => "Another valid comment for hidden note")
        end
  
 -      get api_note_path(:id => note_with_hidden_comment, :format => "json")
 +      get api_note_path(note_with_hidden_comment, :format => "json")
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
      end
  
      def test_show_fail
 -      get api_note_path(:id => 12345)
 +      get api_note_path(12345)
        assert_response :not_found
  
 -      get api_note_path(:id => create(:note, :status => "hidden"))
 +      get api_note_path(create(:note, :status => "hidden"))
        assert_response :gone
      end
  
        user = create(:user)
        moderator_user = create(:moderator_user)
  
 -      delete api_note_path(:id => open_note_with_comment, :text => "This is a hide comment", :format => "json")
 +      delete api_note_path(open_note_with_comment, :text => "This is a hide comment", :format => "json")
        assert_response :unauthorized
  
        auth_header = basic_authorization_header user.email, "test"
  
 -      delete api_note_path(:id => open_note_with_comment, :text => "This is a hide comment", :format => "json"), :headers => auth_header
 +      delete api_note_path(open_note_with_comment, :text => "This is a hide comment", :format => "json"), :headers => auth_header
        assert_response :forbidden
  
        auth_header = basic_authorization_header moderator_user.email, "test"
  
 -      delete api_note_path(:id => open_note_with_comment, :text => "This is a hide comment", :format => "json"), :headers => auth_header
 +      delete api_note_path(open_note_with_comment, :text => "This is a hide comment", :format => "json"), :headers => auth_header
        assert_response :success
        js = ActiveSupport::JSON.decode(@response.body)
        assert_not_nil js
        assert_equal "This is a hide comment", js["properties"]["comments"].last["text"]
        assert_equal moderator_user.display_name, js["properties"]["comments"].last["user"]
  
 -      get api_note_path(:id => open_note_with_comment, :format => "json"), :headers => auth_header
 +      get api_note_path(open_note_with_comment, :format => "json"), :headers => auth_header
        assert_response :success
  
        auth_header = basic_authorization_header user.email, "test"
  
 -      get api_note_path(:id => open_note_with_comment, :format => "json"), :headers => auth_header
 +      get api_note_path(open_note_with_comment, :format => "json"), :headers => auth_header
        assert_response :gone
      end
  
        user = create(:user)
        moderator_user = create(:moderator_user)
  
 -      delete api_note_path(:id => 12345, :format => "json")
 +      delete api_note_path(12345, :format => "json")
        assert_response :unauthorized
  
        auth_header = basic_authorization_header user.email, "test"
  
 -      delete api_note_path(:id => 12345, :format => "json"), :headers => auth_header
 +      delete api_note_path(12345, :format => "json"), :headers => auth_header
        assert_response :forbidden
  
        auth_header = basic_authorization_header moderator_user.email, "test"
  
 -      delete api_note_path(:id => 12345, :format => "json"), :headers => auth_header
 +      delete api_note_path(12345, :format => "json"), :headers => auth_header
        assert_response :not_found
  
        hidden_note_with_comment = create(:note_with_comments, :status => "hidden")
  
 -      delete api_note_path(:id => hidden_note_with_comment, :format => "json"), :headers => auth_header
 +      delete api_note_path(hidden_note_with_comment, :format => "json"), :headers => auth_header
        assert_response :gone
      end