cortex-client 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbc7f3a571dbb32fcc37a005ab162f65e71e9053
-  data.tar.gz: 51eee03bbaa63c4e1cf897e1dbcc73f377f13a96
+  metadata.gz: 77658369ff63cdc4448149946ae675efb937dc9d
+  data.tar.gz: 8326bee51ecb3d16f66eee959b1186a3fb9ec3da
 SHA512:
-  metadata.gz: 9ffec12c8de2a7314b695f961cdc6d7d62fb395f5b832a6b39456f6f4d673c831585fa05b6f5c81842fdf022fa2a951950e3c10ea1e4219bbe62dc35d22102d9
-  data.tar.gz: c5025876bc24781fbb062dd54911098c57cb6511f3ead7f5802357aafb674bfa1db21306f5ad085791b85cc2b6ee1f58556bae2c27b1c37d12bef96d1162d9d4
+  metadata.gz: 4a64a29148d0b1561e594664343792624e86edff7d5dafc62a808c8c2fe3785ab3898c71d49d55d827624f1303090af9e643ea81b578c6ddf8f6e75034c87ab6
+  data.tar.gz: 63d4568bd71a1f538b35dcabc25241fa9bf9e72939a2286a47564a2b49ab20241fab381e47074b06d50aebb438ab2e353f9739e376af71233243ec3bf2ff05a9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cortex-client (0.2.5)
+    cortex-client (0.3.0)
       faraday (~> 0.9)
       faraday_middleware (~> 0.9.0)
       oauth2 (~> 0.9)
@@ -15,6 +15,9 @@ GEM
     faraday_middleware (0.9.1)
       faraday (>= 0.7.4, < 0.10)
     jwt (1.0.0)
