api_pagination_headers 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71e7a44f98f5f3f27c7f0631163945f1865fdcc8
-  data.tar.gz: 3149cda9b4c6c12493b9a3f03c0ae2a545964d41
+  metadata.gz: bbc1bb209392610ed0cbdb2e6c8f1acad4c345ea
+  data.tar.gz: 12da3da8f08069065e7d2b9c65049c0790926870
 SHA512:
-  metadata.gz: ee1d49d47f3ea87e6ccebfb0db2742a67530a10b55de1e7625dda439cf2ce53bb5a560ef0528a1ad89792faf27aa6ce9c0ff7a2517a630de5fabb2ba51d1120d
-  data.tar.gz: 1c0a1ff5fdd4fbe9686190c0b84588e194ea1164a2f2907e4727e4dd4ceda79811f025f35fd5e8e661ac2a3f38208bc182fe8569a575aa7dfe7d82cc14e9de6c
+  metadata.gz: 63023f56aa083ff91a158a1de00fe3e9585a002abbb42f755aba164334ff0ede0dd2f3cac9954cd4772fcc10379b599c3e6fe9c2addca3b6788b52fa14bebf7b
+  data.tar.gz: f17ec0aec0d372f9b125a889b9b06ce341db288f6face91980bfe150a865d5d2d32a57d8f665c52c284a405664f8c8f98bf8c6ac438e5b9db1884d986c55b014

data/Gemfile.lock

@@ -1,39 +1,48 @@
 PATH
   remote: .
   specs:
-    api_pagination_headers (2.0.0)
-      rails (~> 4.1)
+    api_pagination_headers (2.1.0)
+      rails (>= 4.1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.1.6)
-      actionpack (= 4.1.6)
-      actionview (= 4.1.6)
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
       mail (~> 2.5, >= 2.5.4)
-    actionpack (4.1.6)
-      actionview (= 4.1.6)
-      activesupport (= 4.1.6)
-      rack (~> 1.5.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
       rack-test (~> 0.6.2)
-    actionview (4.1.6)
-      activesupport (= 4.1.6)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activemodel (4.1.6)
-      activesupport (= 4.1.6)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
       builder (~> 3.1)
-    activerecord (4.1.6)
-      activemodel (= 4.1.6)
-      activesupport (= 4.1.6)
-      arel (~> 5.0.0)
-    activesupport (4.1.6)
-      i18n (~> 0.6, >= 0.6.9)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    arel (5.0.1.20140414130214)
+    arel (6.0.0)
     builder (3.2.2)
     diff-lcs (1.2.5)
     erubis (2.7.0)
@@ -42,65 +51,76 @@ GEM
     factory_girl_rails (4.5.0)
       factory_girl (~> 4.5.0)
       railties (>= 3.0.0)
-    hike (1.2.3)
-    i18n (0.6.11)
-    json (1.8.1)
-    kaminari (0.16.1)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    kaminari (0.16.3)
       actionpack (>= 3.0.0)
       activesupport (>= 3.0.0)
-    mail (2.6.1)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
       mime-types (>= 1.16, < 3)
     mime-types (2.4.3)
-    minitest (5.4.2)
-    multi_json (1.10.1)
-    rack (1.5.2)
-    rack-test (0.6.2)
+    mini_portile (0.6.2)
+    minitest (5.6.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.1.6)
-      actionmailer (= 4.1.6)
-      actionpack (= 4.1.6)
-      actionview (= 4.1.6)
-      activemodel (= 4.1.6)
-      activerecord (= 4.1.6)
-      activesupport (= 4.1.6)
+    rails (4.2.1)
+      actionmailer (= 4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      activemodel (= 4.2.1)
+      activerecord (= 4.2.1)
+      activesupport (= 4.2.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.1.6)
-      sprockets-rails (~> 2.0)
-    railties (4.1.6)
-      actionpack (= 4.1.6)
-      activesupport (= 4.1.6)
+      railties (= 4.2.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.3.2)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rake (10.4.2)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-rails (3.1.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    sprockets (2.12.2)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.1)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    sprockets (3.0.1)
       rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.2.0)
+    sprockets-rails (2.2.4)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.9)
+    sqlite3 (1.3.10)
     thor (0.19.1)
-    thread_safe (0.3.4)
-    tilt (1.4.1)
+    thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     will_paginate (3.0.7)

data/LICENSE

