finapps_core 5.0.6 → 5.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '08859c33cd6524380a075b7f36177300adfdeb2b'
-  data.tar.gz: cd48d1c3f27ee17efbb19d70b24abf121ecb98d0
+SHA256:
+  metadata.gz: a7da6746a9d41a5a653232294b795c91e9a12b5c6879e3fcd3cef0ae199c7856
+  data.tar.gz: e6cd9df962d35834b073dea681bc56c4a0283130e535dd9e38e03b0431febc76
 SHA512:
-  metadata.gz: b69ac8cecad4365023c4eb2769895d0b5a4e49970b7dc51a086149347fb5dee65b2a37e230fe5ec2be234ad5be79d37be32a5ad0527a4c2a9a74f1dc33515893
-  data.tar.gz: 59768f251ec965091bc87e04384219befdeab569363ffb3c6f4fd6b585b2d25791b2c8ea9dbda5e62edfd626e325cdac0f9e0f461df6ce1791d58df90d4cf0b6
+  metadata.gz: c0adf1096463f145ced38476aed16b78a9e1db262881614e727e74eb6a015fc80fae7a6c15a4452e3bc16de47b3536379caeb19b63da86980da890971885c720
+  data.tar.gz: d856c0cd51760de8fb94e2b1907acfe594c3bfb8b8afc54f1bf8447c8759b60ecbaedbfae9c533d46d5eacf7af14c088bc9ca0fdd81166e8ffeed19a9c025370

data/.codeclimate.yml

@@ -13,7 +13,10 @@ plugins:
     enabled: true
     config:
       languages:
-      - ruby
+        ruby:
+          mass_threshold: 30
 exclude_patterns:
 - spec/**/*
 - "**/vendor/**/*"
+- lib/finapps_core/rest/connection.rb
+- lib/core_extensions/string/json_to_hash.rb

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
   UseCache: false
 
 # Commonly used screens these days easily fit more than 80 characters.
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 # Re-enable this when the following is resolved:
@@ -40,7 +40,7 @@ Naming/PredicateName:
     - is_
     - has_
     - have_
-  NamePrefixBlacklist:
+  ForbiddenPrefixes:
     - is_
   Exclude:
     - spec/**/*
@@ -95,7 +95,7 @@ Style/VariableInterpolation:
     strings.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
   Enabled: false
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Description: Don't suppress exception.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
   Enabled: false

data/.travis.yml

@@ -6,7 +6,7 @@ cache:
 rvm:
   - 2.5
   - 2.6
-  - ruby-head
+#  - ruby-head
 
 before_install:
   - "echo 'gem: --no-document' > ~/.gemrc"

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/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

@@ -9,6 +9,7 @@ module FinAppsCore
     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 +17,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/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/rest/configuration.rb

@@ -8,7 +8,7 @@ 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))

data/lib/finapps_core/rest/connection.rb

@@ -15,6 +15,7 @@ module FinAppsCore
           else
             conn.request :tenant_authentication, config.tenant_token
           end
+          conn.request :x_consumer_id, config.consumer_id if config.consumer_id
           conn.request :json
           conn.request :retry
           conn.request :multipart

data/lib/finapps_core/version.rb

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

data/spec/middleware/request/x_consumer_id_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec.describe FinAppsCore::Middleware::XConsumerId do
+  let(:key) { FinAppsCore::Middleware::XConsumerId::KEY }
+  let(:id) { 'valid_consumer_id' }
+  let(:fake_app) { proc {|env| env } }
+  let(:env) { { request_headers: {} } }
+
+  describe '#call' do
+    subject { FinAppsCore::Middleware::XConsumerId.new(fake_app, id) }
+
+    it('generates an X-Consumer-ID header') do
+      expect(subject.call(env)[:request_headers][key]).to eq(id)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps_core
 version: !ruby/object:Gem::Version
-  version: 5.0.6
+  version: 5.0.7
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,82 +134,82 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.75'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.75.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.75'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.75.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.36'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.36.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.36'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.36.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -234,22 +234,22 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: A simple library for communicating with the FinApps REST API. Core functionality.
 email:
 - erich@financialapps.com
@@ -271,6 +271,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- RELEASES.md
 - Rakefile
 - finapps_core.gemspec
 - lib/core_extensions/object/is_integer.rb
@@ -283,6 +284,7 @@ files:
 - lib/finapps_core/middleware/request/request_id.rb
 - lib/finapps_core/middleware/request/tenant_authentication.rb
 - lib/finapps_core/middleware/request/user_agent.rb
+- lib/finapps_core/middleware/request/x_consumer_id.rb
 - lib/finapps_core/middleware/response/raise_error.rb
 - lib/finapps_core/rest/base_client.rb
 - lib/finapps_core/rest/configuration.rb
@@ -300,6 +302,7 @@ files:
 - spec/middleware/request/request_id_spec.rb
 - spec/middleware/request/tenant_authentication_spec.rb
 - spec/middleware/request/user_agent_spec.rb
+- spec/middleware/request/x_consumer_id_spec.rb
 - spec/middleware/response/raise_error_spec.rb
 - spec/rest/base_client_spec.rb
 - spec/rest/configuration_spec.rb
@@ -341,25 +344,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client - Core.
 test_files:
-- spec/middleware/response/raise_error_spec.rb
-- spec/middleware/request/user_agent_spec.rb
-- spec/middleware/request/no_encoding_basic_authentication_spec.rb
-- spec/middleware/request/request_id_spec.rb
-- spec/middleware/request/tenant_authentication_spec.rb
-- spec/middleware/request/accept_json_spec.rb
-- spec/rest/credentials_spec.rb
-- spec/rest/configuration_spec.rb
 - spec/rest/defaults_spec.rb
 - spec/rest/base_client_spec.rb
+- spec/rest/credentials_spec.rb
+- spec/rest/configuration_spec.rb
 - spec/rest/resources_spec.rb
-- spec/utils/validatable_spec.rb
 - spec/support/fake_api.rb
+- spec/utils/validatable_spec.rb
+- spec/spec_helpers/client.rb
 - spec/spec_helper.rb
 - spec/core_extensions/object/is_integer_spec.rb
-- spec/spec_helpers/client.rb
+- spec/middleware/request/no_encoding_basic_authentication_spec.rb
+- spec/middleware/request/user_agent_spec.rb
+- spec/middleware/request/tenant_authentication_spec.rb
+- spec/middleware/request/x_consumer_id_spec.rb
+- spec/middleware/request/accept_json_spec.rb
+- spec/middleware/request/request_id_spec.rb
+- spec/middleware/response/raise_error_spec.rb