License

Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 
All rights reserved. 

Licensed under the Apache License, Version 2.0 (the "License"); 
you may not use this file except in compliance with the License. 
You may obtain a copy of the License at 

    http://www.apache.org/licenses/LICENSE-2.0 

Unless required by applicable law or agreed to in writing, software 
distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
See the License for the specific language governing permissions and 
limitations under the License.

ZOHO CRM RUBY SDK 2.1 for API version 2.1

Overview
Registering a Zoho Client
Environmental Setup
Including the SDK in your project
Persistence
- DataBase Persistence
- File Persistence
- Custom Persistence
Configuration
Initialization
Class Hierarchy
Responses And Exceptions
Multithreading in a Multi-user App
Sample Code

Overview

Zoho CRM RUBY SDK offers a way to create client Ruby applications that can be integrated with Zoho CRM.

Registering a Zoho Client

Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register your client app with Zoho. To register your app:

Visit this page https://api-console.zoho.com/
Click on ADD CLIENT.
Choose the Client Type.
Enter Client Name, Client Domain or Homepage URL and Authorized Redirect URIs. Click CREATE.
Your Client app will be created.
Select the created OAuth client.
Generate grant token by providing the necessary scopes, time duration (the duration for which the generated token is valid) and Scope Description.

Environmental Setup

RUBY SDK requires Ruby (version 2.6 and above) to be set up in your development environment.

Including the SDK in your project

Ruby SDK is available through Gem . You can download the gem using: gem install ZOHOCRMSDK2_1

You can include the SDK to your project using: require 'ZOHOCRMSDK2_1'

Token Persistence

Token persistence refers to storing and utilizing the authentication tokens that are provided by Zoho. There are three ways provided by the SDK in which persistence can be utilized. They are DataBase Persistence, File Persistence, and Custom Persistence.

DataBase Persistence(mysql)
File Persistence(csv)
Custom Persistence

Implementing OAuth Persistence

Once the application is authorized, OAuth access and refresh tokens can be used for subsequent user data requests to Zoho CRM. Hence, they need to be persisted by the client app.

The persistence is achieved by extending the Store::TokenStore class TokenStore, which has the following callback methods.

get_token(user, token) - invoked before firing a request to fetch the saved tokens. This method should return an implementation of Token object for the library to process it.
save_token(user, token) - invoked after fetching access and refresh tokens from Zoho.
delete_token(token) - invoked before saving the latest tokens.
get_tokens() - The method to retrieve all the stored tokens.
delete_tokens() - The method to delete all the stored tokens.
get_token_by_id(id, token) - This method is used to retrieve the user token details based on unique ID.

DataBase Persistence

In case the user prefers to use the default DataBase persistence, MySQL can be used.

The database name should be zohooauth.
There must be a table named oauthtoken with the following columns.
- id int(11)
- user_mail varchar(255)
- client_id varchar(255)
- client_secret varchar(255)
- refresh_token varchar(255)
- access_token varchar(255)
- grant_token varchar(255)
- expiry_time varchar(20)
- redirect_url varchar(255)

Note:

Custom database name and table name can be set in DBStore instance.

MySQL Query

CREATE TABLE  oauthtoken (
  id varchar(255) NOT NULL,
  user_mail varchar(255) NOT NULL,
  client_id varchar(255),
  client_secret varchar(255),
  refresh_token varchar(255),
  access_token varchar(255),
  grant_token varchar(255),
  expiry_time varchar(20),
  redirect_url varchar(255),
  primary key (id)
)

Create DBStore object

# 1 -> DataBase host name. Default value "localhost"
# 2 -> DataBase name. Default  value "zohooauth"
# 3 -> DataBase user name. Default value "root"
# 4 -> DataBase password. Default value ""
# 5 -> DataBase port number. Default value "3306"

tokenstore = ZOHOCRMSDK::Store::DBStore.new() 
tokenstore = ZOHOCRMSDK::Store::DBStore.new(host: "host_name", database_name: "database_name" ,table_name: "table_name",user_name: "user_name",password: "password",port_number:"port_number")

