api_pagination_headers 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ea795c955eb559b1674f3e3512dde05644be6b4
-  data.tar.gz: e858bfccf5f408d91364daf0c09863ee6d6e0426
+  metadata.gz: 18140f8cc85e119d447bed481450005ae984883a
+  data.tar.gz: df38764d04880176f3b71e21b388725d0a2587da
 SHA512:
-  metadata.gz: 8be7d78b0599c5d67a1bb821916e8aeec24ef75cc3879848a6019773ab0c43e35620b4685d5aca40c3d3102a0b42032834eac3cb02463dccdc4d258f85425918
-  data.tar.gz: 32bcd099e63d6d79fd378c0040f3a57b74ef83db8a513e907f8b0fb8cb5fe5fe1b9b170bf6cdaa936999ca7dc254eae0e204b82124e497cf9176818c517915b0
+  metadata.gz: 207a5bbda68f0525df3a006f728285317b40b4a23a4d8a6cf18a179b5245131a646791532fc2e0d3da643aa7e4512ac9533401a8b18ae07458e638278c9c8db7
+  data.tar.gz: bcec9e9f6a401184c3b4b2d8d48fcdd8f8ddfc10137257b4f5fd04a272bed91a5bdc0c8ca8ea66e29d2ad0363b512e13ae45ef0f809251a1027d0299c0394bc6

data/.travis.yml

@@ -2,7 +2,7 @@ language:
   - ruby
 install:
   - 'bundle install'
-  - 'cd spec/dummy;rake db:test:prepare;cd ../../'
+  - 'cd spec/dummy;rake db:drop;rake db:create;rake db:schema:load;rake db:test:prepare;cd ../../'
 rvm:
   - 1.9.3
   - 2.0.0

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    api_pagination_headers (1.1.2)
+    api_pagination_headers (2.0.0)
       rails (~> 4.0)
-      will_paginate (~> 3.0.5)
 
 GEM
   remote: https://rubygems.org/
@@ -43,13 +42,16 @@ GEM
       railties (>= 3.0.0)
     hike (1.2.3)
     i18n (0.6.9)
