finapps_core 5.0.4 → 5.0.9

data/spec/rest/base_client_spec.rb

@@ -1,96 +1,140 @@
 # frozen_string_literal: true
 
 RSpec.describe FinAppsCore::REST::BaseClient do
-  let(:valid_tenant_options) { { tenant_token: VALID_CREDENTIALS[:token] } }
-  subject { FinAppsCore::REST::BaseClient.new(valid_tenant_options) }
+  subject(:base_client) { described_class.new(valid_tenant_options) }
 
-  RESPONSE = 0
-  ERROR_MESSAGES = 1
-  let(:return_array) { %i[RESPONSE ERROR_MESSAGES] }
+  let(:valid_tenant_options) { {tenant_token: VALID_CREDENTIALS[:token]} }
+
+  before do
+    stub_const 'RESPONSE', 0
+    stub_const 'ERROR_MESSAGES', 1
+  end
 
   describe '#new' do
     it 'assigns @config' do
-      expect(subject.config).to be_a(FinAppsCore::REST::Configuration)
+      expect(base_client.config).to be_a(FinAppsCore::REST::Configuration)
     end
   end
 
   describe '#connection' do
     it 'created a Faraday connection object' do
-      expect(subject.connection).to be_a(Faraday::Connection)
+      expect(base_client.connection).to be_a(Faraday::Connection)
     end
 
     it 'memoizes the results' do
-      first = subject.connection
-      second = subject.connection
+      first = base_client.connection
+      second = base_client.connection
       expect(first.object_id).to eq(second.object_id)
     end
   end
 
   describe '#send_request' do
-    it 'should raise FinAppsCore::InvalidArgumentsError if method is NOT supported' do
-      expect { subject.send_request('fake_path', :option) }.to raise_error(FinAppsCore::UnsupportedHttpMethodError,
-                                                                           'Method not supported: option.')
+    it 'raises FinAppsCore::InvalidArgumentsError if method is NOT supported' do
+      expect { base_client.send_request('fake_path', :option) }
+        .to(raise_error NoMethodError)
     end
 
-    it 'should raise FinAppsCore::MissingArgumentsError if method is NOT provided' do
-      expect { subject.send_request(nil, :get) }.to raise_error(FinAppsCore::MissingArgumentsError,
-                                                                ': path')
+    it 'raises FinAppsCore::MissingArgumentsError if method is NOT provided' do
+      expect { base_client.send_request(nil, :get) }
+        .to(raise_error(FinAppsCore::MissingArgumentsError, ': path'))
     end
 
-    it 'should raise FinAppsCore::MissingArgumentsError if path is NOT provided' do
-      expect { subject.send_request('fake_path', nil) }.to raise_error(FinAppsCore::MissingArgumentsError,
-                                                                       ': method')
+    it 'raises FinAppsCore::MissingArgumentsError if path is NOT provided' do
+      expect { base_client.send_request('fake_path', nil) }
+        .to raise_error(FinAppsCore::MissingArgumentsError, ': method')
     end
 
     context 'when method and path are provided' do
-      subject { FinAppsCore::REST::BaseClient.new(valid_tenant_options).send_request('relevance/ruleset/names', :get) }
-      let(:return_array) { %i[RESPONSE ERROR_MESSAGES] }
+      subject(:results) do
+        described_class.new(valid_tenant_options)
+                       .send_request('relevance/ruleset/names', :get)
+      end
+
+      it('returns an array') do
+        expect(results).to be_a(Array)
+      end
 
-      it('returns an array of 2 items') do
-        expect(subject).to be_a(Array)
-        expect(subject.size).to eq(return_array.length)
+      it('returns an array of length=2') do
+        expect(results.size).to eq(2)
       end
 
-      context 'for client errors' do
-        subject { FinAppsCore::REST::BaseClient.new(valid_tenant_options).send_request('client_error', :get) }
+      context 'with client errors' do
+        subject(:client_error) do
+          described_class.new(valid_tenant_options)
+                         .send_request('client_error', :get)
+        end
 