File Persistence

In case of default File Persistence, the user can persist tokens in the local drive, by providing the the absolute file path to the FileStore object.

The File contains.
- id
- user_mail
- client_id
- client_secret
- refresh_token
- access_token
- grant_token
- expiry_time
- redirect_url

Create FileStore object

#Parameter containing the absolute file path to store tokens
tokenstore = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt")

Custom Persistence

To use Custom Persistence, the user must extend ZOHOCRMSDK::Store::TokenStore and include the methods.

require 'ZOHOCRMSDK2_1'
# This class stores the user token details to the file.
  class TokenStore
    # This method is used to get the user token details.
    # @param user A UserSignature class instance.
    # @param token A Token class instance.
    # @return A Token class instance representing the user token details.
    # @raise SDKException
    def get_token(user, token); end

    def get_tokens; end

    # This method is used to store the user token details.
    # @param user A UserSignature class instance.
    # @param token A Token class instance.
    # @raise SDKException
    def save_token(user, token); end

    # This method is used to delete the user token details.
    # @param user A User class instance.
    # @param token A Token class instance.
    # @raise SDKException
    def delete_token(token); end

    def delete_tokens; end
    # This method is used to get the user token details.
    # @param user A UserSignature class instance.
    # @param id A String containing id
    # @return A Token class instance representing the user token details.
    # @raise SDKException
    def get_token_by_id(id, token); end
  end

Configuration

Before you get started with creating your Ruby application, you need to register your client and authenticate the app with Zoho.

Mandatory Keys	Optional Keys
user	logger
environment	store
token	sdk_config
	proxy
	resource_path

Create an instance of UserSignature that identifies the current user.

#Create an UserSignature instance that takes user Email as parameter
user_signature = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')

Configure the API environment which decides the domain and the URL to make API calls.

#Configure the environment
#which is of the pattern DC::Domain::Environment
#Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
#Available Environments: PRODUCTION, DEVELOPER, SANDBOX

environment = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION

Create an instance of ZOHOCRMSDK::Authenticator::OAuthToken with the information that you get after registering your Zoho client.

#Create a Token instance
#1 -> OAuth client id.
#2 -> OAuth client secret.
#3 -> grant token
#4 -> refresh token
#5 -> OAuth redirect URL.
#6 -> id 
#7 -> Access token

token = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL", id:"id", access_token:"access_token")

Create an instance of ZOHOCRMSDK::SDKLog::Log Class to log exception and API information. By default, the SDK constructs a Logger instance with level - INFO and file_path - (sdk_logs.log, created in the current working directory)

#
  # Create an instance of SDKLog::Log Class that takes two parameters
  # 1 -> Level of the log messages to be logged. Can be configured by typing Levels "::" and choose any level from the list displayed.
  # 2 -> Absolute file path, where messages need to be logged.
#
log = ZOHOCRMSDK::SDKLog::Log.initialize(level: ZOHOCRMSDK::Levels::INFO, path:"/Users/user_name/Documents/rubysdk_log.log")

Create an instance of TokenStore to persist tokens, used for authenticating all the requests. By default, the SDK creates the sdk_tokens.txt created in the current working directory) to persist the tokens.

# Create an instance of TokenStore.
# DBStore takes the following parameters
#1 -> DataBase host name. Default "localhost"
#2 -> DataBase name. Default "zohooauth"
#3 -> DataBase user name. Default "root"
#4 -> DataBase password. Default ""
#5 -> DataBase port number. Default "3306"
#6 -> DataBase table name. Default value "oauthtoken"

tokenstore = ZOHOCRMSDK::Store::DBStore.new(host: "host_name", database_name: "database_name", table_name: "table_name", user_name: "user_name",password: "password", port_number:"port_number")

tokenstore = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt")

tokenStore = CustomStore.new

