finapps 6.10.0 → 6.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 765aad4ece03d6e507cd77930fa24fb983911f4773c30adc09399695c62a6c0d
-  data.tar.gz: 7bd544c214f84ec23c64ddc45a732ad820d5faebda7a1c7591a6c46b145dded8
+  metadata.gz: 701a3842e404d5025eccbfd03848e77a1c97ebf837974d51dbbe5d62b7b29ef2
+  data.tar.gz: bd21d306c479be7300b8d9b2769b0e50e657c9c2e962009fa21f82671ab338fe
 SHA512:
-  metadata.gz: 7f7475687fc24f0f4480a0ad229e9ed8fdb9b6a6b4fb7b70117327187678006e3c1476294d2bb2753d2084051bc3350afa81ca892fa9b4d9e9def5e7793e1a40
-  data.tar.gz: 73f047dfbfb2d3e1df537a69145d88a373d80b27799b3a1bf659b9d84c9603fe8048db6e85fe16bb7b4d3b216ddc8272896bb30e95a0658b9467234c89eaa31b
+  metadata.gz: 44bf90538086fc313fbd62e8be9fdb908a72131f31a24a3485528f8da4cc94f299dc1ee1c328116447472914243f5a43916e9c667927fb07221b4d5217685718
+  data.tar.gz: b61176f93d88fdf09e6a640c3a31185b60d295c76ba71a8654f28397ba8c22c5a9feb97b93fb5c07243f3af076387cc38dd1c48b6ae89313546925f796e940fb

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,14 @@
+# 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
+    end
+  end
+end

data/lib/finapps/rest/locations.rb

@@ -8,9 +8,9 @@ module FinApps
         super path
       end
 
-      def update(key, params = {})
-        path = resource_path(key)
-        send_request path, :put, params
+      def update(id, params)
+        path = resource_path(id)
+        super params, path
       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/rest/states.rb

@@ -3,6 +3,9 @@
 module FinApps
   module REST
     class States < FinAppsCore::REST::Resources # :nodoc:
+      def end_point
+        "references/#{super}"
+      end
     end
   end
 end

data/lib/finapps/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinApps
-  VERSION = '6.10.0'
+  VERSION = '6.11.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,20 @@
+# frozen_string_literal: true
+
+RSpec.describe FinApps::REST::EdmTransmissions do
+  include SpecHelpers::Client
+
+  describe '#create' do
+    subject(:list) { described_class.new(client).create(:order_id, params) }
+
+    let(:params) { {external_id: '12345'} }
+
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+
+    it('returns a hash with known keys') do
+      expect(list[RESULTS].keys)
+        .to(match_array(%i[transmission_id date_created date_modified status
+                           document_order_id documents]))
+    end
+  end
+end

data/spec/rest/locations_spec.rb

@@ -5,31 +5,12 @@ require 'digest'
 RSpec.describe FinApps::REST::Locations do
   include SpecHelpers::Client
 
-  describe '#list' do
-    subject(:list) { described_class.new(client).list filter }
-
-    let(:filter) { nil }
-
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(list[RESULTS]).to all(have_key(:name)) }
-    it { expect(list[RESULTS]).to all(have_key(:state)) }
-
-    context 'when the JMESPath filter is invalid' do
-      let(:filter) { 'invalid' }
-
-      it_behaves_like 'a failed request'
-    end
-  end
-
-  describe '#create' do
-    subject(:create) { described_class.new(client).create(params) }
+  let(:id) { :id }
 
-    let(:params) { {name: 'Quick Mart Urgent Care', state: {code: 'MD'}} }
+  params = {name: 'Quick Mart Non-Urgent Care', state: {code: 'MD'}}
 
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(create[RESULTS]).to be_nil }
+  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
@@ -40,73 +21,74 @@ RSpec.describe FinApps::REST::Locations do
     end
   end
 
-  describe '#show' do
-    subject(:show) { described_class.new(client).show(key) }
+  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 }
 
-    let(:key) { Digest::SHA256.hexdigest('Quick Mart Urgent CareMD,MD') }
+    let(:filter) { nil }
 
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'
-    it { expect(show[RESULTS]).to have_key(:name) }
-    it { expect(show[RESULTS]).to have_key(:state) }
+    it { expect(list[RESULTS]).to all(have_keys(:id, :name, :state)) }
 
-    context 'when key is not a valid SHA256' do
-      let(:key) { 'invalid_SHA256' }
+    context 'when the JMESPath filter is invalid' do
+      let(:filter) { 'invalid' }
 
       it_behaves_like 'a failed request'
     end
