finapps 6.10.1 → 6.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42aeaed6c32c359360c5f40a432723036e7118029003cd6b0d0e2fccad644fd
-  data.tar.gz: 720c838e5da2710309dc6be29e640ba6238c101244145a4eb20b06d765c4387b
+  metadata.gz: 6ce7c7f8fc34e608321adfbbd46536d067f7d50ad907ae0990623b840431f4c7
+  data.tar.gz: 73b85fc49cee872b9c1f0f5e3d9f39493a23bd0f46aeea8f6ef1e0c19979c5e8
 SHA512:
-  metadata.gz: 6b6a365b8057aebefb8431f93e660b133deda0ae94829aa2fdc98d4f59001c9b1cd803af75b44de83bb5c574d940dacb25e13b1e40ff93b2f76893a7bf3001e6
-  data.tar.gz: 7f09473a81677c621c2ebc86e15e346a4d3c5418e3e845c2ac16cf8237c247ccb5aa2b70e46744b1bad3d6f4bb5784be1e9bcca7ecb806dc3fe663e6f050e60d
+  metadata.gz: a48f06dc8cba7910743355dcd41e93d0835cb5c270b04e94ac11177994ab9397f023504b910b5ae08d00f492db8f7a07b1d586ba0990103fd78493b8aaee5b8c
+  data.tar.gz: f42a6c18258a88072d36a46d91c2071c648aba643f9a433b762589133d089a7d71839a9feb2a62796f31a019890e64cefca5071056671a1b44f8be6cf4a5e9be

data/finapps.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
 
   spec.files = `git ls-files -z`.split("\x0")
   spec.executables = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
-  spec.test_files = Dir['spec/**/*.rb']
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency     'finapps_core',               '~> 6.0',   '>= 6.0.2'

data/lib/finapps/rest/client.rb

@@ -17,6 +17,7 @@ module FinApps
         documents_orders_notifications
         documents_upload_types
         documents_uploads
+        edm_transmissions
         esign_templates
         orders
         locations

data/lib/finapps/rest/edm_transmissions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class EdmTransmissions < FinAppsCore::REST::Resources # :nodoc:
+      def create(order_id, params)
+        not_blank(order_id, :order_id)
+
+        path = "documents/edm/#{ERB::Util.url_encode(order_id)}/transmit"
+        super(params, path)
+      end
+
+      def show(transmission_id)
+        not_blank(transmission_id, :transmission_id)
+
+        path = "documents/edm/#{ERB::Util.url_encode(transmission_id)}"
+        super transmission_id, path
+      end
+    end
+  end
+end

data/lib/finapps/rest/operators.rb

@@ -67,10 +67,11 @@ module FinApps
       end
 
       def term_array(term)
-        [
-          {email: term},
-          {last_name: term}
-        ]
+        if term.include?('@')
+          [{email: term}]
+        else
+          [{last_name: term}]
+        end
       end
 
       def role_filter(role)

data/lib/finapps/version.rb

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

data/lib/finapps.rb

@@ -5,6 +5,7 @@ require 'faraday_middleware'
 
 require 'finapps_core'
 require 'finapps/rest/actors'
+require 'finapps/rest/edm_transmissions'
 require 'finapps/rest/version'
 require 'finapps/rest/locations'
 require 'finapps/rest/consumers'

data/spec/rest/edm_transmissions_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.describe FinApps::REST::EdmTransmissions do
+  include SpecHelpers::Client
+
+  RSpec.shared_examples 'an EdmTransmission response' do
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+
+    it('returns a hash with the correct keys') do
+      expect(subject[RESULTS].keys)
+        .to(match_array(%i[transmission_id date_created date_modified status
+                           document_order_id documents]))
+    end
+  end
+
+  describe '#create' do
+    subject(:list) { described_class.new(client).create(:order_id, params) }
+
+    let(:params) { {external_id: '12345'} }
+
+    it_behaves_like 'an EdmTransmission response'
+  end
+
+  describe '#show' do
+    subject(:show) { described_class.new(client).show(:transmission_id) }
+
+    it_behaves_like 'an EdmTransmission response'
+  end
+end

