api-pagination 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5be5003544e0eb53e5149d0ce0e1062f081834a
-  data.tar.gz: b3df8c7d6d0fd12721c32283a27c1f5c05b40ab6
+  metadata.gz: e8bc41a88d9698b56c9329d03b153e4a26359a89
+  data.tar.gz: 5b12ab2abac9d7fa0ad8569b7c80811c35cc3d7c
 SHA512:
-  metadata.gz: 2a1b6e4a3cac799cfc8da269937defa9e309001502e156a66b571eaa465f67fd1681ab443c43eeac1c63d1ee39c03e8c77561136e9295da58f31dafa4b04c119
-  data.tar.gz: ed859205ed82ea72ac784e658ad25d5c92d55d0d47a5a34e745f0903b9ddb3708dff75117f2b46bc13b6f598ffb32b0124aaec989e025b33433048a2133933be
+  metadata.gz: 04d2fe7e9d7df6f1b5bf3ca3e623594d9f01934ec8aaf98147fd759a196a5c778d4fda5946e38ab5b1164d68db0b9d641b6473b23bb90b1ed54abc068f44687a
+  data.tar.gz: 02c3c45d64667438376d0243ab3671d36f1e0f6360881c1a37398e35a25a4252a7653b0bce98cce739aefc7e228c7eb430895ba4f60be7fb1591ba4bb88b8d28

data/lib/api-pagination.rb

@@ -10,7 +10,7 @@ module ApiPagination
 
       case ApiPagination.config.paginator
       when :kaminari
-        paginate_with_kaminari(collection, options)
+        paginate_with_kaminari(collection, options, options[:paginate_array_options] || {})
       when :will_paginate
         paginate_with_will_paginate(collection, options)
       else
@@ -39,31 +39,16 @@ module ApiPagination
       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)
+    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
       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 = Kaminari.paginate_array(collection, paginate_array_options) if collection.is_a?(Array)
       collection.page(options[:page]).per(options[:per_page])
     end
 

data/lib/api-pagination/configuration.rb

@@ -4,6 +4,10 @@ module ApiPagination
 
     attr_accessor :per_page_header
 
+    attr_accessor :page_header
+
+    attr_accessor :include_total
+
     def configure(&block)
       yield self
     end
@@ -11,6 +15,8 @@ module ApiPagination
     def initialize
       @total_header    = 'Total'
       @per_page_header = 'Per-Page'
+      @page_header     = nil
+      @include_total   = true
     end
 
     def paginator

data/lib/api-pagination/version.rb

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

data/lib/grape/pagination.rb

@@ -15,17 +15,20 @@ module Grape
           pages = ApiPagination.pages_from(collection)
 
           pages.each do |k, v|
-            old_params = Rack::Utils.parse_query(request.query_string)
+            old_params = Rack::Utils.parse_nested_query(request.query_string)
             new_params = old_params.merge('page' => v)
             links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
           end
 
           total_header    = ApiPagination.config.total_header
           per_page_header = ApiPagination.config.per_page_header
+          page_header     = ApiPagination.config.page_header
+          include_total   = ApiPagination.config.include_total
 
           header 'Link',          links.join(', ') unless links.empty?
-          header total_header,    ApiPagination.total_from(collection)
+          header total_header,    ApiPagination.total_from(collection) if include_total
           header per_page_header, options[:per_page].to_s
+          header page_header,     options[:page].to_s unless page_header.nil?
 
           return collection
         end
@@ -33,7 +36,7 @@ module Grape
 
       base.class_eval do
         def self.paginate(options = {})
-          route_setting :per_page, (options[:per_page] || 25)
+          route_setting :per_page, options[:per_page]
           route_setting :max_per_page, options[:max_per_page]
           params do
             optional :page,     :type => Integer, :default => 1,

data/lib/rails/pagination.rb

@@ -41,10 +41,13 @@ module Rails
 
       total_header    = ApiPagination.config.total_header
       per_page_header = ApiPagination.config.per_page_header
+      page_header     = ApiPagination.config.page_header
+      include_total   = ApiPagination.config.include_total
 
       headers['Link']          = links.join(', ') unless links.empty?
-      headers[total_header]    = ApiPagination.total_from(collection)
+      headers[total_header]    = ApiPagination.total_from(collection) if include_total
       headers[per_page_header] = options[:per_page].to_s
+      headers[page_header]     = options[:page].to_s unless page_header.nil?
 
       return collection
     end

