api-pagination 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f6ccb55a817446accc21e10ff030b9ee40e4af2
-  data.tar.gz: a562df84550d1521fa5dffcc6459e3ce5ad18038
+  metadata.gz: 83a3cdfe943a03cd590d6a3c9e80aa11d7d5e684
+  data.tar.gz: df6e1401a570e87fad204d6f249e7e31b09ea159
 SHA512:
-  metadata.gz: 10f3c3ed499e25e73ac61845e36f6c8de82c59cba53298a4d25443b68d51a69e5ae747afeff3c8c34562b1752f29f96c49b5e5d74ba51a7b01dda659e3907ca5
-  data.tar.gz: d30c8b948d7f21b69745d3e00b29e81fe82ef34f7c101a197604823ec2f33c920f2ac70a182250f87a714b139dd4abfbb40282f68d922bc1a76f480d68a40d63
+  metadata.gz: 139197be0f405c0e4954250f4ffa56f5bdc02246e49b674d1ecaab262a2c412d8b088ac6eaa54cf00cda4a75e30e74a746c8b3fb122c4ea7dc9954c5ebc67d82
+  data.tar.gz: c8e15989e239fa9b3d77f8968b4612c8ce93ca78000c39f1c04063d32b24cb1dbe20664e8b1a4ab677fefdb153c20f184ba6319686e126980440ae4b9a6891f2

data/lib/api-pagination.rb

@@ -5,15 +5,16 @@ module ApiPagination
   class << self
     attr_reader :paginator
 
-    def paginate(collection, options = {}, &block)
+    def paginate(collection, options = {})
       options[:page]     ||= 1
-      options[:per_page] ||= 10
+      options[:per_page] ||= 25
 
       case ApiPagination.paginator
       when :kaminari
-        collection.page(options[:page]).per(options[:per_page]).tap(&block)
+        collection = Kaminari.paginate_array(collection) if collection.is_a?(Array)
+        collection.page(options[:page]).per(options[:per_page])
       when :will_paginate
-        collection.paginate(:page => options[:page], :per_page => options[:per_page]).tap(&block)
+        collection.paginate(:page => options[:page], :per_page => options[:per_page])
       end
     end
 
@@ -39,5 +40,3 @@ module ApiPagination
     end
   end
 end
-
-ApiPagination::Hooks.init

data/lib/api-pagination/hooks.rb

@@ -45,3 +45,5 @@ EOC
     end
   end
 end
+
+ApiPagination::Hooks.init

data/lib/api-pagination/version.rb

@@ -1,8 +1,8 @@
 module ApiPagination
   class Version
-    MAJOR = 2
-    MINOR = 1
-    PATCH = 1
+    MAJOR = 3
+    MINOR = 0
+    PATCH = 0
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/lib/grape/pagination.rb

@@ -3,32 +3,36 @@ module Grape
     def self.included(base)
       Grape::Endpoint.class_eval do
         def paginate(collection)
-          block = Proc.new do |collection|
-            links = (header['Link'] || "").split(',').map(&:strip)
-            url   = request.url.sub(/\?.*$/, '')
-            pages = ApiPagination.pages_from(collection)
+          options = {
+            :page     => params[:page],
+            :per_page => (settings[:per_page] || params[:per_page])
+          }
+          collection = ApiPagination.paginate(collection, options)
 
-            pages.each do |k, v|
-              old_params = Rack::Utils.parse_query(request.query_string)
-              new_params = old_params.merge('page' => v)
-              links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
-            end
+          links = (header['Link'] || "").split(',').map(&:strip)
+          url   = request.url.sub(/\?.*$/, '')
+          pages = ApiPagination.pages_from(collection)
 
-            header 'Link', links.join(', ') unless links.empty?
-            header 'Total', ApiPagination.total_from(collection)
+          pages.each do |k, v|
+            old_params = Rack::Utils.parse_query(request.query_string)
+            new_params = old_params.merge('page' => v)
+            links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
           end
 
-          ApiPagination.paginate(collection, params, &block)
+          header 'Link', links.join(', ') unless links.empty?
+          header 'Total', ApiPagination.total_from(collection)
+
+          return collection
         end
       end
 
       base.class_eval do
         def self.paginate(options = {})
-          options.reverse_merge!(:per_page => 10)
+          set :per_page, options[:per_page]
           params do
             optional :page,     :type => Integer, :default => 1,
                                 :desc => 'Page of results to fetch.'
-            optional :per_page, :type => Integer, :default => options[:per_page],
+            optional :per_page, :type => Integer,
                                 :desc => 'Number of results to return per page.'
           end
         end

data/lib/rails/pagination.rb

@@ -2,24 +2,43 @@ module Rails
   module Pagination
     protected
 
-      def paginate(collection)
-        collection = instance_variable_get(:"@#{collection}")
+    def paginate(options)
+      collection = options[:json] || options[:xml]
 
