desponders 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e54fe6506dfbcfbd55b07f20c47647da2cc553bf
+  data.tar.gz: b0d9692bcbcceb0798ee20943ef4ed75849fa47d
+SHA512:
+  metadata.gz: 53ff2a38c22f6b6a441eda7df9e8870febd397e978afd8736e216a15311036c11ab27d0277746767981bce161b6f636f6932a3c5d7d1eae6056c1449bd29357c
+  data.tar.gz: 4f80b5479461aa336fe2946ae7356413ea68a9c5893c1fd86b8d8c2e10acf1c2e0d231f7d94b0636a3fa588f7f57483b3b869e3bb256e6a3e98e5d361ebefc5b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+-I spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 0.2.0
+
+- Initial release ported from internal responders. Initial set of responders
+  includes:
+
+  - Error
+  - HttpCaching
+  - Paginated
+  - Rest

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dscout, Inc
+
+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,59 @@
+[![Build Status](https://travis-ci.org/dscout/desponders.png?branch=master)](https://travis-ci.org/dscout/desponders)
+
+# Desponders
+
+A stack of light-weight responders tailored to JSON APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'desponders', '0.2.0'
+```
+
+## Usage
+
+Use the provided `ApiResponder`, which includes all of the responder modules in
+a sane order:
+
+* Desponders::ErrorResponder
+* Desponders::RESTResponder
+* Desponders::PaginatedResponder
+* Desponders::HTTPCacheResponder
+
+Alternatively, create a `ActionController::Responder` subclass and include the
+responders that you would like to use:
+
+```ruby
+class CustomResponder < ActionController::Responder
+  include Desponders::RESTResponder
+  include Desponders::HTTPCacheResponder
+end
+```
+
+Include the responder in any controllers serving API requests:
+
+```ruby
+class ApplicationController < ActionController::Base
+   # Included
+  self.responder = Desponder::Responder
+
+  # Custom
+  self.responder = CustomResponder
+end
+```
+
+## Thanks
+
+The implementation of Desponders is based on the fanstastic work of Jose Valim
+and his contributions to Responders within Rails, as well as Plataformatec's
+Responders gem.
+
+## 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 @@
+require "bundler/gem_tasks"

data/desponders.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'desponders/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'desponders'
+  spec.version       = Desponders::VERSION
+  spec.authors       = ['Parker Selbert']
+  spec.email         = ['parker@sorentwo.com']
+  spec.homepage      = 'https://github.com/dscout/desponders'
+  spec.license       = 'MIT'
+  spec.description   = 'A stack of light-weight responders tailored to JSON APIs'
+  spec.summary       = 'A stack of light-weight responders tailored to JSON APIs'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '>= 3.2', '< 5'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec',   '~> 2.14.0'
+end

data/lib/desponders/error_responder.rb

@@ -0,0 +1,23 @@
+module Desponders
+  module ErrorResponder
+    # If it isn't a get request and the response model has errors it
+    # automatically renders json with errors
+    def to_format
+      if has_errors?
+        controller.render json: {
+          message: lookup_message, errors: resource.errors
+        }, status: :unprocessable_entity
+      else
+        super
+      end
+    end
+
+    def lookup_message
+      action  = controller.action_name
+      lookup  = ['errors', action].join('.').to_sym
+      options = { resource_name: resource.class.model_name.human }
+
+      I18n.t(lookup, options)
+    end
+  end
+end

data/lib/desponders/http_cache_responder.rb

@@ -0,0 +1,22 @@
+module Desponders
+  module HttpCacheResponder
+    def to_format
+      return if do_http_cache? && do_http_cache!
+
+      super
+    end
+
+    private
+
+    def do_http_cache?
+      get? && ActionController::Base.perform_caching &&
+      resource.respond_to?(:updated_at)
+    end
+
+    def do_http_cache!
+      controller.fresh_when(etag: resource,
+                            last_modified: resource.updated_at,
+                            public: false)
+    end
+  end
+end

data/lib/desponders/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  errors:
+    create:  "%{resource_name} could not be created"
+    update:  "%{resource_name} could not be updated"
+    destroy: "%{resource_name} could not be destroyed"
+

data/lib/desponders/paginated_responder.rb

@@ -0,0 +1,69 @@
+require 'active_support/core_ext/module/delegation'
+
+module Desponders
+  module PaginatedResponder
+    def to_format
+      if get? && resource.respond_to?(:paginate)
+        self.resource_size = resource.size
+        self.resource      = resource.paginate(page: page, per_page: per_page)
+
+        response.headers['Link'] = link_headers
+      end
+
+      super
+    end
+
+    private
+
+    attr_accessor :resource, :resource_size
+
+    delegate :response, :request, to: :controller
+
+    def default_page
+      1
+    end
+
+    def default_per_page
+      30
+    end
+
+    def page
+      (request.params[:page] || default_page).to_i
+    end
+
+    def per_page
+      (request.params[:per_page] || default_per_page).to_i
+    end
+
+    def first_page
+      1
+    end
+
+    def prev_page
+      [first_page, page - 1].max
+    end
+
+    def next_page
+      [last_page, page + 1].min
+    end
+
+    def last_page
+      calculated = (resource_size.to_f / per_page).ceil
+
+      calculated.zero? ? 1 : calculated
+    end
+
+    def link_headers
+      base, rest = request.url.split('?')
+
+      [construct_link_rel(base, first_page, per_page, 'first'),
+       construct_link_rel(base, prev_page,  per_page, 'prev'),
+       construct_link_rel(base, next_page,  per_page, 'next'),
+       construct_link_rel(base, last_page,  per_page, 'last')].join(',')
+    end
+
+    def construct_link_rel(base, page, per_page, rel)
+      %(#{base}?page=#{page}&per_page=#{per_page}; rel="#{rel}")
+    end
+  end
+end

data/lib/desponders/rest_responder.rb

@@ -0,0 +1,18 @@
+module Desponders
+  module RestResponder
+    def to_format
+      case
+      when get?
+        display(resource, status: :ok)
+      when has_errors?
+        super
+      when post?
+        display(resource, status: :created)
+      when put?
+        display(resource, status: :ok)
+      when delete?
+        display({}, status: :no_content)
+      end
+    end
+  end
+end

data/lib/desponders/version.rb

@@ -0,0 +1,3 @@
+module Desponders
+  VERSION = '0.2.0'
+end

data/lib/desponders.rb

@@ -0,0 +1,13 @@
+require 'action_controller/base'
+
+module Desponders
+  autoload :ErrorResponder,     'desponders/error_responder'
+  autoload :HttpCacheResponder, 'desponders/http_cache_responder'
+  autoload :PaginatedResponder, 'desponders/paginated_responder'
+  autoload :RestResponder,      'desponders/rest_responder'
+
+  class Railtie < ::Rails::Railtie
+    require 'active_support/i18n'
+    I18n.load_path << File.expand_path('../desponders/locales/en.yml', __FILE__)
+  end
+end

data/spec/desponders/error_responder_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+I18n.load_path += [File.expand_path('lib/desponders/locales/en.yml')]
+
+describe Desponders::ErrorResponder do
+  class MockErrorResponder < Struct.new(:to_format)
+    include Desponders::ErrorResponder
+
+    attr_accessor :controller, :resource
+
+    def initialize(controller, resource)
+      @controller = controller
+      @resource   = resource
+    end
+  end
+
+  let(:controller) { double(:controller, action_name: 'create') }
+  let(:resource)   { double(:resource, errors: []) }
+
+  subject(:responder) { MockErrorResponder.new(controller, resource) }
+
+  before do
+    resource.class.stub_chain(:model_name, :human).and_return('Mock')
+  end
+
+  it 'renders error messages when a non-get request has errors ' do
+    responder.stub(has_errors?: true)
+
+    expect(controller).to receive(:render).with(json: {
+      message: 'Mock could not be created',
+      errors:  []
+    }, status: :unprocessable_entity)
+
+    responder.to_format
+  end
+
+  it 'does not render without errors' do
+    responder.stub(has_errors?: false)
+
+    expect(controller).to_not receive(:render)
+
+    responder.to_format
+  end
+end

data/spec/desponders/http_cache_responder_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Desponders::HttpCacheResponder do
+  class MockHttpCacheResponderBase
+    def to_format
+      '{}'
+    end
+  end
+
+  class MockHttpCacheResponder < MockHttpCacheResponderBase
+    include Desponders::HttpCacheResponder
+
+    attr_accessor :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+  end
+
+  let(:controller) { double(:controller, fresh_when: true) }
+  let(:resource)   { double(:resource, updated_at: nil) }
+  let(:collection) { double(:collection) }
+
+  subject(:responder) { MockHttpCacheResponder.new(controller) }
+
+  it 'returns nothing with a single resource on get' do
+    responder.stub(get?: true, fresh_when: true, resource: resource)
+
+    expect(responder.to_format).to be_nil
+  end
+
+  it 'passes through with multiple resources on get' do
+    responder.stub(get?: true, resource: collection)
+
+    expect(responder.to_format).to be_present
+  end
+
+  it 'passes through without a fresh resource' do
+    controller.stub(fresh_when: false)
+    responder.stub(get?: true, resource: resource)
+
+    expect(responder.to_format).to be_present
+  end
+
+  it 'passes through without a get request' do
+    responder.stub(get?: false, resource: resource)
+
+    expect(responder.to_format).to be_present
+  end
+
+  it 'does not cache if perform_caching is false' do
+    responder.stub(get?: true, resource: resource)
+
+    ActionController::Base.stub(perform_caching: false)
+
+    expect(responder.to_format).to be_present
+  end
+end

data/spec/desponders/paginated_responder_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Desponders::PaginatedResponder do
+  class MockPaginatedResponderBase
+    def to_format
+    end
+  end
+
+  class MockPaginatedResponder < MockPaginatedResponderBase
+    include Desponders::PaginatedResponder
+
+    attr_accessor :controller, :resource
+
+    def initialize(controller, resource)
+      @controller = controller
+      @resource   = resource
+    end
+
+    def get?; true; end
+  end
+
+  let(:controller) { double(:controller, request: request, response: response) }
+  let(:paginated)  { double(:paginated) }
+  let(:request)    { double(:request, params: {}, url: 'https://example.com/missions') }
+  let(:response)   { double(:response, headers: {}) }
+  let(:resource)   { double(:resource, paginate: paginated, size: 100) }
+
+  subject(:responder) { MockPaginatedResponder.new(controller, resource) }
+
+  def link_header
+    controller.response.headers['Link']
+  end
+
+  context 'with a paginatable resource on a get request' do
+    it 'replaces the current resource with a paginated scope' do
+      responder.to_format
+      responder.resource.should eq(paginated)
+    end
+
+    it 'defaults pagination to the first page' do
+      resource.should_receive(:paginate).with(hash_including(page: 1))
+      responder.to_format
+    end
+
+    it 'uses provided page and per_page params' do
+      resource.should_receive(:paginate).with(page: 2, per_page: 25)
+
+      request.params[:page]     = 2
+      request.params[:per_page] = 25
+
+      responder.to_format
+    end
+
+    it 'injects resource urls into a LINK header' do
+      request.params[:page] = 2
+
+      responder.to_format
+
+      link_header.tap do |header|
+        header.should include('https://example.com/missions?page=1&per_page=30; rel="first"')
+        header.should include('https://example.com/missions?page=1&per_page=30; rel="prev"')
+        header.should include('https://example.com/missions?page=3&per_page=30; rel="next"')
+        header.should include('https://example.com/missions?page=4&per_page=30; rel="last"')
+      end
+    end
+
+    it 'ignores params in the request url when constructing headers' do
+      request.stub(url: 'https://example.com/missions?thing=1&other=2')
+
+      responder.to_format
+
+      link_header.should_not include('?thing=1&other=2')
+    end
+
+    it 'calculates the next page based on resource size and the per_page value' do
+      resource.stub(size: 500)
+
+      request.params[:page]     = 3
+      request.params[:per_page] = 50
+
+      responder.to_format
+
+      link_header.tap do |header|
+        header.should include('page=2&per_page=50; rel="prev"')
+        header.should include('page=4&per_page=50; rel="next"')
+      end
+    end
+
+    it 'prevents the next and last pages from being 0' do
+      resource.stub(size: 0)
+
+      responder.to_format
+
+      link_header.should include('page=1&per_page=30; rel="next"')
+      link_header.should include('page=1&per_page=30; rel="last"')
+    end
+
+    it 'calculates the last page based on resource size and the per_page value' do
+      resource.stub(size: 500)
+
+      request.params[:per_page] = 50
+
+      responder.to_format
+
+      link_header.should include('page=10&per_page=50; rel="last"')
+    end
+  end
+end

data/spec/desponders/rest_responder_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Desponders::RestResponder do
+  class MockRestResponderBase
+    def to_format
+      '{}'
+    end
+  end
+
+  class MockRestResponder < MockRestResponderBase
+    include Desponders::RestResponder
+
+    attr_accessor :resource
+
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def display
+    end
+
+    def get?;        false; end
+    def post?;       false; end
+    def put?;        false; end
+    def delete?;     false; end
+    def has_errors?; false; end
+  end
+
+  let(:resource) { double(:resource) }
+
+  subject(:responder) { MockRestResponder.new(resource) }
+
+  it 'renders the resource with 200 status with a get request' do
+    responder.stub(get?: true)
+
+    expect(responder).to receive(:display).with(resource, status: :ok)
+
+    responder.to_format
+  end
+
+  it 'renders the resource with 201 created with a create request' do
+    responder.stub(post?: true)
+
+    expect(responder).to receive(:display).with(resource, status: :created)
+
+    responder.to_format
+  end
+
+  it 'renders the resource with a put request' do
+    responder.stub(put?: true)
+
+    expect(responder).to receive(:display).with(resource, status: :ok)
+
+    responder.to_format
+  end
+
+  it 'renders no content with a delete request' do
+    responder.stub(delete?: true)
+
+    expect(responder).to receive(:display).with({}, status: :no_content)
+
+    responder.to_format
+  end
+
+  it 'falls through to super with errors' do
+    responder.stub(has_errors?: true)
+
+    expect(responder.to_format).to eq('{}')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler.setup
+
+require 'active_support'
+require 'action_controller'
+require 'rails/railtie'
+require 'i18n'
+
+ENV['RAILS_ENV'] = 'test'
+
+require 'desponders'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: desponders
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Parker Selbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: A stack of light-weight responders tailored to JSON APIs
+email:
+- parker@sorentwo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- desponders.gemspec
+- lib/desponders.rb
+- lib/desponders/error_responder.rb
+- lib/desponders/http_cache_responder.rb
+- lib/desponders/locales/en.yml
+- lib/desponders/paginated_responder.rb
+- lib/desponders/rest_responder.rb
+- lib/desponders/version.rb
+- spec/desponders/error_responder_spec.rb
+- spec/desponders/http_cache_responder_spec.rb
+- spec/desponders/paginated_responder_spec.rb
+- spec/desponders/rest_responder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dscout/desponders
+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.0.0
+signing_key: 
+specification_version: 4
+summary: A stack of light-weight responders tailored to JSON APIs
+test_files:
+- spec/desponders/error_responder_spec.rb
+- spec/desponders/http_cache_responder_spec.rb
+- spec/desponders/paginated_responder_spec.rb
+- spec/desponders/rest_responder_spec.rb
+- spec/spec_helper.rb