api-pagination 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d731640c745b641b398f674974fad336835f430
-  data.tar.gz: 87f4e54a8e7f52bfc64110a9631435ca720381ed
+  metadata.gz: 44223a7f3dfd7705282d1c93abc09c04e55b5cd0
+  data.tar.gz: dbcb589c144ae07bc298b90da5de60eb627b021c
 SHA512:
-  metadata.gz: 3270038dc07c4e4fda06bd333d272c0c1825c27f0533e2d0881673eb0cacf166bc4a88fe98cbf20d7a0106f16abafd09f79c0b4a5bac51d1a0f02e40cbd1ae66
-  data.tar.gz: d4b48b49eadbd2a313018110a643d659df61c3d042804c6dbcfd64b1568f44f11eb18889fea6a6211d27190364f177916c07d48df68a263aa1cd7af27b2c8558
+  metadata.gz: fe8b5fb947b1bf135a49283f4ca86f3b3c5131b564c2492105f358f5864eabf6f0509f5d54594c94e8dfff9a1f2a02fe4573c23dcd32625d08a2978b7be41bc8
+  data.tar.gz: df50ee727c766cb82b2f23efeae78f1c91ea63aa790e0459f5645ccaf48c52145904896592ec596990b8c40a4b542530613f4cc0e151b0dbee500254d06a4b72

data/lib/api-pagination.rb

@@ -1,20 +1,33 @@
-require 'api-pagination/configuration'
 require 'api-pagination/version'
 
 module ApiPagination
   class << self
+    attr_reader :paginator
+
     def paginate(collection, options = {})
       options[:page]     = options[:page].to_i
       options[:page]     = 1 if options[:page] <= 0
       options[:per_page] = options[:per_page].to_i
 
-      case ApiPagination.config.paginator
+      case ApiPagination.paginator
       when :kaminari
-        paginate_with_kaminari(collection, options)
+        if Kaminari.config.max_per_page && options[:per_page] > Kaminari.config.max_per_page
+          options[:per_page] = Kaminari.config.max_per_page
+        elsif options[:per_page] <= 0
+          options[:per_page] = Kaminari.config.default_per_page
+        end
+        collection = Kaminari.paginate_array(collection) if collection.is_a?(Array)
+        collection.page(options[:page]).per(options[:per_page])
       when :will_paginate
-        paginate_with_will_paginate(collection, options)
+        options[:per_page] = WillPaginate.per_page if options[:per_page] <= 0
+
+        if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
+          collection.paginate(options[:page], options[:per_page])
+        else
+          collection.paginate(:page => options[:page], :per_page => options[:per_page])
+        end
       else
-        raise StandardError, "Unknown paginator: #{ApiPagination.config.paginator}"
+        raise StandardError, "Unknown paginator: #{ApiPagination.paginator}"
       end
     end
 
@@ -33,49 +46,11 @@ module ApiPagination
     end
 
     def total_from(collection)
-      case ApiPagination.config.paginator
+      case ApiPagination.paginator
         when :kaminari      then collection.total_count.to_s
         when :will_paginate then collection.total_entries.to_s
       end
     end
-
-    def paginator
-      warn "[DEPRECATION] ApiPagination.paginator is deprecated. Please use ApiPagination.config.paginator"
-      config.paginator
-    end
-
-    def per_page_header
-      warn "[DEPRECATION] ApiPagination.paginator is deprecated. Please use ApiPagination.config.per_page_header"
-      config.per_page_header
-    end
-
-    def total_header
-      warn "[DEPRECATION] ApiPagination.paginator is deprecated. Please use ApiPagination.config.total_header"
-      config.total_header
-    end
-
-    private
-
-    def paginate_with_kaminari(collection, options)
-      if Kaminari.config.max_per_page && options[:per_page] > Kaminari.config.max_per_page
-        options[:per_page] = Kaminari.config.max_per_page
-      elsif options[:per_page] <= 0
-        options[:per_page] = Kaminari.config.default_per_page
-      end
-
-      collection = Kaminari.paginate_array(collection) if collection.is_a?(Array)
-      collection.page(options[:page]).per(options[:per_page])
-    end
-
-    def paginate_with_will_paginate(collection, options)
-      options[:per_page] = WillPaginate.per_page if options[:per_page] <= 0
-
-      if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
-        collection.paginate(options[:page], options[:per_page])
-      else
-        collection.paginate(:page => options[:page], :per_page => options[:per_page])
-      end
-    end
   end
 end
 

data/lib/api-pagination/hooks.rb

