finapps 2.0.6 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3744a2198661b2f9ec29349d7fab215fec21ca59
-  data.tar.gz: 89aa372c099626f02b74029badf483e8a8b5f857
+  metadata.gz: bcf4ea9c9605ea437a7c813888251d0ade6c48ff
+  data.tar.gz: 4566ea877d76bfd844191fa425dc520bb72a63d1
 SHA512:
-  metadata.gz: 75115e8917ab7e2f6ca094113a7412d31e5f2aac5372b854a9218495de744d5b3f7d26be8a2b5564aab82a828359980df8b380b4d2090cf712079ce9c29f5b75
-  data.tar.gz: f0962398b0663b53931eb3a5ee11f665c2f5f8b9ac906d6eaeb4b35e9c18a1be72a96b7ee1344defeb18b4628ca0e914c7a12f0d192a137ac99b9e9ce84e4f2e
+  metadata.gz: 1370d0de8ce5510d1defe65b08caf38c7a10d0ed507d38040ff3e6a5e6e75b2b4f7582ff02728c660c1082a271f0a9d3e09fa59e3dc9458779ff741cbf669cbb
+  data.tar.gz: 240d6213a3f48f1eb9395c9050754f74dc4eeabb4a8e2697fa92901ebf61c50a6d8a100c1f2d32d3abf8ba7913c9358f4c380f404f4d09e496c38bc6975b7c23

data/.codeclimate.yml

@@ -1,15 +1,12 @@
 engines:
   rubocop:
     enabled: true
-    #checks:
-    # Rubocop/Metrics/ClassLength:
-    #   enabled: false
   brakeman:
-    enabled: true
+    enabled: false
   eslint:
-    enabled: true
+    enabled: false
   csslint:
-    enabled: true
+    enabled: false
   duplication:
     enabled: true
     config:

data/Gemfile

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 gemspec

data/Rakefile

@@ -1 +1,2 @@
+# frozen_string_literal: true
 import './lib/tasks/releaser.rake'

data/finapps.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'finapps/version'
@@ -20,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['spec/**/*.rb']
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.6'
   spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9.2'
   spec.add_runtime_dependency 'faraday_middleware', '~> 0.10', '>= 0.10.0'
   spec.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.2'

data/lib/core_extensions/hash/compact.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module HashExtensions
+  refine Hash do
+    # Returns a hash with non +nil+ values.
+    #
+    #   hash = { a: true, b: false, c: nil}
+    #   hash.compact # => { a: true, b: false}
+    #   hash # => { a: true, b: false, c: nil}
+    #   { c: nil }.compact # => {}
+    def compact
+      select {|_, value| !value.nil? }
+    end
+
+    # Replaces current hash with non +nil+ values.
+    #
+    #   hash = { a: true, b: false, c: nil}
+    #   hash.compact! # => { a: true, b: false}
+    #   hash # => { a: true, b: false}
+    def compact!
+      reject! {|_, value| value.nil? }
+    end
+  end
+end

data/lib/core_extensions/object/blank.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module ObjectExtensions
+  refine Object do
+    # An object is blank if it's false, empty, or a whitespace string.
+    # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+    #
+    # This simplifies
+    #
+    #   !address || address.empty?
+    #
+    # to
+    #
+    #   address.blank?
+    #
+    # @return [true, false]
+    def blank?
+      respond_to?(:empty?) ? !!empty? : !self
+    end
+
+    # An object is present if it's not blank.
+    #
+    # @return [true, false]
+    def present?
+      !blank?
+    end
+
+    # Returns the receiver if it's present otherwise returns +nil+.
+    # <tt>object.presence</tt> is equivalent to
+    #
+    #    object.present? ? object : nil
+    #
+    # For example, something like
+    #
+    #   state   = params[:state]   if params[:state].present?
+    #   country = params[:country] if params[:country].present?
+    #   region  = state || country || 'US'
+    #
+    # becomes
+    #
+    #   region = params[:state].presence || params[:country].presence || 'US'
+    #
+    # @return [Object]
+    def presence
+      self if present?
+    end
+  end
+end
+
+module StringExtensions
+  refine String do
+    BLANK_RE = /\A[[:space:]]*\z/
+
+    # A string is blank if it's empty or contains whitespaces only:
+    #
+    #   ''.blank?       # => true
+    #   '   '.blank?    # => true
+    #   "\t\n\r".blank? # => true
+    #   ' blah '.blank? # => false
+    #
+    # Unicode whitespace is supported:
+    #
+    #   "\u00a0".blank? # => true
+    #
+    # @return [true, false]
+    def blank?
+      match BLANK_RE
+    end
+  end
+end

