active_call-zoho_sign 0.1.0

data/lib/zoho_sign/document/update_service.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class ZohoSign::Document::UpdateService < ZohoSign::BaseService
+  attr_reader :id, :data
+
+  validates :id, :data, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, data:)
+    @id   = id
+    @data = data
+  end
+
+  # Update a document.
+  #
+  # ==== Examples
+  #
+  #   service = ZohoSign::Document::UpdateService.call(
+  #     id: '',
+  #     data: {
+  #       requests: {
+  #         request_name: 'Name Updated',
+  #         actions: [{
+  #           action_id: '',
+  #           action_type: 'SIGN',
+  #           recipient_email: 'stan.marsh@example.com',
+  #           recipient_name: 'Stan Marsh'
+  #         }]
+  #       }
+  #     }
+  #   )
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<ZohoSign::Document::Facade ...>
+  #   service.facade.request_name
+  #   service.request_name
+  #
+  # PUT /api/v1/requests/:id
+  def call
+    connection.put("requests/#{id}", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: data.to_json
+    }
+  end
+
+  def set_facade
+    @facade = ZohoSign::Document::Facade.new(response.body['requests'])
+  end
+end

data/lib/zoho_sign/error.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ZohoSign
+  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
+
+  # 407
+  class ProxyAuthenticationRequiredError < ClientError; end
+
+  # 408
+  class RequestTimeoutError < ClientError; end
+
+  # 409
+  class ConflictError < ClientError; end
+
+  # 422
+  class UnprocessableEntityError < ClientError; end
+
+  # 429
+  class TooManyRequestsError < ClientError; end
+
+  # 500..599
+  class ServerError < RequestError; end
+end

data/lib/zoho_sign/locale/en.yml

@@ -0,0 +1,18 @@
+en:
+  activemodel:
+    errors:
+      # The values :model, :attribute and :value are always available for interpolation.
+      # The value :count is available when applicable. Can be used for pluralization.
+      models:
+        zoho_sign/base_service:
+          bad_request: 'Bad Request'
+          client_error: 'Client Error'
+          conflict: 'Conflict'
+          forbidden: 'Forbidden'
+          not_found: 'Not Found'
+          proxy_authentication_required: 'Proxy Authentication Required'
+          request_timeout: 'Request Timeout'
+          server_error: 'Server Error'
+          too_many_requests: 'Too Many Requests'
+          unauthorized: 'Unauthorized'
+          unprocessable_entity: 'Unprocessable Entity'

data/lib/zoho_sign/template/document/create_service.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class ZohoSign::Template::Document::CreateService < ZohoSign::BaseService
+  attr_reader :id, :data, :is_quicksend
+
+  validates :id, :data, presence: true
+  validates :is_quicksend, inclusion: { in: [true, false] }
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, data:, is_quicksend: false)
+    @id           = id
+    @data         = data
+    @is_quicksend = is_quicksend
+  end
+
+  # Create a document from a template.
+  #
+  # ==== Examples
+  #
+  #   service = ZohoSign::Template::Document::CreateService.call!(
+  #     id: '',
+  #     is_quicksend: true,
+  #     data: {
+  #       templates: {
+  #         request_name: 'Request Document',
+  #         field_data: {
+  #           field_text_data: {
+  #             'Full name' => 'Eric Cartman',
+  #             'Email' => 'eric.cartman@example.com'
+  #           },
+  #           field_boolean_data: {
+  #             'Agreed to terms' => true
+  #           },
+  #           field_date_data: {
+  #             'Inception date' => '31/01/2025'
+  #           }
+  #         },
+  #         actions: [{
+  #           action_type: 'SIGN',
+  #           recipient_email: 'eric.cartman@example.com',
+  #           recipient_name: 'Eric Cartman',
+  #           verify_recipient: false,
+  #           delivery_mode: 'EMAIL',
+  #           action_id: '',
+  #           role: 'Client'
+  #         }]
+  #       }
+  #     }
+  #   )
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<ZohoSign::Temlate::Document::Facade ...>
+  #   service.facade.request_name
+  #   service.request_name
+  #
+  # POST /api/v1/templates/:id/createdocument
+  def call
+    connection.post("templates/#{id}/createdocument", **params)
+  end
+
+  private
+
+  def params
+    {
+      data:         data.to_json,
+      is_quicksend: is_quicksend
+    }
+  end
+
+  def set_facade
+    @facade = ZohoSign::Template::Document::Facade.new(response.body['requests'])
+  end
+end

