active_call-doc_fox 0.1.0

data/lib/doc_fox/user/facade.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class DocFox::User::Facade
+  attr_reader :id, :attributes, :deactivated, :deactivation_date, :email, :first_names, :last_names
+
+  def initialize(hash)
+    @id         = hash.dig('data', 'id') || hash['id']
+    @attributes = hash.dig('data', 'attributes') || hash['attributes']
+
+    @deactivated       = attributes['deactivated']
+    @deactivation_date = attributes['deactivation_date']
+    @email             = attributes['email']
+    @first_names       = attributes['first_names']
+    @last_names        = attributes['last_names']
+  end
+end

data/lib/doc_fox/user/get_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class DocFox::User::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 user.
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::User::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::User::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # GET /api/v2/users/:id
+  def call
+    connection.get("users/#{id}")
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::User::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/user/list_service.rb

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

data/lib/doc_fox/version.rb

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

data/lib/doc_fox.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_call'
+require 'active_call/api'
+require 'active_support/core_ext/time'
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/active_call-doc_fox.rb")
+loader.ignore("#{__dir__}/doc_fox/error.rb")
+loader.collapse("#{__dir__}/doc_fox/concerns")
+loader.setup
+
+require_relative 'doc_fox/error'
+require_relative 'doc_fox/version'
+
+module DocFox; end

data/sig/doc_fox.rbs

@@ -0,0 +1,4 @@
+module DocFox
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: active_call-doc_fox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kobus Joubert
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_call-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: DocFox exposes the nCino KYC DocFox API endpoints through service objects.
+email:
+- kobus@translate3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_call-doc_fox.rb
+- lib/doc_fox.rb
+- lib/doc_fox/access_token/facade.rb
+- lib/doc_fox/access_token/get_service.rb
+- lib/doc_fox/authentication/facade.rb
+- lib/doc_fox/authentication/get_service.rb
+- lib/doc_fox/base_service.rb
+- lib/doc_fox/concerns/enumerable.rb
+- lib/doc_fox/error.rb
+- lib/doc_fox/kyc_application/approve_service.rb
+- lib/doc_fox/kyc_application/archive_service.rb
+- lib/doc_fox/kyc_application/create_service.rb
+- lib/doc_fox/kyc_application/delete_service.rb
+- lib/doc_fox/kyc_application/facade.rb
+- lib/doc_fox/kyc_application/get_service.rb
+- lib/doc_fox/kyc_application/list_service.rb
+- lib/doc_fox/kyc_application/transfer_service.rb
+- lib/doc_fox/kyc_application/unapprove_service.rb
+- lib/doc_fox/kyc_application/unarchive_service.rb
+- lib/doc_fox/kyc_entity_template/facade.rb
+- lib/doc_fox/kyc_entity_template/get_service.rb
+- lib/doc_fox/kyc_entity_template/list_service.rb
+- lib/doc_fox/user/facade.rb
+- lib/doc_fox/user/get_service.rb
+- lib/doc_fox/user/list_service.rb
+- lib/doc_fox/version.rb
+- sig/doc_fox.rbs
+homepage: https://github.com/kobusjoubert/doc_fox
+licenses:
+- MIT
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: DocFox
+test_files: []