ZOHOCRMSDK2_0 1.0.0 → 5.0.0

data/src/com/zoho/api/authenticator/store/token_store.rb

@@ -1,26 +1,35 @@
-module Store
-  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
+module ZOHOCRMSDK
+  module Store
+    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
+      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 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
+      # 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
+      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
   end
-end
+end

data/src/com/zoho/api/authenticator/token.rb

@@ -1,10 +1,12 @@
-module Authenticator
-  class Token
-    # This method to set authentication token to APIHTTPConnector instance.
-    # @param connector A APIHTTPConnector class instance.
-    # @raise SDKException
-    def authenticate(url_connection); end
+module ZOHOCRMSDK
+  module Authenticator
+    class Token
+      # This method to set authentication token to APIHTTPConnector instance.
+      # @param connector A APIHTTPConnector class instance.
+      # @raise SDKException
+      def authenticate(url_connection); end
 
-    def remove; end
+      def remove; end
+    end
   end
-end
+end

data/src/com/zoho/api/logger/sdk_logger.rb

@@ -2,67 +2,79 @@ require 'webrick/log'
 require 'webrick/accesslog'
 require 'logger'
 
-module SDKLog
-  class Log
-    attr_accessor :level, :path
-    def initialize(level, path)
-      @level = level
-      @path = path
-    end
+module ZOHOCRMSDK
+  module SDKLog
+    class Log
+      attr_reader :level , :path
+      def initialize(level,path)
+        @level = level
+        @path = path
+      end
 
-    def self.initialize(level, path)
-      Log.new(level, path)
+      def self.initialize(level:, path:nil)
+        Log.new(level, path)
+      end
+    
     end
-  end
 
-  class SDKLogger
-    @@path = nil
-    @@level = nil
-    @@log_levels_precedence = { 'FATAL' => 1,'SEVERE' => 1, 'ERROR' => 2, 'WARN' => 3, 'INFO' => 4, 'ALL' => 5,'DEBUG' => 5 ,'OFF' => 5}
-    @@logger = nil
+    class SDKLogger
+      @@path = nil
+      @@level = nil
+      @@log_levels_precedence = { 'FATAL' => 1,'SEVERE' => 1, 'ERROR' => 2, 'WARN' => 3, 'INFO' => 4, 'ALL' => 5,'DEBUG' => 5 ,'OFF' => 5}
+      @@logger = nil
 
-    def self.initialize(log)
-      if(log.level != Levels::OFF) && !log.path.nil? && log.path.length > 0 
-        File.new(log.path, 'w') unless File.exist? log.path if log.path != nil
-        sdk_logger = WEBrick::BasicLog.new(log.path, @@log_levels_precedence[log.level])
-      elsif !log.level.nil? and log.level == Levels::OFF
-        sdk_logger = WEBrick::BasicLog.new(nil, @@log_levels_precedence[log.level])
+      def self.initialize(log)
+
+        if !log.level.nil? && log.level != Levels::OFF && !log.path.nil? && log.path.length > 0 
+          if @@log_levels_precedence.key? log.level
+            File.new(log.path, 'w') unless File.exist? log.path if log.path != nil
+            sdk_logger = WEBrick::BasicLog.new(log.path, @@log_levels_precedence[log.level])
+          end
+        end
+
+        if !log.level.nil? && log.path.nil?
+          if  @@log_levels_precedence.key? log.level
+            sdk_logger = WEBrick::BasicLog.new(nil, @@log_levels_precedence[log.level])
+          end
+        end
+
+        @@logger = sdk_logger
+      rescue StandardError => e
+        raise SDKException.new(nil, Constants::LOGGER_INITIALIZATION_ERROR, nil, e)
       end
-      @@logger = sdk_logger
-    rescue StandardError => e
-      raise SDKException.new(nil, Constants::SDK_LOGGER_INITIALIZE, nil, e)
-    end
 
-    def self.info(message)
-      @@logger&.info(Time.new.to_s + ' ' + message)
-    end
+      def self.info(message)
+        @@logger&.info(Time.new.to_s + ' ' + message)
+      end
 
-    def self.error(message, exception = nil)
-      unless exception.nil?
-        exception.to_s
-        message = message + exception.to_s + exception.backtrace.join("\n")
+      def self.error(message, exception = nil)
+        unless exception.nil?
+          exception.to_s
+          message = message + exception.to_s + exception.backtrace.join("\n")
+        end
+        @@logger&.error(Time.new.to_s + ' ' + message)
       end
-      @@logger&.error(Time.new.to_s + ' ' + message)
-    end
 
-    def self.warn(message)
-      @@logger&.warn(Time.new.to_s + ' ' + message)
-    end
+      def self.warn(message)
+        @@logger&.warn(Time.new.to_s + ' ' + message)
+      end
 
