ZCRMSDK 2.0.0 → 3.0.1

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

@@ -16,7 +16,7 @@ module Store
 
       unless File.exist? @file_path
         File.new(@file_path, 'w')
-        @csv_file = CSV.open(@file_path, 'a', write_headers: true, headers: [Constants::USER_MAIL, Constants::CLIENT_ID, Constants::REFRESH_TOKEN, Constants::ACCESS_TOKEN, Constants::GRANT_TOKEN, Constants::EXPIRY_TIME])
+        @csv_file = CSV.open(@file_path, 'a', write_headers: true, headers: [Constants::ID,Constants::USER_MAIL, Constants::CLIENT_ID,Constants::CLIENT_SECRET, Constants::REFRESH_TOKEN, Constants::ACCESS_TOKEN, Constants::GRANT_TOKEN, Constants::EXPIRY_TIME,Constants::REDIRECT_URL])
       end
       @csv_file = CSV.open(@file_path, 'a')
     end
@@ -38,15 +38,34 @@ module Store
         end
 
         file_contents.each do |row|
-          token_check = grant_token.nil? ? refresh_token == row[2] : grant_token == row[4]
+          token_check = grant_token.nil? ? refresh_token == row[4] : grant_token == row[6]
 
-          if (row[0] == user_email) && (row[1] == client_id) && token_check
-            token.refresh_token = row[2]
+          if (row[1] == user_email) && (row[2] == client_id) && token_check
 
-            token.access_token = row[3]
+            grant_token = (!row[6].nil? &&  !row[6].empty?) ? row[6] : nil
 
-            token.expires_in = row[5]
-            return token
+            redirect_url = (!row[8].nil? &&  !row[8].empty?) ? row[8] : nil
+            
+            oauthtoken = token
+
+            oauthtoken.id = row[0]
+
+            oauthtoken.user_mail = row[1]
+
+            oauthtoken.client_id = row[2]
+
+            oauthtoken.client_secret = row[3]
+
+            oauthtoken.refresh_token = row[4]
+
+            oauthtoken.access_token = row[5]
+    
+            oauthtoken.grant_token = grant_token
+
+            oauthtoken.expires_in = row[7]
+    
+            oauthtoken.redirect_url = redirect_url
+            return oauthtoken
           end
         end
       end
@@ -60,25 +79,21 @@ module Store
       file_contents = CSV.table(@file_path)
       file_contents.each do |row|
         unless row == @csv_file.header_row?
-          token_type = nil
-          token_value = nil
-          if !row[4].nil? && row[4].length.positive?
-            token_type = TokenType::GRANT
-            token_value = row[4]
-          else
-            token_type = TokenType::REFRESH
-            token_value = row[2]
-          end
+          grant_token = (!row[6].nil? &&  !row[6].empty?) ? row[6] : nil
 
-          token = Authenticator::OAuthToken.new(row[1], nil, token_value, token_type)
+          redirect_url = (!row[8].nil? &&  !row[8].empty?) ? row[8] : nil
 
-          token.user_mail = row[0]
+          token = Authenticator::OAuthToken.new(client_id: row[2],client_secret: row[3],grant_token: grant_token,refresh_token: row[4])
+            
+          token.id  = row[0]
 
-          token.refresh_token = row[2]
+          token.user_mail = row[1]
 
-          token.access_token = row[3]
+          token.access_token = row[5]
 
-          token.expires_in = row[5]
+          token.expires_in = row[7]
+
+          token.redirect_url = redirect_url
 
           tokens.push(token)
         end
@@ -96,10 +111,14 @@ module Store
         delete_token(token)
         values_list = []
 
+        values_list.push(token.id)
+
         values_list.push(user.email)
 
         values_list.push(token.client_id)
 
+        values_list.push(token.client_secret)
+
         values_list.push(token.refresh_token)
 
         values_list.push(token.access_token)
@@ -107,6 +126,8 @@ module Store
         values_list.push(token.grant_token)
 
         values_list.push(token.expires_in)
