active_call-zoho_sign 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f5b979aa0e18b49ea40fa109aba4afd213e5c1935cde79c60b14b5ae700420a
-  data.tar.gz: 5c06f8ad0695d64905affc7c84432e39977d1531ac3e1aa94fcd9761c7fd2537
+  metadata.gz: d081ad9bfcfa500488f91ef33523321354c2e92125798dabf903b73455a36969
+  data.tar.gz: c1e116320af36f5a82b2c5fc438accc3417246c073957544e49ce31aa40baa1e
 SHA512:
-  metadata.gz: f928364c2384f5b4437c1712d9d09185d1b187e7c1f52d2a04f29c4478b37e09172a5c3231b4bb79d071818a90a3bf909a7fbcde785619490c04b7ad6498611f
-  data.tar.gz: 0d57d5710f292b8659b90c82a95cb6ac40c34feae262726e945aef322522fb59dcf45a8fb9a050d44a612aea88359e62eb028e7184f8f9fd4287a9de8b581958
+  metadata.gz: 61d2c71ceb5d3cd761adf9bcba5c6b82c32df65de03059be03c53cf0b77756e591347cb93399ff01d0ef0cbef049aafd7dd5dbbf8cab204c6cad6ba823c404dc
+  data.tar.gz: 303712d85e4e32f67f060d0bfcffde7673d10f2c01f8b8e4f9890655097417b0bb53ef02ec75b79702049e0c9daf249ed2ecf7fdb9379418a0ae3756952dccfb

data/.rubocop.yml

@@ -20,7 +20,8 @@ Layout/HashAlignment:
   EnforcedColonStyle: table
 
 Layout/LineLength:
-  AllowedPatterns: ['initialize']
+  AllowedPatterns:
+    - initialize
 
 Lint/MissingSuper:
   Enabled: false
@@ -37,15 +38,14 @@ Metrics/ClassLength:
 
 Metrics/CyclomaticComplexity:
   Exclude:
-    - lib/zoho_sign/document/list_service.rb
-    - lib/zoho_sign/template/list_service.rb
+    - lib/zoho_sign/concerns/enumerable.rb
 
 Metrics/MethodLength:
   Enabled: false
 
 Metrics/PerceivedComplexity:
   Exclude:
-    - lib/zoho_sign/document/list_service.rb
+    - lib/zoho_sign/concerns/enumerable.rb
 
 Naming/FileName:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.1.5] - 2025-04-05
+
+- Added `ZohoSign::GrantToken::GetService`.
+- Set access token in `before_call` hook instead of lambda so we can capture errors from the access token service objects.
+- Fixed empty list enumerable errors.
+- Remove spec dependencies already included in `active_call-api`.
+
+## [0.1.5] - 2025-04-03
+
+- Refactor list endpoints to use `ZohoSign::Enumerable`.
+
 ## [0.1.4] - 2025-03-31
 
 - Sign a document embedded link fix.

data/README.md

