ZCRMSDK 1.0.2 → 3.0.0.beta

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

@@ -0,0 +1,273 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'monitor'
+
+require_relative 'token'
+require_relative '../../crm/api/util/constants'
+require_relative '../logger/sdk_logger'
+require_relative '../../crm/api/exception/sdk_exception'
+
+module Authenticator
+  # This class gets and refreshes the tokens based on the expiry time.
+  class OAuthToken < Token
+    attr_reader :client_id , :client_secret ,:redirect_url ,:grant_token
+    attr_accessor :refresh_token, :access_token ,:user_mail ,:id ,:expires_in
+    @@sync_lock = Monitor.new
+
+    # Creates an OAuthToken class instance with the specified parameters.
+    # @param client_id [string] A String containing the OAuth client id.
+    # @param client_secret [string] A String containing the OAuth client secret.
+    # @param grant_token [string]  A String containing the grant token.
+    # @param refresh_token [string] A String containing the refresh token.
+    # @param redirect_url [string]  A String containing the OAuth redirect URL.
+    # @param id [string] A String containing ID
+    
+    def initialize(client_id:, client_secret:, grant_token: nil, refresh_token: nil, redirect_url: nil,id: nil)
+      error ={}
+      unless client_id.is_a?(String)
+        error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_ID
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+      end
+
+      unless client_secret.is_a?(String)
+        error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_SECRET
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+      end
+
+      if !grant_token.nil? && !grant_token.is_a?(String)
+        error[Constants::ERROR_HASH_FIELD] = Constants::GRANT_TOKEN
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+      end
+
+      if !refresh_token.nil? && !refresh_token.is_a?(String)
+        error[Constants::ERROR_HASH_FIELD] = Constants::REFRESH_TOKEN
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+      end
+
+      if !redirect_url.nil? && !redirect_url.is_a?(String)
+        error[Constants::ERROR_HASH_FIELD] = Constants::REDIRECT_URL
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+      end
+
+      if !id.nil? && !id.is_a?(String)
+        error[Constants::ERROR_HASH_FIELD] = Constants::ID
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+      end
+
+      if  grant_token.nil? && refresh_token.nil?
+        error[Constants::ERROR_HASH_FIELD] = Constants::TYPE
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Constants::EXPECTED_TOKEN_TYPES
+
+        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+
+        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+      end
+      @client_id = client_id
+
+      @client_secret = client_secret
+
+      @redirect_url = redirect_url
+
+      @refresh_token = refresh_token
+
+      @grant_token = grant_token
+
+      @access_token = nil
+
+      @expires_in = nil
+
+      @user_mail = nil
+
+      @id = id
+    end
+    
+    def authenticate(url_connection)
+      @@sync_lock.synchronize do
+        initializer = Initializer.get_initializer
+        store = initializer.store
+        user = initializer.user
+
+        oauth_token = nil
+        if !@id.nil?
+          oauth_token = initializer.store.get_token_by_id(@id, self)
+        else
+          oauth_token = initializer.store.get_token(user, self)
+        end
+
+        token = ""
+
+        if oauth_token.nil?
+          token = @refresh_token.nil? ? generate_access_token(user, store).access_token : refresh_access_token(user, store).access_token
+        elsif oauth_token.expires_in.to_f - get_current_time_in_millis < 5000
+          SDKLog::SDKLogger.info(Constants::REFRESH_TOKEN_MESSAGE)
+          token = oauth_token.refresh_access_token(user, store).access_token
+        else
+          token = oauth_token.access_token
+        end
+
+        url_connection.headers[Constants::AUTHORIZATION] = Constants::OAUTH_HEADER_PREFIX + token
+      end
+    end
+
+    def remove
+      Initializer.get_initializer.store.delete_token(self)
+      true
+    rescue StandardError
+      false
+    end
+
+    def generate_access_token(user, store)
+      json_body = {}
+
+      json_body[Constants::CLIENT_ID] = @client_id
+
+      json_body[Constants::CLIENT_SECRET] = @client_secret
+ 
+      json_body[Constants::REDIRECT_URI] = @redirect_url if !@redirect_url.nil?
+
+      json_body[Constants::GRANT_TYPE] = Constants::GRANT_TYPE_AUTH_CODE
+
+      json_body[Constants::CODE] = @grant_token
+
+      response = get_response_from_server(json_body)
+
+      begin
+        parse_response(response)
+
+        generate_id()
+
+        store.save_token(user,self)
+      rescue SDKException => e
+        raise e
+      rescue StandardError => e
+        raise SDKException.new(nil, Constants::SAVE_TOKEN_ERROR, nil, e)
+      end
+      self
+    end
+
+    def refresh_access_token(user, store)
+      json_body = {}
+
+      json_body[Constants::CLIENT_ID] = @client_id
+
+      json_body[Constants::CLIENT_SECRET] = @client_secret
+
+      json_body[Constants::REDIRECT_URI] = @redirect_url if !@redirect_url.nil?
+
+      json_body[Constants::GRANT_TYPE] = Constants::REFRESH_TOKEN
+
+      json_body[Constants::REFRESH_TOKEN] = @refresh_token
+
+      response = get_response_from_server(json_body)
+
+      begin
+        parse_response(response)
+
+        generate_id()
+
+        store.save_token(user,self)
+      rescue SDKException => e
+        raise e
+      rescue StandardError => e
+        raise SDKException.new(nil, Constants::SAVE_TOKEN_ERROR, nil, e)
+      end
+      self
+    end
+
+    def parse_response(response)
+      response_json = JSON.parse(response)
+
+      unless response_json.key? Constants::ACCESS_TOKEN
+        raise SDKException.new(Constants::INVALID_CLIENT_ERROR, response_json[Constants::ERROR_KEY], nil, nil)
+      end
+
+      @access_token = response_json[Constants::ACCESS_TOKEN]
+
+      @expires_in = get_token_expiry_time(response_json)
+
+      @refresh_token = response_json[Constants::REFRESH_TOKEN] if response_json.key? Constants::REFRESH_TOKEN
+      self
+    end
+
+    def get_response_from_server(json_body)
+      accounts_url = Initializer.get_initializer.environment.accounts_url
+
+      url = URI(accounts_url)
+
+      http = Net::HTTP.new(url.host, url.port)
+
+      http.use_ssl = true
+
+      request = Net::HTTP::Post.new(url.request_uri)
+      request.add_field(Constants::USER_AGENT_KEY, Constants::USER_AGENT)
+      request.set_form(json_body, Constants::APPLICATION_FORM_URLENCODED)
+
+      response = http.request(request)
+
+      response.body
+    rescue StandardError => e
+      raise SDKException.new(nil, nil, nil, e)
+    end
+
+    def get_token_expiry_time(response_json)
+      expires_in = response_json[Constants::EXPIRES_IN]
+
+      expires_in *= 1000 unless response_json.key? Constants::EXPIRES_IN_SEC
+
+      expires_in += get_current_time_in_millis
+
+      expires_in
+    end
+
+    def get_current_time_in_millis
+      (Time.now.to_f * 1000).to_i
+    end
+
+    def generate_id
+      id = ""
+      email = Initializer.get_initializer.user.email
+      environment = Initializer.get_initializer.environment.name
+      id = id + "ruby_" +email[0..email.index(Constants::AT) - 1] + Constants::UNDERSCORE
+      id = id + environment + Constants::UNDERSCORE + @refresh_token[@refresh_token.length-4..@refresh_token.length-1]
+      @id = id
+    end
+  end
+end

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