data/lib/core_extensions/object/is_integer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ObjectExtensions
+  refine Object do
+    def integer?
+      Integer(self)
+    rescue
+      false
+    else
+      true
+    end
+  end
+end

data/lib/finapps.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'finapps/version' unless defined?(FinApps::VERSION)
 
 require 'faraday'
@@ -5,15 +6,17 @@ require 'faraday_middleware'
 require 'typhoeus'
 require 'typhoeus/adapters/faraday'
 
-require 'active_support/core_ext/hash/compact'
-require 'active_support/core_ext/object/blank'
-require 'finapps/core_extensions/integerable'
-require 'finapps/hash_constructable'
+require 'core_extensions/hash/compact'
+require 'core_extensions/object/blank'
+require 'core_extensions/object/is_integer'
 require 'finapps/utils/loggeable'
 require 'finapps/error'
 
-require 'finapps/middleware/tenant_authentication'
-require 'finapps/middleware/raise_error'
+require 'finapps/middleware/request/tenant_authentication'
+require 'finapps/middleware/request/accept_json'
+require 'finapps/middleware/request/user_agent'
+require 'finapps/middleware/response/raise_error'
+require 'finapps/middleware/middleware'
 
 require 'finapps/rest/defaults'
 require 'finapps/rest/resources'
@@ -22,6 +25,7 @@ require 'finapps/rest/users'
 require 'finapps/rest/orders'
 
 require 'finapps/rest/configuration'
+require 'finapps/rest/credentials'
 require 'finapps/rest/connection'
 require 'finapps/rest/base_client'
 require 'finapps/rest/client'

data/lib/finapps/error.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+# Defines some errors to identify Exceptions within this gem
 module FinApps # :nodoc:
+  # Base error class.
   class Error < StandardError; end
+  # Raised for existing but invalid arguments.
   class InvalidArgumentsError < Error; end
+  # Raised whenever a required argument is missing.
   class MissingArgumentsError < Error; end
 
   %i(InvalidArgumentsError MissingArgumentsError).each {|const| Error.const_set(const, FinApps.const_get(const)) }

data/lib/finapps/middleware/middleware.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'faraday' unless defined? Faraday
+
+module FinApps
+  module Middleware
+    autoload :AcceptJson, 'finapps/middleware/request/accept_json'
+    autoload :UserAgent, 'finapps/middleware/request/user_agent'
+    autoload :TenantAuthentication, 'finapps/middleware/request/tenant_authentication'
+
+    if Faraday::Middleware.respond_to? :register_middleware
+      Faraday::Request.register_middleware \
+        accept_json: -> { AcceptJson },
+        user_agent: -> { UserAgent },
+        tenant_authentication: -> { TenantAuthentication }
+    end
+  end
+end

data/lib/finapps/middleware/request/accept_json.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module FinApps
+  module Middleware
+    # This middleware sets the Accept request-header field to specify JSON as acceptable media type for the response.
+    class AcceptJson < Faraday::Middleware
+      KEY = 'Accept' unless defined? KEY
+
+      def call(env)
+        env[:request_headers][KEY] = 'application/json'
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps/middleware/{tenant_authentication.rb → request/tenant_authentication.rb}

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 module FinApps
   module Middleware
     # Adds a custom header for tenant level authorization.
     # If the value for this header already exists, it is not overriden.
     class TenantAuthentication < Faraday::Middleware
-      KEY = 'X-FinApps-Token'.freeze unless defined? KEY
+      KEY = 'X-FinApps-Token' unless defined? KEY
 
-      def initialize(app, options={})
+      def initialize(app, identifier, token)
         super(app)
-        @header_value = "#{options[:identifier].to_s.strip}=#{options[:token].to_s.strip}"
+        @header_value = "#{identifier.to_s.strip}=#{token.to_s.strip}"
       end
 
       def call(env)