data/spec/rest/locations_spec.rb

@@ -7,6 +7,26 @@ RSpec.describe FinApps::REST::Locations do
 
   let(:id) { :id }
 
+  params = {name: 'Quick Mart Non-Urgent Care', state: {code: 'MD'}}
+
+  RSpec::Matchers.define :have_keys do |*keys|
+    match {|actual| keys.all? {|key| actual.key? key } }
+  end
+
+  RSpec.shared_examples 'a request to a not found resource' do
+    it_behaves_like 'a failed request'
+    it('returns a 404 error') do
+      expect(subject[ERROR_MESSAGES].first)
+        .to(eq('the server responded with status 404'))
+    end
+  end
+
+  RSpec.shared_examples 'a successful API request returning an empty body' do
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+    it { expect(subject[RESULTS]).to be_nil }
+  end
+
   describe '#list' do
     subject(:list) { described_class.new(client).list filter }
 
@@ -14,9 +34,7 @@ RSpec.describe FinApps::REST::Locations do
 
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'
-    it { expect(list[RESULTS]).to all(have_key(:id)) }
-    it { expect(list[RESULTS]).to all(have_key(:name)) }
-    it { expect(list[RESULTS]).to all(have_key(:state)) }
+    it { expect(list[RESULTS]).to all(have_keys(:id, :name, :state)) }
 
     context 'when the JMESPath filter is invalid' do
       let(:filter) { 'invalid' }
@@ -25,32 +43,14 @@ RSpec.describe FinApps::REST::Locations do
     end
   end
 
-  describe '#create' do
-    subject(:create) { described_class.new(client).create(params) }
-
-    let(:params) { {name: 'Quick Mart Urgent Care', state: {code: 'MD'}} }
-
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(create[RESULTS]).to be_nil }
-  end
-
-  RSpec.shared_examples 'a request to a not found resource' do
-    it_behaves_like 'a failed request'
-    it('returns a 404 error') do
-      expect(subject[ERROR_MESSAGES].first)
-        .to(eq('the server responded with status 404'))
-    end
-  end
-
   describe '#show' do
     subject(:show) { described_class.new(client).show(id) }
 
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(show[RESULTS]).to have_key(:id) }
-    it { expect(show[RESULTS]).to have_key(:name) }
-    it { expect(show[RESULTS]).to have_key(:state) }
+    context 'when the location exists' do
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it { expect(show[RESULTS]).to have_keys(:id, :name, :state) }
+    end
 
     context 'when id does not match any location' do
       let(:id) { 'not_found' }
@@ -59,14 +59,18 @@ RSpec.describe FinApps::REST::Locations do
     end
   end
 
+  describe '#create' do
+    subject(:create) { described_class.new(client).create(params) }
+
+    it_behaves_like 'a successful API request returning an empty body'
+  end
+
   describe '#update' do
     subject(:update) { described_class.new(client).update(id, params) }
 
-    let(:params) { {name: 'Quick Mart Non-Urgent Care', state: {code: 'MD'}} }
-
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(update[RESULTS]).to be_nil }
+    context 'when the location exists' do
+      it_behaves_like 'a successful API request returning an empty body'
+    end
 
     context 'when id does not match any location' do
       let(:id) { 'not_found' }
@@ -78,9 +82,9 @@ RSpec.describe FinApps::REST::Locations do
   describe '#destroy' do
     subject(:destroy) { described_class.new(client).destroy(id) }
 
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(destroy[RESULTS]).to be_nil }
+    context 'when the location exists' do
+      it_behaves_like 'a successful API request returning an empty body'
+    end
 
     context 'when id does not match any location' do
       let(:id) { 'not_found' }

data/spec/rest/operators_spec.rb

@@ -25,12 +25,21 @@ RSpec.describe FinApps::REST::Operators do
         end
       end
 
-      context 'with searchTerm' do
+      context 'with email searchTerm' do
+        let(:params) { {searchTerm: 'term@example.com'} }
+
+        it_behaves_like 'a filtereable GET index request', {
+          '$or': [
+            {email: 'term@example.com'}
+          ]
+        }
+      end
+
+      context 'with non email searchTerm' do
         let(:params) { {searchTerm: 'le term'} }
 
         it_behaves_like 'a filtereable GET index request', {
           '$or': [
-            {email: 'le term'},
             {last_name: 'le term'}
           ]
         }
