ZOHOCRMSDK2_0 1.0.0 → 2.0.0

data/src/com/zoho/crm/api/request_proxy.rb

@@ -1,16 +1,15 @@
 require_relative 'util/constants'
 
 class RequestProxy
-  attr_accessor :host, :port, :user_name, :password
-  def initialize(host, port, user_name = nil, password = nil)
+  attr_reader :host , :port ,:user_name ,:password 
+  def initialize(host:, port:, user_name:, password:"")
+
     raise SDKException.new(Constants::REQUEST_PROXY_ERROR, Constants::HOST_ERROR_MESSAGE) if host.nil?
 
     raise SDKException.new(Constants::REQUEST_PROXY_ERROR, Constants::PORT_ERROR_MESSAGE) if port.nil?
-
     @host = host
     @port = port
     @user_name = user_name
     @password = password
-    @password = '' if password.nil?
   end
 end

data/src/com/zoho/crm/api/sdk_config.rb

@@ -1,49 +1,7 @@
 class SDKConfig
-  class Builder
-    def initialize
-      @auto_refresh_fields = false
-      @pick_list_validation = true
-      @open_timeout = 60
-      @read_timeout = 60
-      @write_timeout = 60
-      @keep_alive_timeout = 2
-    end
+  attr_reader :auto_refresh_fields , :pick_list_validation ,:open_timeout ,:read_timeout ,:write_timeout ,:keep_alive_timeout
 
-    def auto_refresh_fields(auto_refresh_fields)
-      @auto_refresh_fields = auto_refresh_fields
-      self
-    end
-
-    def pick_list_validation(pick_list_validation)
-      @pick_list_validation = pick_list_validation
-      self
-    end
-
-    def open_timeout(open_timeout)
-      @open_timeout = open_timeout
-      self
-    end
-
-    def read_timeout(read_timeout)
-      @read_timeout = read_timeout
-      self
-    end
-
-    def write_timeout(write_timeout)
-      @write_timeout = write_timeout
-      self
-    end
-
-    def keep_alive_timeout(keep_alive_timeout)
-      @keep_alive_timeout = keep_alive_timeout
-      self
-    end
-
-    def build
-      SDKConfig.new(@auto_refresh_fields, @pick_list_validation,@open_timeout,@read_timeout,@write_timeout,@keep_alive_timeout)
-    end
-  end
-  def initialize(auto_refresh_fields, pick_list_validation,open_timeout,read_timeout,write_timeout,keep_alive_timeout)
+  def initialize(auto_refresh_fields: false, pick_list_validation: true,open_timeout: 60,read_timeout: 60,write_timeout: 60,keep_alive_timeout: 2)
     @auto_refresh_fields = auto_refresh_fields
     @pick_list_validation = pick_list_validation
     @open_timeout = open_timeout
@@ -51,28 +9,4 @@ class SDKConfig
     @write_timeout = write_timeout
     @keep_alive_timeout = keep_alive_timeout
   end
-
-  def auto_refresh_fields
-    @auto_refresh_fields
-  end
-
-  def pick_list_validation
-    @pick_list_validation
-  end
-  
-  def open_timeout
-    @open_timeout   
-  end
-
-  def read_timeout
-    @read_timeout 
-  end
-
-  def write_timeout
-    @write_timeout
-  end
-
-  def keep_alive_timeout
-    @keep_alive_timeout 
-  end
 end

data/src/com/zoho/crm/api/util/api_http_connector.rb

@@ -24,7 +24,7 @@ module Util
     end
 
     def set_content_type_header
-      Constants::SET_TO_CONTENT_TYPE.each do |content_type|
+      Constants::SET_CONTENT_TYPE_HEADER.each do |content_type|
         if @url.include? content_type
           @headers[Constants::CONTENT_TYPE] = @content_type
           break
@@ -49,7 +49,6 @@ module Util
       http = nil
       initializer = Initializer.get_initializer
       request_proxy = initializer.request_proxy
