api-pagination 4.4.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8bd6ee617ad9ee01273cb7b36548cdb197110aa
-  data.tar.gz: b24a83cb8d231b98d7ed1670adb7f23680a80210
+SHA256:
+  metadata.gz: 0aeee41828ccf353b3be509b5ddc10f180cb238d9b12bb8c357dc3ddfd35f07e
+  data.tar.gz: d2e33f4bf383e78f99d9e0d5ee6878e6fa54c8f9ad7412de18d23cadf45ec650
 SHA512:
-  metadata.gz: 729785a6c4835d934f1f6fdab6159ca54f2003aecb4368774581478bb40640b62b1790b332e9d567c2b02b55ae980bd37ae6b01b30fbf5288657f2c87e111cce
-  data.tar.gz: aba98e01b6082d375864506e0ba1d6d6483961e6ef6d5bc61f8c4662fa81b6a785b5ca21029d237dead8e4a8aad28309c8f4c28e9be3924a53cd2eb00362e8c1
+  metadata.gz: c45ef1013c9a791da01d230be2f1a719af87a658b7ba7ab5a2643959eebe9bed8c7935f591f3077a8ed9db5822d561299a9fad87b8347faa3d45b7e6bab70cfc
+  data.tar.gz: 81e9f814f3ba16bcf86f1a07a26d7ac951e1dbc8a13221e9ef6db207861389ee301b6cb2c1923ff3deffc5718bc203070c0f4b77fca64535abe26f62590fdd6f

data/lib/api-pagination/configuration.rb

@@ -8,6 +8,10 @@ module ApiPagination
 
     attr_accessor :include_total
 
+    attr_accessor :base_url
+
+    attr_accessor :response_formats
+
     def configure(&block)
       yield self
     end
@@ -17,6 +21,8 @@ module ApiPagination
       @per_page_header = 'Per-Page'
       @page_header     = nil
       @include_total   = true
+      @base_url   = nil
+      @response_formats = [:json, :xml]
     end
 
     ['page', 'per_page'].each do |param_name|
@@ -47,11 +53,17 @@ module ApiPagination
     end
 
     def paginator
-      @paginator || set_paginator
+      if instance_variable_defined? :@paginator
+        @paginator
+      else
+        set_paginator
+      end
     end
 
     def paginator=(paginator)
       case paginator.to_sym
+      when :pagy
+        use_pagy
       when :kaminari
         use_kaminari
       when :will_paginate
@@ -64,11 +76,12 @@ module ApiPagination
     private
 
     def set_paginator
-      if defined?(Kaminari) && defined?(WillPaginate::CollectionMethods)
+      conditions = [defined?(Pagy), defined?(Kaminari), defined?(WillPaginate::CollectionMethods)]
+      if conditions.compact.size > 1
         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:
+Warning: api-pagination relies on Pagy, Kaminari, or WillPaginate, but more than
+one 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
@@ -83,13 +96,19 @@ Kaminari.configure do |config|
 end
 
 WARNING
+      elsif defined?(Pagy)
+        use_pagy
       elsif defined?(Kaminari)
-        return use_kaminari
+        use_kaminari
       elsif defined?(WillPaginate::CollectionMethods)
-        return use_will_paginate
+        use_will_paginate
       end
     end
 
+    def use_pagy
+      @paginator = :pagy
+    end
+
     def use_kaminari
       require 'kaminari/models/array_extension'
       @paginator = :kaminari

data/lib/api-pagination/hooks.rb

@@ -1,30 +1,43 @@
-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 'grape'; rescue LoadError; end
 if defined?(Grape::API)
   require 'grape/pagination'
-  Grape::API.send(:include, Grape::Pagination)
+
+  klass = if Grape::VERSION >= '1.2.0' || defined?(Grape::API::Instance)
+    Grape::API::Instance
+  else
+    Grape::API
+  end
+
+  klass.send(:include, Grape::Pagination)
 end
 
+begin; require 'pagy';          rescue LoadError; end
 begin; require 'kaminari';      rescue LoadError; end
 begin; require 'will_paginate'; rescue LoadError; end
 
-unless defined?(Kaminari) || defined?(WillPaginate::CollectionMethods)
+unless defined?(Pagy) || 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:
+    Warning: api-pagination relies on either Pagy, Kaminari, or WillPaginate.
+    Please install a paginator by adding one of the following to your Gemfile:
 
+    gem 'pagy'
     gem 'kaminari'
     gem 'will_paginate'
   WARNING
 end