@@ -1,20 +1,21 @@
-Copyright 2014 Richard Käll
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) Richard Käll <richard.kall@me.com> (richardkall.se)
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.ITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,37 +1,31 @@
-#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 [![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.svg)](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 `Total-Count` header.
+> Adds pagination info to a `Link` response header.
 
-Example:
+This technique is considered to be a [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). The gem also adds the total number of records into a `Total-Count` header.
+
+Support for [rails-api](https://github.com/rails-api/rails-api) is built in.
+
+**Example**
 
 ```
 Link: <http://example.com/posts?page=2&per_page=10>; rel="next", <http://example.com/posts?page=2&per_page=10>; rel="last"
 Total-Count: 11
 ```
 
-##Installation
-
-Include in your Gemfile:
+## Requirements
 
-* Rails 4
+- [Kaminari](https://github.com/amatsuda/kaminari) or [will_paginate](https://github.com/mislav/will_paginate)
 
-```ruby
-gem 'api_pagination_headers'
-```
+## Install
 
-* Rails 3.2
+Include in your Gemfile:
 
 ```ruby
-gem 'api_pagination_headers', branch: 'rails-3-2'
+gem 'api_pagination_headers'
 ```
 
-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
+## Usage
 
 ```ruby
 class PostsController < ApplicationController
@@ -44,28 +38,18 @@ 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.
+## Config
 
 ```ruby
 ApiPaginationHeaders.configure do |config|
+  # Change total count header title (default: 'Total-Count')
   config.total_count_header = 'X-Total-Count'
+  
+  # Force HTTPS (default: false)
+  config.force_https = true
 end
 ```
 
-##License
-Copyright © 2014 [Richard Käll](http://richardkall.se). Licensed under the MIT license.
+## License
+
+MIT © [Richard Käll](http://richardkall.se)

data/api_pagination_headers.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split($/)
   s.test_files  = `git ls-files -- {spec}/*`.split("\n")
 
-  s.add_dependency 'rails', '~> 4.1'
+  s.add_dependency 'rails', '>= 4.1.8'
 
   s.add_development_dependency 'factory_girl_rails'
   s.add_development_dependency 'sqlite3'

data/lib/api_pagination_headers.rb

@@ -19,6 +19,9 @@ module ApiPaginationHeaders
 
   def create_links(pages, scope)
     url_without_params = request.url.split('?').first
+    if ApiPaginationHeaders.config.force_https
+      url_without_params.sub! 'http://', 'https://'
+    end
 
     if params[:per_page]
       per_page = params[:per_page].to_i

data/lib/api_pagination_headers/config.rb

@@ -20,5 +20,6 @@ module ApiPaginationHeaders
     TOTAL_COUNT_HEADER = 'Total-Count'
 
     config_accessor(:total_count_header)  { TOTAL_COUNT_HEADER }
+    config_accessor(:force_https)  { false }
   end
 end

data/lib/api_pagination_headers/version.rb

@@ -1,3 +1,3 @@
 module ApiPaginationHeaders
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/spec/controllers/posts_controller_spec.rb

@@ -98,4 +98,16 @@ describe PostsController, '#index', type: :controller do
       expect(response.headers['Link']).to eq("<#{posts_url(page: 2, per_page: 1, order: 'asc', format: :json)}>; rel=\"next\", <#{posts_url(page: 2, per_page: 1, order: 'asc', format: :json)}>; rel=\"last\"")
     end
   end
+
+  context 'when config has force_https set to true' do
+    it 'replaces http:// with https:// in Link header' do
+      ApiPaginationHeaders.config.force_https = true
+      FactoryGirl.create_list(:post, 2)
+      get :index, order: 'asc', format: :json
+      expect(response.headers['Link']).to match 'https://'
+      expect(response.headers['Link']).not_to match 'http://'
+      ApiPaginationHeaders.config.force_https = false
+    end
+  end
+
 end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,2 @@
 class ApplicationController < ActionController::Base
-  respond_to :json
 end

data/spec/dummy/app/controllers/comments_controller.rb

@@ -3,6 +3,6 @@ class CommentsController < ApplicationController
 
   def index
     @comments = Comment.all.paginate(per_page: params[:per_page], page: params[:page])
-    respond_with @comments
+    render json: @comments
   end
 end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -3,6 +3,6 @@ class PostsController < ApplicationController
 
   def index
     @posts = Post.all.paginate(per_page: params[:per_page], page: params[:page])
-    respond_with @posts
+    render json: @posts
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: api_pagination_headers
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Richard Käll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2015-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.1.8
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Link header pagination for APIs