ZCRMSDK 2.0.0 → 3.0.0.beta

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/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,18 +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 = {}

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

@@ -22,17 +22,78 @@ module Util
 
     @@apitype_vs_structurename = {}
 
-    @@api_supported_module ={}
-
     @@new_file = false
 
     @@get_modified_modules = false
 
     @@force_refresh = false
-    def self.api_supported_module
-      @@api_supported_module
+    def self.set_handler_api_path(module_api_name, handler_instance)
+      if handler_instance.nil?
+        return 
+      end
+      api_path = handler_instance.api_path
+      if module_api_name.downcase == api_path.downcase
+        api_path_split = api_path.split('/')
+        api_path_split.each do |api_path_split|
+          split_lower = api_path_split[i].downcase
+          if split_lower == module_api_name.downcase
+            api_path_splits[i] = module_api_name
+          elsif Constants::DEFAULT_MODULENAME_VS_APINAME.key? split_lower && !Constants::DEFAULT_MODULENAME_VS_APINAME[split_lower].nil?
+            api_path_splits[i] = Constants::DEFAULT_MODULENAME_VS_APINAME[split_lower]
+          end
+          api_path = api_path_splits.join("/")
+          handler_instance.api_path = api_path
+        end
+      end
+    end
+
+    def self.file_exists_flow(module_api_name,record_field_details_path,last_modified_time)
+      @@sync_lock.synchronize do
+        initializer = Initializer.get_initializer
+        record_field_details_json = JSON.parse(File.read(record_field_details_path))
+        last_modified_time_exists = false
+        if record_field_details_json.key?(Constants::FIELDS_LAST_MODIFIED_TIME) && !record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME].nil?
+          if get_current_time_in_millis - record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] > 3_600_000
+            last_modified_time_exists = true
+          end
+        end
+        if !record_field_details_json.key?(Constants::FIELDS_LAST_MODIFIED_TIME) || @@force_refresh
+          last_modified_time_exists = true
+        end
+        
+        if initializer.sdk_config.auto_refresh_fields && !@@new_file && !@@get_modified_modules && last_modified_time_exists
+          @@get_modified_modules = true
+          last_modified_time = (record_field_details_json.key? Constants::FIELDS_LAST_MODIFIED_TIME) ? record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] : nil
+          modify_fields(record_field_details_path, last_modified_time)
+          @@get_modified_modules = false
+        elsif !initializer.sdk_config.auto_refresh_fields && @@force_refresh && !@@get_modified_modules
+          @@get_modified_modules = true
+          modify_fields(record_field_details_path, last_modified_time)
+          @@get_modified_modules = false
+        end
+
+        record_field_details_json = JSON.parse(File.read(record_field_details_path))
+        return if module_api_name.nil? || record_field_details_json.key?(module_api_name.downcase)
+
+        fill_data_type
+
+        record_field_details_json[module_api_name.downcase] = {}
+
+        File.open(record_field_details_path, 'w') do |f|
+          f.write(record_field_details_json.to_json)
+        end
+        field_details = get_fields_details(module_api_name)
+        record_field_details_json = JSON.parse(File.read(record_field_details_path))
+
+        record_field_details_json[module_api_name.downcase] = field_details
+
+        File.open(record_field_details_path, 'w') do |f|
+          f.write(record_field_details_json.to_json)
+        end
+      end
     end
-    def self.get_fields(module_api_name)
+
+    def self.get_fields(module_api_name, handler_instance=nil)
       require_relative '../initializer'
       initializer = Initializer.get_initializer
       record_field_details_path = nil
@@ -46,62 +107,25 @@ module Util
 
           Dir.mkdir resoures_folder_path unless File.exist? resoures_folder_path
           record_field_details_path = get_record_json_file_path
-
+          module_api_name = verify_module_api_name(module_api_name)
+          set_handler_api_path(module_api_name,handler_instance)
+          
           if File.exist? record_field_details_path