+
+if defined?(Rails)
+  module ApiPagination
+    module Hooks
+      def self.rails_parent_controller
+        if Rails::VERSION::MAJOR >= 5 || defined?(ActionController::API)
+          ActionController::API
+        else
+          ActionController::Base
+        end
+      end
+    end
+  end
+
+  require 'api-pagination/railtie'
+end

data/lib/api-pagination/railtie.rb

@@ -0,0 +1,19 @@
+require 'rails/railtie'
+
+module ApiPagination
+  class Railtie < ::Rails::Railtie
+    initializer :api_pagination do
+      ActiveSupport.on_load(:action_controller) do
+        require 'rails/pagination'
+
+        klass = if Rails::VERSION::MAJOR >= 5 || defined?(ActionController::API)
+          ActionController::API
+        else
+          ActionController::Base
+        end
+
+        klass.send(:include, Rails::Pagination)
+      end
+    end
+  end
+end

data/lib/api-pagination/version.rb

@@ -1,7 +1,7 @@
 module ApiPagination
   class Version
-    MAJOR = 4
-    MINOR = 4
+    MAJOR = 6
+    MINOR = 0
     PATCH = 0
 
     def self.to_s

data/lib/api-pagination.rb

@@ -9,6 +9,8 @@ module ApiPagination
       options[:per_page] = options[:per_page].to_i
 
       case ApiPagination.config.paginator
+      when :pagy
+        paginate_with_pagy(collection, options)
       when :kaminari
         paginate_with_kaminari(collection, options, options[:paginate_array_options] || {})
       when :will_paginate
@@ -18,15 +20,17 @@ module ApiPagination
       end
     end
 
-    def pages_from(collection)
+    def pages_from(collection, options = {})
+      return pagy_pages_from(collection) if ApiPagination.config.paginator == :pagy && collection.is_a?(Pagy)
+
       {}.tap do |pages|
         unless collection.first_page?
           pages[:first] = 1
           pages[:prev]  = collection.current_page - 1
         end
 
-        unless collection.last_page?
-          pages[:last] = collection.total_pages
+        unless collection.last_page? || (ApiPagination.config.paginator == :kaminari && collection.out_of_range?)
+          pages[:last] = collection.total_pages if ApiPagination.config.include_total
           pages[:next] = collection.current_page + 1
         end
       end
@@ -34,6 +38,7 @@ module ApiPagination
 
     def total_from(collection)
       case ApiPagination.config.paginator
+        when :pagy          then collection.count.to_s
         when :kaminari      then collection.total_count.to_s
         when :will_paginate then collection.total_entries.to_s
       end
@@ -41,6 +46,47 @@ module ApiPagination
 
     private
 
+    def paginate_with_pagy(collection, options)
+      if Pagy::DEFAULT[:max_per_page] && options[:per_page] > Pagy::DEFAULT[:max_per_page]
+        options[:per_page] = Pagy::DEFAULT[:max_per_page]
+      elsif options[:per_page] <= 0
+        options[:per_page] = Pagy::DEFAULT[:limit]
+      end
+
+      pagy = pagy_from(collection, options)
+      collection = if collection.respond_to?(:offset) && collection.respond_to?(:limit)
+        collection.offset(pagy.offset).limit(pagy.limit)
+      else
+        collection[pagy.offset, pagy.limit]
+      end
+
+      return [collection, pagy]
+    end
+
+    def pagy_from(collection, options)
+      if options[:count]
+        count = options[:count]
+      else
+        count = collection.is_a?(Array) ? collection.count : collection.count(:all)
+      end
+
+      Pagy.new(count: count, limit: options[:per_page], page: options[:page])
+    end
+
+    def pagy_pages_from(pagy)
+      {}.tap do |pages|
+        unless pagy.page == 1
+          pages[:first] = 1
+          pages[:prev]  = pagy.prev
+        end
+
+        unless pagy.page == pagy.pages
+          pages[:last] = pagy.pages if ApiPagination.config.include_total
+          pages[:next] = pagy.next
+        end
+      end
+    end
+
     def paginate_with_kaminari(collection, options, paginate_array_options = {})
       if Kaminari.config.max_per_page && options[:per_page] > Kaminari.config.max_per_page
         options[:per_page] = Kaminari.config.max_per_page
@@ -48,8 +94,10 @@ module ApiPagination
         options[:per_page] = get_default_per_page_for_kaminari(collection)
       end
 
