finapps 5.0.46 → 5.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4501dd349460d436671d161a817432d9336cdb1722d2465baef3d65a7bb4d10f
-  data.tar.gz: cea911d0e0449e505aa4fd6229f0ca446fc45519a69b8955f22e8789a5b94132
+  metadata.gz: 487960017ebcda19c22179e090cb9328708a57dd5e54e0d05cc27e5660251d57
+  data.tar.gz: 95abe37a2a66f36f973eb453d2302df92a9d1208c2ad5f20b4b6caf21737c358
 SHA512:
-  metadata.gz: e4e89f43a67412901a05f0cd420973e7c87d2e14fb86191b966ca2381d2af0ee8de1df43a3db2b1a3b2b22df616eab186c49fde9f2373f156e9f8e5f3cbdfad7
-  data.tar.gz: bac2c749e5c60e123dfb02d5d767b1e8930ae9ef2178a3c9e1be6aff2fa55c596b12d9e64817c228839eb0c1b7aab1a9534ecabee90f1ab5ab667c0d87257910
+  metadata.gz: 5df1695cc14dc3a96d47867786a7f564806b5f58d56511c9e08482e3e9ce4767ac03257c055f644b2517d25666a70d0b6312f43fd218607258c642d967061a98
+  data.tar.gz: 9f063fed1bafb02f77ed3b10230c77d757e0ae09c0f7d202f9d78d699dc1d7ba5f0809d59591f608c32aa9c81d86795b932ab5220d0adc13fcea07b2583c4d26

data/.github/workflows/main.yaml

@@ -13,10 +13,8 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
-      - name: Use Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
+      - name: Install required ruby
+        uses: ruby/setup-ruby@v1
 
       - uses: actions/cache@v2
         with:

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',               '~> 5.0',   '>= 5.0.10'
+  spec.add_runtime_dependency     'finapps_core',               '~> 5.0',   '>= 5.0.13'
 
   spec.add_development_dependency 'bundler',                    '~> 2.0',   '>= 2.0.2'
   spec.add_development_dependency 'codeclimate-test-reporter',  '~> 1.0',   '>= 1.0.9'
@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec',                '~> 4.7',   '>= 4.7.3'
   spec.add_development_dependency 'rake',                       '~> 13.0',  '>= 13.0.1'
   spec.add_development_dependency 'rspec',                      '~> 3.9',   '>= 3.9.0'
-  spec.add_development_dependency 'rubocop',                    '~> 0.86',  '>= 0.86.0'
-  spec.add_development_dependency 'rubocop-performance',        '~> 1.6',   '>= 1.6.1'
-  spec.add_development_dependency 'rubocop-rspec',              '~> 1.40',  '>= 1.40.0'
+  spec.add_development_dependency 'rubocop',                    '~> 0.87',  '>= 0.87.0'
+  spec.add_development_dependency 'rubocop-performance',        '~> 1.7',   '>= 1.7.0'
+  spec.add_development_dependency 'rubocop-rspec',              '~> 1.41',  '>= 1.41.0'
   spec.add_development_dependency 'sinatra',                    '~> 2.0',   '>= 2.0.8'
   spec.add_development_dependency 'webmock',                    '~> 3.8',   '>= 3.8.0'
 

data/lib/finapps.rb

@@ -35,6 +35,7 @@ require 'finapps/rest/esign_templates'
 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/plaid/plaid_resources'
 require 'finapps/rest/plaid/plaid_webhooks'

data/lib/finapps/rest/client.rb

@@ -37,6 +37,7 @@ module FinApps
         portfolios_consumers
         portfolio_reports
         products
+        screenings
         sessions
         signed_documents_downloads
         tenant_settings

data/lib/finapps/rest/screenings.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../utils/query_builder'
+
+module FinApps
+  module REST
+    class Screenings < FinAppsCore::REST::Resources # :nodoc:
+      include FinApps::Utils::QueryBuilder
+
+      def show(id)
+        not_blank(id, :session_id)
+
+        path = "#{end_point}/#{ERB::Util.url_encode(id)}/resume"
+        super(nil, path)
+      end
+
+      def create(params)
+        not_blank(params, :params)
+        super params
+      end
+
+      def list(params = nil)
+        return super if params.nil?
+        fail FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(end_point, params)
+      end
+
+      def update(id, params)
+        not_blank(id, :session_id)
+        not_blank(params, :params)
+
+        path = "#{end_point}/#{ERB::Util.url_encode(id)}"
+        super params, path
+      end
+
+      private
+
+      def build_filter(params)
+        search_query(params[:searchTerm])
+      end
+
+      def search_query(term)
+        return {} unless term
+
+        query = search_query_object(term)
+        {"$or": query}
+      end
+
+      def search_query_object(term)
+        [
+          {"consumer.public_id": term},
+          {"consumer.email": term}
+        ]
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

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

