finapps 6.5.0 → 6.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e80a928ff71e2322588992ecaaccb749ef54da3885b691b7397fc0e78be6061
-  data.tar.gz: c37736f652f09f2c7066e9a45df9c4718b9c933d914716251d5e3105d9bb465f
+  metadata.gz: c1007bb9e3b614755fa3252fe8c53958f0a9f093997b8910e2eb29ea38082dec
+  data.tar.gz: 9991cf065517607999949265e2b3c2e7214edbea5c9120bb2f01e11133b6a03d
 SHA512:
-  metadata.gz: f7a0e0ca416920b490133e964d36b4a6a86a0c5c759cbf01a30e1b3158ef66abe1c67ecf3fe2d90fb20355824a69839585090bb16fe21448468c28704bab32aa
-  data.tar.gz: 33788efee5a351ff06001daa933578a54965de86e9b949cc8b1631e93a3c890f888d890a5e5e9af8939679d0bf2ba83702034621ae10503d27885aced872e8a3
+  metadata.gz: 541d42baf3992dc7e7a5a2417d95b9d7d10f886913df1123dc9ff2bc2f62918389a0cac5fbb5aab04ab2544d0c2b4bdaf512fb1a2e0e4e8a1ecdf7495144f24b
+  data.tar.gz: ab496f7a9823916ba5e3493860298c068d9643a193e048e0aec74bf0858bea4a690d561c82257e934e952f6e0de1b7ceda10a0a5afa0dc95abcf952967e40b71

data/.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
 
       - name: Install required ruby version
         uses: ruby/setup-ruby@v1

data/.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps: 
       - name: Checkout source code
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
         with:
           persist-credentials: false
           fetch-depth: 0 # otherwise, you will fail to push refs to dest repo

data/.github/workflows/verify-pr-labeled.yml

@@ -7,7 +7,7 @@ jobs:
   label:
     runs-on: ubuntu-latest
     steps:
-      - uses: mheap/github-action-required-labels@v1.1.2
+      - uses: mheap/github-action-required-labels@v1.2
         with:
           mode: minimum
           count: 1

data/.rubocop.yml

@@ -12,6 +12,9 @@ AllCops:
   CacheRootDirectory: tmp
   NewCops: enable
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 Layout/EmptyLinesAroundAttributeAccessor:

data/finapps.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec',                      '~> 3.10',  '>= 3.10.0'
   spec.add_development_dependency 'rubocop-performance',        '~> 1.11',  '>= 1.11.5'
   spec.add_development_dependency 'rubocop-rake',               '~> 0.5',   '>= 0.5.1'
-  spec.add_development_dependency 'rubocop-rspec',              '~> 2.4',   '>= 2.4.0'
+  spec.add_development_dependency 'rubocop-rspec',              '~> 2.5',   '>= 2.5.0'
   spec.add_development_dependency 'simplecov',                  '~> 0.21',  '>= 0.21.2'
   spec.add_development_dependency 'simplecov-console',          '~> 0.9'
   spec.add_development_dependency 'sinatra',                    '~> 2.1',   '>= 2.1.0'

data/lib/finapps/rest/actors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class Actors < FinAppsCore::REST::Resources
+      END_POINT = 'actor/details'
+
+      def show
+        super nil, END_POINT
+      end
+    end
+  end
+end

data/lib/finapps/rest/client.rb

