finapps 1.0.8 → 2.0.2

data/lib/finapps.rb

@@ -1,39 +1,27 @@
 require 'finapps/version' unless defined?(FinApps::VERSION)
-require 'logger' unless defined?(::Logger)
-require 'pp'
 
 require 'faraday'
 require 'faraday_middleware'
 require 'typhoeus'
 require 'typhoeus/adapters/faraday'
 
-require 'finapps/utils/logging'
-require 'finapps/utils/utils'
-require 'finapps/middleware/api_token'
-require 'finapps/middleware/raise_http_exceptions'
-require 'finapps/middleware/response_logger'
+require 'finapps/core_extensions/object/blank'
+require 'finapps/core_extensions/hash/compact'
+require 'finapps/core_extensions/integerable'
+require 'finapps/hash_constructable'
+require 'finapps/utils/loggeable'
+require 'finapps/error'
 
-require 'finapps/rest/defaults'
-require 'finapps/rest/errors'
+require 'finapps/middleware/tenant_authentication'
+require 'finapps/middleware/raise_error'
 
+require 'finapps/rest/defaults'
 require 'finapps/rest/resource'
 require 'finapps/rest/resources'
 
 require 'finapps/rest/users'
-require 'finapps/rest/institutions'
-require 'finapps/rest/user_institutions'
-require 'finapps/rest/transactions'
-require 'finapps/rest/categories'
-require 'finapps/rest/budget_models'
-require 'finapps/rest/budget_calculation'
-require 'finapps/rest/budgets'
-require 'finapps/rest/cashflows'
-require 'finapps/rest/alert'
-require 'finapps/rest/alert_definition'
-require 'finapps/rest/alert_settings'
-require 'finapps/rest/alert_preferences'
-
-require 'finapps/rest/relevance/rulesets'
 
+require 'finapps/rest/configuration'
 require 'finapps/rest/connection'
+require 'finapps/rest/base_client'
 require 'finapps/rest/client'

data/lib/tasks/releaser.rake

@@ -1,5 +1,5 @@
 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
-  system "gem bump --tag --release"
-end
+  system 'gem bump --tag --release'
+end

data/spec/middleware/tenant_authentication_spec.rb

@@ -0,0 +1,29 @@
+RSpec.describe FinApps::Middleware::TenantAuthentication do
+  let(:valid_tenant_options) { VALID_CREDENTIALS }
+  let(:key) { FinApps::Middleware::TenantAuthentication::KEY }
+
+  describe '#call' 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(:expected_header) { "#{valid_tenant_options[:identifier]}=#{valid_tenant_options[:token]}" }
+
+      context 'when header was not previously set' do
+        let(:request_env) { {request_headers: {}} }
+        subject(:actual_header) { middleware.call(request_env)[:request_headers][key] }
+
+        it('generates a Tenant Authentication header') { expect(actual_header).to eq(expected_header) }
+      end
+
+      context 'when header was previously set' do
+        let(:existing_header) { {FinApps::Middleware::TenantAuthentication::KEY => 'foo'} }
+        let(:request_env) { {request_headers: existing_header} }
+        subject(:actual_header) { middleware.call(request_env)[:request_headers][key] }
+
+        it('does not override existing Tenant Authentication header') { expect(actual_header).to eq('foo') }
+        it('does not generate a Tenant Authentication header') { expect(actual_header).to_not eq(expected_header) }
+      end
+    end
+  end
+end

data/spec/rest/base_client_spec.rb