-      collection = Kaminari.paginate_array(collection, paginate_array_options) if collection.is_a?(Array)
-      collection.page(options[:page]).per(options[:per_page])
+      collection = Kaminari.paginate_array(collection, **paginate_array_options) if collection.is_a?(Array)
+      collection = collection.page(options[:page]).per(options[:per_page])
+      collection.without_count if !collection.is_a?(Array) && !ApiPagination.config.include_total
+      [collection, nil]
     end
 
     def paginate_with_will_paginate(collection, options)
@@ -57,29 +105,36 @@ module ApiPagination
         options[:per_page] = default_per_page_for_will_paginate(collection)
       end
 
-      if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
+      collection = 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])
+        supported_options = [:page, :per_page, :total_entries]
+        options = options.dup.keep_if { |k,v| supported_options.include?(k.to_sym) }
+        collection.paginate(options)
       end
+
+      [collection, nil]
     end
 
     def get_default_per_page_for_kaminari(collection)
       default = Kaminari.config.default_per_page
-      detect_model(collection).default_per_page || default
-    rescue
-      default
+      extract_per_page_from_model(collection, :default_per_page) || default
     end
 
     def default_per_page_for_will_paginate(collection)
       default = WillPaginate.per_page
-      detect_model(collection).per_page || default
-    rescue
-      default
+      extract_per_page_from_model(collection, :per_page) || default
     end
 
-    def detect_model(collection)
-      collection.first.class
+    def extract_per_page_from_model(collection, accessor)
+      klass = if collection.respond_to?(:klass)
+        collection.klass
+      else
+        collection.first.class
+      end
+
+      return unless klass.respond_to?(accessor)
+      klass.send(accessor)
     end
   end
 end

data/lib/grape/pagination.rb

@@ -9,11 +9,11 @@ module Grape
             :page     => ApiPagination.config.page_param(params),
             :per_page => [per_page, route_setting(:max_per_page)].compact.min
           }
-          collection = ApiPagination.paginate(collection, options)
+          collection, pagy = ApiPagination.paginate(collection, options)
 
           links = (header['Link'] || "").split(',').map(&:strip)
           url   = request.url.sub(/\?.*$/, '')
-          pages = ApiPagination.pages_from(collection)
+          pages = ApiPagination.pages_from(pagy || collection, options)
 
           pages.each do |k, v|
             old_params = Rack::Utils.parse_nested_query(request.query_string)
@@ -27,7 +27,7 @@ module Grape
           include_total   = ApiPagination.config.include_total
 
           header 'Link',          links.join(', ') unless links.empty?
-          header total_header,    ApiPagination.total_from(collection) if include_total
+          header total_header,    ApiPagination.total_from(pagy || collection).to_s if include_total
           header per_page_header, options[:per_page].to_s
           header page_header,     options[:page].to_s unless page_header.nil?
 
@@ -39,11 +39,16 @@ module Grape
         def self.paginate(options = {})
           route_setting :per_page, options[:per_page]
           route_setting :max_per_page, options[:max_per_page]
+
+          enforce_max_per_page = options[:max_per_page] && options[:enforce_max_per_page]
+          per_page_values = enforce_max_per_page ? 0..options[:max_per_page] : nil
+
           params do
-            optional :page,     :type => Integer, :default => 1,
-                                :desc => 'Page of results to fetch.'
-            optional :per_page, :type => Integer,
-                                :desc => 'Number of results to return per page.'
+            optional :page,     :type   => Integer, :default => 1,
+                                :desc   => 'Page of results to fetch.'
+            optional :per_page, :type   => Integer, :default => options[:per_page],
+                                :desc   => 'Number of results to return per page.',
+                                :values => per_page_values
           end
         end
       end

data/lib/rails/pagination.rb

@@ -8,11 +8,12 @@ module Rails
 
       return _paginate_collection(collection, options) if collection
 
-      collection = options[:json] || options[:xml]
+      response_format = _discover_format(options)
+
+      collection = options[response_format]
       collection = _paginate_collection(collection, options)
 
-      options[:json] = collection if options[:json]
-      options[:xml]  = collection if options[:xml]
+      options[response_format] = collection if options[response_format]
 
       render options
     end
@@ -23,15 +24,21 @@ module Rails
 
     private
 
