active_call-doc_fox 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628b59bc4c362f6a5caab2386b8016e4d1fcfe4e75dd5b99dd0ba008533b2c80
-  data.tar.gz: c067179a7335e1cb214f42770bd58caaede0579a37df5c5295a16333c705b943
+  metadata.gz: 03e0ba0383b10c32d4db8d54c218218af2a0b88c7c424a55962a66030dd2759a
+  data.tar.gz: e3a1da533e017f392cdc428e37f1c5142a25105aaeb32b8f04224bffe499bcb7
 SHA512:
-  metadata.gz: 9d066ed5880a5d588fd6bd17c9ac98c09eb112b03909d97fb07675fd4252520b5facbbf062788ffc85b81eebd837da3c0e6519f2e8ed4feca3b224a168251632
-  data.tar.gz: b7e3b3d89e1ef3482de466858b020767103ad34ab310e350e8d0c6449327986d8ce1e8ab1c894bd526688c01feea2be089c5d836b91e45917049e2101465d443
+  metadata.gz: 59c45a9756e5dece42d132e3cb4dd14af215454c6811874a804e5608e5693f5213a747fd00db86d2d60477cf7c2febb7c8df821f4a2afaea10c278c9d44ab42f
+  data.tar.gz: '080c8f01dd88a9dd8ba3a136d7e763d0d4599077f02bfc4f3572a4594937d19859bf3da7b188f1c22d2607bbc6448fd4ad12dded10a718539d4f1528b80bee59'

data/.rubocop.yml

@@ -19,6 +19,11 @@ Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 
+Layout/LineLength:
+  AllowedPatterns:
+    - initialize
+    - '#'
+
 Lint/MissingSuper:
   Enabled: false
 
@@ -39,6 +44,13 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/doc_fox/concerns/enumerable.rb
+
 Naming/FileName:
   Exclude:
     - lib/active_call-doc_fox.rb

data/CHANGELOG.md

@@ -1,8 +1,23 @@
-## [0.1.1] - 2025-03-23
+## [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.
+- Fixed empty list enumerable errors.
+
+## [0.1.1] - 2025-04-02
 
 - Fix `source_code_uri` and `changelog_uri` link in gemspec.
 
-## [0.1.0] - 2025-03-23
+## [0.1.0] - 2025-04-02
 
 - Initial release
 - Intial `DocFox::KycApplication`, `DocFox::KycEntityTemplate` and `DocFox::User` service objects

data/README.md

@@ -1,5 +1,7 @@
 # Active Call - nCino KYC DocFox
 
+[![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.
 
 - [Installation](#installation)
@@ -9,27 +11,23 @@ DocFox exposes the [nCino KYC DocFox API](https://www.docfoxapp.com/api/v2/docum
   - [Using call!](#using-call!)
   - [When to use call or call!](#using-call-or-call!)
   - [Using lists](#using-lists)
-  - [KYC Applications](#kyc-applications)
-  - [KYC Entity Templates](#kyc-entity-templates)
-  - [Users](#users)
+- [Service Objects](#service-objects)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add active_call-doc_fox
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install active_call-doc_fox
 ```
 
 ## Configuration
@@ -205,12 +203,19 @@ end
 
 If you don't provide the `per_page` argument, multiple API requests will be made untill all records have been returned. You could be rate limited, so use wisely.
 
+## Service Objects
+
+<details open>
+<summary>KYC Applications</summary>
+
 ### KYC Applications
 
 #### 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
 ```
@@ -224,6 +229,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
@@ -237,6 +244,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
@@ -245,7 +254,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: {
@@ -263,45 +274,184 @@ 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>
+
+<details>
+<summary>KYC Entity Templates</summary>
+
 ### KYC Entity Templates
 
 #### 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
 ```
@@ -309,6 +459,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
@@ -318,12 +470,284 @@ 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>
+
 ### Users
 
 #### 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
 ```
@@ -331,6 +755,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
@@ -340,6 +766,8 @@ service.deactivated
 ...
 ```
 
+</details>
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/doc_fox/access_token/get_service.rb

@@ -7,6 +7,8 @@ class DocFox::AccessToken::GetService < DocFox::BaseService
     errors.merge!(authentication_service.errors) unless authentication_service.success?
   end
 
+  skip_callback :call, :before, :set_access_token
+
   before_call :authenticate
 
   after_call :set_facade
@@ -15,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
@@ -30,7 +34,6 @@ class DocFox::AccessToken::GetService < DocFox::BaseService
 
   def connection
     @_connection ||= Faraday.new do |conn|
-      conn.adapter Faraday.default_adapter
       conn.url_prefix = base_url
       conn.headers['X-Client-Api-Key'] = api_key
       conn.headers['X-Client-Signature'] = signature
@@ -42,6 +45,7 @@ class DocFox::AccessToken::GetService < DocFox::BaseService
         logger.filter(/(X-Client-Signature:).*"(.+)."/i, '\1 [FILTERED]')
         logger.filter(/"token":"([^"]+)"/i, '"token":"[FILTERED]"')
       end
+      conn.adapter Faraday.default_adapter
     end
   end