active_call-doc_fox 0.1.1 → 0.2.0

data/lib/doc_fox/authentication/get_service.rb

@@ -1,12 +1,18 @@
 # 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
 
   delegate_missing_to :@facade
 
   # Get access token.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Authentication/paths/~1api~1v2~1authentications~1new/get
+  #
   # ==== Examples
   #
   #   service = DocFox::Authentication::GetService.call
@@ -22,7 +28,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 +37,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,16 @@ 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 :follow_redirects
       conn.response :logger, logger, **logger_options do |logger|
         logger.filter(/(Authorization:).*"(.+)."/i, '\1 [FILTERED]')
       end
+      conn.adapter Faraday.default_adapter
     end
   end
 
@@ -69,11 +78,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

@@ -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?
@@ -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/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

data/lib/doc_fox/data_requirement/get_service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class DocFox::DataRequirement::GetService < DocFox::BaseService
+  attr_reader :id, :params
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, params: {})
+    @id     = id
+    @params = params
+  end
+
+  # Get a data requirement.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1data_requirements~1%7Bdata_requirement_id%7D/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::DataRequirement::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::DataRequirement::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  #   service.relationships.dig('kyc_application', 'data', 'id')
+  #   service.relationships.dig('active_evidence_submission', 'links', 'related')
+  #
+  # Include related resources.
+  #
+  #   service = DocFox::DataRequirement::GetService.call(id: '', params: { include: 'evidence_submissions,active_evidence_submission' })
+  #
+  # GET /api/v2/data_requirements/:id
+  def call
+    connection.get("data_requirements/#{id}", **params)
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::DataRequirement::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/data_requirement/list_service.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class DocFox::DataRequirement::ListService < DocFox::BaseService
+  include DocFox::Enumerable
+
+  attr_reader :kyc_application_id, :account_application_id, :forms
+
+  validates :kyc_application_id_or_account_application_id, presence: true
+
+  # List data requirements.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1data_requirements/get
+  #
+  # List data requirements associated with an account application.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Data-Requirements/paths/~1api~1v2~1account_applications~1%7Baccount_application_id%7D~1data_requirements/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::DataRequirement::ListService.call(kyc_application_id: '').first
+  #   service.id
+  #   service.name
+  #
+  #   service = DocFox::DataRequirement::ListService.call(account_application_id: '').first
+  #   service.id
+  #   service.name
+  #
+  # 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.
+  #
+  #   DocFox::DataRequirement::ListService.call(kyc_application_id: '', page: 1, per_page: 10).map { _1 }
+  #
+  # Filter by forms.
+  #
+  #   DocFox::DataRequirement::ListService.call(kyc_application_id: '', forms: true).map { _1 }
+  #
+  # GET /api/v2/kyc_applications/:kyc_application_id/data_requirements
+  # GET /api/v2/account_applications/:account_application_id/data_requirements
+  def initialize(kyc_application_id: nil, account_application_id: nil, page: 1, per_page: Float::INFINITY, forms: false)
+    @kyc_application_id     = kyc_application_id
+    @account_application_id = account_application_id
+    @forms                  = forms
+
+    entity_path = kyc_application_id.present? ? 'kyc_applications' : 'account_applications'
+
+    super(
+      path:         "#{entity_path}/#{kyc_application_id_or_account_application_id}/data_requirements",
+      facade_klass: DocFox::DataRequirement::Facade,
+      page:         page,
+      per_page:     per_page
+    )
+  end
+
+  private
+
+  def params
+    @_params ||= begin
+      params         = { page: page, per_page: max_per_page_per_request }
+      params[:forms] = true if forms == true
+      params
+    end
+  end
+
+  def kyc_application_id_or_account_application_id
+    kyc_application_id.presence || account_application_id.presence
+  end
+end

