jro_apps/redmine Commit - r14880:5533a2b5f2e4

REST API for Search (#6277)....

Jean-Philippe Lang -

r14880:5533a2b5f2e4

parent child

Context file:

r14880:5533a2b5f2e4

Collapse all files

app/views/search/index.api.rsb created 644 +12 0

@@ -0,0 +1,12
	1	api.array :results do
	2	@results.each do \|result\|
	3	api.result do
	4	api.id result.id
	5	api.title result.event_title
	6	api.type result.event_type
	7	api.url url_for(result.event_url(:only_path => false))
	8	api.description result.event_description
	9	api.datetime result.event_datetime
	10	end
	11	end
	12	end

test/integration/api_test/search_test.rb created 644 +68 0

@@ -0,0 +1,68
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2015 Jean-Philippe Lang
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; either version 2
	7	# of the License, or (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	17
	18	require File.expand_path('../../../test_helper', __FILE__)
	19
	20	class Redmine::ApiTest::SearchTest < Redmine::ApiTest::Base
	21	fixtures :projects, :issues
	22
	23	test "GET /search.xml should return xml content" do
	24	get '/search.xml'
	25
	26	assert_response :success
	27	assert_equal 'application/xml', @response.content_type
	28	end
	29
	30	test "GET /search.json should return json content" do
	31	get '/search.json'
	32
	33	assert_response :success
	34	assert_equal 'application/json', @response.content_type
	35
	36	json = ActiveSupport::JSON.decode(response.body)
	37	assert_kind_of Hash, json
	38	assert_kind_of Array, json['results']
	39	end
	40
	41	test "GET /search.xml without query strings should return empty results" do
	42	get '/search.xml', :q => '', :all_words => ''
	43
	44	assert_response :success
	45	assert_equal 0, assigns(:results).size
	46	end
	47
	48	test "GET /search.xml with query strings should return results" do
	49	get '/search.xml', :q => 'recipe subproject commit', :all_words => ''
	50
	51	assert_response :success
	52	assert_not_empty(assigns(:results))
	53
	54	assert_select 'results[type=array]' do
	55	assert_select 'result', :count => assigns(:results).count
	56	assigns(:results).size.times.each do \|i\|
	57	assert_select 'result' do
	58	assert_select 'id', :text => assigns(:results)[i].id.to_s
	59	assert_select 'title', :text => assigns(:results)[i].event_title
	60	assert_select 'type', :text => assigns(:results)[i].event_type
	61	assert_select 'url', :text => url_for(assigns(:results)[i].event_url(:only_path => false))
	62	assert_select 'description', :text => assigns(:results)[i].event_description
	63	assert_select 'datetime'
	64	end
	65	end
	66	end
	67	end
	68	end

app/controllers/search_controller.rb +5 -1

             # Redmine - project management software
             # Copyright (C) 2006-2016  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class SearchController < ApplicationController
               before_filter :find_optional_project
+              accept_api_auth :index
               def index
                 @question = params[:q] || ""
                 @question.strip!
                 @all_words = params[:all_words] ? params[:all_words].present? : true
                 @titles_only = params[:titles_only] ? params[:titles_only].present? : false
                 @search_attachments = params[:attachments].presence || '0'
                 @open_issues = params[:open_issues] ? params[:open_issues].present? : false
                 # quick jump to an issue
                 if (m = @question.match(/^#?(\d+)$/)) && (issue = Issue.visible.find_by_id(m[1].to_i))
                   redirect_to issue_path(issue)
                   return
                 end
                 projects_to_search =
                   case params[:scope]
                   when 'all'
                     nil
                   when 'my_projects'
                     User.current.projects
                   when 'subprojects'
                     @project ? (@project.self_and_descendants.active.to_a) : nil
                   else
                     @project
                   end
                 @object_types = Redmine::Search.available_search_types.dup
                 if projects_to_search.is_a? Project
                   # don't search projects
                   @object_types.delete('projects')
                   # only show what the user is allowed to view
                   @object_types = @object_types.select {|o| User.current.allowed_to?("view_#{o}".to_sym, projects_to_search)}
                 end
                 @scope = @object_types.select {|t| params[t]}
                 @scope = @object_types if @scope.empty?
                 fetcher = Redmine::Search::Fetcher.new(
                   @question, User.current, @scope, projects_to_search,
                   :all_words => @all_words, :titles_only => @titles_only, :attachments => @search_attachments, :open_issues => @open_issues,
                   :cache => params[:page].present?
                 )
                 if fetcher.tokens.present?
                   @result_count = fetcher.result_count
                   @result_count_by_type = fetcher.result_count_by_type
                   @tokens = fetcher.tokens
                   per_page = Setting.search_results_per_page.to_i
                   per_page = 10 if per_page == 0
                   @result_pages = Paginator.new @result_count, per_page, params['page']
                   @results = fetcher.results(@result_pages.offset, @result_pages.per_page)
                 else
                   @question = ""
                 end
-                render :layout => false if request.xhr?
+                respond_to do |format|
+                  format.html { render :layout => false if request.xhr? }
+                  format.api  { @results ||= []; render :layout => false }
+                end
               end
             private
               def find_optional_project
                 return true unless params[:id]
                 @project = Project.find(params[:id])
                 check_project_privacy
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages