finapps 5.0.27 → 5.0.32

data/spec/rest/documents_orders_spec.rb

@@ -0,0 +1,287 @@
+# 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
+
+        context 'with search term containing spaces' do
+          let(:params) { { "searchTerm": 'Blue Jay', "page": 2 } }
+          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:"\
+              '%22Blue%20Jay%22%7D,%7B%22applicant.first_name%22:%22Blue%20Jay%22%7D,%7B%22applicant.last_name%22:'\
+              '%22Blue%20Jay%22%7D,%7B%22reference_no%22:%7B%22$regex%22:%22%5EBlue%20Jay%22,%22$options%22:'\
+              '%22i%22%7D%7D,%7B%22applicant.first_name%22:%22Blue%22%7D,%7B%22applicant.last_name%22:%22Blue%22%7D,'\
+              '%7B%22applicant.first_name%22:%22Jay%22%7D,%7B%22applicant.last_name%22:%22Jay%22%7D%5D%7D&page=2'
+
+            expect(WebMock).to have_requested(:get, url)
+          end
+        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

data/spec/rest/esign_templates_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::EsignTemplates do
+  include SpecHelpers::Client
+  subject(:templates) { FinApps::REST::EsignTemplates.new(client).list }
+  let(:results) { templates[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(:template_id)
+      end
+    end
+  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/rest/verix/verix_documents_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::VerixDocuments do
+  include SpecHelpers::Client
+
+  let(:api_client) { client }
+  let(:document) { FinApps::REST::VerixDocuments.new(api_client) }
+
+  describe '#list' do
+    context 'when missing parameters' do
+      subject { document.list(nil) }
+      it 'raises an error when missing record id' do
+        expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    subject(:list) do
+      document.list(
+        :record_id
+      )
+    end
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+  end
+
+  describe '#show' do
+    context 'when missing parameters' do
+      subject { document.show(nil, :document_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 document id' do
+        expect { subject }.to raise_error(FinAppsCore::MissingArgumentsError)
+      end
+    end
+
+    subject(:show) do
+      document.show(
+        :record_id,
+        :document_id
+      )
+    end
+
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+  end
+end

data/spec/rest/verix/verix_pdf_documents_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+require 'rest/api_request'
+
+RSpec.describe FinApps::REST::VerixPdfDocuments do
+  include SpecHelpers::Client
+
+  let(:api_client) { client }
+  let(:document) { FinApps::REST::VerixPdfDocuments.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
+
+    it_behaves_like 'an API request'
+    it_behaves_like 'a successful request'
+  end
+end

data/spec/rest/verix/verix_records_spec.rb

@@ -12,10 +12,7 @@ RSpec.describe FinApps::REST::VerixRecords do
   describe '#create' do
     subject(:create) do
       FinApps::REST::VerixRecords.new(api_client).create(
-        code: 'authcode',
-        download: [
-          'form_1040'
-        ]
+        code: 'authcode'
       )
     end
 
@@ -26,11 +23,7 @@ RSpec.describe FinApps::REST::VerixRecords do
     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 document count') { expect(create[RESULTS][:documents].first).to have_key(:count) }
-    it('returns a document date sycned node') { expect(create[RESULTS][:documents].first).to have_key(:date_synced) }
-    it('returns a document id') { expect(create[RESULTS][:documents].first).to have_key(:document_id) }
-    it('returns a document downloaded bool') { expect(create[RESULTS][:documents].first).to have_key(:downloaded) }
-    it('returns a document type') { expect(create[RESULTS][:documents].first).to have_key(:type) }
+    it('returns a list of downloaded documents') { expect(create[RESULTS]).to have_key(:downloaded_documents) }
   end
 
   describe '#list' do
@@ -44,10 +37,6 @@ RSpec.describe FinApps::REST::VerixRecords do
     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 document type') { expect(list[RESULTS].first[:documents].first).to have_key(:type) }
-    it('returns a document id') { expect(list[RESULTS].first[:documents].first).to have_key(:document_id) }
-    it('returns a document count') { expect(list[RESULTS].first[:documents].first).to have_key(:count) }
-    it('returns a document downloaded bool') { expect(list[RESULTS].first[:documents].first).to have_key(:downloaded) }
-    it('returns a document date_synced') { expect(list[RESULTS].first[:documents].first).to have_key(:date_synced) }
+    it('returns a list of downloaded documents') { expect(list[RESULTS].first).to have_key(:downloaded_documents) }
   end
 end