Merge pull request #23 from cortex-cms/improve-pagination-result

Improve pagination on result object

Author: Alex Tharp

CHANGELOG.md

@@ -3,6 +3,7 @@ Version History
     * All Version bumps are required to update this file as well!!
 ----
 
+* 0.9.0 - Add total pages, next page, and prev page to result object
 * 0.8.0 - Revert ETag caching flow implementation
 * 0.7.0 - Implement ability to specify OAuth scopes
 * 0.6.1 - Update various dependencies

lib/cortex/result.rb

@@ -1,13 +1,12 @@
 require 'hashie'
 module Cortex
   class Result
-    attr_reader :raw_headers, :contents, :total_items, :page, :per_page, :errors, :range_start, :range_end, :range, :status
+    attr_reader :raw_headers, :contents, :total_items, :page, :per_page, :errors, :range_start, :range_end, :range, :status, :total_pages, :next_page, :prev_page
 
     def initialize(body, headers, status)
       @contents = parse(body)
       @raw_headers = headers
       @status = status
-      @total_items = headers['x-total-items'] unless headers['x-total-items'].nil?
       parse_headers(headers)
       @errors = find_errors
     end
@@ -20,15 +19,16 @@ def is_error?
 
     def parse_headers(headers)
       if headers['X-Total']
+        @total_items = headers['X-Total']
         @count = headers['X-Total'].to_i
-      end
-      if headers['X-Total']
         @page = headers['X-Page'].to_i
         @per_page = headers['X-Per-Page'].to_i
         @range_start = (@page-1) * @per_page
         @range_end = @per_page * @page - 1
         @range = "#{@range_start}-#{@range_end}"
-
+        @total_pages = headers['X-Total-Pages']
+        @next_page = headers['X-Next-Page']
+        @prev_page = headers['X-Prev-Page']
       end
     end
 

lib/cortex/version.rb

@@ -1,3 +1,3 @@
 module Cortex
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

spec/result_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Cortex::Result do
-  let(:result) { Cortex::Result.new('body', {'X-Total' => 10, 'X-Page' => "1", "X-Per-Page" => "10"}, 200) }
+  let(:result) { Cortex::Result.new('body', { 'X-Total' => '40', 'X-Page' => "1", 'X-Per-Page' => "10", 'X-Total-Pages' => '4', 'X-Next-Page' => '2', 'X-Prev-Page' => nil }, 200) }
   let(:failed) { Cortex::Result.new('failed body', {}, 403) }
 
   it 'should construct' do
@@ -31,7 +31,7 @@
   end
 
   it 'should expose the headers' do
-    expect(result.raw_headers).to eq({ 'X-Total' => 10, 'X-Page' => "1", "X-Per-Page" => "10" })
+    expect(result.raw_headers).to eq({ 'X-Total' => '40', 'X-Page' => "1", 'X-Per-Page' => "10", 'X-Total-Pages' => '4', 'X-Next-Page' => '2', 'X-Prev-Page' => nil })
     expect(failed.raw_headers).to eq({})
   end
 
@@ -40,4 +40,28 @@
     expect(failed.status).to eq 403
   end
 
+  describe '#total_pages' do
+    it 'returns the value of "X-Total-Pages"' do
+      expect(result.total_pages).to eq '4'
+    end
+  end
+
+  describe '#next_page' do
+    it 'returns_the_value of "X-Next-Page"' do
+      expect(result.next_page).to eq '2'
+    end
+  end
+
+  describe '#prev_page' do
+    it 'returns nil when on the first page' do
+      expect(result.prev_page).to be_nil
+    end
+
+    context 'on the 2nd page' do
+      let(:result) { Cortex::Result.new('body', { 'X-Total' => '40', 'X-Page' => "2", 'X-Per-Page' => "10", 'X-Total-Pages' => '4', 'X-Next-Page' => '3', 'X-Prev-Page' => '1' }, 200) }
+      it 'returns the value if "X-Prev-Page"' do
+        expect(result.prev_page).to eq '1'
+      end
+    end
+  end
 end