api-pagination 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8bc41a88d9698b56c9329d03b153e4a26359a89
-  data.tar.gz: 5b12ab2abac9d7fa0ad8569b7c80811c35cc3d7c
+  metadata.gz: 48cb5f06eb2928aab44c8b41c50ad8ac87d8907f
+  data.tar.gz: f4f14870f987d37dfe508217a27ee9905de4137e
 SHA512:
-  metadata.gz: 04d2fe7e9d7df6f1b5bf3ca3e623594d9f01934ec8aaf98147fd759a196a5c778d4fda5946e38ab5b1164d68db0b9d641b6473b23bb90b1ed54abc068f44687a
-  data.tar.gz: 02c3c45d64667438376d0243ab3671d36f1e0f6360881c1a37398e35a25a4252a7653b0bce98cce739aefc7e228c7eb430895ba4f60be7fb1591ba4bb88b8d28
+  metadata.gz: d159ecc56ea17eeb912638cccb5db3d8d9e188ea7939fb6f4254aaa1f7912b6341ae3d78d9657ae985f6c4d0f56e47c3d40704c0403d47d629f424604cb48540
+  data.tar.gz: a87c54ba5f0bc1761efc5fdf793df7b19d60a7bef57cf41d5b778aef31ace3712aef4ebed963600211c116505ec3050f91849557998c9af8d81dc0934e6b744c

data/lib/api-pagination.rb

@@ -45,7 +45,7 @@ module ApiPagination
       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
+        options[:per_page] = get_default_per_page_for_kaminari(collection)
       end
 
       collection = Kaminari.paginate_array(collection, paginate_array_options) if collection.is_a?(Array)
@@ -53,7 +53,9 @@ module ApiPagination
     end
 
     def paginate_with_will_paginate(collection, options)
-      options[:per_page] = WillPaginate.per_page if options[:per_page] <= 0
+      if options[:per_page] <= 0
+        options[:per_page] = default_per_page_for_will_paginate(collection)
+      end
 
       if defined?(Sequel::Dataset) && collection.kind_of?(Sequel::Dataset)
         collection.paginate(options[:page], options[:per_page])
@@ -61,6 +63,24 @@ module ApiPagination
         collection.paginate(:page => options[:page], :per_page => options[:per_page])
       end
     end
+
+    def get_default_per_page_for_kaminari(collection)
+      default = Kaminari.config.default_per_page
+      detect_model(collection).default_per_page || default
+    rescue
+      default
+    end
+
+    def default_per_page_for_will_paginate(collection)
+      default = WillPaginate.per_page
+      detect_model(collection).per_page || default
+    rescue
+      default
+    end
+
+    def detect_model(collection)
+      collection.first.class
+    end
   end
 end
 

data/lib/api-pagination/configuration.rb

@@ -19,6 +19,33 @@ module ApiPagination
       @include_total   = true
     end
 
+    ['page', 'per_page'].each do |param_name|
+      method_name = "#{param_name}_param"
+      instance_variable_name = "@#{method_name}"
+
+      define_method method_name do |params = nil, &block|
+        if block.is_a?(Proc)
+          instance_variable_set(instance_variable_name, block)
+          return
+        end
+
+        if instance_variable_get(instance_variable_name).nil?
+          # use :page & :per_page by default
+          instance_variable_set(instance_variable_name, (lambda { |p| p[param_name.to_sym] }))
+        end
+
+        instance_variable_get(instance_variable_name).call(params)
+      end
+
+      define_method "#{method_name}=" do |param|
+        if param.is_a?(Symbol) || param.is_a?(String)
+          instance_variable_set(instance_variable_name, (lambda { |params| params[param] }))
+        else
+          raise ArgumentError, "Cannot set page_param option"
+        end
+      end
+    end
+
     def paginator
       @paginator || set_paginator
     end

data/lib/api-pagination/version.rb

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

data/lib/grape/pagination.rb

@@ -3,9 +3,10 @@ module Grape
     def self.included(base)
       Grape::Endpoint.class_eval do
         def paginate(collection)
