ZOHOCRMSDK2_0 2.0.0 → 3.0.0

data/src/com/zoho/crm/api/header.rb

@@ -1,10 +1,12 @@
-# This class represents the HTTP header name
-class Header
-  attr_accessor :name, :class_name
-  # Creates an Header class instance with the specified header name.
-  # @param name [String] A String containing the header name.
-  def initialize(name, class_name = nil)
-    @name = name
-    @class_name = class_name
+module ZOHOCRMSDK
+  # This class represents the HTTP header name
+  class Header
+    attr_accessor :name, :class_name
+    # Creates an Header class instance with the specified header name.
+    # @param name [String] A String containing the header name.
+    def initialize(name, class_name = nil)
+      @name = name
+      @class_name = class_name
+    end
   end
 end

data/src/com/zoho/crm/api/header_map.rb

@@ -3,53 +3,55 @@ require_relative 'util/data_type_converter'
 require_relative 'exception/sdk_exception'
 require_relative 'util/header_param_validator'
 
-class HeaderMap
-  attr_accessor :header_hash
+module ZOHOCRMSDK
+  class HeaderMap
+    attr_accessor :header_hash
 
-  def initialize
-    @header_hash = {}
-  end
-
-  # This method is to add header name and value.
-  # @param header [Header] A Header class instance.
-  # @param value [Object] An object containing the header value.
-  def add(header, value)
-    unless header.is_a? Header
-      raise SDKException.new(Constants::HEADER_NULL_ERROR, Constants::HEADER_INSTANCE_NULL_ERROR)
+    def initialize
+      @header_hash = {}
     end
 
-    header_name = header.name
+    # This method is to add header name and value.
+    # @param header [Header] A Header class instance.
+    # @param value [Object] An object containing the header value.
+    def add(header, value)
+      unless header.is_a? Header
+        raise SDKException.new(Constants::HEADER_NULL_ERROR, Constants::HEADER_INSTANCE_NULL_ERROR)
+      end
 
-    if header_name.nil?
-      raise SDKException.new(Constants::HEADER_NAME_NULL_ERROR, Constants::HEADER_NAME_NULL_ERROR_MESSAGE)
-    end
+      header_name = header.name
 
-    if value.nil?
-      raise SDKException.new(Constants::HEADER_NULL_ERROR, header_name + Constants::NULL_VALUE_ERROR_MESSAGE)
-    end
+      if header_name.nil?
+        raise SDKException.new(Constants::HEADER_NAME_NULL_ERROR, Constants::HEADER_NAME_NULL_ERROR_MESSAGE)
+      end
 
-    header_value = nil
+      if value.nil?
+        raise SDKException.new(Constants::HEADER_NULL_ERROR, header_name + Constants::NULL_VALUE_ERROR_MESSAGE)
+      end
 
-    if header.class_name.nil?
-      begin
-        header_value = value.to_s
-      rescue StandardError
-        header_value = value
+      header_value = nil
+
+      if header.class_name.nil?
+        begin
+          header_value = value.to_s
+        rescue StandardError
+          header_value = value
+        end
+      else
+        header_param_validator = Util::HeaderParamValidator.new
+        header_value = header_param_validator.validate(header, value)
       end
-    else
-      header_param_validator = Util::HeaderParamValidator.new
-      header_value = header_param_validator.validate(header, value)
-    end
 
-    header_value = header_value.to_s
-    if (@header_hash.key? header_name) && !@header_hash[header_name].nil?
-      existing_header_value = @header_hash[header_name]
+      header_value = header_value.to_s
+      if (@header_hash.key? header_name) && !@header_hash[header_name].nil?
+        existing_header_value = @header_hash[header_name]
 
-      existing_header_value = existing_header_value + ',' + header_value
+        existing_header_value = existing_header_value + ',' + header_value
 
-      @header_hash[header_name] = existing_header_value
-    else
-      @header_hash[header_name] = header_value
+        @header_hash[header_name] = existing_header_value
+      else
+        @header_hash[header_name] = header_value
+      end
     end
   end
-end
+end

data/src/com/zoho/crm/api/initializer.rb

@@ -5,216 +5,218 @@ require 'json'
 require_relative '../../api/logger/sdk_logger'
 require_relative 'util/constants'
 
-# This class to initialize Zoho CRM SDK.
-class Initializer
-  attr_accessor :json_details,:user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy
-  @@json_details = nil
+module ZOHOCRMSDK
+  # This class to initialize Zoho CRM SDK.
+  class Initializer
+    attr_accessor :json_details,:user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy
+    @@json_details = nil
 
-  Thread.current['initi'] = nil
+    Thread.current['initi'] = nil
 
-  def self.json_details
-    @@json_details
-  end
-
-  def self.initialize(user:, environment:, token:, store:, sdk_config:, resources_path:, log: nil, request_proxy: nil)
-    error = {}
+    def self.json_details
+      @@json_details
+    end
 
-    require_relative 'user_signature'
+    def self.initialize(user:, environment:, token:, store:, sdk_config:, resources_path:, log: nil, request_proxy: nil)
+      error = {}
 