-    def self.severe(message, exception = nil)
-      message = message + exception.to_s + exception.backtrace.join("\n") unless exception.nil?
-      @@logger&.fatal(Time.new.to_s + ' ' + message)
+      def self.severe(message, exception = nil)
+      
+        message = message + exception.to_s + exception.backtrace.join("\n") unless exception.nil?
+        @@logger&.fatal(Time.new.to_s + ' ' + message)
+      end
     end
   end
-end
 
-module Levels
-  SEVERE = 'SEVERE'
-  INFO = 'INFO'
-  WARNING = 'WARNING'
-  ERROR = 'ERROR'
-  DEBUG = 'DEBUG'
-  ALL = 'ALL'
-  OFF = 'OFF'
-  FATAL = 'FATAL'
-end
+  module Levels
+    SEVERE = 'SEVERE'
+    INFO = 'INFO'
+    WARNING = 'WARNING'
+    ERROR = 'ERROR'
+    DEBUG = 'DEBUG'
+    ALL = 'ALL'
+    OFF = 'OFF'
+    FATAL = 'FATAL'
+  end
+end

data/src/com/zoho/crm/api/attachments/action_handler.rb

@@ -1,10 +1,12 @@
-module Attachments
-  module ActionHandler
+module ZOHOCRMSDK
+  module Attachments
+    module ActionHandler
 
-    # Creates an instance of ActionHandler
-    def initialize
-    end
+      # Creates an instance of ActionHandler
+      def initialize
+      end
 
 
+    end
   end
 end

data/src/com/zoho/crm/api/attachments/action_response.rb

@@ -1,10 +1,12 @@
-module Attachments
-  module ActionResponse
+module ZOHOCRMSDK
+  module Attachments
+    module ActionResponse
 
-    # Creates an instance of ActionResponse
-    def initialize
-    end
+      # Creates an instance of ActionResponse
+      def initialize
+      end
 
 
+    end
   end
 end

data/src/com/zoho/crm/api/attachments/action_wrapper.rb

@@ -1,63 +1,65 @@
 require_relative '../util/model'
 
-module Attachments
-  require_relative 'action_handler'
-  class ActionWrapper
-    include Util::Model
-    include ActionHandler
-
-    # Creates an instance of ActionWrapper
-    def initialize
-      @data = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the data
-      # @return An instance of Array
+module ZOHOCRMSDK
+  module Attachments
+    require_relative 'action_handler'
+    class ActionWrapper
+      include Util::Model
+      include ActionHandler
 
-    def data
-      @data
-    end
+      # Creates an instance of ActionWrapper
+      def initialize
+        @data = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to data
-      # @param data [Array] An instance of Array
+        # The method to get the data
+        # @return An instance of Array
 
-    def data=(data)
-      if data!=nil and !data.is_a? Array
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
+      def data
+        @data
       end
-      @data = data
-      @key_modified['data'] = 1
-    end
 
-      # The method to check if the user has modified the given key
-      # @param key [String] A String
-      # @return A Integer value
+        # The method to set the value to data
+        # @param data [Array] An instance of Array
 
-    def is_key_modified(key)
-      if key!=nil and !key.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
-      end
-      if @key_modified.key?(key)
-        return @key_modified[key]
+      def data=(data)
+        if data!=nil and !data.is_a? Array
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Array', nil, nil)
+        end
+        @data = data
+        @key_modified['data'] = 1
       end
 
-      nil
-    end
+        # The method to check if the user has modified the given key
+        # @param key [String] A String
+        # @return A Integer value
 
-      # The method to mark the given key as modified
-      # @param key [String] A String
-      # @param modification [Integer] A Integer
+      def is_key_modified(key)
+        if key!=nil and !key.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+        end
+        if @key_modified.key?(key)
+          return @key_modified[key]
+        end
 
-    def set_key_modified(key, modification)
-      if key!=nil and !key.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+        nil
       end
-      if modification!=nil and !modification.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+
+        # The method to mark the given key as modified
+        # @param key [String] A String
+        # @param modification [Integer] A Integer
+
+      def set_key_modified(key, modification)
+        if key!=nil and !key.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+        end
+        if modification!=nil and !modification.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+        end
+        @key_modified[key] = modification
       end
-      @key_modified[key] = modification
-    end
 
+    end
   end
 end

data/src/com/zoho/crm/api/attachments/api_exception.rb

@@ -1,125 +1,127 @@
 require_relative '../util/choice'
 require_relative '../util/model'
 