data/lib/zoho_sign/template/document/facade.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class ZohoSign::Template::Document::Facade
+  attr_reader :action_time, :actions, :created_time, :description, :document_fields, :document_ids, :email_reminders,
+    :expiration_days, :expire_by, :folder_id, :folder_name, :in_process, :is_deleted, :is_expiring, :is_sequential,
+    :modified_time, :notes, :owner_email, :owner_first_name, :owner_id, :owner_last_name, :reminder_period, :request_id,
+    :request_name, :request_status, :request_type_id, :request_type_name, :self_sign, :sign_percentage,
+    :sign_submitted_time, :template_ids, :templates_used, :validity, :visible_sign_settings, :zsdocumentid
+
+  def initialize(hash)
+    @action_time           = hash['action_time']
+    @actions               = hash['actions']
+    @created_time          = hash['created_time']
+    @description           = hash['description']
+    @document_fields       = hash['document_fields']
+    @document_ids          = hash['document_ids']
+    @email_reminders       = hash['email_reminders']
+    @expiration_days       = hash['expiration_days']
+    @expire_by             = hash['expire_by']
+    @folder_id             = hash['folder_id']
+    @folder_name           = hash['folder_name']
+    @in_process            = hash['in_process']
+    @is_deleted            = hash['is_deleted']
+    @is_expiring           = hash['is_expiring']
+    @is_sequential         = hash['is_sequential']
+    @modified_time         = hash['modified_time']
+    @notes                 = hash['notes']
+    @owner_email           = hash['owner_email']
+    @owner_first_name      = hash['owner_first_name']
+    @owner_id              = hash['owner_id']
+    @owner_last_name       = hash['owner_last_name']
+    @reminder_period       = hash['reminder_period']
+    @request_id            = hash['request_id']
+    @request_name          = hash['request_name']
+    @request_status        = hash['request_status']
+    @request_type_id       = hash['request_type_id']
+    @request_type_name     = hash['request_type_name']
+    @self_sign             = hash['self_sign']
+    @sign_percentage       = hash['sign_percentage']
+    @sign_submitted_time   = hash['sign_submitted_time']
+    @template_ids          = hash['template_ids']
+    @templates_used        = hash['templates_used']
+    @validity              = hash['validity']
+    @visible_sign_settings = hash['visible_sign_settings']
+    @zsdocumentid          = hash['zsdocumentid']
+  end
+end

data/lib/zoho_sign/template/facade.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class ZohoSign::Template::Facade
+  attr_reader :actions, :created_time, :description, :document_ids, :document_fields, :email_reminders,
+    :expiration_days, :folder_id, :folder_name, :is_deleted, :is_sequential, :modified_time, :notes, :owner_email,
+    :owner_first_name, :owner_id, :owner_last_name, :reminder_period, :request_type_id, :request_type_name,
+    :signform_count, :template_id, :template_name, :validity
+
+  def initialize(hash)
+    @actions           = hash['actions']
+    @created_time      = hash['created_time']
+    @description       = hash['description']
+    @document_fields   = hash['document_fields']
+    @document_ids      = hash['document_ids']
+    @email_reminders   = hash['email_reminders']
+    @expiration_days   = hash['expiration_days']
+    @folder_id         = hash['folder_id']
+    @folder_name       = hash['folder_name']
+    @is_deleted        = hash['is_deleted']
+    @is_sequential     = hash['is_sequential']
+    @modified_time     = hash['modified_time']
+    @notes             = hash['notes']
+    @owner_email       = hash['owner_email']
+    @owner_first_name  = hash['owner_first_name']
+    @owner_id          = hash['owner_id']
+    @owner_last_name   = hash['owner_last_name']
+    @reminder_period   = hash['reminder_period']
+    @request_type_id   = hash['request_type_id']
+    @request_type_name = hash['request_type_name']
+    @signform_count    = hash['signform_count']
+    @template_id       = hash['template_id']
+    @template_name     = hash['template_name']
+    @validity          = hash['validity']
+  end
+end

data/lib/zoho_sign/template/get_service.rb

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

