jro_apps/redmine Commit - r3652:345301284a9b

Added JSON support to the issues API. #1214...

Eric Davis -

r3652:345301284a9b

parent child

Context file:

r3652:345301284a9b

Collapse all files

app/controllers/application_controller.rb +7 0

@@ -349,4 +349,11 class ApplicationController < ActionController::Base
349	render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."	349	render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."
350	end	350	end
351		351
		352	# Converts the errors on an ActiveRecord object into a common JSON format
		353	def object_errors_to_json(object)
		354	object.errors.collect do \|attribute, error\|
		355	{ attribute => error }
		356	end.to_json
		357	end
		358
352	end	359	end

app/controllers/issues_controller.rb +8 -1

                   respond_to do |format|
                     format.html { render :template => 'issues/index.rhtml', :layout => !request.xhr? }
                     format.xml  { render :layout => false }
+                    format.json { render :text => @issues.to_json, :layout => false }
                     format.atom { render_feed(@issues, :title => "#{@project || Setting.app_title}: #{l(:label_issue_plural)}") }
                     format.csv  { send_data(issues_to_csv(@issues, @project), :type => 'text/csv; header=present', :filename => 'export.csv') }
                     format.pdf  { send_data(issues_to_pdf(@issues, @project, @query), :type => 'application/pdf', :filename => 'export.pdf') }
                 respond_to do |format|
                   format.html { render :template => 'issues/show.rhtml' }
                   format.xml  { render :layout => false }
+                  format.json { render :text => @issue.to_json, :layout => false }
                   format.atom { render :action => 'changes', :layout => false, :content_type => 'application/atom+xml' }
                   format.pdf  { send_data(issue_to_pdf(@issue), :type => 'application/pdf', :filename => "#{@project.identifier}-#{@issue.id}.pdf") }
                 end
                                   { :action => 'show', :id => @issue })
                     }
                     format.xml  { render :action => 'show', :status => :created, :location => url_for(:controller => 'issues', :action => 'show', :id => @issue) }
+                    format.json { render :text => @issue.to_json, :status => :created, :location => url_for(:controller => 'issues', :action => 'show'), :layout => false }
                   end
                   return
                 else
                   respond_to do |format|
                     format.html { render :action => 'new' }
                     format.xml  { render(:xml => @issue.errors, :status => :unprocessable_entity); return }
+                    format.json { render :text => object_errors_to_json(@issue), :status => :unprocessable_entity, :layout => false }
                   end
                 end
               end
                   respond_to do |format|
                     format.html { redirect_back_or_default({:action => 'show', :id => @issue}) }
                     format.xml  { head :ok }
+                    format.json  { head :ok }
                   end
                 else
                   render_attachment_warning_if_needed(@issue)
                   respond_to do |format|
                     format.html { render :action => 'edit' }
                     format.xml  { render :xml => @issue.errors, :status => :unprocessable_entity }
+                    format.json { render :text => object_errors_to_json(@issue), :status => :unprocessable_entity, :layout => false }
                   end
                 end
               end
                       TimeEntry.update_all("issue_id = #{reassign_to.id}", ['issue_id IN (?)', @issues])
                     end
                   else
-                    unless params[:format] == 'xml'
+                    unless params[:format] == 'xml' || params[:format] == 'json'
                       # display the destroy form if it's a user request
                       return
                     end
                 respond_to do |format|
                   format.html { redirect_to :action => 'index', :project_id => @project }
                   format.xml  { head :ok }
+                  format.json  { head :ok }
                 end
               end

test/integration/issues_api_test.rb +155 -3

@@ -54,7 +54,20 class IssuesApiTest < ActionController::IntegrationTest
54	should_respond_with :success	54	should_respond_with :success
55	should_respond_with_content_type 'application/xml'	55	should_respond_with_content_type 'application/xml'
56	end	56	end
57		57
		58	context "/index.json" do
		59	setup do
		60	get '/issues.json'
		61	end
		62
		63	should_respond_with :success
		64	should_respond_with_content_type 'application/json'
		65
		66	should 'return a valid JSON string' do
		67	assert ActiveSupport::JSON.decode(response.body)
		68	end
		69	end
		70
58	context "/index.xml with filter" do	71	context "/index.xml with filter" do
59	setup do	72	setup do
60	get '/issues.xml?status_id=5'	73	get '/issues.xml?status_id=5'
@@ -69,6 +82,27 class IssuesApiTest < ActionController::IntegrationTest
69	end	82	end
70	end	83	end
71		84
		85	context "/index.json with filter" do
		86	setup do
		87	get '/issues.json?status_id=5'
		88	end
		89
		90	should_respond_with :success
		91	should_respond_with_content_type 'application/json'
		92
		93	should 'return a valid JSON string' do
		94	assert ActiveSupport::JSON.decode(response.body)
		95	end
		96
		97	should "show only issues with the status_id" do
		98	json = ActiveSupport::JSON.decode(response.body)
		99	status_ids_used = json.collect {\|j\| j['status_id'] }
		100	assert_equal 3, status_ids_used.length
		101	assert status_ids_used.all? {\|id\| id == 5 }
		102	end
		103
		104	end
		105