@@ -1,30 +1,77 @@
-begin; require 'rails'; rescue LoadError; end
-if defined?(ActionController::Base)
-  require 'rails/pagination'
-  ActionController::Base.send(:include, Rails::Pagination)
-end
+module ApiPagination
+  class Hooks
+    def self.init!
+      begin; require 'rails'; rescue LoadError; end
+      if defined?(ActionController::Base)
+        require 'rails/pagination'
+        ActionController::Base.send(:include, Rails::Pagination)
+      end
 
-begin; require 'rails-api'; rescue LoadError; end
-if defined?(ActionController::API)
-  require 'rails/pagination'
-  ActionController::API.send(:include, Rails::Pagination)
-end
+      begin; require 'rails-api'; rescue LoadError; end
+      if defined?(ActionController::API)
+        require 'rails/pagination'
+        ActionController::API.send(:include, Rails::Pagination)
+      end
 
-begin; require 'grape'; rescue LoadError; end
-if defined?(Grape::API)
-  require 'grape/pagination'
-  Grape::API.send(:include, Grape::Pagination)
-end
+      begin; require 'grape'; rescue LoadError; end
+      if defined?(Grape::API)
+        require 'grape/pagination'
+        Grape::API.send(:include, Grape::Pagination)
+      end
+
+      # Kaminari and will_paginate conflict with each other, so we should check
+      # to see if either is already active before attempting to load them.
+      if defined?(Kaminari) && defined?(WillPaginate::CollectionMethods)
+        STDERR.puts <<-EOC
+Warning: api-pagination relies on either Kaminari or WillPaginate, but these
+gems conflict.  Please ensure only one of them is active at any given time.
+
+EOC
+        return
+      elsif defined?(Kaminari)
+        initialize_kaminari! and return
+      elsif defined?(WillPaginate::CollectionMethods)
+        initialize_will_paginate! and return
+      end
+      # If neither is loaded, we can safely attempt these requires.
+      unless ApiPagination.paginator == :will_paginate
+        begin
+          require 'kaminari'
+          initialize_kaminari! and return
+        rescue LoadError
+        end
+      end
 
-begin; require 'kaminari';      rescue LoadError; end
-begin; require 'will_paginate'; rescue LoadError; end
+      begin
+        require 'will_paginate'
+        initialize_will_paginate! and return
+      rescue LoadError
+      end
 
-unless defined?(Kaminari) || defined?(WillPaginate::CollectionMethods)
-  Kernel.warn <<-WARNING.gsub(/^\s{4}/, '')
-    Warning: api-pagination relies on either Kaminari or WillPaginate. Please
-    install either dependency by adding one of the following to your Gemfile:
+      STDERR.puts <<-EOC
+Warning: api-pagination relies on either Kaminari or WillPaginate. Please
+install either dependency by adding one of the following to your Gemfile:
 
-    gem 'kaminari'
-    gem 'will_paginate'
-  WARNING
+gem 'kaminari'
+gem 'will_paginate'
+
+EOC
+    end
+
+    def self.initialize_kaminari!
+      require 'kaminari/models/array_extension'
+      ApiPagination.instance_variable_set(:@paginator, :kaminari)
+    end
+
+    def self.initialize_will_paginate!
+      WillPaginate::CollectionMethods.module_eval do
+        def first_page?() !previous_page end
+        def last_page?() !next_page end
+      end
+
+      ApiPagination.instance_variable_set(:@paginator, :will_paginate)
+    end
+  end
 end
+
+ApiPagination::Hooks.init!

data/lib/api-pagination/version.rb

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

data/lib/grape/pagination.rb

@@ -3,10 +3,9 @@ module Grape
     def self.included(base)
       Grape::Endpoint.class_eval do
         def paginate(collection)
-          per_page = params[:per_page] || route_setting(:per_page)
           options = {
             :page     => params[:page],
-            :per_page => [per_page, route_setting(:max_per_page)].compact.min
+            :per_page => (params[:per_page] || route_setting(:per_page))
           }
           collection = ApiPagination.paginate(collection, options)
 
@@ -20,12 +19,8 @@ module Grape
             links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
           end
 
-          total_header    = ApiPagination.config.total_header
-          per_page_header = ApiPagination.config.per_page_header
-
-          header 'Link',          links.join(', ') unless links.empty?
-          header total_header,    ApiPagination.total_from(collection)
-          header per_page_header, options[:per_page].to_s
+          header 'Link', links.join(', ') unless links.empty?
+          header 'Total', ApiPagination.total_from(collection)
 
           return collection
         end
@@ -34,7 +29,6 @@ module Grape
       base.class_eval do
         def self.paginate(options = {})
           route_setting :per_page, (options[:per_page] || 25)
-          route_setting :max_per_page, options[:max_per_page]
           params do
             optional :page,     :type => Integer, :default => 1,
                                 :desc => 'Page of results to fetch.'

data/lib/rails/pagination.rb