+    def _discover_format(options)
+      for response_format in ApiPagination.config.response_formats
+        return response_format if options.key?(response_format)
+      end
+    end
+
     def _paginate_collection(collection, options={})
       options[:page] = ApiPagination.config.page_param(params)
       options[:per_page] ||= ApiPagination.config.per_page_param(params)
 
-      collection = ApiPagination.paginate(collection, options)
+      collection, pagy = ApiPagination.paginate(collection, options)
 
-      links = (headers['Link'] || "").split(',').map(&:strip)
-      url   = request.original_url.sub(/\?.*$/, '')
-      pages = ApiPagination.pages_from(collection)
+      links = (headers['Link'] || '').split(',').map(&:strip)
+      url   = base_url + request.path_info
+      pages = ApiPagination.pages_from(pagy || collection, options)
 
       pages.each do |k, v|
         new_params = request.query_parameters.merge(:page => v)
@@ -46,7 +53,7 @@ module Rails
       headers['Link'] = links.join(', ') unless links.empty?
       headers[per_page_header] = options[:per_page].to_s
       headers[page_header] = options[:page].to_s unless page_header.nil?
-      headers[total_header] = total_count(collection, options) if include_total
+      headers[total_header] = total_count(pagy || collection, options).to_s if include_total
 
       return collection
     end
@@ -58,5 +65,9 @@ module Rails
       end
       total_count || ApiPagination.total_from(collection)
     end
+
+    def base_url
+      ApiPagination.config.base_url || request.base_url
+    end
   end
 end

data/spec/active_record_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'support/active_record/foo'
+require 'nulldb_rspec'
+
+ActiveRecord::Base.establish_connection(
+  adapter: :nulldb,
+  schema: 'spec/support/active_record/schema.rb'
+)
+
+NullDB.configure { |ndb| def ndb.project_root; Dir.pwd; end; }
+
+shared_examples 'produces_correct_sql' do 
+  it 'produces correct sql for first page' do
+    allow(collection).to receive(:count).and_return(collection_size)
+    paginated_sql, _ = ApiPagination.paginate(collection, per_page: per_page)
+    expect(paginated_sql.to_sql).to eql(Foo.limit(per_page).offset(0).to_sql)
+  end
+end
+
+describe 'ActiveRecord Support' do 
+  let(:collection) { Foo.all }
+  let(:collection_size) { 50 }
+  let(:per_page) { 5 }
+  
+  if ApiPagination.config.paginator == :will_paginate
+    require 'will_paginate/active_record'
+  end
+
+  context "pagination with #{ApiPagination.config.paginator}" do 
+    include_examples 'produces_correct_sql'
+  end
+
+
+  if ApiPagination.config.paginator != :pagy
+    context 'reflections' do
+      it 'invokes the correct methods to determine type' do 
+        expect(collection).to receive(:klass).at_least(:once)
+                                             .and_call_original
+        ApiPagination.paginate(collection)
+      end
+
+      it 'does not fail if table name is not snake cased class name' do
+        allow(collection).to receive(:table_name).and_return(SecureRandom.uuid)
+        expect { ApiPagination.paginate(collection) }.to_not raise_error
+      end
+    end
+  end
+end
+
+

data/spec/api-pagination_spec.rb

@@ -1,30 +1,76 @@
 require 'spec_helper'
 
 describe ApiPagination do
-  let(:collection) { (1..100).to_a }
-  let(:paginate_array_options) { { total_count: 1000 } }
+  let(:collection) {(1..100).to_a}
+  let(:active_record_relation) {double("ActiveRecord_Relation").as_null_object}
+  let(:paginate_array_options) {{ total_count: 1000 }}
 
-  context 'Using kaminari' do
-    before do
-      ApiPagination.config.paginator = :kaminari
-    end
+  describe "#paginate" do
+    if ENV['PAGINATOR'].to_sym == :kaminari
+      context 'Using kaminari' do
+        describe '.paginate' do
+          it 'should accept paginate_array_options option' do
+            expect(Kaminari).to receive(:paginate_array)
+              .with(collection, **paginate_array_options)
+              .and_call_original
+
+            ApiPagination.paginate(
+              collection,
+              {
+                per_page: 30,
+                paginate_array_options: paginate_array_options
+              }
+            )
+          end
+
+          context 'configured not to include the total' do
+            before { ApiPagination.config.include_total = false }
+
+            context 'and paginating an array' do
+              it 'should not call without_count on the collection' do
+                expect(collection).to_not receive :without_count
+                ApiPagination.paginate(collection)
+              end
+            end
+            context 'and paginating an active record relation' do
+              it 'should call without_count on the relation' do
+                expect(active_record_relation).to receive :without_count
+                ApiPagination.paginate(active_record_relation)
+              end
+            end
 