-            record_field_details_json = JSON.parse(File.read(record_field_details_path))
-            last_modified_time_exists = false
-            if @@force_refresh
-              if record_field_details_json.key?(Constants::FIELDS_LAST_MODIFIED_TIME) && !record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME].nil?
-                if get_current_time_in_millis - record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] > 3_600_000
-                  last_modified_time_exists = true
-                end
-              end
-            end
-            if initializer.sdk_config.auto_refresh_fields && !@@new_file && !@@get_modified_modules && last_modified_time_exists
-              @@get_modified_modules = true
-              last_modified_time = (record_field_details_json.key? Constants::FIELDS_LAST_MODIFIED_TIME) ? record_field_details_json[Constants::FIELDS_LAST_MODIFIED_TIME] : nil
-              modify_fields(record_field_details_path, last_modified_time)
-              @@get_modified_modules = false
-            elsif !initializer.sdk_config.auto_refresh_fields && @@force_refresh && !@@get_modified_modules
-              @@get_modified_modules = true
-              modify_fields(record_field_details_path, last_modified_time)
-              @@get_modified_modules = false
-            end
-
-            record_field_details_json = JSON.parse(File.read(record_field_details_path))
-            return if module_api_name.nil? || record_field_details_json.key?(module_api_name.downcase)
-
-            fill_data_type
-
-            record_field_details_json[module_api_name.downcase] = {}
-
-            File.open(record_field_details_path, 'w') do |f|
-              f.write(record_field_details_json.to_json)
-            end
-            field_details = get_fields_details(module_api_name)
-            record_field_details_json = JSON.parse(File.read(record_field_details_path))
-
-            record_field_details_json[module_api_name.downcase] = field_details
-
-            File.open(record_field_details_path, 'w') do |f|
-              f.write(record_field_details_json.to_json)
-            end
-
+            file_exists_flow(module_api_name,record_field_details_path,last_modified_time)
           elsif initializer.sdk_config.auto_refresh_fields
             @@new_file = true
             fill_data_type
-            if @@api_supported_module.length == 0
-              @@api_supported_module = get_modules_api_names(nil)
-            end
+            api_supported_modules = get_modules(nil)
+            record_field_details_json  = File.exist? record_field_details_path ? JSON.parse(File.read(record_field_details_path)) : {}
            
             record_field_details_json = { Constants::FIELDS_LAST_MODIFIED_TIME => get_current_time_in_millis }
-            @@api_supported_module.each_key do |module_name|
+            api_supported_modules.each_key do |module_name|
               unless record_field_details_json.key? module_name.downcase
                 record_field_details_json[module_name.downcase] = {}
                 File.open(record_field_details_path, 'w') do |f|
                   f.write(record_field_details_json.to_json)
                 end
-                field_details = get_fields_details(module_name)
+                field_details = get_fields_details(api_supported_modules[module_name][Constants::API_NAME])
                 record_field_details_json = JSON.parse(File.read(record_field_details_path))
                 record_field_details_json[module_name.downcase] = field_details
                 File.open(record_field_details_path, 'w') do |f|
@@ -189,10 +213,30 @@ module Util
         f.write(record_field_details_json.to_json)
       end
       modified_modules.each_key do |module_api_name|
-        get_fields(module_api_name)
+        module_data = modified_modules[module_api_name]
+        get_fields(module_data[Constants::API_NAME])
       end
     end
 
+    def self.verify_module_api_name(module_api_name)
+
+      if !module_api_name.nil? 
+        if Constants::DEFAULT_MODULENAME_VS_APINAME.key? (module_api_name.downcase) && !Constants::DEFAULT_MODULENAME_VS_APINAME[module_api_name.downcase].nil?
+          return Constants::DEFAULT_MODULENAME_VS_APINAME[module_api_name.downcase]
+        end
+      end
+
+      record_field_details_path = get_record_json_file_path
+
+      if File.exist? record_field_details_path
+        fields_json =  JSON.parse(File.open(record_field_details_path).read)
+        if fields_json.key? Constants::SDK_MODULE_METADATA and fields_json[Constants::SDK_MODULE_METADATA].key? module_api_name.downcase
+          return fields_json[Constants::SDK_MODULE_METADATA][module_api_name.downcase][Constants::API_NAME]
+        end
+      end
+      return module_api_name
+    end
+
     def self.delete_fields(record_field_details_json, module_api_name)
       subform_modules = []
 
