add search_term to files, modules, and module item apis

test plan:
* test the new /courses/:course_id/files index endpoint,
 which should return all files that belong to a course
* refer to the API documentation to test the
 search_term parameter (which should work as with other
 API index actions), for:
  - Files (both folder and course specific)
  - Modules
  - Module Items

closes #CNVS-6904

Change-Id: I4c6f80792cda453d53bf48741d14e851f5040dd4
Reviewed-on: https://gerrit.instructure.com/22746
Reviewed-by: Jeremy Stanley <jeremy@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
QA-Review: August Thornton <august@instructure.com>
Product-Review: Bracken Mosbacker <bracken@instructure.com>

Author: maneframe

app/controllers/context_module_items_api_controller.rb

@@ -90,6 +90,7 @@ class ContextModuleItemsApiController < ApplicationController
   #
   # @argument include[] ["content_details"] If included, will return additional details specific to the content associated with each item.
   #    Refer to the {api:Modules:Module%20Item Module Item specification} for more details.
+  # @argument search_term (optional) The partial title of the items to match and return.
   #
   # @example_request
   #     curl -H 'Authorization: Bearer <token>' \
@@ -102,6 +103,7 @@ def index
       ContextModule.send(:preload_associations, mod, {:content_tags => :content})
       route = polymorphic_url([:api_v1, @context, mod, :items])
       scope = mod.content_tags_visible_to(@current_user)
+      scope = ContentTag.search_by_attribute(scope, :title, params[:search_term])
       items = Api.paginate(scope, self, route)
       prog = @context.grants_right?(@current_user, session, :participate_as_student) ? mod.evaluate_for(@current_user) : nil
       render :json => items.map { |item| module_item_json(item, @current_user, session, mod, prog, Array(params[:include])) }

app/controllers/context_modules_api_controller.rb

@@ -85,6 +85,7 @@ class ContextModulesApiController < ApplicationController
   #    if items are not returned.
   # @argument include[] ["content_details"] (Requires include['items']) Returns additional details with module items specific to their associated content items.
   #    Refer to the {api:Modules:Module%20Item Module Item specification} for more details.
+  # @argument search_term (optional) The partial name of the modules (and module items, if include['items'] is specified) to match and return.
   #
   # @example_request
   #     curl -H 'Authorization: Bearer <token>' \
@@ -95,16 +96,24 @@ def index
     if authorized_action(@context, @current_user, :read)
       route = polymorphic_url([:api_v1, @context, :context_modules])
       scope = @context.modules_visible_to(@current_user)
-      modules = Api.paginate(scope, self, route)
+
       includes = Array(params[:include])
+      scope = ContextModule.search_by_attribute(scope, :name, params[:search_term]) unless includes.include?('items')
+      modules = Api.paginate(scope, self, route)
+
       ContextModule.send(:preload_associations, modules, {:content_tags => :content}) if includes.include?('items')
 
       modules_and_progressions = if @context.grants_right?(@current_user, session, :participate_as_student)
         modules.map { |m| [m, m.evaluate_for(@current_user, true)] }
       else
         modules.map { |m| [m, nil] }
       end
-      render :json => modules_and_progressions.map { |mod, prog| module_json(mod, @current_user, session, prog, includes) }
+      opts = {}
+      if includes.include?('items') && params[:search_term].present?
+        SearchTermHelper.validate_search_term(params[:search_term])
+        opts[:search_term] = params[:search_term]
+      end
+      render :json => modules_and_progressions.map { |mod, prog| module_json(mod, @current_user, session, prog, includes, opts) }.compact
     end
   end
 

app/controllers/files_controller.rb

@@ -116,9 +116,10 @@ def index
   end
 
   # @API List files
-  # Returns the paginated list of files for the folder.
+  # Returns the paginated list of files for the folder or course.
   #
   # @argument content_types[] [optional] Filter results by content-type. You can specify type/subtype pairs (e.g., 'image/jpeg'), or simply types (e.g., 'image', which will match 'image/gif', 'image/jpeg', etc.).
+  # @argument search_term (optional) The partial name of the files to match and return.
   #
   # @example_request
   #
@@ -127,16 +128,34 @@ def index
   #
   # @returns [File]
   def api_index
-    folder = Folder.find(params[:id])
+    get_context
+    if @context
+      folder = Folder.root_folders(@context).first
+      raise ActiveRecord::RecordNotFound unless folder
+      context_index = true
+    else
+      folder = Folder.find(params[:id])
+    end
+
     if authorized_action(folder, @current_user, :read_contents)
-      @context = folder.context
+      @context = folder.context unless context_index
       can_manage_files = @context.grants_right?(@current_user, session, :manage_files)
 
-      if can_manage_files
-        scope = folder.active_file_attachments
+      if context_index
+        if can_manage_files
+          scope = @context.attachments.not_deleted
+        else
+          scope = @context.attachments.visible.not_hidden.not_locked.where(
+              :folder_id => @context.active_folders.not_hidden.not_locked)
+        end
       else
-        scope = folder.visible_file_attachments.not_hidden.not_locked
+        if can_manage_files
+          scope = folder.active_file_attachments
+        else
+          scope = folder.visible_file_attachments.not_hidden.not_locked
+        end
       end
+      scope = Attachment.search_by_attribute(scope, :display_name, params[:search_term])
       if params[:sort_by] == 'position'
         scope = scope.by_position_then_display_name
       else
@@ -147,7 +166,8 @@ def api_index
         scope = scope.by_content_types(Array(params[:content_types]))
       end
 