+
+        values_list.push(token.redirect_url)
       end
       @csv_file = CSV.open(@file_path, 'a') if @csv_file.closed?
       @csv_file << values_list
@@ -161,5 +182,54 @@ module Store
     rescue StandardError => e
       raise SDKException.new(Constants::TOKEN_STORE, Constants::DELETE_TOKENS_FILE_ERROR, nil, e)
     end
+
+    def get_token_by_id(id, token)
+      if token.is_a? Authenticator::OAuthToken
+
+        is_row_present = false
+        
+        file_contents = CSV.read(@file_path)
+
+        file_contents.each do |row|
+
+          if row[0] == id 
+
+            is_row_present = true
+
+            grant_token = (!row[6].nil? &&  !row[6].empty?) ? row[6] : nil
+
+            redirect_url = (!row[8].nil? &&  !row[8].empty?) ? row[8] : nil
+
+            oauthtoken = token
+
+            oauthtoken.id = row[0]
+
+            oauthtoken.user_mail = row[1]
+
+            oauthtoken.client_id = row[2]
+
+            oauthtoken.client_secret = row[3]
+
+            oauthtoken.refresh_token = row[4]
+
+            oauthtoken.access_token = row[5]
+    
+            oauthtoken.grant_token = grant_token
+
+            oauthtoken.expires_in = row[7]
+    
+            oauthtoken.redirect_url = redirect_url
+    
+            return oauthtoken
+          end
+        end
+        if !is_row_present
+          raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_BY_ID_FILE_ERROR, nil, nil)
+        end
+      end
+      nil
+    rescue StandardError => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_BY_ID_FILE_ERROR, nil, e)
+    end
   end
 end

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

@@ -22,5 +22,12 @@ module Store
     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
 end

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

@@ -4,15 +4,16 @@ require 'logger'
 
 module SDKLog
   class Log
-    attr_accessor :level, :path
-    def initialize(level, path)
+    attr_reader :level , :path
+    def initialize(level,path)
       @level = level
       @path = path
     end
 
-    def self.initialize(level, path)
+    def self.initialize(level:, path:nil)
       Log.new(level, path)
     end
+   
   end
 
   class SDKLogger
@@ -22,15 +23,23 @@ module SDKLog
     @@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])
+
+      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::SDK_LOGGER_INITIALIZE, nil, e)
+      raise SDKException.new(nil, Constants::LOGGER_INITIALIZATION_ERROR, nil, e)
     end
 
     def self.info(message)

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

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module AssignmentRules
+  require_relative 'response_handler'
+  class APIException
+    include Util::Model
+    include ResponseHandler
+
+    # 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
+
+      # The method to set the value to status
+      # @param status [Util::Choice] 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)
+      end
+      @status = status
+      @key_modified['status'] = 1
+    end
+
+      # The method to get the code
+      # @return An instance of Util::Choice
+
+    def code
+      @code
+    end
+
+      # The method to set the value to code
+      # @param code [Util::Choice] 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)
+      end
+      @code = code
+      @key_modified['code'] = 1
+    end
+
+      # The method to get the message
+      # @return An instance of Util::Choice
+
+    def message
+      @message
+    end
+
+      # The method to set the value to message
+      # @param message [Util::Choice] 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)
+      end
+      @message = message
+      @key_modified['message'] = 1
+    end
+
+      # The method to get the details
+      # @return An instance of Hash
+
+    def details
+      @details
+    end
+
+      # The method to set the value to details
+      # @param details [Hash] 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)
+      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
+
+    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
+
+      nil
+    end
+
+      # 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
+
+  end
+end

data/src/com/zoho/crm/api/assignment_rules/assignment_rule.rb

