finapps_core 5.0.4 → 5.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d73742939d1896b096ba4ea23eae7381c812565acc344b634467ec581b24bd0e
-  data.tar.gz: 1e9acbd80be922e20b13ddbc399f07e6adfa2ad9dea799a77a44ea06516029bd
+  metadata.gz: 02d94808c56da43ce378a957a15a28a0eb48d5005c785e784ba9142a9652d91f
+  data.tar.gz: 2eabf5b84c9839d2cdd9f80245d8a3454bcb863f1b8dcdbea89e0a4a2b3ef8c2
 SHA512:
-  metadata.gz: 648f16e4ea04e82aa0bc1d281872b12172653834a41bc950634b38b549b20e25c94bf6a56a471bf0c294f7bc5ea49874fefb2263315cfc5795b49da4cae7229b
-  data.tar.gz: 163c427e8170c8613acd7cc1d0bcfb56c6270af9d9ec444579b6e3e0103e1cf9759e0da38661a36433088887d4163d5da74d895bc4d670f25249566daede8fc0
+  metadata.gz: 2b494fac5ca2d2104d5d40912c440b08e750e137fa4a0bd44bdfa8b540c6ad4e627b2ae5eb372fcf704d915c98028854d9f5ab527ede1a8a29b87e4527ae4f1c
+  data.tar.gz: '028ea9d578f9d6a8f97ba73c715d08c65f4f06548c620bc5d6c05c76b505e5268a3736d454a3f39b37c71e3c4744364ee4c658d3913ea7d64031b25bcf77bb76'

data/.codeclimate.yml

@@ -1,6 +1,8 @@
-engines:
+version: "2"
+plugins:
   rubocop:
     enabled: true
+    channel: rubocop-0-74
   brakeman:
     enabled: false
   eslint:
@@ -11,11 +13,10 @@ engines:
     enabled: true
     config:
       languages:
-      - ruby
-ratings:
-  paths:
-  - lib/**
-  - "**.rb"
-exclude_paths:
+        ruby:
+          mass_threshold: 30
+exclude_patterns:
 - spec/**/*
-- "**/vendor/**/*"
+- "**/vendor/**/*"
+- lib/finapps_core/rest/connection.rb
+- lib/core_extensions/string/json_to_hash.rb

data/.rubocop.yml

@@ -1,24 +1,78 @@
+require: 
+  - rubocop-rspec
+  - rubocop-performance
+
 AllCops:
-  DisplayCopNames: true
+  TargetRubyVersion: 2.6
   Exclude:
-    - "finapps_core.gemspec"
-  UseCache: false
-
-# Commonly used screens these days easily fit more than 80 characters.
-Metrics/LineLength:
-  Max: 120
-
-# Re-enable this when the following is resolved:
-# https://github.com/rubocop-hq/rubocop/issues/5953
-Style/AccessModifierDeclarations:
-  Enabled: false
+    - "vendor/**/*"
+    - "bin/**/*"
+  CacheRootDirectory: tmp
 
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/SpaceInsideBlockBraces:
   # The space here provides no real gain in readability while consuming
   # horizontal space that could be used for a better parameter name.
   # Also {| differentiates better from a hash than { | does.
   SpaceBeforeBlockParameters: false
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Layout/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: leading
+  SupportedStyles:
+  - leading
+  - trailing
+Layout/LineLength:
+  Max: 110
 
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/ClassLength:
+  Exclude:
+    - app/controllers/orders_controller.rb
+    - app/models/order.rb
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+  Exclude:
+    - config/environments/**/**
+    - '*.gemspec'
+    - Guardfile
+    - config/routes.rb
+    - config/Guardfile
+
+Naming/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  ForbiddenPrefixes:
+  - is_
+  Exclude:
+  - spec/**/*
+
+RSpec/FilePath:
+  Enabled: false
+    
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
 Style/CollectionMethods:
   Description: Preferred collection methods.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