-        it('result is null') { expect(subject[RESPONSE]).to be_nil }
-        it('error_messages is an array') { expect(subject[ERROR_MESSAGES]).to be_a(Array) }
-        it('error_messages gets populated') { expect(subject[ERROR_MESSAGES].first).to eq 'Password Minimum size is 8' }
+        it('result is null') { expect(client_error[RESPONSE]).to be_nil }
+
+        it('error_messages is an array') {
+          expect(client_error[ERROR_MESSAGES]).to be_a(Array)
+        }
+
+        it('error_messages gets populated') {
+          expect(client_error[ERROR_MESSAGES].first)
+            .to eq 'Password Minimum size is 8'
+        }
       end
 
-      context 'for server errors' do
-        subject { FinAppsCore::REST::BaseClient.new(valid_tenant_options).send_request('server_error', :get) }
+      context 'with server errors' do
+        subject(:server_error) do
+          described_class.new(valid_tenant_options)
+                         .send_request('server_error', :get)
+        end
+
+        it('the result should be nil') {
+          expect(server_error[RESPONSE]).to be_nil
+        }
+
+        it('error messages should not be nil') {
+          expect(server_error[ERROR_MESSAGES]).not_to be_nil
+        }
+
+        it('error messages should be an array') {
+          expect(server_error[ERROR_MESSAGES]).to be_a(Array)
+        }
 
-        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].first).to eq 'the server responded with status 500' }
+        it('the first error message should match') {
+          expect(server_error[ERROR_MESSAGES].first)
+            .to eq 'the server responded with status 500'
+        }
       end
 
-      context 'for proxy errors' do
-        subject { FinAppsCore::REST::BaseClient.new(valid_tenant_options).send_request('proxy_error', :get) }
-        it { expect { subject }.to raise_error(FinAppsCore::ConnectionFailedError, 'Connection Failed') }
+      context 'with proxy errors' do
+        subject(:proxy_error) do
+          described_class.new(valid_tenant_options)
+                         .send_request('proxy_error', :get)
+        end
+
+        it {
+          expect { proxy_error }
+            .to(raise_error(FinAppsCore::ConnectionFailedError,
+                            'Connection Failed'))
+        }
       end
     end
 
-    context 'if a block is provided' do
+    context 'when a block is provided' do
       it('gets executed on the response and returned as the result') do
-        expect(subject.send_request('relevance/ruleset/names', :get) {|r| r.body.length }).to eq([45, []])
+        expect(base_client
+          .send_request('relevance/ruleset/names', :get) {|r| r.body.length })
+          .to eq([45, []])
       end
     end
   end
 
   describe '#method_missing' do
-    context 'for unsupported methods' do
-      it { expect { subject.unsupported }.to raise_error(NoMethodError) }
+    context 'with unsupported methods' do
+      it { expect { base_client.unsupported }.to raise_error(NoMethodError) }
     end
   end
 
   describe '#respond_to_missing?' do
-    context 'for supported methods' do
+    context 'with supported methods' do
       %i[get post put delete].each do |method|
-        it("responds to #{method}") { expect(subject).to respond_to(method) }
+        it("responds to #{method}") {
+          expect(base_client).to respond_to(method)
+        }
       end
     end
   end

data/spec/rest/configuration_spec.rb

@@ -4,41 +4,48 @@ require 'finapps_core/error'
 
 RSpec.describe FinAppsCore::REST::Configuration do
   describe '#new' do
-    context 'for invalid timeout configuration' do
-      subject { FinAppsCore::REST::Configuration.new(timeout: 'whatever') }
+    context 'with invalid timeout configuration' do
+      subject(:configuration) { described_class.new(timeout: 'whatever') }
+
       expected_error = FinAppsCore::InvalidArgumentsError
-      it { expect { subject }.to raise_error(expected_error, 'Invalid argument. {timeout: whatever}') }
+      it { expect { configuration }.to raise_error(expected_error, 'Invalid argument. {timeout: whatever}') }
     end
 
-    context 'for missing timeout configuration' do
-      subject { FinAppsCore::REST::Configuration.new(timeout: nil) }
-      it 'should have a default timeout value' do
-        expect(subject.timeout).to eq(FinAppsCore::REST::Defaults::DEFAULTS[:timeout])
+    context 'with missing timeout configuration' do
+      subject(:configuration) { described_class.new(timeout: nil) }
+
+      it 'has a default timeout value' do
+        expect(configuration.timeout).to eq(FinAppsCore::REST::Defaults::DEFAULTS[:timeout])
       end
     end
 