@@ -65,7 +74,7 @@ RSpec.describe FinApps::REST::Operators do
         it 'builds a full filter and query and sends the request' do
           list
 
-          filter = {'$or': [{email: 't'}, {last_name: 't'}], role: {'$in': [2]}}
+          filter = {'$or': [{last_name: 't'}], role: {'$in': [2]}}
           expect(WebMock).to have_requested(:get, "#{versioned_api_path}/operators"\
                                                   "?filter=#{ERB::Util.url_encode filter.to_json}"\
                                                   '&page=2&requested=25&sort=date_created')

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-if ENV['COVERAGE'] == 'true'
+if ENV.fetch('COVERAGE', nil) == 'true'
   require 'simplecov'
   require 'simplecov-console'
 

data/spec/support/fake_api.rb

@@ -5,6 +5,7 @@ require 'sinatra/base'
 require_relative 'documents_uploads_routes'
 require_relative 'screenings_routes'
 require_relative 'routes/actors'
+require_relative 'routes/edm_transmissions'
 require_relative 'routes/locations'
 require_relative 'routes/screening_metadatas'
 require_relative 'routes/query_screenings'
@@ -25,6 +26,7 @@ module Fake
     delete("/#{version}/resources/:id") { status 202 }
 
     include ActorsRoutes
+    include EdmTransmissionsRoutes
     include DocumentsUploadsRoutes
     include LocationsRoutes
     include QueryScreeningRoutes

data/spec/support/fixtures/edm_transmissions/create.json

@@ -0,0 +1,17 @@
+{
+    "transmission_id": "7829e171-4d39-4270-8969-7729038953d2",
+    "date_created": "2022-05-18T21:05:48.076809156Z",
+    "date_modified": "2022-05-18T21:05:48.07680924Z",
+    "status": 0,
+    "document_order_id": "0c272b3d-3c8c-43ab-beff-f5964835a591",
+    "documents": [
+        {
+            "template_data": null,
+            "path": "",
+            "file_id": "",
+            "status": 0,
+            "edm_filename": "",
+            "date_modified": "0001-01-01T00:00:00Z"
+        }
+    ]
+}

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

@@ -0,0 +1,17 @@
+{
+    "transmission_id": "7829e171-4d39-4270-8969-7729038953d2",
+    "date_created": "2022-05-18T21:05:48.076Z",
+    "date_modified": "2022-06-08T20:46:05.839936446Z",
+    "status": 1,
+    "document_order_id": "0c272b3d-3c8c-43ab-beff-f5964835a591",
+    "documents": [
+        {
+            "template_data": {},
+            "path": "",
+            "file_id": "",
+            "status": 0,
+            "edm_filename": "",
+            "date_modified": "0001-01-01T00:00:00Z"
+        }
+    ]
+}

data/spec/support/routes/edm_transmissions.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Fake
+  module EdmTransmissionsRoutes
+    class << self
+      def included(base)
+        get_routes base
+        post_routes base
+
+        super
+      end
+
+      def get_routes(base)
+        base.get("/#{base.version}/documents/edm/:transmission_id") do
+          json_response 200, 'edm_transmissions/show.json'
+        end
+      end
+
+      def post_routes(base)
+        base.post("/#{base.version}/documents/edm/:order_id/transmit") do
+          json_response 200, 'edm_transmissions/create.json'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 6.10.1
+  version: 6.12.0
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -269,6 +269,7 @@ files:
 - lib/finapps/rest/documents_orders_notifications.rb
 - lib/finapps/rest/documents_upload_types.rb
 - lib/finapps/rest/documents_uploads.rb
+- lib/finapps/rest/edm_transmissions.rb
 - lib/finapps/rest/esign_templates.rb
 - lib/finapps/rest/locations.rb
 - lib/finapps/rest/operator_change_password_email.rb
