From 345301284a9b47d98bf7af8c09d1c6301b9a2a81 Mon Sep 17 00:00:00 2001
From: Eric Davis <edavis@littlestreamsoftware.com>
Date: Sat, 5 Jun 2010 03:52:59 +0000
Subject: [PATCH] Added JSON support to the issues API. #1214
git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3766 e93f8b46-1217-0410-a6f0-8f06a7374b81
---
app/controllers/application_controller.rb | 7 +
app/controllers/issues_controller.rb | 9 +-
test/integration/issues_api_test.rb | 158 +++++++++++++++++++++-
3 files changed, 170 insertions(+), 4 deletions(-)
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 54339b4e9..909125475 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -349,4 +349,11 @@ class ApplicationController < ActionController::Base
render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."
end
+ # Converts the errors on an ActiveRecord object into a common JSON format
+ def object_errors_to_json(object)
+ object.errors.collect do |attribute, error|
+ { attribute => error }
+ end.to_json
+ end
+
end
diff --git a/app/controllers/issues_controller.rb b/app/controllers/issues_controller.rb
index 6b42ce62b..8b5d73fa3 100644
--- a/app/controllers/issues_controller.rb
+++ b/app/controllers/issues_controller.rb
@@ -82,6 +82,7 @@ class IssuesController < ApplicationController
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') }
@@ -122,6 +123,7 @@ class IssuesController < ApplicationController
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
@@ -146,12 +148,14 @@ class IssuesController < ApplicationController
{ :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
@@ -181,6 +185,7 @@ class IssuesController < ApplicationController
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)
@@ -190,6 +195,7 @@ class IssuesController < ApplicationController
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
@@ -305,7 +311,7 @@ class IssuesController < ApplicationController
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
@@ -315,6 +321,7 @@ class IssuesController < ApplicationController
respond_to do |format|
format.html { redirect_to :action => 'index', :project_id => @project }
format.xml { head :ok }
+ format.json { head :ok }
end
end
diff --git a/test/integration/issues_api_test.rb b/test/integration/issues_api_test.rb
index ab1489834..a1e2cb703 100644
--- a/test/integration/issues_api_test.rb
+++ b/test/integration/issues_api_test.rb
@@ -54,7 +54,20 @@ class IssuesApiTest < ActionController::IntegrationTest
should_respond_with :success
should_respond_with_content_type 'application/xml'
end
-
+
+ context "/index.json" do
+ setup do
+ get '/issues.json'
+ end
+
+ should_respond_with :success
+ should_respond_with_content_type 'application/json'
+
+ should 'return a valid JSON string' do
+ assert ActiveSupport::JSON.decode(response.body)
+ end
+ end
+
context "/index.xml with filter" do
setup do
get '/issues.xml?status_id=5'
@@ -69,6 +82,27 @@ class IssuesApiTest < ActionController::IntegrationTest
end
end
+ context "/index.json with filter" do
+ setup do
+ get '/issues.json?status_id=5'
+ end
+
+ should_respond_with :success
+ should_respond_with_content_type 'application/json'
+
+ should 'return a valid JSON string' do
+ assert ActiveSupport::JSON.decode(response.body)
+ end
+
+ should "show only issues with the status_id" do
+ json = ActiveSupport::JSON.decode(response.body)
+ status_ids_used = json.collect {|j| j['status_id'] }
+ assert_equal 3, status_ids_used.length
+ assert status_ids_used.all? {|id| id == 5 }
+ end
+
+ end
+
context "/issues/1.xml" do
setup do
get '/issues/1.xml'
@@ -78,6 +112,19 @@ class IssuesApiTest < ActionController::IntegrationTest
should_respond_with_content_type 'application/xml'
end
+ context "/issues/1.json" do
+ setup do
+ get '/issues/1.json'
+ end
+
+ should_respond_with :success
+ should_respond_with_content_type 'application/json'
+
+ should 'return a valid JSON string' do
+ assert ActiveSupport::JSON.decode(response.body)
+ end
+ end
+
context "POST /issues.xml" do
setup do
@issue_count = Issue.count
@@ -111,7 +158,42 @@ class IssuesApiTest < ActionController::IntegrationTest
assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
end
end
-
+
+ context "POST /issues.json" do
+ setup do
+ @issue_count = Issue.count
+ @attributes = {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}
+ post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+ end
+
+ should_respond_with :created
+ should_respond_with_content_type 'application/json'
+
+ should "create an issue with the attributes" do
+ assert_equal Issue.count, @issue_count + 1
+
+ issue = Issue.first(:order => 'id DESC')
+ @attributes.each do |attribute, value|
+ assert_equal value, issue.send(attribute)
+ end
+ end
+ end
+
+ context "POST /issues.json with failure" do
+ setup do
+ @attributes = {:project_id => 1}
+ post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+ end
+
+ should_respond_with :unprocessable_entity
+ should_respond_with_content_type 'application/json'
+
+ should "have an errors element" do
+ json = ActiveSupport::JSON.decode(response.body)
+ assert_equal "can't be blank", json.first['subject']
+ end
+ end
+
context "PUT /issues/1.xml" do
setup do
@issue_count = Issue.count
@@ -166,6 +248,61 @@ class IssuesApiTest < ActionController::IntegrationTest
end
end
+ context "PUT /issues/1.json" do
+ setup do
+ @issue_count = Issue.count
+ @journal_count = Journal.count
+ @attributes = {:subject => 'API update'}
+
+ put '/issues/1.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+ end
+
+ should_respond_with :ok
+ should_respond_with_content_type 'application/json'
+
+ should "not create a new issue" do
+ assert_equal Issue.count, @issue_count
+ end
+
+ should "create a new journal" do
+ assert_equal Journal.count, @journal_count + 1
+ end
+
+ should "update the issue" do
+ issue = Issue.find(1)
+ @attributes.each do |attribute, value|
+ assert_equal value, issue.send(attribute)
+ end
+ end
+
+ end
+
+ context "PUT /issues/1.json with failed update" do
+ setup do
+ @attributes = {:subject => ''}
+ @issue_count = Issue.count
+ @journal_count = Journal.count
+
+ put '/issues/1.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+ end
+
+ should_respond_with :unprocessable_entity
+ should_respond_with_content_type 'application/json'
+
+ should "not create a new issue" do
+ assert_equal Issue.count, @issue_count
+ end
+
+ should "not create a new journal" do
+ assert_equal Journal.count, @journal_count
+ end
+
+ should "have an errors attribute" do
+ json = ActiveSupport::JSON.decode(response.body)
+ assert_equal "can't be blank", json.first['subject']
+ end
+ end
+
context "DELETE /issues/1.xml" do
setup do
@issue_count = Issue.count
@@ -180,7 +317,22 @@ class IssuesApiTest < ActionController::IntegrationTest
assert_nil Issue.find_by_id(1)
end
end
-
+
+ context "DELETE /issues/1.json" do
+ setup do
+ @issue_count = Issue.count
+ delete '/issues/1.json', {}, :authorization => credentials('jsmith')
+ end
+
+ should_respond_with :ok
+ should_respond_with_content_type 'application/json'
+
+ should "delete the issue" do
+ assert_equal Issue.count, @issue_count -1
+ assert_nil Issue.find_by_id(1)
+ end
+ end
+
def credentials(user, password=nil)
ActionController::HttpAuthentication::Basic.encode_credentials(user, password || user)
end
--
GitLab