ZOHOCRMSDK2_0 1.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e2e634ac64c557bfbb3054bb21f8a76ea05c3396aba162f88fa777832650c7e
-  data.tar.gz: 867335f19bdf382d60a6ad3f6e5698e08ae6cb6798ae9004cc258935ba2d62f4
+  metadata.gz: 6d849e9372013af6a6f78533714a2c066d78596043d8981911bb8892dafe27d0
+  data.tar.gz: 2e3ac3e7c53e0b1cc0c5f8e1138988b29391e3813c111aa7e2a7fd1365647de1
 SHA512:
-  metadata.gz: 625df3665f2738c53b53dc182e364451759bf23cb56e7a42edac2942c5a0a0c6bf16ae728b1de314ad281399ce73fe1f5b72fa76bf9e0a446e133609022636dc
-  data.tar.gz: bc375d637388404f7998acf4a6881ef3a8d871f37cea201fa0846b494af954b9f412c984d486cc1fa822b2c005112fc22934b41d63d1943c3736f9a0ee62cb7a
+  metadata.gz: b9b9cc0099cfcd90557cb7efe522f37e2e95e1c01e06848612de7097608d07b7fa03387a32155e1b1d69c222758bae0cd6eb47bc9dd3c1f9dc6136a6bd9d20d4
+  data.tar.gz: 9dbdc83281fd0b175a2b0bf3ed49e8beb3e4b3025558d0cbf9fc58bb9f2e3d2846c1d4f7c92699b9e6d7fcca8d3183409ca1c2eaf58ad850305cdedbd15ecd25

data/src/ZOHOCRMSDK2_0.rb

@@ -202,11 +202,17 @@ require 'com/zoho/crm/api/contact_roles/contact_role.rb'
 require 'com/zoho/crm/api/contact_roles/body_wrapper.rb'
 require 'com/zoho/crm/api/contact_roles/action_handler.rb'
 require 'com/zoho/crm/api/contact_roles/action_wrapper.rb'
+require 'com/zoho/crm/api/contact_roles/record_action_handler.rb'
+require 'com/zoho/crm/api/contact_roles/record_response_handler.rb'
+require 'com/zoho/crm/api/contact_roles/record_action_wrapper.rb'
+require 'com/zoho/crm/api/contact_roles/record_body_wrapper.rb'
+require 'com/zoho/crm/api/contact_roles/record_response_wrapper.rb'
 require 'com/zoho/crm/api/contact_roles/response_wrapper.rb'
 require 'com/zoho/crm/api/contact_roles/api_exception.rb'
 require 'com/zoho/crm/api/contact_roles/contact_roles_operations.rb'
 require 'com/zoho/crm/api/contact_roles/success_response.rb'
 require 'com/zoho/crm/api/contact_roles/action_response.rb'
+require 'com/zoho/crm/api/contact_roles/contact_role_wrapper.rb'
 require 'com/zoho/crm/api/contact_roles/response_handler.rb'
 require 'com/zoho/crm/api/layouts/layouts_operations.rb'
 require 'com/zoho/crm/api/layouts/section.rb'

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

@@ -8,210 +8,278 @@ 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
-    @@sync_lock = Monitor.new
+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: nil, client_secret: nil, grant_token: nil, refresh_token: nil, redirect_url: nil, id: nil, access_token: nil)
+        error = {}
+
+        if grant_token.nil? && refresh_token.nil? && id.nil? && access_token.nil?
+          raise SDKException.new(code:Constants::MANDATORY_VALUE_ERROR, message:Constants::MANDATORY_KEY_ERROR, details:Constants::OAUTH_MANDATORY_KEYS)
+        end
 
-    attr_accessor :client_id, :client_secret, :redirect_url, :grant_token, :refresh_token, :access_token, :expires_in, :user_mail, :id
+        if id.nil? and access_token.nil?
+          unless client_id.is_a?(String)
+            error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_ID
 
