finapps 5.0.25 → 5.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ce0fc688800cfa247a62642d55c679edbe52a0a10556e359bf290b8f202351a
-  data.tar.gz: 0b5a307b87e1b704c8fa684a98f6fcb804538d3ac6326a08ac8285f462f23556
+  metadata.gz: 1c74f2340d52ad3cd13dc2bdf8415e7cf89e48f0993dbb346456546910a69ba9
+  data.tar.gz: 3bdefc2032a2efa241d5cc72ab5d6b74fc44b568599f0054bf5477e473fab81f
 SHA512:
-  metadata.gz: 3bbddba45806a7df005d72934aff45b43a3f574bf054e63622e2e7acc39ec06bd210742cd5dc8b9684cb9d179e8b4e882cb04fa9d1d278bea81dd002f4dd89f9
-  data.tar.gz: 2d8ac6a59586af1c7eaa3d7e3b8bcf78b7fcaca9ea7d440e07c639d7e8cc728439579eb45ff0cc78a399349b00cf6f8f4655cdc7d1834c82b95886881ab515d3
+  metadata.gz: 9cb6732ca1b8ba09cc84920ec7fdd086259cd339f012f72cf19c30387f877f3af1aa495bea47f019ee638e9a32eb3f76bbd0397e89b6e773e108da98e9bc8300
+  data.tar.gz: 5dedcdb78fa82b22011520031aae7aa55b1c6e35a7f5ccd55e16fdaa1c6d3b19bd4d17e300a00849d1768be6528b2396adff43ef96b6c6f060740af4315c857f

data/.codeclimate.yml

@@ -12,7 +12,8 @@ plugins:
     enabled: true
     config:
       languages:
-      - ruby
+        ruby:
+          mass_threshold: 30
 
 ratings:
   paths:

data/RELEASES.md