@@ -39,14 +39,11 @@ module Rails
         links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
       end
 
-      total_header    = ApiPagination.config.total_header
-      per_page_header = ApiPagination.config.per_page_header
-
-      headers['Link']          = links.join(', ') unless links.empty?
-      headers[total_header]    = ApiPagination.total_from(collection)
-      headers[per_page_header] = options[:per_page].to_s
+      headers['Link']  = links.join(', ') unless links.empty?
+      headers['Total'] = ApiPagination.total_from(collection)
 
       return collection
     end
   end
 end
+

data/spec/grape_spec.rb

@@ -8,10 +8,9 @@ describe NumbersAPI do
   describe 'GET #index' do
     let(:links) { last_response.headers['Link'].split(', ') }
     let(:total) { last_response.headers['Total'].to_i }
-    let(:per_page) { last_response.headers['Per-Page'].to_i }
 
     context 'without enough items to give more than one page' do
-      before { get '/numbers', :count => 10 }
+      before { get :numbers, :count => 10 }
 
       it 'should not paginate' do
         expect(last_response.headers.keys).not_to include('Link')
@@ -21,10 +20,6 @@ describe NumbersAPI do
         expect(total).to eq(10)
       end
 
-      it 'should give a Per-Page header' do
-        expect(per_page).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)
@@ -32,72 +27,29 @@ describe NumbersAPI do
     end
 
     context 'with existing Link headers' do
-      before { get '/numbers', :count => 30, :with_headers => true }
+      before { get :numbers, :count => 30, :with_headers => true }
 
       it_behaves_like 'an endpoint with existing Link headers'
     end
 
     context 'with enough items to paginate' do
       context 'when on the first page' do
-        before { get '/numbers', :count => 100 }
+        before { get :numbers, :count => 100 }
 
         it_behaves_like 'an endpoint with a first page'
       end
 
       context 'when on the last page' do
-        before { get '/numbers', :count => 100, :page => 10 }
+        before { get :numbers, :count => 100, :page => 10 }
 
         it_behaves_like 'an endpoint with a last page'
       end
 
       context 'when somewhere comfortably in the middle' do
-        before { get '/numbers', :count => 100, :page => 2 }
+        before { get :numbers, :count => 100, :page => 2 }
 
         it_behaves_like 'an endpoint with a middle page'
       end
-
-      context 'with a max_per_page setting' do
-        before { get '/numbers', :count => 100, :per_page => 30 }
-
-        it 'should not go above the max_per_page_limit' do
-          body = '[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]'
-
-          expect(last_response.body).to eq(body)
-        end
-      end
-    end
-
-    context 'with custom response headers' do
-      before do
-        ApiPagination.config.total_header    = 'X-Total-Count'
-        ApiPagination.config.per_page_header = 'X-Per-Page'
-
-        get '/numbers', count: 10
-      end
-
-      after do
-        ApiPagination.config.total_header    = 'Total'
-        ApiPagination.config.per_page_header = 'Per-Page'
-      end
-
-      let(:total) { last_response.header['X-Total-Count'].to_i }
-      let(:per_page) { last_response.header['X-Per-Page'].to_i }
-
-      it 'should give a X-Total-Count header' do
-        headers_keys = last_response.headers.keys
-
-        expect(headers_keys).not_to include('Total')
-        expect(headers_keys).to include('X-Total-Count')
-        expect(total).to eq(10)
-      end
-
-      it 'should give a X-Per-Page header' do
-        headers_keys = last_response.headers.keys
-
-        expect(headers_keys).not_to include('Per-Page')
-        expect(headers_keys).to include('X-Per-Page')
-        expect(per_page).to eq(10)
-      end
     end
   end
 end

data/spec/rails_spec.rb

@@ -10,7 +10,6 @@ describe NumbersController, :type => :controller do
   describe 'GET #index' do
     let(:links) { response.headers['Link'].split(', ') }
     let(:total) { response.headers['Total'].to_i }
-    let(:per_page) { response.headers['Per-Page'].to_i }
 
     context 'without enough items to give more than one page' do
       before { get :index, :count => 10 }
@@ -23,10 +22,6 @@ describe NumbersController, :type => :controller do
         expect(total).to eq(10)
       end
 
-      it 'should give a Per-Page header' do
-        expect(per_page).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)
@@ -68,38 +63,10 @@ describe NumbersController, :type => :controller do
         expect(response.body).to eq(json)
       end
     end
+  end
+end
 
-    context 'with custom response headers' do
-      before do
-        ApiPagination.config.total_header    = 'X-Total-Count'
-        ApiPagination.config.per_page_header = 'X-Per-Page'
-
-        get :index, count: 10
-      end
-
-      after do
-        ApiPagination.config.total_header    = 'Total'
-        ApiPagination.config.per_page_header = 'Per-Page'
-      end
-
-      let(:total) { response.header['X-Total-Count'].to_i }
-      let(:per_page) { response.header['X-Per-Page'].to_i }
 