data/lib/finapps/middleware/request/user_agent.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module FinApps
+  module Middleware
+    # This middleware sets the User-Agent request-header field to identify thei client.
+    class UserAgent < Faraday::Middleware
+      KEY = 'User-Agent' unless defined? KEY
+      RUBY = "#{RUBY_ENGINE}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+
+      def call(env)
+        env[:request_headers][KEY] = "finapps-ruby/#{FinApps::VERSION} (#{RUBY})"
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps/middleware/{raise_error.rb → response/raise_error.rb}

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 module FinApps
   module Middleware
     class RaiseError < Faraday::Response::Middleware # :nodoc:
+      using ObjectExtensions
+      using StringExtensions
       include FinApps::Utils::Loggeable
 
       CLIENT_ERROR_STATUSES = 400...600
@@ -31,9 +34,9 @@ module FinApps
       private
 
       def error_messages(body)
-        return nil unless body.present?
+        return nil if body.blank?
         body = parse_string(body) if body.is_a?(String)
-        body.is_a?(Hash) ? body['messages'].presence : nil
+        body.is_a?(Hash) && body.key?('messages') ? body['messages'] : nil
       end
 
       def parse_string(body)

data/lib/finapps/rest/base_client.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
 module FinApps
   module REST
-    class BaseClient # :nodoc:
+    # base client functionality
+    class BaseClient
       include ::FinApps::Utils::Loggeable
+      include ::FinApps::REST::Connection
+      using ObjectExtensions
+      using StringExtensions
 
       attr_reader :config
 
-      def initialize(options={}, logger=nil)
+      def initialize(options, logger=nil)
         @config = FinApps::REST::Configuration.new options
         @logger = logger
       end
@@ -14,7 +19,7 @@ module FinApps
       #
       # @return Faraday::Connection.
       def connection
-        @connection ||= FinApps::REST::Connection.faraday(config, logger)
+        @connection ||= faraday(config, logger)
       end
 
       # Performs HTTP GET, POST, UPDATE and DELETE requests.
@@ -30,11 +35,11 @@ module FinApps
         raise FinApps::MissingArgumentsError.new 'Missing argument: method.' if method.blank?
 
         response, error_messages = execute_request(method, params, path)
-        result = if response.present?
-                   block_given? ? yield(response) : response.body
-                 else
+        result = if response.blank?
                    logger.error "##{__method__} => Null response found. Unable to process it."
                    nil
+                 else
+                   block_given? ? yield(response) : response.body
                  end
 
         [result, error_messages]
@@ -44,25 +49,36 @@ module FinApps
 
       def execute_request(method, params, path)
         error_messages = []
-
         begin
           response = execute_method method, params, path
         rescue FinApps::InvalidArgumentsError,
                FinApps::MissingArgumentsError,
                Faraday::Error::ConnectionFailed => error
-          logger.fatal "##{__method__} => #{error}"
-          raise error
+          handle_error error
         rescue Faraday::Error::ClientError => error
-          error_messages = error.response[:error_messages].blank? ? [error.message] : error.response[:error_messages]
-          logger.error "##{__method__} => Faraday::Error::ClientError, #{error}"
+          error_messages = handle_client_error error
         rescue StandardError => error
-          error_messages << 'Unexpected error.'
-          logger.fatal "##{__method__} => StandardError, #{error}"
+          error_messages = handle_standard_error error
         end
 
         [response, error_messages]
       end
 
+      def handle_error(error)
+        logger.fatal "#{self.class}##{__method__} => #{error}"
+        raise error
+      end
+
+      def handle_client_error(error)
+        logger.error "#{self.class}##{__method__} => Faraday::Error::ClientError, #{error}"
+        error.response[:error_messages] || [error.message]
+      end
+
+      def handle_standard_error(error)
+        logger.error "#{self.class}##{__method__} => StandardError, #{error}"
+        ['Unexpected error.']
+      end
+
       def execute_method(method, params, path)
         case method
         when :get

data/lib/finapps/rest/client.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 module FinApps
   module REST
     class Client < BaseClient # :nodoc:
+      using ObjectExtensions
+      using StringExtensions
+
       include FinApps::REST::Defaults
 
       # @param [String] tenant_identifier