+    metaclass (0.0.4)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
     multi_json (1.10.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -44,5 +47,6 @@ PLATFORMS
 
 DEPENDENCIES
   cortex-client!
+  mocha
   rake (~> 10.3.2)
   rspec (~> 3.0)

data/README.md

@@ -5,9 +5,7 @@
 
 Ruby client library for [cortex](https://github.com/cb-talent-development/cortex)'s API.
 
-**0.1 Changes the constructor**
-
-Please note that 0.1.0 and onward now require a hash be passed. You can access the previous functionality with the access_token key:
+## Constructor
 
 ```ruby
 require 'cortex-client'
@@ -31,12 +29,26 @@ client = Cortex::Client.new(key: 'my-app-id', secret: 'secrey-key-ssh', base_url
  end
 ```
 
+## Result object
+
+Cortex::Client will return a Cortex::Result object. The following methods are available:
+
+- contents
+- is_error?
+- errors
+- page
+- per_page
+- total_items
+- range
+- range_start
+- range_end
+- raw_headers
+
 ### Supported Endpoints
 
-- *Users* - me, get ,save
-- *Posts* - query, get, save, delete, feed
+- *Users* - me, get, save
+- *Posts* - query, get, save, delete, feed, feed/get, feed/get/released, feed/authors
 
 ### TODO
 - Handle pagination
-- Support for search queries
 - /media

data/cortex-client.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake', '~> 10.3.2'
   s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'mocha'
 
   s.add_dependency 'faraday', '~> 0.9'
   s.add_dependency 'faraday_middleware', '~> 0.9.0'

data/lib/cortex/client.rb

@@ -3,6 +3,7 @@ require 'cortex/request'
 require 'cortex/resource'
 require 'cortex/posts'
 require 'cortex/users'
+require 'cortex/result'
 require 'oauth2'
 
 module Cortex

data/lib/cortex/posts.rb

@@ -1,10 +1,10 @@
 module Cortex
   class Posts  < Cortex::Resource
-    def query(params = nil)
+    def query(params = {})
       client.get('/posts', params)
     end
 
-    def feed(params = nil)
+    def feed(params = {})
       client.get('/posts/feed', params)
     end
 
@@ -12,6 +12,10 @@ module Cortex
       client.get("/posts/#{id}")
     end
 
+    def get_published(id)
+      client.get("/posts/feed/#{id}")
+    end
+
     def save(post)
       client.save('/posts', post)
     end
@@ -24,7 +28,7 @@ module Cortex
       client.get('/posts/filters')
     end
 
-    def related(id, params = nil)
+    def related(id, params = {})
       client.get("/posts/feed/#{id}/related", params)
     end
 

data/lib/cortex/request.rb

@@ -30,18 +30,7 @@ module Cortex
       response = connection.delete do |r|
         r.url base_url + path
       end
-      response.status < 300
-    end
-
-    def delete!(path)
-      response = connection.delete do |r|
-        r.url base_url + path
-      end
-      if response.status < 300
-        true
-      else
-        raise parse_response(response)
-      end
+      parse_response(response)
     end
 
     def save(path, model)
@@ -49,11 +38,7 @@ module Cortex
     end
 
     def parse_response(response)
-      if response.status < 300 || (response.body.kind_of?(Hash) && response.body['error'])
-        OpenStruct.new({body: response.body, headers: { status: response.status }.merge(response.headers.select { |k| ['content-range', 'x-total-items'].include? k })  })
-      else
-        OpenStruct.new({body: {error: response.body, status: response.status, original: response}, headers: { status: response.status }})
-      end
+      Cortex::Result.new(response.body, response.headers, response.status)
     end
   end
 end

data/lib/cortex/result.rb

@@ -0,0 +1,50 @@
+module Cortex
+  class Result
+    attr_reader :raw_headers, :contents, :total_items, :page, :per_page, :errors, :range_start, :range_end, :range, :status
+
+    def initialize(body, headers, status)
+      @contents = 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
+
+    def is_error?
+      @status >= 400 || (@contents.is_a?(Hash) && @contents.has_key?('errors'))
+    end
+
+    private
+
+    def parse_headers(headers)
+      if headers['x-total-items']
+        @count = headers['x-total-items']
+      end
+      if headers['content-range']
+        matches = headers['content-range'].match(/^(\w+) (\d+)\-(\d+):(\d+)\/\d+$/i)
+        @per_page = matches[4].to_i
+        @range_start = matches[2].to_i
+        @range_end = matches[3].to_i
+        @range = "#{@range_start}-#{@range_end}"
+        @page = (@range_end / @per_page) + 1
+      end
+    end
+
+    def find_errors
+      if is_error?
+        if @contents.is_a?(Hash)
+          if @contents.has_key?('errors')
+            Array(@contents['errors'])
+          else
+            Array(@contents['message'])
+          end
+        else
+          Array(@contents)
+        end
+      else
+        Array(nil)
+      end
+    end
+  end
+end

data/lib/cortex/version.rb

@@ -1,3 +1,3 @@
 module Cortex
-  VERSION = '0.2.6'
+  VERSION = '0.3.0'
 end

data/spec/client_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Cortex::Client do
+RSpec.describe Cortex::Client do
 
   let(:access_token) { '123' }
   let(:base_url) { 'http://localhost:3000' }

data/spec/posts_spec.rb

@@ -1,25 +1,32 @@
 require 'spec_helper'
 
-describe Cortex::Posts do
+RSpec.describe Cortex::Posts do
 
   let(:client) { Cortex::Client.new(access_token: '123') }
 
   describe :get do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/posts/1').and_return('response')
+      client.expects(:get).with('/posts/1').returns('response')
       expect(client.posts.get(1)).to eq('response')
     end
   end
 
+  describe :get_published do
+    it 'should correctly make the request' do
+      client.expects(:get).with('/posts/feed/1').returns('response')
+      expect(client.posts.get_published(1)).to eq('response')
+    end
+  end
+
   describe :feed do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/posts/feed', nil).and_return('response')
+      client.expects(:get).with('/posts/feed', {}).returns('response')
       expect(client.posts.feed()).to eq('response')
     end
 
     it 'should accept parameters and send them with the request' do
-      expect(client).to receive(:get).with('/posts/feed', {q: "Test*"}).and_return('success')
-      expect(client.posts.feed(q: 'Test*')).to eq('success')
+      client.expects(:get).with('/posts/feed', {q: "Test*"}).returns('response')
+      expect(client.posts.feed(q: 'Test*')).to eq('response')
     end
   end
 
@@ -27,7 +34,7 @@ describe Cortex::Posts do
     context 'with an existing post' do
       it 'should correctly make the request' do
         post = {:id => 1, :title => 'Post'}
-        expect(client).to receive(:put).with('/posts/1', post).and_return('response')
+        client.expects(:put).with('/posts/1', post).returns('response')
         expect(client.posts.save(post)).to eq('response')
       end
     end
@@ -35,7 +42,7 @@ describe Cortex::Posts do
     context 'with a new post' do
       it 'should correctly make the request' do
         post = {:title => 'Post'}
-        expect(client).to receive(:post).with('/posts', post).and_return('response')
+        client.expects(:post).with('/posts', post).returns('response')
         expect(client.posts.save(post)).to eq('response')
       end
     end
@@ -43,22 +50,22 @@ describe Cortex::Posts do
 
   describe :filters do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/posts/filters').and_return('success')
-      expect(client.posts.filters()).to eq('success')
+      client.expects(:get).with('/posts/filters').returns('response')
+      expect(client.posts.filters()).to eq('response')
     end
   end
 
   describe :related do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/posts/feed/1/related', nil).and_return('success')
-      expect(client.posts.related(1)).to eq('success')
+      client.expects(:get).with('/posts/feed/1/related', {}).returns('response')
+      expect(client.posts.related(1)).to eq('response')
     end
   end
 
   describe :authors do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/posts/feed/authors').and_return('success')
-      expect(client.posts.authors).to eq('success')
+      client.expects(:get).with('/posts/feed/authors').returns('response')
+      expect(client.posts.authors).to eq('response')
     end
   end
 end

data/spec/request_spec.rb

@@ -3,31 +3,82 @@ require 'spec_helper'
 describe Cortex::Request do
   let(:client) { Cortex::Client.new(access_token: '123') }
 
-  context 'with a cortex error response' do
-    it 'should return the error object' do
-      body = {'error' => 'Validation error or something'}
-      response = OpenStruct.new(status: 422, body: body, headers: { :whatever => "Whatever"})
-      expect(client.parse_response(response).to_h).to eq({ :body => body, :headers => {status: 422}})
+  context 'Request Methods' do
+    let(:response) { OpenStruct.new({body: "Body", headers: {}, status: 200} ) }
+    let(:model) { { title: 'Test' } }
+
+    before(:each) do
+      @connection = stub
+      Cortex::Client.any_instance.stubs(:connection).returns(@connection)
+      Cortex::Result.any_instance.stubs(:new).with(response).returns(true)
     end
-  end
 
-  context 'with a non-cortex error response' do
-    it 'should return a wrapped response' do
-      body = 'Catastrophic error'
-      response = OpenStruct.new(status: 500, body: body, headers: { whatever: "Whatever", status: 500 } )
-      parsed = client.parse_response(response)
-      expect(parsed.body[:error]).to eq(body)
-      expect(parsed.body[:status]).to eq(500)
-      expect(parsed.body[:original]).to eq(response)
-      expect(parsed.headers[:status]).to eq(500)
+    describe '#get' do
+      it 'should call get' do
+        @connection.stubs(:get).returns(response).once
+        expect(client.get('/test/')).to be_truthy
+      end
+    end
+
+    describe '#post' do
+      it 'should call post' do
+        @connection.stubs(:post).returns(response).once
+        expect(client.post('/test/')).to be_truthy
+      end
+    end
+
+    describe '#put' do
+      it 'should call put' do
+        @connection.stubs(:put).returns(response).once
+        expect(client.put('/test/')).to be_truthy
+      end
+    end
+
+    describe '#delete' do
+      it 'should call delete' do
+        @connection.stubs(:delete).returns(response).once
+        expect(client.delete('/test/')).to be_truthy
+      end
+    end
+
+    describe '#save' do
+      it 'should post when new' do
+        @connection.stubs(:post).returns(response).once
+        expect(client.save('/test/', model)).to be_truthy
+      end
+
+      it 'should put when updating' do
+        update = model
+        update[:id] = 1
+        @connection.stubs(:put).returns(response).once
+        expect(client.save('/test/', update)).to be_truthy
+      end
     end
   end
 
-  context 'with a successful response' do
-    it 'should return the parsed body' do
-      body = {:id => 1, title: 'A post'}
-      response = OpenStruct.new(status: 200, body: body, headers: { :whatever => "Whatever" })
-      expect(client.parse_response(response).to_h).to eq({ body: body, headers: {status: 200}})
+  context 'Record Parsing' do
+    let(:body) { "Body" }
+    let(:headers) { { } }
+    let(:status) { 200 }
+    let(:error_status) { 400 }
+    let(:response) { OpenStruct.new({body: 'Body', headers: {}, status: 200 } ) }
+
+    describe 'parse_response' do
+      before(:each) do
+        result = stub
+        Cortex::Result.any_instance.stubs(:new).with(body, headers, status).returns(true)
+        Cortex::Result.any_instance.stubs(:new).with(body, headers, error_status).returns(true)
+      end
+
+      it 'should construct a successful response' do
+        expect(client.parse_response(response)).to be_truthy
+      end
+
+      it 'should construct an error response' do
+        error = response
+        error.status = error_status
+        expect(client.parse_response(error)).to be_truthy
+      end
     end
   end
 end

data/spec/result_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+RSpec.describe Cortex::Result do
+  let(:result) { Cortex::Result.new('body', {'x-total-items' => 10, 'content-range' => "posts 0-9:10/200"}, 200) }
+  let(:failed) { Cortex::Result.new('failed body', {}, 403) }
+
+  it 'should construct' do
+    expect(result).to be_truthy
+    expect(failed).to be_truthy
+  end
+
+  it 'should parse the headers' do
+    expect(result.page).to eq 1
+    expect(result.per_page).to eq 10
+    expect(result.range).to eq "0-9"
+  end
+
+  it 'should provide is_error?' do
+    expect(result.is_error?).to be_falsey
+    expect(failed.is_error?).to be_truthy
+  end
+
+  it 'should parse errors properly' do
+    expect(result.errors).to eq []
+    expect(failed.errors).to eq ['failed body']
+  end
+
+  it 'should expose the contents' do
+    expect(result.contents).to eq 'body'
+    expect(failed.contents).to eq 'failed body'
+  end
+
+  it 'should expose the headers' do
+    expect(result.raw_headers).to eq({ 'x-total-items' => 10, 'content-range' => "posts 0-9:10/200" })
+    expect(failed.raw_headers).to eq({})
+  end
+
+  it 'should expose the http status' do
+    expect(result.status).to eq 200
+    expect(failed.status).to eq 403
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,2 +1,6 @@
 require 'ostruct'
 require_relative '../lib/cortex-client'
+
+RSpec.configure do |config|
+  config.mock_framework = :mocha
+end

data/spec/users_spec.rb

@@ -6,7 +6,7 @@ describe Cortex::Users do
 
   describe :me do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/users/me').and_return('response')
+      client.expects(:get).with('/users/me').returns('response')
       response = client.users.me
       expect(response).to eq('response')
     end
@@ -14,7 +14,7 @@ describe Cortex::Users do
 
   describe :get do
     it 'should correctly make the request' do
-      expect(client).to receive(:get).with('/users/1').and_return('response')
+      client.expects(:get).with('/users/1').returns('response')
       expect(client.users.get(1)).to eq('response')
     end
   end
@@ -23,7 +23,7 @@ describe Cortex::Users do
     context 'with an existing user' do
       it 'should correctly make the request' do
         user = {:id => 1, :email => 'user@cbcortex.com'}
-        expect(client).to receive(:put).with('/users/1', user).and_return('response')
+        client.expects(:put).with('/users/1', user).returns('response')
         response = client.users.save(user)
         expect(response).to eq('response')
       end
@@ -32,7 +32,7 @@ describe Cortex::Users do
     context 'with a new user' do
       it 'should correctly make the request' do
         user = {:email => 'user@cbcortex.com'}
-        expect(client).to receive(:post).with('/users', user).and_return('response')
+        client.expects(:post).with('/users', user).returns('response')
         response = client.users.save(user)
         expect(response).to eq('response')
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cortex-client
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Bennett Goble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -99,11 +113,13 @@ files:
 - lib/cortex/posts.rb
 - lib/cortex/request.rb
 - lib/cortex/resource.rb
+- lib/cortex/result.rb
 - lib/cortex/users.rb
 - lib/cortex/version.rb
 - spec/client_spec.rb
 - spec/posts_spec.rb
 - spec/request_spec.rb
+- spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/users_spec.rb
 homepage: https://github.com/cb-talent-development/cortex-client
@@ -134,5 +150,6 @@ test_files:
 - spec/client_spec.rb
 - spec/posts_spec.rb
 - spec/request_spec.rb
+- spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/users_spec.rb