Merge pull request #46 from TiteiKo/add-page-header

Add page header

Author: davidcelis

README.md

@@ -39,6 +39,9 @@ ApiPagination.configure do |config|
 
   # By default, this is set to 'Per-Page'
   config.per_page_header = 'X-Per-Page'
+
+  # Optional : set this to add a header with the current page number.
+  config.page_header = 'X-Page'
 end
 ```
 

lib/api-pagination/configuration.rb

@@ -4,13 +4,16 @@ class Configuration
 
     attr_accessor :per_page_header
 
+    attr_accessor :page_header
+
     def configure(&block)
       yield self
     end
 
     def initialize
       @total_header    = 'Total'
       @per_page_header = 'Per-Page'
+      @page_header     = nil
     end
 
     def paginator

lib/grape/pagination.rb

@@ -22,10 +22,12 @@ def paginate(collection)
 
           total_header    = ApiPagination.config.total_header
           per_page_header = ApiPagination.config.per_page_header
+          page_header     = ApiPagination.config.page_header
 
           header 'Link',          links.join(', ') unless links.empty?
           header total_header,    ApiPagination.total_from(collection)
           header per_page_header, options[:per_page].to_s
+          header page_header,     options[:page].to_s unless page_header.nil?
 
           return collection
         end

lib/rails/pagination.rb

@@ -41,10 +41,12 @@ def _paginate_collection(collection, options={})
 
       total_header    = ApiPagination.config.total_header
       per_page_header = ApiPagination.config.per_page_header
+      page_header     = ApiPagination.config.page_header
 
       headers['Link']          = links.join(', ') unless links.empty?
       headers[total_header]    = ApiPagination.total_from(collection)
       headers[per_page_header] = options[:per_page].to_s
+      headers[page_header]     = options[:page].to_s unless page_header.nil?
 
       return collection
     end

spec/grape_spec.rb

@@ -71,17 +71,20 @@
       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
 
       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,13 @@
         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 'with query string including array parameter' do

spec/rails_spec.rb

@@ -73,17 +73,20 @@
       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
 
       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,13 @@
         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
   end
 end