active_call-doc_fox 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a4844a8cafc0cf44d2064815b76b3e7c595624f8e6df170d5951ab30fc8712
-  data.tar.gz: 72a3cc818e2df925808917b3e84c89e102ccbdf965a350d9895243202ae6b5e1
+  metadata.gz: da9b1a766d5bdb3e7d9ead4e0bd2887b7beb0b7b09456c411b338d7ec76c19e0
+  data.tar.gz: 99b83630296bc23024850639b8078a2d9662e85b41a5f0672929ae4b3e2cd0dd
 SHA512:
-  metadata.gz: 6d40925136bfbd0fa746d5396bcb07b8bcd145fd401d5560e19f45c1d44bf9379a5002a65151cbd99ba31f9407c61f1f0c015b23a4a31cfb552c3cb369cbe308
-  data.tar.gz: 3e6bb5d3a082dd2c8c587541364d437a50fc3784a90219a0c28b31dd1d7535aa76884286a3b8e52a8b57409a23581c8b6a4ba64a8f399afda9b1ffaa5163d844
+  metadata.gz: 7638777bef5355e94885377332aad31c80fa7e3fd448c25572016eb3fd56812cb87992cc11e21ab00696bf34dfcf5181c58aaf16cea389fc639b203b411e70d6
+  data.tar.gz: 3c06cda91a960387883b3ff239fbcdb80fc0a5aa789710a150e560e45e7336cdc6a7109a997b2742e01e5de5183f0e07be8e4cb9a6c3f2cf6322a0cb9f6704aa

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,5 +1,13 @@
-## [Unreleased]
+## [0.1.2] - 2025-04-05
 
-## [0.1.0] - 2025-03-23
+- 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-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,6 +203,11 @@ 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
@@ -296,6 +299,11 @@ service = DocFox::KycApplication::UnarchiveService.call(id: '', reason: '')
 service = DocFox::KycApplication::DeleteService.call(id: '')
 ```
 
+</details>
+
+<details>
+<summary>KYC Entity Templates</summary>
+
 ### KYC Entity Templates
 
 #### List KYC entity templates
@@ -318,6 +326,11 @@ service.profile_schema
 ...
 ```
 
+</details>
+
+<details>
+<summary>Users</summary>
+
 ### Users
 
 #### List users
@@ -340,6 +353,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
@@ -30,7 +32,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 +43,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
 

data/lib/doc_fox/authentication/get_service.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class DocFox::Authentication::GetService < DocFox::BaseService
+  skip_callback :call, :before, :set_access_token
+
   after_call :set_facade
 
   delegate_missing_to :@facade
@@ -22,7 +24,6 @@ class DocFox::Authentication::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.request :json
@@ -32,6 +33,7 @@ class DocFox::Authentication::GetService < DocFox::BaseService
         logger.filter(/(X-Client-Api-Key:).*"(.+)."/i, '\1 [FILTERED]')
         logger.filter(/"nonce":"([^"]+)"/i, '"nonce":"[FILTERED]"')
       end
+      conn.adapter Faraday.default_adapter
     end
   end
 

data/lib/doc_fox/base_service.rb

@@ -15,7 +15,15 @@ class DocFox::BaseService < ActiveCall::Base
   config_accessor :log_bodies, default: false, instance_writer: false
   config_accessor :api_key, :secret, instance_writer: false
 
-  attr_reader :facade
+  attr_reader :access_token, :facade
+
+  before_call :set_access_token
+
+  validate on: :request do
+    next if is_a?(DocFox::AccessToken::GetService) || is_a?(DocFox::Authentication::GetService)
+
+    errors.merge!(access_token_service.errors) if access_token.nil? && !access_token_service.success?
+  end
 
   class << self
     def exception_mapping
@@ -48,15 +56,15 @@ class DocFox::BaseService < ActiveCall::Base
 
   def connection
     @_connection ||= Faraday.new do |conn|
-      conn.adapter Faraday.default_adapter
       conn.url_prefix = base_url
-      conn.request :authorization, 'Bearer', -> { access_token }
+      conn.request :authorization, 'Bearer', access_token
       conn.request :json
       conn.request :retry
       conn.response :json
       conn.response :logger, logger, **logger_options do |logger|
         logger.filter(/(Authorization:).*"(.+)."/i, '\1 [FILTERED]')
       end
+      conn.adapter Faraday.default_adapter
     end
   end
 
@@ -69,11 +77,19 @@ class DocFox::BaseService < ActiveCall::Base
     }
   end
 
-  def access_token
-    access_token = cache.read(CACHE_KEY[:access_token])
-    return access_token if access_token.present?
+  def set_access_token
+    @access_token = cache.read(CACHE_KEY[:access_token])
+    return if @access_token.present?
+    return unless access_token_service.success?
+
+    expires_at = Time.parse(access_token_service.expires_at)
+
+    @access_token = cache.fetch(CACHE_KEY[:access_token], expires_at: expires_at - 10) do
+      access_token_service.token
+    end
+  end
 
-    service = DocFox::AccessToken::GetService.call
-    cache.fetch(CACHE_KEY[:access_token], expires_at: Time.parse(service.expires_at) - 10) { service.token }
+  def access_token_service
+    @_access_token_service ||= DocFox::AccessToken::GetService.call
   end
 end

data/lib/doc_fox/concerns/enumerable.rb

@@ -40,6 +40,8 @@ module DocFox::Enumerable
           throw :list_end
         end
 
+        throw :list_end unless response.body
+
         response.body['data'].each do |hash|
           yield facade_klass.new(hash)
           total += 1

data/lib/doc_fox/kyc_application/get_service.rb

@@ -3,12 +3,12 @@
 class DocFox::KycApplication::GetService < DocFox::BaseService
   attr_reader :id, :params
 
+  validates :id, presence: true
+
   after_call :set_facade
 
   delegate_missing_to :@facade
 
-  validates :id, presence: true
-
   def initialize(id:, params: {})
     @id     = id
     @params = params

data/lib/doc_fox/kyc_entity_template/get_service.rb

@@ -3,12 +3,12 @@
 class DocFox::KycEntityTemplate::GetService < DocFox::BaseService
   attr_reader :id
 
+  validates :id, presence: true
+
   after_call :set_facade
 
   delegate_missing_to :@facade
 
-  validates :id, presence: true
-
   def initialize(id:)
     @id = id
   end

data/lib/doc_fox/user/get_service.rb

@@ -3,12 +3,12 @@
 class DocFox::User::GetService < DocFox::BaseService
   attr_reader :id
 
+  validates :id, presence: true
+
   after_call :set_facade
 
   delegate_missing_to :@facade
 
-  validates :id, presence: true
-
   def initialize(id:)
     @id = id
   end

data/lib/doc_fox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DocFox
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_call-doc_fox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_call-api
@@ -85,8 +85,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/kobusjoubert/doc_fox
-  source_code_uri: https://github.com/kobusjoubert/dox_fox
-  changelog_uri: https://github.com/kobusjoubert/dox_fox/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/kobusjoubert/doc_fox
+  changelog_uri: https://github.com/kobusjoubert/doc_fox/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: