finapps 5.0.27 → 5.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8b7de9d5fc2e4ae26d24d98d1a08c6b55bf195814f86b98b9f570fde651053
-  data.tar.gz: 1ae33a3b696c405a8a6f1f1ee03f7cbdd1f96d5b3979ab8d51b01226da722f23
+  metadata.gz: 05c3cbe0d36260925c0a4ca37018f711a959dc0607b4d379b9adb048ef76a0c9
+  data.tar.gz: 1a519b374d9345074573372872fcc731f7b55111adc47be50ce549f7db5b913d
 SHA512:
-  metadata.gz: dcd6e21e5d4341304a6b1ab6482d18dbaf6cd66f2a3d4a642885a0f0aafb0549a59139fcf6bbbaf751b1e74cd19b290bd7c9b63ff0a44f51710c5e2ed731370f
-  data.tar.gz: 8d2f9526699c782b00238335043df2eb599125f1a5858aca887df2ae34980d5150025ec61a574d3b41d88e030ab424cbd883665206c894d88eaa60a799918c5b
+  metadata.gz: 79b1294efebc55a4eb589511df152268a6afbd135b9d06c0d159d8beecdb3d5c968cd5f1978dfac92934d8f1e8464004f21f7327631f236ee53b084ac1ac1858
+  data.tar.gz: b333304eae828c57e73751fa1a09f5d3da6582499eab129ff4421ac8726c204cef74a6a5d90591f41e5c9a82d9dfeb5e4422cbf738b685fcdc83cf70a38a2945

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,52 @@
+## [5.0.32] - 2020-06-11
+
+### Fixed
+* Argument error resulting from space search ([#225][i225])
+
+[i225]: https://github.com/finapps/ruby-client/issues/225
+
+[5.0.32]: https://github.com/finapps/ruby-client/compare/5.0.31...5.0.32
+
+## [5.0.31] - 2020-06-11
+
+### Changed
+* Consumer and Doc-order search to query names on spaces ([#224][i224])
+
+[i224]: https://github.com/finapps/ruby-client/issues/224
+
+[5.0.31]: https://github.com/finapps/ruby-client/compare/5.0.30...5.0.31
+
+## [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

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

@@ -54,14 +54,30 @@ module FinApps
       end
 
       def search_query(term)
+        query = with_space_search(term).concat(name_search(term))
         {
-          "$or": [
-            { "email": term },
-            { "first_name": term },
-            { "last_name": term }
-          ]
+          "$or": query
         }
       end
+
+      def with_space_search(term)
+        [
+          { "email": term },
+          { "first_name": term },
+          { "last_name": term }
+        ]
+      end
+
+      def name_search(term)
+        search_arr = []
+        if term.match(/\s/)
+          term.split.each do |t|
+            search_arr.append("first_name": t)
+            search_arr.append("last_name": t)
+          end
+        end
+        search_arr
+      end
     end
   end
 end

data/lib/finapps/rest/documents_orders.rb

@@ -0,0 +1,104 @@
+# 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
+          query = with_space_search(term).concat(name_search(term))
+          {
+            "$or": query
+          }
+        else
+          {}
+        end
+      end
+
+      def name_search(term)
+        search_arr = []
+        if term.match(/\s/)
+          term.split.each do |t|
+            search_arr.append("applicant.first_name": t)
+            search_arr.append("applicant.last_name": t)
+          end
+        end
+        search_arr
+      end
+
+      def with_space_search(term)
+        [
+          { "applicant.email": term },
+          { "applicant.first_name": term },
+          { "applicant.last_name": term },
+          {
+            "reference_no": {
+              "$regex": "^#{term}", "$options": 'i'
+            }
+          }
+        ]
+      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.27'
+  VERSION = '5.0.32'
 end

data/spec/rest/consumers_spec.rb

@@ -110,6 +110,25 @@ RSpec.describe FinApps::REST::Consumers,
             '&sort=date_created'
         expect(WebMock).to have_requested(:get, url)
       end
+
+      context 'when search term contains a space' do
+        let(:params) do
+          {
+            page: 2,
+            sort: 'date_created',
+            requested: 25,
+            searchTerm: 'Two terms'
+          }
+        end
+        it 'treats space as start of a new query for first and last name' do
+          list
+          url = "#{versioned_api_path}/consumers?filter=%7B%22$or%22:%5B%7B%22email%22:%22Two%20terms%22%7D,"\
+              '%7B%22first_name%22:%22Two%20terms%22%7D,%7B%22last_name%22:%22Two%20terms%22%7D,%7B%22first_name%22:'\
+              '%22Two%22%7D,%7B%22last_name%22:%22Two%22%7D,%7B%22first_name%22:%22terms%22%7D,%7B%22last_name%22:'\
+              '%22terms%22%7D%5D%7D&page=2&requested=25&sort=date_created'
+          expect(WebMock).to have_requested(:get, url)
+        end
+      end
     end
   end
 

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