-      @files = Api.paginate(scope, self, api_v1_list_files_url(@folder))
+      url = context_index ? context_files_url : api_v1_list_files_url(folder)
+      @files = Api.paginate(scope, self, url)
       render :json => attachments_json(@files, @current_user, {}, :can_manage_files => can_manage_files)
     end
   end

app/models/attachment.rb

@@ -25,6 +25,7 @@ def self.display_name_order_by_clause(table = nil)
   attr_accessible :context, :folder, :filename, :display_name, :user, :locked, :position, :lock_at, :unlock_at, :uploaded_data, :hidden
   include HasContentTags
   include ContextModuleItem
+  include SearchTermHelper
 
   attr_accessor :podcast_associated_asset, :submission_attachment
 
@@ -1277,6 +1278,7 @@ def self.filtering_scribd_submits?
     state :unattached_temporary
   end
 
+  scope :visible, where(['attachments.file_state in (?, ?)', 'available', 'public'])
   scope :not_deleted, where("attachments.file_state<>'deleted'")
 
   scope :not_hidden, where("attachments.file_state<>'hidden'")

app/models/content_tag.rb

@@ -25,6 +25,7 @@ def initialize( alignment )
     end 
   end
   include Workflow
+  include SearchTermHelper
   belongs_to :content, :polymorphic => true
   belongs_to :context, :polymorphic => true
   belongs_to :associated_asset, :polymorphic => true

app/models/context_module.rb

@@ -18,6 +18,7 @@
 
 class ContextModule < ActiveRecord::Base
   include Workflow
+  include SearchTermHelper
   attr_accessible :context, :name, :unlock_at, :require_sequential_progress, :completion_requirements, :prerequisites
   belongs_to :context, :polymorphic => true
   belongs_to :cloned_item

config/routes.rb

@@ -837,6 +837,7 @@
       post 'courses/:course_id/preview_html', :action => :preview_html
       post 'courses/:course_id/course_copy', :controller => :content_imports, :action => :copy_course_content
       get 'courses/:course_id/course_copy/:id', :controller => :content_imports, :action => :copy_course_status, :path_name => :course_copy_status
+      get  'courses/:course_id/files', :controller => :files, :action => :api_index, :path_name => 'course_files'
       post 'courses/:course_id/files', :action => :create_file, :path_name => 'course_create_file'
       post 'courses/:course_id/folders', :controller => :folders, :action => :create
       get  'courses/:course_id/folders/:id', :controller => :folders, :action => :show, :path_name => 'course_folder'

db/migrate/20130729175222_add_additional_gist_indexes_for_api_search.rb

@@ -0,0 +1,31 @@
+class AddAdditionalGistIndexesForApiSearch < ActiveRecord::Migration
+  self.transactional = false
+  tag :predeploy
+
+  def self.up
+    if is_postgres?
+      connection.transaction(:requires_new => true) do
+        begin
+          execute('create extension if not exists pg_trgm;')
+        rescue ActiveRecord::StatementInvalid
+          raise ActiveRecord::Rollback
+        end
+      end
+
+      if has_postgres_proc?('show_trgm')
+        concurrently = " CONCURRENTLY" if connection.open_transactions == 0
+        execute("create index#{concurrently} index_trgm_attachments_display_name on attachments USING gist(lower(display_name) gist_trgm_ops);")
+        execute("create index#{concurrently} index_trgm_context_modules_name on context_modules USING gist(lower(name) gist_trgm_ops);")
+        execute("create index#{concurrently} index_trgm_content_tags_title on content_tags USING gist(lower(title) gist_trgm_ops);")
+      end
+    end
+  end
+
+  def self.down
+    if is_postgres?
+      execute('drop index if exists index_trgm_attachments_display_name;')
+      execute('drop index if exists index_trgm_context_modules_name;')
+      execute('drop index if exists index_trgm_content_tags_title;')
+    end
+  end
+end

lib/api/v1/attachment.rb

@@ -173,4 +173,9 @@ def process_attachment_params(params)
     new_atts[:hidden] = value_to_boolean(params[:hidden]) if params.has_key?(:hidden)
     new_atts
   end
+
+  def context_files_url
+    # change if context_api_index route is expanded to other contexts besides courses
+    api_v1_course_files_url(@context)
+  end
 end

lib/api/v1/context_module.rb

@@ -25,7 +25,7 @@ module Api::V1::ContextModule
   MODULE_ITEM_JSON_ATTRS = %w(id position title indent)
 
   # optionally pass progression to include 'state', 'completed_at'
-  def module_json(context_module, current_user, session, progression = nil, includes = [])
+  def module_json(context_module, current_user, session, progression = nil, includes = [], opts = {})
     hash = api_json(context_module, current_user, session, :only => MODULE_JSON_ATTRS)
     hash['require_sequential_progress'] = !!context_module.require_sequential_progress
     hash['prerequisite_module_ids'] = context_module.prerequisites.reject{|p| p[:type] != 'context_module'}.map{|p| p[:id]}
@@ -40,6 +40,10 @@ def module_json(context_module, current_user, session, progression = nil, includ
     hash['items_count'] = count
     hash['items_url'] = polymorphic_url([:api_v1, context_module.context, context_module, :items])
     if includes.include?('items') && count <= Setting.get_cached('api_max_per_page', '50').to_i
+      if opts[:search_term].present? && !context_module.matches_attribute?(:name, opts[:search_term])
+        tags = ContentTag.search_by_attribute(tags, :title, opts[:search_term])
+        return nil if tags.count == 0
+      end
       item_includes = includes & ['content_details']
       hash['items'] = tags.map do |tag|
         module_item_json(tag, current_user, session, context_module, progression, item_includes, :has_update_rights => has_update_rights)