active_call-doc_fox 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9b1a766d5bdb3e7d9ead4e0bd2887b7beb0b7b09456c411b338d7ec76c19e0
-  data.tar.gz: 99b83630296bc23024850639b8078a2d9662e85b41a5f0672929ae4b3e2cd0dd
+  metadata.gz: e33b608e780fdfcaad1dd0b298eb03392c606f88507bcd33fd0a16f4b2bea303
+  data.tar.gz: 2d8d562d240c26e546c955dbd570136270a558720ad0417e7dca3dac50b8f748
 SHA512:
-  metadata.gz: 7638777bef5355e94885377332aad31c80fa7e3fd448c25572016eb3fd56812cb87992cc11e21ab00696bf34dfcf5181c58aaf16cea389fc639b203b411e70d6
-  data.tar.gz: 3c06cda91a960387883b3ff239fbcdb80fc0a5aa789710a150e560e45e7336cdc6a7109a997b2742e01e5de5183f0e07be8e4cb9a6c3f2cf6322a0cb9f6704aa
+  metadata.gz: fd5a76c5f1f2433c8f966e57ac3e47cc0938a3cd44aaa0fb59aef7e3a78a79a4ba19f95209fe853f1f252f6fcc00bf2b73e270fedfa361bb24fcc6b4d9c59d60
+  data.tar.gz: ba4b0940e67264198360cb05e1af1f201ffd38db0fc233729793c4b5f2b3a3198e2c91bfe05a1e7190bf1d8b7b3e83e9f2d0589c99d1eda7c5227f955f31acd5

data/.rubocop.yml

@@ -22,6 +22,7 @@ Layout/HashAlignment:
 Layout/LineLength:
   AllowedPatterns:
     - initialize
+    - '#'
 
 Lint/MissingSuper:
   Enabled: false
@@ -43,6 +44,9 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ParameterLists:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Exclude:
     - lib/doc_fox/concerns/enumerable.rb

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.2.1] - 2025-05-09
+
+- README and Gemspec description updates.
+
+## [0.2.0] - 2025-04-15
+
+- DocFox::StatusSummary service objects
+- DocFox::Profile service objects
+- DocFox::DataRequirement service objects
+- DocFox::EvidenceSubmission service objects
+- DocFox::Document service objects
+- README update with new added services
+- Bug fix on DocFox::Authentication::GetService when no api_key
+
 ## [0.1.2] - 2025-04-05
 
 - Set access token in before_call hook instead of lambda so we can capture errors from the access token service objects.

data/README.md