@@ -29,73 +83,76 @@ Style/CollectionMethods:
     find: detect
     find_all: select
     reduce: inject
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  MinBodyLength: 1
 Style/OptionHash:
   Description: Don't use option hashes when you can use keyword arguments.
   Enabled: false
-Naming/PredicateName:
-  Description: Check the names of predicate methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
-  Enabled: true
-  NamePrefix:
-    - is_
-    - has_
-    - have_
-  NamePrefixBlacklist:
-    - is_
-  Exclude:
-    - spec/**/*
-Metrics/AbcSize:
-  Description: A calculated magnitude based on number of assignments, branches, and
-    conditions.
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
   Enabled: false
-  Max: 15
-Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
-Metrics/ClassLength:
-  Description: Avoid classes longer than 100 lines of code.
-  Enabled: false
-  CountComments: false
-  Max: 100
-Metrics/ModuleLength:
-  CountComments: false
-  Max: 100
-  Description: Avoid modules longer than 100 lines of code.
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Description: A complexity metric that is strongly correlated to the number of test
-    cases needed to validate a method.
-  Enabled: false
-  Max: 6
-Metrics/MethodLength:
-  Description: Avoid methods longer than 10 lines of code.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
-  Enabled: false
-  CountComments: false
-  Max: 10
-Metrics/ParameterLists:
-  Description: Avoid parameter lists longer than three or four parameters.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
-  Enabled: false
-  Max: 5
-  CountKeywordArgs: true
-Metrics/PerceivedComplexity:
-  Description: A complexity metric geared towards measuring complexity for a human
-    reader.
-  Enabled: false
-  Max: 7
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: true
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
 Style/Documentation:
   Description: Document classes and non-namespace modules.
   Enabled: false
-Style/EmptyLiteral:
-  Description: Prefer literals to Array.new/Hash.new/String.new.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
   Enabled: false
-Style/VariableInterpolation:
-  Description: Don't interpolate global, instance and class variables directly in
-    strings.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
-  Enabled: false
-Lint/HandleExceptions:
-  Description: Don't suppress exception.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
-  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
+RSpec/NestedGroups:
+  Max: 5
+RSpec/DescribeClass:
+  Exclude:
+    - spec/system/*
+    - spec/factories_spec.rb

data/.tmuxinator.yml

@@ -0,0 +1,20 @@
+--- 
+name: ruby-client-core
+root: ~/projects/ruby-client-core/
+windows: 
+  - 
+    editor: 
+      layout: main-vertical
+      panes: 
+        - vim: $EDITOR
+        - bash: 
+          - git pull
+          - git status
+          - bundle
+          - bundle outdated
+  - 
+    guard: 
+      layout: even-horizontal
+      panes:
+        - guard:
+          - bundle exec guard

data/.travis.yml

@@ -1,17 +1,16 @@
-sudo: false
 language: ruby
+os: ["linux"]
+dist: "xenial"
+
 cache:
   bundler: true
 
 rvm:
-  - 2.5
   - 2.6
-  - ruby-head
 
 before_install:
   - "echo 'gem: --no-document' > ~/.gemrc"
-  - gem update --system
-  - gem install bundler -v "~>2.0"
+  - gem install bundler --force --quiet
 
 script:
   - bundle exec rspec
@@ -23,4 +22,4 @@ addons:
   code_climate:
     repo_token: 5a8d194cbc23aa4c171e3478e3b6bbea9dd96041071380ec25bf80c07770b39a
 after_success:
-  - bundle exec codeclimate-test-reporter
+  - bundle exec codeclimate-test-reporter

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|
@@ -26,14 +26,14 @@ Gem::Specification.new do |spec|
   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.73',  '>= 0.73.0'
-  spec.add_development_dependency 'rubocop-performance',        '~> 1.4',   '>= 1.4.0'
-  spec.add_development_dependency 'rubocop-rspec',              '~> 1.33',  '>= 1.33.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'
 
   spec.extra_rdoc_files = %w(README.md LICENSE)
   spec.rdoc_options = %w(--line-numbers --inline-source --title finapps-ruby-core --main README.md)
-end
+end

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::Error::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)