finapps_core 5.0.6 → 5.0.11

data/RELEASES.md

@@ -0,0 +1,8 @@
+## [5.0.7] - 2020-02-11
+
+### Added
+* X-Consumer-ID header ([#49][i49])
+
+[i49]: https://github.com/finapps/ruby-client-core/issues/49
+
+[5.0.7]: https://github.com/finapps/ruby-client-core/compare/5.0.6...5.0.7

data/finapps_core.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'finapps_core/version'
 Gem::Specification.new do |spec|
@@ -20,17 +20,16 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['spec/**/*.rb']
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency     'faraday',                    '~> 0.15',  '>= 0.15.3'
-  spec.add_runtime_dependency     'faraday_middleware',         '~> 0.12',  '>= 0.12.2'
+  spec.add_runtime_dependency     'faraday',                    '~> 1.0',   '>= 1.0.1'
+  spec.add_runtime_dependency     'faraday_middleware',         '~> 1.0',   '>= 1.0'
 
-  spec.add_development_dependency 'bundler',                    '~> 2.0', '>= 2.0.2'
+  spec.add_development_dependency 'bundler',                    '~> 2.0',   '>= 2.0.2'
   spec.add_development_dependency 'codeclimate-test-reporter',  '~> 1.0',   '>= 1.0.9'
-  spec.add_development_dependency 'gem-release',                '~> 2.0',   '>= 2.0.3'
-  spec.add_development_dependency 'rake',                       '~> 12.3',  '>= 12.3.2'
+  spec.add_development_dependency 'rake',                       '~> 13.0',  '>= 13.0.1'
   spec.add_development_dependency 'rspec',                      '~> 3.8',   '>= 3.8.0'
-  spec.add_development_dependency 'rubocop',                    '~> 0.75',  '>= 0.75.0'
-  spec.add_development_dependency 'rubocop-performance',        '~> 1.5',   '>= 1.5.0'
-  spec.add_development_dependency 'rubocop-rspec',              '~> 1.36',  '>= 1.36.0'
+  spec.add_development_dependency 'rubocop',                    '~> 0.86',  '>= 0.86.0'
+  spec.add_development_dependency 'rubocop-performance',        '~> 1.6',   '>= 1.6.1'
+  spec.add_development_dependency 'rubocop-rspec',              '~> 1.40',  '>= 1.40.0'
   spec.add_development_dependency 'sinatra',                    '~> 2.0',   '>= 2.0.5'
   spec.add_development_dependency 'webmock',                    '~> 3.6',   '>= 3.6.0'
 

data/lib/finapps_core.rb

@@ -17,6 +17,7 @@ require 'finapps_core/middleware/request/no_encoding_basic_authentication'
 require 'finapps_core/middleware/request/accept_json'
 require 'finapps_core/middleware/request/user_agent'
 require 'finapps_core/middleware/request/request_id'
+require 'finapps_core/middleware/request/x_consumer_id'
 require 'finapps_core/middleware/response/raise_error'
 require 'finapps_core/middleware/middleware'
 

data/lib/finapps_core/middleware/middleware.rb

@@ -6,9 +6,12 @@ module FinAppsCore
   module Middleware
     autoload :AcceptJson, 'finapps_core/middleware/request/accept_json'
     autoload :UserAgent, 'finapps_core/middleware/request/user_agent'
-    autoload :NoEncodingBasicAuthentication, 'finapps_core/middleware/request/no_encoding_basic_authentication'
-    autoload :TenantAuthentication, 'finapps_core/middleware/request/tenant_authentication'
+    autoload :NoEncodingBasicAuthentication,
+             'finapps_core/middleware/request/no_encoding_basic_authentication'
+    autoload :TenantAuthentication,
+             'finapps_core/middleware/request/tenant_authentication'
     autoload :RequestId, 'finapps_core/middleware/request/request_id'
+    autoload :XConsumerId, 'finapps_core/middleware/request/x_consumer_id'
 
     if Faraday::Middleware.respond_to? :register_middleware
       Faraday::Request.register_middleware \
@@ -16,7 +19,8 @@ module FinAppsCore
         user_agent: -> { UserAgent },
         no_encoding_basic_authentication: -> { NoEncodingBasicAuthentication },
         tenant_authentication: -> { TenantAuthentication },
-        request_id: -> { RequestId }
+        request_id: -> { RequestId },
+        x_consumer_id: -> { XConsumerId }
     end
   end
 end

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

@@ -2,7 +2,8 @@
 
 module FinAppsCore
   module Middleware
-    # This middleware sets the Accept request-header field to specify JSON as acceptable media type for the response.
+    # 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
 

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

@@ -2,7 +2,7 @@
 
 module FinAppsCore
   module Middleware
-    # This middleware sets the User-Agent request-header field to identify thei client.
+    # This middleware sets the User-Agent request-header field to identify the client.
     class UserAgent < Faraday::Middleware
       KEY = 'User-Agent' unless defined? KEY
       RUBY = "#{RUBY_ENGINE}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"

data/lib/finapps_core/middleware/request/x_consumer_id.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinAppsCore
+  module Middleware
+    # Adds a header to specify consumer to retrieve data for
+    class XConsumerId < Faraday::Middleware
+      KEY = 'X-Consumer-ID' unless defined? KEY
+
+      def initialize(app, x_consumer_id)
+        super(app)
+        @x_consumer_id = x_consumer_id.to_s.strip
+      end
+
+      def call(env)
+        env[:request_headers][KEY] ||= @x_consumer_id
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps_core/middleware/response/raise_error.rb

@@ -16,12 +16,7 @@ module FinAppsCore
       def on_complete(env)
         return if SUCCESS_STATUSES.include?(env[:status])
 
-        raise(FinAppsCore::ApiUnauthenticatedError, 'API Invalid Session') if env[:status] == API_UNAUTHENTICATED
-        raise(FinAppsCore::ApiSessionTimeoutError, 'API Session Timed out') if env[:status] == API_SESSION_TIMEOUT
-        raise(FinAppsCore::ConnectionFailedError, 'Connection Failed') if env[:status] == CONNECTION_FAILED_STATUS
-        raise(FinAppsCore::UserLockoutError, 'User is Locked') if user_is_locked?(env)
-
-        raise(Faraday::ClientError, response_values(env))
+        failures env
       end
 
       def response_values(env)
@@ -35,6 +30,39 @@ module FinAppsCore
 
       private
 
+      def failures(env)
+        api_authentication_fail env
+        api_session_timeout_fail env
+        locked_user_fail env
+        connection_fail env
+
+        fail(Faraday::ClientError, response_values(env))
+      end
+
+      def locked_user_fail(env)
+        return unless user_is_locked?(env)
+
+        fail(FinAppsCore::UserLockoutError, 'User is Locked')
+      end
+
+      def api_session_timeout_fail(env)
+        return unless env[:status] == API_SESSION_TIMEOUT
+
+        fail(FinAppsCore::ApiSessionTimeoutError, 'API Session Timed out')
+      end
+
+      def connection_fail(env)
+        return unless env[:status] == CONNECTION_FAILED_STATUS
+
+        fail(FinAppsCore::ConnectionFailedError, 'Connection Failed')
+      end
+
+      def api_authentication_fail(env)
+        return unless env[:status] == API_UNAUTHENTICATED
+
+        fail(FinAppsCore::ApiUnauthenticatedError, 'API Invalid Session')
+      end
+
       def error_messages(body)
         return nil if empty?(body)
 
@@ -59,7 +87,8 @@ module FinAppsCore
       end
 
       def user_is_locked?(env)
-        env.status == FORBIDDEN && error_messages(env.body)&.[](0)&.downcase == LOCKOUT_MESSAGE
+        env.status == FORBIDDEN &&
+          error_messages(env.body)&.[](0)&.downcase == LOCKOUT_MESSAGE
       end
 
       def symbolize(obj)

data/lib/finapps_core/rest/base_client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './configuration.rb'
-require_relative './connection.rb'
+require_relative './configuration'
+require_relative './connection'
 require_relative '../utils/loggeable'
 require_relative '../utils/validatable'
 
@@ -31,7 +31,8 @@ module FinAppsCore
       end
 
       # Performs HTTP GET, POST, UPDATE and DELETE requests.
-      # You shouldn't need to use this method directly, but it can be useful for debugging.
+      # You shouldn't need to use this method directly,
+      # but it can be useful for debugging.
       # Returns a hash obtained from parsing the JSON object in the response body.
       #
       # @param [String] path
@@ -42,7 +43,7 @@ module FinAppsCore
         not_blank(path, :path)
         not_blank(method, :method)
 
-        response, error_messages = execute_request(path, method, params)
+        response, error_messages = execute_request(method, path, params)
         result = block_given? ? yield(response) : response_body(response)
 
         [result, error_messages]
@@ -76,26 +77,19 @@ module FinAppsCore
         end
       end
 
-      def execute_request(path, method, params)
-        response = nil
-        errors = []
-
-        begin
-          response = execute_method path, method, params
-        rescue FinAppsCore::InvalidArgumentsError,
-               FinAppsCore::MissingArgumentsError,
-               Faraday::Error::ConnectionFailed => e
-          handle_error e
-        rescue Faraday::ClientError => e
-          errors = handle_client_error(e)
-        end
-
-        [response, errors]
+      def execute_request(method, path, params)
+        [send(method, path, params), []]
+      rescue FinAppsCore::InvalidArgumentsError,
+             FinAppsCore::MissingArgumentsError,
+             Faraday::ConnectionFailed => e
+        [nil, handle_error(e)]
+      rescue Faraday::ClientError => e
+        [nil, handle_client_error(e)]
       end
 
       def handle_error(error)
         logger.fatal "#{self.class}##{__method__} => #{error}"
-        raise error
+        fail error
       end
 
       def handle_client_error(error)
@@ -103,19 +97,13 @@ module FinAppsCore
         error.response && error.response[:error_messages] ? error.response[:error_messages] : [error.message]
       end
 
-      def execute_method(path, method, params)
-        case method
-        when :get
-          get(path)
-        when :post
-          post(path, params)
-        when :put
-          put(path, params)
-        when :delete
-          delete(path, params)
-        else
-          raise FinAppsCore::UnsupportedHttpMethodError, "Method not supported: #{method}."
+      def execute_method(method, path, params)
+        unless %i(get post put delete).include?(method)
+          fail FinAppsCore::UnsupportedHttpMethodError,
+               "Method not supported: #{method}."
         end
+
+        send(method, path, params)
       end
     end
   end

data/lib/finapps_core/rest/configuration.rb

@@ -8,14 +8,13 @@ module FinAppsCore
 
       attr_accessor :tenant_token, :user_identifier, :user_token,
                     :host, :proxy, :timeout, :retry_limit, :rashify,
-                    :log_level, :request_id
+                    :log_level, :request_id, :consumer_id
 
       def initialize(options = {})
         FinAppsCore::REST::Defaults::DEFAULTS.merge(remove_empty_options(options))
                                              .each {|key, value| public_send("#{key}=", value) }
-
-        raise FinAppsCore::InvalidArgumentsError, "Invalid argument. {host: #{host}}" unless valid_host?
-        raise FinAppsCore::InvalidArgumentsError, "Invalid argument. {timeout: #{timeout}}" unless timeout.integer?
+        fail_invalid_host
+        fail_invalid_timeout
       end
 
       def valid_user_credentials?
@@ -24,6 +23,20 @@ module FinAppsCore
 
       private
 
+      def fail_invalid_host
+        return if valid_host?
+
+        fail FinAppsCore::InvalidArgumentsError,
+             "Invalid argument. {host: #{host}}"
+      end
+
+      def fail_invalid_timeout
+        return if timeout.integer?
+
+        fail FinAppsCore::InvalidArgumentsError,
+             "Invalid argument. {timeout: #{timeout}}"
+      end
+
       def valid_host?
         host.start_with?('http://', 'https://')
       end

data/lib/finapps_core/rest/connection.rb

@@ -8,39 +8,49 @@ module FinAppsCore
         options = connection_options config
 
         Faraday.new(options) do |conn|
-          conn.request :accept_json
-          conn.request :user_agent
-          if config.valid_user_credentials?
-            conn.request :no_encoding_basic_authentication, config.user_token
-          else
-            conn.request :tenant_authentication, config.tenant_token
-          end
-          conn.request :json
-          conn.request :retry
-          conn.request :multipart
-          conn.request :url_encoded
-          conn.request :request_id, config.request_id if config.request_id
-
           conn.use FinAppsCore::Middleware::RaiseError
-          conn.response :json,
-                        content_type: /\bjson$/,
-                        parser_options: { symbolize_names: true }
-          conn.response :logger, logger, bodies: true
+          init_connection_request conn, config
+          init_connection_response conn, logger
+          init_connection_auth conn, config
 
           # Adapter (ensure that the adapter is always last.)
           conn.adapter Faraday.default_adapter
         end
       end
-      module_function :faraday
+
+      def init_connection_response(conn, logger)
+        conn.response :logger, logger, bodies: true
+        conn.response :json,
+                      content_type: /\bjson$/,
+                      parser_options: {symbolize_names: true}
+      end
+
+      def init_connection_request(conn, config)
+        conn.request :accept_json
+        conn.request :user_agent
+        conn.request :x_consumer_id, config.consumer_id if config.consumer_id
+        conn.request :json
+        conn.request :retry
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.request :request_id, config.request_id if config.request_id
+      end
+
+      def init_connection_auth(conn, config)
+        if config.valid_user_credentials?
+          conn.request :no_encoding_basic_authentication, config.user_token
+        else
+          conn.request :tenant_authentication, config.tenant_token
+        end
+      end
 
       def connection_options(config)
         {
           url: "#{config.host}/v#{Defaults::API_VERSION}/",
-          request: { open_timeout: config.timeout,
-                     timeout: config.timeout }
+          request: {open_timeout: config.timeout,
+                    timeout: config.timeout}
         }
       end
-      module_function :connection_options
     end
   end
 end

data/lib/finapps_core/rest/defaults.rb

@@ -12,7 +12,7 @@ module FinAppsCore
         host: 'https://api.finclear.io',
         timeout: 30,
         proxy: nil,
-        log_level: Logger::INFO
+        log_level: Logger::UNKNOWN
       }.freeze
     end
   end

data/lib/finapps_core/utils/loggeable.rb

@@ -7,7 +7,7 @@ module FinAppsCore
       def logger
         @logger ||= begin
           require 'logger'
-          logger = Logger.new(STDOUT)
+          logger = Logger.new($stdout)
           logger.level = FinAppsCore::REST::Defaults::DEFAULTS[:log_level]
           logger
         end

data/lib/finapps_core/utils/validatable.rb

@@ -8,7 +8,7 @@ module FinAppsCore
     # Adds validation capabilities when included into other classes
     module Validatable
       def not_blank(value, name = nil)
-        raise FinAppsCore::MissingArgumentsError, name.nil? ? nil : ": #{name}" if nil_or_empty?(value)
+        fail FinAppsCore::MissingArgumentsError, name.nil? ? nil : ": #{name}" if nil_or_empty?(value)
       end
 
       def nil_or_empty?(value)

data/lib/finapps_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinAppsCore
-  VERSION = '5.0.6'
+  VERSION = '5.0.11'
 end

data/spec/core_extensions/object/is_integer_spec.rb

@@ -2,16 +2,15 @@
 
 RSpec.describe ObjectExtensions do
   context 'when refining Object' do
-    using ObjectExtensions
+    using described_class
 
     describe '#integer?' do
-      context 'for integers' do
-        subject { rand(1..10) }
-        it { expect(subject.integer?).to eq(true) }
+      context 'with integers' do
+        it { expect(rand(1..10).integer?).to eq(true) }
       end
-      context 'for non integers' do
-        subject { rand }
-        it { expect(subject.integer?).to eq(false) }
+
+      context 'with non integers' do
+        it { expect(rand.integer?).to eq(false) }
       end
     end
   end

data/spec/middleware/request/accept_json_spec.rb

@@ -2,12 +2,16 @@
 
 RSpec.describe FinAppsCore::Middleware::AcceptJson do
   let(:fake_app) { proc {|env| env } }
+
   describe '#call' do
-    subject { FinAppsCore::Middleware::AcceptJson.new(fake_app) }
-    env = { request_headers: {} }
+    subject(:accept_json) { described_class.new(fake_app) }
+
+    env = {request_headers: {}}
 
     it('generates a UserAgent header') do
-      expect(subject.call(env)[:request_headers][FinAppsCore::Middleware::AcceptJson::KEY]).to eq('application/json')
+      header_key = FinAppsCore::Middleware::AcceptJson::KEY
+      expect(accept_json.call(env)[:request_headers][header_key])
+        .to eq('application/json')
     end
   end
 end