ZCRMSDK 1.0.2 → 2.1.0

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

@@ -0,0 +1,149 @@
+require 'mysql2'
+require_relative 'token_store'
+require_relative '../oauth_token'
+require_relative '../../../crm/api/util/constants'
+
+module Store
+  # This class stores the user token details to the MySQL DataBase.
+  class DBStore < TokenStore
+    attr_accessor :user_name, :password, :port_number, :host, :database_name
+
+    # Creates an DBStore class instance with the specified parameters.
+    # @param host [string] A String containing the DataBase host name.
+    # @param database_name A String containing the DataBase name.
+    # @param user_name A String containing the DataBase user name.
+    # @param password A String containing the DataBase password.
+    # @param port_number A String containing the DataBase port number.
+    def initialize(host = nil, database_name = nil, user_name = nil, password = nil, port_number = nil)
+      @host = host.nil? ? Constants::MYSQL_HOST : host
+
+      @database_name = database_name.nil? ? Constants::MYSQL_DATABASE_NAME : database_name
+
+      @user_name = user_name.nil? ? Constants::MYSQL_USER_NAME : user_name
+
+      @password = password.nil? ? '' : password
+
+      @port_number = port_number.nil? ? Constants::MYSQL_PORT_NUMBER : port_number
+    end
+
+    def get_token(user, token)
+      con = Mysql2::Client.new(host: @host, username: @user_name, password: @password, database: @database_name, port: @port_number)
+
+      query = construct_db_query(user.email, token, false)
+
+      rs = con.query(query)
+
+      con.close
+
+      rs.each do |row|
+        oauthtoken = token
+
+        oauthtoken.access_token = row[Constants::ACCESS_TOKEN]
+
+        oauthtoken.expires_in = row[Constants::EXPIRY_TIME]
+
+        oauthtoken.refresh_token = row[Constants::REFRESH_TOKEN]
+
+        return oauthtoken
+      end
+      nil
+    rescue Mysql2::Error => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_DB_ERROR, nil, e)
+    end
+
+    def save_token(user, token)
+      con = Mysql2::Client.new(host: @host, username: @user_name, password: @password, database: @database_name, port: @port_number)
+      if token.is_a? Authenticator::OAuthToken
+        query = "insert into oauthtoken(user_mail,client_id,refresh_token,access_token,grant_token,expiry_time) values ('#{user.email}','#{token.client_id}','#{token.refresh_token}','#{token.access_token}','#{token.grant_token}','#{token.expires_in}')"
+        token.user_mail = user.email
+        delete_token(token)
+        con.query(query)
+      end
+
+      con.close
+    rescue Mysql2::Error => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::SAVE_TOKEN_DB_ERROR, nil, e)
+    end
+
+    def delete_token(token)
+      con = Mysql2::Client.new(host: @host, username: @user_name, password: @password, database: @database_name, port: @port_number)
+      if token.is_a? Authenticator::OAuthToken
+        query = construct_db_query(token.user_mail, token, true)
+
+        con.query(query)
+      end
+
+      con.close
+    rescue Mysql2::Error => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::DELETE_TOKEN_DB_ERROR, nil, e)
+    end
+
+    def delete_tokens
+      con = Mysql2::Client.new(host: @host, username: @user_name, password: @password, database: @database_name, port: @port_number)
+
+      query = 'delete from oauthtoken'
+
+      con.query(query)
+
+      con.close
+    rescue Mysql2::Error => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::DELETE_TOKENS_DB_ERROR, nil, e)
+    end
+
+    def get_tokens
+      tokens = []
+      con = Mysql2::Client.new(host: @host, username: @user_name, password: @password, database: @database_name, port: @port_number)
+
+      query = 'select * from oauthtoken;'
+
+      rs = con.query(query)
+
+      con.close
+
+      rs.each do |row|
+        token_type = nil
+        token_value = nil
+        if !row[Constants::GRANT_TOKEN].nil? && row[Constants::GRANT_TOKEN].length.positive?
+          token_type = TokenType::GRANT
+          token_value = row[Constants::GRANT_TOKEN]
+        else
+          token_type = TokenType::REFRESH
+          token_value = row[Constants::REFRESH_TOKEN]
+        end
+
+        oauthtoken = Authenticator::OAuthToken.new(row[Constants::CLIENT_ID], nil, token_value, token_type)
+
+        oauthtoken.id = row[Constants::ID]
+
+        oauthtoken.user_mail = row[Constants::USER_MAIL]
+
+        oauthtoken.access_token = row[Constants::ACCESS_TOKEN]
+
+        oauthtoken.expires_in = row[Constants::EXPIRY_TIME]
+
+        oauthtoken.refresh_token = row[Constants::REFRESH_TOKEN]
+
+        tokens.push(oauthtoken)
+      end
+      tokens
+    rescue Mysql2::Error => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKENS_DB_ERROR, nil, e)
+    end
+
+    def construct_db_query(email, token, is_delete)
+      raise SDKException.new(Constants::USER_MAIL_NULL_ERROR, Constants::USER_MAIL_NULL_ERROR_MESSAGE) if email.nil?
+
+      query = is_delete ? 'delete from ' : 'select * from '
+
+      query += 'oauthtoken ' + "where user_mail='#{email}' and client_id='#{token.client_id}' and "
+
+      query += if token.grant_token.nil?
+                 "refresh_token='#{token.refresh_token}'"
+               else
+                 "grant_token='#{token.grant_token}'"
+               end
+
+      query
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+require 'csv'
+
+require_relative 'token_store'
+require_relative '../../../crm/api/util/constants'
+
+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::USER_MAIL, Constants::CLIENT_ID, Constants::REFRESH_TOKEN, Constants::ACCESS_TOKEN, Constants::GRANT_TOKEN, Constants::EXPIRY_TIME])
+      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[2] : grant_token == row[4]
+
+          if (row[0] == user_email) && (row[1] == client_id) && token_check
+            token.refresh_token = row[2]
+
+            token.access_token = row[3]
+
+            token.expires_in = row[5]
+            return token
+          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?
+          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
+
+          token = Authenticator::OAuthToken.new(row[1], nil, token_value, token_type)
+
+          token.user_mail = row[0]
+
+          token.refresh_token = row[2]
+
+          token.access_token = row[3]
+
+          token.expires_in = row[5]
+
+          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(user.email)
+
+        values_list.push(token.client_id)
+
+        values_list.push(token.refresh_token)
+
+        values_list.push(token.access_token)
+
+        values_list.push(token.grant_token)
+
+        values_list.push(token.expires_in)
+      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[:refresh_token] : grant_token == row[:grant_token]
+
+            row[:user_mail] == user_email and row[:client_id] == 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
+  end
+end

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

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

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

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

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

@@ -0,0 +1,68 @@
+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
+
+    def self.initialize(level, path)
+      Log.new(level, path)
+    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
+
+    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])
+      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.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?
+      @@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

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

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

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

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