ZCRMSDK 1.0.2 → 2.1.0

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

@@ -0,0 +1,213 @@
+require 'base64'
+require_relative 'constants'
+require_relative 'utility'
+
+module Util
+  class Converter
+    attr_accessor :common_api_handler
+    # This method is to process the API response.
+    # @param response [Object] A Object containing the API response contents or response.
+    # @param class_path [String] A String containing the expected method return type.
+    def get_response(response_json, class_path); end
+
+    # This abstract method is to construct the API request.
+    # @param request_instance [Object] An Object containing the class instance.
+    # @param class_path [String] A String containing the expected method return type.
+    # @param instanceNumber [Integer] An Integer containing the class instance list number.
+    # @return An Object representing the API request body object.
+    # @raise Exception
+    def form_request(request_instance, class_path, instance_no, member_details = nil); end
+
+    # This abstract method is to process the API response.
+    # @param response [Object] A Object containing the HttpResponse class instance.
+    # @param pack [String] A String containing the expected method return type.
+    # @return An Object representing the POJO class instance.
+    # @raise Exception
+    def get_wrapper_response(response, pack); end
+
+    # This abstract method is to construct the API request body.
+    # @param request [Object] A HttpEntityEnclosingRequestBase class instance.
+    # @param request_object A Object containing the API request body object.
+    # @raise Exception
+    def append_to_request(request, request_object); end
+
+    # Creates a Converter class instance with the CommonAPIHandler class instance.
+    # @param common_api_handler A CommonAPIHandler class instance.
+    def initialize(common_api_handler)
+      @common_api_handler = common_api_handler
+    end
+
+    # This method is to validate if the input values satisfy the constraints for the respective fields.
+    # @param class_name [String] A String containing the class name.
+    # @param member_name [String] A String containing the member name.
+    # @param key_details A Hash containing the key JSON details.
+    # @param value [Object[ An Object containing the key value.
+    # @param unique_values_map A Hash containing the construct objects.
+    # @param instance_number [Integer] An Integer containing the POJO class instance list number.
+    # @return A Boolean representing the key value is expected pattern, unique, length, and values.
+    # @raise SDKException
+    def value_checker(class_name, member_name, key_details, value, unique_values_map, instance_number)
+      error = {}
+
+      name = key_details[Constants::NAME]
+      type = key_details[Constants::TYPE]
+
+      var_type = nil
+      check = true
+
+      unless value.nil? 
+        var_type = value.class.name
+      end
+  
+      if Constants::DATA_TYPE.key? type 
+        if value.is_a? Array
+          if key_details.key? Constants::STRUCTURE_NAME
+            structure_name = key_details[Constants::STRUCTURE_NAME]
+            index = 0
+            value.each do |data|
+              class_name = data.class.name
+              unless structure_name.downcase == Util::Utility.path_to_package(class_name).downcase
+                instance_number = index
+                type = Constants::LIST_NAMESPACE + '(' + structure_name + ')'
+                var_type = Constants::LIST_NAMESPACE + '(' + class_name + ')'
+                expected_list_type = false
+                check = false
+               
+                break
+              end
+              index += 1
+            end
+          end
+        elsif !value.nil? 
+          check = Util::Utility.check_data_type(value,type)
+        end
+      elsif (type.downcase != Constants::OBJECT.downcase)
+        if type.downcase != Util::Utility.path_to_package(var_type).downcase 
+          check = false
+        end
+      end
+      if !check 
+        error[Constants::ERROR_HASH_CLASS] = class_name
+
+        error[Constants::ERROR_HASH_FIELD] = member_name
+
+        error[Constants::INDEX] = instance_number
+
+        error[Constants::ERROR_HASH_EXPECTED_TYPE] = type
+
+        error[Constants::GIVEN_TYPE] = var_type
+
+        raise SDKException.new(Constants::TYPE_ERROR, nil, error, nil)
+      end
+
+      class_name = if class_name.include? Constants::DOUBLE_COLON
+                     class_name.split(Constants::DOUBLE_COLON)[1]
+                   else
+                     class_name.split(Constants::DOT)[5]
+                   end
+
+      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
+
+          unless instance_number.nil?
+            error[Constants::INDEX] = instance_number 
+          end
+
+          error[Constants::ERROR_HASH_CLASS] = class_name
+
+          error[Constants::GIVEN_VALUE] = value
+
+          error[Constants::ERROR_HASH_FIELD] = member_name
+
+          error[Constants::ACCEPTED_VALUES] = key_details[Constants::VALUES]
+
+          raise SDKException.new(Constants::UNACCEPTED_VALUES_ERROR, nil, error, nil)
+        end
+      end
+
+      if key_details.key?(Constants::MIN_LENGTH) || key_details.key?(Constants::MAX_LENGTH)
+        count = value.length
+        if count < key_details[Constants::MIN_LENGTH]
+          error[Constants::ERROR_HASH_CLASS] = class_name
+
+          error[Constants::GIVEN_LENGTH] = count
+
+          error[Constants::ERROR_HASH_FIELD] = member_name
+
+          error[Constants::ERROR_HASH_MINIMUM_LENGTH] = key_details[Constants::MIN_LENGTH]
+
+          raise SDKException.new(Constants::MINIMUM_LENGTH_ERROR, nil, error, nil)
+
+        end
+
+        if count > key_details[Constants::MAX_LENGTH]
+          error[Constants::ERROR_HASH_CLASS] = class_name
+
+          error[Constants::ERROR_HASH_FIELD] = member_name
+
+          error[Constants::GIVEN_LENGTH] = count
+
+          error[Constants::ERROR_HASH_MAXIMUM_LENGTH] = key_details[Constants::MAX_LENGTH]
+
+          raise SDKException.new(Constants::MAXIMUM_LENGTH_ERROR, nil, error, nil)
+
+        end
+      end
+
+      if key_details.key? Constants::REGEX
+        if value.match(key_details[Constants::REGEX]).nil?
+          error[Constants::INSTANCE_NUMBER] = instance_number
+
+          error[Constants::ERROR_HASH_CLASS] = class_name
+
+          error[Constants::ERROR_HASH_FIELD] = member_name
+
+          raise SDKException.new(Constants::REGEX_MISMATCH_ERROR, nil, error, nil)
+
+        end
+
+      end
+
+      if key_details.key? Constants::UNIQUE
+
+        unique_values_map[name] = [] unless unique_values_map.key? name
+
+        if unique_values_map[name].include? value
+          error[Constants::FIRST_INDEX] = unique_values_map[name].find_index(value) + 1
+
+          error[Constants::NEXT_INDEX] = instance_number
+
+          error[Constants::ERROR_HASH_CLASS] = class_name
+
+          error[Constants::ERROR_HASH_FIELD] = member_name
+
+          raise SDKException.new(Constants::UNIQUE_KEY_ERROR, nil, error, nil)
+
+        else
+          unique_values_map[name].push(value)
+        end
+      end
+
+      true
+    end
+
+    # This method to get the module field JSON details file path.
+    # @return A String representing the module field JSON details file path.
+    def get_record_json_file_path
+      initializer = Initializer.get_initializer
+
+      file_name = initializer.user.email
+
+      file_name = file_name[0..file_name.index(Constants::AT) - 1] + initializer.environment.url
+
+      bytes = file_name.force_encoding('utf-8').bytes
+
+      str = Base64.encode64(bytes.pack('"C*"'))
+
+      str = str.chomp
+
+      File.join(initializer.resources_path + '/' + Constants::RESOURCES + '/' + str + '.json')
+    end
+  end
+end

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