@@ -4,6 +4,18 @@
 
 Zoho Sign exposes the [Zoho Sign API](https://www.zoho.com/sign/api) 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)
+- [Service Objects](#service-objects)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -20,6 +32,12 @@ gem install active_call-zoho_sign
 
 ## Configuration
 
+Create a new **Self Client** client type from the [Zoho Developer Console](https://api-console.zoho.com) to retrieve your **Client ID** and **Client Secret**.
+
+Choose what you need from the list of [Zoho Scopes](https://www.zoho.com/sign/api/oauth.html) like `ZohoSign.documents.ALL` to generate your **Grant Token**.
+
+Get your **Refresh Token** by calling `ZohoSign::GrantToken::GetService.call(grant_token: '', client_id: '', client_secret: '').refresh_token`
+
 Configure your API credentials.
 
 In a Rails application, the standard practice is to place this code in a file named `zoho_sign.rb` within the `config/initializers` directory.
@@ -45,7 +63,7 @@ While testing, you can set your temporary development OAuth access token in the
 
 ## Usage
 
-### Using `.call`
+### <a name='using-call'></a>Using `call`
 
 Each service object returned will undergo validation before the `call` method is invoked to access API endpoints.
 
@@ -99,7 +117,7 @@ service.response.status # => 400
 service.response.body # => {"code"=>9004, "message"=>"No match found", "status"=>"failure"}
 ```
 
-### Using `.call!`
+### <a name='using-call!'></a>Using `call!`
 
 Each service object returned will undergo validation before the `call!` method is invoked to access API endpoints.
 
@@ -154,14 +172,14 @@ rescue ZohoSign::RequestError => exception
   exception.response.body # => {"code"=>9004, "message"=>"No match found", "status"=>"failure"}
 ```
 
-### When to use `.call` or `.call!`
+### <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.
+An example of where to use `call` would be in a **controller** doing an inline synchronous request.
 
 ```ruby
-class DocumentController < ApplicationController
+class SomeController < ApplicationController
   def update
-    @document = ZohoSign::Document::UpdateService.call(params)
+    @document = ZohoSign::Document::UpdateService.call(**params)
 
     if @document.success?
       redirect_to [@document], notice: 'Success', status: :see_other
@@ -173,31 +191,37 @@ class DocumentController < ApplicationController
 end
 ```
 
-An example of where to use `.call!` would be in a **job** doing an asynchronous request.
+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 DocumentJob < ApplicationJob
+class SomeJob < ApplicationJob
   discard_on ZohoSign::NotFoundError
 
   retry_on ZohoSign::RequestTimeoutError, wait: 5.minutes, attempts: :unlimited
   retry_on ZohoSign::TooManyRequestsError, wait: :polynomially_longer, attempts: 10
 
   def perform
-    ZohoSign::Document::UpdateService.call!(params)
+    ZohoSign::Document::UpdateService.call!(**params)
   end
 end
 ```
 
-### Documents
+### Using lists
 
-#### List documents.
+If you don't provide the `limit` argument, multiple API requests will be made untill all records have been returned. You could be rate limited, so use wisely.
 
-Note that the `offset` starts at `1` for the first item.
+Note that the `offset` argument starts at `1` for the first item.
+
+## Service Objects
+
+<details open>
+<summary>Documents</summary>
+
+### Documents
 
-If you don't provide a `limit`, multiple API requests will be made untill all records have been returned. You could be
-rate limited, so use wisely.
+#### List documents
 
 ```ruby
 service = ZohoSign::Document::ListService.call(offset: 1, limit: 10).each do |facade|
@@ -217,10 +241,9 @@ Filter by column.
 ZohoSign::Document::ListService.call(search_columns: { recipient_email: 'eric.cartman@example.com' }).map { _1 }
 ```
 
-Columns to sort and filter by are `request_name`, `folder_name`, `owner_full_name`, `recipient_email`,
-`form_name` `created_time`.
+Columns to sort and filter by are `request_name`, `folder_name`, `owner_full_name`, `recipient_email`, `form_name` and `created_time`.
 
-#### Get a document.
+#### Get a document
 
 ```ruby
 service = ZohoSign::Document::GetService.call(id: '')
@@ -235,7 +258,7 @@ service.sign_percentage
 ...
 ```
 
-#### Create a document.
+#### Create a document
 
 ```ruby
 service = ZohoSign::Document::CreateService.call(
@@ -258,7 +281,7 @@ service = ZohoSign::Document::CreateService.call(
 )
 ```
 
-#### Update a document.
+#### Update a document
 
 ```ruby
 service = ZohoSign::Document::UpdateService.call(
@@ -277,13 +300,13 @@ service = ZohoSign::Document::UpdateService.call(
 )
 ```
 
-#### Delete a document.
+#### Delete a document
 
 ```ruby
 service = ZohoSign::Document::DeleteService.call(id: '')
 ```
 
-#### Sign a document.
+#### Sign a document
 
 A unique signing URL will be generated, which will be valid for two minutes. If the signing page is not open by then, a new link needs to be generated and it is a one-time usable URL.
 
@@ -292,29 +315,44 @@ service = ZohoSign::Document::Action::EmbedToken::GetService.call(request_id: ''
 service.sign_url
 ```
 
+</details>
+
+<details>
+<summary>Folders</summary>
+
 ### Folders
 
 TODO: ...
 
+</details>
+
+<details>
+<summary>Field Types</summary>
+
 ### Field Types
 
 TODO: ...
 
+</details>
+
+<details>
+<summary>Request Types</summary>
+
 ### Request Types
 
 TODO: ...
 
-### Templates
+</details>
 
-#### List templates.
+<details>
+<summary>Templates</summary>
 
-Note that the `offset` starts at `1` for the first item.
+### Templates
 
-If you don't provide a `limit`, multiple API requests will be made untill all records have been returned. You could be
-rate limited, so use wisely.
+#### List templates
 
 ```ruby
-service = ZohoSign::Template::ListService.call(offset: 1, limit: 10).each do |facade|
+ZohoSign::Template::ListService.call(offset: 1, limit: 10).each do |facade|
   facade.description
 end
 ```
@@ -331,9 +369,9 @@ Filter by column.
 ZohoSign::Template::ListService.call(search_columns: { template_name: 'Eric Template' }).map { _1 }
 ```
 
-Columns to sort and filter by are `template_name`, `owner_first_name`, `modified_time`.
+Columns to sort and filter by are `template_name`, `owner_first_name` and `modified_time`.
 
-#### Get a template.
+#### Get a template
 
 ```ruby
 service = ZohoSign::Template::GetService.call(id: '')
@@ -348,19 +386,19 @@ service.template_name
 ...
 ```
 
-#### Create a template.
+#### Create a template
 
 TODO: ...
 
-#### Update a template.
+#### Update a template
 
 TODO: ...
 
-#### Delete a template.
+#### Delete a template
 
 TODO: ...
 
-#### Create document from template.
+#### Create document from template
 
 The auto filled fields specified in the `field_data` object should be marked as **Prefill by you** when creating the document template.
 
@@ -397,6 +435,8 @@ service = ZohoSign::Template::Document::CreateService.call!(
 )
 ```
 
+</details>
+
 ## 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.

data/lib/zoho_sign/access_token/get_service.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class ZohoSign::AccessToken::GetService < ZohoSign::BaseService
+  skip_callback :call, :before, :set_access_token
+
   after_call :set_facade
 
   delegate_missing_to :@facade
@@ -38,7 +40,6 @@ class ZohoSign::AccessToken::GetService < ZohoSign::BaseService
       client_id:     client_id,
       client_secret: client_secret,
       refresh_token: refresh_token,
-      redirect_uri:  'https://sign.zoho.com',
       grant_type:    'refresh_token'
     }
   end

data/lib/zoho_sign/base_service.rb

@@ -15,7 +15,15 @@ class ZohoSign::BaseService < ActiveCall::Base
   config_accessor :log_bodies, default: false, instance_writer: false
   config_accessor :client_id, :client_secret, :refresh_token, instance_writer: false
 
-  attr_reader :facade
+  attr_reader :access_token, :facade
+
+  before_call :set_access_token
+
+  validate on: :request do
+    next if is_a?(ZohoSign::AccessToken::GetService)
+
+    errors.merge!(access_token_service.errors) if access_token.nil? && !access_token_service.success?
+  end
 
   class << self
     def exception_mapping
@@ -32,6 +40,7 @@ class ZohoSign::BaseService < ActiveCall::Base
         proxy_authentication_required: ZohoSign::ProxyAuthenticationRequiredError,
         request_timeout:               ZohoSign::RequestTimeoutError,
         conflict:                      ZohoSign::ConflictError,
+        gone:                          ZohoSign::GoneError,
         unprocessable_entity:          ZohoSign::UnprocessableEntityError,
         too_many_requests:             ZohoSign::TooManyRequestsError,
         internal_server_error:         ZohoSign::InternalServerError,
@@ -48,7 +57,7 @@ class ZohoSign::BaseService < ActiveCall::Base
   def connection
     @_connection ||= Faraday.new do |conn|
       conn.url_prefix = base_url
-      conn.request :authorization, 'Zoho-oauthtoken', -> { access_token }
+      conn.request :authorization, 'Zoho-oauthtoken', access_token
       conn.request :multipart
       conn.request :url_encoded
       conn.request :retry
@@ -69,12 +78,18 @@ class ZohoSign::BaseService < ActiveCall::Base
     }
   end
 
-  def access_token
-    access_token = ENV['ZOHO_SIGN_ACCESS_TOKEN'].presence || cache.read(CACHE_KEY[:access_token])
-    return access_token if access_token.present?
+  def set_access_token
+    @access_token = ENV['ZOHO_SIGN_ACCESS_TOKEN'].presence || cache.read(CACHE_KEY[:access_token])
+    return if @access_token.present?
+    return unless access_token_service.success?
+
+    @access_token = cache.fetch(CACHE_KEY[:access_token], expires_in: [access_token_service.expires_in - 10, 0].max) do
+      access_token_service.facade.access_token
+    end
+  end
 
-    service = ZohoSign::AccessToken::GetService.call
-    cache.fetch(CACHE_KEY[:access_token], expires_in: [service.expires_in - 10, 0].max) { service.facade.access_token }
+  def access_token_service
+    @_access_token_service ||= ZohoSign::AccessToken::GetService.call
   end
 
   def forbidden?

data/lib/zoho_sign/concerns/enumerable.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ZohoSign::Enumerable
+  extend ActiveSupport::Concern
+
+  included do
+    include Enumerable
+
+    attr_reader :path, :list_key, :facade_klass, :offset, :limit
+
+    validates :path, :list_key, :facade_klass, presence: true
+    validates :limit, presence: true, numericality: { greater_than_or_equal_to: 1 }
+  end
+
+  def initialize(path:, list_key:, facade_klass:, offset: 1, limit: Float::INFINITY)
+    @path         = path
+    @list_key     = list_key
+    @facade_klass = facade_klass
+    @limit        = limit
+    @offset       = offset
+  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, data: params.to_json)
+        validate(:response)
+
+        unless success?
+          raise exception_for(response, errors) if bang?
+
+          throw :list_end
+        end
+
+        throw :list_end unless response.body
+
+        response.body[list_key].each do |hash|
+          yield facade_klass.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
+      }
+    }
+  end
+
+  def max_limit_per_request
+    @_max_limit_per_request ||= limit.infinite? ? 100 : [limit, 100].min
+  end
+end

data/lib/zoho_sign/document/get_service.rb

@@ -9,7 +9,7 @@ class ZohoSign::Document::GetService < ZohoSign::BaseService
 
   validates :id, presence: true
 
-  def initialize(id: nil)
+  def initialize(id:)
     @id = id
   end
 

data/lib/zoho_sign/document/list_service.rb

@@ -4,11 +4,10 @@ class ZohoSign::Document::ListService < ZohoSign::BaseService
   SORT_COLUMNS = %w[request_name folder_name owner_full_name recipient_email form_name created_time].freeze
   SORT_ORDERS  = %w[ASC DESC].freeze
 
-  include Enumerable
+  include ZohoSign::Enumerable
 
-  attr_reader :limit, :offset, :sort_column, :sort_order, :search_columns
+  attr_reader :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: {
@@ -24,14 +23,6 @@ class ZohoSign::Document::ListService < ZohoSign::BaseService
     throw :abort
   end
 
-  def initialize(limit: Float::INFINITY, offset: 1, sort_column: 'created_time', 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
@@ -39,43 +30,35 @@ class ZohoSign::Document::ListService < ZohoSign::BaseService
   #   service = ZohoSign::Document::ListService.call.first
   #   service.request_name
   #
+  # If you don't provide the `limit` argument, multiple API requests will be made untill all records have been returned.
+  # You could be rate limited, so use wisely.
+  #
   #   ZohoSign::Document::ListService.call(offset: 11, limit: 10).each { _1 }
-  #   ZohoSign::Document::ListService.call(sort_column: 'recipient_email', sort_order: 'ASC').each { _1 }
-  #   ZohoSign::Document::ListService.call(search_columns: { recipient_email: 'eric.cartman@example.com' }).each { _1 }
+  #
+  # Sort by column.
+  #
+  #   ZohoSign::Document::ListService.call(sort_column: 'recipient_email', sort_order: 'ASC').map { _1 }
+  #
+  # Filter by column.
+  #
+  #   ZohoSign::Document::ListService.call(search_columns: { recipient_email: 'eric.cartman@example.com' }).map { _1 }
+  #
+  # Columns to sort and filter by are `request_name`, `folder_name`, `owner_full_name`, `recipient_email`, `form_name`
+  # and `created_time`.
   #
   # GET /api/v1/requests
-  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('requests', data: params.to_json)
-        validate(:response)
-
-        unless success?
-          raise exception_for(response, errors) if bang?
-
-          throw :list_end
-        end
-
-        response.body['requests'].each do |hash|
-          yield ZohoSign::Document::Facade.new(hash)
-          total += 1
-          throw :list_end if total >= limit
-        end
-
-        break unless response.body.dig('page_context', 'has_more_rows')
+  def initialize(offset: 1, limit: Float::INFINITY, sort_column: 'created_time', sort_order: 'DESC', search_columns: {})
+    @sort_column    = sort_column
+    @sort_order     = sort_order
+    @search_columns = search_columns
 
-        @_params[:page_context][:start_index] += max_limit_per_request
-      end
-    end
+    super(
+      path:         'requests',
+      list_key:     'requests',
+      facade_klass: ZohoSign::Document::Facade,
+      limit:        limit,
+      offset:       offset
+    )
   end
 
   private
@@ -91,8 +74,4 @@ class ZohoSign::Document::ListService < ZohoSign::BaseService
       }
     }
   end
-
-  def max_limit_per_request
-    @_max_limit_per_request ||= limit.infinite? ? 100 : [limit, 100].min
-  end
 end

data/lib/zoho_sign/error.rb

@@ -38,6 +38,9 @@ module ZohoSign
   # 409
   class ConflictError < ClientError; end
 
+  # 410
+  class GoneError < ClientError; end
+
   # 422
   class UnprocessableEntityError < ClientError; end
 

data/lib/zoho_sign/grant_token/facade.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ZohoSign::GrantToken::Facade
+  attr_reader :access_token, :refresh_token, :scope, :api_domain, :expires_in, :token_type
+
+  def initialize(hash)
+    @access_token  = hash['access_token']
+    @api_domain    = hash['api_domain']
+    @expires_in    = hash['expires_in']
+    @refresh_token = hash['refresh_token']
+    @scope         = hash['scope']
+    @token_type    = hash['token_type']
+  end
+end

data/lib/zoho_sign/grant_token/get_service.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class ZohoSign::GrantToken::GetService < ZohoSign::BaseService
+  attr_reader :grant_token, :client_id, :client_secret
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+  delegate :refresh_token, to: :@facade, allow_nil: true
+
+  validates :grant_token, presence: true
+
+  def initialize(grant_token:, client_id: nil, client_secret: nil)
+    @grant_token   = grant_token
+    @client_id     = client_id.presence || ZohoSign::BaseService.client_id
+    @client_secret = client_secret.presence || ZohoSign::BaseService.client_secret
+  end
+
+  # Get refresh token from grant token.
+  #
+  # ==== Examples
+  #
+  #   service = ZohoSign::GrantToken::GetService.call(grant_token: '', client_id: '', client_secret: '')
+  #   service.refresh_token # => '1000.xxxx.yyyy'
+  #   service.expires_in # => 3600
+  #
+  # POST /oauth/v2/token
+  def call
+    connection.post('oauth/v2/token', params.to_param)
+  end
+
+  private
+
+  def connection
+    @_connection ||= Faraday.new do |conn|
+      conn.url_prefix = 'https://accounts.zoho.com'
+      conn.request :retry
+      conn.response :json
+      conn.response :logger, logger, **logger_options do |logger|
+        logger.filter(/(code|client_id|client_secret)=([^&]+)/i, '\1=[FILTERED]')
+        logger.filter(/"access_token":"([^"]+)"/i, '"access_token":"[FILTERED]"')
+        logger.filter(/"refresh_token":"([^"]+)"/i, '"refresh_token":"[FILTERED]"')
+      end
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  def params
+    {
+      client_id:     client_id,
+      client_secret: client_secret,
+      code:          grant_token,
+      grant_type:    'authorization_code'
+    }
+  end
+
+  def unauthorized?
+    response.status == 200 && response.body.key?('error')
+  end
+
+  def set_facade
+    @facade = ZohoCrm::GrantToken::Facade.new(response.body)
+  end
+end

