Merge pull request #2 from cb-talent-development/release/v0.3.0

v0.3.0 release

Author: Casao

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cortex-client (0.2.6)
+    cortex-client (0.3.0)
       faraday (~> 0.9)
       faraday_middleware (~> 0.9.0)
       oauth2 (~> 0.9)

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

lib/cortex/result.rb

@@ -1,6 +1,6 @@
 module Cortex
   class Result
-    attr_reader :raw_headers, :contents, :total_items, :page, :per_page, :errors, :range_start, :range_end, :range
+    attr_reader :raw_headers, :contents, :total_items, :page, :per_page, :errors, :range_start, :range_end, :range, :status
 
     def initialize(body, headers, status)
       @contents = body

lib/cortex/version.rb

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

spec/result_spec.rb

@@ -35,4 +35,9 @@
     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