bootic_client 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03f3eb030bbf24bfb6139b46682376a00520cff4
-  data.tar.gz: 480c44fe0b9e62387028d5d0d2061ee5350664e7
+SHA256:
+  metadata.gz: 30679ee6a43b99369706f814812e081c631f7fb430ee1aee257f39690dd065bd
+  data.tar.gz: 5edc48fe9a7f34e4adb0cd2eeab702953b7371d29ff538fb7a2c629ebd74d29c
 SHA512:
-  metadata.gz: 29a90003594b260e0dbc0a0ddcdaa2758ab9f54a87fd467698bc7a658efaa836ebeb5a3182f24c83e659016c753c669970a5178ca5224e528a6ed801b402b3aa
-  data.tar.gz: ea07a9a75c125f616945985be788b5b246e53c4df9e4b288a2e70d41445c501a1df943f79071f7d6c31a34652e5a3d743b5d3a9653c54d3d9157f312fee3e1d8
+  metadata.gz: b7177b27e419870b4e158b717f94d5a5209748c9f2d8ca590bfeec21acfaef677feabd50d70a9a67f669c4679400be9b10937e21db6114d606fa4338e289b737
+  data.tar.gz: 034fa3444247619b836be72220d1009ff407a53e5b5551eb5faa127196aa0dfa5a908c7697ba24f2f881150c5e0eb7d5b3410295c5a93a2493abe611ab690a64

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+## [Unreleased](https://github.com/bootic/bootic_client.rb/tree/HEAD)
+
+[Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.21...HEAD)
+
+**Merged pull requests:**
+
+- Custom response handlers [\#18](https://github.com/bootic/bootic_client.rb/pull/18) ([ismasan](https://github.com/ismasan))
+- Wrap all hash properties in Entity.new, even if not in \_embedded group. [\#17](https://github.com/bootic/bootic_client.rb/pull/17) ([ismasan](https://github.com/ismasan))
+- Make configuration an instance [\#16](https://github.com/bootic/bootic_client.rb/pull/16) ([ismasan](https://github.com/ismasan))
+
+## [v0.0.21](https://github.com/bootic/bootic_client.rb/tree/v0.0.21) (2018-08-30)
+[Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.20...v0.0.21)
+
+**Merged pull requests:**
+
+- Add :user\_agent option [\#13](https://github.com/bootic/bootic_client.rb/pull/13) ([ismasan](https://github.com/ismasan))
+
+## [v0.0.20](https://github.com/bootic/bootic_client.rb/tree/v0.0.20) (2018-07-05)
+[Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.19...v0.0.20)
+
+**Merged pull requests:**
+
+- Validate config setters [\#15](https://github.com/bootic/bootic_client.rb/pull/15) ([ismasan](https://github.com/ismasan))
+- Whitelist undeclared params [\#12](https://github.com/bootic/bootic_client.rb/pull/12) ([ismasan](https://github.com/ismasan))
+
 ## [v0.0.19](https://github.com/bootic/bootic_client.rb/tree/v0.0.19) (2017-06-01)
 [Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.18...v0.0.19)
 

data/Gemfile

@@ -5,5 +5,5 @@ gemspec
 
 group :test do
   gem 'byebug' if RUBY_VERSION.to_i >= 2
-  gem 'webmock', '1.22.3'
+  gem 'webmock', '3.5.1'
 end

data/README.md

@@ -218,6 +218,49 @@ asset = product.create_product_asset(
 )
 ```
 
+## Non-JSON responses
+
+HTTP responses are resolved by handler callables in `BooticClient::Configuration#response_handlers`.
+
+The default stack is:
+
+* `BooticClient::ResponseHandlers::Hal`: handles `application/json` responses and wraps JSON data in `BooticClient::Entity` instances.
+* `BooticClient::ResponseHandlers::File`: handles `image/*` responses and wraps image data in IO-like objects.
+
+```ruby
+# Fetching product images and saving them to local files:
+product.images.each do |img|
+  io = img.original # HTTP request to image file
+  # now write image data to local file.
+  File.open(io.file_name, 'wb') do |f|
+    f.write io.read
+  end
+end
+```
+
+You can register custom response handlers. The example below parses CSV response data.
+
+```ruby
+require 'csv'
+
+# Response handlers are callable (anything that responds to #call(faraday_response, client)
+# if a handler returns `nil`, the next handler in the stack will be called.
+CSVHandler = Proc.new do |resp, _client|
+  if resp.headers['Content-Type'] =~ /text\/csv/
+    CSV.parse(resp.body, headings: true)
+  end
+end
+
+BooticClient.configure do |c|
+  c.response_handlers.append(CSVHandler)
+end
+
+# Now CSV resources will be returned as parsed CSV data
+client = BooticClient.client(:authorized, access_token: 'abc')
+root = client.root
+csv = root.some_csv_resource # returns parsed CSV object.
+```
+
 ## Relation docs
 
 All resource link relations include a "docs" URL so you can learn more about that particular resource.

data/lib/bootic_client/client.rb

@@ -60,7 +60,7 @@ module BooticClient
       end
     end
 
-    protected
+    private
 
     def conn(&block)
       @conn ||= Faraday.new do |f|
@@ -69,7 +69,6 @@ module BooticClient
 
         f.use :http_cache, cache_options
         f.response :logger, options[:logger] if options[:logging]
-        f.response :json
         yield f if block_given?
         f.adapter *Array(options[:faraday_adapter])
       end

data/lib/bootic_client/configuration.rb

@@ -0,0 +1,74 @@
+require 'bootic_client/response_handlers'
+
+module BooticClient
+  InvalidConfigurationError = Class.new(StandardError)
+  VERY_BASIC_URL_CHECK = /^(http|https):/.freeze
+
+  AUTH_HOST = 'https://auth.bootic.net'.freeze
+  API_ROOT = 'https://api.bootic.net/v1'.freeze
+
+  class Configuration
+    attr_accessor :logging
+    attr_reader :client_id, :client_secret, :cache_store, :user_agent
+
+    def user_agent=(v)
+      set_non_nil :user_agent, v
+    end
+
+    def client_id=(v)
+      set_non_nil :client_id, v
+    end
+
+    def client_secret=(v)
+      set_non_nil :client_secret, v
+    end
+
+    def cache_store=(v)
+      set_non_nil :cache_store, v
+    end
+
+    def auth_host=(v)
+      check_url! :auth_host, v
+      set_non_nil :auth_host, v
+    end
+
+    def api_root=(v)
+      check_url! :api_root, v
+      set_non_nil :api_root, v
+    end
+
+    def logger=(v)
+      set_non_nil :logger, v
+    end
+
+    def auth_host
+      @auth_host || AUTH_HOST
+    end
+
+    def api_root
+      @api_root || API_ROOT
+    end
+
+    def logger
+      @logger || ::Logger.new(STDOUT)
+    end
+
+    def response_handlers
+      @response_handlers ||= ResponseHandlers::Set.new([
+        ResponseHandlers::Hal,
+        ResponseHandlers::File
+      ])
+    end
+
+    private
+
+    def set_non_nil(name, v)
+      raise InvalidConfigurationError, "#{name} cannot be nil" if v.nil?
+      instance_variable_set("@#{name}", v)
+    end
+
+    def check_url!(name, v)
+      raise InvalidConfigurationError, "#{name} must be a valid URL" unless v.to_s =~ VERY_BASIC_URL_CHECK
+    end
+  end
+end

data/lib/bootic_client/entity.rb

@@ -1,5 +1,4 @@
 require "bootic_client/relation"
-require 'ostruct'
 
 module BooticClient
   module EnumerableEntity
@@ -60,7 +59,7 @@ module BooticClient
 
     def properties
       @properties ||= attrs.select{|k,v| !(k =~ SPECIAL_PROP_EXP)}.each_with_object({}) do |(k,v),memo|
-        memo[k.to_sym] = Entity.wrap(v)
+        memo[k.to_sym] = Entity.wrap(v, client: client, top: top)
       end
     end
 
@@ -68,10 +67,10 @@ module BooticClient
       @links ||= attrs.fetch('_links', {})
     end
 
-    def self.wrap(obj)
+    def self.wrap(obj, client: nil, top: nil)
       case obj
       when Hash
-        OpenStruct.new(obj)
+        new(obj, client, top: top)
       when Array
         obj.map{|e| wrap(e)}
       else
@@ -129,7 +128,7 @@ module BooticClient
       )
     end
 
-    protected
+    private
 
     attr_reader :client, :top, :attrs
 

data/lib/bootic_client/relation.rb

@@ -18,8 +18,8 @@ module BooticClient
       end
     end
 
-    def initialize(attrs, client, entity_class: Entity, complain_on_undeclared_params: self.class.complain_on_undeclared_params)
-      @attrs, @client, @entity_class = attrs, client, entity_class
+    def initialize(attrs, client, complain_on_undeclared_params: self.class.complain_on_undeclared_params)
+      @attrs, @client = attrs, client
       @complain_on_undeclared_params = complain_on_undeclared_params
     end
 
@@ -71,9 +71,9 @@ module BooticClient
         end
         # remove payload vars from URI opts if destructive action
         opts = opts.reject{|k, v| !uri_vars.include?(k.to_s) } if destructive?
-        client.request_and_wrap transport_method.to_sym, uri.expand(opts), entity_class, payload
+        client.request_and_wrap transport_method.to_sym, uri.expand(opts), payload
       else
-        client.request_and_wrap transport_method.to_sym, href, entity_class, opts
+        client.request_and_wrap transport_method.to_sym, href, opts
       end
     end
 
@@ -82,7 +82,7 @@ module BooticClient
     end
 
     protected
-    attr_reader :entity_class, :client, :attrs, :complain_on_undeclared_params
+    attr_reader :client, :attrs, :complain_on_undeclared_params
 
     def uri
       @uri ||= WhinyURI.new(href, complain_on_undeclared_params)

data/lib/bootic_client/response_handlers.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+module BooticClient
+  module ResponseHandlers
+    class Set
+      def initialize(handlers = [])
+        @handlers = handlers
+      end
+
+      def resolve(response, client)
+        custom = @handlers.find do |handler|
+          obj = handler.call(response, client)
+          break obj if obj
+          nil
+        end
+        # if no handler found,
+        # return raw Faraday response
+        custom || response
+      end
+
+      def append(handler)
+        @handlers << handler
+      end
+
+      def prepend(handler)
+        @handlers.unshift handler
+      end
+
+      def to_a
+        @handlers
+      end
+    end
+
+    JSON_MIME_EXP = /^application\/json/.freeze
+    IMAGE_MIME_EXP = /^image\//.freeze
+    CONTENT_TYPE = 'Content-Type'.freeze
+    IO = Struct.new(:io, :file_name, :mime_type) do
+      def read
+        io.read
+      end
+    end
+
+    Hal = Proc.new do |resp, client|
+      if resp.headers[CONTENT_TYPE] =~ JSON_MIME_EXP
+        data = ::JSON.parse(resp.body)
+        Entity.new(data, client)
+      end
+    end
+
+    File = Proc.new do |resp, client|
+      if resp.headers[CONTENT_TYPE] =~ IMAGE_MIME_EXP
+        fname = ::File.basename(resp.env[:url].to_s)
+        IO.new(
+          StringIO.new(resp.body),
+          fname,
+          resp.headers[CONTENT_TYPE]
+        )
+      end
+    end
+  end
+end

data/lib/bootic_client/strategies/authorized.rb

@@ -4,10 +4,10 @@ module BooticClient
   module Strategies
 
     class Authorized < Oauth2Strategy
-      protected
+      private
 
       def validate!
-        raise ArgumentError, "options MUST include access_token" unless options[:access_token]
+        raise ArgumentError, 'options MUST include access_token' unless options[:access_token]
       end
 
       def get_token

data/lib/bootic_client/strategies/basic_auth.rb

@@ -8,11 +8,11 @@ module BooticClient
         %(#<#{self.class.name} root: #{config.api_root} username: #{options[:username]}>)
       end
 
-      protected
+      private
 
       def validate!
-        raise ArgumentError, "options MUST include username" unless options[:username]
-        raise ArgumentError, "options MUST include password" unless options[:password]
+        raise ArgumentError, 'options MUST include username' unless options[:username]
+        raise ArgumentError, 'options MUST include password' unless options[:password]
       end
 
       def client

data/lib/bootic_client/strategies/bearer.rb

@@ -7,7 +7,7 @@ module BooticClient
       private
 
       def validate!
-        raise ArgumentError, "options MUST include access_token" unless options[:access_token]
+        raise ArgumentError, 'options MUST include access_token' unless options[:access_token]
       end
 
       def request_headers

data/lib/bootic_client/strategies/client_credentials.rb

@@ -4,7 +4,7 @@ module BooticClient
   module Strategies
 
     class ClientCredentials < Oauth2Strategy
-      protected
+      private
 
       def get_token
         opts = {}

data/lib/bootic_client/strategies/oauth2_strategy.rb

@@ -10,12 +10,12 @@ module BooticClient
         %(#<#{self.class.name} cid: #{config.client_id} root: #{config.api_root} auth: #{config.auth_host}>)
       end
 
-      protected
+      private
 
       def validate!
-        raise ArgumentError, "MUST include client_id" unless config.client_id
-        raise ArgumentError, "MUST include client_secret" unless config.client_secret
-        raise ArgumentError, "MUST include api_root" unless config.api_root
+        raise ArgumentError, 'MUST include client_id' unless config.client_id
+        raise ArgumentError, 'MUST include client_secret' unless config.client_secret
+        raise ArgumentError, 'MUST include api_root' unless config.api_root
       end
 
       def pre_flight

data/lib/bootic_client/strategies/strategy.rb

@@ -6,25 +6,27 @@ module BooticClient
 
       def initialize(config, client_opts = {}, &on_new_token)
         @config, @options, @on_new_token = config, client_opts, (on_new_token || Proc.new{})
+        raise ArgumentError, 'must include a Configuration object' unless config
         validate!
       end
 
       def root
-        request_and_wrap :get, config.api_root, Entity
+        request_and_wrap :get, config.api_root
       end
 
       def from_hash(hash, wrapper_class = Entity)
         wrapper_class.new hash, self
       end
 
-      def from_url(url, wrapper_class = Entity)
-        request_and_wrap :get, url, wrapper_class
+      def from_url(url)
+        request_and_wrap :get, url
       end
 
-      def request_and_wrap(request_method, href, wrapper_class, payload = {})
+      def request_and_wrap(request_method, href, payload = {})
         pre_flight
         retryable do
-          wrapper_class.new client.send(request_method, href, payload, request_headers).body, self
+          resp = client.send(request_method, href, payload, request_headers)
+          config.response_handlers.resolve(resp, self)
         end
       end
 

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.21".freeze
+  VERSION = "0.0.22".freeze
 end

data/lib/bootic_client.rb

@@ -3,85 +3,30 @@ require "bootic_client/version"
 require "bootic_client/entity"
 require "bootic_client/relation"
 require "bootic_client/client"
+require "bootic_client/configuration"
 
 module BooticClient
-  InvalidConfigurationError = Class.new(StandardError)
-  VERY_BASIC_URL_CHECK = /^(http|https):/.freeze
-
-  AUTH_HOST = 'https://auth.bootic.net'.freeze
-  API_ROOT = 'https://api.bootic.net/v1'.freeze
-
   class << self
-    attr_accessor :logging
-    attr_reader :client_id, :client_secret, :cache_store, :user_agent
-
     def strategies
       @strategies ||= {}
     end
 
     def client(strategy_name, client_opts = {}, &on_new_token)
       opts = client_opts.dup
-      opts[:logging] = logging
-      opts[:logger] = logger if logging
-      opts[:cache_store] = cache_store if cache_store
-      opts[:user_agent] = user_agent if user_agent
+      opts[:logging] = configuration.logging
+      opts[:logger] = configuration.logger if configuration.logging
+      opts[:cache_store] = configuration.cache_store if configuration.cache_store
+      opts[:user_agent] = configuration.user_agent if configuration.user_agent
       require "bootic_client/strategies/#{strategy_name}"
-      strategies.fetch(strategy_name.to_sym).new self, opts, &on_new_token
-    end
-
-    def user_agent=(v)
-      set_non_nil :user_agent, v
-    end
-
-    def client_id=(v)
-      set_non_nil :client_id, v
-    end
-
-    def client_secret=(v)
-      set_non_nil :client_secret, v
-    end
-
-    def cache_store=(v)
-      set_non_nil :cache_store, v
-    end
-
-    def auth_host=(v)
-      check_url! :auth_host, v
-      set_non_nil :auth_host, v
-    end
-
-    def api_root=(v)
-      check_url! :api_root, v
-      set_non_nil :api_root, v
-    end
-
-    def logger=(v)
-      set_non_nil :logger, v
-    end
-
-    def auth_host
-      @auth_host || AUTH_HOST
-    end
-
-    def api_root
-      @api_root || API_ROOT
-    end
-
-    def logger
-      @logger || ::Logger.new(STDOUT)
+      strategies.fetch(strategy_name.to_sym).new configuration, opts, &on_new_token
     end
 
     def configure(&block)
-      yield self
-    end
-
-    def set_non_nil(name, v)
-      raise InvalidConfigurationError, "#{name} cannot be nil" if v.nil?
-      instance_variable_set("@#{name}", v)
+      yield configuration
     end
 
-    def check_url!(name, v)
-      raise InvalidConfigurationError, "#{name} must be a valid URL" unless v.to_s =~ VERY_BASIC_URL_CHECK
+    def configuration
+      @configuration ||= Configuration.new
     end
   end
 end

data/spec/authorized_strategy_spec.rb

@@ -6,6 +6,7 @@ describe 'BooticClient::Strategies::Authorized' do
 
   let(:client_id) {'aaa'}
   let(:client_secret) {'bbb'}
+  let(:response_headers) { {'Content-Type' => 'application/json'} }
 
   def jwt_assertion(expired_token, now)
     JWT.encode({
@@ -19,7 +20,7 @@ describe 'BooticClient::Strategies::Authorized' do
   def stub_api_root(access_token, status, body)
     stub_request(:get, "https://api.bootic.net/v1").
       with(headers: {'Accept'=>'application/json', 'Authorization' => "Bearer #{access_token}"}).
-      to_return(status: status, :body => JSON.dump(body))
+      to_return(status: status, :headers => response_headers, :body => JSON.dump(body))
   end
 
   def stub_auth(expired_token, status, body, client_id: '', client_secret: '', scope: '')
@@ -127,12 +128,12 @@ describe 'BooticClient::Strategies::Authorized' do
         stub_api_root('abc', 200, root_data)
         @unauthorized_request = stub_request(:get, "https://api.bootic.net/v1/shops").
           with(headers: {'Accept'=>'application/json', 'Authorization' => "Bearer abc"}).
-          to_return(status: 401, :body => JSON.dump(message: 'authorized'))
+          to_return(status: 401, headers: response_headers, :body => JSON.dump(message: 'authorized'))
         @auth_request = stub_auth('abc', 200, access_token: 'validtoken')
 
         @authorized_request = stub_request(:get, "https://api.bootic.net/v1/shops").
           with(headers: {'Accept'=>'application/json', 'Authorization' => "Bearer validtoken"}).
-          to_return(status: 200, :body => JSON.dump(title: 'All shops'))
+          to_return(status: 200, headers: response_headers, :body => JSON.dump(title: 'All shops'))
         @root = client.root
       end
 
@@ -157,7 +158,7 @@ describe 'BooticClient::Strategies::Authorized' do
     describe '#from_url' do
       it 'builds and returns an entity' do
         authorized_request = stub_request(:get, "https://api.bootic.net/v1/shops").
-          to_return(status: 200, :body => JSON.dump(title: 'All shops'))
+          to_return(status: 200, headers: response_headers, :body => JSON.dump(title: 'All shops'))
 
         entity = client.from_url('https://api.bootic.net/v1/shops')
         expect(entity).to be_kind_of(BooticClient::Entity)

data/spec/basic_auth_strategy_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe 'BooticClient::Strategies::BasicAuth' do
   require 'webmock/rspec'
 
+  let(:response_headers) { {'Content-Type' => 'application/json'} }
   let(:root_data) {
     {
       '_links' => {
@@ -34,8 +35,9 @@ describe 'BooticClient::Strategies::BasicAuth' do
 
   context 'with invalid BasicAuth credentials' do
     let!(:root_request) do
-      stub_request(:get, 'https://foo:bar@api.bootic.net/v1')
-        .to_return(status: 401, body: JSON.dump(root_data))
+      stub_request(:get, 'https://api.bootic.net/v1')
+        .with(basic_auth: ['foo', 'bar'])
+        .to_return(status: 401, headers: response_headers, body: JSON.dump(root_data))
     end
 
     it 'raises an Unauthorized error' do
@@ -46,13 +48,15 @@ describe 'BooticClient::Strategies::BasicAuth' do
 
   context 'with valid BasicAuth credentials' do
     let!(:root_request) do
-      stub_request(:get, 'https://foo:bar@api.bootic.net/v1')
-        .to_return(status: 200, body: JSON.dump(root_data))
+      stub_request(:get, 'https://api.bootic.net/v1')
+        .with(basic_auth: ['foo', 'bar'])
+        .to_return(status: 200, headers: response_headers, body: JSON.dump(root_data))
     end
 
     let!(:product_request) do
-      stub_request(:get, 'https://foo:bar@api.bootic.net/v1/products/1')
-        .to_return(status: 200, body: JSON.dump(product_data))
+      stub_request(:get, 'https://api.bootic.net/v1/products/1')
+        .with(basic_auth: ['foo', 'bar'])
+        .to_return(status: 200, headers: response_headers, body: JSON.dump(product_data))
     end
 
     let!(:root) { client.root }

data/spec/bearer_strategy_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe 'BooticClient::Strategies::Bearer' do
   require 'webmock/rspec'
 
+  let(:response_headers) { {'Content-Type' => 'application/json'} }
   let(:root_data) {
     {
       '_links' => {
@@ -36,7 +37,7 @@ describe 'BooticClient::Strategies::Bearer' do
     let!(:root_request) do
       stub_request(:get, 'https://api.bootic.net/v1')
         .with(headers: {"Authorization" => "Bearer foobar"})
-        .to_return(status: 401, body: JSON.dump(root_data))
+        .to_return(status: 401, headers: response_headers, body: JSON.dump(root_data))
     end
 
     it 'raises an Unauthorized error' do
@@ -49,13 +50,13 @@ describe 'BooticClient::Strategies::Bearer' do
     let!(:root_request) do
       stub_request(:get, 'https://api.bootic.net/v1')
         .with(headers: {"Authorization" => "Bearer foobar"})
-        .to_return(status: 200, body: JSON.dump(root_data))
+        .to_return(status: 200, headers: response_headers, body: JSON.dump(root_data))
     end
 
     let!(:product_request) do
       stub_request(:get, 'https://api.bootic.net/v1/products/1')
         .with(headers: {"Authorization" => "Bearer foobar"})
-        .to_return(status: 200, body: JSON.dump(product_data))
+        .to_return(status: 200, headers: response_headers, body: JSON.dump(product_data))
     end
 
     let!(:root) { client.root }

data/spec/client_credentials_strategy_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe 'BooticClient::Strategies::ClientCredentials' do
   require 'webmock/rspec'
 
+  let(:response_headers) { {'Content-Type' => 'application/json'} }
   let(:store){ Hash.new }
   let(:root_data) {
     {
@@ -15,7 +16,7 @@ describe 'BooticClient::Strategies::ClientCredentials' do
 
   describe 'with missing client credentials' do
     it 'raises error' do
-      allow(BooticClient).to receive(:client_id).and_return nil
+      allow(BooticClient.configuration).to receive(:client_id).and_return nil
       expect{
         BooticClient.client(:client_credentials, scope: 'admin')
       }.to raise_error(ArgumentError)
@@ -33,7 +34,7 @@ describe 'BooticClient::Strategies::ClientCredentials' do
     def stub_api_root(access_token, status, body)
       stub_request(:get, "https://api.bootic.net/v1").
         with(headers: {'Accept'=>'application/json', 'Authorization'=>"Bearer #{access_token}"}).
-        to_return(status: status, body: JSON.dump(body))
+        to_return(status: status, headers: response_headers, body: JSON.dump(body))
     end
 
     before do

data/spec/client_spec.rb

@@ -37,9 +37,7 @@ describe BooticClient::Client do
       def assert_successful_response(response)
         expect(response).to be_kind_of(Faraday::Response)
         expect(response.status).to eql(200)
-        response.body.tap do |b|
-          expect(b['_links']['shops']).to eql({'href' => 'https://api.bootic.net/v1/products'})
-        end
+        expect(response.body).not_to be nil
       end
 
       context 'switching cache key as per Vary header' do
@@ -193,11 +191,11 @@ describe BooticClient::Client do
         before do
           stub_request(:get, root_url)
             .with(query: {foo: 'bar'}, headers: request_headers)
-            .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+            .to_return(status: 200, body: 'abc')
         end
 
         it 'GETs response' do
-          expect(client.get(root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
+          expect(client.get(root_url, {foo: 'bar'}, request_headers).body).to eq 'abc'
         end
       end
 
@@ -209,7 +207,7 @@ describe BooticClient::Client do
         end
 
         it 'POSTs request and parses response' do
-          expect(client.post(root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
+          expect(client.post(root_url, {foo: 'bar'}, request_headers).status).to eq 201
         end
       end
 
@@ -223,18 +221,19 @@ describe BooticClient::Client do
             .to_return(status: 201, body: JSON.dump(root_data), headers: response_headers)
         end
 
-        it 'POSTs request with base64-encoded file and parses response' do
-          expect(client.post(root_url, {foo: 'bar', data: file}, request_headers).body['message']).to eql('Hello!')
+        it 'POSTs request with base64-encoded file' do
+          resp = client.post(root_url, {foo: 'bar', data: file}, request_headers)
+          expect(resp.status).to eq 201
         end
 
         it "works with anything that responds to #read" do
           reader = double("reader", read: File.read(fixture_path("file.gif")))
-          expect(client.post(root_url, {foo: 'bar', data: reader}, request_headers).body['message']).to eql('Hello!')
+          expect(client.post(root_url, {foo: 'bar', data: reader}, request_headers).status).to eq 201
         end
 
         it "works with open-uri" do
           reader = open(fixture_path("file.gif"))
-          expect(client.post(root_url, {foo: 'bar', data: reader}, request_headers).body['message']).to eql('Hello!')
+          expect(client.post(root_url, {foo: 'bar', data: reader}, request_headers).status).to eq 201
         end
       end
 
@@ -243,11 +242,13 @@ describe BooticClient::Client do
           before do
             stub_request(verb, root_url)
               .with(body: JSON.dump({foo: 'bar'}), headers: request_headers)
-              .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+              .to_return(status: 200, body: 'abc', headers: response_headers)
           end
 
-          it "#{verb.to_s.upcase}s request and parses response" do
-            expect(client.send(verb, root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
+          it "#{verb.to_s.upcase}s request" do
+            resp = client.send(verb, root_url, {foo: 'bar'}, request_headers)
+            expect(resp.status).to eq 200
+            expect(resp.body).to eq 'abc'
           end
         end
 
@@ -258,11 +259,13 @@ describe BooticClient::Client do
           before do
             stub_request(verb, root_url)
               .with(body: JSON.dump({foo: 'bar', data: {name: 'la', file: base64_data}}), headers: request_headers)
-              .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+              .to_return(status: 200, body: 'abc', headers: response_headers)
           end
 
-          it "#{verb.to_s.upcase}s request with base64-encoded file data and parses response" do
-            expect(client.send(verb, root_url, {foo: 'bar', data: {name: 'la', file: file}}, request_headers).body['message']).to eql('Hello!')
+          it "#{verb.to_s.upcase}s request with base64-encoded file data" do
+            resp = client.send(verb, root_url, {foo: 'bar', data: {name: 'la', file: file}}, request_headers)
+            expect(resp.status).to eq 200
+            expect(resp.body).to eq 'abc'
           end
         end
       end

data/spec/configuration_spec.rb

@@ -1,63 +1,75 @@
 require 'spec_helper'
 
-describe BooticClient do
-  it "raises if nil client_id" do
-    expect {
-      BooticClient.configure do |c|
-        c.client_id = nil
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
-  end
+describe BooticClient::Configuration do
+  context 'errors' do
+    it "raises if nil client_id" do
+      expect {
+        BooticClient.configure do |c|
+          c.client_id = nil
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
+    end
 
-  it "raises if nil client_secret" do
-    expect {
-      BooticClient.configure do |c|
-        c.client_secret = nil
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
-  end
+    it "raises if nil client_secret" do
+      expect {
+        BooticClient.configure do |c|
+          c.client_secret = nil
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
+    end
 
-  it "raises if nil cache_store" do
-    expect {
-      BooticClient.configure do |c|
-        c.cache_store = nil
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
-  end
+    it "raises if nil cache_store" do
+      expect {
+        BooticClient.configure do |c|
+          c.cache_store = nil
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
+    end
 
-  it "raises if nil or invalid auth_host" do
-    expect {
-      BooticClient.configure do |c|
-        c.auth_host = nil
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
+    it "raises if nil or invalid auth_host" do
+      expect {
+        BooticClient.configure do |c|
+          c.auth_host = nil
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
 
-    expect {
-      BooticClient.configure do |c|
-        c.auth_host = 'not-a-url'
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
-  end
+      expect {
+        BooticClient.configure do |c|
+          c.auth_host = 'not-a-url'
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
+    end
 
-  it "raises if nil or invalid api_root" do
-    expect {
-      BooticClient.configure do |c|
-        c.api_root = nil
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
+    it "raises if nil or invalid api_root" do
+      expect {
+        BooticClient.configure do |c|
+          c.api_root = nil
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
 
-    expect {
-      BooticClient.configure do |c|
-        c.api_root = 'not-a-url'
-      end
-    }.to raise_error BooticClient::InvalidConfigurationError
+      expect {
+        BooticClient.configure do |c|
+          c.api_root = 'not-a-url'
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
+    end
+
+    it "raises if nil logger" do
+      expect {
+        BooticClient.configure do |c|
+          c.logger = nil
+        end
+      }.to raise_error BooticClient::InvalidConfigurationError
+    end
   end
 
-  it "raises if nil logger" do
-    expect {
-      BooticClient.configure do |c|
-        c.logger = nil
+  context 'instance' do
+    subject(:config) { described_class.new }
+
+    describe '#response_handlers' do
+      it 'includes Entity handler by default' do
+        expect(config.response_handlers.to_a.first).not_to be_nil
       end
-    }.to raise_error BooticClient::InvalidConfigurationError
+    end
   end
 end

data/spec/entity_spec.rb

@@ -9,7 +9,8 @@ describe BooticClient::Entity do
       'page' => 1,
       'an_object' => {
         'name' => 'Foobar',
-        'age' => 22
+        'age' => 22,
+        'another_object' => {'foo' => 'bar'}
       },
       '_links' => {
         'self' => {'href' => '/foo'},
@@ -74,8 +75,11 @@ describe BooticClient::Entity do
     end
 
     it 'wraps object properties as entities' do
+      expect(entity.an_object).to be_a described_class
       expect(entity.an_object.name).to eql('Foobar')
       expect(entity.an_object.age).to eql(22)
+      expect(entity.an_object.another_object).to be_a described_class
+      expect(entity.an_object.another_object.foo).to eq 'bar'
     end
 
     it 'has a #properties object' do
@@ -160,7 +164,7 @@ describe BooticClient::Entity do
         let(:next_page) { BooticClient::Entity.new({'page' => 2}, client) }
 
         it 'exposes link target resources as normal properties' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/foo?page=2', BooticClient::Entity, {}).and_return next_page
+          expect(client).to receive(:request_and_wrap).with(:get, '/foo?page=2', {}).and_return next_page
           entity.next.tap do |next_entity|
             expect(next_entity).to be_kind_of(BooticClient::Entity)
             expect(next_entity.page).to eql(2)
@@ -168,7 +172,7 @@ describe BooticClient::Entity do
         end
 
         it 'takes optional URI parameters' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/search?q=foo', BooticClient::Entity, {}).and_return next_page
+          expect(client).to receive(:request_and_wrap).with(:get, '/search?q=foo', {}).and_return next_page
           entity.search(q: 'foo').tap do |next_entity|
             expect(next_entity).to be_kind_of(BooticClient::Entity)
             expect(next_entity.page).to eql(2)
@@ -222,8 +226,8 @@ describe BooticClient::Entity do
       let(:page_2) { BooticClient::Entity.new(page_2_data, client) }
 
       it 'lazily enumerates entries across pages, making as little requests as possible' do
-        expect(client).to receive(:request_and_wrap).with(:get, '/foo?page=2', BooticClient::Entity, {}).and_return page_2
-        expect(client).to_not receive(:request_and_wrap).with(:get, '/foo?page=3', BooticClient::Entity, {})
+        expect(client).to receive(:request_and_wrap).with(:get, '/foo?page=2', {}).and_return page_2
+        expect(client).to_not receive(:request_and_wrap).with(:get, '/foo?page=3', {})
         results = entity.full_set.first(4)
         titles = results.map(&:title)
         expect(titles).to match_array(['iPhone 4', 'iPhone 5', 'Item 3', 'Item 4'])

data/spec/relation_spec.rb

@@ -26,7 +26,7 @@ describe BooticClient::Relation do
 
     describe 'running GET by default' do
       it 'fetches data and returns entity' do
-        allow(client).to receive(:request_and_wrap).with(:get, '/foo/bars', BooticClient::Entity, {}).and_return entity
+        allow(client).to receive(:request_and_wrap).with(:get, '/foo/bars', {}).and_return entity
         expect(relation.run).to eql(entity)
       end
 
@@ -42,7 +42,7 @@ describe BooticClient::Relation do
         end
 
         it 'passes query string to client' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/foos/bar', BooticClient::Entity, id: 2, q: 'test', page: 2).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/bar', id: 2, q: 'test', page: 2).and_return entity
           expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
         end
       end
@@ -61,7 +61,7 @@ describe BooticClient::Relation do
         end
 
         it 'works with defaults' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/foos/123', BooticClient::Entity, {}).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/123', {}).and_return entity
           expect(relation.run(id: 123)).to eql(entity)
         end
 
@@ -70,7 +70,7 @@ describe BooticClient::Relation do
         end
 
         it 'interpolates tokens' do
-          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=2', BooticClient::Entity, {}).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=2', {}).and_return entity
           expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
         end
 
@@ -92,7 +92,7 @@ describe BooticClient::Relation do
             client,
           )
 
-          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=3', BooticClient::Entity, {foo: 1}).and_return entity
+          expect(client).to receive(:request_and_wrap).with(:get, '/foos/2?q=test&page=3', {foo: 1}).and_return entity
 
           relation.run(id: 2, q: 'test', page: 3, foo: 1)
 
@@ -106,12 +106,12 @@ describe BooticClient::Relation do
       let(:relation_templated) { BooticClient::Relation.new({'href' => '/foo/{bars}', 'templated' => true, 'type' => 'application/json', 'name' => 'self', 'method' => 'post'}, client) }
 
       it 'POSTS data and returns resulting entity' do
-        allow(client).to receive(:request_and_wrap).with(:post, '/foo/bars', BooticClient::Entity, {}).and_return entity
+        allow(client).to receive(:request_and_wrap).with(:post, '/foo/bars', {}).and_return entity
         expect(relation.run).to eql(entity)
       end
 
       it 'interpolates templated URLs and sends remaining as BODY' do
-        allow(client).to receive(:request_and_wrap).with(:post, '/foo/123', BooticClient::Entity, {foo: 'bar'}).and_return entity
+        allow(client).to receive(:request_and_wrap).with(:post, '/foo/123', {foo: 'bar'}).and_return entity
         expect(relation_templated.run(bars: 123, foo: 'bar')).to eql(entity)
       end
     end
@@ -120,7 +120,7 @@ describe BooticClient::Relation do
       let(:relation) { BooticClient::Relation.new({'href' => '/foo/bars', 'type' => 'application/json', 'name' => 'self', 'method' => 'delete'}, client) }
 
       it 'DELETEs data and returns resulting entity' do
-        allow(client).to receive(:request_and_wrap).with(:delete, '/foo/bars', BooticClient::Entity, {}).and_return entity
+        allow(client).to receive(:request_and_wrap).with(:delete, '/foo/bars', {}).and_return entity
         expect(relation.run).to eql(entity)
       end
     end

data/spec/response_handlers_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'bootic_client/response_handlers'
+
+describe BooticClient::ResponseHandlers::Set do
+  let(:h1) do
+    Proc.new do |resp, _client|
+      if resp.headers['Content-Type'] =~ /json/
+        'H1'
+      end
+    end
+  end
+  let(:h2) do
+    Proc.new do |resp, _client|
+      if resp.headers['Content-Type'] =~ /text/
+        'H2'
+      end
+    end
+  end
+  let(:h3) do
+    Proc.new do |resp, _client|
+      if resp.headers['Content-Type'] =~ /json/
+        'H3'
+      end
+    end
+  end
+
+  it 'initializes with default handlers' do
+    set = described_class.new([h1])
+    expect(set.to_a).to eq [h1]
+  end
+
+  describe '#resolve' do
+    it 'finds first matching handler and returns result' do
+      set = described_class.new([h1, h2, h3])
+
+      text_resp = instance_double(::Faraday::Response, headers: {'Content-Type' => 'text/plain'})
+      expect(set.resolve(text_resp, nil)).to eq 'H2'
+
+      json_resp = instance_double(::Faraday::Response, headers: {'Content-Type' => 'application/json'})
+      expect(set.resolve(json_resp, nil)).to eq 'H1'
+    end
+
+    it 'returns raw response if no handler found' do
+      set = described_class.new([h1, h2, h3])
+      img_resp = instance_double(::Faraday::Response, headers: {'Content-Type' => 'image/jpeg'})
+      expect(set.resolve(img_resp, nil)).to eq img_resp
+    end
+  end
+
+  describe '#append' do
+    it 'adds handlers' do
+      set = described_class.new
+
+      text_resp = instance_double(::Faraday::Response, headers: {'Content-Type' => 'text/plain'})
+      expect(set.resolve(text_resp, nil)).to eq text_resp
+
+      set.append(h2)
+      expect(set.resolve(text_resp, nil)).to eq 'H2'
+    end
+  end
+
+  describe '#prepend' do
+    it 'prepends handlers' do
+      set = described_class.new([h1, h2])
+
+      json_resp = instance_double(::Faraday::Response, headers: {'Content-Type' => 'application/json'})
+      expect(set.resolve(json_resp, nil)).to eq 'H1'
+
+      set.prepend(h3)
+      expect(set.resolve(json_resp, nil)).to eq 'H3'
+    end
+  end
+end

data/spec/strategy_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'bootic_client/strategies/strategy'
+
+describe BooticClient::Strategies::Strategy do
+  require 'webmock/rspec'
+
+  let(:config) { BooticClient::Configuration.new }
+  subject(:strategy) { described_class.new(config) }
+
+  describe '#request_and_wrap' do
+    context 'response is JSON' do
+      let(:resp_data) do
+        {
+          'name' => 'Jason'
+        }
+      end
+
+      before do
+        stub_request(:get, 'https://a.server.com/foo')
+          .to_return(status: 200, body: JSON.dump(resp_data), headers: {'Content-Type' => 'application/json'})
+      end
+
+      it 'returns the raw response' do
+        resp = strategy.request_and_wrap(:get, 'https://a.server.com/foo')
+        expect(resp).to be_a(BooticClient::Entity)
+        expect(resp.name).to eq 'Jason'
+      end
+    end
+
+    context 'response type is not handled' do
+      before do
+        stub_request(:get, 'https://a.server.com/foo')
+          .to_return(status: 200, body: 'abc', headers: {'Content-Type' => 'text/plain'})
+      end
+
+      it 'returns the raw response' do
+        resp = strategy.request_and_wrap(:get, 'https://a.server.com/foo')
+        expect(resp).to be_a(Faraday::Response)
+        expect(resp.body).to eq 'abc'
+        expect(resp.status).to eq 200
+      end
+
+      it 'uses available request handlers' do
+        custom_resp = Struct.new(:message)
+
+        config.response_handlers.append(Proc.new { |resp, client|
+          if resp.headers['Content-Type'] == 'text/plain'
+            custom_resp.new(resp.body)
+          end
+        })
+
+        resp = strategy.request_and_wrap(:get, 'https://a.server.com/foo')
+        expect(resp).to be_a custom_resp
+        expect(resp.message).to eq 'abc'
+      end
+    end
+
+    context 'response is an image' do
+      before do
+        stub_request(:get, 'https://a.server.com/a/b/foo.jpg')
+          .to_return(status: 200, body: 'abc', headers: {'Content-Type' => 'image/jpeg'})
+      end
+
+      it 'returns an IO-like object' do
+        img = strategy.request_and_wrap(:get, 'https://a.server.com/a/b/foo.jpg')
+        expect(img.io).to be_a StringIO
+        expect(img.read).to eq 'abc'
+        expect(img.file_name).to eq 'foo.jpg'
+        expect(img.mime_type).to eq 'image/jpeg'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2019-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -183,9 +183,11 @@ files:
 - bootic_client.gemspec
 - lib/bootic_client.rb
 - lib/bootic_client/client.rb
+- lib/bootic_client/configuration.rb
 - lib/bootic_client/entity.rb
 - lib/bootic_client/errors.rb
 - lib/bootic_client/relation.rb
+- lib/bootic_client/response_handlers.rb
 - lib/bootic_client/stores/memcache.rb
 - lib/bootic_client/strategies/authorized.rb
 - lib/bootic_client/strategies/basic_auth.rb
@@ -206,7 +208,9 @@ files:
 - spec/fixtures/file.gif
 - spec/memcache_storage_spec.rb
 - spec/relation_spec.rb
+- spec/response_handlers_spec.rb
 - spec/spec_helper.rb
+- spec/strategy_spec.rb
 - spec/whiny_uri_spec.rb
 homepage: https://developers.bootic.net
 licenses:
@@ -228,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Official Ruby client for the Bootic API
@@ -244,5 +248,7 @@ test_files:
 - spec/fixtures/file.gif
 - spec/memcache_storage_spec.rb
 - spec/relation_spec.rb
+- spec/response_handlers_spec.rb
 - spec/spec_helper.rb
+- spec/strategy_spec.rb
 - spec/whiny_uri_spec.rb