-        block = Proc.new do |collection|
-          links = (headers['Link'] || "").split(',').map(&:strip)
-          url   = request.original_url.sub(/\?.*$/, '')
-          pages = ApiPagination.pages_from(collection)
+      collection     = _paginate_collection(collection, options)
+      options[:json] = collection if options[:json]
+      options[:xml]  = collection if options[:xml]
 
-          pages.each do |k, v|
-            new_params = request.query_parameters.merge(:page => v)
-            links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
-          end
+      render options
+    end
 
-          headers['Link']  = links.join(', ') unless links.empty?
-          headers['Total'] = ApiPagination.total_from(collection)
-        end
+    def paginate_with(collection)
+      respond_with _paginate_collection(collection)
+    end
 
-        ApiPagination.paginate(collection, params, &block)
+    private
+
+    def _paginate_collection(collection, options)
+      options = {
+        :page     => params[:page],
+        :per_page => (options.delete(:per_page) || params[:per_page])
+      }
+      collection = ApiPagination.paginate(collection, options)
+
+      links = (headers['Link'] || "").split(',').map(&:strip)
+      url   = request.original_url.sub(/\?.*$/, '')
+      pages = ApiPagination.pages_from(collection)
+
+      pages.each do |k, v|
+        new_params = request.query_parameters.merge(:page => v)
+        links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
       end
+
+      headers['Link']  = links.join(', ') unless links.empty?
+      headers['Total'] = ApiPagination.total_from(collection)
+
+      return collection
+    end
   end
 end
+

data/spec/grape_spec.rb

@@ -10,14 +10,19 @@ describe NumbersAPI do
     let(:total) { last_response.headers['Total'].to_i }
 
     context 'without enough items to give more than one page' do
-      before { get :numbers, :count => 20 }
+      before { get :numbers, :count => 10 }
 
       it 'should not paginate' do
         expect(last_response.headers.keys).not_to include('Link')
       end
 
       it 'should give a Total header' do
-        expect(total).to eq(20)
+        expect(total).to eq(10)
+      end
+
+      it 'should list all numbers in the response body' do
+        body = '[1,2,3,4,5,6,7,8,9,10]'
+        expect(last_response.body).to eq(body)
       end
     end
 
@@ -35,7 +40,7 @@ describe NumbersAPI do
       end
 
       context 'when on the last page' do
-        before { get :numbers, :count => 100, :page => 4 }
+        before { get :numbers, :count => 100, :page => 10 }
 
         it_behaves_like 'an endpoint with a last page'
       end

data/spec/rails_spec.rb

@@ -12,13 +12,19 @@ describe NumbersController, :type => :controller do
     let(:total) { response.headers['Total'].to_i }
 
     context 'without enough items to give more than one page' do
-      before { get :index, :count => 20 }
+      before { get :index, :count => 10 }
+
       it 'should not paginate' do
         expect(response.headers.keys).not_to include('Link')
       end
 
       it 'should give a Total header' do
-        expect(total).to eq(20)
+        expect(total).to eq(10)
+      end
+
+      it 'should list all numbers in the response body' do
+        body = '[1,2,3,4,5,6,7,8,9,10]'
+        expect(response.body).to eq(body)
       end
     end
 
@@ -36,7 +42,7 @@ describe NumbersController, :type => :controller do
       end
 
       context 'when on the last page' do
-        before { get :index, :count => 100, :page => 4 }
+        before { get :index, :count => 100, :page => 10 }
 
         it_behaves_like 'an endpoint with a last page'
       end

data/spec/spec_helper.rb

@@ -1,33 +1,10 @@
+require 'coveralls'
+Coveralls.wear_merged!
+
 require 'support/numbers_controller'
 require 'support/numbers_api'
 require 'api-pagination'
 
-# Quacks like Kaminari and will_paginate
-PaginatedSet = Struct.new(:current_page, :per_page, :total_count) do
-  def total_pages
-    total_count.zero? ? 1 : (total_count.to_f / per_page).ceil
-  end
-
-  def first_page?() current_page == 1 end
-  def last_page?() current_page == total_pages end
-
-  def page(page)
-    current_page = page
-    self
-  end
-
-  def per(per)
-    per_page = per
-    self
-  end
-
-  def paginate(options = {})
-    page(options[:page]).per(options[:per_page])
-  end
-
-  alias :total_entries :total_count
-end
-
 if ENV['PAGINATOR']
   ApiPagination.instance_variable_set(:@paginator, ENV['PAGINATOR'].to_sym)
 else
@@ -35,6 +12,12 @@ else
   ApiPagination.instance_variable_set(:@paginator, :kaminari)
 end
 
+if ApiPagination.paginator == :kaminari
+  Kaminari::Hooks.init
+elsif ApiPagination.paginator == :will_paginate
+  require 'will_paginate/array'
+end
+
 RSpec.configure do |config|
   config.include Rack::Test::Methods
   config.include ControllerExampleGroup, :type => :controller

data/spec/support/numbers_api.rb

