active_call-zoho_sign 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d081ad9bfcfa500488f91ef33523321354c2e92125798dabf903b73455a36969
-  data.tar.gz: c1e116320af36f5a82b2c5fc438accc3417246c073957544e49ce31aa40baa1e
+  metadata.gz: 24fd5f8a6cedfeae21a85de1412a2c6abefa4b8749151f8e55f63200460a3307
+  data.tar.gz: 05f78e8283339dc0703ceee1e64ac997c3e2ae3018b709e7ce24a43dfcf91979
 SHA512:
-  metadata.gz: 61d2c71ceb5d3cd761adf9bcba5c6b82c32df65de03059be03c53cf0b77756e591347cb93399ff01d0ef0cbef049aafd7dd5dbbf8cab204c6cad6ba823c404dc
-  data.tar.gz: 303712d85e4e32f67f060d0bfcffde7673d10f2c01f8b8e4f9890655097417b0bb53ef02ec75b79702049e0c9daf249ed2ecf7fdb9379418a0ae3756952dccfb
+  metadata.gz: b5f686d8c6a75657ab589f4ea999614e2e2340f52f760816036da2be33a271a3001c63a36a4713891c7a00b8b03da0b6036fda0e69146112998987324077029d
+  data.tar.gz: 8bcca9f1cc1fb120a724093d2f6bd31b1694afcb4c9889753433335ac0b304a4ff3fee22e74853533be663b030c4be5e80c90db45f92771a6a73a79763b935af

data/.rubocop.yml

@@ -22,6 +22,7 @@ Layout/HashAlignment:
 Layout/LineLength:
   AllowedPatterns:
     - initialize
+    - '#'
 
 Lint/MissingSuper:
   Enabled: false
@@ -43,6 +44,9 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ParameterLists:
+  Enabled: false
+
 Metrics/PerceivedComplexity:
   Exclude:
     - lib/zoho_sign/concerns/enumerable.rb

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [0.1.5] - 2025-04-05
+## [0.1.7] - 2025-05-09
+
+- README updates with links to API endpoint docs.
+- `EmbedToken::GetService` path does not need to set the full path `/api/v1/requests/...` -> `requests/...`.
+- README and Gemspec description updates.
+
+## [0.1.6] - 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.

data/README.md

