finapps_core 2.0.2

data/spec/rest/configuration_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+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') }
+      expected_error = FinAppsCore::InvalidArgumentsError
+      it { expect { subject }.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])
+      end
+    end
+
+    context 'for invalid host configuration' do
+      subject { FinAppsCore::REST::Configuration.new(host: 'whatever') }
+      expected_error = FinAppsCore::InvalidArgumentsError
+      it { expect { subject }.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])
+      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) }
+    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) }
+    end
+  end
+end

data/spec/rest/credentials_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+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(false) }
+    end
+
+    context 'when missing token' do
+      it { expect(FinAppsCore::REST::Credentials.new(:identifier, nil).valid?).to eql(false) }
+    end
+
+    context 'when missing both identifier and token' do
+      it { expect(FinAppsCore::REST::Credentials.new(nil, nil).valid?).to eql(false) }
+    end
+
+    context 'when having identifier and token' do
+      it { expect(FinAppsCore::REST::Credentials.new(:identifier, :token).valid?).to eql(true) }
+    end
+  end
+end

data/spec/rest/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"
+]

data/spec/rest/timeout_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+RSpec.describe FinAppsCore::REST::Resources do
+  describe 'timeout' do
+    subject { FinAppsCore::REST::Resources.new(FinAppsCore::REST::BaseClient.new({})).show(:timeout) }
+    it { expect { subject }.to raise_error(FinAppsCore::ApiSessionTimeoutError) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'finapps_core'
+require 'webmock/rspec'
+
+# 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_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.warnings = true
+  Kernel.srand config.seed
+
+  config.before(:each) 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

data/spec/spec_helpers/client.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module SpecHelpers
+  module Client
+    def client
+      FinAppsCore::REST::Client.new :tenant_id, :tenant_token
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'sinatra/base'
+
+# the FakeApi class is used to mock API requests while testing.
+class FakeApi < Sinatra::Base
+  # timeout
+  get('/v2/resources/timeout') { status 419 }
+
+  # resource
+  post('/v2/resources') { json_response 201, 'resource.json' }
+  get('/v2/resources/:id') { json_response 200, 'resource.json' }
+  get('/v2/resources') { json_response 200, 'resources.json' }
+  put('/v2/resources') { json_response 201, 'resource.json' }
+  delete('/v2/resources/:id') { status 202 }
+
+  # version
+  get('/v2/version') { 'Version => 2.1.29-.20161208.172810' }
+
+  # errors
+  get('/v2/client_error') { json_response 400, 'error.json' }
+  get('/v2/server_error') { status 500 }
+  get('/v2/proxy_error') { status 407 }
+
+  # relevance
+  get('/v2/relevance/ruleset/names') { json_response 200, 'relevance_ruleset_names.json' }
+
+  private
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  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"
+]

data/spec/support/fixtures/resource.json

@@ -0,0 +1,3 @@
+{
+  "public_id":"83e6c55a-9883-40bb-45f9-fc70d70731c9"
+}

data/spec/support/fixtures/resource_not_found.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "Resource not found"
+  ]
+}

data/spec/support/fixtures/resources.json

@@ -0,0 +1,11 @@
+{
+  "total": 2,
+  "resources": [
+    {
+      "public_id": "83e6c55a-9883-40bb-45f9-fc70d70731c9"
+    },
+    {
+      "public_id": "83e6c55a-9883-40bb-45f9-fc70d70731c9"
+    }
+  ]
+}

data/spec/support/fixtures/unauthorized.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "Invalid User Identifier or Credentials"
+  ]
+}

data/spec/utils/parameter_filter_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+class FakeClass
+  include ::FinAppsCore::Utils::ParameterFilter
+end
+
+RSpec.describe FinAppsCore::Utils::ParameterFilter do
+  describe '#skip_sensitive_data' do
+    context 'when provided with sensitive data' do
+      let(:unfiltered_params) do
+        {password: 'FinApps@123', password_confirm: 'FinApps@123', token: '123456',
+         login: 'sammysosa', username: 'johnny', name: 'george'}
+      end
+      let(:filtered_params) do
+        {password: '[REDACTED]', password_confirm: '[REDACTED]', token: '[REDACTED]',
+         login: '[REDACTED]', username: '[REDACTED]', name: 'george'}
+      end
+
+      it 'filters out sensitive values' do
+        expect(FakeClass.new.skip_sensitive_data(unfiltered_params)).to eq(filtered_params)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,353 @@
+--- !ruby/object:Gem::Specification
+name: finapps_core
+version: !ruby/object:Gem::Version
+  version: 2.0.2
+platform: ruby
+authors:
+- Erich Quintero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: rash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+description: A simple library for communicating with the FinApps REST API. Core functionality.
+email:
+- erich@financialapps.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- finapps_core.gemspec
+- lib/core_extensions/object/blank.rb
+- lib/core_extensions/object/is_integer.rb
+- lib/core_extensions/string/json_to_hash.rb
+- lib/finapps_core.rb
+- lib/finapps_core/error.rb
+- lib/finapps_core/middleware/middleware.rb
+- lib/finapps_core/middleware/request/accept_json.rb
+- lib/finapps_core/middleware/request/no_encoding_basic_authentication.rb
+- lib/finapps_core/middleware/request/tenant_authentication.rb
+- lib/finapps_core/middleware/request/user_agent.rb
+- lib/finapps_core/middleware/response/custom_logger.rb
+- lib/finapps_core/middleware/response/raise_error.rb
+- lib/finapps_core/rest/base_client.rb
+- lib/finapps_core/rest/configuration.rb
+- lib/finapps_core/rest/connection.rb
+- lib/finapps_core/rest/credentials.rb
+- lib/finapps_core/rest/defaults.rb
+- lib/finapps_core/rest/resources.rb
+- lib/finapps_core/utils/loggeable.rb
+- lib/finapps_core/utils/parameter_filter.rb
+- lib/finapps_core/version.rb
+- lib/tasks/releaser.rake
+- spec/core_extensions/object/blank_spec.rb
+- spec/core_extensions/object/is_integer_spec.rb
+- spec/middleware/request/accept_json_spec.rb
+- spec/middleware/request/no_encoding_basic_authentication_spec.rb
+- spec/middleware/request/tenant_authentication_spec.rb
+- spec/middleware/request/user_agent_spec.rb
+- spec/middleware/response/raise_error_spec.rb
+- spec/rest/base_client_spec.rb
+- spec/rest/configuration_spec.rb
+- spec/rest/credentials_spec.rb
+- spec/rest/relevance_ruleset_names.json
+- spec/rest/timeout_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/client.rb
+- spec/support/fake_api.rb
+- spec/support/fixtures/error.json
+- spec/support/fixtures/relevance_ruleset_names.json
+- spec/support/fixtures/resource.json
+- spec/support/fixtures/resource_not_found.json
+- spec/support/fixtures/resources.json
+- spec/support/fixtures/unauthorized.json
+- spec/utils/parameter_filter_spec.rb
+homepage: https://github.com/finapps/ruby-client-core
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- finapps-ruby-core
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: FinApps REST API ruby client - Core.
+test_files:
+- spec/rest/base_client_spec.rb
+- spec/rest/credentials_spec.rb
+- spec/rest/configuration_spec.rb
+- spec/rest/timeout_spec.rb
+- spec/support/fake_api.rb
+- spec/utils/parameter_filter_spec.rb
+- spec/spec_helpers/client.rb
+- spec/spec_helper.rb
+- spec/core_extensions/object/is_integer_spec.rb
+- spec/core_extensions/object/blank_spec.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/accept_json_spec.rb
+- spec/middleware/response/raise_error_spec.rb