-    after do
-      ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
+            after { ApiPagination.config.include_total = true }
+          end
+        end
+
+        describe '.pages_from' do
+          subject { described_class.pages_from(collection) }
+
+          context 'on empty collection' do
+            let(:collection) { ApiPagination.paginate([], page: 1).first }
+
+            it { is_expected.to be_empty }
+          end
+        end
+      end
     end
 
-    it 'should accept paginate_array_options option' do
-      expect(Kaminari).to receive(:paginate_array)
-                            .with(collection, paginate_array_options)
-                            .and_call_original
-
-      ApiPagination.paginate(
-        collection,
-        {
-          per_page: 30,
-          paginate_array_options: paginate_array_options
-        }
-      )
+    if ENV['PAGINATOR'].to_sym == :will_paginate
+      context 'Using will_paginate' do
+        context 'passing in total_entries in options' do
+          it 'should set total_entries using the passed in value' do
+            paginated_collection = ApiPagination.paginate(collection, total_entries: 3000).first
+            expect(paginated_collection.total_entries).to eq(3000)
+          end
+        end
+
+        context 'passing in collection only' do
+          it 'should set total_entries using the size of the collection ' do
+            paginated_collection = ApiPagination.paginate(collection).first
+            expect(paginated_collection.total_entries).to eq(100)
+          end
+        end
+      end
     end
   end
 end

data/spec/grape_spec.rb

@@ -5,8 +5,11 @@ require 'support/shared_examples/middle_page'
 require 'support/shared_examples/last_page'
 
 describe NumbersAPI do
+  it { is_expected.to be_kind_of(Grape::Pagination) }
+
   describe 'GET #index' do
-    let(:links) { last_response.headers['Link'].split(', ') }
+    let(:link) { last_response.headers['Link'] }
+    let(:links) { link.split(', ') }
     let(:total) { last_response.headers['Total'].to_i }
     let(:per_page) { last_response.headers['Per-Page'].to_i }
 
@@ -56,15 +59,35 @@ describe NumbersAPI do
         it_behaves_like 'an endpoint with a middle page'
       end
 
-      context 'with a max_per_page setting' do
+      context 'without a max_per_page setting' do
         before { get '/numbers', :count => 100, :per_page => 30 }
 
