Enhanced the notes search endpoint with a few features

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

diff --git a/app/controllers/notes_controller.rb b/app/controllers/notes_controller.rb
index 51ef4491d35363be75437919e9089537f1eeff9a..24ef13bf936118fcbdccee7b9a43cc0a97703695 100644 (file)
--- a/app/controllers/notes_controller.rb
+++ b/app/controllers/notes_controller.rb
@@ -1,9 +1,10 @@
 class NotesController < ApplicationController
   layout "site", :only => [:mine]
 
 class NotesController < ApplicationController
   layout "site", :only => [:mine]
 

+  skip_before_action :verify_authenticity_token, :except => [:mine]

   before_action :check_api_readable
   before_action :authorize_web, :only => [:mine]
   before_action :check_api_readable
   before_action :authorize_web, :only => [:mine]

-  before_action :setup_user_auth, :only => [:create, :comment]
+  before_action :setup_user_auth, :only => [:create, :comment, :show]

   before_action :authorize, :only => [:close, :reopen, :destroy]
   before_action :require_moderator, :only => [:destroy]
   before_action :check_api_writable, :only => [:create, :comment, :close, :reopen, :destroy]
   before_action :authorize, :only => [:close, :reopen, :destroy]
   before_action :require_moderator, :only => [:destroy]
   before_action :check_api_writable, :only => [:create, :comment, :close, :reopen, :destroy]


@@ -19,10 +20,10 @@ class NotesController < ApplicationController
     if params[:bbox]
       bbox = BoundingBox.from_bbox_params(params)
     else
     if params[:bbox]
       bbox = BoundingBox.from_bbox_params(params)
     else

-      raise OSM::APIBadUserInput.new("No l was given") unless params[:l]
-      raise OSM::APIBadUserInput.new("No r was given") unless params[:r]
-      raise OSM::APIBadUserInput.new("No b was given") unless params[:b]
-      raise OSM::APIBadUserInput.new("No t was given") unless params[:t]
+      raise OSM::APIBadUserInput, "No l was given" unless params[:l]
+      raise OSM::APIBadUserInput, "No r was given" unless params[:r]
+      raise OSM::APIBadUserInput, "No b was given" unless params[:b]
+      raise OSM::APIBadUserInput, "No t was given" unless params[:t]

 
       bbox = BoundingBox.from_lrbt_params(params)
     end
 
       bbox = BoundingBox.from_lrbt_params(params)
     end


@@ -55,9 +56,9 @@ class NotesController < ApplicationController
     raise OSM::APIAccessDenied if Acl.no_note_comment(request.remote_ip)
 
     # Check the arguments are sane
     raise OSM::APIAccessDenied if Acl.no_note_comment(request.remote_ip)
 
     # Check the arguments are sane

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

 
     # Extract the arguments
     lon = OSM.parse_float(params[:lon], OSM::APIBadUserInput, "lon was not a number")
 
     # Extract the arguments
     lon = OSM.parse_float(params[:lon], OSM::APIBadUserInput, "lon was not a number")


@@ -68,7 +69,7 @@ class NotesController < ApplicationController
     Note.transaction do
       # Create the note
       @note = Note.create(:lat => lat, :lon => lon)
     Note.transaction do
       # Create the note
       @note = Note.create(:lat => lat, :lon => lon)

-      raise OSM::APIBadUserInput.new("The note is outside this world") unless @note.in_world?
+      raise OSM::APIBadUserInput, "The note is outside this world" unless @note.in_world?

 
       # Save the note
       @note.save!
 
       # Save the note
       @note.save!


@@ -91,8 +92,8 @@ class NotesController < ApplicationController
     raise OSM::APIAccessDenied if Acl.no_note_comment(request.remote_ip)
 
     # Check the arguments are sane
     raise OSM::APIAccessDenied if Acl.no_note_comment(request.remote_ip)
 
     # 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


@@ -102,7 +103,7 @@ class NotesController < ApplicationController
     @note = Note.find(id)
     raise OSM::APINotFoundError unless @note
     raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
     @note = Note.find(id)
     raise OSM::APINotFoundError unless @note
     raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?

