rack-jsonp 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cyril Rohr
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,9 @@
+= rack-jsonp
+
+A Rack middleware for providing JSON-P support. Most of it is taken from the original Rack::JSONP middleware present in rack-contrib.
+Since I don't want to include the complete rack-contrib gem when all I need is the JSONP middleware, I created this gem.
+
+
+== Copyright
+
+Copyright (c) 2009 Cyril Rohr. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-jsonp"
+    gem.summary = %Q{A Rack middleware for providing JSON-P support.}
+    gem.description = %Q{A Rack middleware for providing JSON-P support.}
+    gem.email = "cyril.rohr@gmail.com"
+    gem.homepage = "http://github.com/crohr/rack-jsonp"
+    gem.authors = ["Cyril Rohr"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-jsonp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rack/jsonp.rb

@@ -0,0 +1,56 @@
+module Rack
+  # A Rack middleware for providing JSON-P support.
+  # 
+  # Adapted from Flinn Mueller (http://actsasflinn.com/).
+  #
+  class JSONP
+  
+    def initialize(app, options = {})
+      @app = app
+      @carriage_return = options[:carriage_return] || false
+      @callback_param = options[:callback_param] || 'callback'
+    end
+  
+    # Proxies the request to the application, stripping out the JSON-P callback
+    # method and padding the response with the appropriate callback format.
+    # 
+    # Changes nothing if no <tt>callback</tt> param is specified.
+    # 
+    def call(env)
+      # remove the callback and _ parameters BEFORE calling the backend, 
+      # so that caching middleware does not store a copy for each value of the callback parameter
+      request = Rack::Request.new(env)
+      callback = request.params.delete(@callback_param)
+      env['QUERY_STRING'] = env['QUERY_STRING'].split("&").delete_if{|param| param =~ /^(_|#{@callback_param})/}.join("&")
+      
+      status, headers, response = @app.call(env)
+      if callback
+        response = pad(callback, response)
+        headers['Content-Length'] = response.first.length.to_s
+      elsif @carriage_return && headers['Content-Type'] =~ /json/i
+        # add a \n after the response if this is a json (not JSONP) response
+        response = carriage_return(response)
+        headers['Content-Length'] = response.first.length.to_s
+      end
+      [status, headers, response]
+    end
+  
+    # Pads the response with the appropriate callback format according to the
+    # JSON-P spec/requirements.
+    # 
+    # The Rack response spec indicates that it should be enumerable. The method
+    # of combining all of the data into a single string makes sense since JSON
+    # is returned as a full string.
+    # 
+    def pad(callback, response, body = "")
+      response.each{ |s| body << s.to_s }
+      ["#{callback}(#{body})"]
+    end
+    
+    def carriage_return(response, body = "")
+      response.each{ |s| body << s.to_s }
+      ["#{body}\n"]
+    end
+  end
+  
+end

data/rack-jsonp.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-jsonp}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril Rohr"]
+  s.date = %q{2009-10-21}
+  s.description = %q{A Rack middleware for providing JSON-P support.}
+  s.email = %q{cyril.rohr@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack/jsonp.rb",
+     "rack-jsonp.gemspec",
+     "spec/rack_jsonp_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/crohr/rack-jsonp}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Rack middleware for providing JSON-P support.}
+  s.test_files = [
+    "spec/rack_jsonp_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/rack_jsonp_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe Rack::JSONP do
+
+  describe "when a callback parameter is provided" do
+    it "should wrap the response body in the Javascript callback [default callback param]" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=#{callback}")
+      body = Rack::JSONP.new(app).call(request).last
+      body.should == ["#{callback}(#{test_body})"]
+    end
+    
+    it "should wrap the response body in the Javascript callback [custom callback param]" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar&whatever=#{callback}")
+      body = Rack::JSONP.new(app, :callback_param => 'whatever').call(request).last
+      body.should == ["#{callback}(#{test_body})"]
+    end
+ 
+    it "should modify the content length to the correct value" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=#{callback}")
+      headers = Rack::JSONP.new(app).call(request)[1]
+      headers['Content-Length'].should == ((test_body.length + callback.length + 2).to_s) # 2 parentheses
+    end
+  end
+ 
+  describe "when json content is returned" do
+    it "should do nothing if no carriage return has been requested" do
+      test_body = '{"bar":"foo"}'
+      app = lambda { |env| [200, {'Content-Type' => 'application/vnd.com.example.Object+json'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar")
+      body = Rack::JSONP.new(app).call(request).last
+      body.should == ['{"bar":"foo"}']
+    end
+    it "should add a carriage return if requested" do
+      test_body = '{"bar":"foo"}'
+      app = lambda { |env| [200, {'Content-Type' => 'application/vnd.com.example.Object+json'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar")
+      body = Rack::JSONP.new(app, :carriage_return => true).call(request).last
+      body.should == ["{\"bar\":\"foo\"}\n"]
+    end
+    it "should not add a carriage return for jsonp content" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'application/vnd.com.example.Object+json'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=#{callback}")
+      body = Rack::JSONP.new(app, :carriage_return => true).call(request).last
+      body.should == ["#{callback}(#{test_body})"]
+    end
+  end
+  
+  it "should not change anything if no callback param is provided" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['{"bar":"foo"}']] }
+    request = Rack::MockRequest.env_for("/", :input => "foo=bar")
+    body = Rack::JSONP.new(app).call(request).last
+    body.join.should == '{"bar":"foo"}'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/jsonp'
+require 'spec'
+require 'spec/autorun'
+require 'rack'
+
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: rack-jsonp
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Cyril Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A Rack middleware for providing JSON-P support.
+email: cyril.rohr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/jsonp.rb
+- rack-jsonp.gemspec
+- spec/rack_jsonp_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/crohr/rack-jsonp
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rack middleware for providing JSON-P support.
+test_files: 
+- spec/rack_jsonp_spec.rb
+- spec/spec_helper.rb