@@ -2,7 +2,15 @@
 
 [![Gem Version](https://badge.fury.io/rb/active_call-zoho_sign.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/active_call-zoho_sign)
 
-Zoho Sign exposes the [Zoho Sign API](https://www.zoho.com/sign/api) endpoints through service objects.
+Zoho Sign exposes the [Zoho Sign API](https://www.zoho.com/sign/api) endpoints through [Active Call](https://rubygems.org/gems/active_call) service objects.
+
+<div align="center">
+  <a href="https://platform45.com?utm_source=github&utm_content=zoho_sign">
+    <picture>
+      <img src="https://github.com/user-attachments/assets/19fd40df-2ce9-4f30-8120-d53f3fbf9f07">
+    </picture>
+  </a>
+</div>
 
 - [Installation](#installation)
 - [Configuration](#configuration)
@@ -224,7 +232,9 @@ Note that the `offset` argument starts at `1` for the first item.
 #### List documents
 
 ```ruby
-service = ZohoSign::Document::ListService.call(offset: 1, limit: 10).each do |facade|
+# https://www.zoho.com/sign/api/document-managment/get-document-list.html
+
+ZohoSign::Document::ListService.call(offset: 1, limit: 10).each do |facade|
   facade.description
 end
 ```
@@ -246,6 +256,8 @@ Columns to sort and filter by are `request_name`, `folder_name`, `owner_full_nam
 #### Get a document
 
 ```ruby
+# https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
+
 service = ZohoSign::Document::GetService.call(id: '')
 service.request_name
 service.request_id
@@ -261,7 +273,9 @@ service.sign_percentage
 #### Create a document
 
 ```ruby
-service = ZohoSign::Document::CreateService.call(
+# https://www.zoho.com/sign/api/document-managment/create-document.html
+
+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',
@@ -284,7 +298,9 @@ service = ZohoSign::Document::CreateService.call(
 #### Update a document
 
 ```ruby
-service = ZohoSign::Document::UpdateService.call(
+# https://www.zoho.com/sign/api/document-managment/update-document.html
+
+ZohoSign::Document::UpdateService.call(
   id: '',
   data: {
     requests: {
@@ -303,7 +319,9 @@ service = ZohoSign::Document::UpdateService.call(
 #### Delete a document
 
 ```ruby
-service = ZohoSign::Document::DeleteService.call(id: '')
+# https://www.zoho.com/sign/api/document-managment/delete-document.html
+
+ZohoSign::Document::DeleteService.call(id: '')
 ```
 
 #### Sign a document
@@ -311,6 +329,8 @@ service = ZohoSign::Document::DeleteService.call(id: '')
 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.
 
 ```ruby
+# https://www.zoho.com/sign/api/embedded-signing.html
+
 service = ZohoSign::Document::Action::EmbedToken::GetService.call(request_id: '', action_id: '', host: '')
 service.sign_url
 ```
@@ -352,6 +372,8 @@ TODO: ...
 #### List templates
 
 ```ruby
+# https://www.zoho.com/sign/api/template-managment/get-template-list.html
+
 ZohoSign::Template::ListService.call(offset: 1, limit: 10).each do |facade|
   facade.description
 end
@@ -374,6 +396,8 @@ Columns to sort and filter by are `template_name`, `owner_first_name` and `modif
 #### Get a template
 
 ```ruby
+# https://www.zoho.com/sign/api/template-managment/get-template-details.html
+
 service = ZohoSign::Template::GetService.call(id: '')
 service.description
 service.document_fields
@@ -383,6 +407,7 @@ service.folder_name
 service.folder_id
 service.owner_email
 service.template_name
+service.request_status
 ...
 ```
 
@@ -403,7 +428,9 @@ TODO: ...
 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!(
+# https://www.zoho.com/sign/api/template-managment/send-documents-using-template.html
+
+ZohoSign::Template::Document::CreateService.call!(
   id: '',
   is_quicksend: true,
   data: {

data/lib/zoho_sign/access_token/get_service.rb

@@ -9,6 +9,8 @@ class ZohoSign::AccessToken::GetService < ZohoSign::BaseService
 
   # Get access token.
   #
+  # https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::AccessToken::GetService.call

data/lib/zoho_sign/document/action/embed_token/get_service.rb

@@ -17,6 +17,8 @@ class ZohoSign::Document::Action::EmbedToken::GetService < ZohoSign::BaseService
 
   # Get a signing URL.
   #
+  # https://www.zoho.com/sign/api/embedded-signing.html
+  #
   # 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.
   #
@@ -37,7 +39,7 @@ class ZohoSign::Document::Action::EmbedToken::GetService < ZohoSign::BaseService
   #
   # POST /api/v1/requests/:request_id/actions/:action_id/embedtoken
   def call
-    connection.post("/api/v1/requests/#{request_id}/actions/#{action_id}/embedtoken", **params)
+    connection.post("requests/#{request_id}/actions/#{action_id}/embedtoken", **params)
   end
 
   private

data/lib/zoho_sign/document/create_service.rb

@@ -18,6 +18,8 @@ class ZohoSign::Document::CreateService < ZohoSign::BaseService
 
   # Create a document.
   #
+  # https://www.zoho.com/sign/api/document-managment/create-document.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Document::CreateService.call(

data/lib/zoho_sign/document/delete_service.rb

@@ -11,6 +11,8 @@ class ZohoSign::Document::DeleteService < ZohoSign::BaseService
 
   # Delete a document.
   #
+  # https://www.zoho.com/sign/api/document-managment/delete-document.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Document::DeleteService.call(id: '')

data/lib/zoho_sign/document/get_service.rb

@@ -15,6 +15,8 @@ class ZohoSign::Document::GetService < ZohoSign::BaseService
 
   # Get a document.
   #
+  # https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Document::GetService.call(id: '')

data/lib/zoho_sign/document/list_service.rb

@@ -25,6 +25,8 @@ class ZohoSign::Document::ListService < ZohoSign::BaseService
 
   # List documents.
   #
+  # https://www.zoho.com/sign/api/document-managment/get-document-list.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Document::ListService.call.first

data/lib/zoho_sign/document/update_service.rb

@@ -16,6 +16,8 @@ class ZohoSign::Document::UpdateService < ZohoSign::BaseService
 
   # Update a document.
   #
+  # https://www.zoho.com/sign/api/document-managment/update-document.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Document::UpdateService.call(

data/lib/zoho_sign/grant_token/get_service.rb

@@ -18,6 +18,8 @@ class ZohoSign::GrantToken::GetService < ZohoSign::BaseService
 
   # Get refresh token from grant token.
   #
+  # https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::GrantToken::GetService.call(grant_token: '', client_id: '', client_secret: '')

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

@@ -18,6 +18,8 @@ class ZohoSign::Template::Document::CreateService < ZohoSign::BaseService
 
   # Create a document from a template.
   #
+  # https://www.zoho.com/sign/api/template-managment/send-documents-using-template.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Template::Document::CreateService.call!(

data/lib/zoho_sign/template/get_service.rb

@@ -15,6 +15,8 @@ class ZohoSign::Template::GetService < ZohoSign::BaseService
 
   # Get a document.
   #
+  # https://www.zoho.com/sign/api/template-managment/get-template-details.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Template::GetService.call(id: '')

data/lib/zoho_sign/template/list_service.rb

@@ -25,6 +25,8 @@ class ZohoSign::Template::ListService < ZohoSign::BaseService
 
   # List documents.
   #
+  # https://www.zoho.com/sign/api/template-managment/get-template-list.html
+  #
   # ==== Examples
   #
   #   service = ZohoSign::Template::ListService.call.first

data/lib/zoho_sign/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_call-zoho_sign
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_call-api
@@ -38,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-description: Zoho Sign exposes the Zoho Sign API endpoints through service objects.
+description: Zoho Sign exposes the Zoho Sign API endpoints through Active Call service
+  objects.
 email:
 - kobus@translate3d.com
 executables: []
@@ -104,5 +105,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
-summary: Zoho Sign
+summary: Zoho Sign service objects
 test_files: []