data/spec/rest/api_request.rb

@@ -16,3 +16,11 @@ RSpec.shared_examples 'a successful request' do |_parameter|
     expect(subject[ERROR_MESSAGES]).to be_empty
   end
 end
+
+RSpec.shared_examples 'a request that raises an error' do |_parameter|
+  it do
+    expect { subject }.to raise_error(
+      FinAppsCore::MissingArgumentsError
+    )
+  end
+end

data/spec/rest/documents_orders_spec.rb

@@ -6,14 +6,6 @@ require 'rest/api_request'
 RSpec.describe FinApps::REST::DocumentsOrders do
   include SpecHelpers::Client
 
-  RSpec.shared_examples 'a request that raises an error' do |_parameter|
-    it do
-      expect { subject }.to raise_error(
-        FinAppsCore::MissingArgumentsError
-      )
-    end
-  end
-
   describe '#list' do
     subject(:list) { described_class.new(client).list(params) }
 

data/spec/rest/screenings_spec.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::Screenings do
+  include SpecHelpers::Client
+
+  describe '#list' do
+    subject(:list) { described_class.new(client).list(params) }
+
+    let(:results) { list[0] }
+    let(:error_messages) { list[1] }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          page: 2,
+          sort: 'date_created',
+          requested: 25,
+          searchTerm: 'term'
+        }
+      end
+
+      context 'without searchTerm' do
+        let(:params) { {searchTerm: nil, page: 2} }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it 'performs a get and returns the response' do
+          expect(results).to have_key(:records)
+        end
+
+        it 'builds query and sends proper request' do
+          list
+          url = "#{versioned_api_path}/screenings?page=2"
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+
+      # rubocop:disable RSpec/ExampleLength
+      context 'with searchTerm' do
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it 'performs a get and returns the response' do
+          expect(results).to have_key(:records)
+        end
+
+        it 'builds query and sends proper request' do
+          list
+          url =
+            "#{versioned_api_path}/screenings?filter=%7B%22$or%22:%5B%7B%22" \
+            'consumer.public_id%22:%22term%22%7D,%7B%22consumer.email%22:%22' \
+            'term%22%7D%5D%7D&page=2&requested=25&sort=date_created'
+
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+      # rubocop:enable RSpec/ExampleLength
+    end
+
+    context 'with invalid params' do
+      let(:params) { ['invalid array'] }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    end
+
+    context 'with missing params' do
+      let(:params) { nil }
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('performs a get and returns the response') do
+        expect(results).to have_key(:records)
+      end
+    end
+  end
+
+  describe '#show' do
+    subject(:show) { described_class.new(client).show(id) }
+
+    let(:results) { show[0] }
+    let(:error_messages) { show[1] }
+
+    context 'with valid id' do
+      let(:id) { :valid_id }
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('performs a get and returns the response') do
+        expect(results).to have_key(:session)
+      end
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_id }
+
+      it { expect(results).to be_nil }
+      it { expect(error_messages).not_to be_empty }
+    end
+
+    context 'when missing id' do
+      let(:id) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#create' do
+    subject(:create) { described_class.new(client).create(params) }
+
+    let(:results) { create[0] }
+    let(:error_messages) { create[1] }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          "email": 'validemail@financialapps.com',
+          "first_name": 'Geo',
+          "last_name": 'Metric',
+          "public_id": '1234'
+        }
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('results is a Hash') { expect(results).to be_a(Hash) }
+
+      it('performs a post and returns the response') do
+        expect(results).to have_key(:question)
+      end
+    end
+
+    context 'with invalid params' do
+      let(:params) { {"params": 'invalid'} }
+
+      it { expect { create }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+
+      it('error messages array is populated') do
+        expect(error_messages.first.downcase).to eq('invalid request body')
+      end
+    end
+
+    context 'with missing params' do
+      let(:params) { nil }
+
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#update' do
+    subject(:update) { described_class.new(client).update(id, params) }
+
+    let(:params) { {} }
+    let(:results) { update[0] }
+    let(:error_messages) { update[1] }
+
+    context 'with valid session id' do
+      let(:id) { :valid_id }
+
+      context 'with valid params' do
+        let(:params) { {"question_id": '1234'} }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('returns the next question') do
+          expect(results).to have_key(:question)
+        end
+      end
+
+      context 'with invalid params' do
+        let(:params) { {"question_id": 'invalid'} }
+
+        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('question with id (invalid) not found ')
+        end
+      end
+    end
+
+    context 'with invalid session id' do
+      let(:id) { :invalid_id }
+      let(:params) { {"question_id": '1234'} }
+
+      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(
+          'resource not found'
+        )
+      end
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -2,7 +2,9 @@
 
 require 'sinatra/base'
 require_relative 'documents_uploads_routes'
+
 module Fake
+  # rubocop:disable Metrics/ClassLength
   # the FakeApi class is used to mock API requests while testing.
   class FakeApi < Sinatra::Base
     def self.version
@@ -275,6 +277,35 @@ module Fake
     # document_upload_types
     get("/#{version}/documents/upload_types") { json_response 200, 'upload_types.json' }
 
+    # screenings
+    get("/#{version}/screenings") { json_response 200, 'screening_list.json' }
+    get("/#{version}/screenings/invalid_id/resume") do
+      json_response 404, 'resource_not_found.json'
+    end
+    get("/#{version}/screenings/valid_id/resume") { json_response 200, 'screening.json' }
+    put("/#{version}/screenings/invalid_id") do
+      json_response 404, 'resource_not_found.json'
+    end
+    put("/#{version}/screenings/valid_id") do
+      request.body.rewind
+      request_payload = JSON.parse request.body.read
+      if request_payload['question_id'] == 'invalid'
+        json_response 400, 'screening_invalid_update.json'
+      else
+        json_response 200, 'screening.json'
+      end
+    end
+
+    post("/#{version}/screenings") do
+      request.body.rewind
+      request_payload = JSON.parse request.body.read
+      if request_payload.key? 'email'
+        json_response 201, 'screening.json'
+      else
+        json_response 400, 'invalid_request_body.json'
+      end
+    end
+
     # consumers
     get("/#{version}/consumers") do
       json_response 200, 'users.json'
@@ -515,4 +546,5 @@ module Fake
       File.open("#{File.dirname(__FILE__)}/fixtures/#{file_name}").read
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/spec/support/fixtures/screening.json

@@ -0,0 +1,26 @@
+{
+  "question": {
+    "id": "result_2",
+    "group": "Eligibility",
+    "label": "Eligible",
+    "answer_type": ""
+  },
+  "session": {
+    "s_id": "a561e712-fddc-4f5d-ae0b-11e6f3f598b0",
+    "date_created": "2021-01-18T19:19:35.74Z",
+    "date_modified": "2021-01-18T20:12:30.257Z",
+    "consumer": {
+      "public_id": "2e807db3-3f95-4fc4-697b-2d62969b4667",
+      "email": "email@financialapps.com",
+      "first_name": "Colonel",
+      "last_name": "Mustard"
+    },
+    "operator_id": "6d64098a-a96a-40c3-4305-17ba485440ae",
+    "result": {
+      "status": "Eligible",
+      "documents": [
+        "Proof of Identity"
+      ]
+    }
+  }
+}

data/spec/support/fixtures/screening_invalid_update.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "question with id (invalid) not found "
+  ]
+}