Create an instance of SDKConfig containing the SDK configuration.

 # By default, the SDK creates the SDKConfig instance
 # auto_refresh_fields
 # if true - all the modules' fields will be auto-refreshed in the background, every    hour.
 # if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler (ZOHOCRMSDK::Util::ModuleFieldsHandler)
 #
 # pickListValidation
 # if true - value for any picklist field will be validated with the available values.
 # if false - value for any picklist field will not be validated, resulting in creation of a new value.
 #
 # open_timeout
 # Number of seconds to wait for the connection to open (default 60 seconds)
 # 
 # read_timeout
 # Number of seconds to wait for one block to be read (via one read(2) call) (default 60 seconds)
 # 
 # write_timeout
 # Number of seconds to wait for one block to be written (via one write(2) call) (default 60 seconds)
 # 
 # keep_alive_timeout
 # Seconds to reuse the connection of the previous request(default 2 seconds)
 # 

sdk_config = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false, pick_list_validation: true, open_timeout: 60, read_timeout: 60, write_timeout: 60,keep_alive_timeout: 2)

The path containing the absolute directory path to store user specific files containing module fields information. By default, the SDK stores the user-specific files within a folder in the current working directory.
```
resource_path = "/Users/user_name/Documents/rubysdk-application"
```

Create an instance of RequestProxy containing the proxy properties of the user.

request_proxy = ZOHOCRMSDK::RequestProxy.new(host:"proxyHost", post:"proxyPort", user_name:"proxyUser", password:"password")

Initializing the Application

Initialize the SDK using the following code.

require 'ZOHOCRMSDK2_1'

class Initialize
    def self.initialize() 
        # Create an instance of Log::SDKLog Class that takes two parameters
        #1 -> Level of the log messages to be logged. Can be configured by typing Levels "::" and choose any level from the list displayed.
        # 2 -> Absolute file path, where messages need to be logged.
        
        log = ZOHOCRMSDK::SDKLog::Log.initialize(level:ZOHOCRMSDK::Levels::INFO,path:"/Users/user_name/Documents/rubysdk_log.log")

        #Create an UserSignature instance that takes user Email as parameter
        user_signature = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')

        
        # Configure the environment
        # which is of the pattern Domain.Environment
        # Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
        # Available Environments: PRODUCTION, DEVELOPER, SANDBOX
        
        environment = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION

         #Create a Token instance
         #1 -> OAuth client id.
         #2 -> OAuth client secret.
         #3 -> grant token
         #4 -> refresh token
         #5 -> OAuth redirect URL.
         #6 -> id 
    
    
        token = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL", id:"id")

        #Create an instance of TokenStore.
        #1 -> DataBase host name. Default "localhost"
        #2 -> DataBase name. Default "zohooauth"
        #3 -> DataBase user name. Default "root"
        #4 -> DataBase password. Default ""
        #5 -> DataBase port number. Default "3306"

        tokenstore = ZOHOCRMSDK::Store::DBStore.new(host: "host_name", database_name: "database_name" ,table_name: "table_name",user_name: "user_name",password: "password",port_number:"port_number")

        #tokenstore = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt")

        # auto_refresh_fields
        # if true - all the modules' fields will be auto-refreshed in the background, every    hour.
        # if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler (ZOHOCRMSDK::Util::ModuleFieldsHandler)
        #
        # pickListValidation
        # if true - value for any picklist field will be validated with the available values.
        # if false - value for any picklist field will not be validated, resulting in creation of a new value.
        #
        # open_timeout
        # Number of seconds to wait for the connection to open (default 60 seconds)
        # 
        # read_timeout
        # Number of seconds to wait for one block to be read (via one read(2) call) (default 60 seconds)
        # 
        # write_timeout
        # Number of seconds to wait for one block to be written (via one write(2) call) (default 60 seconds)
        # 
        # keep_alive_timeout
        # Seconds to reuse the connection of the previous request(default 2 seconds)
        # 
        
        sdk_config = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false,pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)

        resource_path = "/Users/user_name/Documents/rubysdk-application"
        
        # Create an instance of RequestProxy class that takes the following parameters
        # 1 -> Host
        # 2 -> Port Number
        # 3 -> User Name
        # 4 -> Password
        
        request_proxy = ZOHOCRMSDK::RequestProxy.new(host:"proxyHost", post:"proxyPort", user_name:"proxyUser", password:"password")

        
        # The initialize method of Initializer class that takes the following arguments
        # 1 -> UserSignature instance
        # 2 -> Environment instance
        # 3 -> Token instance
        # 4 -> TokenStore instance
        # 5 -> SDKConfig instance
        # 6 -> resourcePath -A String
        # 7 -> Log instance (optional)
        # 8 -> RequestProxy instance (optional)

        #The following is the initialize method

        ZOHOCRMSDK::Initializer.initialize(user: user_signature, environment: environment, token: token, store: tokenstore, sdk_config: sdk_config, resources_path: resource_path,log:log,request_proxy: request_proxy)
    end
