ZOHOCRMSDK5_0 1.0.0

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

@@ -0,0 +1,280 @@
+require 'csv'
+
+require_relative 'token_store'
+require_relative '../../../crm/api/util/constants'
+
+module ZOHOCRMSDK
+  module Store
+    # This class stores the user token details to the file.
+    class FileStore < TokenStore
+      attr_accessor :file_path
+
+      # Creates an FileStore class instance with the specified parameters.
+      # @param filePath A String containing the absolute file path to store tokens.
+      # @raise Exception
+      def initialize(file_path)
+        @file_path = file_path
+        @headers = [Constants::ID, Constants::USER_NAME, Constants::CLIENT_ID, Constants::CLIENT_SECRET, Constants::REFRESH_TOKEN, Constants::ACCESS_TOKEN, Constants::GRANT_TOKEN, Constants::EXPIRY_TIME, Constants::REDIRECT_URL, Constants::API_DOMAIN]
+        is_create =  false
+
+        if  (File.exist?(@file_path) && CSV.read(@file_path).empty?) || (!File.exist?@file_path)
+          File.new(@file_path, 'w')
+          @csv_file = CSV.open(@file_path, 'a', write_headers: true)
+          @csv_file << @headers
+          @csv_file.close
+          is_create = true
+        end
+
+        unless is_create
+          all_contents = CSV.read(@file_path)
+          headers = all_contents[0]
+          if !headers.nil? && headers.length == 9
+            all_contents = all_contents.map { |arr| arr + [nil] }
+            all_contents[0] = @headers
+            CSV.open(file_path, 'w') do |csv|
+              all_contents.each do |row|
+                csv << row
+              end
+            end
+          end
+        end
+        # @csv_file = CSV.open(@file_path, 'a')
+      end
+
+      def find_token(token)
+        return token unless token.is_a? Authenticator::OAuthToken
+
+        file_contents = CSV.read(@file_path)
+
+        is_row_present = false
+
+        oauth_token = token
+
+        file_contents.each do |row|
+          if row.length > 1
+            is_row_present = check_condition(oauth_token, row)
+            if is_row_present
+              set_merge_data(oauth_token, row)
+              return oauth_token
+            end
+          end
+        end
+        return nil unless is_row_present
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_FILE_ERROR, nil, e)
+        token
+      end
+
+      def get_tokens
+        tokens = []
+        file_contents = CSV.table(@file_path)
+        file_contents.each do |row|
+          unless row == file_contents.headers
+            oauth_token = Authenticator::OAuthToken.initialize
+            set_merge_data(oauth_token, row)
+            tokens.push(oauth_token)
+          end
+        end
+        tokens
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKENS_FILE_ERROR, nil, e)
+      end
+
+      def save_token(token)
+        if token.is_a? Authenticator::OAuthToken
+
+          is_row_present = false
+
+          oauth_token = token
+
+          all_contents = CSV.table(@file_path)
+
+          all_contents.each do |row|
+            if row.length > 1
+              if !oauth_token.id.nil?
+                id = get_data(row[0].to_s)
+                if !id.nil? && !oauth_token.id.nil? && id == oauth_token.id
+                  is_row_present = true
+                end
+              else
+                is_row_present = check_condition(oauth_token, row)
+              end
+              if is_row_present
+                set_merge_data(oauth_token, row)
+                target_index = all_contents.find_index(row)
+                if !target_index.nil?
+                  all_contents[target_index] = set_token(oauth_token)
+                end
+                break
+              end
+            else
+              target_index = all_contents.find_index(row)
+              if !target_index.nil?
+                all_contents.delete_at(target_index)
+              end
+            end
+          end
+
+          unless is_row_present
+            if !oauth_token.id.nil? || !oauth_token.user_signature.nil?
+              if oauth_token.refresh_token.nil? && oauth_token.grant_token.nil? && oauth_token.access_token.nil?
+                raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_FILE_ERROR1, nil, nil)
+              end
+            end
+            if oauth_token.id.nil?
+              new_id = generate_id(all_contents)
+              oauth_token.id = new_id
+            end
+            all_contents.push(set_token(oauth_token))
+          end
+          File.open(@file_path, 'w') do |f|
+            f.write(all_contents.to_csv)
+          end
+        end
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::SAVE_TOKEN_FILE_ERROR, nil, e)
+      end
+
+      def delete_token(id)
+
+        table = CSV.table(@file_path)
+
+        table.delete_if do |row|
+          unless row == table.headers
+            !get_data(row[0]).nil? and get_data(row[0]) == id
+          end
+        end
+
+        File.open(@file_path, 'w') do |f|
+          f.write(table.to_csv)
+        end
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::DELETE_TOKEN_FILE_ERROR, nil, e)
+      end
+
+      def delete_tokens
+        table = CSV.table(@file_path)
+
+        table.delete_if do |row|
+          true unless row == table.headers
+        end
+
+        File.open(@file_path, 'w') do |f|
+          f.write(table.to_csv)
+        end
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::DELETE_TOKENS_FILE_ERROR, nil, e)
+      end
+
+      def find_token_by_id(id)
+        is_row_present = false
+
+        oauth_token = Authenticator::OAuthToken.initialize
+
+        file_contents = CSV.read(@file_path)
+
+        file_contents.each do |row|
+
+          if row[0] == id
+
+            is_row_present = true
+
+            set_merge_data(oauth_token, row)
+
+            return oauth_token
+          end
+        end
+        if !is_row_present
+          raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_BY_ID_FILE_ERROR, nil, nil)
+        end
+      nil
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_BY_ID_FILE_ERROR, nil, e)
+      end
+
+
+      def set_token(oauth_token)
+        data = []
+        data.push(oauth_token.id)
+        data.push(!oauth_token.user_signature.nil? ? oauth_token.user_signature.name : nil)
+        data.push(oauth_token.client_id)
+        data.push(oauth_token.client_secret)
+        data.push(oauth_token.refresh_token)
+        data.push(oauth_token.access_token)
+        data.push(oauth_token.grant_token)
+        data.push(oauth_token.expires_in)
+        data.push(oauth_token.redirect_url)
+        data.push(oauth_token.api_domain)
+        data
+      end
+
+      def generate_id(all_contents)
+        max_value = 0
+
+        if !all_contents.nil?
+          all_contents.each do |row|
+            if !row.nil? && !row[0].nil? && (row[0].to_s).length > 0
+              if max_value < row[0].to_i
+                max_value = row[0].to_i
+              end
+            end
+          end
+        end
+        (max_value + 1).to_s
+      end
+      
+      def set_merge_data(oauth_token, next_record)
+        oauth_token.id = get_data(next_record[0]) if oauth_token.id.nil? || oauth_token.id == ""
+        if oauth_token.user_signature.nil?
+          name = get_data(next_record[1])
+          oauth_token.user_signature = UserSignature.new(name) unless name.nil?
+        end
+        oauth_token.client_id = get_data(next_record[2]) if oauth_token.client_id.nil?
+        oauth_token.client_secret = get_data(next_record[3]) if oauth_token.client_secret.nil?
+        oauth_token.refresh_token = get_data(next_record[4]) if oauth_token.refresh_token.nil?
+        oauth_token.access_token = get_data(next_record[5]) if oauth_token.access_token.nil?
+        oauth_token.grant_token = get_data(next_record[6]) if oauth_token.grant_token.nil?
+        if oauth_token.expires_in.nil?
+          expires_in = get_data(next_record[7])
+          oauth_token.expires_in = expires_in.to_s unless expires_in.nil?
+        end
+        oauth_token.redirect_url = get_data(next_record[8]) if oauth_token.redirect_url.nil?
+        oauth_token.api_domain = get_data(next_record[9]) if oauth_token.api_domain.nil?
+      end
+
+      def get_data(value)
+        value= value.to_s
+        !value.nil? && !value.empty? && value.length > 0 ? value : nil
+      end
+
+      def check_condition(oauth_token, next_record)
+        is_row_present = false
+        if !oauth_token.user_signature.nil?
+          name = oauth_token.user_signature.name
+          user_name = get_data(next_record[1])
+          if !name.nil? && name.length > 0 && !user_name.nil? && user_name.length > 0 && name==user_name
+            is_row_present = true
+          end
+        elsif !oauth_token.access_token.nil? && are_all_objects_null(oauth_token.client_id, oauth_token.client_secret)
+          access_token = get_data(next_record[5])
+          if !access_token.nil? && access_token.length > 0 && oauth_token.access_token.length > 0 && oauth_token.access_token == access_token
+            is_row_present = true
+          end
+        elsif (!oauth_token.refresh_token.nil? || !oauth_token.grant_token.nil?) && !oauth_token.client_id.nil? && !oauth_token.client_secret.nil?
+          grant_token = get_data(next_record[6])
+          refresh_token = get_data(next_record[4])
+          if !grant_token.nil? && grant_token.length > 0 && !oauth_token.grant_token.nil? && oauth_token.grant_token.length > 0 && oauth_token.grant_token == grant_token
+            is_row_present = true
+          elsif !refresh_token.nil? && refresh_token.length > 0 && !oauth_token.refresh_token.nil? && oauth_token.refresh_token.length > 0 && oauth_token.refresh_token == refresh_token
+            is_row_present = true
+          end
+        end
+        is_row_present
+      end
+
+      def are_all_objects_null(*objects)
+        objects.all?(&:nil?)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module ZOHOCRMSDK
+  module Store
+    class TokenStore
+      # This method is used to get the user token details.
+      # @param token A Token class instance.
+      # @return A Token class instance representing the user token details.
+      # @raise SDKException
+      def find_token(token); end
+
+      def get_tokens; end
+
+      # This method is used to store the user token details.
+      # @param token A Token class instance.
+      # @raise SDKException
+      def save_token(token); end
+
+      # This method is used to delete the user token details.
+      # @param id A String containing id
+      # @raise SDKException
+      def delete_token(id); end
+
+      def delete_tokens; end
+
+      # This method is used to get the user token details.
+      # @param id A String containing id
+      # @return A Token class instance representing the user token details.
+      # @raise SDKException
+      def find_token_by_id(id); end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+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 generate_token; end
+
+      def remove; end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+require 'webrick/log'
+require 'webrick/accesslog'
+require 'logger'
+
+module ZOHOCRMSDK
+  module SDKLog
+    class Log
+      attr_reader :level , :path
+      def initialize(level,path)
+        @level = level
+        @path = path
+      end
+
+      def self.initialize(level:, path:nil)
+        Log.new(level, path)
+      end
+    
+    end
+
+    class SilentLogger < WEBrick::BasicLog
+      def log(level, data) end # override log method for avoiding logs
+    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
+
+      def self.initialize(log)
+
+        if (!log.level.nil? && (log.level == Levels::OFF || log.path.nil? || log.path == "") )
+          sdk_logger = SilentLogger.new.log(log.level, log.path)
+        else
+          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
+        end
+
+        @@logger = sdk_logger
+      rescue StandardError => e
+        raise SDKException.new(nil, Constants::LOGGER_INITIALIZATION_ERROR, nil, e)
+      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")
+        end
+        @@logger&.error(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? || exception.backtrace.nil?
+        @@logger&.fatal(Time.new.to_s + ' ' + message)
+      end
+    end
+  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/appointment_preference/action_handler.rb

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

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

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

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

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module AppointmentPreference
+    require_relative 'action_handler'
+    class ActionWrapper
+      include Util::Model
+      include ActionHandler
+
+      # Creates an instance of ActionWrapper
+      def initialize
+        @appointment_preferences = nil
+        @key_modified = Hash.new
+      end
+
+        # The method to get the appointment_preferences
+        # @return An instance of ActionResponse
+
+      def appointment_preferences
+        @appointment_preferences
+      end
+
+        # The method to set the value to appointment_preferences
+        # @param appointment_preferences [ActionResponse] An instance of ActionResponse
+
+      def appointment_preferences=(appointment_preferences)
+        if appointment_preferences!=nil and !appointment_preferences.is_a? ActionResponse
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: ActionResponse', nil, nil)
+        end
+        @appointment_preferences = appointment_preferences
+        @key_modified['appointment_preferences'] = 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
+end

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

@@ -0,0 +1,127 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  module AppointmentPreference
+    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
+
+        # 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 A String value
+
+      def message
+        @message
+      end
+
+        # The method to set the value to message
+        # @param message [String] A String
+
+      def message=(message)
+        if message!=nil and !message.is_a? String
+          raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: String', 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
+end