-    context 'for invalid host configuration' do
-      subject { FinAppsCore::REST::Configuration.new(host: 'whatever') }
+    context 'with invalid host configuration' do
+      subject(:configuration) { described_class.new(host: 'whatever') }
+
       expected_error = FinAppsCore::InvalidArgumentsError
-      it { expect { subject }.to raise_error(expected_error, 'Invalid argument. {host: whatever}') }
+      it { expect { configuration }.to raise_error(expected_error, 'Invalid argument. {host: whatever}') }
     end
 
-    context 'for missing host configuration' do
-      subject { FinAppsCore::REST::Configuration.new(host: nil) }
-      it 'should have a default host value' do
-        expect(subject.host).to eq(FinAppsCore::REST::Defaults::DEFAULTS[:host])
+    context 'with missing host configuration' do
+      subject(:configuration) { described_class.new(host: nil) }
+
+      it 'has a default host value' do
+        expect(configuration.host).to eq(FinAppsCore::REST::Defaults::DEFAULTS[:host])
       end
     end
   end
 
   describe '#valid_user_credentials??' do
     context 'when user credentials were not set' do
-      subject { FinAppsCore::REST::Configuration.new(host: nil) }
-      it { expect(subject.valid_user_credentials?).to eq(false) }
+      subject(:configuration) { described_class.new(host: nil) }
+
+      it { expect(configuration.valid_user_credentials?).to eq(false) }
     end
+
     context 'when user credentials were set' do
-      subject { FinAppsCore::REST::Configuration.new(user_identifier: 1, user_token: 2) }
-      it { expect(subject.valid_user_credentials?).to eq(true) }
+      subject(:configuration) { described_class.new(user_identifier: 1, user_token: 2) }
+
+      it { expect(configuration.valid_user_credentials?).to eq(true) }
     end
   end
 end

data/spec/rest/credentials_spec.rb

@@ -3,19 +3,19 @@
 RSpec.describe FinAppsCore::REST::Credentials do
   describe '#valid?' do
     context 'when missing identifier' do
-      it { expect(FinAppsCore::REST::Credentials.new(nil, :token).valid?).to eql(true) }
+      it { expect(described_class.new(nil, :token).valid?).to be(true) }
     end
 
     context 'when missing token' do
-      it { expect(FinAppsCore::REST::Credentials.new(:identifier, nil).valid?).to eql(false) }
+      it { expect(described_class.new(:identifier, nil).valid?).to be(false) }
     end
 
     context 'when missing both identifier and token' do
-      it { expect(FinAppsCore::REST::Credentials.new(nil, nil).valid?).to eql(false) }
+      it { expect(described_class.new(nil, nil).valid?).to be(false) }
     end
 
     context 'when having identifier and token' do
-      it { expect(FinAppsCore::REST::Credentials.new(:identifier, :token).valid?).to eql(true) }
+      it { expect(described_class.new(:identifier, :token).valid?).to be(true) }
     end
   end
 end

data/spec/rest/defaults_spec.rb

@@ -12,6 +12,6 @@ RSpec.describe FinAppsCore::REST::Defaults do
     it('sets DEFAULTS[:host]') { expect(described_class::DEFAULTS[:host]).to eq 'https://api.finclear.io' }
     it('sets DEFAULTS[:timeout]') { expect(described_class::DEFAULTS[:timeout]).to eq 30 }
     it('does not set DEFAULTS[:proxy]') { expect(described_class::DEFAULTS[:proxy]).to be_nil }
-    it('sets DEFAULTS[:log_level]') { expect(described_class::DEFAULTS[:log_level]).to eq Logger::INFO }
+    it('sets DEFAULTS[:log_level]') { expect(described_class::DEFAULTS[:log_level]).to eq Logger::UNKNOWN }
   end
 end

data/spec/rest/resources_spec.rb

@@ -1,30 +1,20 @@
 # frozen_string_literal: true
 
-require 'spec_helpers/client'
-
 RSpec.describe FinAppsCore::REST::Resources do
