active_call-doc_fox 0.1.0

data/lib/doc_fox/concerns/enumerable.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module DocFox::Enumerable
+  extend ActiveSupport::Concern
+
+  included do
+    include Enumerable
+
+    attr_reader :path, :facade_klass, :page, :per_page
+
+    validates :path, :facade_klass, presence: true
+    validates :page, :per_page, presence: true, numericality: { greater_than_or_equal_to: 1 }
+  end
+
+  def initialize(path:, facade_klass:, page: 1, per_page: Float::INFINITY)
+    @path         = path
+    @facade_klass = facade_klass
+    @page         = page
+    @per_page     = per_page
+  end
+
+  def call
+    self
+  end
+
+  def each
+    return to_enum(:each) unless block_given?
+    return if invalid?
+
+    total = 0
+
+    catch :list_end do
+      loop do
+        @response = connection.get(path, params)
+        validate(:response)
+
+        unless success?
+          raise exception_for(response, errors) if bang?
+
+          throw :list_end
+        end
+
+        response.body['data'].each do |hash|
+          yield facade_klass.new(hash)
+          total += 1
+          throw :list_end if total >= per_page
+        end
+
+        break if total >= response.body.dig('meta', 'total')
+
+        @_params[:page] = response.body.dig('meta', 'page') + 1
+      end
+    end
+  end
+
+  private
+
+  def params
+    @_params ||= { page: page, per_page: max_per_page_per_request }
+  end
+
+  def max_per_page_per_request
+    @_max_per_page_per_request ||= per_page.infinite? ? 100 : [per_page, 100].min
+  end
+end

data/lib/doc_fox/error.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module DocFox
+  class Error < StandardError; end
+
+  class ValidationError < Error
+    include ActiveCall::ValidationErrorable
+  end
+
+  class RequestError < Error
+    include ActiveCall::RequestErrorable
+  end
+
+  # 400..499
+  class ClientError < RequestError; end
+
+  # 400
+  class BadRequestError < ClientError; end
+
+  # 401
+  class UnauthorizedError < ClientError; end
+
+  # 403
+  class ForbiddenError < ClientError; end
+
+  # 404
+  class NotFoundError < ClientError; end
+
+  # 406
+  class NotAcceptableError < ClientError; end
+
+  # 407
+  class ProxyAuthenticationRequiredError < ClientError; end
+
+  # 408
+  class RequestTimeoutError < ClientError; end
+
+  # 409
+  class ConflictError < ClientError; end
+
+  # 410
+  class GoneError < ClientError; end
+
+  # 422
+  class UnprocessableEntityError < ClientError; end
+
+  # 429
+  class TooManyRequestsError < ClientError; end
+
+  # 500..599
+  class ServerError < RequestError; end
+
+  # 500
+  class InternalServerError < ServerError; end
+
+  # 501
+  class NotImplementedError < ServerError; end
+
+  # 502
+  class BadGatewayError < ServerError; end
+
+  # 503
+  class ServiceUnavailableError < ServerError; end
+
+  # 504
+  class GatewayTimeoutError < ServerError; end
+end

data/lib/doc_fox/kyc_application/approve_service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::ApproveService < DocFox::BaseService
+  attr_reader :id
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:)
+    @id = id
+  end
+
+  # Approve a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::ApproveService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::KycApplication::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # PATCH /api/v2/kyc_applications/:id/approve
+  def call
+    connection.patch("kyc_applications/#{id}/approve", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type:       'kyc_application',
+        id:         id,
+        attributes: {}
+      }
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::KycApplication::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_application/archive_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::ArchiveService < DocFox::BaseService
+  attr_reader :id, :reason
+
+  validates :id, :reason, presence: true
+
+  def initialize(id:, reason:)
+    @id     = id
+    @reason = reason
+  end
+
+  # Archive a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::ArchiveService.call(id: '', reason: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 204
+  #   service.response.body # => ""
+  #
+  # POST /api/v2/kyc_applications/:id/archive
+  def call
+    connection.post("kyc_applications/#{id}/archive", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type:       'application_archiving',
+        attributes: {
+          reason: reason
+        }
+      }
+    }
+  end
+end

