active_call-zoho_sign 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216f81e67c69376d2180d986456d6fdd043680d4429bd5f0838446c1e64ec706
-  data.tar.gz: 2939c3d9638842cfe9d8231f6271b08291c66a674960efd78a1d4304d7a61509
+  metadata.gz: 4e6bfddd2811ee821c10b0f03e640a1d5bd61fce4a1f55e710d94284c4428013
+  data.tar.gz: 31222714f42fa31b5a8c90c59b1eae1e7f3e10103b3aac99e6ee3899d445c3ed
 SHA512:
-  metadata.gz: ca0380d7b312f9e9ce1d4b840eb3d891ebad7300337569a001618a7db9168c1a74a14f92e381e38836062cc4b094fa7a65776befaaf1bd5883454dd84ad0326e
-  data.tar.gz: 456f26fd3ec6e59966dc633126030800c8196a87d3c2d418b86a9601801781012d2606cb216b76692fc6a5083cf72d911ed78b54f43aeefc2300b7349ff3dc31
+  metadata.gz: f0da06b096bad4445ba1985194968119a4c320d961fd9d70dce91efa80206677b0cbd718608e9acfc03f15114de2255509d2d8b7f5863095aecff511566193d5
+  data.tar.gz: 46054e1c662f60ce7fe651dfc41bdbe3dc50f4009d94e2871c91230c8ac493e5600e63cae1b038332444759258a064aa3210336d8777485295a9da49acb17a2f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.2] - 2025-03-25
+
+- Refactored common REST API methods out into an active_call-api gem.
+
 ## [0.1.1] - 2025-03-22
 
 - Add gem install instructions.

data/README.md