data/lib/doc_fox/document/download_service.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class DocFox::Document::DownloadService < DocFox::BaseService
+  CONTENT_TYPES = ['image/jpeg', 'image/png', 'application/pdf'].freeze
+
+  attr_reader :document_id, :document_token_id, :content_type, :url
+  private attr_reader :document_token_create_service
+
+  validates :document_token_id_or_document_id, presence: true
+  validates :content_type, presence: true, if: -> { document_token_id.present? }
+
+  validates :content_type, on: :request,
+    inclusion: {
+      in:      CONTENT_TYPES,
+      message: "has to be one of #{CONTENT_TYPES.to_sentence(last_word_connector: ' or ')}"
+    }
+
+  validate on: :request do
+    if document_token_id.blank? && !document_token_create_service.success?
+      errors.merge!(document_token_create_service.errors)
+    end
+  end
+
+  before_call :create_document_token, :set_document_token_id_and_content_type, if: -> { document_token_id.blank? }
+
+  def initialize(document_id: nil, document_token_id: nil, content_type: nil)
+    @document_id       = document_id
+    @document_token_id = document_token_id
+    @content_type      = content_type
+  end
+
+  # Download a document file.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Download-Documents/paths/~1api~1v2~1document_file_downloads~1%7Bdocument_token_id%7D/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::Document::DownloadService.call(document_token_id: '', content_type: 'image/png')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   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.
+  #
+  #   service = DocFox::Document::DownloadService.call(document_id: '')
+  #
+  # GET /api/v2/document_file_downloads/:document_token_id
+  def call
+    connection.get("document_file_downloads/#{document_token_id}", nil, { 'Accept' => content_type })
+  end
+
+  private
+
+  def document_token_id_or_document_id
+    document_token_id.presence || document_id.presence
+  end
+
+  def create_document_token
+    @document_token_create_service = DocFox::DocumentToken::CreateService.call(
+      document_id: document_id,
+      data:        { type: 'document_token' }
+    )
+  end
+
+  def set_document_token_id_and_content_type
+    return unless document_token_create_service.success?
+
+    @document_token_id = document_token_create_service.id
+    @content_type      = document_token_create_service.content_type
+  end
+end

data/lib/doc_fox/document/facade.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class DocFox::Document::Facade
+  attr_reader :id, :attributes, :relationships, :included, :content_type, :created_at, :data_capture_fields, :filename,
+    :token, :token_expiry, :uploaded_by, :updated_at
+
+  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']
+
+    @content_type        = attributes['content_type']
+    @created_at          = attributes['created_at']
+    @data_capture_fields = attributes['data_capture_fields']
+    @filename            = attributes['filename']
+    @token               = attributes['token']
+    @token_expiry        = attributes['token_expiry']
+    @uploaded_by         = attributes['uploaded_by']
+    @updated_at          = attributes['updated_at']
+  end
+end

data/lib/doc_fox/document/get_service.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class DocFox::Document::GetService < DocFox::BaseService
+  attr_reader :id, :params
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, params: {})
+    @id     = id
+    @params = params
+  end
+
+  # Get a document.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Documents/paths/~1api~1v2~1documents~1%7Bdocument_id%7D/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::Document::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::Document::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  #   service.relationships.dig('evidence_submissions', 'data')
+  #   service.relationships.dig('document_tokens', 'links', 'related')
+  #
+  # Include related resources.
+  #
+  #   service = DocFox::Document::GetService.call(id: '', params: { include: 'evidence_submissions' })
+  #   service.included
+  #
+  # GET /api/v2/documents/:id
+  def call
+    connection.get("documents/#{id}", **params)
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::Document::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/document/list_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class DocFox::Document::ListService < DocFox::BaseService
+  include DocFox::Enumerable
+
+  attr_reader :evidence_submission_id
+
+  validates :evidence_submission_id, presence: true
+
+  # List documents.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Documents/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1documents/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::Document::ListService.call(evidence_submission_id: '').first
+  #   service.id
+  #   service.filename
+  #
+  # 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.
+  #
+  #   DocFox::Document::ListService.call(evidence_submission_id: '', page: 1, per_page: 10).map { _1 }
+  #
+  # GET /api/v2/evidence_submissions/:evidence_submission_id/documents
+  def initialize(evidence_submission_id:, page: 1, per_page: Float::INFINITY)
+    @evidence_submission_id = evidence_submission_id
+
+    super(
+      path:         "evidence_submissions/#{evidence_submission_id}/documents",
+      facade_klass: DocFox::Document::Facade,
+      page:         page,
+      per_page:     per_page
+    )
+  end
+end