-    unless user.is_a?(UserSignature)
-      error[Constants::ERROR_HASH_FIELD] = 'user'
+      require_relative 'user_signature'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
+      unless user.is_a?(UserSignature)
+        error[Constants::ERROR_HASH_FIELD] = 'user'
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
 
-    end
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
 
-    require_relative '../../crm/api/dc/datacenter'
+      end
 
-    unless environment.is_a?(DC::DataCenter::Environment)
-      error[Constants::ERROR_HASH_FIELD] = 'environment'
+      require_relative '../../crm/api/dc/datacenter'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
+      unless environment.is_a? (DC::DataCenter::Environment)
+        error[Constants::ERROR_HASH_FIELD] = 'environment'
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
 
-    end
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
 
-    require_relative '../../api/authenticator/token'
+      end
 
-    unless token.is_a?(Authenticator::Token)
-      error[Constants::ERROR_HASH_FIELD] = 'token'
+      require_relative '../../api/authenticator/token'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
+      unless token.is_a?(Authenticator::Token)
+        error[Constants::ERROR_HASH_FIELD] = 'token'
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
 
-    end
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
 
-    require_relative '../../api/authenticator/store/token_store'
+      end
 
-    unless store.is_a?(Store::TokenStore)
-      error[Constants::ERROR_HASH_FIELD] = 'store'
+      require_relative '../../api/authenticator/store/token_store'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Store::TokenStore
+      unless store.is_a?(Store::TokenStore)
+        error[Constants::ERROR_HASH_FIELD] = 'store'
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::STORE_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Store::TokenStore
 
-    end
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::STORE_ERROR_MESSAGE, error, nil)
 
-    require_relative 'sdk_config'
+      end
 
-    unless sdk_config.is_a?(SDKConfig)
-      error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
+      require_relative 'sdk_config'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
+      unless sdk_config.is_a?(SDKConfig)
+        error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
 
-    end
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
 
-    if !request_proxy.nil? && !sdk_config.is_a?(RequestProxy)
+      end
 
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::REQUEST_PROXY_ERROR, nil, nil)
-    end
+      if !request_proxy.nil? && !sdk_config.is_a?(RequestProxy)
 
-    if resources_path.nil? || resources_path.empty?
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_ERROR_MESSAGE, nil, nil)
-    end
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::REQUEST_PROXY_ERROR, nil, nil)
+      end
 
-    if !File.directory?(resources_path)
-      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_INVALID_ERROR_MESSAGE, nil, nil)
-    end
+      if resources_path.nil? || resources_path.empty?
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_ERROR_MESSAGE, nil, nil)
+      end
 
-    log = SDKLog::Log.initialize(level: Levels::INFO, path: File.join(Dir.pwd, Constants::LOGFILE_NAME)) if log.nil? 
-    SDKLog::SDKLogger.initialize(log)
+      if !File.directory?(resources_path)
+        raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_INVALID_ERROR_MESSAGE, nil, nil)
+      end
 
-    @@initializer = Initializer.new
+      log = SDKLog::Log.initialize(level: Levels::INFO, path: File.join(Dir.pwd, Constants::LOGFILE_NAME)) if log.nil? 
+      SDKLog::SDKLogger.initialize(log)
 
-    @@initializer.user = user
+      @@initializer = Initializer.new
 
-    @@initializer.environment = environment
+      @@initializer.user = user
 
-    @@initializer.sdk_config = sdk_config
+      @@initializer.environment = environment
 
-    @@initializer.token = token
+      @@initializer.sdk_config = sdk_config
 
-    @@initializer.store = store
+      @@initializer.token = token
 
-    @@initializer.resources_path = resources_path
+      @@initializer.store = store
 
-    @@initializer.request_proxy = request_proxy
+      @@initializer.resources_path = resources_path
 
-    @@json_details = get_JSONDetails
+      @@initializer.request_proxy = request_proxy
 
-    SDKLog::SDKLogger.info(Constants::INITIALIZATION_SUCCESSFUL + @@initializer.to_s)
-  rescue SDKException => e
-    raise e
-  rescue StandardError => e
-    raise SDKException.new(nil, Constants::INITIALIZATION_ERROR, nil, e)
-  end
+      @@json_details = get_JSONDetails
 
-  def self.get_JSONDetails
-    if @@json_details.nil? || @@json_details.length == 0
-      return JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
+      SDKLog::SDKLogger.info(Constants::INITIALIZATION_SUCCESSFUL + @@initializer.to_s)
+    rescue SDKException => e
+      raise e
+    rescue StandardError => e
+      raise SDKException.new(nil, Constants::INITIALIZATION_ERROR, nil, e)
     end
-    @@json_details
-  rescue StandardError => e
-    raise SDKException.new(nil, Constants::EXCEPTION_JSONDETAILS, nil, e)
-  end
 
-  def self.get_initializer
-    return Thread.current['initi'] unless Thread.current['initi'].nil?
+    def self.get_JSONDetails
+      if @@json_details.nil? || @@json_details.length == 0
+        return JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
+      end
+      @@json_details
+    rescue StandardError => e
+      raise SDKException.new(nil, Constants::EXCEPTION_JSONDETAILS, nil, e)
+    end
 
