Merge pull request #25 from cortex-cms/client-rebuild-and-support-for-special-chars

Large-ish Refactor and Support for Special Characters

Author: Alex Tharp

.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,13 @@
 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

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,12 +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.request :url_encoded
         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

lib/cortex/resource.rb

@@ -1,18 +1,17 @@
-require 'hashie'
 module Cortex
   class Result
     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)
+      @contents = body
       @raw_headers = headers
       @status = status
       parse_headers(headers)
       @errors = find_errors
     end
 
     def is_error?
-      @status >= 400 || (@contents.is_a?(Hash) && @contents.has_key?('errors'))
+      @status >= 400 || (@contents.is_a?(Hash) && @contents.errors?)
     end
 
     private
@@ -32,31 +31,21 @@ def parse_headers(headers)
       end
     end
 
-    def parse(body)
-      case body
-        when Hash
-          ::Hashie::Mash.new(body)
-        when Array
-          body.map { |item| parse(item) }
-        else
-          body
-      end
-    end
-
     def find_errors
+      errors = nil
       if is_error?
         if @contents.is_a?(Hash)
-          if @contents.has_key?('errors')
-            Array(@contents['errors'])
+          if @contents.errors?
+            errors = @contents.errors
           else
-            Array(@contents['message'])
+            errors = @contents.message
           end
         else
-          Array(@contents)
+          errors = @contents
         end
-      else
-        Array(nil)
       end
+
+      Array(errors)
     end
   end
 end

lib/cortex/result.rb

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

lib/cortex/version.rb

@@ -2,6 +2,7 @@
 
 RSpec.describe Cortex::Posts do
 
+  # TODO: Stub out Faraday somewhere. See: https://github.com/lostisland/faraday#using-faraday-for-testing
   let(:client) { Cortex::Client.new(access_token: '123') }
 
   describe :get do
@@ -16,6 +17,10 @@
       client.expects(:get).with('/posts/feed/1').returns('response')
       expect(client.posts.get_published(1)).to eq('response')
     end
+
+    it 'should work with special characters' do
+      expect { client.posts.get_published('1 post') }.to_not raise_error(URI::InvalidURIError)
+    end
   end
 
   describe :feed do