finapps 6.7.1 → 6.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1007bb9e3b614755fa3252fe8c53958f0a9f093997b8910e2eb29ea38082dec
-  data.tar.gz: 9991cf065517607999949265e2b3c2e7214edbea5c9120bb2f01e11133b6a03d
+  metadata.gz: da705f7ca97a1925b4ea9125e454272e94b7866dfc661c9ea71f174f5cecac20
+  data.tar.gz: a18e05871459ceb86aeb2e9c3e6d66ef695f6efb11184a34f2a011c285b6290d
 SHA512:
-  metadata.gz: 541d42baf3992dc7e7a5a2417d95b9d7d10f886913df1123dc9ff2bc2f62918389a0cac5fbb5aab04ab2544d0c2b4bdaf512fb1a2e0e4e8a1ecdf7495144f24b
-  data.tar.gz: ab496f7a9823916ba5e3493860298c068d9643a193e048e0aec74bf0858bea4a690d561c82257e934e952f6e0de1b7ceda10a0a5afa0dc95abcf952967e40b71
+  metadata.gz: 9c60414d911ac232b446c87a05d4228a4b78971c6b16921d70cf004de97317f6decaf566a011854bcc3f3bfbcf4492e5507826b3658c46f813646e5109912aa2
+  data.tar.gz: 8bb08e58b6faf855c61a2c51907358e75ec1f2557dda5d484bf8017f0dd88fe28d16b381d20ae114c70d43d9350cb68e595f2262d36e40beaa5c81b6835d6a8d

data/.github/workflows/ci.yaml

@@ -16,7 +16,6 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [2.6, 2.7, '3.0']
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout source code

data/finapps.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['spec/**/*.rb']
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency     'finapps_core',               '~> 6.0',   '>= 6.0.1'
+  spec.add_runtime_dependency     'finapps_core',               '~> 6.0',   '>= 6.0.2'
 
   spec.add_development_dependency 'bundler',                    '~> 2.2',   '>= 2.2.16'
   spec.add_development_dependency 'rake',                       '~> 13.0',  '>= 13.0.1'

data/lib/finapps/rest/client.rb

@@ -54,6 +54,32 @@ module FinApps
         version
       ].freeze
 
+      RESOURCES.each do |method|
+        define_method(method) do
+          method_definition(method) do |class_name|
+            Object.const_get(:FinApps)
+                  .const_get(:REST)
+                  .const_get(class_name)
+          end
+        end
+      end
+
+      QUERY_RESOURCES = [:query_screenings].freeze
+
+      QUERY_RESOURCES.each do |method|
+        define_method(method) do
+          class_name = method.to_s.gsub(/query_/, '').capitalize
+          variable = "@#{method}"
+
+          method_definition(method, class_name, variable) do |_|
+            Object.const_get(:FinApps)
+                  .const_get(:REST)
+                  .const_get(:Query)
+                  .const_get(class_name)
+          end
+        end
+      end
+
       # @param [String] tenant_token
       # @param [Hash] options
       # @return [FinApps::REST::Client]
@@ -64,34 +90,23 @@ module FinApps
         super(options, logger)
       end
 
-      def method_missing(symbol, *arguments, &block)
-        if RESOURCES.include? symbol
-          class_name = camelize(symbol.to_s)
-          variable = "@#{class_name.downcase}"
-          set_variable(class_name, variable) unless instance_variable_defined? variable
-          instance_variable_get(variable)
-        else
-          super
-        end
-      end
+      private
 
-      def set_variable(class_name, variable)
-        klass = Object.const_get(:FinApps).const_get(:REST).const_get class_name
-        instance_variable_set(variable, klass.new(self))
-      end
+      def method_definition(method, class_name = nil, variable = nil)
+        class_name = camelize(method.to_s) if class_name.nil?
+        variable = "@#{class_name.downcase}" if variable.nil?
 
-      def respond_to_missing?(method_sym, include_private = false)
-        RESOURCES.include?(method_sym) ? true : super
+        unless instance_variable_defined?(variable)
+          klass = yield class_name
+          instance_variable_set(variable, klass.new(self))
+        end
+        instance_variable_get(variable)
       end
 
-      private
-
       def camelize(term)
         string = term.to_s
         string = string.sub(/^[a-z\d]*/) { Regexp.last_match(0).capitalize }