-      it 'should give a X-Total-Count header' do
-        headers_keys = response.headers.keys
 
-        expect(headers_keys).not_to include('Total')
-        expect(headers_keys).to include('X-Total-Count')
-        expect(total).to eq(10)
-      end
 
-      it 'should give a X-Per-Page header' do
-        headers_keys = response.headers.keys
 
-        expect(headers_keys).not_to include('Per-Page')
-        expect(headers_keys).to include('X-Per-Page')
-        expect(per_page).to eq(10)
-      end
-    end
-  end
-end

data/spec/sequel_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-if ApiPagination.config.paginator == :will_paginate
+if ApiPagination.paginator == :will_paginate
   require 'sqlite3'
   require 'sequel'
   require 'will_paginate/sequel'

data/spec/spec_helper.rb

@@ -1,17 +1,15 @@
-require 'support/numbers_controller'
-require 'support/numbers_api'
-require 'api-pagination'
-
 if ENV['PAGINATOR']
-  require ENV['PAGINATOR']
-  ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
+  ApiPagination.instance_variable_set(:@paginator, ENV['PAGINATOR'].to_sym)
 else
   warn 'No PAGINATOR set. Defaulting to kaminari. To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`'
-  require 'kaminari'
-  ApiPagination.config.paginator = :kaminari
+  ApiPagination.instance_variable_set(:@paginator, :kaminari)
 end
 
-require 'will_paginate/array'
+require 'support/numbers_controller'
+require 'support/numbers_api'
+require 'api-pagination'
+
+require 'will_paginate/array' if ApiPagination.paginator == :will_paginate
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods

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 => 10, :max_per_page => 25 
+  paginate :per_page => 10
   params do
     requires :count, :type => Integer
     optional :with_headers, :default => false, :type => Boolean

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.0
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.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
     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: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.9.0
 description: Link header pagination for Rails and Grape APIs
@@ -87,10 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/api-pagination/configuration.rb
+- lib/api-pagination.rb
 - lib/api-pagination/hooks.rb
 - lib/api-pagination/version.rb
-- lib/api-pagination.rb
 - lib/grape/pagination.rb
 - lib/rails/pagination.rb
 - spec/grape_spec.rb
@@ -113,17 +112,17 @@ 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.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Link header pagination for Rails and Grape APIs. Don't use the request body.
@@ -138,3 +137,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: 

data/lib/api-pagination/configuration.rb

@@ -1,85 +0,0 @@
-module ApiPagination
-  class Configuration
-    attr_accessor :total_header
-
-    attr_accessor :per_page_header
-
-    def configure(&block)
-      yield self
-    end
-
-    def initialize
-      @total_header    = 'Total'
-      @per_page_header = 'Per-Page'
-    end
-
-    def paginator
-      @paginator || set_paginator
-    end
-
-    def paginator=(paginator)
-      case paginator.to_sym
-      when :kaminari
-        use_kaminari
-      when :will_paginate
-        use_will_paginate
-      else
-        raise StandardError, "Unknown paginator: #{paginator}"
-      end
-    end
-
-    private
-
-    def set_paginator
-      if defined?(Kaminari) && defined?(WillPaginate::CollectionMethods)
-        Kernel.warn <<-WARNING
-Warning: api-pagination relies on either Kaminari or WillPaginate, but both are
-currently active. If possible, you should remove one or the other. If you can't,
-you _must_ configure api-pagination on your own. For example:
-
-ApiPagination.configure do |config|
-  config.paginator = :kaminari
-end
-
-You should also configure Kaminari to use a different `per_page` method name as
-using these gems together causes a conflict; some information can be found at
-https://github.com/activeadmin/activeadmin/wiki/How-to-work-with-will_paginate
-
-Kaminari.configure do |config|
-  config.page_method_name = :per_page_kaminari
-end
-
-WARNING
-      elsif defined?(Kaminari)
-        return use_kaminari
-      elsif defined?(WillPaginate::CollectionMethods)
-        return use_will_paginate
-      end
-    end
-
-    def use_kaminari
-      require 'kaminari/models/array_extension'
-      @paginator = :kaminari
-    end
-
-    def use_will_paginate
-      WillPaginate::CollectionMethods.module_eval do
-        def first_page?() !previous_page end
-        def last_page?() !next_page end
-      end
-
-      @paginator = :will_paginate
-    end
-  end
-
-  class << self
-    def configure
-      yield config
-    end
-
-    def config
-      @config ||= Configuration.new
-    end
-    alias :configuration :config
-  end
-end