@@ -233,9 +277,10 @@ module Util
           if !File.exist?(record_field_details_path) || (File.exist?(record_field_details_path) && !(JSON.parse(File.read(record_field_details_path)).key? key))
             is_new_data = true
             related_list_values = get_related_list_details(module_api_name)
-            record_field_details_json = {}
-            if File.exist? record_field_details_path
+            if  File.exist? (record_field_details_path)
               record_field_details_json = JSON.parse(File.read(record_field_details_path))
+            else
+              record_field_details_json = {}
             end
             record_field_details_json[key] = related_list_values
             File.open(record_field_details_path, 'w') do |f|
@@ -253,6 +298,7 @@ module Util
           end
         rescue SDKException => e
           SDKLog::SDKLogger.severe(Constants::EXCEPTION, e)
+          raise e
         rescue StandardError => e
           ex = SDKException.new(nil, Constants::EXCEPTION, nil, e)
           SDKLog::SDKLogger.severe(Constants::EXCEPTION, ex)
@@ -347,12 +393,11 @@ module Util
     def self.fill_data_type
       return unless @@apitype_vs_datatype.empty?
 
-      field_api_names_string = %w[autonumber textarea text website email phone mediumtext multiselectlookup profileimage]
+      field_api_names_string = %w[autonumber textarea text website email phone mediumtext profileimage]
       field_api_names_integer = %w[integer]
       field_api_names_boolean = %w[boolean]
       field_api_names_long = %w[bigint long]
       field_api_names_double = %w[double percent lookup currency]
-      field_api_names_file = %w[imageupload]
       field_api_names_field_file = %w[fileupload]
       field_api_names_datetime = %w[datetime event_reminder]
       field_api_names_date = %w[date]
@@ -367,6 +412,8 @@ module Util
       field_api_names_recurring_activity = %w[RRULE]
       field_api_names_reminder = %w[multireminder]
       field_api_names_consent_look_up = %w[consent_lookup]
+      field_api_name_image_upload = %w["imageupload"]
+      field_api_name_multiselect_lookup = %w["multiselectlookup"]
 
       field_api_names_string.each do |field_api_name|
         @@apitype_vs_datatype[field_api_name] = Constants::STRING
@@ -388,10 +435,6 @@ module Util
         @@apitype_vs_datatype[field_api_name] = Constants::LONG
       end
 
-      field_api_names_file.each do |field_api_name|
-        @@apitype_vs_datatype[field_api_name] = Constants::FILE_NAMESPACE
-      end
-
       field_api_names_field_file.each do |field_api_name|
         @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
         @@apitype_vs_structurename[field_api_name] = Constants::FIELD_FILE_NAMESPACE
@@ -435,7 +478,7 @@ module Util
       field_api_names_multiuser_lookup.each do |field_api_name|
         @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
 
-        @@apitype_vs_structurename[field_api_name] = Constants::USER_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::RECORD_NAMESPACE
       end
 
       field_api_names_multimodule_lookup.each do |field_api_name|
@@ -465,6 +508,15 @@ module Util
 
         @@apitype_vs_structurename[field_api_name] = Constants::CONSENT_NAMESPACE
       end
+
+      field_api_name_image_upload.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::IMAGEUPLOAD_NAMESPACE
+      end
+      field_api_name_multiselect_lookup.each do |field_api_name|
+        @@apitype_vs_datatype[field_api_name] = Constants::LIST_NAMESPACE
+        @@apitype_vs_structurename[field_api_name] = Constants::RECORD_NAMESPACE
+      end
     end
 
     def self.set_data_type(field_detail, field_instance, module_api_name)