end

You can now access the functionalities of the SDK. Refer to the sample codes to make various API calls through the SDK.

Class Hierarchy

Responses and Exceptions

All SDK method calls return an instance of the APIResponse class.

Use the data_object to get the returned APIResponse object to obtain the response handler interface depending on the type of request (GET, POST,PUT,DELETE).

APIResponse&ltResponseHandler&gt and APIResponse&ltActionHandler&gt are the common wrapper objects for Zoho CRM APIs’ responses.

Whenever the API returns an error response, the response will be an instance of APIException class.

All other exceptions such as SDK anomalies and other unexpected behaviours are thrown under the SDKException class.

For operations involving records in Tags
- APIResponse&ltRecordActionHandler&gt
For getting Record Count for a specific Tag operation
- APIResponse&ltCountHandler&gt
For operations involving BaseCurrency
- APIResponse&ltBaseCurrencyActionHandler&gt
For Lead convert operation
- APIResponse&ltConvertActionHandler&gt
For retrieving Deleted records operation
- APIResponse&ltDeletedRecordsHandler&gt
For Record image download operation
- APIResponse&ltDownloadHandler&gt
For MassUpdate record operations
- APIResponse&ltMassUpdateActionHandler&gt
- APIResponse&ltMassUpdateResponseHandler&gt
For Transfer Pipeline operation
- APIResponse<TransferActionHandler>

GET Requests

The data_object variable of the returned APIResponse instance returns the response handler interface.
The ResponseHandler encompasses the following
- ResponseWrapper class (for application/json responses)
- FileBodyWrapper class (for File download responses)
- APIException class
The CountHandler encompasses the following
- CountWrapper class (for application/json responses)
- APIException class
The DeletedRecordsHandler encompasses the following
- DeletedRecordsWrapper class (for application/json responses)
- APIException class
The DownloadHandler encompasses the following
- FileBodyWrapper class (for File download responses)
- APIException class
The MassUpdateResponseHandler encompasses the following
- MassUpdateResponseWrapper class (for application/json responses)
- APIException class

POST, PUT, DELETE Requests

The data_object variable of the returned APIResponse instance returns the action handler interface.
The ActionHandler encompasses the following
- ActionWrapper class (for application/json responses)
- APIException class
The ActionWrapper class contains Property/Properties that may contain one/list of ActionResponse interfaces.
The ActionResponse encompasses the following
- SuccessResponse class (for application/json responses)
- APIException class
The ActionHandler encompasses the following
- ActionWrapper class (for application/json responses)
- APIException class
The RecordActionHandler encompasses the following
- RecordActionWrapper class (for application/json responses)
- APIException class
The BaseCurrencyActionHandler encompasses the following
- BaseCurrencyActionWrapper class (for application/json responses)
- APIException class
The MassUpdateActionHandler encompasses the following
- MassUpdateActionWrapper class (for application/json responses)
- APIException class
The ConvertActionHandler encompasses the following
- ConvertActionWrapper class (for application/json responses)
- APIException class
The TransferActionHandler interface encompasses the following
- TransferActionWrapper class (for application/json responses)
- APIException class

