finapps 5.0.29 → 5.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f24fb86c099693e3d0f4ffb075bbaadd4886e9c165680b192a86bc79b6e6b82
-  data.tar.gz: 65255650d2ac2cf388f83b9be35b9b9d838ae4c2d85d850e2b25352c73e95227
+  metadata.gz: 1c74f2340d52ad3cd13dc2bdf8415e7cf89e48f0993dbb346456546910a69ba9
+  data.tar.gz: 3bdefc2032a2efa241d5cc72ab5d6b74fc44b568599f0054bf5477e473fab81f
 SHA512:
-  metadata.gz: 254d4ceb173bb18759b6aed0c6b1fd3144656e516376b7c559bdc1e9836d0782d227e35508ac032b8fb3d03d268b171e8f357ceb6c191fc1d57a9e68bca9829d
-  data.tar.gz: 15a9340a7550212b940e16fb22890cd8ff22a99b1bc05bac3cd46435acd1f2aefa93d4118418c47c3abd2e720a27091c39b3f6b9b1376e002f49ade74f546df9
+  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,16 @@
+## [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

data/lib/finapps.rb

@@ -31,6 +31,8 @@ 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'

data/lib/finapps/rest/client.rb

@@ -12,6 +12,7 @@ module FinApps
         consumers
         consumers_portfolios
         documents_orders
+        documents_orders_notifications
         esign_templates
         orders
         order_assignments
@@ -35,6 +36,7 @@ module FinApps
         portfolio_reports
         products
         sessions
+        signed_documents_downloads
         tenant_settings
         tenant_app_settings
         verix_metadata

data/lib/finapps/rest/documents_orders.rb

@@ -53,7 +53,8 @@ module FinApps
         if term
           {
             "$or": [
-              { "order_id": { "$regex": "^#{term}", "$options": 'i' } },
+              { "applicant.email": term },
+              { "applicant.first_name": term },
               { "applicant.last_name": term },
               {
                 "reference_no": {

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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinApps
-  VERSION = '5.0.29'
+  VERSION = '5.0.30'
 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

data/spec/rest/documents_orders_spec.rb

@@ -53,10 +53,11 @@ RSpec.describe FinApps::REST::DocumentsOrders do
         it 'builds query and sends proper request' do
           list
           url =
-            "#{versioned_api_path}/documents/orders?filter=%7B%22$or%22:%5B%7B%22order_id%22:%7B%22$regex%22:"\
-            '%22%5Eterm%22,%22$options%22:%22i%22%7D%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'
+            "#{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

data/spec/rest/signed_documents_downloads_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::SignedDocumentsDownloads do
+  include SpecHelpers::Client
+
+  let(:api_client) { client }
+  let(:document) { FinApps::REST::SignedDocumentsDownloads.new(api_client) }
+
+  describe '#show' do
+    context 'when missing parameters' do
+      subject { document.show(nil, :signature_request_id) }
+      it 'raises an error when missing consumer id' do
+        expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+
+      subject { document.show(:consumer_id, nil) }
+      it 'raises an error when missing signature request id' do
+        expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    subject(:show) do
+      document.show(
+        :consumer_id,
+        :signature_request_id
+      )
+    end
+
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+  end
+end

data/spec/support/fake_api.rb

@@ -245,6 +245,17 @@ class FakeApi < Sinatra::Base
     json_response 404, 'invalid_signature_id.json'
   end
 
+  # documents orders notifications
+  post("/#{version}/documents/orders/valid_id/notify") { status 204 }
+  post("/#{version}/documents/orders/invalid_id/notify") do
+    json_response 400, 'invalid_order_id.json'
+  end
+
+  # signed documents downloads
+  get("/#{version}/consumers/:consumer_id/documents/:signature_request_id") do
+    pdf_response 'signed_document.pdf'
+  end
+
   # esign_templates
   get("/#{version}/esign_templates") { json_response 200, 'esign_templates.json' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 5.0.29
+  version: 5.0.30
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -303,6 +303,7 @@ files:
 - lib/finapps/rest/consumers.rb
 - lib/finapps/rest/consumers_portfolios.rb
 - lib/finapps/rest/documents_orders.rb
+- lib/finapps/rest/documents_orders_notifications.rb
 - lib/finapps/rest/esign_templates.rb
 - lib/finapps/rest/operators.rb
 - lib/finapps/rest/operators_password_resets.rb
@@ -327,6 +328,7 @@ files:
 - lib/finapps/rest/portfolios_consumers.rb
 - lib/finapps/rest/products.rb
 - lib/finapps/rest/sessions.rb
+- lib/finapps/rest/signed_documents_downloads.rb
 - lib/finapps/rest/tenant_app_settings.rb
 - lib/finapps/rest/tenant_settings.rb
 - lib/finapps/rest/verix/verix_documents.rb
@@ -343,6 +345,7 @@ files:
 - spec/rest/client_spec.rb
 - spec/rest/consumers_portfolios_spec.rb
 - spec/rest/consumers_spec.rb
+- spec/rest/documents_orders_notifications_spec.rb
 - spec/rest/documents_orders_spec.rb
 - spec/rest/esign_templates_spec.rb
 - spec/rest/operators_password_resets_spec.rb
@@ -367,6 +370,7 @@ files:
 - spec/rest/portfolios_spec.rb
 - spec/rest/products_spec.rb
 - spec/rest/sessions_spec.rb
+- spec/rest/signed_documents_downloads_spec.rb
 - spec/rest/tenant_app_settings_spec.rb
 - spec/rest/tenant_settings_spec.rb
 - spec/rest/verix/verix_documents_spec.rb
@@ -424,6 +428,7 @@ files:
 - spec/support/fixtures/resource_not_found.json
 - spec/support/fixtures/resources.json
 - spec/support/fixtures/sign_url.json
+- spec/support/fixtures/signed_document.pdf
 - spec/support/fixtures/single_consumer_subscribe_error.json
 - spec/support/fixtures/tenant_app_settings.json
 - spec/support/fixtures/tenant_settings.json
@@ -479,6 +484,7 @@ test_files:
 - spec/rest/portfolios_spec.rb
 - spec/rest/order_statuses_spec.rb
 - spec/rest/order_notifications_spec.rb
+- spec/rest/documents_orders_notifications_spec.rb
 - spec/rest/operators_password_resets_spec.rb
 - spec/rest/esign_templates_spec.rb
 - spec/rest/portfolios_consumers_spec.rb
@@ -497,6 +503,7 @@ test_files:
 - spec/rest/verix/verix_records_spec.rb
 - spec/rest/verix/verix_documents_spec.rb
 - spec/rest/verix/verix_pdf_documents_spec.rb
+- spec/rest/signed_documents_downloads_spec.rb
 - spec/rest/password_resets_spec.rb
 - spec/rest/portfolio_reports_spec.rb
 - spec/rest/plaid/plaid_webhooks_spec.rb