@@ -478,7 +530,8 @@ module Util
       if !field_instance.system_mandatory.nil? && field_instance.system_mandatory && !((module_api_name == Constants::CALLS.downcase) && (key_name.downcase == Constants::CALL_DURATION.downcase))
         field_detail[Constants::REQUIRED] = true
       end
-      if Constants::INVENTORY_MODULES.include?(module_api_name) && (key_name.downcase == Constants::PRODUCT_DETAILS.downcase)
+    
+      if Constants::KEY_VS_INVENTORY_MODULE.key?(key_name) && (module_api_name.downcase == Constants::KEY_VS_INVENTORY_MODULE[key_name].downcase)
         field_detail[Constants::NAME] = key_name
         field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
         field_detail[Constants::STRUCTURE_NAME] = Constants::INVENTORY_LINE_ITEMS
@@ -498,7 +551,7 @@ module Util
         return
       elsif (key_name.downcase == Constants::COMMENTS.downcase) && ((module_api_name == Constants::SOLUTIONS.downcase) || (module_api_name == Constants::CASES.downcase))
         field_detail[Constants::NAME] = key_name
-        field_detail[Constants::TYPE] = Constants::LAYOUT_NAMESPACE
+        field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
         field_detail[Constants::STRUCTURE_NAME] = Constants::COMMENTS_NAMESPACE
         field_detail[Constants::LOOKUP] = true
         return
@@ -508,6 +561,17 @@ module Util
         field_detail[Constants::LOOKUP] = true
         field_detail[Constants::STRUCTURE_NAME] = Constants::LAYOUT_NAMESPACE
         return
+      elsif (key_name.downcase() == Constants::TERRITORIES.downcase or key_name.downcase() == Constants::TERRITORY.downcase) and !field_instance.custom_field.nil? and !field_instance.custom_field
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+        field_detail[Constants::STRUCTURE_NAME] = Constants::TERRITORY_NAMESPACE
+        field_detail[Constants::LOOKUP] = true
+        return
+      elsif key_name.downcase() == Constants::TAX.downcase and module_api_name.downcase() == Constants::PRODUCTS.downcase
+        field_detail[Constants::NAME] = key_name
+        field_detail[Constants::TYPE] = Constants::LIST_NAMESPACE
+        field_detail[Constants::STRUCTURE_NAME] = Constants::TAX_NAMESPACE
+        return
       elsif @@apitype_vs_datatype.include? data_type
         field_detail[Constants::TYPE] = @@apitype_vs_datatype[data_type]
       elsif data_type.downcase == Constants::FORMULA.downcase
@@ -524,6 +588,31 @@ module Util
       field_detail[Constants::LOOKUP] = true if data_type.downcase.include? Constants::LOOKUP
       field_detail[Constants::SKIP_MANDATORY] = true if data_type.downcase.include? Constants::CONSENT_LOOKUP
 
+
+      if data_type.downcase.include? Constants::MULTI_SELECT_LOOKUP
+        field_detail[Constants::SKIP_MANDATORY] = true
+        if !field.multiselectlookup.nil?
+          if !field.multiselectlookup.linking_module.nil?
+            linking_module = field.multiselectlookup.linking_module
+            field_detail[Constants::MODULE] = linking_module
+            module_name = linking_module
+          end
+        end
+        field_detail[Constants::SUBFORM] = true
+      end
+
+      if data_type.downcase.include? Constants::MULTI_USER_LOOKUP
+        field_detail[Constants::SKIP_MANDATORY] = true
+        if !field.multiuserlookup.nil?
+          if !field.multiuserlookup.linking_module.nil?
+            linking_module = field.multiuserlookup.linking_module
+            field_detail[Constants::MODULE] = linking_module
+            module_name = linking_module
+          end
+        end
+        field_detail[Constants::SUBFORM] = true
+      end
+
       if @@apitype_vs_structurename.include? data_type
         field_detail[Constants::STRUCTURE_NAME] = @@apitype_vs_structurename[data_type]
       end
@@ -560,13 +649,8 @@ module Util
       get_fields(module_name) if !module_name.nil? && !module_name.empty?
       field_detail[Constants::NAME] = key_name
     end
