active_call-zoho_crm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5692f8ba47b601d8c6781d92154ae4f2b229923bfdb34c5b1537eef054558bc3
+  data.tar.gz: 95346571658eddc07819ad96a8b8d2bda19942dcd8d20d23fc6efc4283ff0a24
+SHA512:
+  metadata.gz: 5f2d97143511747fec70a48323a0590cd633592b38e379be100c8a12666d31ff20e83c0d6975be5cbe97be265c3792ab931debaa431fe2b46b8e653eab32533e
+  data.tar.gz: da622d9adc9047203d77e8c76340ddb3c800f898097d93562b0d381593b7641361d7120dd2c4b88fb8b154d2c74039c37cf2fc615ffcc573c7b33bfca59e24d7

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,82 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - zoho_crm.gemspec
+    - bin/*
+    - 'vendor/**/*'
+    - 'gem/**/*'
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/LineLength:
+  AllowedPatterns:
+    - initialize
+    - '#'
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*/**.rb
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/zoho_crm/concerns/enumerable.rb
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - lib/zoho_crm/concerns/enumerable.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/active_call-zoho_crm.rb
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Exclude:
+    - lib/zoho_crm.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-04-02
+
+- 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,355 @@
+# Active Call - Zoho CRM
+
+Zoho CRM exposes the [Zoho CRM API](https://www.zoho.com/crm/developer/docs/api) endpoints through service objects.
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+  - [Using call](#using-call)
+  - [Using call!](#using-call!)
+  - [When to use call or call!](#using-call-or-call!)
+  - [Using lists](#using-lists)
+- [Service Objects](#service-objects)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+## 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
+
+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/crm/developer/docs/api/v7/scopes.html) like `ZohoCRM.modules.ALL` to generate your **Grant Token**.
+
+Get your **Refresh Token** by calling `ZohoCrm::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_crm.rb` within the `config/initializers` directory.
+
+```ruby
+require 'active_call-zoho_crm'
+
+ZohoCrm::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
+```
+
+## Usage
+
+### <a name='using-call'></a>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=id, type=blank, options={}>]>
+service.errors.full_messages # => ["Id 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 # => {"data"=> [{"Email"=>"eric.cartman@example.com", ...}]}
+```
+
+At this point you will also have a `facade` object which will hold all the attributes for the specific resource.
+
+```ruby
+service.facade # => #<ZohoCrm::Record::Facade @attributes={"Email"=>"eric.cartman@example.com", ...} ...>
+service.facade.attributes # => {"Email"=>"eric.cartman@example.com", ...}
+```
+
+For convenience, facade attributes can be accessed directly on the service object.
+
+```ruby
+service.attributes # => {"Email"=>"eric.cartman@example.com", ...}
+```
+
+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=bad_request, options={}>]>
+service.errors.full_messages # => ["Bad Request"]
+service.response # => #<Faraday::Response ...>
+service.response.success? # => false
+service.response.status # => 400
+service.response.body # => {"data"=>[{"code"=>"INVALID_DATA", "details"=>{"api_name"=>"id", "json_path"=>"$.data[0].id"}, "message"=>"the id given seems to be invalid", "status"=>"error"}]}
+```
+
+### <a name='using-call!'></a>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 `ZohoCrm::ValidationError` exception will be raised with an `errors` attribute which 
+will contain an `ActiveModel::Errors` object.
+
+```ruby
+rescue ZohoCrm::ValidationError => exception
+  exception.message # => ''
+  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=id, type=blank, options={}>]>
+  exception.errors.full_messages # => ["Id 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 # => {"data"=> [{"Email"=>"eric.cartman@example.com", ...}]}
+```
+
+At this point you will also have a `facade` object which will hold all the attributes for the specific resource.
+
+```ruby
+service.facade # => #<ZohoCrm::Record::Facade @attributes={"Email"=>"eric.cartman@example.com", ...} ...>
+service.facade.attributes # => {"Email"=>"eric.cartman@example.com", ...}
+```
+
+For convenience, facade attributes can be accessed directly on the service object.
+
+```ruby
+service.attributes # => {"Email"=>"eric.cartman@example.com", ...}
+```
+
+After a **failed** `call!` invocation, a `ZohoCrm::RequestError` will be raised with a `response` attribute which will contain a `Faraday::Response` object.
+
+```ruby
+rescue ZohoCrm::RequestError => exception
+  exception.message # => 'Bad Request'
+  exception.errors # => #<ActiveModel::Errors [#<ActiveModel::Error attribute=base, type=bad_request, options={}>]>
+  exception.errors.full_messages # => ["Bad Request"]
+  exception.response # => #<Faraday::Response ...>
+  exception.response.status # => 400
+  exception.response.body # => {"data"=>[{"code"=>"INVALID_DATA", "details"=>{"api_name"=>"id", "json_path"=>"$.data[0].id"}, "message"=>"the id given seems to be invalid", "status"=>"error"}]}
+```
+
+### <a name='using-call-or-call!'></a>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 SomeController < ApplicationController
+  def update
+    @service = ZohoCrm::Record::UpdateService.call(**params)
+
+    if @service.success?
+      redirect_to [@service], notice: 'Success', status: :see_other
+    else
+      flash.now[:alert] = @service.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 SomeJob < ApplicationJob
+  discard_on ZohoCrm::NotFoundError
+
+  retry_on ZohoCrm::RequestTimeoutError, wait: 5.minutes, attempts: :unlimited
+  retry_on ZohoCrm::TooManyRequestsError, wait: :polynomially_longer, attempts: 10
+
+  def perform
+    ZohoCrm::Record::UpdateService.call!(**params)
+  end
+end
+```
+
+### Using lists
+
+If you don't provide the `per_page` argument, multiple API requests will be made untill all records have been returned. You could be rate limited, so use wisely.
+
+## Service Objects
+
+<details open>
+<summary>Records</summary>
+
+### Records
+
+##### Supported modules
+
+`Leads`, `Accounts`, `Contacts`, `Deals`, `Campaigns`, `Tasks`, `Cases`, `Events`, `Calls`, `Solutions`, `Products`, `Vendors`, `Price Books`, `Quotes`, `Sales Orders`, `Purchase Orders`, `Invoices`, `Custom`, `Appointments`, `Appointments Rescheduled History`, `Services` and `Activities`
+
+##### Custom modules
+
+For custom modules, use their respective API names in the request URL. You can obtain the API name from **Setup -> Developer Hub -> APIs & SDKs -> API Names**. You can also use the respective custom module's `api_name` key in the [Modules API's](https://www.zoho.com/crm/developer/docs/api/v7/modules-api.html) response to get the API name of the custom module.
+
+#### List records
+
+```ruby
+ZohoCrm::Record::ListService.call(module_name: 'Contacts', fields: 'Email,Last_Name', page: 1, per_page: 10).each do |facade|
+  facade.attributes
+end
+```
+
+Sort by column.
+
+```ruby
+ZohoCrm::Record::ListService.call(module_name: 'Contacts', fields: 'Email,Last_Name', sort_by: 'Modified_Time', sort_order: 'asc').map { _1 }
+```
+
+Columns to sort by are `id`, `Created_Time` and `Modified_Time`.
+
+#### Search records
+
+```ruby
+ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com', page: 1, per_page: 10).each do |facade|
+  facade.attributes
+end
+```
+
+Sort by column.
+
+```ruby
+ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com', sort_by: 'Modified_Time', sort_order: 'asc').map { _1 }
+```
+
+Columns to sort by are `id`, `Created_Time` and `Modified_Time`.
+
+Search by email.
+
+```ruby
+ZohoCrm::Record::SearchService.call(module_name: 'Contacts', email: 'eric.cartman@example.com').map { _1 }
+```
+
+Search by phone.
+
+```ruby
+ZohoCrm::Record::SearchService.call(module_name: 'Contacts', phone: '0123456789').map { _1 }
+```
+
+Search by criteria.
+
+```ruby
+ZohoCrm::Record::SearchService.call(module_name: 'Contacts', criteria: 'Created_Time:between:2025-01-01T06:00:00+00:00,2025-01-30T06:00:00+00:00').map { _1 }
+```
+
+Search by word.
+
+```ruby
+ZohoCrm::Record::SearchService.call(module_name: 'Contacts', word: 'eric').map { _1 }
+```
+
+#### Get a record
+
+```ruby
+service = ZohoCrm::Record::GetService.call(module_name: 'Contacts', id: '')
+service.id
+service.attributes
+service.attributes['Email']
+service.attributes['Record_Status__s']
+service.attributes['Owner']['name']
+...
+```
+
+#### Create a record
+
+```ruby
+service = ZohoCrm::Record::CreateService.call(
+  module_name: 'Contacts',
+  data: {
+    'Email' => 'eric.cartman@example.com',
+    'First_Name' => 'Eric',
+    'Last_Name' => 'Cartman'
+  }
+)
+```
+
+#### Update a record
+
+```ruby
+service = ZohoCrm::Record::UpdateService.call(
+  module_name: 'Contacts',
+  data: {
+    'id' => '',
+    'First_Name' => 'Eric Theodore'
+  }
+)
+```
+
+#### Upsert a record
+
+```ruby
+service = ZohoCrm::Record::UpsertService.call(
+  module_name: 'Contacts',
+  data: {
+    'Email' => 'eric.cartman@example.com',
+    'First_Name' => 'Eric',
+    'Last_Name' => 'Cartman Theodore 2nd'
+  },
+  duplicate_check_fields: ['Email']
+)
+```
+
+#### Delete a record
+
+```ruby
+service = ZohoCrm::Record::DeleteService.call(module_name: 'Contacts', id: '')
+```
+
+</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.
+
+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_crm.
+
+## 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/active_call-zoho_crm.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'zoho_crm'

data/lib/zoho_crm/access_token/facade.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ZohoCrm::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_crm/access_token/get_service.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class ZohoCrm::AccessToken::GetService < ZohoCrm::BaseService
+  skip_callback :call, :before, :set_access_token
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  # Get access token.
+  #
+  # ==== Examples
+  #
+  #   service = ZohoCrm::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,
+      grant_type:    'refresh_token'
+    }
+  end
+
+  def unauthorized?
+    response.status == 200 && response.body.key?('error')
+  end
+
+  def set_facade
+    @facade = ZohoCrm::AccessToken::Facade.new(response.body)
+  end
+end

data/lib/zoho_crm/base_service.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+class ZohoCrm::BaseService < ActiveCall::Base
+  include ActiveCall::Api
+
+  self.abstract_class = true
+
+  CACHE_KEY = { access_token: 'zoho_sign/base_service/access_token' }.freeze
+
+  config_accessor :base_url, default: 'https://www.zohoapis.com/crm/v7', instance_writer: false
+  config_accessor :cache, default: ActiveSupport::Cache::MemoryStore.new, instance_writer: false
+  config_accessor :logger, default: Logger.new($stdout), instance_writer: false
+  config_accessor :log_level, default: :info, instance_writer: false
+  config_accessor :log_headers, default: false, instance_writer: false
+  config_accessor :log_bodies, default: false, instance_writer: false
+  config_accessor :client_id, :client_secret, :refresh_token, instance_writer: false
+
+  attr_reader :access_token, :facade
+
+  before_call :set_access_token
+
+  validate on: :request do
+    next if is_a?(ZohoCrm::AccessToken::GetService) || is_a?(ZohoCrm::GrantToken::GetService)
+
+    errors.merge!(access_token_service.errors) if access_token.nil? && !access_token_service.success?
+  end
+
+  class << self
+    def exception_mapping
+      {
+        validation_error:              ZohoCrm::ValidationError,
+        request_error:                 ZohoCrm::RequestError,
+        client_error:                  ZohoCrm::ClientError,
+        server_error:                  ZohoCrm::ServerError,
+        bad_request:                   ZohoCrm::BadRequestError,
+        unauthorized:                  ZohoCrm::UnauthorizedError,
+        forbidden:                     ZohoCrm::ForbiddenError,
+        not_found:                     ZohoCrm::NotFoundError,
+        method_not_allowed:            ZohoCrm::MethodNotAllowedError,
+        not_acceptable:                ZohoCrm::NotAcceptableError,
+        proxy_authentication_required: ZohoCrm::ProxyAuthenticationRequiredError,
+        request_timeout:               ZohoCrm::RequestTimeoutError,
+        conflict:                      ZohoCrm::ConflictError,
+        gone:                          ZohoCrm::GoneError,
+        payload_too_large:             ZohoCrm::PayloadTooLargeError,
+        unsupported_media_type:        ZohoCrm::UnsupportedMediaTypeError,
+        unprocessable_entity:          ZohoCrm::UnprocessableEntityError,
+        too_many_requests:             ZohoCrm::TooManyRequestsError,
+        internal_server_error:         ZohoCrm::InternalServerError,
+        not_implemented:               ZohoCrm::NotImplementedError,
+        bad_gateway:                   ZohoCrm::BadGatewayError,
+        service_unavailable:           ZohoCrm::ServiceUnavailableError,
+        gateway_timeout:               ZohoCrm::GatewayTimeoutError
+      }.freeze
+    end
+  end
+
+  private
+
+  def connection
+    @_connection ||= Faraday.new do |conn|
+      conn.url_prefix = base_url
+      # conn.headers['If-Modified-Since'] = '2019-07-25T15:26:49+05:30'
+      conn.request :authorization, 'Zoho-oauthtoken', access_token
+      conn.request :json
+      conn.request :retry
+      conn.response :json
+      conn.response :logger, logger, **logger_options do |logger|
+        logger.filter(/(Authorization:).*"(.+)."/i, '\1 [FILTERED]')
+      end
+      conn.adapter Faraday.default_adapter
+    end
+  end
+
+  def logger_options
+    {
+      headers:   log_headers,
+      log_level: log_level,
+      bodies:    log_bodies,
+      formatter: Faraday::Logging::ColorFormatter, prefix: { request: 'ZohoCrm', response: 'ZohoCrm' }
+    }
+  end
+
+  def set_access_token
+    @access_token = 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
+
+  def access_token_service
+    @_access_token_service ||= ZohoCrm::AccessToken::GetService.call
+  end
+
+  def too_many_requests?
+    return false unless response.status == 400 && response.body.key?('error_description')
+
+    response.body['error_description'].include?('too many requests')
+  end
+end