+  end
 
-    context 'when key does not match any location' do
-      let(:key) { 'not_found' }
+  describe '#show' do
+    subject(:show) { described_class.new(client).show(id) }
+
+    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' }
 
-      it_behaves_like 'a failed request'
       it_behaves_like 'a request to a not found resource'
     end
   end
 
-  describe '#update' do
-    subject(:update) { described_class.new(client).update(key, params) }
-
-    let(:key) { Digest::SHA256.hexdigest('Quick Mart Urgent CareMD,MD') }
-    let(:params) { {name: 'Quick Mart Non-Urgent Care', state: {code: 'MD'}} }
+  describe '#create' do
+    subject(:create) { described_class.new(client).create(params) }
 
-    it_behaves_like 'an API request'
-    it_behaves_like 'a successful request'
-    it { expect(update[RESULTS]).to be_nil }
+    it_behaves_like 'a successful API request returning an empty body'
+  end
 
-    context 'when key is not a valid SHA256' do
-      let(:key) { 'invalid_SHA256' }
+  describe '#update' do
+    subject(:update) { described_class.new(client).update(id, params) }
 
-      it_behaves_like 'a failed request'
+    context 'when the location exists' do
+      it_behaves_like 'a successful API request returning an empty body'
     end
 
-    context 'when key does not match any location' do
-      let(:key) { 'not_found' }
+    context 'when id does not match any location' do
+      let(:id) { 'not_found' }
 
-      it_behaves_like 'a failed request'
       it_behaves_like 'a request to a not found resource'
     end
   end
 
   describe '#destroy' do
-    subject(:destroy) { described_class.new(client).destroy(key) }
-
-    let(:key) { Digest::SHA256.hexdigest('Quick Mart Urgent CareMD,MD') }
+    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 key is not a valid SHA256' do
-      let(:key) { 'invalid_SHA256' }
-
-      it_behaves_like 'a failed request'
+    context 'when the location exists' do
+      it_behaves_like 'a successful API request returning an empty body'
     end
 
-    context 'when key does not match any location' do
-      let(:key) { 'not_found' }
+    context 'when id does not match any location' do
+      let(:id) { 'not_found' }
 
-      it_behaves_like 'a failed request'
       it_behaves_like 'a request to a not found resource'
     end
   end

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

@@ -9,6 +9,8 @@ RSpec.describe FinApps::REST::States do
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'
 
-    it('returns a list') { expect(list[RESULTS]).to be_a(Array) }
+    it('returns a list of hashes with the following keys: code, label, type') do
+      expect(list[RESULTS].first.keys).to match_array(%i[code label type])
+    end
   end
 end

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/locations/get_location.json