-        string.gsub(%r{(?:_|(/))([a-z\d]*)}) do
-          Regexp.last_match(2).capitalize.to_s
-        end
+        string.gsub(%r{(?:_|(/))([a-z\d]*)}) { Regexp.last_match(2).capitalize }
       end
     end
   end

data/lib/finapps/rest/query/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    module Query
+      class Base < FinAppsCore::REST::Resources
+        def end_point
+          "query/#{super}"
+        end
+      end
+    end
+  end
+end

data/lib/finapps/rest/query/screenings.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    module Query
+      class Screenings < FinApps::REST::Query::Base
+      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.7.1'
+  VERSION = '6.9.2'
 end

data/lib/finapps.rb

@@ -54,5 +54,8 @@ require 'finapps/rest/verix/verix_records'
 require 'finapps/rest/verix/verix_pdf_documents'
 require 'finapps/rest/verix/verix_documents'
 
+require 'finapps/rest/query/base'
+require 'finapps/rest/query/screenings'
+
 require 'finapps/utils/query_builder'
 require 'finapps/version' unless defined?(FinApps::VERSION)

data/spec/rest/client_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe FinApps::REST::Client do
   context 'with an instance of Client' do
     subject(:client) { described_class.new(:company_token) }
 
-    FinApps::REST::Client::RESOURCES.each do |method|
+    (FinApps::REST::Client::RESOURCES +
+     FinApps::REST::Client::QUERY_RESOURCES).each do |method|
       it("responds to #{method}") { expect(client).to respond_to(method) }
 
       it "memoizes the result of #{method}" do

data/spec/rest/query/base_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'spec_helpers/api_request'
+
+RSpec.describe FinApps::REST::Query::Base do
+  describe '#end_point' do
+    it 'starts with query/' do
+      expect(described_class.new(:client).end_point).to start_with('query/')
+    end
+  end
+end

data/spec/rest/query/screenings_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'spec_helpers/api_request'
+
+RSpec.describe FinApps::REST::Query::Screenings do
+  include SpecHelpers::Client
+
+  subject(:create) { described_class.new(client).create('string') }
+
+  describe '#create' do
+    context 'when valid tenant token is provided' do
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it 'sends the params in the body of the request' do
+        create
+        url = "#{versioned_api_path}/query/screenings"
+
+        expect(WebMock).to have_requested(:post, url).with(body: 'string')
+      end
+    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

@@ -5,6 +5,7 @@ require_relative 'documents_uploads_routes'
 require_relative 'screenings_routes'
 require_relative 'routes/actors'
 require_relative 'routes/screening_metadatas'
+require_relative 'routes/query_screenings'
 
 module Fake
   # the FakeApi class is used to mock API requests while testing.
@@ -24,6 +25,7 @@ module Fake
     include DocumentsUploadsRoutes
     include ScreeningsRoutes
     include ScreeningMetadatasRoutes
+    include QueryScreeningRoutes
 
     # verix_metadata
     get("/#{version}/v/metadata") do

data/spec/support/fixtures/query/screenings.json

@@ -0,0 +1,68 @@
+[
+  {
+    "answered_questions": [
+      {
+        "additional_label": "string",
+        "answer_type": "string",
+        "answers": [
+          {
+            "documents": [
+              {
+                "name": "string",
+                "type": 0
+              }
+            ],
+            "id": "string",
+            "input_value": "string",
+            "label": "string",
+            "next_question_id": "string",
+            "type": "string",
+            "value": "string"
+          }
+        ],
+        "group": "string",
+        "id": "string",
+        "label": "string",
+        "summary": "string"
+      }
+    ],
+    "consumer": {
+      "email": "string",
+      "external_id": "string",
+      "first_name": "string",
+      "last_name": "string",
+      "public_id": "string"
+    },
+    "date_created": "2022-02-04T14:29:03Z",
+    "date_modified": "2022-02-04T14:29:03Z",
+    "metadata": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "operator": {
+      "email": "string",
+      "first_name": "string",
+      "last_name": "string"
+    },
+    "operator_id": "string",
+    "original_consumer": {
+      "email": "string",
+      "external_id": "string",
+      "first_name": "string",
+      "last_name": "string",
+      "public_id": "string"
+    },
+    "progress": 0,
+    "result": {
+      "documents": [
+        {
+          "name": "string",
+          "type": 0
+        }
+      ],
+      "status": "string"
+    },
+    "s_id": "string",
+    "schema_id": "string"
+  }
+]

