finapps 6.6.0 → 6.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db026df91582571b3b108a3fd4996f8030941df83b4a606857d3471fb3c4575e
-  data.tar.gz: 8debd1ce6537786a5fc593a56daa5385593f698fb24f096f92e6e5e3c01169f2
+  metadata.gz: d9f972096761ac681f6f984445a44fe9fe28dca7e2ee8b45839e0f1ef5b60a24
+  data.tar.gz: a973e1c1790dd21f505b673e95660882c19a781e605cfea6e2707efef6e8b62d
 SHA512:
-  metadata.gz: '08ef11ebbf9618230a9835e90913bfc70d51f1a11752db4dd393f73981c7d8499860c392b4cde94a4df6930a95643c5b1edd11273d75a2aa1ac690e8d0ed7c3e'
-  data.tar.gz: 219263a24148d12869c73d032d7fd7b924bf7aedfe13d0e3b8cdc42db6d4afff62bb51acbfa8e29f70beaab72a1dcfec1dbcf78ae24934fb7d9998f64ae30e41
+  metadata.gz: d47eecdc4513c9676b9fdb9f8b589a98acecfc593bdb828099079584832289f5b50275fdc3b7b280e774fb9e6aef4490c739b336e3dd9a8439c81e465a02c725
+  data.tar.gz: 5fdedc48c9f1887f146e4c33ed55fed6b5ab604bec091670991972ff063f9174f93d56853af506595286af0fcccf15be75c465c8a72f56bf69f4e1a3c721bf3d

data/.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v2.3.5
+        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.5
+        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/lib/finapps/rest/actors.rb

@@ -3,7 +3,7 @@
 module FinApps
   module REST
     class Actors < FinAppsCore::REST::Resources
-      END_POINT = 'actors/details'
+      END_POINT = 'actor/details'
 
       def show
         super nil, END_POINT

data/lib/finapps/rest/client.rb

@@ -42,6 +42,7 @@ module FinApps
         portfolio_reports
         products
         screenings
+        screening_metadatas
         sessions
         signed_documents_downloads
         tenant_settings
@@ -75,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/rest/screenings.rb

@@ -57,6 +57,7 @@ module FinApps
 
       def build_filter(params)
         term_filter(params[:searchTerm])
+          .merge(operator_filter(params[:operatorID]))
           .merge(date_range_filter(params[:fromDate], params[:toDate]))
           .merge(progress_filter(params[:progress]))
       end
@@ -73,7 +74,9 @@ module FinApps
           {'consumer.email': term},
           {'consumer.first_name': term},
           {'consumer.last_name': term},
-          {'consumer.external_id': term}
+          {'consumer.external_id': term},
+          {'operator.first_name': term},
+          {'operator.last_name': term}
         ]
       end
 
@@ -84,11 +87,19 @@ module FinApps
         term.split.each do |t|
           arr.append('consumer.first_name': t)
           arr.append('consumer.last_name': t)
+          arr.append('operator.first_name': t)
+          arr.append('operator.last_name': t)
         end
 
         arr
       end
 
+      def operator_filter(operator_id)
+        return {} unless operator_id
+
+        {operator_id: operator_id}
+      end
+
       def date_range_filter(from_date, to_date)
         return {} unless from_date || to_date
 

data/lib/finapps/version.rb

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

data/lib/finapps.rb

@@ -40,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

@@ -27,7 +27,7 @@ RSpec.describe FinApps::REST::Actors do
   end
 
   def stub_unauthorized_request
-    stub_request(:get, %r{/actors/details}).to_return(
+    stub_request(:get, %r{/actor/details}).to_return(
       status: 401,
       body: {
         error_messages: ['Unauthorized'],

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/rest/screenings_spec.rb

@@ -84,10 +84,24 @@ RSpec.describe FinApps::REST::Screenings do
                   {'consumer.first_name': 'le term'},
                   {'consumer.last_name': 'le term'},
                   {'consumer.external_id': 'le term'},
+                  {'operator.first_name': 'le term'},
+                  {'operator.last_name': 'le term'},
                   {'consumer.first_name': 'le'},
                   {'consumer.last_name': 'le'},
+                  {'operator.first_name': 'le'},
+                  {'operator.last_name': 'le'},
                   {'consumer.first_name': 'term'},
-                  {'consumer.last_name': 'term'}]
+                  {'consumer.last_name': 'term'},
+                  {'operator.first_name': 'term'},
+                  {'operator.last_name': 'term'}]
+        }
+      end
+
+      context 'with operator' do
+        let(:params) { {operatorID: '123abc'} }
+
+        it_behaves_like 'a correct query builder', {
+          operator_id: '123abc'
         }
       end
     end

data/spec/support/fake_api.rb

@@ -4,6 +4,7 @@ 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.
@@ -22,6 +23,7 @@ module Fake
     include ActorsRoutes
     include DocumentsUploadsRoutes
     include ScreeningsRoutes
+    include ScreeningMetadatasRoutes
 
     # verix_metadata
     get("/#{version}/v/metadata") do
@@ -553,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/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

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

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.6.0
+  version: 6.8.0
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -294,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
@@ -341,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
@@ -410,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
@@ -430,6 +434,7 @@ files:
 - 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
@@ -463,56 +468,58 @@ signing_key:
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/rest/portfolio_reports_spec.rb
+- spec/support/routes/actors.rb
+- spec/support/routes/screening_metadatas.rb
+- spec/support/screenings_routes.rb
+- spec/support/documents_uploads_routes.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/sessions_spec.rb
-- spec/rest/consumers_portfolios_spec.rb
+- spec/rest/documents_orders_spec.rb
 - spec/rest/documents_uploads_spec.rb
-- spec/rest/portfolios_consumers_spec.rb
-- spec/rest/actors_spec.rb
-- spec/rest/documents_orders_notifications_spec.rb
 - spec/rest/alert_definitions_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/operators_spec.rb
-- spec/rest/esign_templates_spec.rb
-- spec/rest/consumers_spec.rb
-- spec/rest/order_refreshes_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/signed_documents_downloads_spec.rb
 - spec/rest/products_spec.rb
-- spec/rest/consumer_login_tokens_spec.rb
-- spec/rest/password_resets_spec.rb
-- spec/rest/operator_change_password_email_spec.rb
-- spec/rest/version_spec.rb
-- spec/rest/operators_password_resets_spec.rb
-- spec/rest/portfolios_alerts_spec.rb
-- spec/rest/alert_occurrences_spec.rb
+- spec/rest/operators_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/verix/verix_documents_spec.rb
+- spec/rest/verix/verix_pdf_documents_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_webhooks_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_account_permissions_spec.rb
-- spec/rest/order_tokens_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/tenant_app_settings_spec.rb
-- spec/rest/documents_upload_types_spec.rb
-- spec/rest/verix/verix_documents_spec.rb
-- spec/rest/verix/verix_metadata_spec.rb
-- spec/rest/verix/verix_records_spec.rb
-- spec/rest/verix/verix_pdf_documents_spec.rb
-- spec/rest/operators_login_tokens_spec.rb
-- spec/rest/portfolios_spec.rb
-- spec/rest/documents_orders_spec.rb
-- spec/rest/order_notifications_spec.rb
-- spec/rest/tenant_settings_spec.rb
-- spec/rest/portfolios_available_consumers_spec.rb
-- spec/rest/orders_spec.rb
-- spec/spec_helper.rb
-- spec/support/screenings_routes.rb
-- spec/support/fake_api.rb
-- spec/support/documents_uploads_routes.rb
-- spec/support/routes/actors.rb
-- spec/utils/query_builder_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