api_pagination_headers 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 374afc4499dc9a5ee0ccb5e5bddcca51cfbd053b
-  data.tar.gz: 206cc6c5517388e2fbed65c2757ae94a0a03a81f
+  metadata.gz: 7ea795c955eb559b1674f3e3512dde05644be6b4
+  data.tar.gz: e858bfccf5f408d91364daf0c09863ee6d6e0426
 SHA512:
-  metadata.gz: d51b26e2bd2d30c3f5a6256bd3410111df837700707a0a03405441e0edeaaf6b5febfa544be00cbafe7b3b355bbb7f05d7418eff43ecbcf98b2a07ba483e9ab9
-  data.tar.gz: 6bec58a194f0638ef434621da26aecd7852b33a6e38b71d0cd64f7a9a70a62ef30680eb247908fc37ce6404559e59dc382eb8dabd9812359da9e5ed08a2143c1
+  metadata.gz: 8be7d78b0599c5d67a1bb821916e8aeec24ef75cc3879848a6019773ab0c43e35620b4685d5aca40c3d3102a0b42032834eac3cb02463dccdc4d258f85425918
+  data.tar.gz: 32bcd099e63d6d79fd378c0040f3a57b74ef83db8a513e907f8b0fb8cb5fe5fe1b9b170bf6cdaa936999ca7dc254eae0e204b82124e497cf9176818c517915b0

data/Gemfile.lock

@@ -1,102 +1,101 @@
 PATH
   remote: .
   specs:
-    api_pagination_headers (1.1.0)
-      rails (~> 4.0.0)
+    api_pagination_headers (1.1.2)
+      rails (~> 4.0)
       will_paginate (~> 3.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.0.0)
-      actionpack (= 4.0.0)
-      mail (~> 2.5.3)
-    actionpack (4.0.0)
-      activesupport (= 4.0.0)
+    actionmailer (4.0.4)
+      actionpack (= 4.0.4)
+      mail (~> 2.5.4)
+    actionpack (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.0)
-      activesupport (= 4.0.0)
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
       builder (~> 3.1.0)
-    activerecord (4.0.0)
-      activemodel (= 4.0.0)
+    activerecord (4.0.4)
+      activemodel (= 4.0.4)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.0)
+      activesupport (= 4.0.4)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    arel (4.0.0)
-    atomic (1.1.14)
+    arel (4.0.2)
     builder (3.1.4)
-    diff-lcs (1.2.4)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
-    factory_girl (4.2.0)
+    factory_girl (4.4.0)
       activesupport (>= 3.0.0)
-    factory_girl_rails (4.2.1)
-      factory_girl (~> 4.2.0)
+    factory_girl_rails (4.4.1)
+      factory_girl (~> 4.4.0)
       railties (>= 3.0.0)
     hike (1.2.3)
-    i18n (0.6.5)
+    i18n (0.6.9)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.25)
+    mime-types (1.25.1)
     minitest (4.7.5)
-    multi_json (1.8.0)
-    polyglot (0.3.3)
+    multi_json (1.9.2)
+    polyglot (0.3.4)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (4.0.0)
-      actionmailer (= 4.0.0)
-      actionpack (= 4.0.0)
-      activerecord (= 4.0.0)
-      activesupport (= 4.0.0)
+    rails (4.0.4)
+      actionmailer (= 4.0.4)
+      actionpack (= 4.0.4)
+      activerecord (= 4.0.4)
+      activesupport (= 4.0.4)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.0.0)
+      railties (= 4.0.4)
       sprockets-rails (~> 2.0.0)
-    railties (4.0.0)
-      actionpack (= 4.0.0)
-      activesupport (= 4.0.0)
+    railties (4.0.4)
+      actionpack (= 4.0.4)
+      activesupport (= 4.0.4)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.1.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
+    rake (10.2.2)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    rspec-rails (2.14.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.2)
       actionpack (>= 3.0)
+      activemodel (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    sprockets (2.10.0)
+    sprockets (2.12.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.0.0)
+    sprockets-rails (2.0.1)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (~> 2.8)
-    sqlite3 (1.3.8)
-    thor (0.18.1)
-    thread_safe (0.1.3)
-      atomic
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.2)
     tilt (1.4.1)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
