restful_jsonp 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*~

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by University of Toronto
+
+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.markdown

@@ -0,0 +1,38 @@
+RESTful JSONP
+============
+
+This is a Rails plugin (Railtie) that allows your existing RESTful controllers to work over JSONP.
+
+REST is designed around the four HTTP request methods (`GET`, `POST`, `PUT`, and `DELETE`), but
+JSONP requests are always `GET`s. To get around this restriction, this Railtie lets you specify the
+desired method in a special `_method` parameter.
+
+For example, to make a `PUT` request to `/users/1.json`, you would make a JSONP (`GET`) request to
+`/users/1.json?_method=PUT`.
+
+
+Installation
+------------
+
+First, install the gem: 
+
+`gem install restful_jsonp`
+
+Then add this to your Rails app's `Gemfile`:
+
+`gem 'restful_jsonp', :require => 'restful_jsonp/railtie'`
+
+Note that this only works for Rails 3. In principle you could try to swap in the RestfulJSONP::MethodOverride
+middleware into a Rails 2.3+ app, but this has not been tested.
+
+
+How it Works
+------------
+
+The `_method` functionality is built in to Rails (via Rack), but is normally only available for
+`POST` requests. This Railtie replaces the default `Rack::MethodOverride` middleware with a slightly
+altered version that checks for the `_method` parameter regardless of whether it's in a `POST`
+or `GET` request.
+
+Note that this functionality is enabled for all requests, regardless of whether they are done
+via JSONP or otherwise.

data/lib/restful_jsonp.rb

@@ -0,0 +1,13 @@
+require 'rails'
+require 'action_controller/base'
+require 'restful_jsonp/method_override'
+require 'restful_jsonp/jsonp_responder'
+
+module RestfulJSONP
+  class Railtie < Rails::Railtie
+    initializer "restful_jsonp.replace_rack_methodoverride" do |app|
+      Rails.logger.debug "Swapping in RestfulJSONP Middleware"
+      app.middleware.swap Rack::MethodOverride, RestfulJSONP::MethodOverride
+    end
+  end
+end

data/lib/restful_jsonp/jsonp_responder.rb

@@ -0,0 +1,33 @@
+require 'action_controller/metal/responder'
+
+module RestfulJSONP
+  class JSONPResponder < ActionController::Responder
+
+    def display(resource, given_options = {})
+      if format == :json && controller.params[:callback] && !controller.request.xhr?
+        # this is a JSONP request (note that JSONP is not done over XHR!)
+
+        jsonp_options = {}
+
+        if (resource.respond_to?(:errors) && !resource.errors.empty?) ||
+            (given_options[:status] && ![:ok, :created].include?(given_options[:status]))
+          jsonp_options[:status] = :accepted # we can't return an error HTTP response (e.g. 422 or 500) because it would be ignored :(
+          resource = {
+            :error => {
+              :status => given_options[:status],
+              :data => resource.to_json
+            }
+          }
+        end
+
+        jsonp_options[format] = resource
+        jsonp_options[:callback] = controller.params[:callback]
+
+        render options.merge!(given_options).merge!(jsonp_options)
+      else
+        # this is not a JSONP request; carry on
+        super
+      end
+    end
+  end
+end

data/lib/restful_jsonp/method_override.rb

@@ -0,0 +1,18 @@
+require 'rack'
+
+module RestfulJSONP
+  class MethodOverride < Rack::MethodOverride
+    def call(env)
+      req = Rack::Request.new(env)
+      method = req.params[METHOD_OVERRIDE_PARAM_KEY] ||
+        env[HTTP_METHOD_OVERRIDE_HEADER]
+      method = method.to_s.upcase
+      if HTTP_METHODS.include?(method)
+        env["rack.methodoverride.original_method"] = env["REQUEST_METHOD"]
+        env["REQUEST_METHOD"] = method
+      end
+ 
+      @app.call(env)
+    end
+  end
+end

data/restful_jsonp.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |gem|
+  gem.name     = "restful_jsonp"
+  gem.version  = "1.0.0"
+  gem.authors  = ["Matt Zukowski"]
+  gem.email    = ["matt.zukowski@utoronto.ca"]
+  gem.homepage = "http://github.com/educoder/restful_jsonp"
+  gem.summary  = "Makes your RESTful Rails service accessible using JSONP. Use the '_method' parameter in your requests to specify the request method."
+  gem.description = "Normally Rails/Rack only checks the '_method' parameter in POST requests, but JSONP requests are always GETs. This railtie enables the '_method' check for all request types, including GET."
+  gem.require_paths = ["lib"]
+
+  gem.files = `git ls-files`.split("\n")
+
+  gem.add_dependency "rack", "~> 1"
+  gem.add_dependency "rails", "~> 3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: restful_jsonp
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matt Zukowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        version: "1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id002
+description: Normally Rails/Rack only checks the '_method' parameter in POST requests, but JSONP requests are always GETs. This railtie enables the '_method' check for all request types, including GET.
+email: 
+- matt.zukowski@utoronto.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- lib/restful_jsonp.rb
+- lib/restful_jsonp/jsonp_responder.rb
+- lib/restful_jsonp/method_override.rb
+- restful_jsonp.gemspec
+has_rdoc: true
+homepage: http://github.com/educoder/restful_jsonp
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Makes your RESTful Rails service accessible using JSONP. Use the '_method' parameter in your requests to specify the request method.
+test_files: []
+