-
       if request_proxy.nil?
         http = Net::HTTP.new(url.host, url.port)
       else
@@ -97,16 +96,17 @@ module Util
 
     def to_s
       req_headers = @headers.clone
-      req_headers [Constants::AUTHORIZATION] = Constants::CANT_DISCLOSE
+      req_headers[Constants::AUTHORIZATION] = Constants::CANT_DISCLOSE
       @request_method + ' - ' + Constants::URL + ' = ' + @url + ', ' + Constants::HEADERS + ' = ' + req_headers.to_s + ', ' + Constants::PARAMS + ' = ' + @parameters.to_s
     end
 
     def proxy_log(request_proxy)
+      proxy_log = Constants::PROXY_SETTINGS + Constants::PROXY_HOST + request_proxy.host + " , "
+      proxy_log += Constants::PROXY_PORT + request_proxy.port.to_s
       if request_proxy.user_name.nil?
-        'Proxy settings - Host : ' + request_proxy.host + ' , Port : ' + request_proxy.port.to_s
-      else
-        'Proxy settings - Host : ' + request_proxy.host + ' , Port : ' + request_proxy.port.to_s + ' , Proxy User : ' + request_proxy.user_name
+        proxy_log +=  " , " + Constants::PROXY_USER + request_proxy.user_name
       end
+      proxy_log
     end
   end
 end

data/src/com/zoho/crm/api/util/constants.rb

@@ -26,6 +26,8 @@ class Constants
 
   RESPONSECODE_BAD_REQUEST = 400
 
+  JSON_DETAILS_ERROR = "ERROR IN READING JSONDETAILS FILE"
+
   RESPONSECODE_AUTHORIZATION_ERROR = 401
 
   RESPONSECODE_FORBIDDEN = 403
@@ -94,17 +96,73 @@ class Constants
 
   HTTP = 'http'
 
+  DEFAULT_MODULENAME_VS_APINAME = {
+
+    "leads" => "Leads",
+
+    "contacts" => "Contacts",
+
+    "accounts" => "Accounts",
+
+    "deals" => "Deals",
+
+    "tasks" => "Tasks",
+
+    "events" => "Events",
+
+    "activities" => "Activities",
+
+    "calls" => "Calls",
+
+    "products" => "Products",
+
+    "quotes" => "Quotes",
+
+    "sales_orders" => "Sales_Orders",
+
+    "purchase_orders" => "Purchase_Orders",
+
+    "invoices" => "Invoices",
+
+    "campaigns" => "Campaigns",
+
+    "vendors" => "Vendors",
+
+    "price_books" => "Price_Books",
+
+    "cases" => "Cases",
+
+    "solutions" => "Solutions",
+
+    "visits" => "Visits",
+
+    "approvals" => "Approvals",
+
+    "notes" => "Notes",
+
+    "attachments" => "Attachments",
+
+    "actions_performed" => "Actions_Performed",
+
+}
+
+  USER_AGENT = "Mozilla/5.0"
+  
+  USER_AGENT_KEY = "user-agent"
+
   CONTENT_API_URL = 'content.zohoapis.com'
 
   INVALID_URL_ERROR = 'Invalid URI Error'
 
   ZOHO_SDK = 'X-ZOHO-SDK'
 
-  SDK_VERSION = '1.0.0'
+  SDK_VERSION = '2.0.0'
 
   ZOHO_API_VERSION = '2.0'
 
-  SET_TO_CONTENT_TYPE = ['/crm/bulk/v2/read', '/crm/bulk/v2/write']
+  SET_CONTENT_TYPE_HEADER = ['/crm/bulk/v2/read', '/crm/bulk/v2/write']
+
+  RESOURCE_PATH_INVALID_ERROR_MESSAGE = "Resource Path MUST be a valid directory."
 
   IS_GENERATE_REQUEST_BODY =[REQUEST_METHOD_POST,REQUEST_METHOD_PUT,REQUEST_METHOD_PATCH]
 
@@ -114,9 +172,7 @@ class Constants
     
   CRM = "crm"
   