+    kaminari (0.16.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     minitest (4.7.5)
     multi_json (1.9.2)
-    polyglot (0.3.4)
+    polyglot (0.3.5)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -79,7 +81,7 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    sprockets (2.12.0)
+    sprockets (2.12.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
@@ -104,5 +106,7 @@ PLATFORMS
 DEPENDENCIES
   api_pagination_headers!
   factory_girl_rails
+  kaminari
   rspec-rails
   sqlite3
+  will_paginate

data/README.md

@@ -1,29 +1,39 @@
 #api_pagination_headers [![Build Status](https://travis-ci.org/richardkall/api_pagination_headers.svg)](http://travis-ci.org/richardkall/api_pagination_headers) [![Dependency Status](https://gemnasium.com/richardkall/api_pagination_headers.png)](https://gemnasium.com/richardkall/api_pagination_headers)
 
-api_pagination_headers is a gem that adds pagination info to a `Link` response header. This is considered to be the [best practice](http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#pagination) for REST APIs and is currently used by [GitHub](http://developer.github.com/v3/#pagination). It also adds the total number of records into a `X-Total-Count` header.
+api_pagination_headers is a gem that adds pagination info to a `Link` response header. This is considered to be the [best practice](http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#pagination) for REST APIs and is currently used by [GitHub](http://developer.github.com/v3/#pagination). It also adds the total number of records into a `Total-Count` header.
 
 Example:
 
 ```
 Link: <http://example.com/posts?page=2&per_page=10>; rel="next", <http://example.com/posts?page=2&per_page=10>; rel="last"
-X-Total-Count: 11
+Total-Count: 11
 ```
 
 ##Installation
 
 Include in your Gemfile:
 
-```
+* Rails 4
+
+```ruby
 gem 'api_pagination_headers'
 ```
 
-Depending on [will_paginate](https://github.com/mislav/will_paginate) at the moment. Support for [rails-api](https://github.com/rails-api/rails-api) is built in.
+* Rails 3.2
+
+```ruby
+gem 'api_pagination_headers', branch: 'rails-3-2'
+```
+
+Depending on [Kaminari](https://github.com/amatsuda/kaminari) or [will_paginate](https://github.com/mislav/will_paginate) at the moment. Support for [rails-api](https://github.com/rails-api/rails-api) is built in.
 
 ##Usage
 
 In the controller:
 
-```
+* Rails 4
+
+```ruby
 class PostsController < ApplicationController
   after_action only: [:index] { set_pagination_headers(:posts) }
 
@@ -34,5 +44,28 @@ class PostsController < ApplicationController
 end
 ```
 
+* Rails 3.2
+
+```ruby
+class PostsController < ApplicationController
+  after_filter only: [:index] { set_pagination_headers(:posts) }
+
+  def index
+    @posts = Post.paginate(per_page: params[:per_page], page: params[:page])
+    respond_with @posts
+  end
+end
+```
+
+##Configuration
+
+You can change the `Total-Count` header title by configuring the gem.
+
+```ruby
+ApiPaginationHeaders.configure do |config|
+  config.total_count_header = 'X-Total-Count'
+end
+```
+
 ##License
 Copyright © 2014 [Richard Käll](http://richardkall.se). Licensed under the MIT license.

data/api_pagination_headers.gemspec

@@ -16,9 +16,10 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files -- {spec}/*`.split("\n")
 
   s.add_dependency 'rails', '~> 4.0'
-  s.add_dependency 'will_paginate', '~> 3.0.5'
 
   s.add_development_dependency 'factory_girl_rails'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'kaminari'
+  s.add_development_dependency 'will_paginate'
 end

data/lib/api_pagination_headers.rb

@@ -1,3 +1,8 @@
+require 'active_support/configurable'
+
+require 'api_pagination_headers/version'
+require 'api_pagination_headers/config'
+
 module ApiPaginationHeaders
   protected
 
@@ -7,14 +12,20 @@ module ApiPaginationHeaders
     links = create_links(pages, scope)
 
     headers['Link'] = links.join(', ') unless links.empty?
-    headers['X-Total-Count'] = "#{scope.total_entries}"
+    headers[ApiPaginationHeaders.config.total_count_header] = defined?(Kaminari) ? "#{scope.total_count}" : "#{scope.total_entries}"
   end
 
   private
 
   def create_links(pages, scope)
     url_without_params = request.url.split('?').first
-    per_page = params[:per_page] ? params[:per_page].to_i : scope.per_page
+
+    if params[:per_page]
+      per_page = params[:per_page].to_i
+    else
+      per_page = defined?(Kaminari) ? scope.default_per_page : scope.per_page
+    end
+
     links = []
     pages.each do |key, value|
       new_params = request.query_parameters.merge({ page: value, per_page: per_page })

data/lib/api_pagination_headers/config.rb

@@ -0,0 +1,24 @@
+require 'active_support/configurable'
+
+module ApiPaginationHeaders
+  # Configures global settings for ApiPaginationHeaders
+  #   ApiPaginationHeaders.configure do |config|
+  #     config.total_count_header = 'X-Total-Count'
+  #   end
+  def self.configure(&block)
+    yield @config ||= ApiPaginationHeaders::Configuration.new
+  end
+
+  # Global settings for ApiPaginationHeaders
+  def self.config
+    @config ||= ApiPaginationHeaders::Configuration.new
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+
+    TOTAL_COUNT_HEADER = 'Total-Count'
+
+    config_accessor(:total_count_header)  { TOTAL_COUNT_HEADER }
+  end
+end

data/lib/api_pagination_headers/version.rb

@@ -1,3 +1,3 @@
 module ApiPaginationHeaders
-  VERSION = '1.1.2'
+  VERSION = '2.0.0'
 end

data/spec/controllers/posts_controller_spec.rb

@@ -9,9 +9,9 @@ describe PostsController, '#index' do
       expect(response.headers).not_to include('Link')
     end
 
-    it 'responds with X-Total-Count header' do
+    it 'responds with Total-Count header' do
       get :index, format: :json
-      expect(response.headers['X-Total-Count']).to eq('1')
+      expect(response.headers['Total-Count']).to eq('1')
     end
   end
 
@@ -24,9 +24,9 @@ describe PostsController, '#index' do
         expect(response.headers['Link']).to eq("<#{posts_url(page: 2, per_page: 1, format: :json)}>; rel=\"next\", <#{posts_url(page: 2, per_page: 1, format: :json)}>; rel=\"last\"")
       end
 
-      it 'responds with X-Total-Count header' do
+      it 'responds with Total-Count header' do
         get :index, format: :json
-        expect(response.headers['X-Total-Count']).to eq('2')
+        expect(response.headers['Total-Count']).to eq('2')
       end
     end
 
@@ -36,9 +36,9 @@ describe PostsController, '#index' do
         expect(response.headers['Link']).to eq("<#{posts_url(page: 1, per_page: 1, format: :json)}>; rel=\"first\", <#{posts_url(page: 1, per_page: 1, format: :json)}>; rel=\"prev\"")
       end
 
-      it 'responds with X-Total-Count header' do
+      it 'responds with Total-Count header' do
         get :index, format: :json
-        expect(response.headers['X-Total-Count']).to eq('2')
+        expect(response.headers['Total-Count']).to eq('2')
       end
     end
   end
@@ -52,9 +52,9 @@ describe PostsController, '#index' do
         expect(response.headers['Link']).to eq("<#{posts_url(page: 2, per_page: 1, format: :json)}>; rel=\"next\", <#{posts_url(page: 3, per_page: 1, format: :json)}>; rel=\"last\"")
       end
 
-      it 'responds with X-Total-Count header' do
+      it 'responds with Total-Count header' do
         get :index, format: :json
-        expect(response.headers['X-Total-Count']).to eq('3')
+        expect(response.headers['Total-Count']).to eq('3')
       end
     end
 
@@ -64,9 +64,9 @@ describe PostsController, '#index' do
         expect(response.headers['Link']).to eq("<#{posts_url(page: 1, per_page: 1, format: :json)}>; rel=\"first\", <#{posts_url(page: 1, per_page: 1, format: :json)}>; rel=\"prev\", <#{posts_url(page: 3, per_page: 1, format: :json)}>; rel=\"next\", <#{posts_url(page: 3, per_page: 1, format: :json)}>; rel=\"last\"")
       end
 
-      it 'responds with X-Total-Count header' do
+      it 'responds with Total-Count header' do
         get :index, format: :json
-        expect(response.headers['X-Total-Count']).to eq('3')
+        expect(response.headers['Total-Count']).to eq('3')
       end
     end
 
@@ -76,9 +76,9 @@ describe PostsController, '#index' do
         expect(response.headers['Link']).to eq("<#{posts_url(page: 1, per_page: 1, format: :json)}>; rel=\"first\", <#{posts_url(page: 2, per_page: 1, format: :json)}>; rel=\"prev\"")
       end
 
-      it 'responds with X-Total-Count header' do
+      it 'responds with Total-Count header' do
         get :index, format: :json
-        expect(response.headers['X-Total-Count']).to eq('3')
+        expect(response.headers['Total-Count']).to eq('3')
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_pagination_headers
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Richard Käll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: will_paginate
+  name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.5
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,6 +110,7 @@ files:
 - Rakefile
 - api_pagination_headers.gemspec
 - lib/api_pagination_headers.rb
+- lib/api_pagination_headers/config.rb
 - lib/api_pagination_headers/version.rb
 - spec/controllers/comments_controller_spec.rb
 - spec/controllers/posts_controller_spec.rb
@@ -144,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Link header pagination for APIs