ZOHOCRMSDK2_0_docgo 6.2.0

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

@@ -0,0 +1,238 @@
+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
+
+        unless File.exist? @file_path
+          File.new(@file_path, 'w')
+          @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
+
+      def get_token(user, token)
+        if token.is_a? Authenticator::OAuthToken
+          file_contents = CSV.read(@file_path)
+
+          grant_token = token.grant_token
+
+          refresh_token = token.refresh_token
+
+          client_id = token.client_id
+
+          user_email = user.email
+
+          if user_email.nil?
+            raise SDKException.new(Constants::USER_MAIL_NULL_ERROR, Constants::USER_MAIL_NULL_ERROR_MESSAGE)
+          end
+
+          file_contents.each do |row|
+            token_check = grant_token.nil? ? refresh_token == row[4] : grant_token == row[6]
+            if (row[1] == user_email) && (row[2] == client_id) && token_check
+
+              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
+        end
+        nil
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_FILE_ERROR, nil, e)
+      end
+
+      def get_tokens
+        tokens = []
+        file_contents = CSV.table(@file_path)
+        file_contents.each do |row|
+          unless row == @csv_file.header_row?
+            grant_token = (!row[6].nil? &&  !row[6].empty?) ? row[6] : nil
+
+            redirect_url = (!row[8].nil? &&  !row[8].empty?) ? row[8] : nil
+
+            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.user_mail = row[1]
+
+            token.access_token = row[5]
+
+            token.expires_in = row[7]
+
+            token.redirect_url = redirect_url
+
+            tokens.push(token)
+          end
+        end
+
+        tokens
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKENS_FILE_ERROR, nil, e)
+      end
+
+      def save_token(user, token)
+        if token.is_a? Authenticator::OAuthToken
+
+          token.user_mail = user.email
+          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)
+
+          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
+      rescue StandardError => e
+        raise SDKException.new(Constants::TOKEN_STORE, Constants::SAVE_TOKEN_FILE_ERROR, nil, e)
+      ensure
+        @csv_file.close
+      end
+
+      def delete_token(token)
+        if token.is_a? Authenticator::OAuthToken
+        
+          grant_token = token.grant_token
+
+          refresh_token = token.refresh_token
+
+          client_id = token.client_id
+
+          user_email = token.user_mail
+
+          if user_email.nil?
+            raise SDKException.new(Constants::USER_MAIL_NULL_ERROR, Constants::USER_MAIL_NULL_ERROR_MESSAGE)
+          end
+
+          table = CSV.table(@file_path)
+
+          table.delete_if do |row|
+            unless row == @csv_file.header_row?
+        
+              token_check = grant_token.nil? ? refresh_token == row[4] : grant_token == row[6]
+            
+              row[1] == user_email and row[2] == client_id and token_check
+            end
+          end
+
+          File.open(@file_path, 'w') do |f|
+            f.write(table.to_csv)
+          end
+        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 == @csv_file.header_row?
+        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 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
+end

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

@@ -0,0 +1,35 @@
+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
+
+      # 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
+  end
+end

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

@@ -0,0 +1,12 @@
+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
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+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
+
+      def as_logger
+        return Logger.new(File.open(File::NULL, 'w')) if self.level == Levels::OFF
+
+        logger = self.path.nil? ? Logger.new(STDOUT) : Logger.new(self.path)
+        logger.level = self.level ? Object.const_get("Logger::#{self.level}") : Logger::INFO
+        logger
+      end
+    end
+
+    # Generic logger to support passing in a custom logger i.e. your application's Rails.logger
+    class SDKLogger
+      def self.initialize(log)
+        return @logger = log.as_logger if log.is_a?(Log)
+        @logger = log
+      rescue StandardError => e
+        raise SDKException.new(nil, Constants::LOGGER_INITIALIZATION_ERROR, nil, e)
+      end
+
+      def self.info(message)
+        @logger&.info("#{Time.new} #{message}")
+      end
+
+      def self.error(message, exception = nil)
+        message = "#{message}#{exception}#{exception.backtrace&.join("\n")}" unless exception.nil?
+        @logger&.error("#{Time.new} #{message}")
+      end
+
+      def self.warn(message)
+        @logger&.warn("#{Time.new} #{message}")
+      end
+
+      def self.severe(message, exception = nil)
+        message = "#{message}#{exception}#{exception.backtrace&.join("\n")}" unless exception.nil?
+        @logger&.fatal("#{Time.new} #{message}")
+      end
+    end
+  end
+
+  module Levels
+    SEVERE = 'FATAL'
+    INFO = 'INFO'
+    WARNING = 'WARN'
+    ERROR = 'ERROR'
+    DEBUG = 'DEBUG'
+    ALL = 'DEBUG'
+    OFF = 'OFF'
+    FATAL = 'FATAL'
+  end
+end

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

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

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

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

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

@@ -0,0 +1,65 @@
+require_relative '../util/model'
+
+module ZOHOCRMSDK
+  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
+
+      def data
+        @data
+      end
+
+        # The method to set the value to data
+        # @param data [Array] 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)
+        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
+
+      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/attachments/api_exception.rb

@@ -0,0 +1,127 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+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 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
+end