72	context "/issues/1.xml" do	106	context "/issues/1.xml" do
73	setup do	107	setup do
74	get '/issues/1.xml'	108	get '/issues/1.xml'
@@ -78,6 +112,19 class IssuesApiTest < ActionController::IntegrationTest
78	should_respond_with_content_type 'application/xml'	112	should_respond_with_content_type 'application/xml'
79	end	113	end
80		114
		115	context "/issues/1.json" do
		116	setup do
		117	get '/issues/1.json'
		118	end
		119
		120	should_respond_with :success
		121	should_respond_with_content_type 'application/json'
		122
		123	should 'return a valid JSON string' do
		124	assert ActiveSupport::JSON.decode(response.body)
		125	end
		126	end
		127
81	context "POST /issues.xml" do	128	context "POST /issues.xml" do
82	setup do	129	setup do
83	@issue_count = Issue.count	130	@issue_count = Issue.count
@@ -111,7 +158,42 class IssuesApiTest < ActionController::IntegrationTest
111	assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}	158	assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
112	end	159	end
113	end	160	end
114		161
		162	context "POST /issues.json" do
		163	setup do
		164	@issue_count = Issue.count
		165	@attributes = {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}
		166	post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith')
		167	end
		168
		169	should_respond_with :created
		170	should_respond_with_content_type 'application/json'
		171
		172	should "create an issue with the attributes" do
		173	assert_equal Issue.count, @issue_count + 1
		174
		175	issue = Issue.first(:order => 'id DESC')
		176	@attributes.each do \|attribute, value\|
		177	assert_equal value, issue.send(attribute)
		178	end
		179	end
		180	end
		181
		182	context "POST /issues.json with failure" do
		183	setup do
		184	@attributes = {:project_id => 1}
		185	post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith')
		186	end
		187
		188	should_respond_with :unprocessable_entity
		189	should_respond_with_content_type 'application/json'
		190
		191	should "have an errors element" do
		192	json = ActiveSupport::JSON.decode(response.body)
		193	assert_equal "can't be blank", json.first['subject']
		194	end
		195	end
		196
115	context "PUT /issues/1.xml" do	197	context "PUT /issues/1.xml" do
116	setup do	198	setup do
117	@issue_count = Issue.count	199	@issue_count = Issue.count
@@ -166,6 +248,61 class IssuesApiTest < ActionController::IntegrationTest
166	end	248	end
167	end	249	end
168		250
		251	context "PUT /issues/1.json" do
		252	setup do
		253	@issue_count = Issue.count
		254	@journal_count = Journal.count
		255	@attributes = {:subject => 'API update'}
		256
		257	put '/issues/1.json', {:issue => @attributes}, :authorization => credentials('jsmith')
		258	end
		259
		260	should_respond_with :ok
		261	should_respond_with_content_type 'application/json'
		262
		263	should "not create a new issue" do
		264	assert_equal Issue.count, @issue_count
		265	end
		266
		267	should "create a new journal" do
		268	assert_equal Journal.count, @journal_count + 1
		269	end
		270
		271	should "update the issue" do
		272	issue = Issue.find(1)
		273	@attributes.each do \|attribute, value\|
		274	assert_equal value, issue.send(attribute)
		275	end
		276	end
		277
		278	end
		279
		280	context "PUT /issues/1.json with failed update" do
		281	setup do
		282	@attributes = {:subject => ''}
		283	@issue_count = Issue.count
		284	@journal_count = Journal.count
		285
		286	put '/issues/1.json', {:issue => @attributes}, :authorization => credentials('jsmith')
		287	end
		288
		289	should_respond_with :unprocessable_entity
		290	should_respond_with_content_type 'application/json'
		291
		292	should "not create a new issue" do
		293	assert_equal Issue.count, @issue_count
		294	end
		295
		296	should "not create a new journal" do
		297	assert_equal Journal.count, @journal_count
		298	end
		299
		300	should "have an errors attribute" do
		301	json = ActiveSupport::JSON.decode(response.body)
		302	assert_equal "can't be blank", json.first['subject']
		303	end
		304	end
		305
169	context "DELETE /issues/1.xml" do	306	context "DELETE /issues/1.xml" do
170	setup do	307	setup do
171	@issue_count = Issue.count	308	@issue_count = Issue.count
@@ -180,7 +317,22 class IssuesApiTest < ActionController::IntegrationTest
180	assert_nil Issue.find_by_id(1)	317	assert_nil Issue.find_by_id(1)
181	end	318	end
182	end	319	end
183		320
		321	context "DELETE /issues/1.json" do
		322	setup do
		323	@issue_count = Issue.count
		324	delete '/issues/1.json', {}, :authorization => credentials('jsmith')
		325	end
		326
		327	should_respond_with :ok
		328	should_respond_with_content_type 'application/json'
		329
		330	should "delete the issue" do
		331	assert_equal Issue.count, @issue_count -1
		332	assert_nil Issue.find_by_id(1)
		333	end
		334	end
		335
184	def credentials(user, password=nil)	336	def credentials(user, password=nil)
185	ActionController::HttpAuthentication::Basic.encode_credentials(user, password \|\| user)	337	ActionController::HttpAuthentication::Basic.encode_credentials(user, password \|\| user)
186	end	338	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