jro_apps/redmine Commit - r9905:3c3bdb8bb07e

Adds JSONP support to the API (#11469)....

Jean-Philippe Lang -

r9905:3c3bdb8bb07e

parent child

Context file:

r9905:3c3bdb8bb07e

Collapse all files

test/integration/api_test/jsonp_test.rb created 644 +54 0

			@@ -0,0 +1,54
		1	# Redmine - project management software
		2	# Copyright (C) 2006-2012 Jean-Philippe Lang
		3	#
		4	# This program is free software; you can redistribute it and/or
		5	# modify it under the terms of the GNU General Public License
		6	# as published by the Free Software Foundation; either version 2
		7	# of the License, or (at your option) any later version.
		8	#
		9	# This program is distributed in the hope that it will be useful,
		10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		12	# GNU General Public License for more details.
		13	#
		14	# You should have received a copy of the GNU General Public License
		15	# along with this program; if not, write to the Free Software
		16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
		17
		18	require File.expand_path('../../../test_helper', __FILE__)
		19
		20	class ApiTest::JsonpTest < ActionController::IntegrationTest
		21	fixtures :trackers
		22
		23	def test_jsonp_should_accept_callback_param
		24	get '/trackers.json?callback=handler'
		25
		26	assert_response :success
		27	assert_match %r{^handler$\{"trackers":.+\}$$}, response.body
		28	assert_equal 'application/javascript; charset=utf-8', response.headers['Content-Type']
		29	end
		30
		31	def test_jsonp_should_accept_jsonp_param
		32	get '/trackers.json?jsonp=handler'
		33
		34	assert_response :success
		35	assert_match %r{^handler$\{"trackers":.+\}$$}, response.body
		36	assert_equal 'application/javascript; charset=utf-8', response.headers['Content-Type']
		37	end
		38
		39	def test_jsonp_should_strip_invalid_characters_from_callback
		40	get '/trackers.json?callback=+-aA$1_'
		41
		42	assert_response :success
		43	assert_match %r{^aA1_$\{"trackers":.+\}$$}, response.body
		44	assert_equal 'application/javascript; charset=utf-8', response.headers['Content-Type']
		45	end
		46
		47	def test_jsonp_without_callback_should_return_json
		48	get '/trackers.json?callback='
		49
		50	assert_response :success
		51	assert_match %r{^\{"trackers":.+\}$}, response.body
		52	assert_equal 'application/json; charset=utf-8', response.headers['Content-Type']
		53	end
		54	end

lib/redmine/views/api_template_handler.rb +1 -1

                module Views
                  class ApiTemplateHandler
                    def self.call(template)
-                     "Redmine::Views::Builders.for(params[:format]) do |api|; #{template.source}; self.output_buffer = api.output; end"
+                     "Redmine::Views::Builders.for(params[:format], request, response) do |api|; #{template.source}; self.output_buffer = api.output; end"
                    end
                  end
                end

lib/redmine/views/builders.rb +3 -3

              module Redmine
                module Views
                  module Builders
-                   def self.for(format, &block)
+                   def self.for(format, request, response, &block)
                      builder = case format
-                       when 'xml',  :xml;  Builders::Xml.new
-                       when 'json', :json; Builders::Json.new
+                       when 'xml',  :xml;  Builders::Xml.new(request, response)
+                       when 'json', :json; Builders::Json.new(request, response)
                        else; raise "No builder for format #{format}"
                      end
                      if block

lib/redmine/views/builders/json.rb +13 -1

                module Views
                  module Builders
                    class Json < Structure
+                     attr_accessor :jsonp
+                     def initialize(request, response)
+                       super
+                       self.jsonp = (request.params[:callback] || request.params[:jsonp]).to_s.gsub(/[^a-zA-Z0-9_]/, '')
+                     end
                      def output
-                       @struct.first.to_json
+                       json = @struct.first.to_json
+                       if jsonp.present?
+                         json = "#{jsonp}(#{json})"
+                         response.content_type = 'application/javascript'
+                       end
+                       json
                      end
                    end
                  end

lib/redmine/views/builders/structure.rb +5 -1

                module Views
                  module Builders
                    class Structure < BlankSlate
-                     def initialize
+                     attr_accessor :request, :response
+                     def initialize(request, response)
                        @struct = [{}]
+                       self.request = request
+                       self.response = response
                      end
                      def array(tag, options={}, &block)

lib/redmine/views/builders/xml.rb +2 -2

                module Views
                  module Builders
                    class Xml < ::Builder::XmlMarkup
-                     def initialize
-                       super
+                     def initialize(request, response)
+                       super()
                        instruct!
                      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