@@ -2,7 +2,15 @@
 
 [![Gem Version](https://badge.fury.io/rb/active_call-doc_fox.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/active_call-doc_fox)
 
-DocFox exposes the [nCino KYC DocFox API](https://www.docfoxapp.com/api/v2/documentation) endpoints through service objects.
+DocFox exposes the [nCino KYC DocFox API](https://www.docfoxapp.com/api/v2/documentation) endpoints through [Active Call](https://rubygems.org/gems/active_call) service objects.
+
+<div align="center">
+  <a href="https://platform45.com?utm_source=github&utm_content=doc_fox">
+    <picture>
+      <img src="https://github.com/user-attachments/assets/19fd40df-2ce9-4f30-8120-d53f3fbf9f07">
+    </picture>
+  </a>
+</div>
 
 - [Installation](#installation)
 - [Configuration](#configuration)
@@ -213,7 +221,9 @@ If you don't provide the `per_page` argument, multiple API requests will be made
 #### List KYC applications
 
 ```ruby
-service = DocFox::KycApplication::ListService.call(page: 1, per_page: 10).each do |facade|
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications/get
+
+DocFox::KycApplication::ListService.call(page: 1, per_page: 10).each do |facade|
   facade.id
 end
 ```
@@ -227,6 +237,8 @@ DocFox::KycApplication::ListService.call(search_term: 'eric.cartman@example.com'
 #### Get a KYC application
 
 ```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D/get
+
 service = DocFox::KycApplication::GetService.call(id: '')
 service.id
 service.approved_at
@@ -240,6 +252,8 @@ service.relationships.dig('data_requirements', 'links', 'related')
 
 Include related resources.
 
+`managed_by`, `profile.additional_details`, `profile.addresses`, `profile.contacts`, `profile.names`, `profile.numbers`, `parent_related_entities`, `onboarding_token_summary`, `onboarding_token_summary.status_summaries`, `onboarding_token_summary.data_requirement_summaries`, `onboarding_token_summary.kyc_entity_template_designation_schema`, `onboarding_token_summary.parent_related_entity_designation_summary`, `onboarding_token_summary.parent_onboarding_token_summary`, `onboarding_token_summary.relationship_builder_config`
+
 ```ruby
 service = DocFox::KycApplication::GetService.call(id: '', params: { include: 'managed_by,profile.names' })
 service.included
@@ -248,7 +262,9 @@ service.included
 #### Create a KYC application
 
 ```ruby
-service = DocFox::KycApplication::CreateService.call(
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications/post
+
+DocFox::KycApplication::CreateService.call(
   data: {
     type: 'kyc_application',
     attributes: {
@@ -266,37 +282,169 @@ service = DocFox::KycApplication::CreateService.call(
 #### Approve a KYC application
 
 ```ruby
-service = DocFox::KycApplication::ApproveService.call(id: '')
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1approve/patch
+
+DocFox::KycApplication::ApproveService.call(id: '')
 ```
 
 #### Unapprove a KYC application
 
 ```ruby
-service = DocFox::KycApplication::UnapproveService.call(id: '', reason: '')
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1unapprove/patch
+
+DocFox::KycApplication::UnapproveService.call(id: '', reason: '')
 ```
 
 #### Transfer a KYC application
 
 ```ruby
-service = DocFox::KycApplication::TransferService.call(id: '', transfer_to_user_id: '')
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1transfer/patch
+
+DocFox::KycApplication::TransferService.call(id: '', transfer_to_user_id: '')
 ```
 
 #### Archive a KYC application
 
 ```ruby
-service = DocFox::KycApplication::ArchiveService.call(id: '', reason: '')
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1archive/post
+
+DocFox::KycApplication::ArchiveService.call(id: '', reason: '')
 ```
 
 #### Unarchive a KYC application
 
 ```ruby
-service = DocFox::KycApplication::UnarchiveService.call(id: '', reason: '')
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1unarchive/post
+
+DocFox::KycApplication::UnarchiveService.call(id: '', reason: '')
 ```
 
 #### Delete a KYC application
 
 ```ruby
-service = DocFox::KycApplication::DeleteService.call(id: '')
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D/delete
+
+DocFox::KycApplication::DeleteService.call(id: '')
+```
+
+</details>
+
+<details>
+<summary>Status Summaries</summary>
+
+### Status Summaries
+
+#### Get a status summary of a KYC application
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Status-Summaries/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1status_summaries/get
+
+service = DocFox::StatusSummary::GetService.call(id: '')
+service.id
+service.overall_kyc_application_status
+service.module_statuses
+...
+```
+
+</details>
+
+<details>
+<summary>Profiles</summary>
+
+### Profiles
+
+#### List profiles
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Profiles/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1profiles/get
+
+DocFox::Profile::ListService.call(kyc_application_id: '', page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+#### Get a profile
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Profiles/paths/~1api~1v2~1profiles~1%7Bprofile_id%7D/get
+
+service = DocFox::Profile::GetService.call(id: '')
+service.id
+service.created_at
+...
+```
+
+Include related resources.
+
+`additional_details`, `addresses`, `contacts`, `contacts.invitation_tokens`, `names`, `numbers`
+
+```ruby
+service = DocFox::Profile::GetService.call(id: '', params: { include: 'names,numbers,additional_details' })
+service.included
+```
+
+</details>
+
+<details>
+<summary>Data Requirements</summary>
+
+### Data Requirements
+
+#### List data requirements
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1data_requirements/get
+
+DocFox::DataRequirement::ListService.call(kyc_application_id: '', page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+List only data requirements for forms.
+
+```ruby
+DocFox::DataRequirement::ListService.call(kyc_application_id: '', forms: true).map { _1 }
+```
+
+#### List data requirements associated with an account application
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1account_applications~1%7Baccount_application_id%7D~1data_requirements/get
+
+DocFox::DataRequirement::ListService.call(account_application_id: '', page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+List only data requirements for forms.
+
+```ruby
+DocFox::DataRequirement::ListService.call(account_application_id: '', forms: true).map { _1 }
+```
+
+#### Get a data requirement
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1data_requirements~1%7Bdata_requirement_id%7D/get
+
+service = DocFox::DataRequirement::GetService.call(id: '')
+service.id
+service.created_at
+service.form
+service.name
+service.required
+service.slug
+service.valid_evidence_types
+...
+```
+
+Include related resources.
+
+`evidence_submissions`, `active_evidence_submission`, `active_evidence_submission.form`, `active_evidence_submission.form.active_form_datum`
+
+```ruby
+service = DocFox::DataRequirement::GetService.call(id: '', params: { include: 'evidence_submissions,active_evidence_submission' })
+service.included
 ```
 
 </details>
@@ -309,7 +457,9 @@ service = DocFox::KycApplication::DeleteService.call(id: '')
 #### List KYC entity templates
 
 ```ruby
-service = DocFox::KycEntityTemplate::ListService.call(page: 1, per_page: 10).each do |facade|
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Entity-Templates/paths/~1api~1v2~1kyc_entity_templates/get
+
+DocFox::KycEntityTemplate::ListService.call(page: 1, per_page: 10).each do |facade|
   facade.id
 end
 ```
@@ -317,6 +467,8 @@ end
 #### Get a KYC entity template
 
 ```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Entity-Templates/paths/~1api~1v2~1kyc_entity_templates~1%7Bkyc_entity_template_id%7D/get
+
 service = DocFox::KycEntityTemplate::GetService.call(id: '')
 service.id
 service.kyc_entity_type_name
@@ -328,6 +480,271 @@ service.profile_schema
 
 </details>
 
+<details>
+<summary>Evidence Submissions</summary>
+
+### Evidence Submissions
+
+#### List evidence submissions
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1data_requirements~1%7Bdata_requirement_id%7D~1evidence_submissions/get
+
+DocFox::EvidenceSubmission::ListService.call(data_requirement_id: '', page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+#### Get an evidence submission
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D/get
+
+service = DocFox::EvidenceSubmission::GetService.call(id: '')
+service.id
+service.evidence_type
+service.form
+service.status
+service.created_at
+service.attributes
+...
+```
+
+Include related resources.
+
+`document`: the related document, for document evidence submission  
+`qualitative_checks`: the related qualitative checks, for document evidence submission  
+`rejection_reasons`: the related rejection reasons  
+`form`: the related form, for form evidence submission  
+`form.active_form_datum`: the related form and its latest data submission, for form evidence submission
+
+```ruby
+service = DocFox::EvidenceSubmission::GetService.call(id: '', params: { include: 'document,qualitative_checks' })
+service.included
+```
+
+#### Update an evidence submission
+
+At the moment this is used only to add third party data to an external evidence submission for a specific third party provider.
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D/patch
+
+DocFox::EvidenceSubmission::UpdateService.call(
+  id: '',
+  data: {
+    type: 'evidence_submission',
+    id: '',
+    attributes: {
+      results: {
+        dob: '1984-01-01',
+        gender: 'M',
+        surname: 'Cartman',
+        forename1: 'Eric',
+        forename2: nil,
+        id_number: '8401017223183',
+        addresses: {
+          address: [
+            {
+              addr_type: 'R',
+              addr_line1: '28201 E. Bonanza St.',
+              addr_line2: '',
+              addr_line3: '',
+              addr_line4: 'South Park',
+              addr_postal_code: '8000',
+              addr_update_date: '2017-11-21'
+            }
+          ]
+        },
+        telephones: {
+          telephone: [
+            {
+              tel_num: '27715555555',
+              tel_type: 'Cell',
+              tel_update_date: '2017-09-05'
+            }
+          ]
+        },
+        deceased_date: nil,
+        deceased_flag: 'N',
+        verified_date: '2015-06-23',
+        verified_flag: 'Y',
+        deceased_reason: nil
+      }
+    }
+  }
+)
+```
+
+#### Reject an active evidence submission
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1reject/patch
+
+DocFox::EvidenceSubmission::RejectService.call(id: '', reason: '')
+```
+
+#### Approve an active evidence submission
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1approve/patch
+
+DocFox::EvidenceSubmission::ApproveService.call(id: '')
+```
+
+#### Replace an active evidence submission
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1replace/patch
+
+DocFox::EvidenceSubmission::ReplaceService.call(id: '')
+```
+
+</details>
+
+<details>
+<summary>Documents</summary>
+
+### Documents
+
+#### List documents
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Documents/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1documents/get
+
+DocFox::Document::ListService.call(evidence_submission_id: '', page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+#### Get a document
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Documents/paths/~1api~1v2~1documents~1%7Bdocument_id%7D/get
+
+service = DocFox::Document::GetService.call(id: '')
+service.id
+service.created_at
+service.content_type
+service.filename
+service.token
+service.token_expiry
+service.uploaded_by
+...
+```
+
+Include related resources.
+
+`evidence_submissions`
+
+```ruby
+service = DocFox::Document::GetService.call(id: '', params: { include: 'evidence_submissions' })
+service.included
+```
+
+</details>
+
+<details>
+
+<summary>Document Tokens</summary>
+
+### Document Tokens
+
+#### List document tokens
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Document-Tokens/paths/~1api~1v2~1documents~1%7Bdocument_id%7D~1document_tokens/get
+
+DocFox::DocumentToken::ListService.call(document_id: '', page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+#### Get a document token
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Document-Tokens/paths/~1api~1v2~1document_tokens~1%7Bdocument_token_id%7D/get
+
+service = DocFox::DocumentToken::GetService.call(id: '')
+service.id
+service.created_at
+service.expiry
+service.content_type
+...
+```
+
+#### Create a document token
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Document-Tokens/paths/~1api~1v2~1documents~1%7Bdocument_id%7D~1document_tokens/post
+
+DocFox::DocumentToken::CreateService.call(
+  document_id: '',
+  data: {
+    type: 'document_token'
+  }
+)
+```
+
+</details>
+
+<details>
+
+<summary>Download Documents</summary>
+
+### Download Documents
+
+#### Download a document file
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Download-Documents/paths/~1api~1v2~1document_file_downloads~1%7Bdocument_token_id%7D/get
+
+service = DocFox::Document::DownloadService.call(document_token_id: '', content_type: 'image/jpeg')
+service.response.body # => "\xFF\xD8\xFF\xDB\x00\x84\x00\x04\x05\x..."
+```
+
+Possible values for `content_type`.
+
+- `image/jpeg`
+- `image/png`
+- `application/pdf`
+
+You can also provide just the `document_id` and the service will automatically request the `document_token_id` and `content_type` for you.
+
+```ruby
+service = DocFox::Document::DownloadService.call(document_id: '')
+service.response.body # => "\xFF\xD8\xFF\xDB\x00\x84\x00\x04\x05\x..."
+```
+
+</details>
+
+<details>
+
+<summary>Document Uploads</summary>
+
+### Document Uploads
+
+#### Upload a document file
+
+```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Document-Uploads/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1documents/post
+
+DocFox::Document::UploadService.call(
+  evidence_submission_id: '',
+  data: {
+    type: 'document',
+    attributes: {
+      evidence_type: 'taxes_paid_in_prior_quarter',
+      filename: 'taxes_paid.png',
+      document_data: "data:image/png;base64,#{Base64.encode64(File.read('/path/to/taxes_paid.png'))}"
+    }
+  }
+)
+```
+</details>
+
+</details>
+
 <details>
 <summary>Users</summary>
 
@@ -336,7 +753,9 @@ service.profile_schema
 #### List users
 
 ```ruby
-service = DocFox::User::ListService.call(page: 1, per_page: 10).each do |facade|
+# https://www.docfoxapp.com/api/v2/documentation#tag/Users/paths/~1api~1v2~1users/get
+
+DocFox::User::ListService.call(page: 1, per_page: 10).each do |facade|
   facade.id
 end
 ```
@@ -344,6 +763,8 @@ end
 #### Get a user
 
 ```ruby
+# https://www.docfoxapp.com/api/v2/documentation#tag/Users/paths/~1api~1v2~1users~1%7Buser_id%7D/get
+
 service = DocFox::User::GetService.call(id: '')
 service.id
 service.email

data/lib/doc_fox/access_token/get_service.rb

@@ -17,6 +17,8 @@ class DocFox::AccessToken::GetService < DocFox::BaseService
 
   # Get access token.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Authentication/paths/~1api~1v2~1tokens~1new/get
+  #
   # ==== Examples
   #
   #   service = DocFox::AccessToken::GetService.call

data/lib/doc_fox/authentication/get_service.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class DocFox::Authentication::GetService < DocFox::BaseService
+  validates :api_key, presence: true
+
   skip_callback :call, :before, :set_access_token
 
   after_call :set_facade
@@ -9,6 +11,8 @@ class DocFox::Authentication::GetService < DocFox::BaseService
 
   # Get access token.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Authentication/paths/~1api~1v2~1authentications~1new/get
+  #
   # ==== Examples
   #
   #   service = DocFox::Authentication::GetService.call

data/lib/doc_fox/base_service.rb

@@ -61,6 +61,7 @@ class DocFox::BaseService < ActiveCall::Base
       conn.request :json
       conn.request :retry
       conn.response :json
+      conn.response :follow_redirects
       conn.response :logger, logger, **logger_options do |logger|
         logger.filter(/(Authorization:).*"(.+)."/i, '\1 [FILTERED]')
       end

data/lib/doc_fox/concerns/enumerable.rb

@@ -31,7 +31,7 @@ module DocFox::Enumerable
 
     catch :list_end do
       loop do
-        @response = connection.get(path, params)
+        @response = connection.get(path, **params)
         validate(:response)
 
         unless success?

data/lib/doc_fox/data_requirement/facade.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class DocFox::DataRequirement::Facade
+  attr_reader :id, :attributes, :relationships, :included, :created_at, :duplicable, :duplicates_max, :duplicates_min,
+    :duplicate_of, :form, :name, :required, :slug, :updated_at, :valid_evidence_types
+
+  def initialize(hash)
+    @id            = hash.dig('data', 'id') || hash['id']
+    @attributes    = hash.dig('data', 'attributes') || hash['attributes']
+    @relationships = hash.dig('data', 'relationships') || hash['relationships']
+    @included      = hash['included']
+
+    @created_at           = attributes['created_at']
+    @duplicable           = attributes['duplicable']
+    @duplicates_max       = attributes['duplicates_max']
+    @duplicates_min       = attributes['duplicates_min']
+    @duplicate_of         = attributes['duplicate_of']
+    @form                 = attributes['form']
+    @name                 = attributes['name']
+    @required             = attributes['required']
+    @slug                 = attributes['slug']
+    @updated_at           = attributes['updated_at']
+    @valid_evidence_types = attributes['valid_evidence_types']
+  end
+end