rack-jsonp-utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2d788ba01785cdad556e08582359d38e8830fad
+  data.tar.gz: 3652f66191ea6a6f14affec08bb2b2139eec785b
+SHA512:
+  metadata.gz: a16a26e176502397afba3c3c5027c0b5e21d729b379d6810d81d042004f3ef311f65da8499fc2ad43d95906565d07b123e2d87a320a335e28e150e2205a39216
+  data.tar.gz: 2900007addca9ffa78325b7a179f51136a41bb2df6407f8b672ae81e7581cba4d78df4794384f21c13b87e52b45ba528ce1faa3b874cf9740f18c52386ae64f7

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+v0.0.1
+======
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-jsonp-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Luis Mayoral
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+[![Gem Version](https://badge.fury.io/rb/rack-jsonp-utils.svg)](http://badge.fury.io/rb/rack-jsonp-utils)
+[![Code Climate](https://codeclimate.com/github/mayoral/rack-jsonp-utils/badges/gpa.svg)](https://codeclimate.com/github/mayoral/rack-jsonp-utils)
+[![Inline docs](http://inch-ci.org/github/mayoral/rack-jsonp-utils.svg?branch=master)](http://inch-ci.org/github/mayoral/rack-jsonp-utils)
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/mayoral/rack-jsonp-utils?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+# Rack::JSONP::Utils
+
+Some Rack middlewares to make easier for your app to support JSONP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-jsonp-utils'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Simply add these lines to your `config/application.rb` file:
+
+```ruby
+config.middleware.use Rack::JSONP::Callback
+config.middleware.use Rack::JSONP::MethodOverride
+```
+
+### Rack::JSONP::Callback
+
+This middleware will transform your JSON output into a valid JSONP output, using the callback name specified in the URL.
+
+By default, this middleware will use `callback` as the callback parameter in the query string. You can customize the name for the callback parameter:  
+
+```ruby
+config.middleware.use Rack::JSONP::Callback, 'my_callback_param'
+```
+
+### Rack::JSONP::MethodOverride
+
+This middleware will help you to transform internally the request to the HTTP method you want, since all the requests in JSONP must be GET requests. It will also force the HTTP response code of your request to be 200.
+
+As an example, `http://example.com/customers&callback=myfunc&_method=POST` will be seen by your app as a `POST /customers` request.
+
+By default, this middleware will use `callback` as the callback parameter in the query string, and `_method`. It will not activate if these two params are not in the query string.
+ 
+You can customize the name of these params:  
+
+```ruby
+# To only change the method override param name
+config.middleware.use Rack::JSONP::MethodOverride, 'my_method_override_param'
+
+# To also change the callback param name
+config.middleware.use Rack::JSONP::MethodOverride, 'my_method_override_param', 'my_callback_param'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mayoral/rack-jsonp-utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rack/jsonp/callback.rb

@@ -0,0 +1,49 @@
+module Rack
+  module JSONP
+    class Callback
+      def initialize(app, callback_param = 'callback')
+        @app = app
+        @callback_param = callback_param
+      end
+
+      def call(env)
+        request = Rack::Request.new(env)
+
+        callback = request.params[@callback_param]
+
+        if callback
+          env['jsonp.utils.callback'] = callback
+
+          status, headers, response = @app.call(env)
+
+          if headers['Content-Type'].to_s.start_with?('application/json')
+            response = pad(callback, response)
+
+            headers['Content-Length'] = response.first.bytesize.to_s
+            headers['Content-Type']   = 'application/javascript'
+
+            [200, headers, response]
+          else
+            [status, headers, response]
+          end
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def pad(callback, response)
+        body = ''
+
+        response.each do |s|
+          body << s.to_s.gsub("\u2028", '\u2028').gsub("\u2029", '\u2029')
+        end
+
+        response.close if response.respond_to?(:close)
+
+        ["/**/#{callback}(#{body})"]
+      end
+    end
+  end
+end

data/lib/rack/jsonp/method_override.rb

@@ -0,0 +1,31 @@
+module Rack
+  module JSONP
+    class MethodOverride
+      HTTP_METHODS = %w(GET HEAD PUT POST DELETE OPTIONS PATCH)
+
+      def initialize(app, method_override_param = '_method', callback_param = 'callback')
+        @app = app
+        @method_override_param = method_override_param
+        @callback_param = callback_param
+      end
+
+      def call(env)
+        request = Rack::Request.new(env)
+        method_override = request.params[@method_override_param]
+
+        if jsonp_callback_enabled?(request) && method_override && HTTP_METHODS.include?(method_override)
+          env['jsonp.utils.method_override'] = method_override
+          env['REQUEST_METHOD'] = method_override
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def jsonp_callback_enabled?(request)
+        @callback_param && request.params[@callback_param]
+      end
+    end
+  end
+end

data/lib/rack/jsonp/utils.rb

@@ -0,0 +1,4 @@
+require 'rack/jsonp/utils/version'
+
+require 'rack/jsonp/callback'
+require 'rack/jsonp/method_override'

data/lib/rack/jsonp/utils/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module JSONP
+    module Utils
+      VERSION = '0.0.1'
+    end
+  end
+end

data/rack-jsonp-utils.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/jsonp/utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-jsonp-utils'
+  spec.version       = Rack::JSONP::Utils::VERSION
+  spec.authors       = ['Luis Mayoral']
+  spec.email         = ['luis@luismayoral.com']
+  spec.summary       = 'Some Rack middlewares to make easier for your app to support JSONP'
+  spec.description   = 'Some Rack middlewares to make easier for your app to support JSONP'
+  spec.homepage      = 'http://github.com/mayoral/rack-jsonp-utils'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack', '>= 0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rack-jsonp-utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luis Mayoral
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Some Rack middlewares to make easier for your app to support JSONP
+email:
+- luis@luismayoral.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/jsonp/callback.rb
+- lib/rack/jsonp/method_override.rb
+- lib/rack/jsonp/utils.rb
+- lib/rack/jsonp/utils/version.rb
+- rack-jsonp-utils.gemspec
+homepage: http://github.com/mayoral/rack-jsonp-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Some Rack middlewares to make easier for your app to support JSONP
+test_files: []