data/spec/support/routes/query_screenings.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fake
+  module QueryScreeningRoutes
+    class << self
+      def included(base)
+        base.post("/#{base.version}/query/screenings") do
+          json_response 200, 'query/screenings.json'
+        end
+        super
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 6.7.1
+  version: 6.9.2
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -19,7 +19,7 @@ dependencies:
         version: '6.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.1
+        version: 6.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '6.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.1
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -294,6 +294,8 @@ files:
 - lib/finapps/rest/portfolios_available_consumers.rb
 - lib/finapps/rest/portfolios_consumers.rb
 - lib/finapps/rest/products.rb
+- lib/finapps/rest/query/base.rb
+- lib/finapps/rest/query/screenings.rb
 - lib/finapps/rest/screening_metadatas.rb
 - lib/finapps/rest/screenings.rb
 - lib/finapps/rest/sessions.rb
@@ -342,6 +344,8 @@ files:
 - spec/rest/portfolios_consumers_spec.rb
 - spec/rest/portfolios_spec.rb
 - spec/rest/products_spec.rb
+- spec/rest/query/base_spec.rb
+- spec/rest/query/screenings_spec.rb
 - spec/rest/screening_metadatas_spec.rb
 - spec/rest/screenings_spec.rb
 - spec/rest/sessions_spec.rb
@@ -406,6 +410,7 @@ files:
 - spec/support/fixtures/portfolios_available_consumers.json
 - spec/support/fixtures/portfolios_consumers.json
 - spec/support/fixtures/products.json
+- spec/support/fixtures/query/screenings.json
 - spec/support/fixtures/resource.json
 - spec/support/fixtures/resource_not_found.json
 - spec/support/fixtures/resources.json
@@ -434,6 +439,7 @@ files:
 - spec/support/fixtures/verix/record/create.json
 - spec/support/fixtures/verix/record/list.json
 - spec/support/routes/actors.rb
+- spec/support/routes/query_screenings.rb
 - spec/support/routes/screening_metadatas.rb
 - spec/support/screenings_routes.rb
 - spec/utils/query_builder_spec.rb
@@ -468,58 +474,61 @@ signing_key:
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
+- spec/utils/query_builder_spec.rb
+- spec/support/fake_api.rb
+- spec/support/documents_uploads_routes.rb
+- spec/support/routes/query_screenings.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/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/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/spec_helper.rb
+- spec/rest/documents_orders_notifications_spec.rb
+- spec/rest/operator_change_password_email_spec.rb
+- spec/rest/order_assignments_spec.rb
+- spec/rest/order_refreshes_spec.rb
+- spec/rest/verix/verix_records_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/consumers_portfolios_spec.rb
+- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/portfolio_reports_spec.rb
+- spec/rest/order_statuses_spec.rb
+- spec/rest/esign_templates_spec.rb
+- spec/rest/order_reports_spec.rb
+- spec/rest/tenant_settings_spec.rb
+- spec/rest/portfolios_alerts_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/consumer_login_tokens_spec.rb
+- spec/rest/operators_spec.rb
+- spec/rest/actors_spec.rb
+- spec/rest/plaid/plaid_accounts_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/client_spec.rb
-- spec/rest/portfolios_alerts_spec.rb
+- spec/rest/plaid/plaid_institution_logos_spec.rb
+- spec/rest/plaid/plaid_consumer_institutions_spec.rb
+- spec/rest/tenant_app_settings_spec.rb
 - spec/rest/consumers_spec.rb
-- spec/rest/order_assignments_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/alert_definitions_spec.rb
+- spec/rest/documents_upload_types_spec.rb
+- spec/rest/order_notifications_spec.rb
+- spec/rest/documents_orders_spec.rb
+- spec/rest/documents_uploads_spec.rb
+- spec/rest/portfolios_available_consumers_spec.rb
+- spec/rest/screening_metadatas_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/screenings_spec.rb
+- spec/rest/sessions_spec.rb
+- spec/rest/query/screenings_spec.rb
+- spec/rest/query/base_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/rest/password_resets_spec.rb
+- spec/rest/products_spec.rb
+- spec/rest/portfolios_spec.rb
+- spec/rest/operators_login_tokens_spec.rb
+- spec/rest/alert_occurrences_spec.rb
 - spec/rest/portfolios_consumers_spec.rb
-- spec/rest/actors_spec.rb
+- spec/rest/version_spec.rb
 - spec/spec_helpers/api_request.rb
 - spec/spec_helpers/client.rb
-- spec/utils/query_builder_spec.rb
-- spec/spec_helper.rb