-    # 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 redirect_url [string]  A String containing the OAuth redirect URL.
-    # @param token [string]  A String containing the REFRESH/GRANT token.
-    # @param type A TokenType module variable containing the type of given token.
-    def initialize(client_id, client_secret, token, type, redirect_url = nil)
-      error = {}
+            error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      unless client_id.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_ID
+            error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+            raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+          end
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          unless client_secret.is_a?(String)
+            error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_SECRET
 
-      end
+            error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      unless client_secret.nil? || client_secret.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::CLIENT_SECRET
+            error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+            raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+          end
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          if !grant_token.nil? && !grant_token.is_a?(String)
+            error[Constants::ERROR_HASH_FIELD] = Constants::GRANT_TOKEN
 
-      end
+            error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      unless token.is_a?(String)
-        error[Constants::ERROR_HASH_FIELD] = Constants::TOKEN
+            error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
+            raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+          end
 
-        raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+          if !refresh_token.nil? && !refresh_token.is_a?(String)
+            error[Constants::ERROR_HASH_FIELD] = Constants::REFRESH_TOKEN
 
-      end
+            error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      unless TokenType::REFRESH.to_s.equal?(TokenType.const_get(type.to_s)) || TokenType::GRANT.to_s.equal?(TokenType.const_get(type.to_s))
-        error[Constants::ERROR_HASH_FIELD] = Constants::TYPE
+            error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-        error[Constants::ERROR_HASH_EXPECTED_TYPE] = Constants::EXPECTED_TOKEN_TYPES
+            raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-        error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
+          end
 
-        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
 
-      @client_id = client_id
+            error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-      @client_secret = client_secret
+            error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-      @redirect_url = redirect_url
+            raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
 
-      @refresh_token = (type == TokenType::REFRESH) ? token : nil
+          end
+        end
 
-      @grant_token = (type == TokenType::GRANT) ? token : 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
 
-    def authenticate(url_connection)
-      @@sync_lock.synchronize do
-        initializer = Initializer.get_initializer
-        store = initializer.store
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
+
+        end
 
-        user = initializer.user
+        if !access_token.nil? && !access_token.is_a?(String)
+          error[Constants::ERROR_HASH_FIELD] = Constants::ACCESS_TOKEN
 
-        oauth_token = initializer.store.get_token(user, self)
+          error[Constants::ERROR_HASH_EXPECTED_TYPE] = String
 
-        token = nil
+          error[Constants::ERROR_HASH_CLASS] = OAuthToken.class
 
-        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
+          raise SDKException.new(Constants::INPUT_ERROR, nil, error, nil)
         end
 
-        url_connection.headers[Constants::AUTHORIZATION] = Constants::OAUTH_HEADER_PREFIX + token
-      end
-    end
+        @client_id = client_id
 
-    def remove
-      Initializer.get_initializer.store.delete_token(self)
-      true
-    rescue StandardError
-      false
-    end
+        @client_secret = client_secret
 
-    def generate_access_token(user, store)
-      json_body = {}
+        @redirect_url = redirect_url
 
-      json_body[Constants::CLIENT_ID] = @client_id
+        @refresh_token = refresh_token
 
-      json_body[Constants::CLIENT_SECRET] = @client_secret
+        @grant_token = grant_token
 
-      json_body[Constants::REDIRECT_URI] = @redirect_url
+        @access_token = access_token
 
-      json_body[Constants::GRANT_TYPE] = Constants::GRANT_TYPE_AUTH_CODE
+        @expires_in = nil
 
-      json_body[Constants::CODE] = @grant_token
+        @user_mail = nil
 
-      response = get_response_from_server(json_body)
+        @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.nil? && 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
 
-      begin
-        store.save_token(user, parse_response(response))
-      rescue SDKException => e
-        raise e
-      rescue StandardError => e
-        raise SDKException.new(nil, Constants::SAVE_TOKEN_ERROR, nil, e)
+      def remove
+        Initializer.get_initializer.store.delete_token(self)
+        true
+      rescue StandardError
+        false
       end
-      self
-    end
 