-    raise OSM::APINoteAlreadyClosedError.new(@note) if @note.closed?
+    raise OSM::APINoteAlreadyClosedError, @note if @note.closed?

 
     # Add a comment to the note
     Note.transaction do
 
     # Add a comment to the note
     Note.transaction do


@@ -120,17 +121,17 @@ class NotesController < ApplicationController
   # Close a note
   def close
     # Check the arguments are sane
   # Close a note
   def close
     # 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
     comment = params[:text]
 
     # Find the note and check it is valid
 
     # Extract the arguments
     id = params[:id].to_i
     comment = params[:text]
 
     # Find the note and check it is valid

-    @note = Note.find_by_id(id)
+    @note = Note.find_by(:id => id)

     raise OSM::APINotFoundError unless @note
     raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
     raise OSM::APINotFoundError unless @note
     raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?

-    raise OSM::APINoteAlreadyClosedError.new(@note) if @note.closed?
+    raise OSM::APINoteAlreadyClosedError, @note if @note.closed?

 
     # Close the note and add a comment
     Note.transaction do
 
     # Close the note and add a comment
     Note.transaction do


@@ -150,17 +151,17 @@ class NotesController < ApplicationController
   # Reopen a note
   def reopen
     # Check the arguments are sane
   # Reopen a note
   def reopen
     # 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
     comment = params[:text]
 
     # Find the note and check it is valid
 
     # Extract the arguments
     id = params[:id].to_i
     comment = params[:text]
 
     # Find the note and check it is valid

-    @note = Note.find_by_id(id)
+    @note = Note.find_by(:id => id)

     raise OSM::APINotFoundError unless @note
     raise OSM::APINotFoundError unless @note

-    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || @user.moderator?
-    raise OSM::APINoteAlreadyOpenError.new(@note) unless @note.closed? || !@note.visible?
+    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || current_user.moderator?
+    raise OSM::APINoteAlreadyOpenError, @note unless @note.closed? || !@note.visible?

 
     # Reopen the note and add a comment
     Note.transaction do
 
     # Reopen the note and add a comment
     Note.transaction do


@@ -205,12 +206,12 @@ class NotesController < ApplicationController
   # Read a note
   def show
     # Check the arguments are sane
   # Read a note
   def show
     # 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]

 
     # Find the note and check it is valid
     @note = Note.find(params[:id])
     raise OSM::APINotFoundError unless @note
 
     # Find the note and check it is valid
     @note = Note.find(params[:id])
     raise OSM::APINotFoundError unless @note

-    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible?
+    raise OSM::APIAlreadyDeletedError.new("note", @note.id) unless @note.visible? || (current_user && current_user.moderator?)

 
     # Render the result
     respond_to do |format|
 
     # Render the result
     respond_to do |format|


@@ -225,7 +226,7 @@ class NotesController < ApplicationController
   # Delete (hide) a note
   def destroy
     # Check the arguments are sane
   # Delete (hide) a note
   def destroy
     # 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


@@ -254,15 +255,49 @@ class NotesController < ApplicationController
   ##
   # Return a list of notes matching a given string
   def search
   ##
   # Return a list of notes matching a given string
   def search

-    # Check the arguments are sane
-    raise OSM::APIBadUserInput.new("No query string was given") unless params[:q]
+    # Filter either by the name or the id of the user
+    if params[:display_name]
+      @user = User.find_by(:display_name => params[:display_name])
+    elsif params[:id]
+      @user = User.find_by(:id => params[:id])
+    end

 
 

-    # Get any conditions that need to be applied
-    @notes = closed_condition(Note.all)
-    @notes = @notes.joins(:comments).where("to_tsvector('english', note_comments.body) @@ plainto_tsquery('english', ?)", params[:q])
+    if @user
+      @notes = @user.notes
+      @notes = closed_condition(@notes)
+    elsif params[:display_name] || params[:id]
+      # Return an error message because obviously the user could not be found
+      raise OSM::APIBadUserInput, "The user could not be found"
+    else
+      @notes = closed_condition(Note.all)
+    end
+
+    # Filter by a given string
+    if params[:q]
+      # TODO: why doesn't this work if we want to filter the notes of a given user?
+      if !params[:display_name] && !params[:id]
+        @notes = @notes.joins(:comments).where("to_tsvector('english', note_comments.body) @@ plainto_tsquery('english', ?)", params[:q])
+      end
+    end
+
+    # Filter by a given start date and an optional end date
+    if params[:from]
+      from = DateTime.parse(params[:from])
+      if params[:to]
+        to = DateTime.parse(params[:to])
+      else
+        to = DateTime.now
+      end
+
+      if from && to
+        @notes = @notes.where("(created_at > '#{from}' AND created_at < '#{to}')")
+      else
+        raise OSM::APIBadUserInput, "The date is in a wrong format"
+      end
+    end

 
     # Find the notes we want to return
 
     # Find the notes we want to return