data/spec/api-pagination_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ApiPagination do
+  let(:collection) { (1..100).to_a }
+  let(:paginate_array_options) { { total_count: 1000 } }
+
+  context 'Using kaminari' do
+    before do
+      ApiPagination.config.paginator = :kaminari
+    end
+
+    after do
+      ApiPagination.config.paginator = ENV['PAGINATOR'].to_sym
+    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
+        }
+      )
+    end
+  end
+end

data/spec/grape_spec.rb

@@ -71,6 +71,7 @@ describe NumbersAPI do
       before do
         ApiPagination.config.total_header    = 'X-Total-Count'
         ApiPagination.config.per_page_header = 'X-Per-Page'
+        ApiPagination.config.page_header     = 'X-Page'
 
         get '/numbers', count: 10
       end
@@ -78,10 +79,12 @@ describe NumbersAPI do
       after do
         ApiPagination.config.total_header    = 'Total'
         ApiPagination.config.per_page_header = 'Per-Page'
+        ApiPagination.config.page_header     = nil
       end
 
       let(:total) { last_response.header['X-Total-Count'].to_i }
       let(:per_page) { last_response.header['X-Per-Page'].to_i }
+      let(:page) { last_response.header['X-Page'].to_i }
 
       it 'should give a X-Total-Count header' do
         headers_keys = last_response.headers.keys
@@ -98,6 +101,36 @@ describe NumbersAPI do
         expect(headers_keys).to include('X-Per-Page')
         expect(per_page).to eq(10)
       end
+
+      it 'should give a X-Page header' do
+        headers_keys = last_response.headers.keys
+
+        expect(headers_keys).to include('X-Page')
+        expect(page).to eq(1)
+      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 '/numbers', count: 10
+
+        expect(last_response.header['Total']).to be_nil
+      end
+
+      after { ApiPagination.config.include_total = true }
+    end
+
+    context 'with query string including array parameter' do
+      before do
+        get '/numbers', { count: 100, parity: ['odd', 'even']}
+      end
+
+      it 'returns links with with same received parameters' do
+        expect(links).to include('<http://example.org/numbers?count=100&page=10&parity%5B%5D=odd&parity%5B%5D=even>; rel="last"')
+        expect(links).to include('<http://example.org/numbers?count=100&page=2&parity%5B%5D=odd&parity%5B%5D=even>; rel="next"')
+      end
     end
   end
 end

data/spec/rails_spec.rb

@@ -73,6 +73,7 @@ describe NumbersController, :type => :controller do
       before do
         ApiPagination.config.total_header    = 'X-Total-Count'
         ApiPagination.config.per_page_header = 'X-Per-Page'
+        ApiPagination.config.page_header     = 'X-Page'
 
         get :index, count: 10
       end
@@ -80,10 +81,12 @@ describe NumbersController, :type => :controller do
       after do
         ApiPagination.config.total_header    = 'Total'
         ApiPagination.config.per_page_header = 'Per-Page'
+        ApiPagination.config.page_header     = nil
       end
 
       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 }
 
       it 'should give a X-Total-Count header' do
         headers_keys = response.headers.keys
@@ -100,6 +103,25 @@ describe NumbersController, :type => :controller do
         expect(headers_keys).to include('X-Per-Page')
         expect(per_page).to eq(10)
       end
+
+      it 'should give a X-Page header' do
+        headers_keys = response.headers.keys
+
+        expect(headers_keys).to include('X-Page')
+        expect(page).to eq(1)
+      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
+
+        expect(response.header['Total']).to be_nil
+      end
+
+      after { ApiPagination.config.include_total = true }
     end
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: api-pagination
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2016-01-01 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,12 +87,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/api-pagination.rb
 - lib/api-pagination/configuration.rb
 - lib/api-pagination/hooks.rb
 - lib/api-pagination/version.rb
-- lib/api-pagination.rb
 - lib/grape/pagination.rb
 - lib/rails/pagination.rb
+- spec/api-pagination_spec.rb
 - spec/grape_spec.rb
 - spec/rails_spec.rb
 - spec/sequel_spec.rb
@@ -113,21 +114,22 @@ 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.5.1
 signing_key: 
 specification_version: 4
 summary: Link header pagination for Rails and Grape APIs. Don't use the request body.
 test_files:
+- spec/api-pagination_spec.rb
 - spec/grape_spec.rb
 - spec/rails_spec.rb
 - spec/sequel_spec.rb
@@ -138,3 +140,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: