jro_apps/redmine Commit - r4372:5f57bceabbdc

Makes some attributes optional in API response to get faster/lightweight responses....

Jean-Philippe Lang -

r4372:5f57bceabbdc

parent child

Context file:

r4372:5f57bceabbdc

app/helpers/application_helper.rb +10 0

@@ -866,6 +866,16 module ApplicationHelper
866	def favicon	866	def favicon
867	"<link rel='shortcut icon' href='#{image_path('/favicon.ico')}' />"	867	"<link rel='shortcut icon' href='#{image_path('/favicon.ico')}' />"
868	end	868	end
		869
		870	# Returns true if arg is expected in the API response
		871	def include_in_api_response?(arg)
		872	unless @included_in_api_response
		873	param = params[:include]
		874	@included_in_api_response = param.is_a?(Array) ? param.collect(&:to_s) : param.to_s.split(',')
		875	@included_in_api_response.collect!(&:strip)
		876	end
		877	@included_in_api_response.include?(arg.to_s)
		878	end
869		879
870	private	880	private
871		881

app/views/issues/show.api.rsb +4 -4

               api.created_on @issue.created_on
               api.updated_on @issue.updated_on
-              render_api_issue_children(@issue, api)
+              render_api_issue_children(@issue, api) if include_in_api_response?('children')
               api.array :relations do
               	@issue.relations.select {|r| r.other_issue(@issue).visible? }.each do |relation|
               		api.relation(:id => relation.id, :issue_id => relation.other_issue(@issue).id, :relation_type => relation.relation_type_for(@issue), :delay => relation.delay)
               	end
-              end
+              end if include_in_api_response?('relations')
               api.array :changesets do
               	@issue.changesets.each do |changeset|
               			api.committed_on changeset.committed_on
               		end
               	end
-              end if User.current.allowed_to?(:view_changesets, @project) && @issue.changesets.any?
+              end if include_in_api_response?('changesets') && User.current.allowed_to?(:view_changesets, @project)
               api.array :journals do
               	@issue.journals.each do |journal|
               			end
               		end
               	end
-              end unless @issue.journals.empty?
+              end if include_in_api_response?('journals')
             end

app/views/projects/show.api.rsb +1 -1

                 @project.trackers.each do |tracker|
                   api.tracker(:id => tracker.id, :name => tracker.name)
                 end
-              end
+              end if include_in_api_response?('trackers')
             end

app/views/users/show.api.rsb +1 -1

                     end
                   end if membership.project
                 end
-              end if @memberships.present?
+              end if include_in_api_response?('memberships') && @memberships
             end

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

                 context "with journals" do
                   context ".xml" do
                     should "display journals" do
-                      get '/issues/1.xml'
+                      get '/issues/1.xml?include=journals'
                       assert_tag :tag => 'issue',
                         :child => {
                   context ".xml" do
                     should "display children" do
-                      get '/issues/1.xml'
+                      get '/issues/1.xml?include=children'
                       assert_tag :tag => 'issue',
                         :child => {
                     context ".json" do
                       should "display children" do
-                        get '/issues/1.json'
+                        get '/issues/1.json?include=children'
                         json = ActiveSupport::JSON.decode(response.body)
                         assert_equal([

General Comments 0

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

No TODOs yet

	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