-          per_page = params[:per_page] || route_setting(:per_page)
+          per_page = ApiPagination.config.per_page_param(params) || route_setting(:per_page)
+
           options = {
-            :page     => params[:page],
+            :page     => ApiPagination.config.page_param(params),
             :per_page => [per_page, route_setting(:max_per_page)].compact.min
           }
           collection = ApiPagination.paginate(collection, options)

data/lib/rails/pagination.rb

@@ -25,8 +25,11 @@ module Rails
 
     def _paginate_collection(collection, options={})
       options = {
-        :page     => params[:page],
-        :per_page => (options.delete(:per_page) || params[:per_page])
+        :page     => ApiPagination.config.page_param(params),
+        :per_page => (
+          options.delete(:per_page) ||
+          ApiPagination.config.per_page_param(params)
+        )
       }
       collection = ApiPagination.paginate(collection, options)
 

data/spec/rails_spec.rb

@@ -123,5 +123,124 @@ describe NumbersController, :type => :controller do
 
       after { ApiPagination.config.include_total = true }
     end
+
+    context 'custom page param' do
+      context 'page_param as a symbol' do
+        before do
+          ApiPagination.config.page_param = :foo
+          ApiPagination.config.page_header = 'Page'
+        end
+
+        after do
+          ApiPagination.config.page_param = :page
+          ApiPagination.config.page_header = nil
+        end
+
+        it 'should work' do
+          get :index, :foo => 2, :count => 100
+
+          expect(response.header['Page']).to eq('2')
+        end
+      end
+
+      context 'page_param as a block' do
+        before do
+          ApiPagination.config.page_param do |params|
+            params[:foo][:bar]
+          end
+
+          ApiPagination.config.page_header = 'Page'
+        end
+
+        after do
+          ApiPagination.config.page_param = :page
+          ApiPagination.config.page_header = nil
+        end
+
+        it 'should work' do
+          get :index, :foo => { :bar => 2 }, :count => 100
+
+          expect(response.header['Page']).to eq('2')
+        end
+      end
+    end
+
+    context 'custom per_page param' do
+      context 'per_page_param as a symbol' do
+        before do
+          ApiPagination.config.per_page_param = :foo
+        end
+
+        after do
+          ApiPagination.config.per_page_param = :per_page
+        end
+
+        it 'should work' do
+          get :index_with_no_per_page, :foo => 2, :count => 100
+
+          expect(response.header['Per-Page']).to eq('2')
+        end
+      end
+
+      context 'page_param as a block' do
+        before do
+          ApiPagination.config.per_page_param do |params|
+            params[:foo][:bar]
+          end
+        end
+
+        after do
+          ApiPagination.config.per_page_param = :per_page
+        end
+
+        it 'should work' do
+          get :index_with_no_per_page, :foo => { :bar => 2 }, :count => 100
+
+          expect(response.header['Per-Page']).to eq('2')
+        end
+      end
+    end
+
+    context 'default per page in model' do
+      before do
+        class Fixnum
+          @default_per_page = 6
+          @per_page = 6
+
+          class << self
+            attr_accessor :default_per_page, :per_page
+          end
+        end
+      end
+
+      after do
+        class Fixnum
+          @default_per_page = 25
+          @per_page = 25
+        end
+      end
+
+      it 'should use default per page from model' do
+        get :index_with_no_per_page, count: 100
+
+        expect(response.header['Per-Page']).to eq('6')
+      end
+
+      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
+
+        expect(response.header['Per-Page']).to eq(
+          case ApiPagination.config.paginator
+          when :kaminari      then Kaminari.config.default_per_page.to_s
+          when :will_paginate then WillPaginate.per_page.to_s
+          end
+        )
+      end
+    end
   end
 end

data/spec/support/numbers_controller.rb

@@ -41,6 +41,7 @@ end
 Rails.application.routes.draw do
   resources :numbers, :only => [:index] do
     get :index_with_custom_render, on: :collection
+    get :index_with_no_per_page,   on: :collection
   end
 end
 
@@ -76,4 +77,12 @@ class NumbersController < ActionController::Base
 
     render json: NumbersSerializer.new(numbers)
   end
+
+  def index_with_no_per_page
+    total   = params.fetch(:count).to_i
+    numbers = (1..total).to_a
+    numbers = paginate numbers
+
+    render json: NumbersSerializer.new(numbers)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec