zoho_sign 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85bd1a932999943e553720f8e0d866a0b5365bdd2a29406c5016d59b2ae39f7b
+  data.tar.gz: 55cd33a724b2d63ecc0c95aa62cf1d2e5a6b114aa1d522244fc8314ccdf30ef6
+SHA512:
+  metadata.gz: 57f9062cd8b92ecdfae801fbce3a70bd6a4b0a44d3c06d331dee9d0709006e79ddb4b11ab90804d0c9719c9898768019f8227f78cf15ca9ab613d6271785b163
+  data.tar.gz: 9bd95ce532b3f593f764dfb48f4bb8af5a0661f2e67ca935aa493b556828e07aeb38db07e70235ac334faacb5605b26679f75a939fcaea9be28762cd670f8c54

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'zoho_sign.gemspec'
+    - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-17
+
+- Initial release:
+  - `ZohoSign::Template.all`
+  - `ZohoSign::Template.find`
+  - `ZohoSign::Template.create_document`
+  - `ZohoSign::Document.all`
+  - `ZohoSign::Document.find`
+  - `ZohoSign::Document.download_pdf`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at wakematta@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zoho_sign.gemspec
+gemspec
+
+# Utility
+gem "dotenv"
+gem "rake", "~> 13.0"
+
+# Lints
+gem "rubocop", "~> 1.7"
+
+# Console
+gem "pry"
+
+# Testing
+gem "faker"
+gem "rspec", "~> 3.0"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    zoho_sign (0.1.0)
+      activesupport
+      addressable
+      dry-configurable (~> 0.13)
+      faraday
+      faraday_middleware
+      rainbow
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    dry-configurable (0.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    faker (2.19.0)
+      i18n (>= 1.6, < 2)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  faker
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  webmock
+  zoho_sign!
+
+BUNDLED WITH
+   2.2.27

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mohamed Ziata
+
+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,137 @@
+# ZohoSign
+
+Simple wrapper around Zoho Sign, using OAuth 2.0 protocol for authentication.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zoho_sign'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install zoho_sign
+```
+
+## Usage
+
+### Initialization
+
+Create the following file (or equivalent for your app) and fill it with your credentails.
+
+If you don't have them, follow this official guide: https://www.zoho.com/sign/api/#getting-started
+
+**`config/initializers/zoho_sign.rb`**
+```ruby
+require "zoho_sign"
+
+ZohoSign.config.debug = true # Default is false. You can enable it to see the requests made by the Gem.
+
+ZohoSign.config.update(
+  oauth: {
+    client_id: ENV["ZOHO_SIGN_CLIENT_ID"],
+    client_secret: ENV["ZOHO_SIGN_CLIENT_SECRET"],
+    access_token: ENV["ZOHO_SIGN_ACCESS_TOKEN"],
+    refresh_token: ENV["ZOHO_SIGN_REFRESH_TOKEN"]
+  }
+)
+
+params = ZohoSign::Auth.refresh_token(ENV["ZOHO_SIGN_REFRESH_TOKEN"])
+ZohoSign.config.connection = params
+```
+
+### How to use `ZohoSign::Template`
+
+Find all templetes:
+
+```ruby
+templates = ZohoSign::Template.all
+```
+
+Find template by ID:
+
+```ruby
+template = ZohoSign::Template.find("12345678900000000")
+```
+
+Create document from template:
+
+```ruby
+template = ZohoSign::Template.find("12345678900000000")
+
+field_data = {
+  field_text_data: {
+    full_name: "Homer Simpson",
+    address: "742 Evergreen Terrace, Springfield, US"
+  }
+}
+
+recipient_data = [
+  {
+    role: "OldOwner",
+    action_id: "11111111111111111",
+    recipient: {
+      name: "Moammar Morris 'Moe' Szyslak",
+      email: "moe@springfield.com",
+      verify: true
+    },
+    private_notes: "Please sign this agreement"
+  },
+  {
+    role: "NewOwner",
+    action_id: "22222222222222222",
+    recipient: {
+      name: "Homer Simpson",
+      email: "homer.simpson@springfield.com",
+      verify: true
+    },
+    private_notes: "Please sign this agreement"
+  }
+]
+
+document = ZohoSign::Template.create_document(
+  template_id: template.attributes[:template_id],
+  field_data: field_data,
+  recipient_data: recipient_data,
+  document_name: "Agreement (v3)",
+  shared_notes: "Agreement to buy Moe's Tavern"
+)
+```
+
+Download document:
+
+```ruby
+document = ZohoSign::Document.find("12345656000000")
+document.download_pdf
+
+# OR
+
+ZohoSign::Document.download_pdf("12345656000000")
+```
+
+## 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/wecasa/zoho_sign. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wecasa/zoho_sign/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ZohoSign project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wecasa/zoho_sign/blob/master/CODE_OF_CONDUCT.md).

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/bin/console

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pry"
+require "dotenv/load"
+
+require "zoho_sign"
+
+ZohoSign.config.debug = true
+
+ZohoSign.config.update(
+  oauth: {
+    client_id: ENV["ZOHO_SIGN_CLIENT_ID"],
+    client_secret: ENV["ZOHO_SIGN_CLIENT_SECRET"],
+    access_token: ENV["ZOHO_SIGN_ACCESS_TOKEN"],
+    refresh_token: ENV["ZOHO_SIGN_REFRESH_TOKEN"]
+  }
+)
+
+unless ENV["ZOHO_SIGN_REFRESH_TOKEN"]
+  params = ZohoSign::Auth.get_token(ENV["ZOHO_SIGN_ACCESS_TOKEN"])
+  ZohoSign.config.oauth.refresh_token = params[:refresh_token] if params.key?(:refresh_token)
+end
+
+ZohoSign.config.connection = {
+  access_token: ZohoSign.config.oauth.access_token,
+  refresh_token: ZohoSign.config.oauth.refresh_token,
+  api_domain: ZohoSign.config.api.domain,
+  api_base_path: ZohoSign.config.api.base_path,
+  expires_in: 3600
+}
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zoho_sign/auth.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require "faraday"
+require "faraday_middleware"
+require "addressable"
+
+module ZohoSign
+  # Class that takes care of authentication using Oauth2 workflow as described here:
+  # https://www.zoho.com/crm/help/api/v2/#oauth-request.
+  class Auth
+    extend Forwardable
+
+    AUTH_DOMAIN_PATH = "https://accounts.zoho.com"
+
+    TOKEN_PATH = "/oauth/v2/token"
+
+    DEFAULT_SCOPES = %w[
+      ZohoSign.account.all
+      ZohoSign.documents.all
+      ZohoSign.templates.all
+    ].freeze
+
+    DEFAULT_ACCESS_TYPE = "offline"
+
+    def initialize(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES)
+      @configuration = ZohoSign.config
+      @access_type = access_type
+      @scopes = scopes
+    end
+
+    def self.refresh_token(refresh_token)
+      new.refresh_token(refresh_token)
+    end
+
+    def refresh_token(refresh_token)
+      uri = refresh_url(refresh_token)
+
+      log "POST #{uri}"
+
+      result = Faraday.post(uri)
+      json = JSON.parse(result.body, symbolize_names: true)
+      json.merge(refresh_token: refresh_token)
+    end
+
+    def refresh_url(refresh_token)
+      uri = token_full_uri
+
+      uri.query_values = {
+        client_id: @configuration.oauth.client_id,
+        client_secret: @configuration.oauth.client_secret,
+        refresh_token: refresh_token,
+        grant_type: "refresh_token"
+      }
+
+      Addressable::URI.unencode(uri.to_s)
+    end
+
+    def token_full_uri
+      Addressable::URI.join(AUTH_DOMAIN_PATH, TOKEN_PATH)
+    end
+
+    def self.get_token(grant_token)
+      new.get_token(grant_token)
+    end
+
+    def get_token(grant_token)
+      result = Faraday.post(token_url(grant_token))
+      JSON.parse(result.body, symbolize_names: true)
+    end
+
+    def token_url(grant_token)
+      uri = token_full_uri
+
+      uri.query_values = {
+        client_id: @configuration.oauth.client_id,
+        client_secret: @configuration.oauth.client_secret,
+        code: grant_token,
+        redirect_uri: @configuration.oauth.redirect_uri,
+        grant_type: "authorization_code"
+      }
+
+      Addressable::URI.unencode(uri.to_s)
+    end
+
+    private
+
+    def log(text)
+      return unless ZohoSign.config.debug
+
+      puts Rainbow("[ZohoSign] #{text}").blue.bright
+    end
+  end
+end

data/lib/zoho_sign/base_record.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+require "active_support/core_ext/object/to_query"
+
+module ZohoSign
+  # The main class for record classes
+  class BaseRecord
+    # Default number of records when fetching all.
+    DEFAULT_RECORDS_PER_REQUEST = 100
+
+    # Default starting index point when fetching all.
+    DEFAULT_START_INDEX = 1
+
+    attr_accessor :attributes
+
+    class << self
+      # @param [Integer] :start_index (1) Start Index.
+      # @param [Integer] :per_request (100) No of rows to be retrieved. Possible values: 10, 25, 50 or 100.
+      # @param [String] :sort_column (nil)
+      # @param [String] :sort_order (nil)
+      #
+      # @return [Array] Array of instances of current class
+      def all(start_index: DEFAULT_START_INDEX, per_request: DEFAULT_RECORDS_PER_REQUEST,
+              sort_column: nil, sort_order: nil)
+        params = build_params_for_index_action(start_index, per_request, sort_column, sort_order)
+        body = connection.get(request_path, params)
+        response = build_response(body)
+        data = response.data(data_key)
+
+        loop do
+          break unless response.more_rows?
+
+          start_index += response.data(data_key).count
+          params = build_params_for_index_action(start_index, per_request, sort_column, sort_order)
+          body = connection.get(request_path, params)
+          response = build_response(body)
+          data += response.data(data_key)
+        end
+
+        data.map { |record_attributes| new(**record_attributes) }
+      end
+
+      # @param [String] zoho_id
+      #
+      # @return [Class] Instance of current class
+      def find(zoho_id)
+        body = connection.get("#{request_path}/#{zoho_id}")
+        response = build_response(body)
+        record_attributes = response.data(data_key)
+        new(**record_attributes)
+      end
+
+      private
+
+      def connection
+        ZohoSign.connection
+      end
+
+      def request_path
+        raise ZohoSign::Error, "this method should be overwrite in the child class. Please open an issue at https://github.com/wecasa/zoho_sign"
+      end
+
+      def data_key
+        raise ZohoSign::Error, "this method should be overwrite in the child class. Please open an issue at https://github.com/wecasa/zoho_sign"
+      end
+
+      def build_response(body)
+        response = ZohoSign::ResponseHandler.new(body)
+        return response if response.success?
+
+        raise RecordNotFoundError, response.message if response.not_found_error?
+
+        # This is a fallback because ZohoSign API could evolve by adding new error messages.
+        raise Error, response.detailed_message
+      end
+
+      def build_params_for_index_action(start_index, row_count, sort_column, sort_order)
+        {
+          data: {
+            page_context: {
+              start_index: start_index,
+              row_count: row_count,
+              sort_column: sort_column,
+              sort_order: sort_order
+            }.compact
+          }.compact.to_json
+        }.compact
+      end
+    end
+
+    def initialize(**attributes)
+      @attributes = attributes
+    end
+  end
+end

data/lib/zoho_sign/connection.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "rainbow"
+require "faraday"
+require "faraday_middleware"
+
+require_relative "response_handler"
+
+module ZohoSign
+  # Internal class that has all the logic to stablish a connection with Zoho API
+  class Connection
+    attr_accessor :access_token, :refresh_token, :api_domain, :api_base_path, :expires_ins
+
+    def initialize(access_token:, refresh_token: nil, api_domain: nil, api_base_path: nil, expires_in: 3600)
+      @access_token = access_token
+      @refresh_token ||= refresh_token # Do not overwrite if it's already set
+      @api_domain = api_domain || ZohoSign.config.api.domain
+      @api_base_path = api_base_path || ZohoSign.config.api.base_path
+      @expires_in = expires_in
+    end
+
+    def get(path, params = {})
+      log "GET #{path} with #{params}"
+
+      response = with_refresh { adapter.get(path, params) }
+      response.body
+    end
+
+    def post(path, params = {})
+      log "POST #{path} with #{params}"
+
+      response = with_refresh { adapter.post(path, params) }
+      response.body
+    end
+
+    def put(path, params = {})
+      log "PUT #{path} with #{params}"
+
+      response = with_refresh { adapter.put(path, params) }
+      response.body
+    end
+
+    def delete(path, params = {})
+      log "DELETE #{path} with #{params}"
+
+      response = with_refresh { adapter.delete(path, params) }
+      response.body
+    end
+
+    def download(path, params = {})
+      log "GET #{path} with #{params}"
+
+      response = with_refresh { download_adapter.get(path, params) }
+      response.body
+    end
+
+    private
+
+    def log(text)
+      return unless ZohoSign.config.debug
+
+      puts Rainbow("[ZohoSign] #{text}").blue.bright
+    end
+
+    def with_refresh
+      http_response = yield
+      response = ZohoSign::ResponseHandler.new(http_response.body, http_response.status)
+      # Try to refresh the token and try again
+      if response.invalid_token_error? && refresh_token?
+        log "Refreshing outdated token... #{@access_token}"
+        params = ZohoSign::Auth.refresh_token(@refresh_token)
+        @access_token = params[:access_token]
+        http_response = yield
+        response = ZohoSign::ResponseHandler.new(http_response.body, http_response.status)
+      end
+
+      raise ZohoSign::Error, response.detailed_message if response.error?
+
+      response
+    end
+
+    def base_url
+      "#{@api_domain}#{@api_base_path}"
+    end
+
+    def authorization_token
+      "Zoho-oauthtoken #{@access_token}"
+    end
+
+    def access_token?
+      !@access_token.empty?
+    end
+
+    def refresh_token?
+      !@refresh_token.empty?
+    end
+
+    def adapter
+      Faraday.new(url: base_url) do |conn|
+        conn.headers["Authorization"] = authorization_token if access_token?
+        conn.headers["Content-Type"] = "application/x-www-form-urlencoded"
+        conn.request :json
+        conn.request :retry
+        conn.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+        conn.response :logger if ZohoSign.config.debug
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def download_adapter
+      Faraday.new(url: base_url) do |conn|
+        conn.headers["Authorization"] = authorization_token if access_token?
+        conn.headers["Content-Type"] = "application/x-www-form-urlencoded"
+        conn.request :retry
+        conn.response :json, parser_options: { symbolize_names: true }, content_type: /\bjson$/
+        conn.response :logger if ZohoSign.config.debug
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/zoho_sign/document.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require_relative "base_record"
+
+module ZohoSign
+  # Record class to interact with Zoho Sign Documents API
+  class Document < ZohoSign::BaseRecord
+    class << self
+      def download_pdf(document_id)
+        body = connection.download("#{request_path}/#{document_id}/pdf")
+        pdf_tmp = Tempfile.new([tempfile_name, ".pdf"], encoding: "ascii-8bit")
+        pdf_tmp.write(body)
+        pdf_tmp.rewind
+        pdf_tmp
+      end
+
+      private
+
+      def request_path
+        "requests"
+      end
+
+      def data_key
+        :requests
+      end
+
+      def tempfile_name
+        SecureRandom.uuid
+      end
+    end
+
+    def download_pdf
+      self.class.download_pdf(@attributes.fetch(:request_id))
+    end
+  end
+end

data/lib/zoho_sign/response_handler.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module ZohoSign
+  # Internal class to centralize the code related to the response of the Zoho Sign API
+  class ResponseHandler
+    def initialize(response, http_response = nil)
+      @response = response || {}
+      @http_response = http_response
+    end
+
+    def body
+      @response
+    end
+
+    def data(key)
+      return unless @response.is_a?(Hash)
+
+      @response[key]
+    end
+
+    def success?
+      return false unless @response.is_a?(Hash)
+
+      @http_response == 200 || @response[:status] == "success"
+    end
+
+    def error?
+      return false if @http_response == 200
+
+      (!@http_response.nil? && @http_response != 200) ||
+        @response[:status] == "error" ||
+        @response[:status] == "failure"
+    end
+
+    def message
+      [
+        @response[:message],
+        ("error_param: #{@response[:error_param]}" if @response.key?(:error_param))
+      ].join(" ")
+    end
+
+    def detailed_message
+      @response.to_s
+    end
+
+    def more_rows?
+      !!@response.dig(:page_context, :has_more_rows)
+    end
+
+    # @response = { code: 9004, status: "failure", message: "No match found" }
+    def not_found_error?
+      code?(9004)
+    end
+
+    # @response = {
+    #   code: 9008,
+    #   status: "failure",
+    #   message: "templates occurs less than minimum occurance of 1",
+    #   error_param: "templates"
+    # }
+    def missing_param_error?
+      code?(9008)
+    end
+
+    # @response = {
+    #   code: 9015,
+    #   status: "failure",
+    #   message: "Extra key found",
+    #   status: "failure",
+    #   error_param: "data[page_context][row_count]"
+    # }
+    def extra_key_found_error?
+      code?(9015)
+    end
+
+    # @response = { code: 9031, status: "failure", message: "Ticket invalid" }
+    def ticket_invalid_error?
+      code?(9031)
+    end
+
+    # @response = { code: 9039, status: "failure", message: "Unable to process your request" }
+    def unable_to_process_request_error?
+      code?(9039)
+    end
+
+    # @response = { code: 9041, status: "failure", message: "Invalid Oauth token" }
+    def invalid_token_error?
+      if @response.is_a?(Hash)
+        code?(9041)
+      else
+        @http_response == 401 && @response.include?("Invalid Oauth token")
+      end
+    end
+
+    # @response = { code: 12001, status: "failure", message: "Upgrade API credits to access resources using API" }
+    def no_more_credits_error?
+      code?(12_001)
+    end
+
+    private
+
+    def code?(code)
+      return unless @response.is_a?(Hash)
+
+      @response.key?(:code) && @response[:code] == code
+    end
+  end
+end

data/lib/zoho_sign/template.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "base_record"
+require_relative "document"
+
+module ZohoSign
+  # Record class to interact with Zoho Sign Templates API
+  class Template < ZohoSign::BaseRecord
+    class << self
+      # @param [String] :template_id Zoho Sign Template ID
+      #
+      # @param [Hash] :field_data Data used to prefill the document
+      # @option :field_data [Hash] :field_text_data
+      # @option :field_data [Hash] :field_date_data
+      # @option :field_data [Hash] :field_boolean_data
+      #
+      # @param [Array] :recipient_data Recipient
+      # @option :recipient_data [String] :role
+      # @option :recipient_data [String] :private_notes
+      # @option :recipient_data [String] :action_id
+      # @option :recipient_data [String] :action_type
+      # @option :recipient_data [String] :verification_type
+      # @option :recipient_data [Hash] :recipient
+      # @option :recipient [String] :name
+      # @option :recipient [String] :email
+      # @option :recipient [String] :phone
+      # @option :recipient [String] :country_code
+      # @option :recipient [Boolean] :verify
+      #
+      # @param [String] :shared_notes Text to be shown for all recipients
+      # @param [Boolean] :quicksend
+      #
+      # @param [String] :shared_notes Text to be shown for all recipients
+      # @param [Boolean] :quicksend
+      #
+      # @return [Class] ZohoSign::Document instance
+      #
+      def create_document(template_id:, field_data: {}, recipient_data: [], shared_notes: "", quicksend: true,
+                          document_name: nil)
+        actions = recipient_data.map do |action_data|
+          recipient = action_data.fetch(:recipient)
+          {
+            role: action_data.fetch(:role),
+            recipient_name: recipient.fetch(:name),
+            recipient_email: recipient.fetch(:email),
+            recipient_phonenumber: recipient[:phone],
+            recipient_countrycode: recipient[:country_code],
+            verify_recipient: recipient.fetch(:verify, true),
+            private_notes: action_data[:private_notes],
+            verification_type: action_data.fetch(:verification_type, "EMAIL"),
+            action_type: action_data.fetch(:action_type, "SIGN"),
+            action_id: action_data.fetch(:action_id)
+          }.compact
+        end
+
+        params = {
+          is_quicksend: quicksend,
+          data: {
+            templates: {
+              request_name: document_name,
+              field_data: field_data,
+              actions: actions,
+              notes: shared_notes
+            }.compact
+          }.to_json
+        }
+
+        body = connection.post("#{request_path}/#{template_id}/createdocument", params.to_query)
+        response = build_response(body)
+        document_attributes = response.data(:requests)
+        ZohoSign::Document.new(**document_attributes)
+      end
+
+      private
+
+      def request_path
+        "templates"
+      end
+
+      def data_key
+        :templates
+      end
+    end
+
+    # - Instance methods
+    def create_document(**arguments)
+      arguments[:template_id] = @attributes.fetch(:template_id)
+      self.class.create_document(**arguments)
+    end
+  end
+end

data/lib/zoho_sign/version.rb

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

data/lib/zoho_sign.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "dry-configurable"
+
+require_relative "zoho_sign/version"
+require_relative "zoho_sign/auth"
+require_relative "zoho_sign/connection"
+
+# Record classes
+require_relative "zoho_sign/template"
+require_relative "zoho_sign/document"
+
+# Namespace ZohoSign
+module ZohoSign
+  extend Dry::Configurable
+
+  setting :debug, default: false
+
+  # Follow the instruction found here to generate your credentails:
+  # https://www.zoho.com/sign/api/#getting-started
+  setting :oauth do
+    setting :client_id
+    setting :client_secret
+    setting :access_token
+    setting :refresh_token
+    setting :redirect_uri, default: "https://example.com"
+  end
+
+  setting :api do
+    setting :domain, default: "https://sign.zoho.com"
+    setting :base_path, default: "/api/v1"
+  end
+
+  setting :connection, reader: true, constructor: lambda { |params|
+    return unless params
+    raise Error, "ERROR: #{params[:error]}" if params && params[:error]
+
+    connection_params = params.dup.slice(:access_token, :expires_in, :refresh_token)
+    Connection.new(**connection_params)
+  }
+
+  class Error < StandardError; end
+
+  class RecordNotFoundError < Error; end
+end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: zoho_sign
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Wecasa Developers Team
+- Mohamed Ziata
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem to allow easy interaction with Zoho Sign API (v1).
+email:
+- tech@wecasa.fr
+- wakematta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zoho_sign.rb
+- lib/zoho_sign/auth.rb
+- lib/zoho_sign/base_record.rb
+- lib/zoho_sign/connection.rb
+- lib/zoho_sign/document.rb
+- lib/zoho_sign/response_handler.rb
+- lib/zoho_sign/template.rb
+- lib/zoho_sign/version.rb
+- renovate.json
+homepage: https://www.zoho.com/sign/api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.zoho.com/sign/api
+  documentation_uri: https://github.com/wecasa/zoho_sign
+  source_code_uri: https://github.com/wecasa/zoho_sign
+  changelog_uri: https://github.com/wecasa/zoho_sign/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/wecasa/zoho_sign/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Zoho Sign API Wrapper
+test_files: []