finapps 5.0.35 → 5.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4756aafb56941b9eaf0609a1aa07d9eae9b3485e70a10bf1ab7590cc973654d1
-  data.tar.gz: 0e55b4ed791fc263027a21b6193ca025778e983fb0742006111b9fc1c5d88e4d
+  metadata.gz: d502756b01180a324db1ab9e232bd71810d1e9f950bcaf9f47df667c3bd2d7ed
+  data.tar.gz: b1a9723d9944b250ff1d57917e66c903647929b3161ecb718dde62b9804f7d36
 SHA512:
-  metadata.gz: 90031e4f43d5a3fda8f4f3f2df53e7ecb8a5e27ab53830f79aaf80ab981b293b8890ad3e2bf8a31ebc210dcaf37f29fbcc1442fb139ee463b465243223381393
-  data.tar.gz: 56d79d89f1a40e4ee1fff5b58ad8e49f762375c7ea6a4911a3e149004272eba89fe3e6348653a49f75a2bf1cd6a1f41ef4e8c20af6857c0e75af76c818b88467
+  metadata.gz: 643b7f796405c8d6d06f2f414098b23f4295627702c03d119599827f8977866c8ffc8f62ab7b60330ae679ef35be0247440d16f938686c75f1426be3fec3a068
+  data.tar.gz: cb58c991c8b188221f9900d057e03d2394eaa7baaf712edf4f1f029a722436afe2e424e4562176778e00d294d9ebaac609ab7d578d57110162889e5b56a9ed2a

data/.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
     - "vendor/**/*"
     - "bin/**/*"
   CacheRootDirectory: tmp
+  NewCops: enable
 
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
@@ -69,6 +70,8 @@ Naming/PredicateName:
 
 RSpec/FilePath:
   Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
     
 Style/RedundantRegexpCharacterClass:
   Enabled: true
@@ -150,6 +153,10 @@ Style/RedundantFetchBlock:
   Enabled: true
 Style/SlicingWithRange:
   Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/StringConcatenation:
+  Enabled: false
 
 RSpec/NestedGroups:
   Max: 5

data/.rubocop_todo.yml

@@ -17,7 +17,7 @@ Metrics/BlockLength:
 # Configuration parameters: CountComments.
 # fake_api.rb - leaving as is intentionally
 Metrics/ClassLength:
-  Max: 431
+  Max: 442
 
 # Offense count: 5
 # Configuration parameters: Max.

data/RELEASES.md

