cortex-client 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e3d73ec9aa82a9f0aa4931fe30731c32537f9f4
-  data.tar.gz: aa513546927675339846803412df7b0b9cf9f76c
+  metadata.gz: 0ae9160a1f77ff75bbdd94a1dd24c2158dd24dd2
+  data.tar.gz: 32696a70d36bfb41f7b3769ef6d8c86f71ad7c1f
 SHA512:
-  metadata.gz: 949ddcb080dfd027f6367ca6d44553ee79e81c042222b6eff8d81ae4df88ea5965493d0afbe11623fa9308d50e17d0fd3132118fc0ec338091bf346e6d2100fd
-  data.tar.gz: 2a118370b5fa03731bd4dcd1b89a9e2f161240559f2ad5ec40858098436788d7056d041695ab8570d6209640fd4cce1d66d38d66dacfb625e5ef196d05fc0626
+  metadata.gz: a6bd08c5ae793a6aaac1e5bb8c320164cd2c776a1515a76f7860b305c7daacf59fc30a175f8d2383f2fa3bd99dcb90777fe4aee13408114adfae60aebcffc6fd
+  data.tar.gz: 4342fc1a3198dda90259324c55b0f7bc821300eb9f7a1f98e8d461b909acc6e8e8949ba9ca13c0545afba720ae01ad617832c16c230600a488bc8629061a0595

data/CHANGELOG.md

@@ -3,7 +3,7 @@ Version History
     * All Version bumps are required to update this file as well!!
 ----
 
-* 0.8.2 - Revert ETag caching flow implementation
+* 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

data/README.md

@@ -22,13 +22,17 @@ Alternatively, cortex-client will handle OAuth2 authentication for you:
 ```ruby
 require 'cortex-client'
 
-client = Cortex::Client.new(key: 'my-app-id', secret: 'secrey-key-ssh', base_url: 'base_url', scopes: 'view:posts view:media')
+client = Cortex::Client.new(key: 'my-app-id', secret: 'my-app-secret', base_url: 'base_url', scopes: 'view:posts view:media')
  
  client.posts.query().each do |post|
   puts post
  end
 ```
 
+## Authorization
+
+For more information about `scopes` and how to obtain an application `key` and `secret`, check [Cortex's authorization documentation](https://github.com/cbdr/cortex#authorization).
+
 ## Result object
 
 Cortex::Client will return a Cortex::Result object. The following methods are available:

data/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 @@ module Cortex
 
     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
 

data/lib/cortex/version.rb

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

data/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 @@ RSpec.describe Cortex::Result do
   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 @@ RSpec.describe Cortex::Result do
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cortex-client
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - CB Content Enablement
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Cortex API Client