jro_apps/redmine Commit - r11060:a0158eff9643

Add/remove issue watchers via the REST API (#6727)....

Jean-Philippe Lang -

r11060:a0158eff9643

parent child

Context file:

r11060:a0158eff9643

Collapse all files

app/controllers/watchers_controller.rb +11 -5

               before_filter :find_project
               before_filter :require_login, :check_project_privacy, :only => [:watch, :unwatch]
               before_filter :authorize, :only => [:new, :destroy]
+              accept_api_auth :create, :destroy
               def watch
                 if @watched.respond_to?(:visible?) && !@watched.visible?(User.current)
               end
               def create
-                if params[:watcher].is_a?(Hash) && request.post?
+                user_ids = []
-                  user_ids = params[:watcher][:user_ids] || [params[:watcher][:user_id]]
+                if params[:watcher].is_a?(Hash)
-                  user_ids.each do |user_id|
+                  user_ids << (params[:watcher][:user_ids] || params[:watcher][:user_id])
-                    Watcher.create(:watchable => @watched, :user_id => user_id)
+                else
+                  user_ids << params[:user_id]
                 end
+                user_ids.flatten.compact.uniq.each do |user_id|
+                  Watcher.create(:watchable => @watched, :user_id => user_id)
                 end
                 respond_to do |format|
                   format.html { redirect_to_referer_or {render :text => 'Watcher added.', :layout => true}}
                   format.js
+                  format.api { render_api_ok }
                 end
               end
               end
               def destroy
-                @watched.set_watcher(User.find(params[:user_id]), false) if request.post?
+                @watched.set_watcher(User.find(params[:user_id]), false)
                 respond_to do |format|
                   format.html { redirect_to :back }
                   format.js
+                  format.api { render_api_ok }
                 end
               end

app/views/issues/show.api.rsb +6 0

@@ -64,4 +64,10 api.issue do
64	end	64	end
65	end	65	end
66	end if include_in_api_response?('journals')	66	end if include_in_api_response?('journals')
		67
		68	api.array :watchers do
		69	@issue.watcher_users.each do \|user\|
		70	api.user :id => user.id, :name => user.name
		71	end
		72	end if include_in_api_response?('watchers') && User.current.allowed_to?(:view_issue_watchers, @issue.project)
67	end	73	end

config/routes.rb +3 0

               match 'watchers/watch', :controller=> 'watchers', :action => 'watch', :via => :post
               match 'watchers/unwatch', :controller=> 'watchers', :action => 'unwatch', :via => :post
               match 'watchers/autocomplete_for_user', :controller=> 'watchers', :action => 'autocomplete_for_user', :via => :get
+              # Specific routes for issue watchers API
+              post 'issues/:object_id/watchers', :to => 'watchers#create', :object_type => 'issue'
+              delete 'issues/:object_id/watchers/:user_id' => 'watchers#destroy', :object_type => 'issue'
               resources :projects do
                 member do

test/integration/api_test/issues_test.rb +51 0

@@ -453,6 +453,21 class Redmine::ApiTest::IssuesTest < Redmine::ApiTest::Base
453	end	453	end
454	end	454	end
455		455
		456	test "GET /issues/:id.xml?include=watchers should include watchers" do
		457	Watcher.create!(:user_id => 3, :watchable => Issue.find(1))
		458
		459	get '/issues/1.xml?include=watchers', {}, credentials('jsmith')
		460
		461	assert_response :ok
		462	assert_equal 'application/xml', response.content_type
		463	assert_select 'issue' do
		464	assert_select 'watchers', Issue.find(1).watchers.count
		465	assert_select 'watchers' do
		466	assert_select 'user[id=3]'
		467	end
		468	end
		469	end
		470
456	context "POST /issues.xml" do	471	context "POST /issues.xml" do
457	should_allow_api_authentication(	472	should_allow_api_authentication(
458	:post,	473	:post,
@@ -478,6 +493,18 class Redmine::ApiTest::IssuesTest < Redmine::ApiTest::Base
478	end	493	end
479	end	494	end
480		495
		496	test "POST /issues.xml with watcher_user_ids should create issue with watchers" do
		497	assert_difference('Issue.count') do
		498	post '/issues.xml',
		499	{:issue => {:project_id => 1, :subject => 'Watchers',
		500	:tracker_id => 2, :status_id => 3, :watcher_user_ids => [3, 1]}}, credentials('jsmith')
		501	assert_response :created
		502	end
		503	issue = Issue.order('id desc').first
		504	assert_equal 2, issue.watchers.size
		505	assert_equal [1, 3], issue.watcher_user_ids.sort
		506	end
		507
481	context "POST /issues.xml with failure" do	508	context "POST /issues.xml with failure" do
482	should "have an errors tag" do	509	should "have an errors tag" do
483	assert_no_difference('Issue.count') do	510	assert_no_difference('Issue.count') do
@@ -720,6 +747,30 class Redmine::ApiTest::IssuesTest < Redmine::ApiTest::Base
720	end	747	end
721	end	748	end
722		749
		750	test "POST /issues/:id/watchers.xml should add watcher" do
		751	assert_difference 'Watcher.count' do
		752	post '/issues/1/watchers.xml', {:user_id => 3}, credentials('jsmith')
		753
		754	assert_response :ok
		755	assert_equal '', response.body
		756	end
		757	watcher = Watcher.order('id desc').first
		758	assert_equal Issue.find(1), watcher.watchable
		759	assert_equal User.find(3), watcher.user
		760	end
		761
		762	test "DELETE /issues/:id/watchers/:user_id.xml should remove watcher" do
		763	Watcher.create!(:user_id => 3, :watchable => Issue.find(1))
		764
		765	assert_difference 'Watcher.count', -1 do
		766	delete '/issues/1/watchers/3.xml', {}, credentials('jsmith')
		767
		768	assert_response :ok
		769	assert_equal '', response.body
		770	end
		771	assert_equal false, Issue.find(1).watched_by?(User.find(3))
		772	end
		773
723	def test_create_issue_with_uploaded_file	774	def test_create_issue_with_uploaded_file
724	set_tmp_attachments_directory	775	set_tmp_attachments_directory
725	# upload the file	776	# upload the file

test/integration/routing/watchers_test.rb +10 0

@@ -47,5 +47,15 class RoutingWatchersTest < ActionController::IntegrationTest
47	{ :method => 'post', :path => "/watchers/unwatch" },	47	{ :method => 'post', :path => "/watchers/unwatch" },
48	{ :controller => 'watchers', :action => 'unwatch' }	48	{ :controller => 'watchers', :action => 'unwatch' }
49	)	49	)
		50	assert_routing(
		51	{ :method => 'post', :path => "/issues/12/watchers.xml" },
		52	{ :controller => 'watchers', :action => 'create',
		53	:object_type => 'issue', :object_id => '12', :format => 'xml' }
		54	)
		55	assert_routing(
		56	{ :method => 'delete', :path => "/issues/12/watchers/3.xml" },
		57	{ :controller => 'watchers', :action => 'destroy',
		58	:object_type => 'issue', :object_id => '12', :user_id => '3', :format => 'xml'}
		59	)
50	end	60	end
51	end	61	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