data/lib/zoho_sign/template/get_service.rb

@@ -9,7 +9,7 @@ class ZohoSign::Template::GetService < ZohoSign::BaseService
 
   validates :id, presence: true
 
-  def initialize(id: nil)
+  def initialize(id:)
     @id = id
   end
 

data/lib/zoho_sign/template/list_service.rb

@@ -4,11 +4,10 @@ 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
+  include ZohoSign::Enumerable
 
-  attr_reader :limit, :offset, :sort_column, :sort_order, :search_columns
+  attr_reader :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: {
@@ -24,14 +23,6 @@ class ZohoSign::Template::ListService < ZohoSign::BaseService
     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
@@ -39,43 +30,34 @@ class ZohoSign::Template::ListService < ZohoSign::BaseService
   #   service = ZohoSign::Template::ListService.call.first
   #   service.request_name
   #
+  # If you don't provide the `limit` argument, multiple API requests will be made untill all records have been returned.
+  # You could be rate limited, so use wisely.
+  #
   #   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 }
+  #
+  # Sort by column.
+  #
+  #   ZohoSign::Template::ListService.call(sort_column: 'template_name', sort_order: 'ASC').map { _1 }
+  #
+  # Filter by column.
+  #
+  #   ZohoSign::Template::ListService.call(search_columns: { template_name: 'Eric Template' }).map { _1 }
+  #
+  # Columns to sort and filter by are `template_name`, `owner_first_name` and `modified_time`.
   #
   # 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')
+  def initialize(offset: 1, limit: Float::INFINITY, sort_column: 'template_name', sort_order: 'DESC', search_columns: {})
+    @sort_column    = sort_column
+    @sort_order     = sort_order
+    @search_columns = search_columns
 
-        @_params[:page_context][:start_index] += max_limit_per_request
-      end
-    end
+    super(
+      path:         'templates',
+      list_key:     'templates',
+      facade_klass: ZohoSign::Template::Facade,
+      limit:        limit,
+      offset:       offset
+    )
   end
 
   private
@@ -91,8 +73,4 @@ class ZohoSign::Template::ListService < ZohoSign::BaseService
       }
     }
   end
-
-  def max_limit_per_request
-    @_max_limit_per_request ||= limit.infinite? ? 100 : [limit, 100].min
-  end
 end

data/lib/zoho_sign/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_call-zoho_sign
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-05 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: active_call-api
   requirement: !ruby/object:Gem::Requirement
@@ -38,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !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
@@ -80,20 +38,6 @@ dependencies:
     - - "~>"
       - !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
@@ -112,6 +56,7 @@ files:
 - lib/zoho_sign/access_token/facade.rb
 - lib/zoho_sign/access_token/get_service.rb
 - lib/zoho_sign/base_service.rb
+- lib/zoho_sign/concerns/enumerable.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
@@ -123,6 +68,8 @@ files:
 - lib/zoho_sign/document/list_service.rb
 - lib/zoho_sign/document/update_service.rb
 - lib/zoho_sign/error.rb
+- lib/zoho_sign/grant_token/facade.rb
+- lib/zoho_sign/grant_token/get_service.rb
 - lib/zoho_sign/template/document/create_service.rb
 - lib/zoho_sign/template/document/facade.rb
 - lib/zoho_sign/template/facade.rb