api_pagination_headers 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35814c87aed688c6c42e3fa945a6bb03577c655b
-  data.tar.gz: 4de3bfa064064a4a779911fbea668d333f63ad0c
+  metadata.gz: 2951f6ab1e6f4ae8b918ef019ebaf213ca871227
+  data.tar.gz: 84f12322efdfd46aa93e11f0b65eb6e38afb7639
 SHA512:
-  metadata.gz: 204c618c1da93248ccff5ea218dab5ca501bd4930dbd43cbca5be9805cb893ffe564371266809df85911a8703250018dd2d42e1a14a135af5bb34bd0f1edd0ca
-  data.tar.gz: 4d3918d4c766aeb69f582374000cc9c840be70473de6b122a6f91e940b1f890804befcde616dfd97451322c36353c300c20616990153c4400b20464ce12ce907
+  metadata.gz: 56c710ff5058147cf1add25c6b6434dcd19460a45a0af8e899ba13abbd35f84b7e46862631287e2c24b510c9de0bb4e76b2db1d3c785b25789230bbe3e10a974
+  data.tar.gz: 40d2074b5382155d0e752c5c5c367fa65bbbbcec532b91822b8d0208eb1db3bf200aaf64ae424502d6b358c2c3a0e91e49b270b96159019c3e33d5eb9961e2cf

data/.gitignore

@@ -1,5 +1,6 @@
 .bundle/
 .DS_Store
+.gem
 log/*.log
 pkg/
 spec/dummy/db/*.sqlite3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api_pagination_headers (1.0.0)
+    api_pagination_headers (1.1.0)
       rails (~> 4.0.0)
       will_paginate (~> 3.0.5)
 

data/README.md

@@ -1,11 +1,12 @@
-#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)
+#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 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.
 
 Example:
 
 ```
-Link: <http://example.com/posts?page=2&per_page=10>;rel="next",<http://example.com/posts?page=2&per_page=10>;rel="last"
+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
 ```
 
@@ -15,10 +16,9 @@ Include in your Gemfile:
 
 ```
 gem 'api_pagination_headers'
-gem 'will_paginate'
 ```
 
-Only tested with [will_paginate](https://github.com/mislav/will_paginate) at the moment, but should be easily customized for any other pagination gem.
+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.
 

data/lib/api_pagination_headers/version.rb

@@ -1,3 +1,3 @@
 module ApiPaginationHeaders
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/api_pagination_headers.rb

@@ -3,24 +3,33 @@ module ApiPaginationHeaders
 
   def set_pagination_headers(name)
     scope = instance_variable_get("@#{name}")
-    request_params = request.query_parameters
-    url_without_params = request.url.split('?').first
-    per_page = params[:per_page] ? params[:per_page].to_i : WillPaginate.per_page
+    pages = set_page_numbers(scope)
+    links = create_links(pages)
+
+    headers['Link'] = links.join(', ') unless links.empty?
+    headers['X-Total-Count'] = "#{scope.total_entries}"
+  end
 
-    page = {}
-    page[:first] = 1 if scope.total_pages > 1 && scope.current_page > 1
-    page[:prev] = scope.current_page - 1 if scope.current_page > 1
-    page[:next] = scope.current_page + 1 if scope.current_page < scope.total_pages
-    page[:last] = scope.total_pages if scope.total_pages > 1 && scope.current_page < scope.total_pages
+  private
 
-    pagination_links = []
-    page.each do |key, value|
-      new_request_hash = request_params.merge({ page: value, per_page: per_page })
-      pagination_links << "<#{url_without_params}?#{new_request_hash.to_param}>; rel=\"#{key}\""
+  def create_links(pages)
+    url_without_params = request.url.split('?').first
+    per_page = params[:per_page] ? params[:per_page].to_i : WillPaginate.per_page
+    links = []
+    pages.each do |key, value|
+      new_params = request.query_parameters.merge({ page: value, per_page: per_page })
+      links << "<#{url_without_params}?#{new_params.to_param}>; rel=\"#{key}\""
     end
+    links
+  end
 
-    headers['Link'] = pagination_links.join(', ') unless pagination_links.empty?
-    headers['X-Total-Count'] = "#{scope.total_entries}"
+  def set_page_numbers(scope)
+    pages = {}
+    pages[:first] = 1 if scope.total_pages > 1 && scope.current_page > 1
+    pages[:prev] = scope.current_page - 1 if scope.current_page > 1
+    pages[:next] = scope.current_page + 1 if scope.current_page < scope.total_pages
+    pages[:last] = scope.total_pages if scope.total_pages > 1 && scope.current_page < scope.total_pages
+    pages
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_pagination_headers
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Käll