@@ -5,7 +5,7 @@ class NumbersAPI < Grape::API
   format :json
 
   desc 'Return some paginated set of numbers'
-  paginate :per_page => 25
+  paginate :per_page => 10
   params do
     requires :count, :type => Integer
     optional :with_headers, :default => false, :type => Boolean
@@ -18,6 +18,6 @@ class NumbersAPI < Grape::API
       header 'Link', %(<#{url}?#{query.to_query}>; rel="without")
     end
 
-    paginate PaginatedSet.new(params[:page], params[:per_page], params[:count])
+    paginate (1..params[:count]).to_a
   end
 end

data/spec/support/numbers_controller.rb

@@ -45,8 +45,6 @@ end
 class NumbersController < ActionController::Base
   include Rails.application.routes.url_helpers
 
-  after_filter :only => [:index] { paginate(:numbers) }
-
   def index
     page = params.fetch(:page, 1).to_i
     total = params.fetch(:count).to_i
@@ -57,7 +55,6 @@ class NumbersController < ActionController::Base
       headers['Link'] = %(<#{numbers_url}?#{query.to_param}>; rel="without")
     end
 
-    @numbers = PaginatedSet.new(page, 25, total)
-    render :json => @numbers
+    paginate :json => (1..total).to_a, :per_page => 10
   end
 end

data/spec/support/shared_examples/existing_headers.rb

@@ -5,7 +5,7 @@ shared_examples 'an endpoint with existing Link headers' do
 
   it 'should contain pagination Links' do
     expect(links).to include('<http://example.org/numbers?count=30&page=2&with_headers=true>; rel="next"')
-    expect(links).to include('<http://example.org/numbers?count=30&page=2&with_headers=true>; rel="last"')
+    expect(links).to include('<http://example.org/numbers?count=30&page=3&with_headers=true>; rel="last"')
   end
 
   it 'should give a Total header' do

data/spec/support/shared_examples/first_page.rb

@@ -8,7 +8,7 @@ shared_examples 'an endpoint with a first page' do
   end
 
   it 'should give a link with rel "last"' do
-    expect(links).to include('<http://example.org/numbers?count=100&page=4>; rel="last"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=10>; rel="last"')
   end
 
   it 'should give a link with rel "next"' do
@@ -18,4 +18,13 @@ shared_examples 'an endpoint with a first page' do
   it 'should give a Total header' do
     expect(total).to eq(100)
   end
+
+  it 'should list the first page of numbers in the response body' do
+    body = '[1,2,3,4,5,6,7,8,9,10]'
+    if defined?(response)
+      expect(response.body).to eq(body)
+    else
+      expect(last_response.body).to eq(body)
+    end
+  end
 end

data/spec/support/shared_examples/last_page.rb

@@ -12,10 +12,20 @@ shared_examples 'an endpoint with a last page' do
   end
 
   it 'should give a link with rel "prev"' do
-    expect(links).to include('<http://example.org/numbers?count=100&page=3>; rel="prev"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=9>; rel="prev"')
   end
 
   it 'should give a Total header' do
     expect(total).to eq(100)
   end
+
+  it 'should list the last page of numbers in the response body' do
+    body = '[91,92,93,94,95,96,97,98,99,100]'
+
+    if defined?(response)
+      expect(response.body).to eq(body)
+    else
+      expect(last_response.body).to eq(body)
+    end
+  end
 end

data/spec/support/shared_examples/middle_page.rb

@@ -1,7 +1,7 @@
 shared_examples 'an endpoint with a middle page' do
   it 'should give all pagination links' do
     expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="first"')
-    expect(links).to include('<http://example.org/numbers?count=100&page=4>; rel="last"')
+    expect(links).to include('<http://example.org/numbers?count=100&page=10>; rel="last"')
     expect(links).to include('<http://example.org/numbers?count=100&page=3>; rel="next"')
     expect(links).to include('<http://example.org/numbers?count=100&page=1>; rel="prev"')
   end
@@ -9,4 +9,14 @@ shared_examples 'an endpoint with a middle page' do
   it 'should give a Total header' do
     expect(total).to eq(100)
   end
+
+  it 'should list a middle page of numbers in the response body' do
+    body = '[11,12,13,14,15,16,17,18,19,20]'
+
+    if defined?(response)
+      expect(response.body).to eq(body)
+    else
+      expect(last_response.body).to eq(body)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Link header pagination for Rails APIs
+description: Link header pagination for Rails and Grape APIs
 email:
 - me@davidcel.is
 executables: []
@@ -93,10 +107,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Link header pagination for Rails APIs. Don't use the request body.
+summary: Link header pagination for Rails and Grape APIs. Don't use the request body.
 test_files:
 - spec/grape_spec.rb
 - spec/rails_spec.rb
@@ -107,3 +121,4 @@ test_files:
 - spec/support/shared_examples/first_page.rb
 - spec/support/shared_examples/last_page.rb
 - spec/support/shared_examples/middle_page.rb
+has_rdoc: