jro_apps/redmine Commit - r4344:735a83c59615

Converts IssuesController to use the new API template system and makes xml/json responses consistent (#6136)....

Jean-Philippe Lang -

r4344:735a83c59615

parent child

Context file:

r4344:735a83c59615

Collapse all files

app/views/issues/index.apit created 644 +32 0

@@ -0,0 +1,32
	1	api.array :issues do
	2	@issues.each do \|issue\|
	3	api.issue do
	4	api.id issue.id
	5	api.project(:id => issue.project_id, :name => issue.project.name) unless issue.project.nil?
	6	api.tracker(:id => issue.tracker_id, :name => issue.tracker.name) unless issue.tracker.nil?
	7	api.status(:id => issue.status_id, :name => issue.status.name) unless issue.status.nil?
	8	api.priority(:id => issue.priority_id, :name => issue.priority.name) unless issue.priority.nil?
	9	api.author(:id => issue.author_id, :name => issue.author.name) unless issue.author.nil?
	10	api.assigned_to(:id => issue.assigned_to_id, :name => issue.assigned_to.name) unless issue.assigned_to.nil?
	11	api.category(:id => issue.category_id, :name => issue.category.name) unless issue.category.nil?
	12	api.fixed_version(:id => issue.fixed_version_id, :name => issue.fixed_version.name) unless issue.fixed_version.nil?
	13	api.parent(:id => issue.parent_id) unless issue.parent.nil?
	14
	15	api.subject issue.subject
	16	api.description issue.description
	17	api.start_date issue.start_date
	18	api.due_date issue.due_date
	19	api.done_ratio issue.done_ratio
	20	api.estimated_hours issue.estimated_hours
	21
	22	api.array :custom_fields do
	23	issue.custom_field_values.each do \|custom_value\|
	24	api.custom_field custom_value.value, :id => custom_value.custom_field_id, :name => custom_value.custom_field.name
	25	end
	26	end
	27
	28	api.created_on issue.created_on
	29	api.updated_on issue.updated_on
	30	end
	31	end
	32	end

app/views/issues/show.apit created 644 +61 0

@@ -0,0 +1,61
	1	api.issue do
	2	api.id @issue.id
	3	api.project(:id => @issue.project_id, :name => @issue.project.name) unless @issue.project.nil?
	4	api.tracker(:id => @issue.tracker_id, :name => @issue.tracker.name) unless @issue.tracker.nil?
	5	api.status(:id => @issue.status_id, :name => @issue.status.name) unless @issue.status.nil?
	6	api.priority(:id => @issue.priority_id, :name => @issue.priority.name) unless @issue.priority.nil?
	7	api.author(:id => @issue.author_id, :name => @issue.author.name) unless @issue.author.nil?
	8	api.assigned_to(:id => @issue.assigned_to_id, :name => @issue.assigned_to.name) unless @issue.assigned_to.nil?
	9	api.category(:id => @issue.category_id, :name => @issue.category.name) unless @issue.category.nil?
	10	api.fixed_version(:id => @issue.fixed_version_id, :name => @issue.fixed_version.name) unless @issue.fixed_version.nil?
	11	api.parent(:id => @issue.parent_id) unless @issue.parent.nil?
	12
	13	api.subject @issue.subject
	14	api.description @issue.description
	15	api.start_date @issue.start_date
	16	api.due_date @issue.due_date
	17	api.done_ratio @issue.done_ratio
	18	api.estimated_hours @issue.estimated_hours
	19	if User.current.allowed_to?(:view_time_entries, @project)
	20	api.spent_hours @issue.spent_hours
	21	end
	22
	23	api.array :custom_fields do
	24	@issue.custom_field_values.each do \|custom_value\|
	25	api.custom_field custom_value.value, :id => custom_value.custom_field_id, :name => custom_value.custom_field.name
	26	end
	27	end unless @issue.custom_field_values.empty?
	28
	29	api.created_on @issue.created_on
	30	api.updated_on @issue.updated_on
	31
	32	api.array :relations do
	33	@issue.relations.select {\|r\| r.other_issue(@issue).visible? }.each do \|relation\|
	34	api.relation(:id => relation.id, :issue_id => relation.other_issue(@issue).id, :relation_type => relation.relation_type_for(@issue), :delay => relation.delay)
	35	end
	36	end
	37
	38	api.array :changesets do
	39	@issue.changesets.each do \|changeset\|
	40	api.changeset :revision => changeset.revision do
	41	api.user(:id => changeset.user_id, :name => changeset.user.name) unless changeset.user.nil?
	42	api.comments changeset.comments
	43	api.committed_on changeset.committed_on
	44	end
	45	end
	46	end if User.current.allowed_to?(:view_changesets, @project) && @issue.changesets.any?
	47
	48	api.array :journals do
	49	@issue.journals.each do \|journal\|
	50	api.journal :id => journal.id do
	51	api.user(:id => journal.user_id, :name => journal.user.name) unless journal.user.nil?
	52	api.notes journal.notes
	53	api.array :details do
	54	journal.details.each do \|detail\|
	55	api.detail :property => detail.property, :name => detail.prop_key, :old => detail.old_value, :new => detail.value
	56	end
	57	end
	58	end
	59	end
	60	end unless @issue.journals.empty?
	61	end

app/controllers/issues_controller.rb +9 -18

                   respond_to do |format|
                     format.html { render :template => 'issues/index.rhtml', :layout => !request.xhr? }
-                    format.xml  { render :layout => false }
+                    format.api  { render :template => 'issues/index.apit' }
-                    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') }
                 @time_entry = TimeEntry.new
                 respond_to do |format|
                   format.html { render :template => 'issues/show.rhtml' }
-                  format.xml  { render :layout => false }
+                  format.api  { render :template => 'issues/show.apit' }
-                  format.json { render :text => @issue.to_json, :layout => false }
                   format.atom { render :template => 'journals/index', :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
                       redirect_to(params[:continue] ?  { :action => 'new', :project_id => @project, :issue => {:tracker_id => @issue.tracker, :parent_issue_id => @issue.parent_issue_id}.reject {|k,v| v.nil?} } :
                                   { :action => 'show', :id => @issue })
                     }
-                    format.xml  { render :action => 'show', :status => :created, :location => url_for(:controller => 'issues', :action => 'show', :id => @issue) }
+                    format.api  { render :template => 'issues/show.apit', :status => :created, :location => issue_url(@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.api  { render_validation_errors(@issue) }
-                    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.api  { 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.api  { render_validation_errors(@issue) }
-                    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' || params[:format] == 'json'
+                    # display the destroy form if it's a user request
-                      # display the destroy form if it's a user request
+                    return unless api_request?
-                      return
-                    end
                   end
                 end
                 @issues.each(&:destroy)
                 respond_to do |format|
                   format.html { redirect_back_or_default(:action => 'index', :project_id => @project) }
-                  format.xml  { head :ok }
+                  format.api  { head :ok }
-                  format.json  { head :ok }
                 end
               end

lib/redmine/views/builders/structure.rb +2 0

                         if args.first.is_a?(Hash)
                           if @struct.last.is_a?(Array)
                             @struct.last << args.first
+                          else
+                            @struct.last[sym] = args.first
                           end
                         else
                           if @struct.last.is_a?(Array)

test/integration/api_test/issues_test.rb +3 -3

                   get '/issues.json?status_id=5'
                   json = ActiveSupport::JSON.decode(response.body)
-                  status_ids_used = json.collect {|j| j['status_id'] }
+                  status_ids_used = json['issues'].collect {|j| j['status']['id'] }
                   assert_equal 3, status_ids_used.length
                   assert status_ids_used.all? {|id| id == 5 }
                 end
                   end
                   json = ActiveSupport::JSON.decode(response.body)
-                  assert_equal "can't be blank", json.first['subject']
+                  assert json['errors'].include?(['subject', "can't be blank"])
                 end
               end
                   put '/issues/6.json', @parameters, @headers
                   json = ActiveSupport::JSON.decode(response.body)
-                  assert_equal "can't be blank", json.first['subject']
+                  assert json['errors'].include?(['subject', "can't be blank"])
                 end
               end

test/unit/lib/redmine/views/builders/json_test.rb +9 0

@@ -28,6 +28,15 class Redmine::Views::Builders::JsonTest < HelperTestCase
28	end	28	end
29	end	29	end
30		30
		31	def test_hash_hash
		32	assert_json_output({'person' => {'name' => 'Ryan', 'birth' => {'city' => 'London', 'country' => 'UK'}}}) do \|b\|
		33	b.person do
		34	b.name 'Ryan'
		35	b.birth :city => 'London', :country => 'UK'
		36	end
		37	end
		38	end
		39
31	def test_array	40	def test_array
32	assert_json_output({'books' => [{'title' => 'Book 1', 'author' => 'B. Smith'}, {'title' => 'Book 2', 'author' => 'G. Cooper'}]}) do \|b\|	41	assert_json_output({'books' => [{'title' => 'Book 1', 'author' => 'B. Smith'}, {'title' => 'Book 2', 'author' => 'G. Cooper'}]}) do \|b\|
33	b.array :books do \|b\|	42	b.array :books do \|b\|

app/views/issues/index.xml.builder removed 0 -33

NO CONTENT: file was removed

app/views/issues/show.xml.builder removed 0 -62

NO CONTENT: file was removed

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