entity_responder 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Rust
+
+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 @@
+# Responders::EntityResponder
+
+The default [Rails
+Responder](http://api.rubyonrails.org/classes/ActionController/Responder.html)
+returns `head :no_content` for PUT and DELETE requests for non-HTML
+requests (JSON, XML, etc.).  Some APIs or the JS frameworks that consume
+them would prefer that the responses from those operations include the
+entity in the same way that a POST request to create an entity does.
+
+Per [RFC 2616 Section
+9.7](http://tools.ietf.org/html/rfc2616#section-9.7) either way of
+responding is valid:
+
+> A successful response SHOULD be 200 (OK) if the response includes an
+> entity describing the status, 202 (Accepted) if the action has not
+> yet been enacted, or 204 (No Content) if the action has been
+> enacted but the response does not include an entity.
+
+This Responder takes the former approach and returns a 200 response and
+the serialized version of the resource for PUT and DELETE requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'entity_responder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install entity_responder
+
+## Usage
+
+Add `Responders::EntityResponder` to your responder chain:
+
+```ruby
+class AppResponder < Responder
+  include Responders::EntityResponder
+end
+
+class MyController < ApplicationController
+  self.responder = AppResponder
+end
+```
+
+Or use it with
+[plataformatec/responders](https://github.com/plataformatec/responders):
+
+```ruby
+class MyController < ApplicationController
+  responders Responders::EntityResponder
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/entity_responder.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'entity_responder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "entity_responder"
+  spec.version       = EntityResponder::VERSION
+  spec.authors       = ["Jason Rust"]
+  spec.email         = ["jason@lessonplanet.com"]
+  spec.description   = %q{A Rails responder that returns an entity in the response body rather than the :no_content header.}
+  spec.summary       = %q{A Rails responder that returns an entity in the response body rather than the :no_content header.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-ansi"
+  spec.add_development_dependency "actionpack"
+end

data/lib/entity_responder.rb

@@ -0,0 +1,7 @@
+module EntityResponder
+  autoload :VERSION, 'entity_responder/version'
+end
+
+module Responders
+  autoload :EntityResponder, 'responders/entity_responder'
+end

data/lib/entity_responder/version.rb

@@ -0,0 +1,12 @@
+module EntityResponder
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    STAGE = nil
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
+    end
+  end
+end

data/lib/responders/entity_responder.rb

@@ -0,0 +1,15 @@
+module Responders
+  module EntityResponder
+    protected
+
+    # This is the common behavior for formats associated with APIs, such as :xml and :json.
+    def api_behavior(error)
+      raise error unless resourceful?
+      if !get? && !post?
+        display resource, :status => :ok, :location => api_location
+      else
+        super
+      end
+    end
+  end
+end

data/test/entity_responder_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class EntityResponderTest < ActionController::TestCase
+  tests ResourcesController
+
+  def setup
+    @id = 1
+    @resource = Resource.new(@id)
+  end
+
+  def test_get_resource
+    get :show, id: @id, :format => :json
+
+    assert_equal 200, response.status
+    refute_empty response.body.strip
+  end
+
+  def test_post_resource
+    post :create, :format => :json
+
+    assert_equal 201, response.status
+    refute_empty response.body.strip
+  end
+
+  def test_put_resource
+    put :update, id: @id, :format => :json
+
+    assert_equal 200, response.status
+    refute_empty response.body.strip
+  end
+
+  def test_delete_resource
+    delete :destroy, id: @id, :format => :json
+
+    assert_equal 200, response.status
+    refute_empty response.body.strip
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+require 'minitest/autorun'
+require 'bundler'
+
+Bundler.setup
+
+# Configure Rails
+ENV["RAILS_ENV"] = "test"
+
+require 'minitest/ansi'
+MiniTest::ANSI.use!
+
+require 'action_controller'
+require 'action_controller/test_case'
+require 'entity_responder'
+
+Routes = ActionDispatch::Routing::RouteSet.new
+Routes.draw do
+  resources :resources
+end
+
+class ActiveSupport::TestCase
+  setup do @routes = Routes end
+end
+
+class AppResponder < ActionController::Responder
+  include Responders::EntityResponder
+end
+
+class ResourcesController < ActionController::Base
+  include Routes.url_helpers
+  self.responder = AppResponder
+  before_filter :set_resource
+  respond_to :json
+
+  def action
+    options = params.slice(:flash, :flash_now)
+    flash[:success] = "Flash is set" if params[:set_flash]
+    respond_with(@resource, options)
+  end
+  alias :show    :action
+  alias :create  :action
+  alias :update  :action
+  alias :destroy :action 
+
+  def set_resource
+    @resource = Resource.new(params[:id].to_i)
+  end
+end
+
+class Resource
+  attr_accessor :id
+
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  def initialize(id)
+    @id = id
+  end
+
+  def persisted?
+    true
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: entity_responder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Rust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-ansi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails responder that returns an entity in the response body rather
+  than the :no_content header.
+email:
+- jason@lessonplanet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- entity_responder.gemspec
+- lib/entity_responder.rb
+- lib/entity_responder/version.rb
+- lib/responders/entity_responder.rb
+- test/entity_responder_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Rails responder that returns an entity in the response body rather than
+  the :no_content header.
+test_files:
+- test/entity_responder_test.rb
+- test/test_helper.rb