Threading in the Ruby SDK

Threads in a Ruby program help you achieve parallelism. By using multiple threads, you can make a Ruby program run faster and do multiple things simultaneously.

Multithreading in a Multi-user App

Multi-threading for multi-users is achieved using Initializer's static switch_user(). switch_user() takes the value initialized previously for user, enviroment, token and sdk_config incase None is passed (or default value is passed). In case of request_proxy, if intended, the value has to be passed again else None(default value) will be taken.

ZOHOCRMSDK::Initializer.switch_user(user: user, environment:environment, token:token, sdk_config:sdk_config)

ZOHOCRMSDK::Initializer.switch_user(user: user, environment:environment, token:token, sdk_config:sdk_config,request_proxy:proxy)

Here is a sample code to depict multi-threading for a multi-user app.

require 'ZOHOCRMSDK2_1'
module MultiUser
    class MultiThreading
        def initialize(module_api_name)
            @module_api_name = module_api_name
        end
        def execute(user_signature, environment, token,tokenstore, sdk_config,resources_path, log, proxy)
            ZOHOCRMSDK::Initializer.initialize(user: user_signature, environment: environment, token: token, store: tokenstore, sdk_config: sdk_config, resources_path: resource_path,log:log,request_proxy: proxy)
            token1 = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL","id")
            user1 = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')
            environment1 = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION
            sdk_config1 = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false,pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)
            t1 = Thread.new{func1(user1,environment1,token1,sdk_config1)}
            token2 = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL","id")
            user2 = ZOHOCRMSDK::UserSignature.new('dfg@zohocorp.com')
            environment2 = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION
            sdk_config2 = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false,pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)
            t2 = Thread.new{func1(user2,environment2,token2,sdk_config2)}
            t1.join
            t2.join
        end
        def func1(user,environment,token,sdk_config)
            ZOHOCRMSDK::Initializer.switch_user(user: user, environment:environment, token:token, sdk_config:sdk_config)
            print ZOHOCRMSDK::Initializer.get_initializer.user.email
            ro = ZOHOCRMSDK::Record::RecordOperations.new
            ro.get_records(@module_api_name,nil,nil)
        end
    end
end
log = ZOHOCRMSDK::SDKLog::Log.initialize(level:ZOHOCRMSDK::Levels::INFO,path:"/Users/user_name/Documents/rubysdk_log.log")
user_signature = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')
environment = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION
token = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL","id")
tokenstore = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt")
sdk_config = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false,pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)
proxy = ZOHOCRMSDK::RequestProxy.new(host:"proxyHost", post:"proxyPort", user_name:"proxyUser", password:"password")
module_api_name = "Leads"
resource_path = "/Users/user_name/Documents"
MultiUser::MultiThreading.new(module_api_name).execute(user_signature, environment, token,tokenstore, sdk_config,resource_path, log,proxy)

The program execution starts from execute().
The details of "user1" are given in the variables user1, token1, environment1.
Similarly, the details of another user "user2" are given in the variables user2, token2, environment2.
For each user, an instance of MultiThreading class is created.
When t1.join is called which in-turn invokes the thread which has the details of user1 are passed to the switch_user function through the func1(). Therefore, this creates a thread for user1.
Similarly, When the t2.join is invoked , the details of user2 are passed to the switch_user function through the func1(). Therefore, this creates a thread for user2.

Multi-threading in a Single User App

require 'ZOHOCRMSDK2_1'
module SingleUser
    class MultiThreading
        def execute(user_signature, environment, token,tokenstore, sdk_config,resources_path, log,proxy)
            ZOHOCRMSDK::Initializer.initialize(user: user_signature, environment: environment, token: token, store: tokenstore, sdk_config: sdk_config, resources_path: resource_path,log:log,request_proxy: proxy)
            t1 = Thread.new{func1("Leads")}
            t2 = Thread.new{func1("Deals")}
            t1.join
            t2.join
        end
        def func1(module_api_name)
            ro = ZOHOCRMSDK::Record::RecordOperations.new
            ro.get_records(module_api_name,nil,nil)
        end

    end