-
-    def self.get_modules
-      @@sync_lock.synchronize do
-        @@api_supported_module = get_modules_api_names(nil)
-      end
-    end
-    def self.get_modules_api_names(header)
+   
+    def self.get_modules(header)
       api_names = {}
       header_map = HeaderMap.new
       unless header.nil?
@@ -585,7 +669,12 @@ module Util
           if response_object.is_a? Modules::ResponseWrapper
             modules = response_object.modules
             modules.each do |module_ins|
-              api_names[module_ins.api_name.downcase] = module_ins.generated_type.value if module_ins.api_supported
+              if module_ins.api_supported
+                module_details = {}
+                module_details[Constants::API_NAME] = module_ins.api_name
+                module_details[Constants::GENERATED_TYPE] = module_ins.generated_type.value
+                api_names[module_ins.api_name.downcase] = module_details
+              end
             end
           elsif response_object.is_a? Modules::APIException
             error_response = {}
@@ -596,6 +685,13 @@ module Util
           end
         end
       end
+      if @@force_refresh
+        begin
+          write_module_meta_data(get_record_json_file_path, api_names)
+        rescue StandardError => e
+          raise SDKException.new(Constants::EXCEPTION,e)
+        end
+      end
       api_names
     end
 
@@ -617,6 +713,66 @@ module Util
       false
     end
 
+    def self.verify_photo_support(module_api_name)
+      @@sync_lock.synchronize do
+        begin
+          module_api_name = verify_module_api_name(module_api_name)
+          if Constants::PHOTO_SUPPORTED_MODULES.key? module_api_name
+            return true
+          end
+          modules = get_module_names()
+          if modules.key? module_api_name.downcase || !modules[module_api_name.downcase].nil?
+            module_meta_data = modules[module_api_name.downcase]
+
+            if module_meta_data[Constants::GENERATED_TYPE] != Constants::GENERATED_TYPE_CUSTOM
+                raise SDKException.new(Constants::UPLOAD_PHOTO_UNSUPPORTED_ERROR,Constants::UPLOAD_PHOTO_UNSUPPORTED_MESSAGE + module_api_name)
+            end
+          end
+        rescue SDKException => e
+          raise e
+        rescue StandardError => e
+          ex = SDKException.new(nil, Constants::EXCEPTION, nil, e)
+          SDKLog::SDKLogger.severe(Constants::EXCEPTION, ex)
+          raise ex
+        end
+        return true 
+      end
+    end
+    
+    def self.get_module_names()
+      module_data = {}
+      resoures_folder_path = initializer.resources_path + '/' + Constants::RESOURCES
+      Dir.mkdir resoures_folder_path unless File.exist? resoures_folder_path
+
+      record_field_details_path = get_record_json_file_path
+
+      is_null = false
+      if File.exists? record_field_details_path
+        json = JSON.parse(File.read(record_field_details_path))
+        if !json.key? Constants::SDK_MODULE_METADATA
+          is_null = true
+        elsif json[Constants::SDK_MODULE_METADATA].nil?
+          is_null = true
+        end
+      end
+      if !File.exists? os.path.exists(record_field_details_path) || is_null
+        module_data = get_modules(nil)
+        write_module_meta_data(record_field_details_path, module_data)
+        return module_data
+      end
+      record_field_details_json = JSON.parse(File.read(record_field_details_path))
+      module_data = record_field_details_json[Constants::SDK_MODULE_METADATA]
+      return module_data
+    end
+
+    def self.write_module_meta_data(record_field_details_path, module_data)
+      field_details_json = File.exist? record_field_details_path ? JSON.parse(File.read(record_field_details_path)):{}
+      field_details_json[Constants::SDK_MODULE_METADATA] = module_data
+      File.open(record_field_details_path, 'w') do |f|
+        f.write(field_details_json.to_json)
+      end
+    end
+
     def self.get_related_list_details(module_api_name)
       rlo = RelatedLists::RelatedListsOperations.new(module_api_name)
       response = rlo.get_related_lists