api-pagination 4.7.0 → 4.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc970990a6d83c6df9816d8deb22656f16f227c0c125e4824a102b49b3df25a8
-  data.tar.gz: 692ec9b45e7e26140541de25bed1b4a4be625b675967d4155cef94f6ae637dd0
+  metadata.gz: f4cf55ba5db9b488ae0e9e16e9d14b839a8ada930697c39c00d1192f7cfc5456
+  data.tar.gz: a79c32b444ab9b6b84d3f5bbf6312feb46a031ae5ee8b930b3dd553456b207d2
 SHA512:
-  metadata.gz: a421c4df55bcaec8e6f42b76a4e719b83a2d10c9727b9dcd143f4a90072bc46062fea5313b18e10e57b7691b2d3853c72096a0ee2f41f999f77981ad1e798122
-  data.tar.gz: 9a54546062c9a98e2d5f602cc3145b50f2fe20dbbe7be623e42d22ae1c07e200ea257d6da82fe992af1ef48c98331a308304456dcb5dc86b96eb69f29a3ec91a
+  metadata.gz: 6208062d94a1f57d62be3cbf2cd552d6fe86a2af30ae3dde1d2efe1f3ff2c629215ec69aa6c5fd04452ce99be6e79c9395af76a0821e5f4fb039d44c470b8d44
+  data.tar.gz: c91fa40ad83fade4d1d76f0977828b7263d07b6d5d3b1b47e76a65f9fb3bd8530ed143548b6b89e8ba1b1f73b0a04a3498cd0bfb0e3f4541a379aad4e4b5ac38

data/lib/api-pagination/version.rb

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

data/lib/grape/pagination.rb

@@ -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,
+                                :desc   => 'Number of results to return per page.',
+                                :values => per_page_values
           end
         end
       end

data/spec/grape_spec.rb

@@ -56,15 +56,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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.7.1
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Link header pagination for Rails and Grape APIs. Don't use the request body.