-  API_VERSION = "v2"
-
-  PHOTO_SUPPORTED_MODULES = ["leads", "contacts", "accounts", "products", "vendors"]
+  PHOTO_SUPPORTED_MODULES = ["leads", "contacts", "accounts", "products", "vendors", "deals", "cases", "solutions"]
 
   PARAMETER_NULL_ERROR = 'NULL PARAMETER ERROR'
 
@@ -144,9 +200,9 @@ class Constants
 
   NULL_VALUE_ERROR_MESSAGE = ' MUST NOT be null'
 
-  PARAM_INSTANCE_NULL_ERROR = 'Param<T> Instance MUST NOT be null'
+  PARAM_INSTANCE_NULL_ERROR = 'Param Instance MUST NOT be null'
 
-  HEADER_INSTANCE_NULL_ERROR = 'Header<T> Instance MUST NOT be null'
+  HEADER_INSTANCE_NULL_ERROR = 'Header Instance MUST NOT be null'
 
   SDK_UNINITIALIZATION_ERROR = 'SDK UNINITIALIZED ERROR'
 
@@ -170,6 +226,16 @@ class Constants
 
   EXPIRY_TIME = 'expiry_time'
 
+  PROXY_SETTINGS = "Proxy settings - "
+	
+	PROXY_HOST = "Host: "
+	
+	PROXY_PORT = "Port: "
+	
+	PROXY_USER = "User: "
+	
+	PROXY_DOMAIN = "Domain: "
+
   USER_MAIL_NULL_ERROR = 'USER MAIL NULL ERROR'
 
   USER_MAIL_NULL_ERROR_MESSAGE = 'User Mail MUST NOT be null. Use setUserMail() to set value.'
@@ -180,6 +246,10 @@ class Constants
 
   GET_TOKEN_DB_ERROR = 'Exception in get_token - DBStore:'
 
+  GET_TOKEN_BY_ID_DB_ERROR = "Exception in getTokenById - DBStore : Given ID is invalid"
+
+  GET_TOKEN_BY_ID_FILE_ERROR = "Exception in getTokenById - FileStore : Given ID is invalid"
+
   GET_TOKENS_DB_ERROR = 'Exception in get_tokens - DBStore:'
 
   DELETE_TOKEN_DB_ERROR = 'Exception in delete_token - DBStore:'
@@ -190,6 +260,8 @@ class Constants
 
   GET_TOKEN_FILE_ERROR = 'Exception in get_token - FileStore:'
 
+  LOGGER_INITIALIZATION_ERROR = "Exception in Logger Initialization : "
+
   REFRESH_SINGLE_MODULE_FIELDS_ERROR = 'Exception in refreshing fields of module : '
 
   REFRESH_ALL_MODULE_FIELDS_ERROR = 'Exception in refreshing fields of all modules : '
@@ -216,8 +288,6 @@ class Constants
 
   DELETE_TOKENS_FILE_ERROR = 'Exception in delete_tokens - FileStore:'
 
-  SDK_LOGGER_INITIALIZE = 'Exception in Logger Initialization'
-
   DELETE_MODULE_FROM_FIELDFILE_ERROR = 'Exception in deleting module from Fields file'
 
   DELETE_FIELD_FILE_ERROR = 'Exception in deleting Current User Fields file'
@@ -232,7 +302,19 @@ class Constants
 
   GIVEN_VALUE = "given-value"
 
-  PHOTO_UPLOAD_ERROR_MESSAGE  = "The given module is not supported in API.";
+  GENERATED_TYPE = "generated_type"
+
+  GENERATED_TYPE_CUSTOM = "custom"
+
+  UPLOAD_PHOTO_UNSUPPORTED_MESSAGE = "Photo Upload Operation is not supported by the module: "
+
+  SDK_MODULE_METADATA = "SDK-MODULE-METADATA"
+
+  INVALID_MODULE_API_NAME_ERROR = "INVALID MODULE API NAME ERROR"
+
+  PROVIDE_VALID_MODULE_API_NAME = "PROVIDE VALID MODULE API NAME: "
+
+  UPLOAD_PHOTO_UNSUPPORTED_ERROR = "UPLOAD PHOTO UNSUPPORTED MODULE"
     
   INVALID_MODULE  = "INVALID_MODULE"
 
