active_call-zoho_sign 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba562fec7bae27b72ad781e923c0b1db6f0076568a170769ed9490dd0927ca9d
-  data.tar.gz: a2e7dc48e0a7b6cf7774e23a5b93be6026bf7c58b695598a79bd570a5a3e84a0
+  metadata.gz: d081ad9bfcfa500488f91ef33523321354c2e92125798dabf903b73455a36969
+  data.tar.gz: c1e116320af36f5a82b2c5fc438accc3417246c073957544e49ce31aa40baa1e
 SHA512:
-  metadata.gz: 309cf5cdb4c67fbb25e470000a3a81dd21c19209018ecd8e206a8be79ef396537bd5e835e928a0e39ed454bf92327ad9f44c5e77c07279b71ea752d408245a7f
-  data.tar.gz: ea0fd98f0da44b1c564a7f743187f71e3691cd820d8485700e6f21502bc5c9d308d9dcfe68e1e8ed0f2b75a27bffb3b7cafdeb7cfc7530389e656cb4d9105bfc
+  metadata.gz: 61d2c71ceb5d3cd761adf9bcba5c6b82c32df65de03059be03c53cf0b77756e591347cb93399ff01d0ef0cbef049aafd7dd5dbbf8cab204c6cad6ba823c404dc
+  data.tar.gz: 303712d85e4e32f67f060d0bfcffde7673d10f2c01f8b8e4f9890655097417b0bb53ef02ec75b79702049e0c9daf249ed2ecf7fdb9379418a0ae3756952dccfb

data/.rubocop.yml

@@ -45,7 +45,7 @@ Metrics/MethodLength:
 
 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,10 @@
+## [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`.

data/README.md

@@ -11,9 +11,7 @@ Zoho Sign exposes the [Zoho Sign API](https://www.zoho.com/sign/api) endpoints t
   - [Using call!](#using-call!)
   - [When to use call or call!](#using-call-or-call!)
   - [Using lists](#using-lists)
-  - [Documents](#documents)
-  - [Folders](#folders)
-  - [Templates](#templates)
+- [Service Objects](#service-objects)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -34,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.
@@ -173,7 +177,7 @@ rescue ZohoSign::RequestError => exception
 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)
 
@@ -192,7 +196,7 @@ An example of where to use `call!` would be in a **job** doing an asynchronous r
 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
@@ -210,6 +214,11 @@ If you don't provide the `limit` argument, multiple API requests will be made un
 
 Note that the `offset` argument starts at `1` for the first item.
 
+## Service Objects
+
+<details open>
+<summary>Documents</summary>
+
 ### Documents
 
 #### List documents
@@ -306,24 +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: ...
 
+</details>
+
+<details>
+<summary>Templates</summary>
+
 ### Templates
 
 #### 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
 ```
@@ -406,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

@@ -6,13 +6,13 @@ module ZohoSign::Enumerable
   included do
     include Enumerable
 
-    attr_reader :path, :list_key, :facade_klass, :limit, :offset
+    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:, limit: Float::INFINITY, offset: 1)
+  def initialize(path:, list_key:, facade_klass:, offset: 1, limit: Float::INFINITY)
     @path         = path
     @list_key     = list_key
     @facade_klass = facade_klass
@@ -41,6 +41,8 @@ module ZohoSign::Enumerable
           throw :list_end
         end
 
+        throw :list_end unless response.body
+
         response.body[list_key].each do |hash|
           yield facade_klass.new(hash)
           total += 1

data/lib/zoho_sign/document/list_service.rb

@@ -47,7 +47,7 @@ class ZohoSign::Document::ListService < ZohoSign::BaseService
   # and `created_time`.
   #
   # GET /api/v1/requests
-  def initialize(limit: Float::INFINITY, offset: 1, sort_column: 'created_time', sort_order: 'DESC', search_columns: {})
+  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

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/list_service.rb

@@ -46,7 +46,7 @@ class ZohoSign::Template::ListService < ZohoSign::BaseService
   # Columns to sort and filter by are `template_name`, `owner_first_name` and `modified_time`.
   #
   # GET /api/v1/templates
-  def initialize(limit: Float::INFINITY, offset: 1, sort_column: 'template_name', sort_order: 'DESC', search_columns: {})
+  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

data/lib/zoho_sign/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZohoSign
-  VERSION = '0.1.5'
+  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.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-03 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
@@ -124,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