-    @notes = @notes.order("updated_at DESC").limit(result_limit).preload(:comments)
+    @notes = @notes.order("updated_at DESC").distinct.limit(result_limit).preload(:comments)

 
     # Render the result
     respond_to do |format|
 
     # Render the result
     respond_to do |format|


@@ -277,15 +312,16 @@ class NotesController < ApplicationController
   # Display a list of notes by a specified user
   def mine
     if params[:display_name]
   # Display a list of notes by a specified user
   def mine
     if params[:display_name]

-      if @this_user = User.active.find_by_display_name(params[:display_name])
-        @title = t "note.mine.title", :user => @this_user.display_name
-        @heading = t "note.mine.heading", :user => @this_user.display_name
-        @description = t "note.mine.subheading", :user => render_to_string(:partial => "user", :object => @this_user)
+      if @user = User.active.find_by(:display_name => params[:display_name])
+        @params = params.permit(:display_name)
+        @title = t "notes.mine.title", :user => @user.display_name
+        @heading = t "notes.mine.heading", :user => @user.display_name
+        @description = t "notes.mine.subheading", :user => render_to_string(:partial => "user", :object => @user)

         @page = (params[:page] || 1).to_i
         @page_size = 10
         @page = (params[:page] || 1).to_i
         @page_size = 10

-        @notes = @this_user.notes
-        @notes = @notes.visible unless @user && @user.moderator?
-        @notes = @notes.order("updated_at DESC, id").uniq.offset((@page - 1) * @page_size).limit(@page_size).preload(:comments => :author).to_a
+        @notes = @user.notes
+        @notes = @notes.visible unless current_user && current_user.moderator?
+        @notes = @notes.order("updated_at DESC, id").distinct.offset((@page - 1) * @page_size).limit(@page_size).preload(:comments => :author).to_a

       else
         @title = t "user.no_such_user.title"
         @not_found_user = params[:display_name]
       else
         @title = t "user.no_such_user.title"
         @not_found_user = params[:display_name]


@@ -308,7 +344,7 @@ class NotesController < 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("Note limit must be between 1 and 10000")
+        raise OSM::APIBadUserInput, "Note limit must be between 1 and 10000"

       end
     else
       100
       end
     else
       100


@@ -316,7 +352,7 @@ class NotesController < ApplicationController
   end
 
   ##
   end
 
   ##

-  # Generate a condition to choose which bugs we want based
+  # Generate a condition to choose which notes we want based

   # on their status and the user's request parameters
   def closed_condition(notes)
     closed_since = if params[:closed]
   # on their status and the user's request parameters
   def closed_condition(notes)
     closed_since = if params[:closed]


@@ -339,18 +375,16 @@ class NotesController < ApplicationController
   def add_comment(note, text, event, notify = true)
     attributes = { :visible => true, :event => event, :body => text }
 
   def add_comment(note, text, event, notify = true)
     attributes = { :visible => true, :event => event, :body => text }
 

-    if @user
-      attributes[:author_id] = @user.id
+    if current_user
+      attributes[:author_id] = current_user.id

     else
       attributes[:author_ip] = request.remote_ip
     end
 
     else
       attributes[:author_ip] = request.remote_ip
     end
 

-    comment = note.comments.create(attributes)
+    comment = note.comments.create!(attributes)

 
     note.comments.map(&:author).uniq.each do |user|
 
     note.comments.map(&:author).uniq.each do |user|

-      if notify && user && user != @user && user.visible?
-        Notifier.note_comment_notification(comment, user).deliver_now
-      end
+      Notifier.note_comment_notification(comment, user).deliver_now if notify && user && user != current_user && user.visible?

     end
   end
 end
     end
   end
 end