@@ -263,6 +345,8 @@ class Constants
   REQUEST_CATEGORY_UPDATE = 'UPDATE'
 
   MODULEPACKAGENAME = 'modulePackageName'
+  
+  MYSQL_TABLE_NAME = "oauthtoken"
 
   INITIALIZATION_SUCCESSFUL = 'Initialization successful'
 
@@ -495,19 +579,23 @@ class Constants
   HOST_ERROR_MESSAGE = 'Host MUST NOT be null.'
 
   PORT_ERROR_MESSAGE = 'Port MUST NOT be null.'
+
+  REQUEST_PROXY_ERROR_MESSAGE = "request_proxy must be instance of Request Proxy"
+  
+  USER_SIGNATURE_ERROR_MESSAGE = "user must be instance of UserSignature."
 	
-	USERSIGNATURE_ERROR_MESSAGE = "UserSignature MUST NOT be null."
-	
-	ENVIRONMENT_ERROR_MESSAGE = "Environment MUST NOT be null."
+  ENVIRONMENT_ERROR_MESSAGE = "environment must be instance of Environment."
 	
-	SDK_CONFIG_ERROR_MESSAGE = "sdkConfig MUST NOT be null."
+  SDK_CONFIG_ERROR_MESSAGE = "sdk_config must be instance of sdkConfig."
 
-  TOKEN_ERROR_MESSAGE = "Token MUST NOT be null."
+  TOKEN_ERROR_MESSAGE = "token must be instance of Token."
 	
-	STORE_ERROR_MESSAGE = "Store MUST NOT be null."
+  STORE_ERROR_MESSAGE = "store must be instance of Store."
 
   INITIALIZATION_EXCEPTION = 'Exception in initialization'
 
+  SWITCH_USER_EXCEPTION = 'Exception in Switch user'
+  
   SWITCH_USER_ERROR = "SWITCH USER ERROR"
 
   EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
@@ -535,4 +623,13 @@ class Constants
   PICKLIST = 'picklist'
 
   CONSENT_NAMESPACE = 'com.zoho.crm.api.record.Consent'
+
+  INVALID_TOKEN_ERROR = "INVALID TOKEN ERROR"
+
+  NO_ACCESS_TOKEN_ERROR = "ACCESS TOKEN IS NOT PRESENT IN RESPONSE"
+
+  CLIENT_ID_NULL_ERROR_MESSAGE = "ClientID MUST NOT be null"
+
+  CLIENT_SECRET_NULL_ERROR_MESSAGE = "ClientSecret MUST NOT be null"
+
 end

data/src/com/zoho/crm/api/util/converter.rb

@@ -56,7 +56,23 @@ module Util
       check = true
 
       unless value.nil? 
-        var_type = value.class.name
+        if key_details.key? Constants::INTERFACE and key_details[Constants::INTERFACE] == true
+          json_details = Initializer.get_initializer.json_details
+          interface_details = json_details[key_details[Constants::STRUCTURE_NAME]]
+          classes = interface_details[Constants::CLASSES]
+          check = false
+          classes.each do |each_class_name|
+            class_name_lower = each_class_name.to_s.downcase
+            value_class_name = til::Utility.path_to_package(value.class.name).downcase
+  
+            if class_name_lower.downcase == value_class_name
+              check = true
+              break
+            end
+          end
+        else
+          var_type = value.class.name
+        end
       end
   
       if Constants::DATA_TYPE.key? type 
@@ -70,7 +86,6 @@ module Util
                 instance_number = index
                 type = Constants::LIST_NAMESPACE + '(' + structure_name + ')'
                 var_type = Constants::LIST_NAMESPACE + '(' + class_name + ')'
-                expected_list_type = false
                 check = false
                
                 break