data/spec/support/fixtures/screening_list.json

@@ -0,0 +1,25 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "s_id": "a561e712-fddc-4f5d-ae0b-11e6f3f598b0",
+      "date_created": "2021-01-18T19:19:35.74Z",
+      "date_modified": "2021-01-18T20:12:30.257Z",
+      "consumer": {
+        "public_id": "2e807db3-3f95-4fc4-697b-2d62969b4667",
+        "email": "email@financialapps.com",
+        "first_name": "Colonel",
+        "last_name": "Mustard"
+      },
+      "operator_id": "6d64098a-a96a-40c3-4305-17ba485440ae",
+      "result": {
+        "status": "Eligible",
+        "documents": [
+          "Proof of Identity"
+        ]
+      }
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 5.0.46
+  version: 5.0.47
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.10
+        version: 5.0.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.10
+        version: 5.0.13
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,60 +156,60 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.87.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.86'
+        version: '0.87'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.87.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.86'
+        version: '0.87'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.40.0
+        version: 1.41.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.41'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.40.0
+        version: 1.41.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.41'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -315,6 +315,7 @@ files:
 - lib/finapps/rest/portfolios_available_consumers.rb
 - lib/finapps/rest/portfolios_consumers.rb
 - lib/finapps/rest/products.rb
+- lib/finapps/rest/screenings.rb
 - lib/finapps/rest/sessions.rb
 - lib/finapps/rest/signed_documents_downloads.rb
 - lib/finapps/rest/tenant_app_settings.rb
@@ -358,6 +359,7 @@ files:
 - spec/rest/portfolios_consumers_spec.rb
 - spec/rest/portfolios_spec.rb
 - spec/rest/products_spec.rb
