finapps 5.0.25 → 5.0.30

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

data/spec/support/fake_api.rb

@@ -28,6 +28,19 @@ class FakeApi < Sinatra::Base
     json_response 200, 'verix/record/create.json'
   end
 
+  # verix_pdf_documents
+  get("/#{version}/v/record/:record_id/file/:provider_id") do
+    pdf_response 'verix/document/document.pdf'
+  end
+
+  # verix_documents
+  get("/#{version}/v/record/:record_id/document") do
+    json_response 200, 'verix/document/show.json'
+  end
+  get("/#{version}/v/record/:record_id/document/:document_id") do
+    json_response 200, 'verix/document/list.json'
+  end
+
   # plaid_webhook/metadata
   get("/#{version}/p/metadata") do
     tenant_token = request.env['HTTP_X_TENANT_TOKEN']
@@ -189,6 +202,63 @@ class FakeApi < Sinatra::Base
     end
   end
 
+  # documents_orders
+  get("/#{version}/documents/orders") { json_response 200, 'documents_orders.json' }
+  get("/#{version}/documents/orders/valid_order_id") do
+    json_response 200, 'documents_order.json'
+  end
+  get("/#{version}/documents/orders/invalid_order_id") do
+    json_response 404, 'resource_not_found.json'
+  end
+  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 }
+      json_response 200, 'documents_order.json'
+    else
+      json_response 400, 'invalid_request_body.json'
+    end
+  end
+  put("/#{version}/documents/orders/valid_order_id") do
+    request.body.rewind
+    request_payload = JSON.parse request.body.read
+    if request_payload['tag'] == 'invalid'
+      json_response 400, 'invalid_request_body.json'
+    else
+      status 204
+    end
+  end
+  put("/#{version}/documents/orders/invalid_order_id") do
+    json_response 400, 'invalid_order_id.json'
+  end
+  delete("/#{version}/documents/orders/valid_order_id") { status 204 }
+  delete("/#{version}/documents/orders/invalid_order_id") do
+    json_response 404, 'resource_not_found.json'
+  end
+  get("/#{version}/documents/orders/valid_order_id/sign_url/valid_signature_id") do
+    json_response 200, 'sign_url.json'
+  end
+  get("/#{version}/documents/orders/invalid_order_id/sign_url/valid_signature_id") do
+    json_response 400, 'invalid_order_id.json'
+  end
+  get("/#{version}/documents/orders/valid_order_id/sign_url/invalid_signature_id") do
+    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' }
+
   # consumers
   get("/#{version}/consumers") do
     json_response 200, 'users.json'
@@ -224,14 +294,6 @@ class FakeApi < Sinatra::Base
   end
   post("/#{version}/logout") { status 204 }
 
-  # accounts
-  get("/#{version}/accounts/valid_id/statement/valid_id") do
-    json_response 200, 'fake_pdf_statement.json'
-  end
-  get("/#{version}/accounts/invalid_id/statement/valid_id") do
-    json_response 404, 'resource_not_found.json'
-  end
-
   # operators
   get("/#{version}/operators") { json_response 200, 'operator_list.json' }
   get("/#{version}/operators/invalid_id") do
@@ -427,6 +489,10 @@ class FakeApi < Sinatra::Base
     http_response :png, 200, file_name
   end
 
+  def pdf_response(file_name)
+    http_response 'application/pdf', 200, file_name
+  end
+
   def http_response(content_type, response_code, file_name)
     content_type content_type
     status response_code

data/spec/support/fixtures/documents_order.json