-module Attachments
-  require_relative 'response_handler'
-  require_relative 'action_response'
-  require_relative 'action_handler'
-  class APIException
-    include Util::Model
-    include ResponseHandler
-    include ActionResponse
-    include ActionHandler
-
-    # Creates an instance of APIException
-    def initialize
-      @status = nil
-      @code = nil
-      @message = nil
-      @details = nil
-      @key_modified = Hash.new
-    end
-
-      # The method to get the status
-      # @return An instance of Util::Choice
-
-    def status
-      @status
-    end
+module ZOHOCRMSDK
+  module Attachments
+    require_relative 'response_handler'
+    require_relative 'action_response'
+    require_relative 'action_handler'
+    class APIException
+      include Util::Model
+      include ResponseHandler
+      include ActionResponse
+      include ActionHandler
+
+      # Creates an instance of APIException
+      def initialize
+        @status = nil
+        @code = nil
+        @message = nil
+        @details = nil
+        @key_modified = Hash.new
+      end
 
-      # The method to set the value to status
-      # @param status [Util::Choice] An instance of Util::Choice
+        # The method to get the status
+        # @return An instance of Util::Choice
 
-    def status=(status)
-      if status!=nil and !status.is_a? Util::Choice
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
+      def status
+        @status
       end
-      @status = status
-      @key_modified['status'] = 1
-    end
 
-      # The method to get the code
-      # @return An instance of Util::Choice
+        # The method to set the value to status
+        # @param status [Util::Choice] An instance of Util::Choice
 
-    def code
-      @code
-    end
+      def status=(status)
+        if status!=nil and !status.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @status = status
+        @key_modified['status'] = 1
+      end
 
-      # The method to set the value to code
-      # @param code [Util::Choice] An instance of Util::Choice
+        # The method to get the code
+        # @return An instance of Util::Choice
 
-    def code=(code)
-      if code!=nil and !code.is_a? Util::Choice
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
+      def code
+        @code
       end
-      @code = code
-      @key_modified['code'] = 1
-    end
 
-      # The method to get the message
-      # @return An instance of Util::Choice
+        # The method to set the value to code
+        # @param code [Util::Choice] An instance of Util::Choice
 
-    def message
-      @message
-    end
+      def code=(code)
+        if code!=nil and !code.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @code = code
+        @key_modified['code'] = 1
+      end
 
-      # The method to set the value to message
-      # @param message [Util::Choice] An instance of Util::Choice
+        # The method to get the message
+        # @return An instance of Util::Choice
 
-    def message=(message)
-      if message!=nil and !message.is_a? Util::Choice
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
+      def message
+        @message
       end
-      @message = message
-      @key_modified['message'] = 1
-    end
 
-      # The method to get the details
-      # @return An instance of Hash
+        # The method to set the value to message
+        # @param message [Util::Choice] An instance of Util::Choice
 
-    def details
-      @details
-    end
+      def message=(message)
+        if message!=nil and !message.is_a? Util::Choice
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
+        end
+        @message = message
+        @key_modified['message'] = 1
+      end
 
-      # The method to set the value to details
-      # @param details [Hash] An instance of Hash
+        # The method to get the details
+        # @return An instance of Hash
 
-    def details=(details)
-      if details!=nil and !details.is_a? Hash
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
+      def details
+        @details
       end
-      @details = details
-      @key_modified['details'] = 1
-    end
 
-      # The method to check if the user has modified the given key
-      # @param key [String] A String
-      # @return A Integer value
+        # The method to set the value to details
+        # @param details [Hash] An instance of Hash
 
-    def is_key_modified(key)
-      if key!=nil and !key.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
-      end
-      if @key_modified.key?(key)
-        return @key_modified[key]
+      def details=(details)
+        if details!=nil and !details.is_a? Hash
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
+        end
+        @details = details
+        @key_modified['details'] = 1
       end
 
-      nil
-    end
+        # The method to check if the user has modified the given key
+        # @param key [String] A String
+        # @return A Integer value
 
-      # The method to mark the given key as modified
-      # @param key [String] A String
-      # @param modification [Integer] A Integer
+      def is_key_modified(key)
+        if key!=nil and !key.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+        end
+        if @key_modified.key?(key)
+          return @key_modified[key]
+        end
 
-    def set_key_modified(key, modification)
-      if key!=nil and !key.is_a? String
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+        nil
       end
-      if modification!=nil and !modification.is_a? Integer
-        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+
+        # The method to mark the given key as modified
+        # @param key [String] A String
+        # @param modification [Integer] A Integer
+
+      def set_key_modified(key, modification)
+        if key!=nil and !key.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+        end
+        if modification!=nil and !modification.is_a? Integer
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+        end
+        @key_modified[key] = modification
       end
-      @key_modified[key] = modification
-    end
 
+    end
   end
 end