Enhanced the notes search endpoint with a few features

[rails.git] / app / controllers / changeset_controller.rb

diff --git a/app/controllers/changeset_controller.rb b/app/controllers/changeset_controller.rb
index 1c658ccbd61290c35284e4cb152a73de3ff852db..56fab0fc49cb60df161badc50c4384c8e1ce0d2b 100644 (file)
--- a/app/controllers/changeset_controller.rb
+++ b/app/controllers/changeset_controller.rb
@@ -7,12 +7,12 @@ class ChangesetController < ApplicationController
   skip_before_action :verify_authenticity_token, :except => [:list]
   before_action :authorize_web, :only => [:list, :feed, :comments_feed]
   before_action :set_locale, :only => [:list, :feed, :comments_feed]
   skip_before_action :verify_authenticity_token, :except => [:list]
   before_action :authorize_web, :only => [:list, :feed, :comments_feed]
   before_action :set_locale, :only => [:list, :feed, :comments_feed]

-  before_action :authorize, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
+  before_action :authorize, :only => [:create, :update, :upload, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]

   before_action :require_moderator, :only => [:hide_comment, :unhide_comment]
   before_action :require_moderator, :only => [:hide_comment, :unhide_comment]

-  before_action :require_allow_write_api, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
-  before_action :require_public_data, :only => [:create, :update, :delete, :upload, :include, :close, :comment, :subscribe, :unsubscribe]
-  before_action :check_api_writable, :only => [:create, :update, :delete, :upload, :include, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
-  before_action :check_api_readable, :except => [:create, :update, :delete, :upload, :download, :query, :list, :feed, :comment, :subscribe, :unsubscribe, :comments_feed]
+  before_action :require_allow_write_api, :only => [:create, :update, :upload, :close, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
+  before_action :require_public_data, :only => [:create, :update, :upload, :close, :comment, :subscribe, :unsubscribe]
+  before_action :check_api_writable, :only => [:create, :update, :upload, :comment, :subscribe, :unsubscribe, :hide_comment, :unhide_comment]
+  before_action :check_api_readable, :except => [:create, :update, :upload, :download, :query, :list, :feed, :comment, :subscribe, :unsubscribe, :comments_feed]

   before_action(:only => [:list, :feed, :comments_feed]) { |c| c.check_database_readable(true) }
   around_action :api_call_handle_error, :except => [:list, :feed, :comments_feed]
   around_action :api_call_timeout, :except => [:list, :feed, :comments_feed, :upload]
   before_action(:only => [:list, :feed, :comments_feed]) { |c| c.check_database_readable(true) }
   around_action :api_call_handle_error, :except => [:list, :feed, :comments_feed]
   around_action :api_call_timeout, :except => [:list, :feed, :comments_feed, :upload]


@@ -28,7 +28,7 @@ class ChangesetController < ApplicationController
     cs = Changeset.from_xml(request.raw_post, true)
 
     # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml
     cs = Changeset.from_xml(request.raw_post, true)
 
     # Assume that Changeset.from_xml has thrown an exception if there is an error parsing the xml

-    cs.user_id = current_user.id
+    cs.user = current_user

     cs.save_with_tags!
 
     # Subscribe user to changeset comments
     cs.save_with_tags!
 
     # Subscribe user to changeset comments


@@ -216,6 +216,12 @@ class ChangesetController < ApplicationController
     changesets = conditions_closed(changesets, params["closed"])
     changesets = conditions_ids(changesets, params["changesets"])
 
     changesets = conditions_closed(changesets, params["closed"])
     changesets = conditions_ids(changesets, params["changesets"])
 

+    # sort and limit the changesets
+    changesets = changesets.order("created_at DESC").limit(100)
+
+    # preload users, tags and comments
+    changesets = changesets.preload(:user, :changeset_tags, :comments)
+

     # create the results document
     results = OSM::API.new.get_xml_doc
 
     # create the results document
     results = OSM::API.new.get_xml_doc
 


@@ -290,9 +296,7 @@ class ChangesetController < ApplicationController
         changesets = changesets.where(:user_id => current_user.nearby)
       end
 
         changesets = changesets.where(:user_id => current_user.nearby)
       end
 

-      if @params[:max_id]
-        changesets = changesets.where("changesets.id <= ?", @params[:max_id])
-      end
+      changesets = changesets.where("changesets.id <= ?", @params[:max_id]) if @params[:max_id]

 
       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments)
 
 
       @edits = changesets.order("changesets.id DESC").limit(20).preload(:user, :changeset_tags, :comments)
 


@@ -310,8 +314,8 @@ class ChangesetController < ApplicationController
   # Add a comment to a changeset
   def comment
     # Check the arguments are sane
   # Add a comment to a changeset
   def comment
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
-    raise OSM::APIBadUserInput.new("No text was given") if params[:text].blank?
+    raise OSM::APIBadUserInput, "No id was given" unless params[:id]
+    raise OSM::APIBadUserInput, "No text was given" if params[:text].blank?

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Extract the arguments
     id = params[:id].to_i


@@ -319,7 +323,7 @@ class ChangesetController < ApplicationController
 
     # Find the changeset and check it is valid
     changeset = Changeset.find(id)
 
     # Find the changeset and check it is valid
     changeset = Changeset.find(id)

-    raise OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
+    raise OSM::APIChangesetNotYetClosedError, changeset if changeset.is_open?

 
     # Add a comment to the changeset
     comment = changeset.comments.create(:changeset => changeset,
 
     # Add a comment to the changeset
     comment = changeset.comments.create(:changeset => changeset,


@@ -328,9 +332,7 @@ class ChangesetController < ApplicationController
 
     # Notify current subscribers of the new comment
     changeset.subscribers.visible.each do |user|
 
     # Notify current subscribers of the new comment
     changeset.subscribers.visible.each do |user|

-      if current_user != user
-        Notifier.changeset_comment_notification(comment, user).deliver_now
-      end
+      Notifier.changeset_comment_notification(comment, user).deliver_now if current_user != user

     end
 
     # Add the commenter to the subscribers if necessary
     end
 
     # Add the commenter to the subscribers if necessary


@@ -344,15 +346,14 @@ class ChangesetController < ApplicationController
   # Adds a subscriber to the changeset
   def subscribe
     # Check the arguments are sane
   # Adds a subscriber to the changeset
   def subscribe
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    raise OSM::APIBadUserInput, "No id was given" unless params[:id]

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Find the changeset and check it is valid
     changeset = Changeset.find(id)
 
     # Extract the arguments
     id = params[:id].to_i
 
     # Find the changeset and check it is valid
     changeset = Changeset.find(id)

-    raise OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
-    raise OSM::APIChangesetAlreadySubscribedError.new(changeset) if changeset.subscribers.exists?(current_user.id)
+    raise OSM::APIChangesetAlreadySubscribedError, changeset if changeset.subscribers.exists?(current_user.id)

 
     # Add the subscriber
     changeset.subscribers << current_user
 
     # Add the subscriber
     changeset.subscribers << current_user


@@ -365,15 +366,14 @@ class ChangesetController < ApplicationController
   # Removes a subscriber from the changeset
   def unsubscribe
     # Check the arguments are sane
   # Removes a subscriber from the changeset
   def unsubscribe
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    raise OSM::APIBadUserInput, "No id was given" unless params[:id]

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Find the changeset and check it is valid
     changeset = Changeset.find(id)
 
     # Extract the arguments
     id = params[:id].to_i
 
     # Find the changeset and check it is valid
     changeset = Changeset.find(id)

-    raise OSM::APIChangesetNotYetClosedError.new(changeset) if changeset.is_open?
-    raise OSM::APIChangesetNotSubscribedError.new(changeset) unless changeset.subscribers.exists?(current_user.id)
+    raise OSM::APIChangesetNotSubscribedError, changeset unless changeset.subscribers.exists?(current_user.id)

 
     # Remove the subscriber
     changeset.subscribers.delete(current_user)
 
     # Remove the subscriber
     changeset.subscribers.delete(current_user)


@@ -386,7 +386,7 @@ class ChangesetController < ApplicationController
   # Sets visible flag on comment to false
   def hide_comment
     # Check the arguments are sane
   # Sets visible flag on comment to false
   def hide_comment
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    raise OSM::APIBadUserInput, "No id was given" unless params[:id]

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Extract the arguments
     id = params[:id].to_i


@@ -405,7 +405,7 @@ class ChangesetController < ApplicationController
   # Sets visible flag on comment to true
   def unhide_comment
     # Check the arguments are sane
   # Sets visible flag on comment to true
   def unhide_comment
     # Check the arguments are sane

-    raise OSM::APIBadUserInput.new("No id was given") unless params[:id]
+    raise OSM::APIBadUserInput, "No id was given" unless params[:id]

 
     # Extract the arguments
     id = params[:id].to_i
 
     # Extract the arguments
     id = params[:id].to_i


@@ -434,7 +434,7 @@ class ChangesetController < ApplicationController
       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
     else
       # Return comments
       @comments = changeset.comments.includes(:author, :changeset).limit(comments_limit)
     else
       # Return comments

-      @comments = ChangesetComment.includes(:author, :changeset).where(:visible => :true).order("created_at DESC").limit(comments_limit).preload(:changeset)
+      @comments = ChangesetComment.includes(:author, :changeset).where(:visible => true).order("created_at DESC").limit(comments_limit).preload(:changeset)

     end
 
     # Render the result
     end
 
     # Render the result


@@ -475,19 +475,19 @@ class ChangesetController < ApplicationController
       changesets
     else
       # shouldn't provide both name and UID
       changesets
     else
       # shouldn't provide both name and UID

-      raise OSM::APIBadUserInput.new("provide either the user ID or display name, but not both") if user && name
+      raise OSM::APIBadUserInput, "provide either the user ID or display name, but not both" if user && name

 
       # use either the name or the UID to find the user which we're selecting on.
       u = if name.nil?
             # user input checking, we don't have any UIDs < 1
 
       # use either the name or the UID to find the user which we're selecting on.
       u = if name.nil?
             # user input checking, we don't have any UIDs < 1

-            raise OSM::APIBadUserInput.new("invalid user ID") if user.to_i < 1
+            raise OSM::APIBadUserInput, "invalid user ID" if user.to_i < 1

             u = User.find(user.to_i)
           else
             u = User.find_by(:display_name => name)
           end
 
       # make sure we found a user
             u = User.find(user.to_i)
           else
             u = User.find_by(:display_name => name)
           end
 
       # make sure we found a user

-      raise OSM::APINotFoundError.new if u.nil?
+      raise OSM::APINotFoundError if u.nil?

 
       # should be able to get changesets of public users only, or
       # our own changesets regardless of public-ness.
 
       # should be able to get changesets of public users only, or
       # our own changesets regardless of public-ness.


@@ -496,7 +496,7 @@ class ChangesetController < ApplicationController
         # changesets if they're non-public
         setup_user_auth
 
         # changesets if they're non-public
         setup_user_auth
 

-        raise OSM::APINotFoundError if current_user.nil? || current_user.id != u.id
+        raise OSM::APINotFoundError if current_user.nil? || current_user != u

       end
 
       changesets.where(:user_id => u.id)
       end
 
       changesets.where(:user_id => u.id)


@@ -507,27 +507,27 @@ class ChangesetController < ApplicationController
   # restrict changes to those closed during a particular time period
   def conditions_time(changesets, time)
     if time.nil?
   # restrict changes to those closed during a particular time period
   def conditions_time(changesets, time)
     if time.nil?

-      return changesets
+      changesets

     elsif time.count(",") == 1
       # if there is a range, i.e: comma separated, then the first is
       # low, second is high - same as with bounding boxes.
 
       # check that we actually have 2 elements in the array
       times = time.split(/,/)
     elsif time.count(",") == 1
       # if there is a range, i.e: comma separated, then the first is
       # low, second is high - same as with bounding boxes.
 
       # check that we actually have 2 elements in the array
       times = time.split(/,/)

-      raise OSM::APIBadUserInput.new("bad time range") if times.size != 2
+      raise OSM::APIBadUserInput, "bad time range" if times.size != 2

 
 

-      from, to = times.collect { |t| DateTime.parse(t) }
-      return changesets.where("closed_at >= ? and created_at <= ?", from, to)
+      from, to = times.collect { |t| Time.parse(t) }
+      changesets.where("closed_at >= ? and created_at <= ?", from, to)

     else
       # if there is no comma, assume its a lower limit on time
     else
       # if there is no comma, assume its a lower limit on time

-      return changesets.where("closed_at >= ?", DateTime.parse(time))
+      changesets.where("closed_at >= ?", Time.parse(time))

     end
     end

-    # stupid DateTime seems to throw both of these for bad parsing, so
+    # stupid Time seems to throw both of these for bad parsing, so

     # we have to catch both and ensure the correct code path is taken.
   rescue ArgumentError => ex
     # we have to catch both and ensure the correct code path is taken.
   rescue ArgumentError => ex

-    raise OSM::APIBadUserInput.new(ex.message.to_s)
+    raise OSM::APIBadUserInput, ex.message.to_s

   rescue RuntimeError => ex
   rescue RuntimeError => ex

-    raise OSM::APIBadUserInput.new(ex.message.to_s)
+    raise OSM::APIBadUserInput, ex.message.to_s

   end
 
   ##
   end
 
   ##


@@ -563,7 +563,7 @@ class ChangesetController < ApplicationController
     if ids.nil?
       changesets
     elsif ids.empty?
     if ids.nil?
       changesets
     elsif ids.empty?

-      raise OSM::APIBadUserInput.new("No changesets were given to search for")
+      raise OSM::APIBadUserInput, "No changesets were given to search for"

     else
       ids = ids.split(",").collect(&:to_i)
       changesets.where(:id => ids)
     else
       ids = ids.split(",").collect(&:to_i)
       changesets.where(:id => ids)


@@ -584,7 +584,7 @@ class ChangesetController < ApplicationController
       if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
         params[:limit].to_i
       else
       if params[:limit].to_i > 0 && params[:limit].to_i <= 10000
         params[:limit].to_i
       else

-        raise OSM::APIBadUserInput.new("Comments limit must be between 1 and 10000")
+        raise OSM::APIBadUserInput, "Comments limit must be between 1 and 10000"

       end
     else
       100
       end
     else
       100