@@ -1,3 +1,43 @@
+## [5.0.30] - 2020-05-28
+
+### Added
+* New esign endpoints ([#222][i222])
+
+### Changed
+* Search query for documents orders ([#221][i221])
+
+[i221]: https://github.com/finapps/ruby-client/issues/221
+[i222]: https://github.com/finapps/ruby-client/issues/222
+
+[5.0.30]: https://github.com/finapps/ruby-client/compare/5.0.29...5.0.30
+
+## [5.0.29] - 2020-05-08
+
+### Added
+* Document-orders endpoints ([#219][i219])
+
+[i219]: https://github.com/finapps/ruby-client/issues/219
+
+[5.0.29]: https://github.com/finapps/ruby-client/compare/5.0.28...5.0.29
+
+## [5.0.28] - 2020-02-19
+
+### Added
+* Verix document endpoints ([#217][i217])
+
+[i217]: https://github.com/finapps/ruby-client/issues/217
+
+[5.0.28]: https://github.com/finapps/ruby-client/compare/5.0.27...5.0.28
+
+## [5.0.27] - 2020-02-11
+
+### Changed
+* Update finapps-core gem ([#215][i215])
+
+[i215]: https://github.com/finapps/ruby-client/issues/215
+
+[5.0.27]: https://github.com/finapps/ruby-client/compare/5.0.26...5.0.27
+
 ## [5.0.23] - 2020-01-16
 
 ### Changed

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.6'
+  spec.add_runtime_dependency     'finapps_core',               '~> 5.0',   '>= 5.0.7'
 
   spec.add_development_dependency 'bundler',                    '~> 2.0',   '>= 2.0.2'
   spec.add_development_dependency 'codeclimate-test-reporter',  '~> 1.0',   '>= 1.0.9'

data/lib/finapps.rb

@@ -19,7 +19,6 @@ require 'finapps/rest/products'
 require 'finapps/rest/order_assignments'
 require 'finapps/rest/client'
 require 'finapps/rest/order_refreshes'
-require 'finapps/rest/statements'
 require 'finapps/rest/tenant_settings'
 require 'finapps/rest/tenant_app_settings'
 require 'finapps/rest/portfolios'
@@ -30,6 +29,10 @@ require 'finapps/rest/portfolios_alerts'
 require 'finapps/rest/portfolios_consumers'
 require 'finapps/rest/consumers_portfolios'
 require 'finapps/rest/portfolio_reports'
+require 'finapps/rest/documents_orders'
+require 'finapps/rest/esign_templates'
+require 'finapps/rest/signed_documents_downloads'
+require 'finapps/rest/documents_orders_notifications'
 
 require 'finapps/rest/plaid/plaid_resources'
 require 'finapps/rest/plaid/plaid_webhooks'
@@ -40,6 +43,8 @@ require 'finapps/rest/plaid/plaid_institution_logos'
 
 require 'finapps/rest/verix/verix_metadata'
 require 'finapps/rest/verix/verix_records'
+require 'finapps/rest/verix/verix_pdf_documents'
+require 'finapps/rest/verix/verix_documents'
 
 require 'finapps/utils/query_builder'
 require 'finapps/version' unless defined?(FinApps::VERSION)

data/lib/finapps/rest/client.rb

@@ -9,7 +9,11 @@ module FinApps
       RESOURCES = %i[
         alert_definitions
         alert_occurrences
+        consumers
         consumers_portfolios
+        documents_orders
+        documents_orders_notifications
+        esign_templates
         orders
         order_assignments
         order_notifications
@@ -20,24 +24,26 @@ module FinApps
         operators
         operators_password_resets
         password_resets
-        products
+        plaid_webhooks
+        plaid_consumer_institutions
+        plaid_accounts
+        plaid_account_permissions
+        plaid_institution_logos
         portfolios
         portfolios_alerts
         portfolios_available_consumers
         portfolios_consumers
         portfolio_reports
+        products
         sessions
-        consumers
+        signed_documents_downloads
         tenant_settings
         tenant_app_settings
-        version
-        plaid_webhooks
-        plaid_consumer_institutions
-        plaid_accounts
-        plaid_account_permissions
-        plaid_institution_logos
         verix_metadata
         verix_records
+        verix_pdf_documents
+        verix_documents
+        version
       ].freeze
 
       # @param [String] tenant_token

data/lib/finapps/rest/consumers.rb

@@ -48,7 +48,9 @@ module FinApps
       end
 
       def build_filter(params)
-        search_query(params[:searchTerm]) if params[:searchTerm]
+        return {} unless params[:searchTerm]
+
+        search_query(params[:searchTerm])
       end
 
       def search_query(term)

data/lib/finapps/rest/documents_orders.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative '../utils/query_builder'
+
+module FinApps
+  module REST
+    class DocumentsOrders < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+
+      def list(params = nil)
+        path = 'documents/orders'
+        return super(path) if params.nil?
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(path, params)
+      end
+
+      def show(id)
+        not_blank(id, :order_id)
+        super(id, "documents/orders/#{id}")
+      end
+
+      def create(params)
+        not_blank(params, :params)
+        super(params, 'documents/orders')
+      end
+
+      def update(id, params = nil)
+        not_blank(id, :order_id)
+        not_blank(params, :params)
+        super(params, "documents/orders/#{id}")
+      end
+
+      def destroy(id)
+        not_blank(id, :order_id)
+        super(id, "documents/orders/#{id}")
+      end
+
+      def show_signing_url(order_id, signature_id)
+        not_blank(order_id, :order_id)
+        not_blank(signature_id, :signature_id)
+        path = "documents/orders/#{order_id}/sign_url/#{signature_id}"
+        send_request path, :get
+      end
+
+      private
+
+      def build_filter(params)
+        search_query(params[:searchTerm]).merge(consumer_query(params[:consumer])).merge(tag_query(params[:tag]))
+      end
+
+      def search_query(term)
+        if term
+          {
+            "$or": [
+              { "applicant.email": term },
+              { "applicant.first_name": term },
+              { "applicant.last_name": term },
+              {
+                "reference_no": {
+                  "$regex": "^#{term}", "$options": 'i'
+                }
+              }
+            ]
+          }
+        else
+          {}
+        end
+      end
+
+      def tag_query(tag)
+        if tag
+          { "tag": tag.empty? ? nil : tag }
+        else
+          {}
+        end
+      end
+
+      def consumer_query(consumer)
+        if consumer
+          { "consumer_id": consumer.empty? ? nil : consumer }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/finapps/rest/documents_orders_notifications.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class DocumentsOrdersNotifications < FinAppsCore::REST::Resources
+      def create(id)
+        not_blank(id, :id)
+
+        path = "documents/orders/#{ERB::Util.url_encode(id)}/notify"
+        super nil, path
+      end
+    end
+  end
+end

data/lib/finapps/rest/esign_templates.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class EsignTemplates < FinAppsCore::REST::Resources
+      def list
+        super('esign_templates')
+      end
+    end
+  end
+end

data/lib/finapps/rest/signed_documents_downloads.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class SignedDocumentsDownloads < FinAppsCore::REST::Resources
+      def show(consumer_id, signature_request_id)
+        not_blank(consumer_id, :consumer_id)
+        not_blank(signature_request_id, :signature_request_id)
+        path =
+          "consumers/#{ERB::Util.url_encode(consumer_id)}/documents/#{ERB::Util.url_encode(signature_request_id)}"
+        super(nil, path)
+      end
+    end
+  end
+end

data/lib/finapps/rest/verix/verix_documents.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class VerixDocuments < FinAppsCore::REST::Resources
+      def list(record_id)
+        not_blank(record_id, :record_id)
+        path = "v/record/#{ERB::Util.url_encode(record_id)}/document"
+        super path
+      end
+
+      def show(record_id, document_id)
+        not_blank(record_id, :record_id)
+        not_blank(document_id, :document_id)
+        path =
+          "v/record/#{ERB::Util.url_encode(record_id)}/document/#{ERB::Util.url_encode(document_id)}"
+        super(nil, path)
+      end
+    end
+  end
+end

data/lib/finapps/rest/verix/verix_pdf_documents.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class VerixPdfDocuments < FinAppsCore::REST::Resources # :nodoc:
+      def show(record_id, provider_id)
+        not_blank(record_id, :record_id)
+        not_blank(provider_id, :provider_id)
+        path =
+          "v/record/#{ERB::Util.url_encode(record_id)}/file/#{ERB::Util.url_encode(provider_id)}"
+        super(nil, path)
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

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

data/spec/rest/consumers_spec.rb

@@ -62,7 +62,30 @@ RSpec.describe FinApps::REST::Consumers,
       it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
     end
 
-    context 'when including valid params' do
+    context 'when including valid params without searchTerm' do
+      let(:params) do
+        {
+          page: 3,
+          requested: 19
+        }
+      end
+
+      it { expect { list }.to_not raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') do
+        expect(results).to have_key(:records)
+      end
+      it('returns no error messages') do
+        expect(error_messages).to be_empty
+      end
+      it 'builds query and sends proper request' do
+        list
+        url = "#{versioned_api_path}/consumers?page=3&requested=19"
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+
+    context 'when including valid params with searchTerm' do
       let(:params) do
         {
           page: 2,

data/spec/rest/documents_orders_notifications_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::DocumentsOrdersNotifications do
+  include SpecHelpers::Client
+
+  describe '#create' do
+    subject(:notifications) { FinApps::REST::DocumentsOrdersNotifications.new(client) }
+
+    context 'when missing id' do
+      let(:create) { subject.create(nil) }
+      it('returns missing argument error') do
+        expect { create }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when invalid id is provided' do
+      let(:create) { subject.create(:invalid_id) }
+      let(:results) { create[RESULTS] }
+      let(:error_messages) { create[ERROR_MESSAGES] }
+
+      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('order id is invalid')
+      end
+    end
+
+    context 'for valid id' do
+      let(:create) { subject.create(:valid_id) }
+      let(:results) { create[RESULTS] }
+      let(:error_messages) { create[ERROR_MESSAGES] }
+
+      it { expect { create }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      it('error_messages array is empty') { expect(error_messages).to eq([]) }
+    end
+  end
+end

data/spec/rest/documents_orders_spec.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+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) { FinApps::REST::DocumentsOrders.new(client).list(params) }
+    let(:results) { list[0] }
+    let(:error_messages) { list[1] }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          page: 2,
+          sort: 'tag',
+          requested: 25,
+          searchTerm: 'term',
+          consumer: 'valid_consumer_id'
+        }
+      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}/documents/orders?page=2"
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+
+      context 'with search term' 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}/documents/orders?filter=%7B%22$or%22:%5B%7B%22applicant.email%22:"\
+            '%22term%22%7D,%7B%22applicant.first_name%22:%22term%22%7D,%7B%22applicant.last_name%22:'\
+            '%22term%22%7D,%7B%22reference_no%22:%7B%22$regex%22:%22%5Eterm%22,%22$options%22:%22i%22%7D%7D%5D,'\
+            '%22consumer_id%22:%22valid_consumer_id%22%7D&page=2&requested=25&sort=tag '
+
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
+    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) { FinApps::REST::DocumentsOrders.new(client).show(id) }
+    let(:results) { show[0] }
+    let(:error_messages) { show[1] }
+
+    context 'with valid id' do
+      let(:id) { :valid_order_id }
+      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 get and returns the response') do
+        expect(results).to have_key(:order_id)
+      end
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_order_id }
+      it { expect(results).to be_nil }
+      it { expect(error_messages).to_not 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) { FinApps::REST::DocumentsOrders.new(client).create(params) }
+    let(:results) { create[0] }
+    let(:error_messages) { create[1] }
+
+    context 'with valid params' do
+      let(:params) do
+        {
+          "applicant": {
+            "email": 'validemail@financialapps.com',
+            "first_name": 'Emily',
+            "last_name": 'Macs',
+            "role": 'patient'
+          },
+          "esign_documents": [
+            'temp-id'
+          ],
+          "reference_no": 'REFNO',
+          "tag": 'new'
+        }
+      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(:order_id)
+      end
+    end
+
+    context 'with invalid params' do
+      let(:params) do
+        {
+          "applicant": {
+            "email": 'validemail@financialapps.com',
+            "first_name": 'Emily',
+            "last_name": 'Macs',
+            "role": 'patient'
+          },
+          "reference_no": 'REFNO'
+        }
+      end
+      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) { FinApps::REST::DocumentsOrders.new(client).update(id, params) }
+    let(:params) { {} }
+    let(:results) { update[0] }
+    let(:error_messages) { update[1] }
+
+    context 'with valid id' do
+      let(:id) { :valid_order_id }
+
+      context 'with valid params' do
+        let(:params) { { "tag": 'pending' } }
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('results is nil') { expect(results).to be_nil }
+      end
+
+      context 'with invalid params' do
+        let(:params) { { "tag": '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('invalid request body')
+        end
+      end
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_order_id }
+      let(:params) { { applicant: { first_name: 'Quasar' } } }
+      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(
+          'order id is invalid'
+        )
+      end
+    end
+
+    context 'with missing id' do
+      let(:id) { nil }
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#destroy' do
+    subject(:destroy) { FinApps::REST::DocumentsOrders.new(client).destroy(id) }
+    let(:results) { destroy[0] }
+    let(:error_messages) { destroy[1] }
+
+    context 'with valid id' do
+      let(:id) { :valid_order_id }
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('results is nil') { expect(results).to be_nil }
+    end
+
+    context 'with invalid id' do
+      let(:id) { :invalid_order_id }
+      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
+
+    context 'with missing id' do
+      let(:id) { nil }
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+
+  describe '#show_signing_url' do
+    subject(:sign_url) { FinApps::REST::DocumentsOrders.new(client).show_signing_url(order_id, signature_id) }
+    let(:results) { sign_url[0] }
+    let(:error_messages) { sign_url[1] }
+    let(:order_id) { :valid_order_id }
+    let(:signature_id) { :valid_signature_id }
+
+    context 'with valid order id' do
+      context 'with valid signature id' 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(:sign_url)
+        end
+      end
+
+      context 'with invalid signature id' do
+        let(:signature_id) { :invalid_signature_id }
+        it { expect(results).to be_nil }
+        it { expect(error_messages).to_not be_empty }
+      end
+    end
+
+    context 'with invalid order id' do
+      let(:order_id) { :invalid_order_id }
+      it { expect(results).to be_nil }
+      it { expect(error_messages).to_not be_empty }
+    end
+
+    context 'with missing order id' do
+      let(:order_id) { nil }
+      it_behaves_like 'a request that raises an error'
+    end
+
+    context 'with missing signature id' do
+      let(:signature_id) { nil }
+      it_behaves_like 'a request that raises an error'
+    end
+  end
+end