end

log = ZOHOCRMSDK::SDKLog::Log.initialize(level:ZOHOCRMSDK::Levels::INFO,path:"/Users/user_name/Documents/rubysdk_log.log")
user_signature = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')
environment = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION
token = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL","id")
tokenstore = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt")
sdk_config = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false,pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)
proxy = ZOHOCRMSDK::RequestProxy.new(host:"proxyHost", post:"proxyPort", user_name:"proxyUser", password:"password")
resource_path = "/Users/user_name/Documents/rubysdk-application"
SingleUser::MultiThreading.new.execute(user_signature, environment, token,tokenstore, sdk_config,resource_path, log,proxy)

The program execution starts from execute(). where the SDK is initialized with the details of user and an instance of MultiThreading class is created .
When the t1.join is called which in-turn invokes the func1(), the module_api_name is switched through the MultiThreading object. Therefore, this creates a thread for the particular operation
Similarly, When the t2.join is invoked , the module_api_name is switched through the MultiThreading object. Therefore, this creates a thread for the particular operation

SDK Sample code

require 'ZOHOCRMSDK2_1'
require 'date'
class Records
  def get_records
    # Create an instance of Log::SDKLog Class that takes two parameters
    #1 -> Level of the log messages to be logged. Can be configured by typing Levels "::" and choose any level from the list displayed.
    # 2 -> Absolute file path, where messages need to be logged.

    log = ZOHOCRMSDK::SDKLog::Log.initialize(level:ZOHOCRMSDK::Levels::INFO,path:"/Users/user_name/Documents/rubysdk_log.log")

    #Create an UserSignature instance that takes user Email as parameter
    user_signature = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')

    # Configure the environment
    # which is of the pattern Domain.Environment
    # Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
    # Available Environments: PRODUCTION, DEVELOPER, SANDBOX

    environment = ZOHOCRMSDK::DC::USDataCenter::PRODUCTION

    #Create a Token instance
    #1 -> OAuth client id.
    #2 -> OAuth client secret.
    #3 -> grant token
    #4 -> refresh token
    #5 -> OAuth redirect URL.
    #6 -> id 

    token = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL", id:"id")

    #Create an instance of TokenStore.
    #1 -> DataBase host name. Default "localhost"
    #2 -> DataBase name. Default "zohooauth"
    #3 -> DataBase user name. Default "root"
    #4 -> DataBase password. Default ""
    #5 -> DataBase port number. Default "3306"

    store = ZOHOCRMSDK::Store::DBStore.new(host: "host_name", database_name: "database_name" ,table_name: "table_name",user_name: "user_name",password: "password",port_number:"port_number")

    #store = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt")

    # auto_refresh_fields
    # if true - all the modules' fields will be auto-refreshed in the background, every    hour.
    # if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler (ZOHOCRMSDK::Util::ModuleFieldsHandler)
    #
    # pickListValidation
    # if true - value for any picklist field will be validated with the available values.
    # if false - value for any picklist field will not be validated, resulting in creation of a new value.
    #
    # open_timeout
    # Number of seconds to wait for the connection to open (default 60 seconds)
    # 
    # read_timeout
    # Number of seconds to wait for one block to be read (via one read(2) call) (default 60 seconds)
    # 
    # write_timeout
    # Number of seconds to wait for one block to be written (via one write(2) call) (default 60 seconds)
    # 
    # keep_alive_timeout
    # Seconds to reuse the connection of the previous request(default 2 seconds)
    # 

     sdk_config = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false,pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)

    resource_path = "/Users/user_name/Documents/rubysdk-application"
    # Create an instance of RequestProxy class that takes the following parameters
    # 1 -> Host
    # 2 -> Port Number
    # 3 -> User Name
    # 4 -> Password

    request_proxy = ZOHOCRMSDK::RequestProxy.new(host:"proxyHost", post:"proxyPort", user_name:"proxyUser", password:"password")

    # The initialize method of Initializer class that takes the following arguments
    # 1 -> UserSignature instance
    # 2 -> Environment instance
    # 3 -> Token instance
    # 4 -> TokenStore instance
    # 5 -> SDKConfig instance
    # 6 -> resourcePath -A String
    # 7 -> Log instance (optional)
    # 8 -> RequestProxy instance (optional)

    #The following is the initialize method

    ZOHOCRMSDK::Initializer.initialize(user: user_signature, environment: environment, token: token, store: store, sdk_config: sdk_config, resources_path: resource_path,log:log,request_proxy: request_proxy)
    # Get instance of RecordOperations Class
    ro = ZOHOCRMSDK::Record::RecordOperations.new
    # Get instance of ParameterMap Class
    pm = ZOHOCRMSDK::ParameterMap.new
    pm.add(ZOHOCRMSDK::Record::RecordOperations::GetRecordParam.approved, 'false')
    pm.add(ZOHOCRMSDK::Record::RecordOperations::GetRecordParam.converted, 'false')
    hm = ZOHOCRMSDK::HeaderMap.new
    hm.add(ZOHOCRMSDK::Record::RecordOperations::GetRecordHeader.If_modified_since, DateTime.new(2019, 8, 10, 4, 11, 9, '+03:00'))
    module_api_name = "Leads"
    response = ro.get_records(module_api_name,pm, hm)
    unless response.nil?
      status_code = response.status_code
      # Get the status code from response
      print "\n Status Code :" + status_code.to_s
      if [204, 304].include? status_code
        print(status_code == 204 ? 'No Content' : 'Not Modified')
        return
      end
      # Check if expected instance is received.
      if response.is_expected
        # Get object from response
        response_handler = response.data_object
        # Check if expected ResponseWrapper instance is received
        if response_handler.is_a? ZOHOCRMSDK::Record::ResponseWrapper

          records = response_handler.data
          records.each do |record|
            # Get the ID of each Record
            print "\n Record ID: "
            print record.id.to_s
            created_by = record.created_by
            # Check if created_by is not None
            unless created_by.nil?
              # Get the Name of the created_by User
              print "\n Record Created By User-Name: "
              print created_by.name
              # Get the ID of the created_by User
              print "\n Record Created By User-Id: "
              print created_by.id.to_s
              # Get the Email of the created_by User
              print "\n Record Created By User-Email: "
              print created_by.email
            end
            # Get the CreatedTime of each Record
            print "\n Record CreatedTime: "
            print record.created_time
            # Get the modified_by User instance of each Record
            modified_by = record.modified_by
            # Check if modifiedBy is not None
            unless modified_by.nil?
              # Get the Name of the modified_by User
              print "\n Record Modified By User-Name: "
              print modified_by.name
              # Get the ID of the modified_by User
              print "\n Record Modified By User-Id: "
              print modified_by.id.to_s
              # Get the Email of the modified_by User
              print "\n Record Modified By User-Email: "
              print modified_by.email
            end
            # Get the ModifiedTime of each Record
            print "\n Record ModifiedTime: "
            print record.modified_time
            tags = record.tag
            if !tags.nil? && tags.size.positive?
              tags.each do |tag|
                # Get the Name of each Tag
                print "\n Record Tag Name: "
                print tag.name
                # Get the Id of each Tag
                print "\n Record Tag ID: "
                print tag.id.to_s
              end
            end
            # To get particular field value
            print "\n Record Field Value: "
            print record.get_key_value('Last_Name')
            # To get particular KeyValues
            print "\n Record KeyValues:"
            record.get_key_values.each do |key_name, value|
              print "\n "
              unless value.nil?
                print key_name
                print value
              end
            end
          end
        end
      end
    end
  end
end
Records.new.get_records

ZCRMSDK

Runtime