finapps 5.0.32 → 5.0.38

data/spec/rest/verix/verix_metadata_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe FinApps::REST::VerixMetadata do
   let(:api_client) { client }
 
   describe '#show' do
-    subject(:show) { FinApps::REST::VerixMetadata.new(api_client).show }
+    subject(:show) { described_class.new(api_client).show }
 
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'

data/spec/rest/verix/verix_pdf_documents_spec.rb

@@ -7,29 +7,24 @@ RSpec.describe FinApps::REST::VerixPdfDocuments do
   include SpecHelpers::Client
 
   let(:api_client) { client }
-  let(:document) { FinApps::REST::VerixPdfDocuments.new(api_client) }
+  let(:document) { described_class.new(api_client) }
 
   describe '#show' do
-    context 'when missing parameters' do
-      subject { document.show(nil, :provider_id) }
-      it 'raises an error when missing record id' do
-        expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError)
-      end
-
-      subject { document.show(:record_id, nil) }
-      it 'raises an error when missing provider id' do
-        expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError)
-      end
-    end
-
-    subject(:show) do
-      document.show(
-        :record_id,
-        :provider_id
-      )
-    end
+    subject { document.show(:record_id, :provider_id) }
 
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'
+
+    context 'when missing record_id' do
+      subject(:show) { document.show(nil, :provider_id) }
+
+      it { expect { show }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing provider_id' do
+      subject(:show) { document.show(:record_id, nil) }
+
+      it { expect { show }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
   end
 end

data/spec/rest/verix/verix_records_spec.rb

@@ -6,12 +6,11 @@ require 'rest/api_request'
 RSpec.describe FinApps::REST::VerixRecords do
   include SpecHelpers::Client
 
-  # noinspection RubyBlockToMethodReference
   let(:api_client) { client }
 
   describe '#create' do
     subject(:create) do
-      FinApps::REST::VerixRecords.new(api_client).create(
+      described_class.new(api_client).create(
         code: 'authcode'
       )
     end
@@ -19,24 +18,46 @@ RSpec.describe FinApps::REST::VerixRecords do
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'
     it('returns an id') { expect(create[RESULTS]).to have_key(:_id) }
-    it('returns a consumer id') { expect(create[RESULTS]).to have_key(:consumer_id) }
+
+    it('returns a consumer id') {
+      expect(create[RESULTS]).to have_key(:consumer_id)
+    }
+
     it('returns a status') { expect(create[RESULTS]).to have_key(:status) }
     it('returns an error node') { expect(create[RESULTS]).to have_key(:error) }
-    it('returns a list of documents') { expect(create[RESULTS]).to have_key(:documents) }
-    it('returns a list of downloaded documents') { expect(create[RESULTS]).to have_key(:downloaded_documents) }
+
+    it('returns a list of documents') {
+      expect(create[RESULTS]).to have_key(:documents)
+    }
+
+    it('returns a list of downloaded documents') {
+      expect(create[RESULTS]).to have_key(:downloaded_documents)
+    }
   end
 
   describe '#list' do
-    subject(:list) { FinApps::REST::VerixRecords.new(api_client).list }
+    subject(:list) { described_class.new(api_client).list }
 
     it_behaves_like 'an API request'
     it_behaves_like 'a successful request'
     it('returns an array') { expect(list[RESULTS]).to be_an_instance_of(Array) }
     it('returns an id') { expect(list[RESULTS].first).to have_key(:_id) }
     it('returns a status') { expect(list[RESULTS].first).to have_key(:status) }
-    it('returns a consumer id') { expect(list[RESULTS].first).to have_key(:consumer_id) }
-    it('returns an error node') { expect(list[RESULTS].first).to have_key(:error) }
-    it('returns a list of documents') { expect(list[RESULTS].first).to have_key(:documents) }
-    it('returns a list of downloaded documents') { expect(list[RESULTS].first).to have_key(:downloaded_documents) }
+
+    it('returns a consumer id') {
+      expect(list[RESULTS].first).to have_key(:consumer_id)
+    }
+
+    it('returns an error node') {
+      expect(list[RESULTS].first).to have_key(:error)
+    }
+
+    it('returns a list of documents') {
+      expect(list[RESULTS].first).to have_key(:documents)
+    }
+
+    it('returns a list of downloaded documents') {
+      expect(list[RESULTS].first).to have_key(:downloaded_documents)
+    }
   end
 end

data/spec/rest/version_spec.rb

@@ -3,12 +3,14 @@
 RSpec.describe FinApps::REST::Version do
   include SpecHelpers::Client
 
-  subject { FinApps::REST::Version.new(client) }
+  subject(:version) { described_class.new(client) }
+
   describe '#show' do
-    it { expect { subject.show }.not_to raise_error }
-    it('returns a string') { expect(subject.show[0]).to be_a(String) }
+    it { expect { version.show }.not_to raise_error }
+    it('returns a string') { expect(version.show[0]).to be_a(String) }
+
     it('starts with the words "Version =>"') do
-      expect(subject.show[0]).to start_with('Version =>')
+      expect(version.show[0]).to start_with('Version =>')
     end
   end
 end

data/spec/spec_helper.rb

@@ -21,7 +21,7 @@ RSpec.configure do |config|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
     expectations.syntax = :expect
   end
-  config.mock_with(:rspec) { |mocks| mocks.verify_partial_doubles = true }
+  config.mock_with(:rspec) {|mocks| mocks.verify_partial_doubles = true }
   # config.filter_run_including :focus => true
   config.default_formatter = 'doc' if config.files_to_run.one?
   config.order = :random
@@ -29,7 +29,7 @@ RSpec.configure do |config|
   config.warnings = true
   Kernel.srand config.seed
 
-  config.before(:each) do
+  config.before do
     base_url =
       "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v#{FinAppsCore::REST::Defaults::API_VERSION}/"
     stub_request(:any, /#{base_url}/).to_rack(::FakeApi)

data/spec/support/fake_api.rb

@@ -195,7 +195,7 @@ class FakeApi < Sinatra::Base
   post("/#{version}/orders") do
     request.body.rewind
     request_payload = JSON.parse request.body.read
-    if %w[applicant institutions product].all? { |s| request_payload.key? s }
+    if %w[applicant institutions product].all? {|s| request_payload.key? s }
       json_response 200, 'order_token.json'
     else
       json_response 400, 'invalid_request_body.json'
@@ -203,7 +203,13 @@ class FakeApi < Sinatra::Base
   end
 
   # documents_orders
-  get("/#{version}/documents/orders") { json_response 200, 'documents_orders.json' }
+  get("/#{version}/documents/orders") do
+    if params[:filter]&.include?('"status":2')
+      json_response 200, 'documents_orders_none.json'
+    else
+      json_response 200, 'documents_orders.json'
+    end
+  end
   get("/#{version}/documents/orders/valid_order_id") do
     json_response 200, 'documents_order.json'
   end
@@ -213,7 +219,7 @@ class FakeApi < Sinatra::Base
   post("/#{version}/documents/orders") do
     request.body.rewind
     request_payload = JSON.parse request.body.read
-    if %w[applicant esign_documents tag].all? { |s| request_payload.key? s }
+    if %w[applicant esign_documents tag].all? {|s| request_payload.key? s }
       json_response 200, 'documents_order.json'
     else
       json_response 400, 'invalid_request_body.json'
@@ -245,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
@@ -259,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'
@@ -496,6 +517,6 @@ class FakeApi < Sinatra::Base
   def http_response(content_type, response_code, file_name)
     content_type content_type
     status response_code
-    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+    File.open("#{File.dirname(__FILE__)}/fixtures/#{file_name}").read
   end
 end

data/spec/support/fixtures/documents_orders_none.json

@@ -0,0 +1,6 @@
+{
+  "total_records": 0,
+  "page": 0,
+  "total_pages": 0,
+  "records": []
+}

data/spec/support/fixtures/upload_types.json

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

data/spec/utils/query_builder_spec.rb

@@ -1,38 +1,64 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 class FakeClass
   include FinApps::Utils::QueryBuilder
 
-  def build_filter(param); end
+  def build_filter(params)
+    params&.key?(:role) ? {role: params[:role]} : {}
+  end
 end
 
 RSpec.describe FinApps::Utils::QueryBuilder do
-  subject { FakeClass.new }
+  subject(:fake_class) { FakeClass.new }
 
   describe '#build_query_path' do
     let(:end_point) { 'orders' }
 
     context 'with full params' do
       let(:params) do
-        { page: '1', requested: '20', sort: '-date', random: 'random' }
+        {
+          page: '1',
+          requested: '20',
+          sort: '-date',
+          random: 'random',
+          role: 2
+        }
+      end
+      let(:escaped_filter) { "filter=#{CGI.escape({role: 2}.to_json)}" }
+
+      it 'includes a page value in the query string' do
+        value = 'page=1'
+        expect(fake_class.build_query_path(end_point, params)).to include(value)
+      end
+
+      it 'includes a requested value in the query string' do
+        value = 'requested=20'
+        expect(fake_class.build_query_path(end_point, params)).to include(value)
       end
-      it 'calls #build_filter and returns correct string' do
-        allow(subject).to receive(:build_filter) { { role: 2 } }
-        expect(subject).to receive(:build_filter).with(params)
-        correct_string =
-          'orders?page=1&requested=20&sort=-date&filter=%7B%22role%22%3A2%7D'
-        expect(subject.build_query_path(end_point, params)).to eq(
-          correct_string
-        )
+
+      it 'includes a sort value in the query string' do
+        value = 'sort=-date'
+        expect(fake_class.build_query_path(end_point, params)).to include(value)
+      end
+
+      it 'includes a filter value in the query string' do
+        value = escaped_filter
+        expect(fake_class.build_query_path(end_point, params)).to include(value)
+      end
+
+      it 'builds a properly formatted query string' do
+        expected = "orders?page=1&requested=20&sort=-date&#{escaped_filter}"
+        expect(fake_class.build_query_path(end_point, params)).to eq(expected)
       end
     end
 
     context 'with no params' do
       let(:params) { {} }
+
       it 'returns root' do
-        allow(subject).to receive(:build_filter) { {} }
-        expect(subject).to receive(:build_filter).with(params)
-        expect(subject.build_query_path(end_point, params)).to eq(end_point)
+        expect(fake_class.build_query_path(end_point, params)).to eq(end_point)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 5.0.32
+  version: 5.0.38
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.7
+        version: 5.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.7
+        version: 5.0.10
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -154,82 +154,82 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.86.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.86.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.37.1
+        version: 1.40.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.37.1
+        version: 1.40.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -254,22 +254,22 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: A simple library for communicating with the FinApps REST API.
 email:
 - erich@financialapps.com
@@ -280,11 +280,16 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".codeclimate.yml"
+- ".github/release-drafter.yml"
+- ".github/workflows/main.yaml"
+- ".github/workflows/release-drafter.yml"
+- ".github/workflows/verify-pr-labeled.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".tmuxinator.yml"
@@ -304,6 +309,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
@@ -347,6 +354,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
@@ -386,6 +395,7 @@ files:
 - spec/support/fixtures/alert_occurrences.json
 - spec/support/fixtures/documents_order.json
 - spec/support/fixtures/documents_orders.json
+- spec/support/fixtures/documents_orders_none.json
 - spec/support/fixtures/error.json
 - spec/support/fixtures/esign_templates.json
 - spec/support/fixtures/invalid_order_id.json
@@ -433,6 +443,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
@@ -468,51 +479,53 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/spec_helper.rb
-- spec/spec_helpers/client.rb
-- spec/utils/query_builder_spec.rb
-- spec/support/fake_api.rb
-- spec/rest/tenant_app_settings_spec.rb
-- spec/rest/order_reports_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/consumers_spec.rb
-- 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
-- spec/rest/operators_spec.rb
-- spec/rest/version_spec.rb
-- spec/rest/order_assignments_spec.rb
-- spec/rest/api_request.rb
-- spec/rest/order_refreshes_spec.rb
+- spec/rest/products_spec.rb
+- spec/rest/tenant_settings_spec.rb
+- spec/rest/alert_occurrences_spec.rb
 - spec/rest/alert_definitions_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/rest/tenant_app_settings_spec.rb
+- spec/rest/password_resets_spec.rb
+- spec/rest/documents_orders_spec.rb
+- spec/rest/orders_spec.rb
 - spec/rest/order_tokens_spec.rb
-- spec/rest/products_spec.rb
-- spec/rest/sessions_spec.rb
 - spec/rest/portfolios_available_consumers_spec.rb
+- spec/rest/sessions_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/consumers_portfolios_spec.rb
+- spec/rest/esign_templates_spec.rb
+- spec/rest/portfolios_spec.rb
+- spec/rest/documents_upload_types_spec.rb
 - spec/rest/portfolios_alerts_spec.rb
-- spec/rest/verix/verix_metadata_spec.rb
+- spec/rest/portfolios_consumers_spec.rb
 - 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/verix/verix_documents_spec.rb
+- spec/rest/verix/verix_metadata_spec.rb
 - spec/rest/portfolio_reports_spec.rb
-- spec/rest/plaid/plaid_webhooks_spec.rb
+- spec/rest/order_notifications_spec.rb
+- spec/rest/order_refreshes_spec.rb
+- spec/rest/order_assignments_spec.rb
 - spec/rest/plaid/plaid_institution_logos_spec.rb
-- spec/rest/plaid/plaid_consumer_institutions_spec.rb
 - spec/rest/plaid/plaid_accounts_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/consumers_portfolios_spec.rb
-- spec/rest/documents_orders_spec.rb
-- spec/rest/alert_occurrences_spec.rb
-- spec/rest/tenant_settings_spec.rb
-- spec/rest/orders_spec.rb
+- spec/rest/documents_uploads_spec.rb
+- spec/rest/consumers_spec.rb
+- spec/rest/order_statuses_spec.rb
+- spec/rest/api_request.rb
+- spec/rest/documents_orders_notifications_spec.rb
+- spec/rest/operators_spec.rb
+- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/version_spec.rb
+- spec/rest/order_reports_spec.rb
+- spec/support/fake_api.rb
+- spec/utils/query_builder_spec.rb
+- spec/spec_helpers/client.rb
+- spec/spec_helper.rb