finapps 5.0.45 → 5.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c79a7e77e6c6496121b61c0b2d37324ec7ca7aa9ff7f8c4153ebf4cb5a4d764b
-  data.tar.gz: 2016bac07309e1817c0236ddb5b69f5cfb0577ff6c3af27d28ea195b9a56356e
+  metadata.gz: 4501dd349460d436671d161a817432d9336cdb1722d2465baef3d65a7bb4d10f
+  data.tar.gz: cea911d0e0449e505aa4fd6229f0ca446fc45519a69b8955f22e8789a5b94132
 SHA512:
-  metadata.gz: ce58b007e2b3122c2bb4b6ac8e1fd435da08c69e81de23e566488ca52ac4d626d57a814c14dcec667a92d413f93cf746380aeb487ea3b31b7c9fcea048adaa33
-  data.tar.gz: 8642f81a12d89676bb95458a20d0eaa4ac1cc1be30d6384e2ba7a4a3960472f849aca73927bf11ac45045617904ec3a2cfafec48a7c3f34316e2df603b8447e1
+  metadata.gz: e4e89f43a67412901a05f0cd420973e7c87d2e14fb86191b966ca2381d2af0ee8de1df43a3db2b1a3b2b22df616eab186c49fde9f2373f156e9f8e5f3cbdfad7
+  data.tar.gz: bac2c749e5c60e123dfb02d5d767b1e8930ae9ef2178a3c9e1be6aff2fa55c596b12d9e64817c228839eb0c1b7aab1a9534ecabee90f1ab5ab667c0d87257910

data/README.md