@@ -0,0 +1,75 @@
+{
+  "order_id": "572c0ae0-bdb8-4e68-a5fd-8ac15870f2fe",
+  "consumer_id": "fc136a18-af0c-4d36-4743-1babb89cbbd0",
+  "applicant": {
+    "role": "patient",
+    "email": "validemail@financialapps.com",
+    "first_name": "Documents",
+    "last_name": "Testing"
+  },
+  "reference_no": "REFNO87687687",
+  "esign_documents": [
+    {
+      "document_id": "",
+      "template_id": "f6e9c513486c6a9468209a91ec14c25258eed515",
+      "name": "BH Form"
+    }
+  ],
+  "completed_documents": [],
+  "tag": "denied",
+  "status": 1,
+  "signature_requests": [
+    {
+      "signature_request_id": "b32f0073f7817f353199dcaab683d129a939e7be",
+      "test_mode": true,
+      "title": "Document for review",
+      "subject": "Document for review",
+      "message": "",
+      "created_at": 1588689298,
+      "is_complete": false,
+      "is_declined": false,
+      "has_error": false,
+      "signing_url": null,
+      "signing_redirect_url": null,
+      "details_url": "",
+      "files_url": "",
+      "cc_email_addresses": [],
+      "requester_email_address": "validemail@financialapps.com",
+      "custom_fields": [
+        {
+          "name": "PatientName",
+          "type": "text",
+          "value": "",
+          "required": true,
+          "editor": ""
+        }
+      ],
+      "response_data": [],
+      "signatures": [
+        {
+          "signature_id": "00b2bbdc50d4d6a6486965a921cb81f8",
+          "signer_email_address": "validemail@financialapps.com",
+          "signer_name": "Documents Testing",
+          "signer_role": "patient",
+          "order": null,
+          "status_code": "awaiting_signature",
+          "signed_at": null,
+          "last_viewed_at": null,
+          "last_reminded_at": null,
+          "has_pin": false,
+          "reassigned_by": null,
+          "reassignment_reason": null,
+          "error": null
+        }
+      ],
+      "metadata": {
+        "consumer_id": "fc136a18-af0c-4d36-4743-1babb89cbbd0",
+        "order_id": "572c0ae0-bdb8-4e68-a5fd-8ac15870f2fe",
+        "tenant_id": "4dd607b1-565f-4da4-722c-2e84c5c87f43"
+      }
+    }
+  ],
+  "reset_pwd": true,
+  "date_created": "2020-05-05T14:34:58.435Z",
+  "date_modified": "2020-05-07T14:38:08.271Z"
+}

data/spec/support/fixtures/documents_orders.json

@@ -0,0 +1,32 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "order_id": "2f02be2c-0cbc-4980-bd8f-b2dee986c885",
+      "consumer_id": "6dadcf93-5305-4c4b-4136-465f9cd6d5e6",
+      "applicant": {
+        "role": "patient",
+        "email": "validemail@financialapps.com",
+        "first_name": "Documents",
+        "last_name": "Testing"
+      },
+      "reference_no": "REFNO87687687",
+      "esign_documents": [
+        {
+          "document_id": "",
+          "template_id": "f6e9c513486c6a9468209a91ec14c25258eed515",
+          "name": "BH Form"
+        }
+      ],
+      "completed_documents": [],
+      "tag": "approved",
+      "status": 1,
+      "signature_requests": null,
+      "reset_pwd": false,
+      "date_created": "2020-05-05T14:12:21.428Z",
+      "date_modified": null
+    }
+  ]
+}

data/spec/support/fixtures/esign_templates.json

@@ -0,0 +1,6 @@
+[
+  {
+    "template_id": "f6e9c513486c6a9468209a91ec14c25258eed515",
+    "name": "BH Form"
+  }
+]

data/spec/support/fixtures/invalid_order_id.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "order id is invalid"
+  ]
+}

data/spec/support/fixtures/invalid_signature_id.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "signature id not found"
+  ]
+}

data/spec/support/fixtures/sign_url.json

@@ -0,0 +1,4 @@
+{
+  "sign_url": "https://sign_url.com",
+  "expires_at": 1588953702
+}

data/spec/support/fixtures/verix/document/list.json

@@ -0,0 +1,36 @@
+[
+  {
+    "_id": "5e4c44a5b778c00001a81277",
+    "consumer_id": "1f50bddc-4cbf-4e16-6782-a2295d695d4e",
+    "date_synced": "2020-02-18T20:10:13.469Z",
+    "document": {
+      "form_type": "schedule_d",
+      "id": 34790,
+      "net_long_term_gain_loss": 1275,
+      "net_short_term_gain_loss": 2,
+      "tax_period_ends_at": "2017-12-31"
+    },
+    "document_id": "5e4c44a5b778c00001a81277",
+    "record_id": "5e4c44a46c20ec0001e3a505",
+    "tax_period_ends_at": "2017-12-31",
+    "tenant_id": "4dd607b1-565f-4da4-722c-2e84c5c87f43",
+    "type": "schedule_d"
+  },
+  {
+    "_id": "5e4c44a5b778c00001a81278",
+    "consumer_id": "1f50bddc-4cbf-4e16-6782-a2295d695d4e",
+    "date_synced": "2020-02-18T20:10:13.469Z",
+    "document": {
+      "form_type": "schedule_d",
+      "id": 34793,
+      "net_long_term_gain_loss": 5816,
+      "net_short_term_gain_loss": 0,
+      "tax_period_ends_at": "2018-12-31"
+    },
+    "document_id": "5e4c44a5b778c00001a81278",
+    "record_id": "5e4c44a46c20ec0001e3a505",
+    "tax_period_ends_at": "2018-12-31",
+    "tenant_id": "4dd607b1-565f-4da4-722c-2e84c5c87f43",
+    "type": "schedule_d"
+  }
+]