@@ -108,7 +123,9 @@ module Util
 
       if key_details.key?(Constants::VALUES) && (!key_details.key?(Constants::PICKLIST) || (key_details[Constants::PICKLIST] && Initializer.get_initializer.sdk_config.pick_list_validation))
         value = value.value if value.is_a? Util::Choice
-        unless key_details[Constants::VALUES].include? value
+
+        values_ja = key_details[Constants::VALUES]
+        unless values_ja.include? value
 
           unless instance_number.nil?
             error[Constants::INDEX] = instance_number 
@@ -120,7 +137,7 @@ module Util
 
           error[Constants::ERROR_HASH_FIELD] = member_name
 
-          error[Constants::ACCEPTED_VALUES] = key_details[Constants::VALUES]
+          error[Constants::ACCEPTED_VALUES] = values_ja
 
           raise SDKException.new(Constants::UNACCEPTED_VALUES_ERROR, nil, error, nil)
         end

data/src/com/zoho/crm/api/util/data_type_converter.rb

@@ -108,7 +108,10 @@ module Util
     # @raise Exception
     def self.pre_convert(obj, type)
       init
-      @@pre_converter_map[type].call(obj)
+      if @@pre_converter_map.key? type
+        return @@pre_converter_map[type].call(obj)
+      end
+      obj
     end
 
     # This method is to convert Java data to JSON data value.
@@ -118,7 +121,10 @@ module Util
     # @raise Exception
     def self.post_convert(obj, type)
       init
-      @@post_converter_map[type].call(obj)
+      if @@post_converter_map.key? type
+        return @@post_converter_map[type].call(obj)
+      end
+      obj
     end
 
     def self.pre_convert_object_data(obj)

data/src/com/zoho/crm/api/util/form_data_converter.rb

@@ -13,10 +13,10 @@ module Util
     end
 
     def append_to_request(request_base, request_object)
-      request_base.set_form(set_file_fody(request_object), Constants::MULTIPART_FORM_DATA) if request_object.is_a?(Hash)
+      request_base.set_form(set_file_body(request_object), Constants::MULTIPART_FORM_DATA) if request_object.is_a?(Hash)
     end
 
-    def set_file_fody(request_object)
+    def set_file_body(request_object)
       data = []
       request_object.each do |key, value|
         if value.is_a? Array
@@ -38,19 +38,7 @@ module Util
 
     def form_request(request_instance, class_path, instance_no, member_json_details = nil)
       require_relative '../initializer'
-      if  @common_api_handler.api_path.include? Constants::PHOTO
-        path = @common_api_handler.api_path.split("/")
-        if path.length == 6
-          module_api_name = path[3].downcase
-          if path[1].downcase == Constants::CRM && path[2].downcase == Constants::API_VERSION && path[5].downcase == Constants::PHOTO && !(Constants::PHOTO_SUPPORTED_MODULES.include? module_api_name) 
-            api_supported_module = Utility::api_supported_module
-            if api_supported_module.key?(module_api_name) && api_supported_module[module_api_name].downcase != "custom"
-              raise SDKException.new(Constants::INVALID_MODULE, Constants::PHOTO_UPLOAD_ERROR_MESSAGE)
-            end
-          end
-        end
-      end
-
+    
       package_name = Utility.path_to_package(class_path)
       class_details = Initializer.json_details[package_name]
       request_hash = {}
@@ -73,7 +61,7 @@ module Util
 
         member_data = request_instance.instance_variable_get(Constants::AT + member_name)
 
-        if !modified.nil? && (modified != 0) && value_checker(request_instance.class.name, member_name, member_details, member_data, @unique_hash, instance_no)
+        if !modified.nil? && (modified != 0) && !member_data.nil? && value_checker(request_instance.class.name, member_name, member_details, member_data, @unique_hash, instance_no)
           key_name = member_details[Constants::NAME]
           type = member_details[Constants::TYPE]
           if type.downcase == Constants::LIST_NAMESPACE.downcase