+    tzinfo (0.3.39)
     will_paginate (3.0.5)
 
 PLATFORMS

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 Richard Käll
+Copyright 2014 Richard Käll
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,4 @@
-#api_pagination_headers
-[![Build Status](https://travis-ci.org/richardkall/api_pagination_headers.png)](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) [![Code Climate](https://codeclimate.com/github/richardkall/api_pagination_headers.png)](https://codeclimate.com/github/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.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.
 
@@ -18,9 +17,7 @@ Include in your Gemfile:
 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.
+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.
 
 ##Usage
 
@@ -37,13 +34,5 @@ class PostsController < ApplicationController
 end
 ```
 
-##Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
 ##License
-Copyright © 2013 [Richard Käll](http://richardkall.se). Licensed under the MIT license.
+Copyright © 2014 [Richard Käll](http://richardkall.se). Licensed under the MIT license.

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.0.0'
+  s.add_dependency 'rails', '~> 4.0'
   s.add_dependency 'will_paginate', '~> 3.0.5'
 
   s.add_development_dependency 'factory_girl_rails'

data/lib/api_pagination_headers.rb

@@ -4,7 +4,7 @@ module ApiPaginationHeaders
   def set_pagination_headers(name)
     scope = instance_variable_get("@#{name}")
     pages = set_page_numbers(scope)
-    links = create_links(pages)
+    links = create_links(pages, scope)
 
     headers['Link'] = links.join(', ') unless links.empty?
     headers['X-Total-Count'] = "#{scope.total_entries}"
@@ -12,9 +12,9 @@ module ApiPaginationHeaders
 
   private
 
-  def create_links(pages)
+  def create_links(pages, scope)
     url_without_params = request.url.split('?').first
-    per_page = params[:per_page] ? params[:per_page].to_i : WillPaginate.per_page
+    per_page = params[:per_page] ? params[:per_page].to_i : scope.per_page
     links = []
     pages.each do |key, value|
       new_params = request.query_parameters.merge({ page: value, per_page: per_page })

data/lib/api_pagination_headers/version.rb

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

data/spec/controllers/comments_controller_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe CommentsController, '#index' do
+  context 'when model has per_page attribute' do
+    it 'overrides WillPaginate default' do
+      FactoryGirl.create_list(:comment, 4)
+      get :index, format: :json
+      expect(response.headers['Link']).to eq("<#{comments_url(page: 2, per_page: 2, format: :json)}>; rel=\"next\", <#{comments_url(page: 2, per_page: 2, format: :json)}>; rel=\"last\"")
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+class CommentsController < ApplicationController
+  after_action only: [:index] { set_pagination_headers(:comments) }
+
+  def index
+    @comments = Comment.all.paginate(per_page: params[:per_page], page: params[:page])
+    respond_with @comments
+  end
+end

data/spec/dummy/app/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  self.per_page = 2
+end

data/spec/dummy/config/routes.rb

@@ -1,3 +1,4 @@
 Dummy::Application.routes.draw do
   resources :posts
+  resources :comments
 end

data/spec/dummy/db/migrate/20140406141645_create_comments.rb

@@ -0,0 +1,7 @@
+class CreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.string :content
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,10 +11,14 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20131001123917) do
+ActiveRecord::Schema.define(version: 20140406141645) do
+
+  create_table "comments", force: true do |t|
+    t.string "content"
+  end
 
   create_table "posts", force: true do |t|
-    t.string   "content"
+    t.string "content"
   end
 
 end

data/spec/factories/comments.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :comment do
+    sequence(:content) { |n| "Comment number #{n}" }
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ RSpec.configure do |config|
   config.include Rails.application.routes.url_helpers
 
   config.after(:each) do
+    Comment.destroy_all
     Post.destroy_all
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_pagination_headers
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Richard Käll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2014-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -97,11 +97,14 @@ files:
 - api_pagination_headers.gemspec
 - lib/api_pagination_headers.rb
 - lib/api_pagination_headers/version.rb
+- spec/controllers/comments_controller_spec.rb
 - spec/controllers/posts_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/comments_controller.rb
 - spec/dummy/app/controllers/posts_controller.rb
 - spec/dummy/app/models/.keep
+- spec/dummy/app/models/comment.rb
 - spec/dummy/app/models/post.rb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -116,7 +119,9 @@ files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/db/migrate/20131001123917_create_posts.rb
+- spec/dummy/db/migrate/20140406141645_create_comments.rb
 - spec/dummy/db/schema.rb
+- spec/factories/comments.rb
 - spec/factories/posts.rb
 - spec/spec_helper.rb
 homepage: https://github.com/richardkall/api_pagination_headers
@@ -139,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Link header pagination for APIs