active_call-zoho_sign 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 467acc9fbdcce17c52dbd1aefc3308d36769d371b3db5affb6de1a0b6428cef2
+  data.tar.gz: ddc9291cc32c8a3d6c238d98dfdbf5b18d540b1193d219c4527c5be53a1eda2a
+SHA512:
+  metadata.gz: 9542b5eaa353d895ecabb9f7424f3da2096ecd1d358b887a8f502294678384bf8ccacec711a38435d6fd7f0a4e7e79de7840ad11d5e9469a582cd268374a3c9f
+  data.tar.gz: 697afb22b9060a6fcc3370a7bb94d17e65c760a983b380ae664890fe71f2c407139ee34c089a9357785c4c7ff8a01a4830d262f648e89b280eac107134fe28d0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,70 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - zoho_sign.gemspec
+    - bin/*
+    - 'vendor/**/*'
+    - 'gem/**/*'
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*/**.rb
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/zoho_sign/document/list_service.rb
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/zoho_sign/document/list_service.rb
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - lib/zoho_sign.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/SymbolArray:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-09
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kobus Joubert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,401 @@
+# Active Call - Zoho Sign
+
+Zoho Sign exposes the [Zoho Sign API](https://www.zoho.com/sign/api) endpoints through service objects.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Configuration
+
+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.
+
+```ruby
+ZohoSign::BaseService.configure do |config|
+  config.client_id = ''
+  config.client_secret = ''
+  config.refresh_token = ''
+
+  # Optional configuration.
+  config.cache = Rails.cache # Default: ActiveSupport::Cache::MemoryStore.new
+  config.logger = Rails.logger # Default: Logger.new($stdout)
+  config.logger_level = :debug # Default: :info
+  config.log_headers = true # Default: false
+  config.log_bodies = true # Default: false
+end
+```
+
+While testing, you can set your temporary development OAuth access token in the `ZOHO_SIGN_ACCESS_TOKEN` environment variable. In your production environment,`config.refresh_token` will be used.
+
+## Usage
+
+### Using `.call`
+
+Each service object returned will undergo validation before the `call` method is invoked to access API endpoints.
+
+After **successful** validation.
+
+```ruby
+service.success? # => true
+service.errors # => #<ActiveModel::Errors []>
+```
+
+After **failed** validation.
+
+```ruby
+service.success? # => false
+service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=name, type=blank, options={}>]>
+service.errors.full_messages # => ["Name can't be blank"]
+```
+
+After a **successful** `call` invocation, the `response` attribute will contain a `Faraday::Response` object.
+
+```ruby
+service.success? # => true
+service.response # => #<Faraday::Response ...>
+service.response.success? # => true
+service.response.status # => 200
+service.response.body # => {"code"=>0, "message"=>"Document has been retrieved", "status"=>"success", "requests"=>{...}}
+```
+
+At this point you will also have a `facade` object which will hold all the attributes for the specific resource.
+
+```ruby
+service.facade # => #<ZohoSign::Document::Facade @request_status="inprogress" ...>
+service.facade.request_status # => 'inprogress'
+```
+
+For convenience, facade attributes can be accessed directly on the service object.
+
+```ruby
+service.request_status # => 'inprogress'
+```
+
+After a **failed** `call` invocation, the `response` attribute will still contain a `Faraday::Response` object.
+
+```ruby
+service.success? # => false
+service.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=base, type=Not found, options={}>]>
+service.errors.full_messages # => ["No match found"]
+service.response # => #<Faraday::Response ...>
+service.response.success? # => false
+service.response.status # => 400
+service.response.body # => {"code"=>9004, "message"=>"No match found", "status"=>"failure"}
+```
+
+### Using `.call!`
+
+Each service object returned will undergo validation before the `call!` method is invoked to access API endpoints.
+
+After **successful** validation.
+
+```ruby
+service.success? # => true
+```
+
+After **failed** validation, a `ZohoSign::ValidationError` exception will be raised with an `errors` attribute which 
+will contain an `ActiveModel::Errors` object.
+
+```ruby
+rescue ZohoSign::ValidationError => exception
+  exception.message # => ''
+  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=name, type=blank, options={}>]>
+  exception.errors.full_messages # => ["Name can't be blank"]
+```
+
+After a **successful** `call!` invocation, the `response` attribute will contain a `Faraday::Response` object.
+
+```ruby
+service.success? # => true
+service.response # => #<Faraday::Response ...>
+service.response.success? # => true
+service.response.status # => 200
+service.response.body # => {"code"=>0, "message"=>"Document has been retrieved", "status"=>"success", "requests"=>{...}}
+```
+
+At this point you will also have a `facade` object which will hold all the attributes for the specific resource.
+
+```ruby
+service.facade # => #<ZohoSign::Document::Facade @request_status="inprogress" ...>
+service.facade.request_status # => 'inprogress'
+```
+
+For convenience, facade attributes can be accessed directly on the service object.
+
+```ruby
+service.request_status # => 'inprogress'
+```
+
+After a **failed** `call!` invocation, a `ZohoSign::RequestError` will be raised with a `response` attribute which will contain a `Faraday::Response` object.
+
+```ruby
+rescue ZohoSign::RequestError => exception
+  exception.message # => ''
+  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=base, type=Not found, options={}>]>
+  exception.errors.full_messages # => ["No match found"]
+  exception.response # => #<Faraday::Response ...>
+  exception.response.status # => 400
+  exception.response.body # => {"code"=>9004, "message"=>"No match found", "status"=>"failure"}
+```
+
+### When to use `.call` or `.call!`
+
+An example of where to use `.call` would be in a **controller** doing an inline synchronous request.
+
+```ruby
+class DocumentController < ApplicationController
+  def update
+    @document = ZohoSign::Document::UpdateService.call(params)
+
+    if @document.success?
+      redirect_to [@document], notice: 'Success', status: :see_other
+    else
+      flash.now[:alert] = @document.errors.full_messages.to_sentence
+      render :edit, status: :unprocessable_entity
+    end
+  end
+end
+```
+
+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
+  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)
+  end
+end
+```
+
+### Documents
+
+#### List documents.
+
+Note that the `offset` starts at `1` for the first item.
+
+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.
+
+```ruby
+service = ZohoSign::Document::ListService.call(offset: 1, limit: 10).each do |facade|
+  facade.description
+end
+```
+
+Sort by column.
+
+```ruby
+ZohoSign::Document::ListService.call(sort_column: 'recipient_email', sort_order: 'ASC').map { _1 }
+```
+
+Filter by column.
+
+```ruby
+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`.
+
+#### Get a document.
+
+```ruby
+service = ZohoSign::Document::GetService.call(id: '')
+service.request_name
+service.request_id
+service.request_status
+service.owner_email
+service.owner_first_name
+service.owner_last_name
+service.attachments
+service.sign_percentage
+...
+```
+
+#### Create a document.
+
+```ruby
+service = ZohoSign::Document::CreateService.call(
+  file: '/path/to/file.pdf', # or File.open('/path/to/file.pdf')
+  file_name: 'file.pdf',
+  file_content_type: 'application/pdf',
+  data: {
+    requests: {
+      request_name: 'Name',
+      is_sequential: false,
+      actions: [{
+        action_type: 'SIGN',
+        recipient_email: 'eric.cartman@example.com',
+        recipient_name: 'Eric Cartman',
+        verify_recipient: true,
+        verification_type: 'EMAIL'
+      }]
+    }
+  }
+)
+```
+
+#### Update a document.
+
+```ruby
+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'
+      }]
+    }
+  }
+)
+```
+
+#### Delete a document.
+
+```ruby
+service = ZohoSign::Document::DeleteService.call(id: '')
+```
+
+### Folders
+
+TODO: ...
+
+### Field Types
+
+TODO: ...
+
+### Request Types
+
+TODO: ...
+
+### Templates
+
+#### List templates.
+
+Note that the `offset` starts at `1` for the first item.
+
+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.
+
+```ruby
+service = ZohoSign::Template::ListService.call(offset: 1, limit: 10).each do |facade|
+  facade.description
+end
+```
+
+Sort by column.
+
+```ruby
+ZohoSign::Template::ListService.call(sort_column: 'template_name', sort_order: 'ASC').map { _1 }
+```
+
+Filter by column.
+
+```ruby
+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`.
+
+#### Get a template.
+
+```ruby
+service = ZohoSign::Template::GetService.call(id: '')
+service.description
+service.document_fields
+service.email_reminders
+service.expiration_days
+service.folder_name
+service.folder_id
+service.owner_email
+service.template_name
+...
+```
+
+#### Create a template.
+
+TODO: ...
+
+#### Update a template.
+
+TODO: ...
+
+#### Delete a template.
+
+TODO: ...
+
+#### 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.
+
+```ruby
+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'
+      }]
+    }
+  }
+)
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kobusjoubert/zoho_sign.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/zoho_sign/access_token/facade.rb

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

data/lib/zoho_sign/access_token/get_service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class ZohoSign::AccessToken::GetService < ZohoSign::BaseService
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  # Get access token.
+  #
+  # ==== Examples
+  #
+  #   service = ZohoSign::AccessToken::GetService.call
+  #   service.access_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(/(refresh_token|client_id|client_secret)=([^&]+)/i, '\1=[FILTERED]')
+        logger.filter(/"access_token":"([^"]+)"/i, '"access_token":"[FILTERED]"')
+      end
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  def params
+    {
+      client_id:     client_id,
+      client_secret: client_secret,
+      refresh_token: refresh_token,
+      redirect_uri:  'https://sign.zoho.com',
+      grant_type:    'refresh_token'
+    }
+  end
+
+  def unauthorized?
+    response.status == 200 && response.body.key?('error')
+  end
+
+  def set_facade
+    @facade = ZohoSign::AccessToken::Facade.new(response.body)
+  end
+end