desponders 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e54fe6506dfbcfbd55b07f20c47647da2cc553bf
-  data.tar.gz: b0d9692bcbcceb0798ee20943ef4ed75849fa47d
+  metadata.gz: 79f82811106888d082d1ba045451634c2375fa58
+  data.tar.gz: 395e71ab26c0c0ca809d8b9d35b8bb6a6928e95f
 SHA512:
-  metadata.gz: 53ff2a38c22f6b6a441eda7df9e8870febd397e978afd8736e216a15311036c11ab27d0277746767981bce161b6f636f6932a3c5d7d1eae6056c1449bd29357c
-  data.tar.gz: 4f80b5479461aa336fe2946ae7356413ea68a9c5893c1fd86b8d8c2e10acf1c2e0d231f7d94b0636a3fa588f7f57483b3b869e3bb256e6a3e98e5d361ebefc5b
+  metadata.gz: 1053085be5b10413f821c997f09ae1de4c47139f117ea328798d4e588bef73cc6e2f55b04c5e352978c8993709daa581e6aa86b528310ba16de1ddb916e78a2d
+  data.tar.gz: a4f2ed77a87a2c44913b4a8bce69f0c7f40e0c39ef05a9c46fc07a0180d45170cf32f375e2d03ead9c659abf1ac4082e1a8d2574c02c5bc398c7fe17df9d711b

data/CHANGELOG.md

@@ -1,9 +1,13 @@
-# 0.2.0
+## v0.3.0 (2013-12-17)
 
-- Initial release ported from internal responders. Initial set of responders
+* Remove automatic LINK header insertion from PaginatedResponder.
+
+## v0.2.0 (2013-08-05)
+
+* Initial release ported from internal responders. Initial set of responders
   includes:
 
-  - Error
-  - HttpCaching
-  - Paginated
-  - Rest
+  * Error
+  * HttpCaching
+  * Paginated
+  * Rest

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/dscout/desponders.png?branch=master)](https://travis-ci.org/dscout/desponders)
+[![Code Climate](https://codeclimate.com/github/dscout/desponders.png)](https://codeclimate.com/github/dscout/desponders)
 
 # Desponders
 
@@ -9,25 +10,19 @@ A stack of light-weight responders tailored to JSON APIs.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'desponders', '0.2.0'
+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:
+Create a `ActionController::Responder` subclass and include the responders that
+you would like to use:
 
 ```ruby
 class CustomResponder < ActionController::Responder
+  include Desponders::ErrorResponder
   include Desponders::RESTResponder
+  include Desponders::PaginatedResponder
   include Desponders::HTTPCacheResponder
 end
 ```
@@ -36,14 +31,16 @@ Include the responder in any controllers serving API requests:
 
 ```ruby
 class ApplicationController < ActionController::Base
-   # Included
-  self.responder = Desponder::Responder
-
-  # Custom
   self.responder = CustomResponder
 end
 ```
 
+## PaginatedResponder
+
+The `PaginatedResponder` automatically applies pagination to every multi
+resource GET request. In order for pagination to work your resources must
+respond to a `paginate` method that accepts `page` and `per_page` options.
+
 ## Thanks
 
 The implementation of Desponders is based on the fanstastic work of Jose Valim

data/lib/desponders/paginated_responder.rb

@@ -4,10 +4,7 @@ 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
+        self.resource = resource.paginate(page: page, per_page: per_page)
       end
 
       super
@@ -15,7 +12,7 @@ module Desponders
 
     private
 
-    attr_accessor :resource, :resource_size
+    attr_accessor :resource
 
     delegate :response, :request, to: :controller
 
@@ -34,36 +31,5 @@ module Desponders
     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/version.rb

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

data/spec/desponders/paginated_responder_spec.rb

@@ -23,86 +23,26 @@ describe Desponders::PaginatedResponder do
   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) }
+  let(:resource)   { double(:resource, paginate: paginated) }
 
   subject(:responder) { MockPaginatedResponder.new(controller, resource) }
 
-  def link_header
-    controller.response.headers['Link']
+  it 'replaces the current resource with a paginated scope' do
+    responder.to_format
+    responder.resource.should eq(paginated)
   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)
+  it 'defaults pagination to the first page' do
+    resource.should_receive(:paginate).with(hash_including(page: 1))
+    responder.to_format
+  end
 
-      request.params[:per_page] = 50
+  it 'uses provided page and per_page params' do
+    resource.should_receive(:paginate).with(page: 2, per_page: 25)
 
-      responder.to_format
+    request.params[:page]     = 2
+    request.params[:per_page] = 25
 
-      link_header.should include('page=10&per_page=50; rel="last"')
-    end
+    responder.to_format
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: desponders
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A stack of light-weight responders tailored to JSON APIs