@@ -7,6 +7,7 @@ module FinApps
   module REST
     class Client < FinAppsCore::REST::BaseClient # :nodoc:
       RESOURCES = %i[
+        actors
         alert_definitions
         alert_occurrences
         consumers
@@ -41,6 +42,7 @@ module FinApps
         portfolio_reports
         products
         screenings
+        screening_metadatas
         sessions
         signed_documents_downloads
         tenant_settings
@@ -74,7 +76,7 @@ module FinApps
       end
 
       def set_variable(class_name, variable)
-        klass = Object.const_get('FinApps').const_get('REST').const_get class_name
+        klass = Object.const_get(:FinApps).const_get(:REST).const_get class_name
         instance_variable_set(variable, klass.new(self))
       end
 

data/lib/finapps/rest/screening_metadatas.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class ScreeningMetadatas < FinAppsCore::REST::Resources # :nodoc:
+      def show(id, key)
+        not_blank(id, :session_id)
+        not_blank(key, :key)
+
+        path = "screenings/#{ERB::Util.url_encode(id)}/meta/#{ERB::Util.url_encode(key)}"
+        super(nil, path)
+      end
+
+      def create(id, key, value)
+        not_blank(id, :session_id)
+        not_blank(key, :key)
+        not_blank(value, :value)
+
+        path = "screenings/#{ERB::Util.url_encode(id)}/meta"
+        super({key: key, value: value}, path)
+      end
+
+      def destroy(id, key)
+        not_blank(id, :session_id)
+        not_blank(key, :key)
+
+        path = "screenings/#{ERB::Util.url_encode(id)}/meta/#{ERB::Util.url_encode(key)}"
+        super(nil, path)
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinApps
-  VERSION = '6.5.0'
+  VERSION = '6.7.1'
 end

data/lib/finapps.rb

@@ -4,6 +4,7 @@ require 'faraday'
 require 'faraday_middleware'
 
 require 'finapps_core'
+require 'finapps/rest/actors'
 require 'finapps/rest/version'
 require 'finapps/rest/consumers'
 require 'finapps/rest/consumer_login_tokens'
@@ -39,6 +40,7 @@ require 'finapps/rest/documents_upload_types'
 require 'finapps/rest/signed_documents_downloads'
 require 'finapps/rest/documents_orders_notifications'
 require 'finapps/rest/screenings'
+require 'finapps/rest/screening_metadatas'
 
 require 'finapps/rest/plaid/plaid_resources'
 require 'finapps/rest/plaid/plaid_webhooks'

data/spec/rest/actors_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'spec_helpers/api_request'
+
+RSpec.describe FinApps::REST::Actors do
+  include SpecHelpers::Client
+
+  let(:results) { subject[RESULTS] }
+  let(:error_messages) { subject[ERROR_MESSAGES] }
+
+  describe '#show' do
+    subject(:show) { described_class.new(client).show }
+
+    context 'when authorization is not valid' do
+      before { stub_unauthorized_request }
+
+      it { expect { show }.to raise_error(FinAppsCore::ApiUnauthenticatedError) }
+    end
+
+    context 'when authorization is valid' do
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+
+      it('returns a valid actor') { expect(results).to be_a(Hash) }
+    end
+  end
+
+  def stub_unauthorized_request
+    stub_request(:get, %r{/actor/details}).to_return(
+      status: 401,
+      body: {
+        error_messages: ['Unauthorized'],
+        results: nil
+      }.to_json,
+      headers: {}
+    )
+  end
+end

data/spec/rest/screening_metadatas_spec.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'spec_helpers/api_request'
+
+RSpec.describe FinApps::REST::ScreeningMetadatas do
+  include SpecHelpers::Client
+
+  let(:results) { subject[RESULTS] }
+  let(:error_messages) { subject[ERROR_MESSAGES] }
+
+  describe '#show' do
+    subject(:show_metadata) { described_class.new(client).show(id, key) }
+
+    context 'with valid params' do
+      let(:id) { :session_id }
+      let(:key) { :key }
+
+      before { show_metadata }
+
+      it 'sends proper request' do
+        url = "#{versioned_api_path}/screenings/session_id/meta/key"
+
+        expect(WebMock).to have_requested(:get, url)
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+
+    context 'with invalid params' do
+      let(:id) { :something_else }
+      let(:key) { :key }
+
+      it_behaves_like 'an API request'
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('the screening id was not found')
+      end
+    end
+
+    context 'with missing params' do
+      let(:id) { nil }
+      let(:key) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#create' do
+    subject(:create_metadata) { described_class.new(client).create(id, key, value) }
+
+    context 'with valid params' do
+      let(:id) { :session_id }
+      let(:key) { :key }
+      let(:value) { :value }
+
+      before { create_metadata }
+
+      it 'sends proper request' do
+        url = "#{versioned_api_path}/screenings/session_id/meta"
+
+        expect(WebMock).to have_requested(:post, url)
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+
+    context 'with invalid params' do
+      let(:id) { :something_else }
+      let(:key) { :key }
+      let(:value) { :value }
+
+      it_behaves_like 'an API request'
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('the screening id was not found')
+      end
+    end
+
+    context 'with missing params' do
+      let(:id) { nil }
+      let(:key) { nil }
+      let(:value) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#destroy' do
+    subject(:destroy_metadata) { described_class.new(client).destroy(id, key) }
+
+    context 'with valid params' do
+      let(:id) { :session_id }
+      let(:key) { :key }
+
+      before { destroy_metadata }
+
+      it 'sends proper request' do
+        url = "#{versioned_api_path}/screenings/session_id/meta/key"
+
+        expect(WebMock).to have_requested(:delete, url)
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+
+    context 'with invalid params' do
+      let(:id) { :something_else }
+      let(:key) { :key }
+
+      it_behaves_like 'an API request'
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('the screening id was not found')
+      end
+    end
+
+    context 'with missing params' do
+      let(:id) { nil }
+      let(:key) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -3,6 +3,8 @@
 require 'sinatra/base'
 require_relative 'documents_uploads_routes'
 require_relative 'screenings_routes'
+require_relative 'routes/actors'
+require_relative 'routes/screening_metadatas'
 
 module Fake
   # the FakeApi class is used to mock API requests while testing.
@@ -18,6 +20,11 @@ module Fake
     put("/#{version}/resources") { json_response 201, 'resource.json' }
     delete("/#{version}/resources/:id") { status 202 }
 
+    include ActorsRoutes
+    include DocumentsUploadsRoutes
+    include ScreeningsRoutes
+    include ScreeningMetadatasRoutes
+
     # verix_metadata
     get("/#{version}/v/metadata") do
       json_response 200, 'verix/metadata.json'
@@ -257,9 +264,6 @@ module Fake
       json_response 404, 'invalid_signature_id.json'
     end
 
-    # documents_uploads
-    include DocumentsUploadsRoutes
-
     # documents orders notifications
     post("/#{version}/documents/orders/valid_id/notify") { status 204 }
     post("/#{version}/documents/orders/invalid_id/notify") do
@@ -277,9 +281,6 @@ module Fake
     # document_upload_types
     get("/#{version}/documents/upload_types") { json_response 200, 'upload_types.json' }
 
-    # screenings
-    include ScreeningsRoutes
-
     # consumers
     get("/#{version}/consumers") do
       json_response 200, 'users.json'
@@ -554,7 +555,7 @@ module Fake
     def http_response(content_type, response_code, file_name)
       content_type content_type
       status response_code
-      File.open("#{File.dirname(__FILE__)}/fixtures/#{file_name}").read
+      File.read("#{File.dirname(__FILE__)}/fixtures/#{file_name}")
     end
   end
 end

data/spec/support/fixtures/actors/details.json

@@ -0,0 +1,19 @@
+{
+  "auth0_id": "string",
+  "date_created": "2021-10-27T02:36:01Z",
+  "date_modified": "2021-10-27T02:36:01Z",
+  "email": "string",
+  "external_id": "string",
+  "first_name": "string",
+  "language": "string",
+  "last_name": "string",
+  "locked": true,
+  "memo": "string",
+  "phone": "string",
+  "phone_country_code": "string",
+  "public_id": "string",
+  "role": 0,
+  "status": 0,
+  "tenant_id": "string",
+  "token": "string"
+}

data/spec/support/fixtures/screening_metadatas/not_found.json

@@ -0,0 +1,3 @@
+{
+  "messages": [ "The screening ID was not found" ]
+}

data/spec/support/fixtures/screening_metadatas/show.json

@@ -0,0 +1,4 @@
+{
+  "key": "le-key",
+  "value": "le-value"
+}

data/spec/support/routes/actors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fake
+  module ActorsRoutes
+    class << self
+      def included(base)
+        base.get("/#{base.version}/actor/details") do
+          json_response 200, 'actors/details.json'
+        end
+        super
+      end
+    end
+  end
+end

data/spec/support/routes/screening_metadatas.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Fake
+  module ScreeningMetadatasRoutes
+    class << self
+      def included(base)
+        get_routes base
+        post_routes base
+        destroy_routes base
+
+        super
+      end
+
+      def post_routes(base)
+        base.post("/#{base.version}/screenings/:session_id/meta") do
+          if params[:session_id] == 'session_id'
+            status 204
+          else
+            json_response 404, 'screening_metadatas/not_found.json'
+          end
+        end
+      end
+
+      def destroy_routes(base)
+        base.delete("/#{base.version}/screenings/:session_id/meta/:key") do
+          if params[:session_id] == 'session_id'
+            status 204
+          else
+            json_response 404, 'screening_metadatas/not_found.json'
+          end
+        end
+      end
+
+      def get_routes(base)
+        base.get("/#{base.version}/screenings/:session_id/meta/:key") do
+          if params[:session_id] == 'session_id'
+            json_response 200, 'screening_metadatas/show.json'
+          else
+            json_response 404, 'screening_metadatas/not_found.json'
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 6.5.0
+  version: 6.7.1
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -136,20 +136,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +258,7 @@ files:
 - Rakefile
 - finapps.gemspec
 - lib/finapps.rb
+- lib/finapps/rest/actors.rb
 - lib/finapps/rest/alert_definitions.rb
 - lib/finapps/rest/alert_occurrences.rb
 - lib/finapps/rest/client.rb
@@ -293,6 +294,7 @@ files:
 - lib/finapps/rest/portfolios_available_consumers.rb
 - lib/finapps/rest/portfolios_consumers.rb
 - lib/finapps/rest/products.rb
+- lib/finapps/rest/screening_metadatas.rb
 - lib/finapps/rest/screenings.rb
 - lib/finapps/rest/sessions.rb
 - lib/finapps/rest/signed_documents_downloads.rb
@@ -305,6 +307,7 @@ files:
 - lib/finapps/rest/version.rb
 - lib/finapps/utils/query_builder.rb
 - lib/finapps/version.rb
+- spec/rest/actors_spec.rb
 - spec/rest/alert_definitions_spec.rb
 - spec/rest/alert_occurrences_spec.rb
 - spec/rest/client_spec.rb
@@ -339,6 +342,7 @@ files:
 - spec/rest/portfolios_consumers_spec.rb
 - spec/rest/portfolios_spec.rb
 - spec/rest/products_spec.rb
+- spec/rest/screening_metadatas_spec.rb
 - spec/rest/screenings_spec.rb
 - spec/rest/sessions_spec.rb
 - spec/rest/signed_documents_downloads_spec.rb
@@ -354,6 +358,7 @@ files:
 - spec/spec_helpers/client.rb
 - spec/support/documents_uploads_routes.rb
 - spec/support/fake_api.rb
+- spec/support/fixtures/actors/details.json
 - spec/support/fixtures/alert_definition.json
 - spec/support/fixtures/alert_definitions.json
 - spec/support/fixtures/alert_occurrences.json
@@ -407,6 +412,8 @@ files:
 - spec/support/fixtures/screening.json
 - spec/support/fixtures/screening_invalid_update.json
 - spec/support/fixtures/screening_list.json
+- spec/support/fixtures/screening_metadatas/not_found.json
+- spec/support/fixtures/screening_metadatas/show.json
 - spec/support/fixtures/screenings/last_session.json
 - spec/support/fixtures/screenings/session_not_found_with_id.json
 - spec/support/fixtures/screenings/tenant_schemas.json
@@ -426,6 +433,8 @@ files:
 - spec/support/fixtures/verix/metadata.json
 - spec/support/fixtures/verix/record/create.json
 - spec/support/fixtures/verix/record/list.json
+- spec/support/routes/actors.rb
+- spec/support/routes/screening_metadatas.rb
 - spec/support/screenings_routes.rb
 - spec/utils/query_builder_spec.rb
 - tags
@@ -459,54 +468,58 @@ signing_key:
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
+- spec/support/routes/actors.rb
+- spec/support/routes/screening_metadatas.rb
 - spec/support/screenings_routes.rb
-- spec/support/fake_api.rb
 - spec/support/documents_uploads_routes.rb
-- spec/spec_helper.rb
-- spec/spec_helpers/api_request.rb
-- spec/spec_helpers/client.rb
-- spec/rest/portfolios_alerts_spec.rb
-- spec/rest/products_spec.rb
+- spec/support/fake_api.rb
+- spec/rest/operators_login_tokens_spec.rb
+- spec/rest/screening_metadatas_spec.rb
+- spec/rest/documents_upload_types_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/tenant_app_settings_spec.rb
+- spec/rest/version_spec.rb
+- spec/rest/screenings_spec.rb
 - spec/rest/documents_orders_spec.rb
+- spec/rest/documents_uploads_spec.rb
+- spec/rest/alert_definitions_spec.rb
 - spec/rest/password_resets_spec.rb
+- spec/rest/order_reports_spec.rb
+- spec/rest/alert_occurrences_spec.rb
+- spec/rest/portfolios_available_consumers_spec.rb
+- spec/rest/consumer_login_tokens_spec.rb
+- spec/rest/tenant_settings_spec.rb
 - spec/rest/order_statuses_spec.rb
+- spec/rest/products_spec.rb
 - spec/rest/operators_spec.rb
-- spec/rest/operator_change_password_email_spec.rb
-- spec/rest/esign_templates_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/order_reports_spec.rb
-- spec/rest/documents_upload_types_spec.rb
+- spec/rest/sessions_spec.rb
+- spec/rest/order_notifications_spec.rb
+- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/portfolio_reports_spec.rb
+- spec/rest/portfolios_spec.rb
 - spec/rest/consumers_portfolios_spec.rb
-- spec/rest/portfolios_consumers_spec.rb
-- spec/rest/verix/verix_metadata_spec.rb
 - spec/rest/verix/verix_documents_spec.rb
-- spec/rest/verix/verix_records_spec.rb
 - spec/rest/verix/verix_pdf_documents_spec.rb
-- spec/rest/tenant_settings_spec.rb
-- spec/rest/consumers_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/portfolios_available_consumers_spec.rb
-- spec/rest/alert_definitions_spec.rb
-- spec/rest/order_notifications_spec.rb
-- spec/rest/operators_password_resets_spec.rb
-- spec/rest/version_spec.rb
-- spec/rest/portfolios_spec.rb
-- spec/rest/sessions_spec.rb
-- spec/rest/documents_orders_notifications_spec.rb
-- spec/rest/tenant_app_settings_spec.rb
-- spec/rest/documents_uploads_spec.rb
-- spec/rest/screenings_spec.rb
-- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/verix/verix_metadata_spec.rb
+- spec/rest/verix/verix_records_spec.rb
+- spec/rest/order_refreshes_spec.rb
 - spec/rest/plaid/plaid_account_permissions_spec.rb
+- spec/rest/plaid/plaid_consumer_institutions_spec.rb
+- spec/rest/plaid/plaid_institution_logos_spec.rb
 - spec/rest/plaid/plaid_webhooks_spec.rb
 - spec/rest/plaid/plaid_accounts_spec.rb
-- spec/rest/plaid/plaid_institution_logos_spec.rb
-- spec/rest/plaid/plaid_consumer_institutions_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/portfolios_alerts_spec.rb
+- spec/rest/consumers_spec.rb
 - spec/rest/order_assignments_spec.rb
-- spec/rest/consumer_login_tokens_spec.rb
-- spec/rest/alert_occurrences_spec.rb
-- spec/rest/operators_login_tokens_spec.rb
-- spec/rest/order_refreshes_spec.rb
-- spec/rest/portfolio_reports_spec.rb
-- spec/rest/orders_spec.rb
+- spec/rest/operator_change_password_email_spec.rb
+- spec/rest/documents_orders_notifications_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/rest/esign_templates_spec.rb
+- spec/rest/order_tokens_spec.rb
+- spec/rest/portfolios_consumers_spec.rb
+- spec/rest/actors_spec.rb
+- spec/spec_helpers/api_request.rb
+- spec/spec_helpers/client.rb
 - spec/utils/query_builder_spec.rb
+- spec/spec_helper.rb