Adds JSONP support to the API (#11469).

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@10088 e93f8b46-1217-0410-a6f0-8f06a7374b81

diff --git a/lib/redmine/views/api_template_handler.rb b/lib/redmine/views/api_template_handler.rb
index fea212884bd22b8c8dc5307bd5e772b3206282f3..7d9442add4303141e0b1c6901c380b77edbb5383 100644 (file)
--- a/lib/redmine/views/api_template_handler.rb
+++ b/lib/redmine/views/api_template_handler.rb
@@ -19,7 +19,7 @@ module Redmine
   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

diff --git a/lib/redmine/views/builders.rb b/lib/redmine/views/builders.rb
index bd91fa175f99383aa3685d5fc7c9001e38c79fe1..d966befac14c57da2e31d4d31f18d43f1d95a47a 100644 (file)
--- a/lib/redmine/views/builders.rb
+++ b/lib/redmine/views/builders.rb
@@ -18,10 +18,10 @@
 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

diff --git a/lib/redmine/views/builders/json.rb b/lib/redmine/views/builders/json.rb
index db285ffbbb155f36d6d118e1e480f52bb09bec88..9ab8f6bfa8672bf15b831ca322be7dd47f04bae5 100644 (file)
--- a/lib/redmine/views/builders/json.rb
+++ b/lib/redmine/views/builders/json.rb
@@ -21,8 +21,20 @@ module Redmine
   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

diff --git a/lib/redmine/views/builders/structure.rb b/lib/redmine/views/builders/structure.rb
index a73898373db8d69d98be67e0faaa70fd1cf35217..5680551243a69e6956e084c4b9526607b722d2a3 100644 (file)
--- a/lib/redmine/views/builders/structure.rb
+++ b/lib/redmine/views/builders/structure.rb
@@ -21,8 +21,12 @@ module Redmine
   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)

diff --git a/lib/redmine/views/builders/xml.rb b/lib/redmine/views/builders/xml.rb
index d8be4d7c86e18a062f6bb8f480a90af77398a2fa..7046ddf731d591bf3ceb7d5ba9a402a7618a0d89 100644 (file)
--- a/lib/redmine/views/builders/xml.rb
+++ b/lib/redmine/views/builders/xml.rb
@@ -21,8 +21,8 @@ module Redmine
   module Views
     module Builders
       class Xml < ::Builder::XmlMarkup
-        def initialize
-          super
+        def initialize(request, response)
+          super()
           instruct!
         end
 

diff --git a/test/integration/api_test/jsonp_test.rb b/test/integration/api_test/jsonp_test.rb
new file mode 100644 (file)
index 0000000..ca7373f
--- /dev/null
+++ b/test/integration/api_test/jsonp_test.rb
@@ -0,0 +1,54 @@
+# Redmine - project management software
+# Copyright (C) 2006-2012  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require File.expand_path('../../../test_helper', __FILE__)
+
+class ApiTest::JsonpTest < ActionController::IntegrationTest
+  fixtures :trackers
+
+  def test_jsonp_should_accept_callback_param
+    get '/trackers.json?callback=handler'
+
+    assert_response :success
+    assert_match %r{^handler\(\{"trackers":.+\}\)$}, response.body
+    assert_equal 'application/javascript; charset=utf-8', response.headers['Content-Type']
+  end
+
+  def test_jsonp_should_accept_jsonp_param
+    get '/trackers.json?jsonp=handler'
+
+    assert_response :success
+    assert_match %r{^handler\(\{"trackers":.+\}\)$}, response.body
+    assert_equal 'application/javascript; charset=utf-8', response.headers['Content-Type']
+  end
+
+  def test_jsonp_should_strip_invalid_characters_from_callback
+    get '/trackers.json?callback=+-aA$1_'
+
+    assert_response :success
+    assert_match %r{^aA1_\(\{"trackers":.+\}\)$}, response.body
+    assert_equal 'application/javascript; charset=utf-8', response.headers['Content-Type']
+  end
+
+  def test_jsonp_without_callback_should_return_json
+    get '/trackers.json?callback='
+
+    assert_response :success
+    assert_match %r{^\{"trackers":.+\}$}, response.body
+    assert_equal 'application/json; charset=utf-8', response.headers['Content-Type']
+  end
+end