-    @@initializer
-  end
+    def self.get_initializer
+      return Thread.current['initi'] unless Thread.current['initi'].nil?
 
-  def self.switch_user(user:nil, environment:nil, token:nil, sdk_config:nil, request_proxy: nil)
-    
-    if @@initializer.nil?
-      raise SDKException.new(Constants::SDK_UNINITIALIZATION_ERROR, Constants::SDK_UNINITIALIZATION_MESSAGE)
+      @@initializer
     end
 
-    require_relative 'user_signature'
+    def self.switch_user(user:nil, environment:nil, token:nil, sdk_config:nil, request_proxy: nil)
+      
+      if @@initializer.nil?
+        raise SDKException.new(Constants::SDK_UNINITIALIZATION_ERROR, Constants::SDK_UNINITIALIZATION_MESSAGE)
+      end
 
-    if !user.nil? and !user.is_a?(UserSignature)
-      error[Constants::ERROR_HASH_FIELD] = 'user'
+      require_relative 'user_signature'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
+      if !user.nil? and !user.is_a?(UserSignature)
+        error[Constants::ERROR_HASH_FIELD] = 'user'
 
-      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
 
-    end
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USER_SIGNATURE_ERROR_MESSAGE, error, nil)
 
-    require_relative '../../crm/api/dc/datacenter'
+      end
 
-    if !environment.nil? and !environment.is_a?(DC::DataCenter::Environment)
-      error[Constants::ERROR_HASH_FIELD] = 'environment'
+      require_relative '../../crm/api/dc/datacenter'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
+      if !environment.nil? and !environment.is_a?(DC::DataCenter::Environment)
+        error[Constants::ERROR_HASH_FIELD] = 'environment'
 
-      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
 
-    end
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
 
-    require_relative '../../api/authenticator/token'
+      end
 
-    if !token.nil? and !token.is_a?(Authenticator::Token)
-      error[Constants::ERROR_HASH_FIELD] = 'token'
+      require_relative '../../api/authenticator/token'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
+      if !token.nil? and !token.is_a?(Authenticator::Token)
+        error[Constants::ERROR_HASH_FIELD] = 'token'
 
-      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
 
-    end
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
 
-    require_relative 'request_proxy'
+      end
 
-    if !request_proxy.nil? and !request_proxy.is_a?(RequestProxy)
-      error[Constants::ERROR_HASH_FIELD] = 'request_proxy'
+      require_relative 'request_proxy'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = RequestProxy
+      if !request_proxy.nil? and !request_proxy.is_a?(RequestProxy)
+        error[Constants::ERROR_HASH_FIELD] = 'request_proxy'
 
-      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::REQUEST_PROXY_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = RequestProxy
 
-    end
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::REQUEST_PROXY_ERROR_MESSAGE, error, nil)
 
-    require_relative 'sdk_config'
+      end
 
-    if !sdk_config.nil? and !sdk_config.is_a?(SDKConfig)
-      error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
+      require_relative 'sdk_config'
 
-      error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
+      if !sdk_config.nil? and !sdk_config.is_a?(SDKConfig)
+        error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
 
-      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
 
-    end
+        raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
 
-    initializer = Initializer.new
+      end
 
-    previous_initializer = Initializer.get_initializer
+      initializer = Initializer.new
 
-    initializer.user = user.nil? ? previous_initializer.user : user
+      previous_initializer = Initializer.get_initializer
 
-    initializer.environment = environment.nil? ? previous_initializer.environment : environment
+      initializer.user = user.nil? ? previous_initializer.user : user
 
-    initializer.sdk_config = sdk_config.nil? ? previous_initializer.sdk_config : sdk_config
+      initializer.environment = environment.nil? ? previous_initializer.environment : environment
 
-    initializer.token = token.nil? ? previous_initializer.token : token
+      initializer.sdk_config = sdk_config.nil? ? previous_initializer.sdk_config : sdk_config
 
-    initializer.store = @@initializer.store
+      initializer.token = token.nil? ? previous_initializer.token : token
 
-    initializer.resources_path = @@initializer.resources_path
+      initializer.store = @@initializer.store
 
-    initializer.request_proxy = request_proxy
+      initializer.resources_path = @@initializer.resources_path
 
-    Thread.current['initi'] = initializer
+      initializer.request_proxy = request_proxy
 
-    SDKLog::SDKLogger.info(Constants::INITIALIZATION_SWITCHED + initializer.to_s)
-  end
+      Thread.current['initi'] = initializer
 
-  def to_s
-    Constants::FOR_EMAIL_ID + Initializer.get_initializer.user.email + Constants::IN_ENVIRONMENT + Initializer.get_initializer.environment.url + '.'
+      SDKLog::SDKLogger.info(Constants::INITIALIZATION_SWITCHED + initializer.to_s)
+    end
+
+    def to_s
+      Constants::FOR_EMAIL_ID + Initializer.get_initializer.user.email + Constants::IN_ENVIRONMENT + Initializer.get_initializer.environment.url + '.'
+    end
   end
-end
+end