-  include SpecHelpers::Client
-  subject { FinAppsCore::REST::Resources.new client }
-
   describe '#new' do
-    context 'for a valid client param' do
-      it { expect { subject }.not_to raise_error }
+    context 'with a valid client param' do
+      subject(:resources) { described_class.new :client }
+
+      it { expect { resources }.not_to raise_error }
     end
 
     context 'when missing client param' do
-      subject { FinAppsCore::REST::Resources.new nil }
-      it { expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError) }
-    end
-  end
+      subject(:resources) { described_class.new nil }
 
-  describe '#list' do
-  end
-  describe '#create' do
-  end
-  describe '#update' do
-  end
-  describe '#show' do
-  end
-  describe '#destroy' do
+      it {
+        expect { resources }
+          .to raise_error(FinAppsCore::MissingArgumentsError)
+      }
+    end
   end
 end

data/spec/spec_helper.rb

@@ -29,12 +29,12 @@ RSpec.configure do |config|
   config.warnings = true
   Kernel.srand config.seed
 
-  config.before(:each) do
+  config.before do
     base_url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v#{FinAppsCore::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',
-                      token: 'hohoho=' }.freeze
+VALID_CREDENTIALS = {identifier: '49fb918d-7e71-44dd-7378-58f19606df2a',
+                     token: 'hohoho='}.freeze

data/spec/utils/validatable_spec.rb

@@ -6,19 +6,20 @@ end
 
 RSpec.describe FinAppsCore::Utils::Validatable do
   describe '#not_blank' do
-    context 'for null values' do
-      it 'should raise FinAppsCore::MissingArgumentsError' do
-        expect { FakeClass.new.not_blank(nil) }.to raise_error(FinAppsCore::MissingArgumentsError)
+    context 'with null values' do
+      it 'raises FinAppsCore::MissingArgumentsError' do
+        expect { FakeClass.new.not_blank(nil) }
+          .to raise_error(FinAppsCore::MissingArgumentsError)
       end
 
-      it 'should describe the argument name when provided' do
-        expect { FakeClass.new.not_blank(nil, :name) }.to raise_error(FinAppsCore::MissingArgumentsError,
-                                                                      ': name')
+      it 'describes the argument name when provided' do
+        expect { FakeClass.new.not_blank(nil, :name) }
+          .to raise_error(FinAppsCore::MissingArgumentsError, ': name')
       end
     end
 
-    context 'for non null values' do
-      it 'should not raise' do
+    context 'with non null values' do
+      it 'does not raise' do
         expect { FakeClass.new.not_blank(true) }.not_to raise_error
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps_core
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.0.9
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -116,100 +116,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.73.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.73'
+        version: '0.86'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.73.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.73'
+        version: '0.86'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.33.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.40'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.33.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.40'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.40.0
 - !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.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 description: A simple library for communicating with the FinApps REST API. Core functionality.
 email:
 - erich@financialapps.com
@@ -267,10 +267,12 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".tmuxinator.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
+- RELEASES.md
 - Rakefile
 - finapps_core.gemspec
 - lib/core_extensions/object/is_integer.rb
@@ -283,6 +285,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 +303,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,24 +345,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client - Core.
 test_files:
-- 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/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/middleware/request/no_encoding_basic_authentication_spec.rb
+- spec/middleware/response/raise_error_spec.rb
 - spec/middleware/request/user_agent_spec.rb
+- spec/middleware/request/request_id_spec.rb
 - spec/middleware/request/tenant_authentication_spec.rb
 - spec/middleware/request/accept_json_spec.rb
-- spec/middleware/request/request_id_spec.rb
-- spec/middleware/response/raise_error_spec.rb
+- spec/middleware/request/x_consumer_id_spec.rb
+- spec/middleware/request/no_encoding_basic_authentication_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/client.rb
+- spec/utils/validatable_spec.rb
+- spec/support/fake_api.rb
+- spec/core_extensions/object/is_integer_spec.rb
+- spec/rest/credentials_spec.rb
+- spec/rest/base_client_spec.rb
+- spec/rest/configuration_spec.rb
+- spec/rest/defaults_spec.rb
+- spec/rest/resources_spec.rb