-    def refresh_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::CLIENT_SECRET] = @client_secret
+  
+        json_body[Constants::REDIRECT_URI] = @redirect_url if !@redirect_url.nil?
 
-      json_body[Constants::REDIRECT_URI] = @redirect_url
+        json_body[Constants::GRANT_TYPE] = Constants::GRANT_TYPE_AUTH_CODE
 
-      json_body[Constants::GRANT_TYPE] = Constants::REFRESH_TOKEN
+        json_body[Constants::CODE] = @grant_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
-        store.save_token(user, parse_response(response))
-      rescue SDKException => e
-        raise e
-      rescue StandardError => e
-        raise SDKException.new(nil, Constants::SAVE_TOKEN_ERROR, nil, e)
+          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
-      self
-    end
 
-    def parse_response(response)
-      response_json = JSON.parse(response)
+      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::GRANT_TYPE] = Constants::REFRESH_TOKEN
+
+        json_body[Constants::REFRESH_TOKEN] = @refresh_token
+
+        response = get_response_from_server(json_body)
 
-      unless response_json.key? Constants::ACCESS_TOKEN
-        raise SDKException.new(Constants::INVALID_CLIENT_ERROR, response_json[Constants::ERROR_KEY], nil, nil)
+        begin
+          parse_response(response)
+
+          if @id.nil?
+            generate_id()
+          end
+
+          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
 
-      @access_token = response_json[Constants::ACCESS_TOKEN]
+      def parse_response(response)
+        response_json = JSON.parse(response)
 
-      @expires_in = get_token_expiry_time(response_json)
+        unless response_json.key? Constants::ACCESS_TOKEN
+          raise SDKException.new(Constants::INVALID_CLIENT_ERROR, response_json[Constants::ERROR_KEY], nil, nil)
+        end
 
-      @refresh_token = response_json[Constants::REFRESH_TOKEN] if response_json.key? Constants::REFRESH_TOKEN
-      self
-    end
+        @access_token = response_json[Constants::ACCESS_TOKEN]
 
-    def get_response_from_server(json_body)
-      accounts_url = Initializer.get_initializer.environment.accounts_url
+        @expires_in = get_token_expiry_time(response_json)
 
-      url = URI(accounts_url)
+        @refresh_token = response_json[Constants::REFRESH_TOKEN] if response_json.key? Constants::REFRESH_TOKEN
+        self
+      end
 
-      http = Net::HTTP.new(url.host, url.port)
+      def get_response_from_server(json_body)
+        accounts_url = Initializer.get_initializer.environment.accounts_url
 
-      http.use_ssl = true
+        url = URI(accounts_url)
 
-      request = Net::HTTP::Post.new(url.request_uri)
+        http = Net::HTTP.new(url.host, url.port)
 
-      request.set_form(json_body, Constants::APPLICATION_FORM_URLENCODED)
+        http.use_ssl = true
 
-      response = http.request(request)
+        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.body
-    rescue StandardError => e
-      raise SDKException.new(nil, nil, nil, e)
-    end
+        response = http.request(request)
 
-    def get_token_expiry_time(response_json)
-      expires_in = response_json[Constants::EXPIRES_IN]
+        response.body
+      rescue StandardError => e
+        raise SDKException.new(nil, nil, nil, e)
+      end
 
-      expires_in *= 1000 unless response_json.key? Constants::EXPIRES_IN_SEC
+      def get_token_expiry_time(response_json)
+        expires_in = response_json[Constants::EXPIRES_IN]
 
-      expires_in += get_current_time_in_millis
+        expires_in *= 1000 unless response_json.key? Constants::EXPIRES_IN_SEC
 
-      expires_in
-    end
+        expires_in += get_current_time_in_millis
 
-    def get_current_time_in_millis
-      (Time.now.to_f * 1000).to_i
+        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 + (Constants::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
-
-# This module contains different types of token.
-module TokenType
-  GRANT = 'GRANT'.freeze
-  REFRESH = 'REFRESH'.freeze
-end
+end