@@ -0,0 +1,169 @@
+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_reader :user_name, :password, :port_number, :host, :database_name, :table_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 table_name A String containing the table 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: Constants::MYSQL_HOST, database_name: Constants::MYSQL_DATABASE_NAME ,table_name: Constants::MYSQL_TABLE_NAME,user_name: Constants::MYSQL_USER_NAME,password: '',port_number: Constants::MYSQL_PORT_NUMBER )
+      @host = host
+      @database_name = database_name
+      @table_name = table_name
+      @user_name = user_name
+      @password = password
+      @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 = Authenticator::OAuthToken.new(client_id: row[Constants::CLIENT_ID],client_secret: row[Constants::CLIENT_SECRET],grant_token: row[Constants::GRANT_TOKEN],refresh_token: row[Constants::REFRESH_TOKEN],redirect_url: row[Constants::REDIRECT_URL])
+
+        oauthtoken.id  = row[Constants::ID]
+
+        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 #{token.table_name}(id,user_mail,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url) values ('#{token.id}','#{user.email}','#{token.client_id}','#{token.client_secret}','#{token.refresh_token}','#{token.access_token}','#{token.grant_token}','#{token.expires_in}','#{token.redirect_url}')"
+        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 #{@table_name}"
+
+      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 #{@table_name}"
+
+      rs = con.query(query)
+
+      con.close
+
+      rs.each do |row|
+
+
+        oauthtoken = Authenticator::OAuthToken.new(client_id: row[Constants::CLIENT_ID],client_secret: row[Constants::CLIENT_SECRET],grant_token: grant_token,refresh_token: row[Constants::REFRESH_TOKEN])
+
+        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]
+
+        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 += "#{@table_name} 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
+    def get_token_by_id(id,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 = "select * from #{@table_name} where id='#{id}'" 
+
+        rs = con.query(query)
+
+        con.close
+
+        rs.each do |row|
+          if id == row[Constants::ID]
+            oauthtoken = Authenticator::OAuthToken.new(client_id: row[Constants::CLIENT_ID],client_secret: row[Constants::CLIENT_SECRET],grant_token: row[Constants::GRANT_TOKEN],refresh_token: row[Constants::REFRESH_TOKEN],redirect_url: row[Constants::REDIRECT_URL])
+
+            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]
+
+            return oauthtoken
+          end
+        end
+      end
+      nil
+    rescue Mysql2::Error => e
+      raise SDKException.new(Constants::TOKEN_STORE, Constants::GET_TOKEN_BY_ID_DB_ERROR, nil, e)
+    end
+  end
+end

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

@@ -0,0 +1,213 @@
+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::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 = Authenticator::OAuthToken.new(client_id: row[2],client_secret: row[3],grant_token: grant_token,refresh_token: row[4],redirect_url: redirect_url)
+
+            oauthtoken.id = row[0]
+
+            oauthtoken.user_mail = row[1]
+
+            oauthtoken.access_token = row[5]
+
+            oauthtoken.expires_in = row[7]
+            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: nil,grant_token: grant_token,refresh_token: row[4],redirect_url: redirect_url)
+            
+          token.id  = row[0]
+
+          token.user_mail = row[1]
+
+          token.access_token = row[5]
+
+          token.expires_in = row[7]
+
+          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[: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
+
+    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 = Authenticator::OAuthToken.new(client_id: row[2],client_secret: row[3],grant_token: grant_token,refresh_token: row[4],redirect_url: redirect_url)
+
+            oauthtoken.id = row[0]
+
+            oauthtoken.user_mail = row[1]
+
+            oauthtoken.access_token = row[5]
+
+            oauthtoken.expires_in = row[7]
+            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