@@ -0,0 +1,89 @@
+RSpec.describe FinApps::REST::BaseClient do
+  let(:valid_tenant_options) { {tenant_credentials: VALID_CREDENTIALS} }
+  subject { FinApps::REST::BaseClient.new(valid_tenant_options) }
+
+  RESPONSE = 0
+  ERROR_MESSAGES = 1
+  let(:return_array) { %i(RESPONSE ERROR_MESSAGES) }
+
+  describe '#new' do
+    it 'assigns @config' do
+      expect(subject.config).to be_a(FinApps::REST::Configuration)
+    end
+  end
+
+  describe '#connection' do
+    it 'created a Faraday connection object' do
+      expect(subject.connection).to be_a(Faraday::Connection)
+    end
+
+    it 'memoizes the results' do
+      first = subject.connection
+      second = subject.connection
+      expect(first.object_id).to eq(second.object_id)
+    end
+  end
+
+  describe '#send_request' do
+    it 'should raise FinApps::MissingArgumentsError if method is NOT provided' do
+      expect { subject.send_request(nil, :get) }.to raise_error(FinApps::MissingArgumentsError)
+    end
+
+    it 'should raise FinApps::MissingArgumentsError if path is NOT provided' do
+      expect { subject.send_request('fake_path', nil) }.to raise_error(FinApps::MissingArgumentsError)
+    end
+
+    context 'when method and path are provided' do
+      subject { FinApps::REST::BaseClient.new(valid_tenant_options).send_request('relevance/ruleset/names', :get) }
+      let(:return_array) { %i(RESPONSE ERROR_MESSAGES) }
+
+      it('returns an array of 2 items') do
+        expect(subject).to be_a(Array)
+        expect(subject.size).to eq(return_array.length)
+      end
+
+      context 'for unsupported methods' do
+        subject { FinApps::REST::BaseClient.new(valid_tenant_options).send_request('users', :options) }
+
+        it do
+          expect { subject.send_request(nil, :get) }
+            .to raise_error(FinApps::InvalidArgumentsError, 'Method not supported: options.')
+        end
+      end
+
+      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 }
+      end
+
+      context 'for server errors' do
+        subject { FinApps::REST::BaseClient.new(valid_tenant_options).send_request('server_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].first).to eq 'the server responded with status 500' }
+      end
+
+      context 'for proxy errors' do
+        subject { FinApps::REST::BaseClient.new(valid_tenant_options).send_request('proxy_error', :get) }
+
+        it do
+          expect { subject.send_request(nil, :get) }
+            .to raise_error(Faraday::ConnectionFailed, '407 "Proxy Authentication Required"')
+        end
+      end
+    end
+
+    context 'if a block is provided' do
+      it('gets executed on the response') do
+        expect(subject.send_request('relevance/ruleset/names', :get, &:status)[RESPONSE]).to eq(200)
+        expect(subject.send_request('relevance/ruleset/names', :get) {|r| r.body.length }[RESPONSE]).to eq(45)
+      end
+    end
+  end
+end

data/spec/rest/client_spec.rb

@@ -1,122 +1,36 @@
 RSpec.describe FinApps::REST::Client do
-
   describe '#new' do
-
-    context 'when company_identifier is NOT provided' do
-      it { expect { FinApps::REST::Client.new nil, :company_token }.to raise_error(FinApps::REST::MissingArgumentsError) }
-    end
-
-    context 'when company_token is NOT provided' do
-      it { expect { FinApps::REST::Client.new :company_identifier, nil }.to raise_error(FinApps::REST::MissingArgumentsError) }
-    end
-
-    context 'when company_identifier is not string or symbol' do
-      it { expect { FinApps::REST::Client.new 1, :company_token }.to raise_error(FinApps::REST::InvalidArgumentsError) }
+    it 'raises for missing company_identifier' do
+      expect { FinApps::REST::Client.new nil, :company_token }.to raise_error(FinApps::MissingArgumentsError)
     end
 
-    context 'when company_token is not string or symbol' do
-      it { expect { FinApps::REST::Client.new :company_identifier, 1 }.to raise_error(FinApps::REST::InvalidArgumentsError) }
+    it 'raises for missing company_token' do
+      expect { FinApps::REST::Client.new :company_identifier, nil }.to raise_error(FinApps::MissingArgumentsError)
     end
-
-    context 'when options are not provided' do
-      it { expect { FinApps::REST::Client.new :company_identifier, :company_token }.not_to raise_error }
-    end
-
   end
 
-  context 'after initialized' do
+  context 'an instance of Client' do
+    subject { FinApps::REST::Client.new(:company_identifier, :company_token) }
 
-    let(:client) { FinApps::REST::Client.new(:company_identifier, :company_token) }
-
-    [:send_request, :connection, :users, :institutions, :user_institutions, :transactions,
-     :categories, :budget_models, :budget_calculation, :budgets, :cashflows, :alert,
-     :alert_definition, :alert_preferences, :alert_settings, :rule_sets, :user_credentials!].each do |method|
+    %i(users).each do |method|
       it "responds to #{method}" do
-        expect(client).to respond_to(method)
+        expect(subject).to respond_to(method)
       end
     end
 
     describe '#users' do
-      it { expect(client.users).to be_an_instance_of(FinApps::REST::Users) }
-    end
-
-    describe '#institutions' do
-      it { expect(client.institutions).to be_an_instance_of(FinApps::REST::Institutions) }
-    end
-
-    describe '#user_institutions' do
-      it { expect(client.user_institutions).to be_an_instance_of(FinApps::REST::UserInstitutions) }
-    end
-
-    describe '#categories' do
-      it { expect(client.categories).to be_an_instance_of(FinApps::REST::Categories) }
-    end
-
-    describe '#budget_models' do
-      it { expect(client.budget_models).to be_an_instance_of(FinApps::REST::BudgetModels) }
-    end
-
-    describe '#budget_calculation' do
-      it { expect(client.budget_calculation).to be_an_instance_of(FinApps::REST::BudgetCalculation) }
-    end
-
-    describe '#budgets' do
-      it { expect(client.budgets).to be_an_instance_of(FinApps::REST::Budgets) }
-    end
-
-    describe '#cashflows' do
-      it { expect(client.cashflows).to be_an_instance_of(FinApps::REST::Cashflows) }
+      it { expect(subject.users).to be_an_instance_of(FinApps::REST::Users) }
     end
 
-    describe '#alert' do
-      it { expect(client.alert).to be_an_instance_of(FinApps::REST::Alert) }
-    end
-
-    describe '#alert_definition' do
-      it { expect(client.alert_definition).to be_an_instance_of(FinApps::REST::AlertDefinition) }
-    end
-
-    describe '#alert_preferences' do
-      it { expect(client.alert_preferences).to be_an_instance_of(FinApps::REST::AlertPreferences) }
-    end
-
-    describe '#alert_settings' do
-      it { expect(client.alert_settings).to be_an_instance_of(FinApps::REST::AlertSettings) }
-    end
-
-    describe '#rule_sets' do
-      it { expect(client.rule_sets).to be_an_instance_of(FinApps::REST::Relevance::Rulesets) }
-    end
-
-    describe '#connection' do
-      it { expect(client.connection).to be_an_instance_of(Faraday::Connection) }
-    end
-
-    [:connection, :users, :institutions, :user_institutions, :transactions,
-     :categories, :budget_models, :budget_calculation, :budgets, :cashflows, :alert,
-     :alert_definition, :alert_preferences, :alert_settings, :rule_sets].each do |method|
+    # [:users, :institutions, :user_institutions, :transactions, :categories,
+    # :budget_models, :budget_calculation, :budgets, :cashflows,
+    # :alert, :alert_definition, :alert_preferences, :alert_settings, :rule_sets]
+    [:users].each do |method|
       it "memoizes the result of #{method}" do
-        first, second = client.send(method), client.send(method)
+        first = subject.send(method)
+        second = subject.send(method)
         expect(first.object_id).to eq(second.object_id)
       end
     end
-
-    describe '#send_request' do
-
-      context 'when path is NOT provided' do
-        it { expect { client.send_request(nil, :post) }.to raise_error(FinApps::REST::MissingArgumentsError) }
-      end
-
-      context 'when method is NOT provided' do
-        it { expect { client.send_request(:path, nil) }.to raise_error(FinApps::REST::MissingArgumentsError) }
-      end
-
-      context 'when method is NOT supported' do
-        it { expect { client.send_request(:path, :unsupported_method) }.to raise_error(FinApps::REST::InvalidArgumentsError) }
-      end
-
-    end
-
   end
-
-end
+end

data/spec/rest/configuration_spec.rb

@@ -0,0 +1,75 @@
+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.')
+    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.')
+    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.')
+    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
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,25 +3,28 @@ Bundler.setup
 
 require 'finapps'
 require 'webmock/rspec'
-require File.join(File.dirname(__dir__),  'spec/support/fake_api')
+
+# noinspection RubyResolve
+require File.join(File.dirname(__dir__), 'spec/support/fake_api')
 
 RSpec.configure do |config|
   config.expect_with(:rspec) do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
     expectations.syntax = :expect
   end
-  config.mock_with(:rspec) { |mocks| mocks.verify_partial_doubles = true }
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
+  config.mock_with(:rspec) {|mocks| mocks.verify_partial_doubles = true }
+  # config.filter_run_including :focus => true
   config.default_formatter = 'doc' if config.files_to_run.one?
   config.order = :random
   config.example_status_persistence_file_path = 'spec/examples.txt'
-  #config.disable_monkey_patching!
   config.warnings = true
-  config.profile_examples = 5
   Kernel.srand config.seed
 
   config.before(:each) do
-    stub_request(:any, /api.financialapps.com/).to_rack(::FakeApi )
+    base_url = "#{FinApps::REST::Defaults::DEFAULTS[:host]}/v#{FinApps::REST::Defaults::API_VERSION}/"
+    stub_request(:any, /#{base_url}/).to_rack(::FakeApi)
   end
 end
+
+VALID_CREDENTIALS = {identifier: '49fb918d-7e71-44dd-7378-58f19606df2a',
+                     token:      'hohoho='}.freeze

data/spec/support/fake_api.rb

@@ -2,7 +2,14 @@ require 'sinatra/base'
 
 class FakeApi < Sinatra::Base
   # users
-  get('/v1/users/:id') { json_response 200, 'user.json' }
+  get('/users/:id') { json_response 200, 'user.json' }
+
+  # relevance
+  get('/v2/relevance/ruleset/names') { json_response 200, 'relevance_ruleset_names.json' }
+
+  get('/v2/client_error') { json_response 400, 'error.json' }
+  get('/v2/server_error') { status 500 }
+  get('/v2/proxy_error') { status 407 }
 
   private
 
@@ -11,4 +18,4 @@ class FakeApi < Sinatra::Base
     status response_code
     File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
   end
-end
+end

data/spec/support/fixtures/error.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "Password Minimum size is 8"
+  ]
+}

data/spec/support/fixtures/relevance_ruleset_names.json

@@ -0,0 +1,47 @@
+[
+  "accounts_overview",
+  "alert_cash_withdrawal",
+  "alert_deposits",
+  "alert_low_avg_balance",
+  "alert_low_cash_flow",
+  "alert_merchant_breach",
+  "budet_wip03",
+  "budget",
+  "budget_wip",
+  "budget_wip02",
+  "budget_wip03",
+  "budget_wip04",
+  "budget_wip05",
+  "budget_wip06",
+  "budget_wip07",
+  "budget_wip08",
+  "bug_test",
+  "cashflow",
+  "cashflow_02",
+  "cashflow_detail",
+  "cashflow_old",
+  "demo",
+  "formfree_structure",
+  "fraud",
+  "fraud_alert_cash_withdrawal",
+  "fraud_alert_double_charge",
+  "hello_dom_breakpoint",
+  "hello_jira",
+  "hello_temp",
+  "iav_avg_dep_velocity",
+  "iav_avg_dly_bal",
+  "iav_avg_income",
+  "iav_avg_spend",
+  "iav_balance_summary",
+  "iav_cash_flow",
+  "iav_eod_balance",
+  "iav_low_bal_trends",
+  "iav_nsf",
+  "iav_payroll",
+  "iav_report_summary",
+  "iav_risk_score",
+  "inventory_testing",
+  "loopWIP",
+  "mysql",
+  "simple_rule_data"
+]