data/lib/zoho_sign/template/list_service.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class ZohoSign::Template::ListService < ZohoSign::BaseService
+  SORT_COLUMNS = %w[template_name owner_first_name modified_time].freeze
+  SORT_ORDERS  = %w[ASC DESC].freeze
+
+  include Enumerable
+
+  attr_reader :limit, :offset, :sort_column, :sort_order, :search_columns
+
+  validates :limit, presence: true, numericality: { greater_than_or_equal_to: 1 }
+  validates :sort_order, inclusion: { in: SORT_ORDERS, message: "Sort order must be one of #{SORT_ORDERS.join(', ')}" }
+
+  validates :sort_column, inclusion: {
+    in:      SORT_COLUMNS,
+    message: "Sort column must be one of #{SORT_COLUMNS.join(', ')}"
+  }
+
+  validate do
+    next if search_columns.empty?
+    next if (SORT_COLUMNS | search_columns.keys.map(&:to_s)).size == SORT_COLUMNS.size
+
+    errors.add(:search_columns, "keys must be one of #{SORT_COLUMNS.join(', ')}")
+    throw :abort
+  end
+
+  def initialize(limit: Float::INFINITY, offset: 1, sort_column: 'template_name', sort_order: 'DESC', search_columns: {})
+    @limit          = limit
+    @offset         = offset
+    @sort_column    = sort_column
+    @sort_order     = sort_order
+    @search_columns = search_columns
+  end
+
+  # List documents.
+  #
+  # ==== Examples
+  #
+  #   service = ZohoSign::Template::ListService.call.first
+  #   service.request_name
+  #
+  #   ZohoSign::Template::ListService.call(offset: 11, limit: 10).each { _1 }
+  #   ZohoSign::Template::ListService.call(sort_column: 'template_name', sort_order: 'ASC').each { _1 }
+  #   ZohoSign::Template::ListService.call(search_columns: { template_name: 'Eric Template' }).each { _1 }
+  #
+  # GET /api/v1/templates
+  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('templates', data: params.to_json)
+        validate(:response)
+
+        unless success?
+          raise exception_for(response, errors) if bang?
+
+          throw :list_end
+        end
+
+        response.body['templates'].each do |hash|
+          yield ZohoSign::Template::Facade.new(hash)
+          total += 1
+          throw :list_end if total >= limit
+        end
+
+        break unless response.body.dig('page_context', 'has_more_rows')
+
+        @_params[:page_context][:start_index] += max_limit_per_request
+      end
+    end
+  end
+
+  private
+
+  def params
+    @_params ||= {
+      page_context: {
+        row_count:      max_limit_per_request,
+        start_index:    offset,
+        search_columns: search_columns,
+        sort_column:    sort_column,
+        sort_order:     sort_order
+      }
+    }
+  end
+
+  def max_limit_per_request
+    @_max_limit_per_request ||= limit.infinite? ? 100 : [limit, 100].min
+  end
+end

data/lib/zoho_sign/version.rb

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

data/lib/zoho_sign.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_call'
+require 'faraday'
+require 'faraday/retry'
+require 'faraday/multipart'
+require 'faraday/logging/color_formatter'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/zoho_sign/error.rb")
+loader.collapse("#{__dir__}/zoho_sign/concerns")
+loader.setup
+
+require_relative 'zoho_sign/error'
+require_relative 'zoho_sign/version'
+
+module ZohoSign; end
+
+ActiveSupport.on_load(:i18n) do
+  I18n.load_path << File.expand_path('zoho_sign/locale/en.yml', __dir__)
+end

data/sig/zoho_sign.rbs

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: active_call-zoho_sign
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kobus Joubert
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_call
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faraday-logging-color_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Zoho Sign exposes the Zoho Sign 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/zoho_sign.rb
+- lib/zoho_sign/access_token/facade.rb
+- lib/zoho_sign/access_token/get_service.rb
+- lib/zoho_sign/base_service.rb
+- lib/zoho_sign/current_user/facade.rb
+- lib/zoho_sign/current_user/get_service.rb
+- lib/zoho_sign/document/action/embed_token/facade.rb
+- lib/zoho_sign/document/action/embed_token/get_service.rb
+- lib/zoho_sign/document/create_service.rb
+- lib/zoho_sign/document/delete_service.rb
+- lib/zoho_sign/document/facade.rb
+- lib/zoho_sign/document/get_service.rb
+- lib/zoho_sign/document/list_service.rb
+- lib/zoho_sign/document/update_service.rb
+- lib/zoho_sign/error.rb
+- lib/zoho_sign/locale/en.yml
+- lib/zoho_sign/template/document/create_service.rb
+- lib/zoho_sign/template/document/facade.rb
+- lib/zoho_sign/template/facade.rb
+- lib/zoho_sign/template/get_service.rb
+- lib/zoho_sign/template/list_service.rb
+- lib/zoho_sign/version.rb
+- sig/zoho_sign.rbs
+homepage: https://github.com/kobusjoubert/zoho_sign
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/kobusjoubert/zoho_sign
+  source_code_uri: https://github.com/kobusjoubert/zoho_sign
+  changelog_uri: https://github.com/kobusjoubert/zoho_sign/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: Zoho Sign
+test_files: []