+- spec/rest/screenings_spec.rb
 - spec/rest/sessions_spec.rb
 - spec/rest/signed_documents_downloads_spec.rb
 - spec/rest/tenant_app_settings_spec.rb
@@ -419,6 +421,9 @@ files:
 - spec/support/fixtures/resource.json
 - spec/support/fixtures/resource_not_found.json
 - spec/support/fixtures/resources.json
+- spec/support/fixtures/screening.json
+- spec/support/fixtures/screening_invalid_update.json
+- spec/support/fixtures/screening_list.json
 - spec/support/fixtures/sign_url.json
 - spec/support/fixtures/signed_document.pdf
 - spec/support/fixtures/single_consumer_subscribe_error.json
@@ -466,49 +471,50 @@ signing_key:
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/spec_helpers/client.rb
-- spec/spec_helper.rb
-- spec/utils/query_builder_spec.rb
-- spec/support/fake_api.rb
-- spec/support/documents_uploads_routes.rb
+- spec/rest/order_assignments_spec.rb
 - spec/rest/documents_uploads_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/version_spec.rb
-- spec/rest/products_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/password_resets_spec.rb
-- spec/rest/tenant_settings_spec.rb
-- spec/rest/documents_orders_spec.rb
-- spec/rest/verix/verix_metadata_spec.rb
-- spec/rest/verix/verix_records_spec.rb
+- spec/rest/portfolio_reports_spec.rb
+- spec/rest/alert_definitions_spec.rb
+- spec/rest/order_notifications_spec.rb
 - spec/rest/verix/verix_documents_spec.rb
+- spec/rest/verix/verix_records_spec.rb
+- spec/rest/verix/verix_metadata_spec.rb
 - spec/rest/verix/verix_pdf_documents_spec.rb
-- spec/rest/orders_spec.rb
+- spec/rest/api_request.rb
 - spec/rest/documents_upload_types_spec.rb
-- spec/rest/documents_orders_notifications_spec.rb
-- spec/rest/consumers_spec.rb
-- spec/rest/order_reports_spec.rb
-- spec/rest/sessions_spec.rb
-- spec/rest/operators_password_resets_spec.rb
+- spec/rest/portfolios_consumers_spec.rb
 - spec/rest/esign_templates_spec.rb
-- spec/rest/alert_occurrences_spec.rb
-- spec/rest/portfolios_available_consumers_spec.rb
-- spec/rest/tenant_app_settings_spec.rb
-- spec/rest/portfolios_spec.rb
-- spec/rest/order_assignments_spec.rb
-- spec/rest/alert_definitions_spec.rb
-- spec/rest/portfolio_reports_spec.rb
-- spec/rest/consumers_portfolios_spec.rb
-- spec/rest/portfolios_alerts_spec.rb
 - spec/rest/operators_spec.rb
+- spec/rest/sessions_spec.rb
+- spec/rest/documents_orders_spec.rb
+- spec/rest/version_spec.rb
+- spec/rest/products_spec.rb
 - spec/rest/signed_documents_downloads_spec.rb
-- spec/rest/api_request.rb
-- spec/rest/order_notifications_spec.rb
-- spec/rest/portfolios_consumers_spec.rb
-- spec/rest/plaid/plaid_webhooks_spec.rb
-- spec/rest/plaid/plaid_accounts_spec.rb
+- spec/rest/portfolios_available_consumers_spec.rb
 - spec/rest/plaid/plaid_account_permissions_spec.rb
+- spec/rest/plaid/plaid_accounts_spec.rb
+- spec/rest/plaid/plaid_webhooks_spec.rb
 - spec/rest/plaid/plaid_consumer_institutions_spec.rb
 - spec/rest/plaid/plaid_institution_logos_spec.rb
+- spec/rest/tenant_app_settings_spec.rb
+- spec/rest/order_reports_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/screenings_spec.rb
+- spec/rest/consumers_spec.rb
 - spec/rest/order_statuses_spec.rb
+- spec/rest/password_resets_spec.rb
+- spec/rest/documents_orders_notifications_spec.rb
+- spec/rest/alert_occurrences_spec.rb
+- spec/rest/portfolios_alerts_spec.rb
 - spec/rest/order_refreshes_spec.rb
+- spec/rest/tenant_settings_spec.rb
+- spec/rest/portfolios_spec.rb
+- spec/rest/order_tokens_spec.rb
+- spec/rest/consumers_portfolios_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/support/fake_api.rb
+- spec/support/documents_uploads_routes.rb
+- spec/spec_helper.rb
+- spec/utils/query_builder_spec.rb
+- spec/spec_helpers/client.rb