ZOHOCRMSDK2_0 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f0344d741c13094abf8b93a67139018a0b83895f612a9be53fb7e32f14217b
-  data.tar.gz: 8fc22f398327570fe85162016f887c280d2485e6ffdc6e82c671963a1bd7976e
+  metadata.gz: 03d299e56d131411933e4782f22b1dc9fa09c876cd65a499ee60bd4fed382c68
+  data.tar.gz: fb7567e5159da8d9c02ef5c81dc70e93b5156c46503559709c75a59115db254e
 SHA512:
-  metadata.gz: a30421d88bd8b9b915998fbfaecf567e7f99a2534f86427e0f8e804a6a55a247f31f36239287e22b7e1112ee7902b768b7f783f80180dfca77e6f951d605bc69
-  data.tar.gz: 7481d802d6be8ca33d3f723b560e312d21f49dfc6afa27e0e2ea03599f2a23458417d9a0a18fbf9ef7ba5e1ade40e0601cc41eb0718fb892ffd5e0569c78a209
+  metadata.gz: 7767ac62c6088b5fd12a0b96f431cbf7b8d2d1e7d02edfd087e5b3e642b70a1a95bef570ed54954dd2d7899807e64aabbd33069c0086607a4343858c52d98bf7
+  data.tar.gz: 669b4d9ee236a466f57a04f5248bae2e98e1a6a937f2332802604105e7a71aeb971abf55ea1ca257aab26de939166322f9d8737045a3ced9bdfa165c3aa74810

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

@@ -8,264 +8,270 @@ 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_accessor :client_id , :client_secret ,:redirect_url ,:grant_token,: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)
+module ZOHOCRMSDK
+  module Authenticator
+    # This class gets and refreshes the tokens based on the expiry time.
+    class OAuthToken < Token
+      attr_accessor :client_id , :client_secret ,:redirect_url ,:grant_token,: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
+        end
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+        unless client_secret.is_a?(String)
+          error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_SECRET
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      end
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      if !grant_token.nil? && !grant_token.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::GRANT_TOKEN
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+        end
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+        if !grant_token.nil? && !grant_token.is_a?(String)
+          error[Constants::ERROR_HASH_FIELD] = Constants::GRANT_TOKEN
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      end
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      if !refresh_token.nil? && !refresh_token.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::REFRESH_TOKEN
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+        end
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+        if !refresh_token.nil? && !refresh_token.is_a?(String)
+          error[Constants::ERROR_HASH_FIELD] = Constants::REFRESH_TOKEN
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      end
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      if !redirect_url.nil? && !redirect_url.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::REDIRECT_URL
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+        end
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+        if !redirect_url.nil? && !redirect_url.is_a?(String)
+          error[Constants::ERROR_HASH_FIELD] = Constants::REDIRECT_URL
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      end
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      if !id.nil? && !id.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::ID
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+        end
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+        if !id.nil? && !id.is_a?(String)
+          error[Constants::ERROR_HASH_FIELD] = Constants::ID
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      end
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      if  grant_token.nil? && refresh_token.nil?
-        error[Constants::ERROR_HASH_FIELD] = Constants::TYPE
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Constants::EXPECTED_TOKEN_TYPES
+        end
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+        if  grant_token.nil? && refresh_token.nil?
+          error[Constants::ERROR_HASH_FIELD] = Constants::TYPE
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
-      end
-      @client_id = client_id
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = Constants::EXPECTED_TOKEN_TYPES
 
-      @client_secret = client_secret
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      @redirect_url = redirect_url
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+        end
+        @client_id = client_id
 
-      @refresh_token = refresh_token
+        @client_secret = client_secret
 
-      @grant_token = grant_token
+        @redirect_url = redirect_url
 
-      @access_token = nil
+        @refresh_token = refresh_token
 
-      @expires_in = nil
+        @grant_token = grant_token
 
-      @user_mail = nil
+        @access_token = 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
+        @expires_in = nil
 
-        token = ""
+        @user_mail = nil
 
-        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
+        @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 @access_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
+          else
+            oauth_token = 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
-        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 remove
+        Initializer.get_initializer.store.delete_token(self)
+        true
+      rescue StandardError
+        false
+      end
 
-    def generate_access_token(user, store)
-      json_body = {}
+      def generate_access_token(user, store)
+        json_body = {}
 
-      json_body[Constants::CLIENT_ID] = @client_id
+        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::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::GRANT_TYPE] = Constants::GRANT_TYPE_AUTH_CODE
 
-      json_body[Constants::CODE] = @grant_token
+        json_body[Constants::CODE] = @grant_token
 
-      response = get_response_from_server(json_body)
+        response = get_response_from_server(json_body)
 
-      begin
-        parse_response(response)
+        begin
+          parse_response(response)
 
-        generate_id()
+          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)
+          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
-      self
-    end
 
-    def refresh_access_token(user, store)
-      json_body = {}
+      def refresh_access_token(user, store)
+        json_body = {}
 
-      json_body[Constants::CLIENT_ID] = @client_id
+        json_body[Constants::CLIENT_ID] = @client_id
 
-      json_body[Constants::CLIENT_SECRET] = @client_secret
+        json_body[Constants::CLIENT_SECRET] = @client_secret
 
-      json_body[Constants::REDIRECT_URI] = @redirect_url if !@redirect_url.nil?
+        json_body[Constants::REDIRECT_URI] = @redirect_url if !@redirect_url.nil?
 
-      json_body[Constants::GRANT_TYPE] = Constants::REFRESH_TOKEN
+        json_body[Constants::GRANT_TYPE] = Constants::REFRESH_TOKEN
 
-      json_body[Constants::REFRESH_TOKEN] = @refresh_token
+        json_body[Constants::REFRESH_TOKEN] = @refresh_token
 
-      response = get_response_from_server(json_body)
+        response = get_response_from_server(json_body)
 
-      begin
-        parse_response(response)
+        begin
+          parse_response(response)
 
-        generate_id()
+          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)
+          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
-      self
-    end
 
-    def parse_response(response)
-      response_json = JSON.parse(response)
+      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
+        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]
+        @access_token = response_json[Constants::ACCESS_TOKEN]
 
-      @expires_in = get_token_expiry_time(response_json)
+        @expires_in = get_token_expiry_time(response_json)
 
-      @refresh_token = response_json[Constants::REFRESH_TOKEN] if response_json.key? Constants::REFRESH_TOKEN
-      self
-    end
+        @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
+      def get_response_from_server(json_body)
+        accounts_url = Initializer.get_initializer.environment.accounts_url
 
-      url = URI(accounts_url)
+        url = URI(accounts_url)
 
-      http = Net::HTTP.new(url.host, url.port)
+        http = Net::HTTP.new(url.host, url.port)
 
-      http.use_ssl = true
+        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)
+        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 = http.request(request)
 
-      response.body
-    rescue StandardError => e
-      raise SDKException.new(nil, nil, nil, e)
-    end
+        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]
+      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 *= 1000 unless response_json.key? Constants::EXPIRES_IN_SEC
 
-      expires_in += get_current_time_in_millis
+        expires_in += get_current_time_in_millis
 
-      expires_in
-    end
+        expires_in
+      end
 
-    def get_current_time_in_millis
-      (Time.now.to_f * 1000).to_i
-    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
+      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
 end