@@ -322,6 +323,7 @@ files:
 - spec/rest/documents_orders_spec.rb
 - spec/rest/documents_upload_types_spec.rb
 - spec/rest/documents_uploads_spec.rb
+- spec/rest/edm_transmissions_spec.rb
 - spec/rest/esign_templates_spec.rb
 - spec/rest/locations_spec.rb
 - spec/rest/operator_change_password_email_spec.rb
@@ -375,6 +377,8 @@ files:
 - spec/support/fixtures/documents_order.json
 - spec/support/fixtures/documents_orders.json
 - spec/support/fixtures/documents_orders_none.json
+- spec/support/fixtures/edm_transmissions/create.json
+- spec/support/fixtures/edm_transmissions/show.json
 - spec/support/fixtures/error.json
 - spec/support/fixtures/esign_templates.json
 - spec/support/fixtures/invalid_order_id.json
@@ -446,6 +450,7 @@ files:
 - spec/support/fixtures/verix/record/create.json
 - spec/support/fixtures/verix/record/list.json
 - spec/support/routes/actors.rb
+- spec/support/routes/edm_transmissions.rb
 - spec/support/routes/locations.rb
 - spec/support/routes/query_screenings.rb
 - spec/support/routes/screening_metadatas.rb
@@ -482,66 +487,4 @@ rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
-test_files:
-- spec/spec_helper.rb
-- spec/spec_helpers/api_request.rb
-- spec/spec_helpers/client.rb
-- spec/rest/query/screenings_spec.rb
-- spec/rest/query/base_spec.rb
-- spec/rest/portfolios_available_consumers_spec.rb
-- spec/rest/documents_orders_notifications_spec.rb
-- spec/rest/portfolios_alerts_spec.rb
-- spec/rest/version_spec.rb
-- spec/rest/alert_occurrences_spec.rb
-- spec/rest/products_spec.rb
-- spec/rest/operator_change_password_email_spec.rb
-- spec/rest/consumers_spec.rb
-- spec/rest/screenings_spec.rb
-- spec/rest/order_notifications_spec.rb
-- spec/rest/tenant_app_settings_spec.rb
-- spec/rest/order_reports_spec.rb
-- spec/rest/documents_uploads_spec.rb
-- spec/rest/operators_spec.rb
-- spec/rest/portfolios_spec.rb
-- spec/rest/locations_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/actors_spec.rb
-- spec/rest/documents_orders_spec.rb
-- spec/rest/consumer_login_tokens_spec.rb
-- spec/rest/documents_upload_types_spec.rb
-- spec/rest/tenant_settings_spec.rb
-- spec/rest/screening_metadatas_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/order_refreshes_spec.rb
-- spec/rest/operators_password_resets_spec.rb
-- spec/rest/order_assignments_spec.rb
-- spec/rest/alert_definitions_spec.rb
-- spec/rest/signed_documents_downloads_spec.rb
-- spec/rest/operators_login_tokens_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/verix/verix_documents_spec.rb
-- spec/rest/password_resets_spec.rb
-- spec/rest/plaid/plaid_webhooks_spec.rb
-- spec/rest/plaid/plaid_account_permissions_spec.rb
-- spec/rest/plaid/plaid_institution_logos_spec.rb
-- spec/rest/plaid/plaid_accounts_spec.rb
-- spec/rest/plaid/plaid_consumer_institutions_spec.rb
-- spec/rest/states_spec.rb
-- spec/rest/esign_templates_spec.rb
-- spec/rest/portfolios_consumers_spec.rb
-- spec/rest/order_statuses_spec.rb
-- spec/rest/portfolio_reports_spec.rb
-- spec/rest/sessions_spec.rb
-- spec/rest/consumers_portfolios_spec.rb
-- spec/rest/orders_spec.rb
-- spec/utils/query_builder_spec.rb
-- spec/support/screenings_routes.rb
-- spec/support/documents_uploads_routes.rb
-- spec/support/routes/screening_metadatas.rb
-- spec/support/routes/query_screenings.rb
-- spec/support/routes/states.rb
-- spec/support/routes/actors.rb
-- spec/support/routes/locations.rb
-- spec/support/fake_api.rb
+test_files: []