Merge branch 'develop'

Author: toastercup

.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.4.0
 notifications:
   recipients:
-    - ContentEnablementProductTeam@careerbuilder.com
+    - EmployerSiteContentProducts@cb.com

CHANGELOG.md

@@ -1,8 +1,14 @@
 Version History
 ====
-    * All Version bumps are required to update this file as well!!
+    * All Version bumps are required to update this file as well!
 ----
 
+* 0.10.0:
+  * Utilize `Addressable::URI` as Faraday's default URI parser so that resourceful URI fragments are escaped and parsed properly
+  * Utilize `Faraday::Middleware` for `Hashie::Mash`ing & OAuth2 Token insertion
+  * Update dependencies
+  * No major breaking changes anticipated, but please *test* your use cases!
+* 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

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:

cortex-client.gemspec

@@ -6,21 +6,22 @@ Gem::Specification.new do |s|
   s.version       = Cortex::VERSION
   s.summary       = 'Cortex API Client'
   s.homepage      = 'https://github.com/cortex-cms/cortex-client-ruby'
-  s.authors       = ['CB Content Enablement']
-  s.email         = 'ContentEnablementProductTeam@careerbuilder.com'
+  s.authors       = ['CareerBuilder Employer Site & Content Products']
+  s.email         = ['EmployerSiteContentProducts@cb.com']
   s.license       = 'Apache-2.0'
 
   s.files         = `git ls-files`.split($/).reject { |f| f == '.gitignore' }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake', '~> 11.1'
-  s.add_development_dependency 'rspec', '~> 3.4'
-  s.add_development_dependency 'mocha', '~> 1.1'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'mocha', '~> 1.2'
 
+  s.add_dependency 'oauth2', '~> 1.1.0'
   s.add_dependency 'faraday', '~> 0.9'
   s.add_dependency 'faraday_middleware', '~> 0.10'
-  s.add_dependency 'oauth2', '~> 1.1.0'
-  s.add_dependency 'cortex-exceptions', '~> 0.0.4'
+  s.add_dependency 'addressable', '~> 2.5'
   s.add_dependency 'hashie', '~> 3.4'
+  s.add_dependency 'cortex-exceptions', '~> 0.0.4'
 end

lib/cortex/client.rb

@@ -1,12 +1,12 @@
+require 'oauth2'
+
 require 'cortex/connection'
 require 'cortex/request'
 require 'cortex/resource'
 require 'cortex/posts'
 require 'cortex/users'
 require 'cortex/webpages'
 require 'cortex/result'
-require 'oauth2'
-require 'cortex/exceptions'
 
 module Cortex
   class Client
@@ -20,7 +20,7 @@ class Client
     include Cortex::Request
 
     def initialize(hasharg)
-      @base_url = hasharg[:base_url] || 'https://cbcortex.com/api/v1/'
+      @base_url = hasharg[:base_url] || 'https://cbcortex.com/api/v1'
       if hasharg.has_key? :access_token
         @access_token = hasharg[:access_token]
       else

lib/cortex/connection.rb

@@ -1,6 +1,9 @@
 require 'faraday'
 require 'faraday_middleware'
-require 'cortex/faraday_middleware'
+require 'addressable/uri'
+require 'hashie/mash'
+
+require 'cortex/faraday_middleware/response_failures'
 
 module Cortex
   module Connection
@@ -16,11 +19,19 @@ def connection
         @access_token = get_cc_token
       end
 
+      Faraday::Utils.default_uri_parser = Addressable::URI
       Faraday.new options do |conn|
-        conn.use Cortex::FaradayMiddleware
-        conn.request :oauth2, access_token.is_a?(OAuth2::AccessToken) ? access_token.token : access_token
+        ## Request middleware first:
+        conn.use ::FaradayMiddleware::OAuth2, access_token.is_a?(OAuth2::AccessToken) ? access_token.token : access_token
+
+        ## Response middleware second:
+        conn.use ::FaradayMiddleware::Mashify
+        conn.use Cortex::FaradayMiddleware::ResponseFailures
+
         conn.request :json
         conn.response :json, :content_type => /\bjson$/
+
+        ## Adapter always last:
         conn.adapter Faraday.default_adapter
       end
     end

lib/cortex/faraday_middleware.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+
+require 'cortex/exceptions'
+
+module Cortex
+  module FaradayMiddleware
+    class ResponseFailures < Faraday::Middleware
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Faraday::ConnectionFailed
+          raise Cortex::Exceptions::ConnectionFailed.new(base_url: env[:url])
+        end
+      end
+    end
+  end
+end

lib/cortex/faraday_middleware/response_failures.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module Cortex
   module Request
     def get(path, params = {})

lib/cortex/request.rb

@@ -7,4 +7,4 @@ def initialize(client)
     protected
     attr_accessor :client
   end
-end
+end