@@ -11,10 +15,8 @@ module FinApps
         raise FinApps::MissingArgumentsError.new 'Invalid company_identifier.' if tenant_identifier.blank?
         raise FinApps::MissingArgumentsError.new 'Invalid company_token.' if tenant_token.blank?
 
-        merged_options = FinApps::REST::Defaults::DEFAULTS.merge options
-        merged_options[:tenant_credentials] = {identifier: tenant_identifier,
-                                               token:      tenant_token}
-
+        merged_options = FinApps::REST::Defaults::DEFAULTS.merge(options.merge(tenant_identifier: tenant_identifier,
+                                                                               tenant_token: tenant_token))
         super(merged_options, logger)
       end
 

data/lib/finapps/rest/configuration.rb

@@ -1,51 +1,23 @@
+# frozen_string_literal: true
 module FinApps
   module REST
+    # Represents the client configuration options
     class Configuration # :nodoc:
-      include FinApps::HashConstructable
+      using ObjectExtensions
+      using HashExtensions
 
-      using CoreExtensions::Integerable
+      attr_accessor :host,
+                    :tenant_identifier, :tenant_token,
+                    :user_identifier, :user_token,
+                    :proxy, :timeout, :retry_limit, :log_level
 
-      RUBY = "#{RUBY_ENGINE}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}".freeze
-      HEADERS = {
-        accept:     'application/json',
-        user_agent: "finapps-ruby/#{FinApps::VERSION} (#{RUBY})"
-      }.freeze
-
-      attr_accessor :host, :timeout, :tenant_credentials, :user_credentials, :url,
-                    :proxy_addr, :proxy_port, :proxy_user, :proxy_pass,
-                    :retry_limit, :log_level
-
-      def initialize(options)
-        super(options, FinApps::REST::Defaults::DEFAULTS)
-        validate
-        @url = "#{host}/v#{FinApps::REST::Defaults::API_VERSION}/"
-      end
-
-      def connection_options
-        {url:     url,
-         request: {open_timeout: timeout, timeout: timeout},
-         headers: {accept: HEADERS[:accept], user_agent: HEADERS[:user_agent]}}
-      end
-
-      def valid_user_credentials?
-        valid_credentials? user_credentials
-      end
-
-      private
-
-      def validate
-        raise FinApps::MissingArgumentsError.new 'Missing tenant_credentials.' unless valid_tenant_credentials?
+      def initialize(options={})
+        FinApps::REST::Defaults::DEFAULTS.merge(options.compact).each {|key, value| public_send("#{key}=", value) }
         raise FinApps::InvalidArgumentsError.new "Invalid argument. {host: #{host}}" unless valid_host?
         raise FinApps::InvalidArgumentsError.new "Invalid argument. {timeout: #{timeout}}" unless timeout.integer?
       end
 
-      def valid_tenant_credentials?
-        valid_credentials? tenant_credentials
-      end
-
-      def valid_credentials?(h)
-        h.is_a?(Hash) && %i(identifier token).all? {|x| h.key? x } && h.values.all?(&:present?)
-      end
+      private
 
       def valid_host?
         host.start_with?('http://', 'https://')

data/lib/finapps/rest/connection.rb

@@ -1,31 +1,37 @@
+# frozen_string_literal: true
 module FinApps
   module REST
     module Connection # :nodoc:
-      module_function
-
+      # @return [Faraday::Connection]
       def faraday(config, logger)
-        Faraday.new(config.connection_options) do |conn|
-          # tenant level authentication
-          conn.use FinApps::Middleware::TenantAuthentication, config.tenant_credentials
-
-          # user level authentication
-          if config.valid_user_credentials?
-            conn.request :basic_auth, config.user_credentials[:identifier], config.user_credentials[:token]
-          end
+        options = {
+          url: "#{config.host}/v#{Defaults::API_VERSION}/",
+          request: {open_timeout: config.timeout,
+                    timeout: config.timeout}
+        }
 
+        Faraday.new(options) do |conn|
+          conn.request :accept_json
+          conn.request :user_agent
+          conn.request :tenant_authentication, config.tenant_identifier, config.tenant_token
           conn.request :json
           conn.request :retry
           conn.request :multipart
           conn.request :url_encoded