@@ -0,0 +1,162 @@
+require 'date'
+require 'time'
+require 'monitor'
+require_relative 'constants'
+
+module Util
+  # This class converts JSON value to the expected data type.
+  class DataTypeConverter
+    @@sync_lock = Monitor.new
+
+    @@pre_converter_map = {}
+
+    @@post_converter_map = {}
+
+    # This method is to initialize the PreConverter and PostConverter lambda functions.
+    def self.init
+      return unless @@pre_converter_map.empty? && @@post_converter_map.empty?
+
+      @@sync_lock.synchronize do
+        add_to_map(DateTime.name,
+                   lambda do |obj|
+                     return DateTime.parse(Time.parse(obj).localtime.to_s)
+                   end,
+                   lambda do |obj|
+                     return obj.strftime('%FT%T%:z')
+                   end)
+
+        add_to_map(Date.name,
+                   lambda do |obj|
+                     return Date.parse(obj)
+                   end,
+                   lambda do |obj|
+                     return obj.strftime('%F')
+                   end)
+        add_to_map(Constants::DATETIME_NAMESPACE,
+                    lambda do |obj|
+                      return DateTime.parse(Time.parse(obj).localtime.to_s)
+                    end,
+                    lambda do |obj|
+                      return obj.strftime('%FT%T%:z')
+                    end)
+ 
+         add_to_map(Constants::DATE_NAMESPACE,
+                    lambda do |obj|
+                      return Date.parse(obj)
+                    end,
+                    lambda do |obj|
+                      return obj.strftime('%F')
+                    end)
+
+        string = lambda do |obj|
+          return obj.to_s
+        end
+        add_to_map(String.name, string, string)
+        add_to_map(Constants::STRING, string, string)
+
+        integer = lambda do |obj|
+          if obj == Constants::NULL_VALUE
+            return nil
+          end
+          return obj.to_i
+        end
+
+        add_to_map(Integer.name, integer, integer)
+        add_to_map(Constants::INTEGER, integer, integer)
+        add_to_map(Constants::LONG, integer, integer)
+
+        pre_convert_object = lambda do |obj|
+          return pre_convert_object_data(obj)
+        end
+
+        post_convert_object = lambda do |obj|
+          return post_convert_object_data(obj)
+        end
+
+        add_to_map(Constants::OBJECT,pre_convert_object, post_convert_object)
+
+        bool = lambda do |obj|
+          return obj
+        end
+
+        add_to_map(Constants::BOOLEAN, bool, bool)
+
+        float = lambda do |obj|
+          return obj.to_f
+        end
+
+        add_to_map(Float.name, float, float)
+        add_to_map(Constants::FLOAT, float, float)
+        add_to_map(Constants::DOUBLE, float, float)
+      end
+    end
+
+    # This method is to add PreConverter and PostConverter instance.
+    # @param name [String] A String containing the data type class name.
+    # @param pre_converter [Object] A PreConverter instance.
+    # @param post_converter [Object] A PostConverter instance.
+    def self.add_to_map(name, pre_converter, post_converter)
+      @@pre_converter_map[name] = pre_converter
+
+      @@post_converter_map[name] = post_converter
+    end
+
+    # This method is to convert JSON value to expected data value.
+    # @param obj [Object] A Object containing the JSON value.
+    # @param type [String] A String containing the expected method return type.
+    # @return A Value containing the expected data value.
+    # @raise Exception
+    def self.pre_convert(obj, type)
+      init
+      @@pre_converter_map[type].call(obj)
+    end
+
+    # This method is to convert Java data to JSON data value.
+    # @param obj [Object] R containing the Java data value.
+    # @param type [String] A String containing the expected method return type.
+    # @return An Object containing the expected data value.
+    # @raise Exception
+    def self.post_convert(obj, type)
+      init
+      @@post_converter_map[type].call(obj)
+    end
+
+    def self.pre_convert_object_data(obj)
+      return obj
+    end
+
+    def self.post_convert_object_data(obj)
+      if obj.nil?
+        return nil
+      end
+
+      if obj.is_a? DateTime
+        return DataTypeConverter.post_convert(obj, Constants::DATETIME_NAMESPACE)
+      end
+
+      if obj.is_a? Date
+        return DataTypeConverter.post_convert(obj, Constants::DATE_NAMESPACE)
+      end
+
+      if obj.is_a? Array
+        values = []
+        unless obj.empty?
+          obj.each do |value|
+            values.push(DataTypeConverter.post_convert_object_data(value))
+          end
+        end
+        return values
+      elsif obj.is_a? Hash
+        map_instance = {}
+        unless obj.empty?
+          obj.each do |key, value|
+            map_instance[key] = DataTypeConverter.post_convert_object_data(value)
+          end
+        end
+        return map_instance
+      else
+        return obj
+      end 
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+require_relative 'converter'
+require_relative 'stream_wrapper'
+require_relative 'constants'
+module Util
+  # This class is to process the download file and stream response.
+  class Downloader < Converter
+    attr_accessor :unique_hash
+
+    def initialize(common_api_handler)
+      @unique_hash = {}
+
+      super(common_api_handler)
+    end
+
+    def append_to_request(request, request_object); end
+
+    def form_request(request_instance, class_path, member_json_details = nil); end
+
+    def get_wrapped_response(response, class_path)
+      get_response(response, class_path)
+    end
+
+    def get_response(response_object, class_path)
+      require_relative '../initializer'
+
+      json_details = Initializer.json_details
+
+      if class_path.to_s.include? Constants::DOUBLE_COLON
+        class_path_split = class_path.to_s.split(Constants::DOUBLE_COLON)
+        module_name = Utility.classname_to_filename(class_path_split[0])
+        file_name = Utility.classname_to_filename(class_path_split[1])
+      else
+        class_path_split = class_path.to_s.split(Constants::DOT)
+        module_name = class_path_split[-2]
+        file_name = Utility.classname_to_filename(class_path_split[-1])
+      end
+
+      require_relative '../' + module_name + '/' + file_name
+
+      package_name = Utility.path_to_package(class_path)
+      class_details = json_details[package_name]
+
+      if class_details.key?(Constants::INTERFACE) && !class_details[Constants::INTERFACE].nil? && class_details[Constants::INTERFACE]
+        classes = class_details[Constants::CLASSES]
+        classes.each do |class_name|
+          return get_response(response_object, class_name) if class_name.include? Constants::FILEBODYWRAPPER
+        end
+        return nil
+      else
+
+        instance = if class_path.is_a? String
+
+                     if class_path.include? Constants::DOUBLE_COLON
+                       Object.const_get(class_path).new
+                     else
+                       Object.const_get(Utility.class_to_load(class_path)).new
+                     end
+                   else
+                     Object.const_get(Utility.class_to_load(class_path.to_s)).new
+                   end
+
+        class_details.each do |member_name, member_json_details|
+          type = member_json_details[Constants::TYPE]
+
+          if type.downcase == Constants::STREAM_WRAPPER_CLASS_PATH.downcase
+            file_name = response_object.to_hash[Constants::CONTENT_DISPOSITION][0].split('=')[1]
+
+            file_name = file_name.split("''")[1] if file_name.include? "''"
+
+            file_name = file_name.gsub('"', '') if file_name.include? '"'
+
+            file_instance = Util::StreamWrapper.new(file_name, response_object.body)
+            instance_value = file_instance
+          end
+
+          instance.instance_variable_set(Constants::AT + member_name, instance_value)
+        end
+      end
+
+      instance
+    end
+  end
+end