data/lib/doc_fox/document/upload_service.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class DocFox::Document::UploadService < DocFox::BaseService
+  attr_reader :evidence_submission_id, :data
+
+  validates :evidence_submission_id, :data, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(evidence_submission_id:, data:)
+    @evidence_submission_id = evidence_submission_id
+    @data                   = data
+  end
+
+  # Upload a document file.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Document-Uploads/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1documents/post
+  #
+  # ==== Examples
+  #
+  #   service = 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'))}"
+  #       }
+  #     }
+  #   )
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 201
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::Document::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # POST /api/v2/evidence_submissions/:evidence_submission_id/documents
+  def call
+    connection.post("evidence_submissions/#{evidence_submission_id}/documents", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: data
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::Document::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/document_token/create_service.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class DocFox::DocumentToken::CreateService < DocFox::BaseService
+  attr_reader :document_id, :data
+
+  validates :document_id, :data, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(document_id:, data:)
+    @document_id = document_id
+    @data        = data
+  end
+
+  # Create a document token.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Document-Tokens/paths/~1api~1v2~1documents~1%7Bdocument_id%7D~1document_tokens/post
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::DocumentToken::CreateService.call(
+  #     document_id: '',
+  #     data: {
+  #       type: 'document_token'
+  #     }
+  #   )
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 201
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::DocumentToken::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # POST /api/v2/documents/:document_id/document_tokens
+  def call
+    connection.post("documents/#{document_id}/document_tokens", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: data
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::DocumentToken::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/document_token/facade.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class DocFox::DocumentToken::Facade
+  attr_reader :id, :attributes, :content_type, :created_at, :expiry, :updated_at
+
+  def initialize(hash)
+    @id         = hash.dig('data', 'id') || hash['id']
+    @attributes = hash.dig('data', 'attributes') || hash['attributes']
+
+    @content_type = attributes['content_type']
+    @created_at   = attributes['created_at']
+    @expiry       = attributes['expiry']
+    @updated_at   = attributes['updated_at']
+  end
+end

data/lib/doc_fox/document_token/get_service.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class DocFox::DocumentToken::GetService < DocFox::BaseService
+  attr_reader :id, :params
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, params: {})
+    @id     = id
+    @params = params
+  end
+
+  # Get a document token.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Document-Tokens/paths/~1api~1v2~1document_tokens~1%7Bdocument_token_id%7D/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::DocumentToken::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::DocumentToken::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # GET /api/v2/document_tokens/:id
+  def call
+    connection.get("document_tokens/#{id}", **params)
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::DocumentToken::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/document_token/list_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class DocFox::DocumentToken::ListService < DocFox::BaseService
+  include DocFox::Enumerable
+
+  attr_reader :document_id
+
+  validates :document_id, presence: true
+
+  # List document tokens.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Document-Tokens/paths/~1api~1v2~1documents~1%7Bdocument_id%7D~1document_tokens/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::DocumentToken::ListService.call(document_id: '').first
+  #   service.id
+  #   service.expiry
+  #
+  # 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.
+  #
+  #   DocFox::DocumentToken::ListService.call(document_id: '', page: 1, per_page: 10).map { _1 }
+  #
+  # GET /api/v2/documents/:document_id/document_tokens
+  def initialize(document_id:, page: 1, per_page: Float::INFINITY)
+    @document_id = document_id
+
+    super(
+      path:         "documents/#{document_id}/document_tokens",
+      facade_klass: DocFox::DocumentToken::Facade,
+      page:         page,
+      per_page:     per_page
+    )
+  end
+end