+          if FinApps::REST::Credentials.new(config.user_identifier, config.user_token).valid?
+            conn.request :basic_auth, config.user_identifier, config.user_token
+          end
+
           conn.use FinApps::Middleware::RaiseError
           conn.response :rashify
           conn.response :json, content_type: /\bjson$/
-          conn.response :logger, logger # , bodies: true
+          conn.response :logger, logger, bodies: true
 
           # Adapter (ensure that the adapter is always last.)
           conn.adapter :typhoeus
         end
       end
+      module_function :faraday # becomes available as a *private instance method* to classes that mix in the module
     end
   end
 end

data/lib/finapps/rest/credentials.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module FinApps
+  module REST
+    # represents both tenant and user credentials
+    class Credentials
+      using ObjectExtensions
+      using StringExtensions
+
+      attr_reader :identifier, :token
+
+      def initialize(identifier, token)
+        @identifier = identifier
+        @token = token
+      end
+
+      def valid?
+        identifier.present? && token.present?
+      end
+    end
+  end
+end

data/lib/finapps/rest/defaults.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
 module FinApps
   module REST
     module Defaults
-      API_VERSION = '2'.freeze
+      API_VERSION = '2'
 
       # noinspection SpellCheckingInspection
       DEFAULTS = {
-        host:        'https://dev.financialapps.com',
-        timeout:     30,
-        proxy_addr:  nil,
-        proxy_port:  nil,
-        proxy_user:  nil,
-        proxy_pass:  nil,
-        retry_limit: 1,
-        log_level:   Logger::INFO
+        host:             'https://api.financialapps.com',
+        user_identifier:  nil,
+        user_token:       nil,
+        timeout:          30,
+        proxy:            nil,
+        retry_limit:      1,
+        log_level:        Logger::INFO
       }.freeze
 
       END_POINTS = {

data/lib/finapps/rest/orders.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 module FinApps
   module REST
     class Orders < FinApps::REST::Resources # :nodoc:
+      using ObjectExtensions
+      using StringExtensions
+
       def show(id)
         raise MissingArgumentsError.new 'Missing argument: params.' if id.blank?
         super

data/lib/finapps/rest/resources.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module FinApps
   module REST
     class Resources # :nodoc:
@@ -8,7 +9,7 @@ module FinApps
       # @param [FinApps::REST::Client] client
       # @return [FinApps::REST::Resources]
       def initialize(client)
-        raise MissingArgumentsError.new 'Missing argument: client.' if client.blank?
+        raise MissingArgumentsError.new 'Missing argument: client.' if client.nil?
         @client = client
       end
 

data/lib/finapps/rest/users.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 module FinApps
   module REST
     class Users < FinApps::REST::Resources # :nodoc:
+      using ObjectExtensions
+      using StringExtensions
+
       END_POINTS = {
         list:    nil,
         create:  'users/new',

data/lib/finapps/utils/loggeable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module FinApps
   module Utils
     # Adds logging capabilities when included into other classes

data/lib/finapps/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module FinApps
-  VERSION = '2.0.6'.freeze
+  VERSION = '2.0.10'
 end

data/lib/tasks/releaser.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 desc 'Bumps the version to the next patch level, tags and pushes the code to
 origin repository and releases the gem. BOOM!'
 task :release do

data/spec/middleware/accept_json_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::Middleware::AcceptJson do
+  let(:fake_app) { proc {|env| env } }
+  describe '#call' do
+    subject { FinApps::Middleware::AcceptJson.new(fake_app) }
+    env = {request_headers: {}}
+
+    it('generates a UserAgent header') do
+      expect(subject.call(env)[:request_headers][FinApps::Middleware::AcceptJson::KEY]).to eq('application/json')
+    end
+  end
+end

data/spec/middleware/tenant_authentication_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 RSpec.describe FinApps::Middleware::TenantAuthentication do
   let(:valid_tenant_options) { VALID_CREDENTIALS }
   let(:key) { FinApps::Middleware::TenantAuthentication::KEY }
@@ -6,7 +7,11 @@ RSpec.describe FinApps::Middleware::TenantAuthentication do
     fake_app = proc {|env| env }
 
     context 'when company credentials were provided' do
-      let(:middleware) { FinApps::Middleware::TenantAuthentication.new fake_app, valid_tenant_options }
+      let(:middleware) do
+        FinApps::Middleware::TenantAuthentication.new(fake_app,
+                                                      VALID_CREDENTIALS[:identifier],
+                                                      VALID_CREDENTIALS[:token])
+      end
       let(:expected_header) { "#{valid_tenant_options[:identifier]}=#{valid_tenant_options[:token]}" }
 
       context 'when header was not previously set' do

data/spec/middleware/user_agent_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::Middleware::UserAgent do
+  let(:fake_app) { proc {|env| env } }
+  describe '#call' do
+    subject { FinApps::Middleware::UserAgent.new(fake_app) }
+    env = {request_headers: {}}
+
+    it('generates a UserAgent header') do
+      expect(subject.call(env)[:request_headers][FinApps::Middleware::UserAgent::KEY]).to start_with('finapps-ruby')
+    end
+  end
+end

data/spec/rest/base_client_spec.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
 RSpec.describe FinApps::REST::BaseClient do
-  let(:valid_tenant_options) { {tenant_credentials: VALID_CREDENTIALS} }
+  let(:valid_tenant_options) do
+    {tenant_identifier: VALID_CREDENTIALS[:identifier],
+     tenant_token: VALID_CREDENTIALS[:token]}
+  end
   subject { FinApps::REST::BaseClient.new(valid_tenant_options) }
 
   RESPONSE = 0
@@ -54,10 +58,10 @@ RSpec.describe FinApps::REST::BaseClient do
       context 'for client errors' do
         subject { FinApps::REST::BaseClient.new(valid_tenant_options).send_request('client_error', :get) }
 
-        it('the result should be nil') { expect(subject[RESPONSE]).to be_nil }
-        it { expect(subject[ERROR_MESSAGES]).not_to be_nil }
-        it { expect(subject[ERROR_MESSAGES]).to be_a(Array) }
-        it { expect(subject[ERROR_MESSAGES].length).to be > 0 }
+        it('result is null') { expect(subject[RESPONSE]).to be_nil }
+        it('error_messages is not null') { expect(subject[ERROR_MESSAGES]).not_to be_nil }
+        it('error_messages is an array') { expect(subject[ERROR_MESSAGES]).to be_a(Array) }
+        it('error messages array contains elements') { expect(subject[ERROR_MESSAGES].length).to be > 0 }
       end
 
       context 'for server errors' do

data/spec/rest/client_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 RSpec.describe FinApps::REST::Client do
   describe '#new' do
     it 'raises for missing company_identifier' do

data/spec/rest/configuration_spec.rb

@@ -1,74 +1,27 @@
+# frozen_string_literal: true
 RSpec.describe FinApps::REST::Configuration do
   describe '#new' do
-    it 'raises for missing tenant credentials' do
-      expect { FinApps::REST::Configuration.new({}) }
-        .to raise_error(FinApps::MissingArgumentsError, 'Missing tenant_credentials.')
+    context 'for invalid timeout configuration' do
+      subject { FinApps::REST::Configuration.new(timeout: 'whatever') }
+      it { expect { subject }.to raise_error(FinApps::InvalidArgumentsError, 'Invalid argument. {timeout: whatever}') }
     end
 
-    it 'raises for invalid tenant credentials (identifier)' do
-      expect { FinApps::REST::Configuration.new(tenant_credentials: {token: :token}) }
-        .to raise_error(FinApps::MissingArgumentsError, 'Missing tenant_credentials.')
+    context 'for missing timeout configuration' do
+      subject { FinApps::REST::Configuration.new(timeout: nil) }
+      it 'should have a default timeout value' do
+        expect(subject.timeout).to eq(FinApps::REST::Defaults::DEFAULTS[:timeout])
+      end
     end
 
-    it 'raises for invalid tenant credentials (token)' do
-      expect { FinApps::REST::Configuration.new(tenant_credentials: {identifier: :identifier}) }
-        .to raise_error(FinApps::MissingArgumentsError, 'Missing tenant_credentials.')
+    context 'for invalid host configuration' do
+      subject { FinApps::REST::Configuration.new(host: 'whatever') }
+      it { expect { subject }.to raise_error(FinApps::InvalidArgumentsError, 'Invalid argument. {host: whatever}') }
     end
 
-    context 'for valid tenant credentials' do
-      let(:valid_tenant_options) { {tenant_credentials: VALID_CREDENTIALS} }
-
-      context 'when valid user credentials were provided' do
-        let(:valid_creds) { valid_tenant_options.merge(user_credentials: VALID_CREDENTIALS) }
-        subject { FinApps::REST::Configuration.new(valid_creds) }
-        it('should have user_credentials') { expect(subject.user_credentials).to eq(VALID_CREDENTIALS) }
-        it('user_credentials are valid') { expect(subject.valid_user_credentials?).to eq true }
-      end
-
-      context 'for missing user credentials' do
-        subject { FinApps::REST::Configuration.new(valid_tenant_options) }
-        it('user_credentials are not valid') { expect(subject.valid_user_credentials?).to eq false }
-      end
-
-      context 'for invalid user credentials (token)' do
-        let(:invalid_user_creds) { {identifier: :identifier, token: ''} }
-        subject { FinApps::REST::Configuration.new(valid_tenant_options.merge(user_credentials: invalid_user_creds)) }
-
-        it('user_credentials are not valid') { expect(subject.valid_user_credentials?).to eq false }
-      end
-
-      context 'for invalid user credentials (identifier)' do
-        let(:invalid_user_creds) { {identifier: '', token: :token} }
-        subject { FinApps::REST::Configuration.new(valid_tenant_options.merge(user_credentials: invalid_user_creds)) }
-
-        it('user_credentials are not valid') { expect(subject.valid_user_credentials?).to eq false }
-      end
-
-      it 'raises for invalid timeout values' do
-        expect { FinApps::REST::Configuration.new(valid_tenant_options.merge(timeout: 'whatever')) }
-          .to raise_error(FinApps::InvalidArgumentsError, 'Invalid argument. {timeout: whatever}')
-      end
-
-      context 'for valid timeout' do
-        subject { FinApps::REST::Configuration.new(valid_tenant_options.merge(timeout: nil)) }
-        it 'should have a default timeout value' do
-          config = FinApps::REST::Configuration.new(valid_tenant_options.merge(timeout: nil))
-          expect(config.timeout).to eq(FinApps::REST::Defaults::DEFAULTS[:timeout])
-        end
-      end
-
-      it 'raises for invalid host values' do
-        expect { FinApps::REST::Configuration.new(valid_tenant_options.merge(host: 'whatever')) }
-          .to raise_error(FinApps::InvalidArgumentsError, 'Invalid argument. {host: whatever}')
-      end
-
-      context 'for valid host' do
-        subject { FinApps::REST::Configuration.new(valid_tenant_options.merge(host: nil)) }
-
-        it('should have a default host') { expect(subject.host).to eq(FinApps::REST::Defaults::DEFAULTS[:host]) }
-        it('url should include version') do
-          expect(subject.url).to eq("#{subject.host}/v#{FinApps::REST::Defaults::API_VERSION}/")
-        end
+    context 'for missing host configuration' do
+      subject { FinApps::REST::Configuration.new(host: nil) }
+      it 'should have a default host value' do
+        expect(subject.host).to eq(FinApps::REST::Defaults::DEFAULTS[:host])
       end
     end
   end

data/spec/rest/credentials_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::REST::Credentials do
+  describe '#valid?' do
+    context 'when missing identifier' do
+      it { expect(FinApps::REST::Credentials.new(nil, :token).valid?).to eql(false) }
+    end
+
+    context 'when missing token' do
+      it { expect(FinApps::REST::Credentials.new(:identifier, nil).valid?).to eql(false) }
+    end
+
+    context 'when missing both identifier and token' do
+      it { expect(FinApps::REST::Credentials.new(nil, nil).valid?).to eql(false) }
+    end
+
+    context 'when having identifier and token' do
+      it { expect(FinApps::REST::Credentials.new(:identifier, :token).valid?).to eql(true) }
+    end
+  end
+end

data/spec/rest/orders_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 RSpec.describe FinApps::REST::Orders do
   describe '#show' do
     let(:client) { FinApps::REST::Client.new :company_identifier, :company_token }

data/spec/rest/resources_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 RSpec.describe FinApps::REST::Resources do
   let(:client) { FinApps::REST::Client.new :company_identifier, :company_token }
   describe '#new' do

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if ENV['CODECLIMATE_REPO_TOKEN']
   require 'codeclimate-test-reporter'
   CodeClimate::TestReporter.start
@@ -29,6 +30,7 @@ RSpec.configure do |config|
     base_url = "#{FinApps::REST::Defaults::DEFAULTS[:host]}/v#{FinApps::REST::Defaults::API_VERSION}/"
     stub_request(:any, /#{base_url}/).to_rack(::FakeApi)
   end
+  WebMock.disable_net_connect!(allow: 'codeclimate.com')
 end
 
 VALID_CREDENTIALS = {identifier: '49fb918d-7e71-44dd-7378-58f19606df2a',

data/spec/support/fake_api.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 require 'sinatra/base'
 
+# the FakeApi class is used to mock API requests while testing.
 class FakeApi < Sinatra::Base
   # resource
   post('/v2/resources') { json_response 201, 'resource.json' }

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.10
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-07-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.2.6
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -265,16 +245,21 @@ files:
 - README.md
 - Rakefile
 - finapps.gemspec
+- lib/core_extensions/hash/compact.rb
+- lib/core_extensions/object/blank.rb
+- lib/core_extensions/object/is_integer.rb
 - lib/finapps.rb
-- lib/finapps/core_extensions/integerable.rb
 - lib/finapps/error.rb
-- lib/finapps/hash_constructable.rb
-- lib/finapps/middleware/raise_error.rb
-- lib/finapps/middleware/tenant_authentication.rb
+- lib/finapps/middleware/middleware.rb
+- lib/finapps/middleware/request/accept_json.rb
+- lib/finapps/middleware/request/tenant_authentication.rb
+- lib/finapps/middleware/request/user_agent.rb
+- lib/finapps/middleware/response/raise_error.rb
 - lib/finapps/rest/base_client.rb
 - lib/finapps/rest/client.rb
 - lib/finapps/rest/configuration.rb
 - lib/finapps/rest/connection.rb
+- lib/finapps/rest/credentials.rb
 - lib/finapps/rest/defaults.rb
 - lib/finapps/rest/orders.rb
 - lib/finapps/rest/resources.rb
@@ -282,10 +267,13 @@ files:
 - lib/finapps/utils/loggeable.rb
 - lib/finapps/version.rb
 - lib/tasks/releaser.rake
+- spec/middleware/accept_json_spec.rb
 - spec/middleware/tenant_authentication_spec.rb
+- spec/middleware/user_agent_spec.rb
 - spec/rest/base_client_spec.rb
 - spec/rest/client_spec.rb
 - spec/rest/configuration_spec.rb
+- spec/rest/credentials_spec.rb
 - spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
 - spec/spec_helper.rb
@@ -320,16 +308,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/spec_helper.rb
-- spec/support/fake_api.rb
+- spec/middleware/accept_json_spec.rb
 - spec/middleware/tenant_authentication_spec.rb
-- spec/rest/resources_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/orders_spec.rb
+- spec/middleware/user_agent_spec.rb
 - spec/rest/base_client_spec.rb
+- spec/rest/client_spec.rb
 - spec/rest/configuration_spec.rb
+- spec/rest/credentials_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/resources_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_api.rb

data/lib/finapps/core_extensions/integerable.rb

@@ -1,14 +0,0 @@
-module CoreExtensions
-  # adds an integer? method to any object when used in a class
-  module Integerable
-    refine Object do
-      def integer?
-        Integer(self)
-      rescue
-        false
-      else
-        true
-      end
-    end
-  end
-end

data/lib/finapps/hash_constructable.rb

@@ -1,9 +0,0 @@
-module FinApps
-  # when included into any object, allows to initialize public attributes from a hash
-  module HashConstructable
-    def initialize(options_hash={}, defaults=nil)
-      merged_hash = defaults.nil? ? options_hash : defaults.merge(options_hash.compact)
-      merged_hash.each {|k, v| public_send("#{k}=", v) }
-    end
-  end
-end