@@ -0,0 +1,215 @@
+require_relative '../modules/module'
+require_relative '../users/user'
+require_relative '../util/model'
+
+module AssignmentRules
+  class AssignmentRule
+    include Util::Model
+
+    # Creates an instance of AssignmentRule
+    def initialize
+      @modified_time = nil
+      @created_time = nil
+      @default_assignee = nil
+      @module_1 = nil
+      @name = nil
+      @modified_by = nil
+      @id = nil
+      @description = nil
+      @created_by = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the modified_time
+      # @return An instance of DateTime
+
+    def modified_time
+      @modified_time
+    end
+
+      # The method to set the value to modified_time
+      # @param modified_time [DateTime] An instance of DateTime
+
+    def modified_time=(modified_time)
+      if modified_time!=nil and !modified_time.is_a? DateTime
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: DateTime', nil, nil)
+      end
+      @modified_time = modified_time
+      @key_modified['modified_time'] = 1
+    end
+
+      # The method to get the created_time
+      # @return An instance of DateTime
+
+    def created_time
+      @created_time
+    end
+
+      # The method to set the value to created_time
+      # @param created_time [DateTime] An instance of DateTime
+
+    def created_time=(created_time)
+      if created_time!=nil and !created_time.is_a? DateTime
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: DateTime', nil, nil)
+      end
+      @created_time = created_time
+      @key_modified['created_time'] = 1
+    end
+
+      # The method to get the default_assignee
+      # @return An instance of DefaultUser
+
+    def default_assignee
+      @default_assignee
+    end
+
+      # The method to set the value to default_assignee
+      # @param default_assignee [DefaultUser] An instance of DefaultUser
+
+    def default_assignee=(default_assignee)
+      if default_assignee!=nil and !default_assignee.is_a? DefaultUser
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: default_assignee EXPECTED TYPE: DefaultUser', nil, nil)
+      end
+      @default_assignee = default_assignee
+      @key_modified['default_assignee'] = 1
+    end
+
+      # The method to get the module
+      # @return An instance of Modules::Module
+
+    def module
+      @module_1
+    end
+
+      # The method to set the value to module
+      # @param module_1 [Modules::Module] An instance of Modules::Module
+
+    def module=(module_1)
+      if module_1!=nil and !module_1.is_a? Modules::Module
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: module_1 EXPECTED TYPE: Module', nil, nil)
+      end
+      @module_1 = module_1
+      @key_modified['module'] = 1
+    end
+
+      # The method to get the name
+      # @return A String value
+
+    def name
+      @name
+    end
+
+      # The method to set the value to name
+      # @param name [String] A String
+
+    def name=(name)
+      if name!=nil and !name.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: String', nil, nil)
+      end
+      @name = name
+      @key_modified['name'] = 1
+    end
+
+      # The method to get the modified_by
+      # @return An instance of Users::User
+
+    def modified_by
+      @modified_by
+    end
+
+      # The method to set the value to modified_by
+      # @param modified_by [Users::User] An instance of Users::User
+
+    def modified_by=(modified_by)
+      if modified_by!=nil and !modified_by.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', nil, nil)
+      end
+      @modified_by = modified_by
+      @key_modified['modified_by'] = 1
+    end
+
+      # The method to get the id
+      # @return A Integer value
+
+    def id
+      @id
+    end
+
+      # The method to set the value to id
+      # @param id [Integer] A Integer
+
+    def id=(id)
+      if id!=nil and !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      @id = id
+      @key_modified['id'] = 1
+    end
+
+      # The method to get the description
+      # @return A String value
+
+    def description
+      @description
+    end
+
+      # The method to set the value to description
+      # @param description [String] A String
+
+    def description=(description)
+      if description!=nil and !description.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: String', nil, nil)
+      end
+      @description = description
+      @key_modified['description'] = 1
+    end
+
+      # The method to get the created_by
+      # @return An instance of Users::User
+
+    def created_by
+      @created_by
+    end
+
+      # The method to set the value to created_by
+      # @param created_by [Users::User] An instance of Users::User
+
+    def created_by=(created_by)
+      if created_by!=nil and !created_by.is_a? Users::User
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', nil, nil)
+      end
+      @created_by = created_by
+      @key_modified['created_by'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    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
+
+      nil
+    end
+
+      # 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
+
+  end
+end