@@ -60,18 +60,20 @@ company_token = 'my-company-token'
 @client = FinApps::REST::Client.new company_identifier, company_token
 ```
 
-## More Information
+### Release
 
-Please check the [FinApps wiki][wiki] for extended documentation.
+For approved Pull Requests against the master branch, an aggregated release draft will be generated. This draft by default bumps the patch number of previous version.
+Please refer to the [Release Drafter] action documentation for information on this process, specifically how to bump the major or minor numbers of the gem version.
 
+As soon as this draft is converted into an actual release, an automated process also running on GitHub actions will be triggered to build the gem and release it to rubygems.org.
 
-[FinancialApps.com][financialapps]
 
+[FinancialApps.com][financialapps]
 
 [bundler]: http://bundler.io
 [financialapps]: https://financialapps.com
-[wiki]: https://github.com/finapps/ruby-client/wiki
 [builder]: http://builder.rubyforge.org/
 [bundler]: http://bundler.io
 [rubygems]: http://rubygems.org
 [build_status]: http://teamciti.powerwallet.com/viewType.html?buildTypeId=FaRuby_BuildMaster&guest=1
+[Release Drafter]: https://github.com/release-drafter/release-drafter

data/lib/finapps/rest/documents_orders.rb

@@ -17,7 +17,12 @@ module FinApps
 
       def show(id)
         not_blank(id, :order_id)
-        super(id, "documents/orders/#{id}")
+
+        if matches_token_format?(id)
+          show_by_token id
+        else
+          show_by_id id
+        end
       end
 
       def create(params)
@@ -45,6 +50,20 @@ module FinApps
 
       private
 
+      def show_by_id(id)
+        path = "documents/orders/#{id}"
+        send_request path, :get
+      end
+
+      def show_by_token(jwt)
+        path = "documents/retrieve_order?token=#{jwt}"
+        send_request path, :get
+      end
+
+      def matches_token_format?(str)
+        str.match(/^.+\..+\..+$/)
+      end
+
       def build_filter(params)
         search_query(params[:searchTerm])
           .merge(consumer_query(params[:consumer]))

data/lib/finapps/version.rb

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

data/spec/rest/documents_orders_spec.rb

@@ -134,14 +134,28 @@ RSpec.describe FinApps::REST::DocumentsOrders do
     let(:error_messages) { show[1] }
 
     context 'with valid id' do
-      let(:id) { :valid_order_id }
+      context 'when id is an identifier' 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_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('has an order_id node in the response') do
+          expect(results).to have_key(:order_id)
+        end
+      end
 
-      it('performs a get and returns the response') do
-        expect(results).to have_key(:order_id)
+      context 'when id is a token' do
+        let(:id) { '0123456abc.0123456abc.0123456abc' }
+
+        it_behaves_like 'an API request'
+        it_behaves_like 'a successful request'
+        it('has an order node in the response') do
+          expect(results).to have_key(:order)
+        end
+
+        it('has a consumer node in the response') do
+          expect(results).to have_key(:consumer)
+        end
       end
     end
 

data/spec/support/fake_api.rb

@@ -214,6 +214,9 @@ module Fake
     get("/#{version}/documents/orders/valid_order_id") do
       json_response 200, 'documents_order.json'
     end
+    get("/#{version}/documents/retrieve_order") do
+      json_response 200, 'documents/retrieve_order.json'
+    end
     get("/#{version}/documents/orders/invalid_order_id") do
       json_response 404, 'resource_not_found.json'
     end

data/spec/support/fixtures/documents/retrieve_order.json

@@ -0,0 +1,97 @@
+{
+  "order": {
+    "order_id": "2eaf91ab-fdc3-4e0e-a614-5bc790771dcc",
+    "consumer_id": "4040e594-a1c7-4a9a-7a85-d78b915b5ac8",
+    "applicant": {
+      "public_id": "4040e594-a1c7-4a9a-7a85-d78b915b5ac8",
+      "email": "erich+202012301310@financialapps.com",
+      "first_name": "Erich",
+      "last_name": "Quintero",
+      "phone": "",
+      "external_id": ""
+    },
+    "reference_no": "20201230",
+    "esign_documents": [
+      {
+        "signature_request_id": "1fb7b6ad7ad31cff806c66da1ab449f1ed0f8e2a",
+        "completed": false,
+        "completed_date": null,
+        "declined": false,
+        "declined_date": null,
+        "declined_reason": null,
+        "declined_role": null,
+        "date_requested": "2020-12-30T18:11:41.907Z",
+        "template_name": "Un-Ordered Signing w/ Sender Field",
+        "template_id": "aefba323382586b15ede625b055243d94feb0693",
+        "is_ordered": false,
+        "custom_field": [
+          {
+            "api_id": "5ffc1866-c2fb-454c-ac60-37f87cc4fe3f",
+            "value": ""
+          }
+        ],
+        "signers": [
+          {
+            "public_id": "1031ae95-73c2-437d-7d89-b0834866ea63",
+            "role_name": "signer_1",
+            "signed": false,
+            "signed_date": null,
+            "signature_id": "6b5b8c3f0b7ab3a14a9a560c156a85f6"
+          },
+          {
+            "public_id": "032d6613-baa8-4419-60fd-28a3593cbd7a",
+            "role_name": "signer_2",
+            "signed": false,
+            "signed_date": null,
+            "signature_id": "0ef748f8ac3d1c80c0132097eb3a7af5"
+          }
+        ]
+      }
+    ],
+    "co_applicants": [
+      {
+        "public_id": "1031ae95-73c2-437d-7d89-b0834866ea63",
+        "email": "erich+202012301310-s1@financialapps.com",
+        "first_name": "Signer",
+        "last_name": "Uno",
+        "phone": "",
+        "external_id": ""
+      },
+      {
+        "public_id": "032d6613-baa8-4419-60fd-28a3593cbd7a",
+        "email": "erich+202012301310-s2@financialapps.com",
+        "first_name": "Signer",
+        "last_name": "Dos",
+        "phone": "",
+        "external_id": ""
+      }
+    ],
+    "upload_documents": [],
+    "tag": "new",
+    "status": 1,
+    "history": [
+      {
+        "date": "2020-12-30T18:11:44Z",
+        "event": "signature_request_sent",
+        "signature_request_id": "1fb7b6ad7ad31cff806c66da1ab449f1ed0f8e2a"
+      }
+    ],
+    "created_by": "erich@financialapps.com",
+    "date_created": "2020-12-30T18:11:40.156Z",
+    "date_modified": "2020-12-30T18:11:40.156Z",
+    "date_last_completed": null
+  },
+  "consumer": {
+    "public_id": "4040e594-a1c7-4a9a-7a85-d78b915b5ac8",
+    "email": "erich+202012301310@financialapps.com",
+    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwdWJsaWNfaWQiOiI0MDQwZTU5NC1hMWM3LTRhOWEtN2E4NS1kNzhiOTE1YjVhYzgiLCJzZXNzaW9uX2lkIjoiMzljNWJiZWYtMmRlMy00YTM1LTRiMjYtNDk1NThhYWFjMjcwIiwidXNlcl90eXBlIjoxLCJ0ZW5hbnRfaWQiOiI0ZGQ2MDdiMS01NjVmLTRkYTQtNzIyYy0yZTg0YzVjODdmNDMiLCJleHAiOjE2MDk0NDI5MDAsImlhdCI6MTYwOTM1NjUwMCwiaXNzIjoiRmluYW5jaWFsQXBwcyIsIm5iZiI6MTYwOTM1NjUwMH0.j66bynp-bVNIvrhv1AQO-mZgERu365BoyMMoppGGJo0",
+    "first_name": "Erich",
+    "last_name": "Quintero",
+    "memo": "",
+    "tenant_id": "4dd607b1-565f-4da4-722c-2e84c5c87f43",
+    "date_modified": "2020-12-30T18:11:40.167Z",
+    "date_created": "2020-12-30T18:11:40.167Z",
+    "locked": false,
+    "postal_code": "00000"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 5.0.45
+  version: 5.0.46
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -374,6 +374,7 @@ files:
 - spec/support/fixtures/alert_definition.json
 - spec/support/fixtures/alert_definitions.json
 - spec/support/fixtures/alert_occurrences.json
+- spec/support/fixtures/documents/retrieve_order.json
 - spec/support/fixtures/documents_order.json
 - spec/support/fixtures/documents_orders.json
 - spec/support/fixtures/documents_orders_none.json
@@ -465,49 +466,49 @@ signing_key:
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
+- spec/spec_helpers/client.rb
+- spec/spec_helper.rb
+- spec/utils/query_builder_spec.rb
 - spec/support/fake_api.rb
 - spec/support/documents_uploads_routes.rb
-- spec/spec_helpers/client.rb
-- spec/rest/operators_password_resets_spec.rb
+- spec/rest/documents_uploads_spec.rb
+- spec/rest/order_tokens_spec.rb
+- spec/rest/version_spec.rb
 - spec/rest/products_spec.rb
-- spec/rest/alert_definitions_spec.rb
-- spec/rest/verix/verix_pdf_documents_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/password_resets_spec.rb
+- spec/rest/tenant_settings_spec.rb
+- spec/rest/documents_orders_spec.rb
 - spec/rest/verix/verix_metadata_spec.rb
-- spec/rest/verix/verix_documents_spec.rb
 - spec/rest/verix/verix_records_spec.rb
-- spec/rest/portfolios_available_consumers_spec.rb
+- spec/rest/verix/verix_documents_spec.rb
+- spec/rest/verix/verix_pdf_documents_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/documents_upload_types_spec.rb
+- spec/rest/documents_orders_notifications_spec.rb
+- spec/rest/consumers_spec.rb
+- spec/rest/order_reports_spec.rb
 - spec/rest/sessions_spec.rb
-- spec/rest/portfolios_consumers_spec.rb
-- spec/rest/tenant_app_settings_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/rest/esign_templates_spec.rb
 - spec/rest/alert_occurrences_spec.rb
-- spec/rest/client_spec.rb
+- spec/rest/portfolios_available_consumers_spec.rb
+- spec/rest/tenant_app_settings_spec.rb
+- spec/rest/portfolios_spec.rb
+- spec/rest/order_assignments_spec.rb
+- spec/rest/alert_definitions_spec.rb
 - spec/rest/portfolio_reports_spec.rb
-- spec/rest/order_statuses_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/documents_orders_spec.rb
-- spec/rest/order_notifications_spec.rb
-- spec/rest/operators_spec.rb
-- spec/rest/order_reports_spec.rb
-- spec/rest/orders_spec.rb
-- spec/rest/password_resets_spec.rb
-- spec/rest/order_refreshes_spec.rb
-- spec/rest/documents_uploads_spec.rb
-- spec/rest/tenant_settings_spec.rb
 - spec/rest/consumers_portfolios_spec.rb
-- spec/rest/signed_documents_downloads_spec.rb
-- spec/rest/order_assignments_spec.rb
 - spec/rest/portfolios_alerts_spec.rb
-- spec/rest/esign_templates_spec.rb
-- spec/rest/plaid/plaid_accounts_spec.rb
+- spec/rest/operators_spec.rb
+- spec/rest/signed_documents_downloads_spec.rb
+- spec/rest/api_request.rb
+- spec/rest/order_notifications_spec.rb
+- spec/rest/portfolios_consumers_spec.rb
 - spec/rest/plaid/plaid_webhooks_spec.rb
+- spec/rest/plaid/plaid_accounts_spec.rb
 - spec/rest/plaid/plaid_account_permissions_spec.rb
-- spec/rest/plaid/plaid_institution_logos_spec.rb
 - spec/rest/plaid/plaid_consumer_institutions_spec.rb
-- spec/rest/documents_upload_types_spec.rb
-- spec/rest/consumers_spec.rb
-- spec/rest/api_request.rb
-- spec/rest/version_spec.rb
-- spec/rest/documents_orders_notifications_spec.rb
-- spec/rest/portfolios_spec.rb
-- spec/utils/query_builder_spec.rb
-- spec/spec_helper.rb
+- spec/rest/plaid/plaid_institution_logos_spec.rb
+- spec/rest/order_statuses_spec.rb
+- spec/rest/order_refreshes_spec.rb