@@ -4,8 +4,6 @@ Zoho Sign exposes the [Zoho Sign API](https://www.zoho.com/sign/api) endpoints t
 
 ## 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

data/lib/zoho_sign/base_service.rb

@@ -1,24 +1,12 @@
 # frozen_string_literal: true
 
 class ZohoSign::BaseService < ActiveCall::Base
+  include ActiveCall::Api
+
   self.abstract_class = true
 
   CACHE_KEY = { access_token: 'zoho_sign/base_service/access_token' }.freeze
 
-  EXCEPTION_MAPPING = {
-    bad_request:                   ZohoSign::BadRequestError,
-    unauthorized:                  ZohoSign::UnauthorizedError,
-    forbidden:                     ZohoSign::ForbiddenError,
-    not_found:                     ZohoSign::NotFoundError,
-    proxy_authentication_required: ZohoSign::ProxyAuthenticationRequiredError,
-    request_timeout:               ZohoSign::RequestTimeoutError,
-    conflict:                      ZohoSign::ConflictError,
-    unprocessable_entity:          ZohoSign::UnprocessableEntityError,
-    too_many_requests:             ZohoSign::TooManyRequestsError,
-    client_error:                  ZohoSign::ClientError,
-    server_error:                  ZohoSign::ServerError
-  }.freeze
-
   config_accessor :base_url, default: 'https://sign.zoho.com/api/v1', instance_writer: false
   config_accessor :cache, default: ActiveSupport::Cache::MemoryStore.new, instance_writer: false
   config_accessor :logger, default: Logger.new($stdout), instance_writer: false
@@ -29,60 +17,34 @@ class ZohoSign::BaseService < ActiveCall::Base
 
   attr_reader :facade
 
-  validate on: :response do
-    throw :abort if response.is_a?(Enumerable)
-
-    errors.add(:base, :server_error) and throw :abort if response.status >= 500
-
-    errors.add(:base, :unauthorized) and throw :abort if unauthorized?
-    errors.add(:base, :forbidden) and throw :abort if forbidden?
-    errors.add(:base, :not_found) and throw :abort if not_found?
-    errors.add(:base, :proxy_authentication_required) and throw :abort if proxy_authentication_required?
-    errors.add(:base, :request_timeout) and throw :abort if request_timeout?
-    errors.add(:base, :conflict) and throw :abort if conflict?
-    errors.add(:base, :unprocessable_entity) and throw :abort if unprocessable_entity?
-    errors.add(:base, :too_many_requests) and throw :abort if too_many_requests?
-
-    # Check for bad_request here since too_many_requests also has a status of 400.
-    errors.add(:base, :bad_request) and throw :abort if bad_request?
-
-    # We'll use client_error for everything else that we don't have an explicit exception class for.
-    errors.add(:base, :client_error) and throw :abort if response.status >= 400
-  end
-
   class << self
-    def call!(...)
-      super
-    rescue ActiveCall::ValidationError => e
-      raise zoho_sign_validation_error(e)
-    rescue ActiveCall::RequestError => e
-      raise zoho_sign_request_error(e)
-    end
-
-    def zoho_sign_validation_error(exception)
-      ZohoSign::ValidationError.new(exception.errors, exception.message)
-    end
-
-    def zoho_sign_request_error(exception)
-      exception_for(exception.response, exception.errors, exception.message)
-    end
-
-    def exception_for(response, errors, message = nil)
-      exception_type = errors.details[:base].first[:error]
-
-      case exception_type
-      when *EXCEPTION_MAPPING.keys
-        EXCEPTION_MAPPING[exception_type].new(response, errors, message)
-      else
-        ZohoSign::RequestError.new(response, errors, message)
-      end
+    def exception_mapping
+      {
+        validation_error:              ZohoSign::ValidationError,
+        request_error:                 ZohoSign::RequestError,
+        client_error:                  ZohoSign::ClientError,
+        server_error:                  ZohoSign::ServerError,
+        bad_request:                   ZohoSign::BadRequestError,
+        unauthorized:                  ZohoSign::UnauthorizedError,
+        forbidden:                     ZohoSign::ForbiddenError,
+        not_found:                     ZohoSign::NotFoundError,
+        not_acceptable:                ZohoSign::NotAcceptableError,
+        proxy_authentication_required: ZohoSign::ProxyAuthenticationRequiredError,
+        request_timeout:               ZohoSign::RequestTimeoutError,
+        conflict:                      ZohoSign::ConflictError,
+        unprocessable_entity:          ZohoSign::UnprocessableEntityError,
+        too_many_requests:             ZohoSign::TooManyRequestsError,
+        internal_server_error:         ZohoSign::InternalServerError,
+        not_implemented:               ZohoSign::NotImplementedError,
+        bad_gateway:                   ZohoSign::BadGatewayError,
+        service_unavailable:           ZohoSign::ServiceUnavailableError,
+        gateway_timeout:               ZohoSign::GatewayTimeoutError
+      }.freeze
     end
   end
 
   private
 
-  delegate :exception_for, to: :class
-
   def connection
     @_connection ||= Faraday.new do |conn|
       conn.url_prefix = base_url
@@ -115,14 +77,6 @@ class ZohoSign::BaseService < ActiveCall::Base
     cache.fetch(CACHE_KEY[:access_token], expires_in: [service.expires_in - 10, 0].max) { service.facade.access_token }
   end
 
-  def bad_request?
-    response.status == 400
-  end
-
-  def unauthorized?
-    response.status == 401
-  end
-
   def forbidden?
     response.status == 403
     return false unless response.status == 400 && response.body.key?('code')
@@ -144,21 +98,6 @@ class ZohoSign::BaseService < ActiveCall::Base
     false
   end
 
-  # TODO: Confirm.
-  def proxy_authentication_required?
-    response.status == 407
-  end
-
-  # TODO: Confirm.
-  def request_timeout?
-    response.status == 408
-  end
-
-  # TODO: Confirm.
-  def conflict?
-    response.status == 409
-  end
-
   def unprocessable_entity?
     return true if response.status == 422
     return false unless response.status == 400 && response.body.key?('code')

data/lib/zoho_sign/error.rb

@@ -26,6 +26,9 @@ module ZohoSign
   # 404
   class NotFoundError < ClientError; end
 
+  # 406
+  class NotAcceptableError < ClientError; end
+
   # 407
   class ProxyAuthenticationRequiredError < ClientError; end
 
@@ -43,4 +46,19 @@ module ZohoSign
 
   # 500..599
   class ServerError < RequestError; end
+
+  # 500
+  class InternalServerError < ServerError; end
+
+  # 501
+  class NotImplementedError < ServerError; end
+
+  # 502
+  class BadGatewayError < ServerError; end
+
+  # 503
+  class ServiceUnavailableError < ServerError; end
+
+  # 504
+  class GatewayTimeoutError < ServerError; end
 end

data/lib/zoho_sign/version.rb

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

data/lib/zoho_sign.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 require 'active_call'
-require 'faraday'
-require 'faraday/retry'
+require 'active_call/api'
 require 'faraday/multipart'
-require 'faraday/logging/color_formatter'
-require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/active_call-zoho_sign.rb")
@@ -17,7 +14,3 @@ require_relative 'zoho_sign/error'
 require_relative 'zoho_sign/version'
 
 module ZohoSign; end
-
-ActiveSupport.on_load(:i18n) do
-  I18n.load_path << File.expand_path('zoho_sign/locale/en.yml', __dir__)
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_call-zoho_sign
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_call
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: active_call-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,6 @@ files:
 - lib/zoho_sign/document/list_service.rb
 - lib/zoho_sign/document/update_service.rb
 - lib/zoho_sign/error.rb
-- lib/zoho_sign/locale/en.yml
 - lib/zoho_sign/template/document/create_service.rb
 - lib/zoho_sign/template/document/facade.rb
 - lib/zoho_sign/template/facade.rb
@@ -125,7 +138,7 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/kobusjoubert/zoho_sign
   source_code_uri: https://github.com/kobusjoubert/zoho_sign
-  changelog_uri: https://github.com/kobusjoubert/zoho_sign/CHANGELOG.md
+  changelog_uri: https://github.com/kobusjoubert/zoho_sign/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/zoho_sign/locale/en.yml

@@ -1,18 +0,0 @@
-en:
-  activemodel:
-    errors:
-      # The values :model, :attribute and :value are always available for interpolation.
-      # The value :count is available when applicable. Can be used for pluralization.
-      models:
-        zoho_sign/base_service:
-          bad_request: 'Bad Request'
-          client_error: 'Client Error'
-          conflict: 'Conflict'
-          forbidden: 'Forbidden'
-          not_found: 'Not Found'
-          proxy_authentication_required: 'Proxy Authentication Required'
-          request_timeout: 'Request Timeout'
-          server_error: 'Server Error'
-          too_many_requests: 'Too Many Requests'
-          unauthorized: 'Unauthorized'
-          unprocessable_entity: 'Unprocessable Entity'