data/lib/doc_fox/kyc_application/create_service.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::CreateService < DocFox::BaseService
+  attr_reader :data
+
+  validates :data, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(data:)
+    @data = data
+  end
+
+  # Create a KYC application.
+  #
+  # ==== Examples
+  #
+  #   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.
+  #       }
+  #     }
+  #   )
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 201
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::KycApplication::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # POST /api/v2/kyc_applications
+  def call
+    connection.post('kyc_applications', **params)
+  end
+
+  private
+
+  def params
+    {
+      data: data
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::KycApplication::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_application/delete_service.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::DeleteService < DocFox::BaseService
+  attr_reader :id
+
+  validates :id, presence: true
+
+  def initialize(id:)
+    @id = id
+  end
+
+  # Delete a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::DeleteService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 204
+  #   service.response.body # => ""
+  #
+  # DELETE /api/v2/kyc_applications/:id
+  def call
+    connection.delete("kyc_applications/#{id}")
+  end
+end

data/lib/doc_fox/kyc_application/facade.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::Facade
+  attr_reader :id, :attributes, :relationships, :included, :approved_at, :archived, :archived_reason, :created_at,
+    :kyc_entity_type_name, :renew_at, :status, :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']
+
+    @approved_at          = attributes['approved_at']
+    @archived             = attributes['archived']
+    @archived_reason      = attributes['archived_reason']
+    @created_at           = attributes['created_at']
+    @kyc_entity_type_name = attributes['kyc_entity_type_name']
+    @renew_at             = attributes['renew_at']
+    @status               = attributes['status']
+    @updated_at           = attributes['updated_at']
+  end
+end

data/lib/doc_fox/kyc_application/get_service.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::GetService < DocFox::BaseService
+  attr_reader :id, :params
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  validates :id, presence: true
+
+  def initialize(id:, params: {})
+    @id     = id
+    @params = params
+  end
+
+  # Get a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::KycApplication::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  #   service.relationships.dig('profile', 'data', 'id')
+  #   service.relationships.dig('data_requirements', 'links', 'related')
+  #
+  # Include related resources.
+  #
+  #   service = DocFox::KycApplication::GetService.call(id: '', params: { include: 'managed_by,profile.names' })
+  #   service.included
+  #
+  # GET /api/v2/kyc_applications/:id
+  def call
+    connection.get("kyc_applications/#{id}", params)
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::KycApplication::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_application/list_service.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::ListService < DocFox::BaseService
+  include DocFox::Enumerable
+
+  attr_reader :search_term
+
+  # List KYC applications.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::ListService.call.first
+  #   service.id
+  #   service.status
+  #
+  # 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::KycApplication::ListService.call(page: 1, per_page: 10).map { _1 }
+  #
+  # Filter by names, numbers contact information or external refs.
+  #
+  #   DocFox::KycApplication::ListService.call(search_term: 'eric.cartman@example.com').map { _1 }
+  #
+  # GET /api/v2/kyc_applications
+  def initialize(page: 1, per_page: Float::INFINITY, search_term: nil)
+    @search_term = search_term
+
+    super(
+      path:         'kyc_applications',
+      facade_klass: DocFox::KycApplication::Facade,
+      page:         page,
+      per_page:     per_page
+    )
+  end
+
+  private
+
+  def params
+    @_params ||= begin
+      params          = { page: page, per_page: max_per_page_per_request }
+      params[:filter] = { search_term: search_term } if search_term.present?
+      params
+    end
+  end
+end

data/lib/doc_fox/kyc_application/transfer_service.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::TransferService < DocFox::BaseService
+  attr_reader :id, :transfer_to_user_id
+
+  validates :id, :transfer_to_user_id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, transfer_to_user_id:)
+    @id                  = id
+    @transfer_to_user_id = transfer_to_user_id
+  end
+
+  # Transfer a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::TransferService.call(id: '', transfer_to_user_id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::KycApplication::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # PATCH /api/v2/kyc_applications/:id/transfer
+  def call
+    connection.patch("kyc_applications/#{id}/transfer", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type:       'kyc_application',
+        id:         id,
+        attributes: {
+          transfer_to_user_id: transfer_to_user_id
+        }
+      }
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::KycApplication::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_application/unapprove_service.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::UnapproveService < DocFox::BaseService
+  attr_reader :id, :reason
+
+  validates :id, :reason, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, reason:)
+    @id     = id
+    @reason = reason
+  end
+
+  # Unapprove a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::UnapproveService.call(id: '', reason: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::KycApplication::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # PATCH /api/v2/kyc_applications/:id/unapprove
+  def call
+    connection.patch("kyc_applications/#{id}/unapprove", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type:       'kyc_application',
+        id:         id,
+        attributes: {
+          reason: reason
+        }
+      }
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::KycApplication::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_application/unarchive_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class DocFox::KycApplication::UnarchiveService < DocFox::BaseService
+  attr_reader :id, :reason
+
+  validates :id, :reason, presence: true
+
+  def initialize(id:, reason:)
+    @id     = id
+    @reason = reason
+  end
+
+  # Unarchive a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycApplication::UnarchiveService.call(id: '', reason: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 204
+  #   service.response.body # => ""
+  #
+  # POST /api/v2/kyc_applications/:id/unarchive
+  def call
+    connection.post("kyc_applications/#{id}/unarchive", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type:       'application_archiving',
+        attributes: {
+          reason: reason
+        }
+      }
+    }
+  end
+end

data/lib/doc_fox/kyc_entity_template/facade.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class DocFox::KycEntityTemplate::Facade
+  attr_reader :id, :attributes, :created_at, :kyc_entity_type_name, :kyc_entity_type_category, :profile_schema,
+    :updated_at
+
+  def initialize(hash)
+    @id         = hash.dig('data', 'id') || hash['id']
+    @attributes = hash.dig('data', 'attributes') || hash['attributes']
+
+    @created_at               = attributes['created_at']
+    @kyc_entity_type_name     = attributes['kyc_entity_type_name']
+    @kyc_entity_type_category = attributes['kyc_entity_type_category']
+    @profile_schema           = attributes['profile_schema']
+    @updated_at               = attributes['updated_at']
+  end
+end

data/lib/doc_fox/kyc_entity_template/get_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class DocFox::KycEntityTemplate::GetService < DocFox::BaseService
+  attr_reader :id
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  validates :id, presence: true
+
+  def initialize(id:)
+    @id = id
+  end
+
+  # Get a KYC application.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycEntityTemplate::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::KycEntityTemplate::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # GET /api/v2/kyc_entity_templates/:id
+  def call
+    connection.get("kyc_entity_templates/#{id}")
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::KycEntityTemplate::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_entity_template/list_service.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DocFox::KycEntityTemplate::ListService < DocFox::BaseService
+  include DocFox::Enumerable
+
+  # List KYC entity templates.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::KycEntityTemplate::ListService.call.first
+  #   service.id
+  #   service.kyc_entity_type_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::KycEntityTemplate::ListService.call(page: 1, per_page: 10).map { _1 }
+  #
+  # GET /api/v2/kyc_entity_templates
+  def initialize(page: 1, per_page: Float::INFINITY)
+    super(
+      path:         'kyc_entity_templates',
+      facade_klass: DocFox::KycEntityTemplate::Facade,
+      page:         page,
+      per_page:     per_page
+    )
+  end
+end