finapps 6.6.1 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a73b786466432a4103a2aa1a613b7294363e3a2a2ee36796e46107cc624cee6
-  data.tar.gz: 044fd7f2ab6662059afdfe520c73f351a2f6c14571fc2e37c6f14c9f27ede559
+  metadata.gz: 735176ac6ed0687571813a8c336c16b69af0c5667c6596700ff9e2a9f68f360a
+  data.tar.gz: c6d8d16e7eefd52b3394211874bb3e525c012b63729465d0fdbad4ff06d23b53
 SHA512:
-  metadata.gz: 5a3da497f21c62ba5e22347beab814818d9ee9d29a83d8c9a02b9a7db8503ad8b1df848d11606d37e0a51a9c96b34c18ecb92044c08e6cac014a1c4b30882083
-  data.tar.gz: 16fffb9b02cf31f970a757401c6c60f4c6f98435f7eafb2a145c13f5e43b798b6e2dac6b1a981c2e336a96c8ca09537558a5d1789bb2bcf6f2f8498ebc5b353a
+  metadata.gz: 4839196dbed34dce8f802b4e4b95b45b0ce0a8d1e43993290a3783711c6a43394e1ad1680084590ec0ecc3baaa5ae3f4c3c5f52e69b06d72449ef2fd35698e70
+  data.tar.gz: 60afeee0003d524c52a7e966e49e8f6972e5308c7d92c34451149ef25a3041078551eb391a72e38b6723bbcad6e2a8ae284f2b659a5814d6a22fbdb13bc491d8

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/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 => 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.6.1'
+  VERSION = '6.7.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/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

@@ -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/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.1
+  version: 6.7.0
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-09 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/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/support/routes/actors.rb
-- spec/utils/query_builder_spec.rb
-- spec/spec_helpers/client.rb
-- spec/spec_helpers/api_request.rb
-- spec/spec_helper.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/consumers_portfolios_spec.rb
-- spec/rest/portfolios_consumers_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/portfolio_reports_spec.rb
-- spec/rest/portfolios_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/sessions_spec.rb
-- spec/rest/orders_spec.rb
-- spec/rest/products_spec.rb
-- spec/rest/operators_password_resets_spec.rb
 - spec/rest/alert_occurrences_spec.rb
-- spec/rest/plaid/plaid_consumer_institutions_spec.rb
-- spec/rest/plaid/plaid_accounts_spec.rb
-- spec/rest/plaid/plaid_webhooks_spec.rb
-- spec/rest/plaid/plaid_institution_logos_spec.rb
-- spec/rest/plaid/plaid_account_permissions_spec.rb
+- spec/rest/portfolios_available_consumers_spec.rb
 - spec/rest/consumer_login_tokens_spec.rb
-- spec/rest/documents_orders_notifications_spec.rb
-- spec/rest/signed_documents_downloads_spec.rb
-- spec/rest/operator_change_password_email_spec.rb
-- spec/rest/version_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/portfolios_alerts_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_documents_spec.rb
 - spec/rest/verix/verix_records_spec.rb
-- spec/rest/screenings_spec.rb
-- spec/rest/order_assignments_spec.rb
-- spec/rest/alert_definitions_spec.rb
-- spec/rest/portfolios_available_consumers_spec.rb
-- spec/rest/order_statuses_spec.rb
-- spec/rest/actors_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/documents_orders_spec.rb
-- spec/rest/documents_uploads_spec.rb
-- spec/rest/operators_login_tokens_spec.rb
-- spec/rest/password_resets_spec.rb
-- spec/rest/esign_templates_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/client_spec.rb
+- spec/rest/portfolios_alerts_spec.rb
 - spec/rest/consumers_spec.rb
-- spec/rest/tenant_settings_spec.rb
-- spec/rest/documents_upload_types_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/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