+        it 'should list all numbers within per page in the response body' 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,26,27,28,29,30]'
+
+          expect(last_response.body).to eq(body)
+        end
+      end
+
+      context 'with a max_per_page setting not enforced' do
+        before { get '/numbers_with_max_per_page', :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
+
+      context 'with a max_per_page setting enforced' do
+        before { get '/numbers_with_enforced_max_per_page', :count => 100, :per_page => 30 }
+
+        it 'should not allow value above the max_per_page_limit' do
+          body = '{"error":"per_page does not have a valid value"}'
+
+          expect(last_response.body).to eq(body)
+        end
+      end
     end
 
     context 'with custom response headers' do
@@ -119,6 +142,12 @@ describe NumbersAPI do
         expect(last_response.header['Total']).to be_nil
       end
 
+      it 'should not include a link with rel "last"' do
+        get '/numbers', count: 100
+
+        expect(link).to_not include('rel="last"')
+      end
+
       after { ApiPagination.config.include_total = true }
     end
 

data/spec/rails_spec.rb

@@ -8,12 +8,13 @@ describe NumbersController, :type => :controller do
   before { request.host = 'example.org' }
 
   describe 'GET #index' do
-    let(:links) { response.headers['Link'].split(', ') }
+    let(:link) { response.headers['Link'] }
+    let(:links) { 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 }
+      before { get :index, params: {count: 10} }
 
       it 'should not paginate' do
         expect(response.headers.keys).not_to include('Link')
@@ -34,26 +35,26 @@ describe NumbersController, :type => :controller do
     end
 
     context 'with existing Link headers' do
-      before { get :index, :count => 30, :with_headers => true }
+      before { get :index, params: {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 :index, :count => 100 }
+        before { get :index, params: {count: 100} }
 
         it_behaves_like 'an endpoint with a first page'
       end
 
       context 'when on the last page' do
-        before { get :index, :count => 100, :page => 10 }
+        before { get :index, params: {count: 100, page: 10} }
 
         it_behaves_like 'an endpoint with a last page'
       end
 
       context 'when somewhere comfortably in the middle' do
-        before { get :index, :count => 100, :page => 2 }
+        before { get :index, params: {count: 100, page: 2} }
 
         it_behaves_like 'an endpoint with a middle page'
       end
@@ -61,7 +62,7 @@ describe NumbersController, :type => :controller do
 
     context 'providing a block' do
       it 'yields to the block instead of implicitly rendering' do
-        get :index_with_custom_render, :count => 100
+        get :index_with_custom_render, params: {count: 100}
 
         json = { numbers: (1..10).map { |n| { number: n } } }.to_json
 
@@ -74,19 +75,23 @@ describe NumbersController, :type => :controller do
         ApiPagination.config.total_header    = 'X-Total-Count'
         ApiPagination.config.per_page_header = 'X-Per-Page'
         ApiPagination.config.page_header     = 'X-Page'
+        ApiPagination.config.base_url        = 'http://guybrush:3000'
 
-        get :index, count: 10
+        get :index, params: params
       end
 
       after do
         ApiPagination.config.total_header    = 'Total'
         ApiPagination.config.per_page_header = 'Per-Page'
         ApiPagination.config.page_header     = nil
+        ApiPagination.config.base_url        = nil
       end
 
+      let(:params) { { count: 10 } }
       let(:total) { response.header['X-Total-Count'].to_i }
       let(:per_page) { response.header['X-Per-Page'].to_i }
       let(:page) { response.header['X-Page'].to_i }
+      let(:link) { response.header['Link'] }
 
       it 'should give a X-Total-Count header' do
         headers_keys = response.headers.keys
@@ -110,17 +115,32 @@ describe NumbersController, :type => :controller do
         expect(headers_keys).to include('X-Page')
         expect(page).to eq(1)
       end
+
+      context 'with paginated result' do
+        let(:params) { { count: 20 } }
+        it 'should use custom base_url in the Link header' do
+
+          expect(response.headers['Link']).to eq(
+            '<http://guybrush:3000/numbers?count=20&page=2>; rel="last", <http://guybrush:3000/numbers?count=20&page=2>; rel="next"')
+        end
+      end
     end
 
     context 'configured not to include the total' do
       before { ApiPagination.config.include_total = false }
 
       it 'should not include a Total header' do
-        get :index, count: 10
+        get :index, params: {count: 10}
 
         expect(response.header['Total']).to be_nil
       end
 
+      it 'should not include a link with rel "last"' do
+        get :index, params: { count: 100 }
+
+        expect(link).to_not include('rel="last"')
+      end
+
       after { ApiPagination.config.include_total = true }
     end
 
@@ -137,7 +157,7 @@ describe NumbersController, :type => :controller do
         end
 
         it 'should work' do
-          get :index, :foo => 2, :count => 100
+          get :index, params: {foo: 2, count: 100}
 
           expect(response.header['Page']).to eq('2')
         end
@@ -158,7 +178,7 @@ describe NumbersController, :type => :controller do
         end
 
         it 'should work' do
-          get :index, :foo => { :bar => 2 }, :count => 100
+          get :index, params: {foo: {bar:  2}, count: 100}
 
           expect(response.header['Page']).to eq('2')
         end
@@ -176,7 +196,7 @@ describe NumbersController, :type => :controller do
         end
 
         it 'should work' do
-          get :index_with_no_per_page, :foo => 2, :count => 100
+          get :index_with_no_per_page, params: {foo: 2, count: 100}
 
           expect(response.header['Per-Page']).to eq('2')
         end
@@ -194,15 +214,18 @@ describe NumbersController, :type => :controller do
         end
 
         it 'should work' do
-          get :index_with_no_per_page, :foo => { :bar => 2 }, :count => 100
+          get :index_with_no_per_page, params: {foo: {bar: 2}, count: 100}
 
           expect(response.header['Per-Page']).to eq('2')
         end
       end
     end
 
-    context 'paginate array options' do
-      shared_examples 'properly set Total header' do
+    if ApiPagination.config.paginator.to_sym == :kaminari
+      context 'paginate array options' do
+        let(:paginate_array_total_count) { 300 }
+        let(:total_header) { 300 }
+        let(:count) { 50 }
         let(:params) do
           {
             paginate_array_total_count: paginate_array_total_count,
@@ -210,78 +233,75 @@ describe NumbersController, :type => :controller do
           }
         end
 
-        specify do
-          get :index_with_paginate_array_options, params
+        it 'has a properly set Total header' do
+          get :index_with_paginate_array_options, params: params
+
+          expect(response.header['Total']).to be_kind_of(String)
           expect(response.header['Total'].to_i).to eq total_header
         end
       end
+    end
 
-      context 'kaminari' do
-        around do |example|
-          paginator = ApiPagination.config.paginator
-          ApiPagination.config.paginator = :kaminari
-          example.run
-          ApiPagination.config.paginator = paginator
-        end
+    if [:will_paginate, :kaminari].include?(ApiPagination.config.paginator.to_sym)
+      context 'default per page in model' do
+        before do
+          class Fixnum
+            @default_per_page = 6
+            @per_page = 6
 
-        it_should_behave_like 'properly set Total header' do
-          let(:paginate_array_total_count) { 300 }
-          let(:total_header) { 300 }
-          let(:count) { 50 }
+            class << self
+              attr_accessor :default_per_page, :per_page
+            end
+          end
         end
-      end
 
-      context 'will_paginate' do
-        around do |example|
-          paginator = ApiPagination.config.paginator
-          ApiPagination.config.paginator = :will_paginate
-          example.run
-          ApiPagination.config.paginator = paginator
+        after do
+          class Fixnum
+            @default_per_page = 25
+            @per_page = 25
+          end
         end
 
-        it_should_behave_like 'properly set Total header' do
-          let(:paginate_array_total_count) { 300 }
-          let(:total_header) { 50 }
-          let(:count) { 50 }
+        after :all do
+          class Fixnum
+            class << self
+              undef_method :default_per_page, :per_page
+            end
+          end
         end
-      end
-    end
 
-    context 'default per page in model' do
-      before do
-        class Fixnum
-          @default_per_page = 6
-          @per_page = 6
+        it 'should use default per page from model' do
+          get :index_with_no_per_page, params: {count: 100}
 
-          class << self
-            attr_accessor :default_per_page, :per_page
-          end
+          expect(response.header['Per-Page']).to eq('6')
         end
-      end
 
-      after do
-        class Fixnum
-          @default_per_page = 25
-          @per_page = 25
-        end
-      end
+        it 'should not fail if the model yields nil for per page' do
+          class Fixnum
+            @default_per_page = nil
+            @per_page = nil
+          end
 
-      it 'should use default per page from model' do
-        get :index_with_no_per_page, count: 100
+          get :index_with_no_per_page, params: {count: 100}
 
-        expect(response.header['Per-Page']).to eq('6')
+          expect(response.header['Per-Page']).to eq(
+            case ApiPagination.config.paginator
+            when :pagy          then Pagy::DEFAULT[:limit].to_s
+            when :kaminari      then Kaminari.config.default_per_page.to_s
+            when :will_paginate then WillPaginate.per_page.to_s
+            end
+          )
+        end
       end
+    end
 
+    context 'default per page in objects without paginator defaults' do
       it 'should not fail if model does not respond to per page' do
-        class Fixnum
-          @default_per_page = nil
-          @per_page = nil
-        end
-
-        get :index_with_no_per_page, count: 100
+        get :index_with_no_per_page, params: {count: 100}
 
         expect(response.header['Per-Page']).to eq(
           case ApiPagination.config.paginator
+          when :pagy          then Pagy::DEFAULT[:limit].to_s
           when :kaminari      then Kaminari.config.default_per_page.to_s
           when :will_paginate then WillPaginate.per_page.to_s
           end

data/spec/sequel_spec.rb

@@ -23,9 +23,8 @@ if ApiPagination.config.paginator == :will_paginate
     end
 
     it 'returns a Sequel::Dataset' do
-      collection = ApiPagination.paginate(people)
+      collection = ApiPagination.paginate(people).first
       expect(collection.kind_of?(Sequel::Dataset)).to be_truthy
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -3,14 +3,20 @@ require 'support/numbers_api'
 require 'api-pagination'
 
 if ENV['PAGINATOR'].nil?
-  warn 'No PAGINATOR set. Defaulting to kaminari. To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`'
-  ENV['PAGINATOR'] = 'kaminari'
+  warn <<-WARNING
+No PAGINATOR set. Defaulting to pagy.
+
+To test against kaminari, run `PAGINATOR=kaminari bundle exec rspec`
+To test against will_paginate, run `PAGINATOR=will_paginate bundle exec rspec`
+WARNING
+
+  ENV['PAGINATOR'] = 'pagy'
 end
 
 require ENV['PAGINATOR']
 ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
 
-require 'will_paginate/array'
+require 'will_paginate/array' if ENV['PAGINATOR'].to_sym == :will_paginate
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods

data/spec/support/active_record/foo.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+
+class Foo < ActiveRecord::Base; end

data/spec/support/active_record/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table "foos", :force => true do |t|
+    t.string   "foo"
+  end
+end

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
@@ -20,4 +20,22 @@ class NumbersAPI < Grape::API
 
     paginate (1..params[:count]).to_a
   end
+
+  desc 'Return some paginated set of numbers with max_per_page'
+  paginate :per_page => 10, :max_per_page => 25
+  params do
+    requires :count, :type => Integer
+  end
+  get :numbers_with_max_per_page  do
+    paginate (1..params[:count]).to_a
+  end
+
+  desc 'Return some paginated set of numbers with max_per_page enforced'
+  paginate :per_page => 10, :max_per_page => 25, :enforce_max_per_page => true
+  params do
+    requires :count, :type => Integer
+  end
+  get :numbers_with_enforced_max_per_page  do
+    paginate (1..params[:count]).to_a
+  end
 end

data/spec/support/numbers_controller.rb

@@ -1,4 +1,5 @@
-require 'action_controller'
+require 'action_controller/railtie'
+require 'api-pagination/hooks'
 require 'ostruct'
 
 module Rails
@@ -58,7 +59,7 @@ class NumbersSerializer
   end
 end
 
-class NumbersController < ActionController::Base
+class NumbersController < ActionController::API
   include Rails.application.routes.url_helpers
 
   def index
@@ -98,3 +99,5 @@ class NumbersController < ActionController::Base
     render json: NumbersSerializer.new(numbers)
   end
 end
+
+ApiPagination::Railtie.initializers.each(&:run)

data/spec/support/shared_examples/first_page.rb

@@ -1,10 +1,10 @@
 shared_examples 'an endpoint with a first page' do
   it 'should not give a link with rel "first"' do
-    expect(links).not_to include('rel="first"')
+    expect(link).not_to include('rel="first"')
   end
 
   it 'should not give a link with rel "prev"' do
-    expect(links).not_to include('rel="prev"')
+    expect(link).not_to include('rel="prev"')
   end
 
   it 'should give a link with rel "last"' do

data/spec/support/shared_examples/last_page.rb

@@ -1,10 +1,10 @@
 shared_examples 'an endpoint with a last page' do
   it 'should not give a link with rel "last"' do
-    expect(links).not_to include('rel="last"')
+    expect(link).not_to include('rel="last"')
   end
 
   it 'should not give a link with rel "next"' do
-    expect(links).not_to include('rel="next"')
+    expect(link).not_to include('rel="next"')
   end
 
   it 'should give a link with rel "first"' do

metadata

@@ -1,85 +1,165 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 6.0.0
 platform: ruby
 authors:
 - David Celis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 3.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 6.1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 6.1.4.1
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 6.1.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 6.1.4.1
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: '5.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.49'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description: Link header pagination for Rails and Grape APIs
 email:
 - me@davidcel.is
@@ -90,14 +170,18 @@ files:
 - lib/api-pagination.rb
 - lib/api-pagination/configuration.rb
 - lib/api-pagination/hooks.rb
+- lib/api-pagination/railtie.rb
 - lib/api-pagination/version.rb
 - lib/grape/pagination.rb
 - lib/rails/pagination.rb
+- spec/active_record_spec.rb
 - spec/api-pagination_spec.rb
 - spec/grape_spec.rb
 - spec/rails_spec.rb
 - spec/sequel_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record/foo.rb
+- spec/support/active_record/schema.rb
 - spec/support/numbers_api.rb
 - spec/support/numbers_controller.rb
 - spec/support/shared_examples/existing_headers.rb
@@ -108,32 +192,34 @@ homepage: https://github.com/davidcelis/api-pagination
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Link header pagination for Rails and Grape APIs. Don't use the request body.
 test_files:
+- spec/active_record_spec.rb
 - spec/api-pagination_spec.rb
 - spec/grape_spec.rb
 - spec/rails_spec.rb
 - spec/sequel_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record/foo.rb
+- spec/support/active_record/schema.rb
 - spec/support/numbers_api.rb
 - spec/support/numbers_controller.rb
 - spec/support/shared_examples/existing_headers.rb