@@ -1,3 +1,12 @@
+## [5.0.36] - 2020-08-05
+
+### Changed
+* Add upload endpoints to support dashboard ([#309][i309])
+
+[i309]: https://github.com/finapps/tenant-dashboard-react/issues/309
+
+[5.0.36]: https://github.com/finapps/ruby-client/compare/5.0.35...5.0.36
+
 ## [5.0.35] - 2020-07-09
 
 ### Changed

data/lib/finapps.rb

@@ -30,7 +30,9 @@ require 'finapps/rest/portfolios_consumers'
 require 'finapps/rest/consumers_portfolios'
 require 'finapps/rest/portfolio_reports'
 require 'finapps/rest/documents_orders'
+require 'finapps/rest/documents_uploads'
 require 'finapps/rest/esign_templates'
+require 'finapps/rest/documents_upload_types'
 require 'finapps/rest/signed_documents_downloads'
 require 'finapps/rest/documents_orders_notifications'
 

data/lib/finapps/rest/client.rb

@@ -13,6 +13,8 @@ module FinApps
         consumers_portfolios
         documents_orders
         documents_orders_notifications
+        documents_upload_types
+        documents_uploads
         esign_templates
         orders
         order_assignments

data/lib/finapps/rest/documents_orders.rb

@@ -33,7 +33,7 @@ module FinApps
 
       def destroy(id)
         not_blank(id, :order_id)
-        super(id, "documents/orders/#{id}")
+        super(nil, "documents/orders/#{id}")
       end
 
       def show_signing_url(order_id, signature_id)

data/lib/finapps/rest/documents_upload_types.rb

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

data/lib/finapps/rest/documents_uploads.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class DocumentsUploads < FinAppsCore::REST::Resources
+      def show(consumer_id, doc_id, thumbnail = false)
+        not_blank(consumer_id, :consumer_id)
+        not_blank(doc_id, :doc_id)
+
+        path =
+          "consumers/#{ERB::Util.url_encode(consumer_id)}/"\
+        "documents/#{ERB::Util.url_encode(doc_id)}?thumbnail=#{thumbnail}"
+        super(nil, path)
+      end
+
+      def destroy(order_id, doc_id)
+        not_blank(order_id, :order_id)
+        not_blank(doc_id, :doc_id)
+        super(nil, "documents/orders/#{order_id}/#{doc_id}")
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

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

data/spec/rest/documents_upload_types_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsUploadTypes do
+  include SpecHelpers::Client
+  subject(:upload_types) { described_class.new(client).list }
+
+  let(:results) { upload_types[0] }
+
+  describe '#list' do
+    context 'when called' do
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+      it('performs a get and returns the response') do
+        expect(results[0]).to have_key(:type)
+      end
+    end
+  end
+end

data/spec/rest/documents_uploads_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::DocumentsUploads do
+  include SpecHelpers::Client
+
+  describe '#show' do
+    let(:upload) { described_class.new(client) }
+
+    context 'when missing doc id' do
+      subject(:show) { upload.show(:consumer_id, nil) }
+
+      it 'raises an error' do
+        expect { show }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when missing consumer id' do
+      subject(:show) { upload.show(nil, :doc_id) }
+
+      it 'raises an error' do
+        expect { show }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    context 'when thumbnail is not included' do
+      subject(:show) do
+        upload.show(
+          :consumer_id,
+          :doc_id
+        )
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+
+    context 'when thumbnail is included' do
+      subject(:show) do
+        upload.show(
+          :consumer_id,
+          :doc_id,
+          true
+        )
+      end
+
+      it_behaves_like 'an API request'
+      it_behaves_like 'a successful request'
+    end
+  end
+
+  describe '#destroy' do
+    subject(:destroy) { described_class.new(client).destroy(order_id, doc_id) }
+
+    let(:results) { destroy[0] }
+    let(:error_messages) { destroy[1] }
+
+    context 'with valid id' do
+      let(:order_id) { :valid_order_id }
+      let(:doc_id) { :valid_doc_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 order id' do
+      let(:order_id) { :invalid_order_id }
+      let(:doc_id) { :valid_doc_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 invalid doc id' do
+      let(:order_id) { :valid_order_id }
+      let(:doc_id) { :invalid_doc_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(:order_id) { nil }
+      let(:doc_id) { nil }
+
+      it do
+        expect { destroy }.to raise_error(
+          FinAppsCore::MissingArgumentsError
+        )
+      end
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -251,6 +251,18 @@ class FakeApi < Sinatra::Base
     json_response 404, 'invalid_signature_id.json'
   end
 
+  # documents_uploads
+  get("/#{version}/consumers/:consumer_id/documents/:doc_id?thumbnail=false") do
+    pdf_response 'signed_document.pdf'
+  end
+  delete("/#{version}/documents/orders/valid_order_id/valid_doc_id") { status 204 }
+  delete("/#{version}/documents/orders/valid_order_id/invalid_doc_id") do
+    json_response 404, 'resource_not_found.json'
+  end
+  delete("/#{version}/documents/orders/invalid_order_id/valid_doc_id") do
+    json_response 404, 'resource_not_found.json'
+  end
+
   # documents orders notifications
   post("/#{version}/documents/orders/valid_id/notify") { status 204 }
   post("/#{version}/documents/orders/invalid_id/notify") do
@@ -265,6 +277,9 @@ class FakeApi < Sinatra::Base
   # esign_templates
   get("/#{version}/esign_templates") { json_response 200, 'esign_templates.json' }
 
+  # document_upload_types
+  get("/#{version}/documents/upload_types") { json_response 200, 'upload_types.json' }
+
   # consumers
   get("/#{version}/consumers") do
     json_response 200, 'users.json'

data/spec/support/fixtures/upload_types.json

@@ -0,0 +1,9 @@
+[
+  {
+    "acceptable_forms": "string",
+    "id": "string",
+    "name": "string",
+    "special_instructions": "string",
+    "type": 1
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 5.0.35
+  version: 5.0.36
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -306,6 +306,8 @@ files:
 - lib/finapps/rest/consumers_portfolios.rb
 - lib/finapps/rest/documents_orders.rb
 - lib/finapps/rest/documents_orders_notifications.rb
+- lib/finapps/rest/documents_upload_types.rb
+- lib/finapps/rest/documents_uploads.rb
 - lib/finapps/rest/esign_templates.rb
 - lib/finapps/rest/operators.rb
 - lib/finapps/rest/operators_password_resets.rb
@@ -349,6 +351,8 @@ files:
 - spec/rest/consumers_spec.rb
 - spec/rest/documents_orders_notifications_spec.rb
 - spec/rest/documents_orders_spec.rb
+- spec/rest/documents_upload_types_spec.rb
+- spec/rest/documents_uploads_spec.rb
 - spec/rest/esign_templates_spec.rb
 - spec/rest/operators_password_resets_spec.rb
 - spec/rest/operators_spec.rb
@@ -436,6 +440,7 @@ files:
 - spec/support/fixtures/tenant_app_settings.json
 - spec/support/fixtures/tenant_settings.json
 - spec/support/fixtures/unauthorized.json
+- spec/support/fixtures/upload_types.json
 - spec/support/fixtures/user.json
 - spec/support/fixtures/users.json
 - spec/support/fixtures/verix/document/document.pdf
@@ -506,6 +511,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/documents_uploads_spec.rb
 - spec/rest/signed_documents_downloads_spec.rb
 - spec/rest/password_resets_spec.rb
 - spec/rest/portfolio_reports_spec.rb
@@ -516,6 +522,7 @@ test_files:
 - spec/rest/plaid/plaid_account_permissions_spec.rb
 - spec/rest/consumers_portfolios_spec.rb
 - spec/rest/documents_orders_spec.rb
+- spec/rest/documents_upload_types_spec.rb
 - spec/rest/alert_occurrences_spec.rb
 - spec/rest/tenant_settings_spec.rb
 - spec/rest/orders_spec.rb