@@ -1,4 +1,5 @@
 {
+  "id": "2c0c2951-0a5e-463f-abd3-d315e63a62b2",
   "name": "IK",
   "state": {
     "code": "MD",

data/spec/support/fixtures/locations/get_locations.json

@@ -1,5 +1,6 @@
 [
   {
+    "id": "2c0c2951-0a5e-463f-abd3-d315e63a62b2",
     "name": "Quick Mart Urgent Care",
     "state": {
       "code": "MD",
@@ -8,6 +9,7 @@
     }
   },
   {
+    "id": "2c0c2951-0a5e-463f-abd3-d315e63a62b3",
     "name": "Quick Mart Emergency Room",
     "state": {
       "code": "MD",
@@ -16,6 +18,7 @@
     }
   },
   {
+    "id": "2c0c2951-0a5e-463f-abd3-d315e63a62b4",
     "name": "Quick Mart - Folsom Business Office",
     "state": {
       "code": "CA",
@@ -23,4 +26,4 @@
       "type": "state"
     }
   }
-]
+]

data/spec/support/routes/edm_transmissions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Fake
+  module EdmTransmissionsRoutes
+    class << self
+      def included(base)
+        post_routes base
+
+        super
+      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

data/spec/support/routes/locations.rb

@@ -19,18 +19,16 @@ module Fake
       end
 
       def delete_routes(base)
-        base.delete("/#{base.version}/locations/:key") do
-          return status(404) if params[:key] == 'not_found'
-          return status(400) unless sha256?(params[:key])
+        base.delete("/#{base.version}/locations/:id") do
+          return status(404) if params[:id] == 'not_found'
 
           status 204
         end
       end
 
       def put_routes(base)
-        base.put("/#{base.version}/locations/:key") do
-          return status(404) if params[:key] == 'not_found'
-          return status(400) unless sha256?(params[:key])
+        base.put("/#{base.version}/locations/:id") do
+          return status(404) if params[:id] == 'not_found'
 
           status 204
         end
@@ -42,17 +40,12 @@ module Fake
 
           json_response 200, 'locations/get_locations.json'
         end
-        base.get("/#{base.version}/locations/:key") do
-          return status(404) if params[:key] == 'not_found'
-          return status(400) unless sha256?(params[:key])
+        base.get("/#{base.version}/locations/:id") do
+          return status(404) if params[:id] == 'not_found'
 
           json_response 200, 'locations/get_location.json'
         end
       end
     end
-
-    def sha256?(key)
-      key.length == 64 && key.match(/^[0-9a-f]+$/)
-    end
   end
 end

data/spec/support/routes/states.rb

@@ -4,7 +4,7 @@ module Fake
   module StateRoutes
     class << self
       def included(base)
-        base.get("/#{base.version}/states") do
+        base.get("/#{base.version}/references/states") do
           json_response 200, 'states/get_states.json'
         end
         super

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 6.10.0
+  version: 6.11.0
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-05-19 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,7 @@ 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/error.json
 - spec/support/fixtures/esign_templates.json
 - spec/support/fixtures/invalid_order_id.json
@@ -446,6 +449,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
@@ -483,65 +487,67 @@ 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/spec_helper.rb
 - spec/support/documents_uploads_routes.rb
-- spec/support/routes/locations.rb
-- spec/support/routes/query_screenings.rb
+- spec/support/fake_api.rb
 - spec/support/routes/states.rb
 - spec/support/routes/actors.rb
+- spec/support/routes/edm_transmissions.rb
+- spec/support/routes/locations.rb
 - spec/support/routes/screening_metadatas.rb
+- spec/support/routes/query_screenings.rb
 - spec/support/screenings_routes.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/utils/query_builder_spec.rb
+- spec/spec_helpers/client.rb
+- spec/spec_helpers/api_request.rb
+- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/consumers_spec.rb
+- spec/rest/locations_spec.rb
+- spec/rest/screenings_spec.rb
+- spec/rest/consumer_login_tokens_spec.rb
+- spec/rest/operators_spec.rb
 - spec/rest/verix/verix_pdf_documents_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/states_spec.rb
-- spec/rest/consumers_portfolios_spec.rb
-- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/documents_orders_notifications_spec.rb
+- spec/rest/screening_metadatas_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_available_consumers_spec.rb
+- spec/rest/client_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/edm_transmissions_spec.rb
+- spec/rest/sessions_spec.rb
+- spec/rest/portfolios_spec.rb
+- spec/rest/portfolios_consumers_spec.rb
+- spec/rest/operators_login_tokens_spec.rb
+- spec/rest/tenant_settings_spec.rb
+- spec/rest/alert_occurrences_spec.rb
+- spec/rest/query/screenings_spec.rb
+- spec/rest/query/base_spec.rb
+- spec/rest/documents_uploads_spec.rb
 - spec/rest/actors_spec.rb
+- spec/rest/order_statuses_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/rest/alert_definitions_spec.rb
+- spec/rest/operator_change_password_email_spec.rb
+- spec/rest/consumers_portfolios_spec.rb
 - spec/rest/plaid/plaid_accounts_spec.rb
-- spec/rest/plaid/plaid_account_permissions_spec.rb
-- spec/rest/plaid/plaid_webhooks_spec.rb
 - spec/rest/plaid/plaid_institution_logos_spec.rb
 - spec/rest/plaid/plaid_consumer_institutions_spec.rb
+- spec/rest/plaid/plaid_webhooks_spec.rb
+- spec/rest/plaid/plaid_account_permissions_spec.rb
+- spec/rest/version_spec.rb
+- spec/rest/products_spec.rb
 - spec/rest/tenant_app_settings_spec.rb
-- spec/rest/locations_spec.rb
-- spec/rest/consumers_spec.rb
+- spec/rest/order_assignments_spec.rb
+- spec/rest/documents_orders_spec.rb
+- spec/rest/esign_templates_spec.rb
+- spec/rest/order_reports_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/documents_upload_types_spec.rb
+- spec/rest/states_spec.rb
+- spec/rest/order_refreshes_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/version_spec.rb
-- spec/spec_helpers/api_request.rb
-- spec/spec_helpers/client.rb
+- spec/rest/orders_spec.rb