active_call-doc_fox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06a4844a8cafc0cf44d2064815b76b3e7c595624f8e6df170d5951ab30fc8712
+  data.tar.gz: 72a3cc818e2df925808917b3e84c89e102ccbdf965a350d9895243202ae6b5e1
+SHA512:
+  metadata.gz: 6d40925136bfbd0fa746d5396bcb07b8bcd145fd401d5560e19f45c1d44bf9379a5002a65151cbd99ba31f9407c61f1f0c015b23a4a31cfb552c3cb369cbe308
+  data.tar.gz: 3e6bb5d3a082dd2c8c587541364d437a50fc3784a90219a0c28b31dd1d7535aa76884286a3b8e52a8b57409a23581c8b6a4ba64a8f399afda9b1ffaa5163d844

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,70 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - doc_fox.gemspec
+    - bin/*
+    - 'vendor/**/*'
+    - 'gem/**/*'
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*/**.rb
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/doc_fox/concerns/enumerable.rb
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/active_call-doc_fox.rb
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - lib/doc_fox.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/SymbolArray:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-23
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kobus Joubert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,355 @@
+# Active Call - nCino KYC DocFox
+
+DocFox exposes the [nCino KYC DocFox API](https://www.docfoxapp.com/api/v2/documentation) endpoints through service objects.
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+  - [Using call](#using-call)
+  - [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)
+- [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
+```
+
+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
+```
+
+## Configuration
+
+Configure your API credentials.
+
+In a Rails application, the standard practice is to place this code in a file named `doc_fox.rb` within the `config/initializers` directory.
+
+```ruby
+require 'active_call-doc_fox'
+
+DocFox::BaseService.configure do |config|
+  config.api_key = ''
+  config.secret = ''
+
+  # Optional configuration.
+  config.cache = Rails.cache # Default: ActiveSupport::Cache::MemoryStore.new
+  config.logger = Rails.logger # Default: Logger.new($stdout)
+  config.logger_level = :debug # Default: :info
+  config.log_headers = true # Default: false
+  config.log_bodies = true # Default: false
+end
+```
+
+## Usage
+
+### <a name='using-call'></a>Using `call`
+
+Each service object returned will undergo validation before the `call` method is invoked to access API endpoints.
+
+After **successful** validation.
+
+```ruby
+service.success? # => true
+service.errors # => #<ActiveModel::Errors []>
+```
+
+After **failed** validation.
+
+```ruby
+service.success? # => false
+service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=id, type=blank, options={}>]>
+service.errors.full_messages # => ["Id can't be blank"]
+```
+
+After a **successful** `call` invocation, the `response` attribute will contain a `Faraday::Response` object.
+
+```ruby
+service.success? # => true
+service.response # => #<Faraday::Response ...>
+service.response.success? # => true
+service.response.status # => 200
+service.response.body # => {"data"=>{"id"=>"aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb", "type"=>"kyc_application", "attributes"=>{}}, ...}
+```
+
+At this point you will also have a `facade` object which will hold all the attributes for the specific resource.
+
+```ruby
+service.facade # => #<DocFox::KycApplication::Facade @kyc_entity_type_name="South African Citizen" ...>
+service.facade.kyc_entity_type_name # => 'South African Citizen'
+```
+
+For convenience, facade attributes can be accessed directly on the service object.
+
+```ruby
+service.kyc_entity_type_name # => 'South African Citizen'
+```
+
+After a **failed** `call` invocation, the `response` attribute will still contain a `Faraday::Response` object.
+
+```ruby
+service.success? # => false
+service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=base, type=not_found, options={}>]>
+service.errors.full_messages # => ["Not Found"]
+service.response # => #<Faraday::Response ...>
+service.response.success? # => false
+service.response.status # => 404
+service.response.body # => {"errors"=>[{"title"=>"not_found", "status"=>"404", "detail"=>"The resource you requested could not be found"}]}
+```
+
+### <a name='using-call!'></a>Using `call!`
+
+Each service object returned will undergo validation before the `call!` method is invoked to access API endpoints.
+
+After **successful** validation.
+
+```ruby
+service.success? # => true
+```
+
+After **failed** validation, a `DocFox::ValidationError` exception will be raised with an `errors` attribute which 
+will contain an `ActiveModel::Errors` object.
+
+```ruby
+rescue DocFox::ValidationError => exception
+  exception.message # => ''
+  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=id, type=blank, options={}>]>
+  exception.errors.full_messages # => ["Id can't be blank"]
+```
+
+After a **successful** `call!` invocation, the `response` attribute will contain a `Faraday::Response` object.
+
+```ruby
+service.success? # => true
+service.response # => #<Faraday::Response ...>
+service.response.success? # => true
+service.response.status # => 200
+service.response.body # => {"data"=>{"id"=>"aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb", "type"=>"kyc_application", "attributes"=>{}}, ...}
+```
+
+At this point you will also have a `facade` object which will hold all the attributes for the specific resource.
+
+```ruby
+service.facade # => #<DocFox::KycApplication::Facade @kyc_entity_type_name="South African Citizen" ...>
+service.facade.kyc_entity_type_name # => 'South African Citizen'
+```
+
+For convenience, facade attributes can be accessed directly on the service object.
+
+```ruby
+service.kyc_entity_type_name # => 'South African Citizen'
+```
+
+After a **failed** `call!` invocation, a `DocFox::RequestError` will be raised with a `response` attribute which will contain a `Faraday::Response` object.
+
+```ruby
+rescue DocFox::RequestError => exception
+  exception.message # => 'Not Found'
+  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=base, type=not_found, options={}>]>
+  exception.errors.full_messages # => ["Not Found"]
+  exception.response # => #<Faraday::Response ...>
+  exception.response.status # => 404
+  exception.response.body # => {"errors"=>[{"title"=>"not_found", "status"=>"404", "detail"=>"The resource you requested could not be found"}]}
+```
+
+### <a name='using-call-or-call!'></a>When to use `call` or `call!`
+
+An example of where to use `call` would be in a **controller** doing an inline synchronous request.
+
+```ruby
+class SomeController < ApplicationController
+  def update
+    @service = DocFox::KycApplication::UpdateService.call(**params)
+
+    if @service.success?
+      redirect_to [@service], notice: 'Success', status: :see_other
+    else
+      flash.now[:alert] = @service.errors.full_messages.to_sentence
+      render :edit, status: :unprocessable_entity
+    end
+  end
+end
+```
+
+An example of where to use `call!` would be in a **job** doing an asynchronous request.
+
+You can use the exceptions to determine which retry strategy to use and which to discard.
+
+```ruby
+class SomeJob < ApplicationJob
+  discard_on DocFox::NotFoundError
+
+  retry_on DocFox::RequestTimeoutError, wait: 5.minutes, attempts: :unlimited
+  retry_on DocFox::TooManyRequestsError, wait: :polynomially_longer, attempts: 10
+
+  def perform
+    DocFox::KycApplication::UpdateService.call!(**params)
+  end
+end
+```
+
+### Using lists
+
+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.
+
+### KYC Applications
+
+#### List KYC applications
+
+```ruby
+service = DocFox::KycApplication::ListService.call(page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+Filter by names, numbers contact information or external refs.
+
+```ruby
+DocFox::KycApplication::ListService.call(search_term: 'eric.cartman@example.com').map { _1 }
+```
+
+#### Get a KYC application
+
+```ruby
+service = DocFox::KycApplication::GetService.call(id: '')
+service.id
+service.approved_at
+service.archived
+service.created_at
+service.status
+service.relationships.dig('profile', 'data', 'id')
+service.relationships.dig('data_requirements', 'links', 'related')
+...
+```
+
+Include related resources.
+
+```ruby
+service = DocFox::KycApplication::GetService.call(id: '', params: { include: 'managed_by,profile.names' })
+service.included
+```
+
+#### Create a KYC application
+
+```ruby
+service = DocFox::KycApplication::CreateService.call(
+  data: {
+    type: 'kyc_application',
+    attributes: {
+      kyc_entity_template_id: 'aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb',
+      names: {
+        first_names: 'Eric Theodore',
+        last_names: 'Cartman'
+      },
+      # ...more fields following the schema definitions.
+    }
+  }
+)
+```
+
+#### Approve a KYC application
+
+```ruby
+service = DocFox::KycApplication::ApproveService.call(id: '')
+```
+
+#### Unapprove a KYC application
+
+```ruby
+service = DocFox::KycApplication::UnapproveService.call(id: '', reason: '')
+```
+
+#### Transfer a KYC application
+
+```ruby
+service = DocFox::KycApplication::TransferService.call(id: '', transfer_to_user_id: '')
+```
+
+#### Archive a KYC application
+
+```ruby
+service = DocFox::KycApplication::ArchiveService.call(id: '', reason: '')
+```
+
+#### Unarchive a KYC application
+
+```ruby
+service = DocFox::KycApplication::UnarchiveService.call(id: '', reason: '')
+```
+
+#### Delete a KYC application
+
+```ruby
+service = DocFox::KycApplication::DeleteService.call(id: '')
+```
+
+### KYC Entity Templates
+
+#### List KYC entity templates
+
+```ruby
+service = DocFox::KycEntityTemplate::ListService.call(page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+#### Get a KYC entity template
+
+```ruby
+service = DocFox::KycEntityTemplate::GetService.call(id: '')
+service.id
+service.kyc_entity_type_name
+service.kyc_entity_type_category
+service.created_at
+service.profile_schema
+...
+```
+
+### Users
+
+#### List users
+
+```ruby
+service = DocFox::User::ListService.call(page: 1, per_page: 10).each do |facade|
+  facade.id
+end
+```
+
+#### Get a user
+
+```ruby
+service = DocFox::User::GetService.call(id: '')
+service.id
+service.email
+service.first_names
+service.last_names
+service.deactivated
+...
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kobusjoubert/doc_fox.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/active_call-doc_fox.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'doc_fox'

data/lib/doc_fox/access_token/facade.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class DocFox::AccessToken::Facade
+  attr_reader :token, :expires_at
+
+  def initialize(hash)
+    attributes = hash.dig('data', 'attributes')
+
+    @token      = attributes['token']
+    @expires_at = attributes['expires_at']
+  end
+end

data/lib/doc_fox/access_token/get_service.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class DocFox::AccessToken::GetService < DocFox::BaseService
+  attr_reader :authentication_service
+
+  validate on: :request do
+    errors.merge!(authentication_service.errors) unless authentication_service.success?
+  end
+
+  before_call :authenticate
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  # Get access token.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::AccessToken::GetService.call
+  #   service.token # => '1000.xxxx.yyyy'
+  #   service.expires_at # => '2025-01-01T06:00:00.000+02:00'
+  #
+  # GET /api/v2/tokens/new
+  def call
+    connection.get('tokens/new')
+  end
+
+  private
+
+  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
+      conn.request :json
+      conn.request :retry
+      conn.response :json
+      conn.response :logger, logger, **logger_options do |logger|
+        logger.filter(/(X-Client-Api-Key:).*"(.+)."/i, '\1 [FILTERED]')
+        logger.filter(/(X-Client-Signature:).*"(.+)."/i, '\1 [FILTERED]')
+        logger.filter(/"token":"([^"]+)"/i, '"token":"[FILTERED]"')
+      end
+    end
+  end
+
+  def authenticate
+    @authentication_service = DocFox::Authentication::GetService.call
+  end
+
+  def signature
+    # Turns 'HMAC-SHA256' -> 'SHA256'.
+    digest_algorithm = authentication_service.digest_algorithm.split('-').last
+
+    OpenSSL::HMAC.hexdigest(digest_algorithm, secret, authentication_service.nonce)
+  end
+
+  def set_facade
+    @facade = DocFox::AccessToken::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/authentication/facade.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class DocFox::Authentication::Facade
+  attr_reader :nonce, :digest_algorithm
+
+  def initialize(hash)
+    attributes = hash.dig('data', 'attributes')
+
+    @nonce            = attributes['nonce']
+    @digest_algorithm = attributes['digest_algorithm']
+  end
+end

data/lib/doc_fox/authentication/get_service.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class DocFox::Authentication::GetService < DocFox::BaseService
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  # Get access token.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::Authentication::GetService.call
+  #   service.nonce # => ''
+  #   service.digest_algorithm # => ''
+  #
+  # GET /api/v2/authentications/new
+  def call
+    connection.get('authentications/new')
+  end
+
+  private
+
+  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
+      conn.request :retry
+      conn.response :json
+      conn.response :logger, logger, **logger_options do |logger|
+        logger.filter(/(X-Client-Api-Key:).*"(.+)."/i, '\1 [FILTERED]')
+        logger.filter(/"nonce":"([^"]+)"/i, '"nonce":"[FILTERED]"')
+      end
+    end
+  end
+
+  def set_facade
+    @facade = DocFox::Authentication::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/base_service.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+class DocFox::BaseService < ActiveCall::Base
+  include ActiveCall::Api
+
+  self.abstract_class = true
+
+  CACHE_KEY = { access_token: 'doc_fox/base_service/access_token' }.freeze
+
+  config_accessor :base_url, default: 'https://www.docfoxapp.com/api/v2', instance_writer: false
+  config_accessor :cache, default: ActiveSupport::Cache::MemoryStore.new, instance_writer: false
+  config_accessor :logger, default: Logger.new($stdout), instance_writer: false
+  config_accessor :log_level, default: :info, instance_writer: false
+  config_accessor :log_headers, default: false, instance_writer: false
+  config_accessor :log_bodies, default: false, instance_writer: false
+  config_accessor :api_key, :secret, instance_writer: false
+
+  attr_reader :facade
+
+  class << self
+    def exception_mapping
+      {
+        validation_error:              DocFox::ValidationError,
+        request_error:                 DocFox::RequestError,
+        client_error:                  DocFox::ClientError,
+        server_error:                  DocFox::ServerError,
+        bad_request:                   DocFox::BadRequestError,
+        unauthorized:                  DocFox::UnauthorizedError,
+        forbidden:                     DocFox::ForbiddenError,
+        not_found:                     DocFox::NotFoundError,
+        not_acceptable:                DocFox::NotAcceptableError,
+        proxy_authentication_required: DocFox::ProxyAuthenticationRequiredError,
+        request_timeout:               DocFox::RequestTimeoutError,
+        conflict:                      DocFox::ConflictError,
+        gone:                          DocFox::GoneError,
+        unprocessable_entity:          DocFox::UnprocessableEntityError,
+        too_many_requests:             DocFox::TooManyRequestsError,
+        internal_server_error:         DocFox::InternalServerError,
+        not_implemented:               DocFox::NotImplementedError,
+        bad_gateway:                   DocFox::BadGatewayError,
+        service_unavailable:           DocFox::ServiceUnavailableError,
+        gateway_timeout:               DocFox::GatewayTimeoutError
+      }.freeze
+    end
+  end
+
+  private
+
+  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 :json
+      conn.request :retry
+      conn.response :json
+      conn.response :logger, logger, **logger_options do |logger|
+        logger.filter(/(Authorization:).*"(.+)."/i, '\1 [FILTERED]')
+      end
+    end
+  end
+
+  def logger_options
+    {
+      headers:   log_headers,
+      log_level: log_level,
+      bodies:    log_bodies,
+      formatter: Faraday::Logging::ColorFormatter, prefix: { request: 'DocFox', response: 'DocFox' }
+    }
+  end
+
+  def access_token
+    access_token = cache.read(CACHE_KEY[:access_token])
+    return access_token if access_token.present?
+
+    service = DocFox::AccessToken::GetService.call
+    cache.fetch(CACHE_KEY[:access_token], expires_at: Time.parse(service.expires_at) - 10) { service.token }
+  end
+end