ZOHOCRMSDK5_0 1.0.0

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

@@ -0,0 +1,280 @@
+require 'base64'
+require_relative 'constants'
+require_relative 'utility'
+
+module ZOHOCRMSDK
+  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
+          if key_details.key? Constants::INTERFACE and key_details[Constants::INTERFACE] == true
+            json_details = 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 = Util::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 
+          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 + ')'
+                  check = false
+                
+                  break
+                end
+                index += 1
+              end
+            end
+          elsif !value.nil?
+            check = Util::Utility.check_data_type(value, type)
+          end
+        elsif !value.nil? && type.downcase != Constants::OBJECT.downcase
+          if type == 'TimeZone'
+            check = true
+          else
+            if type.downcase != Util::Utility.path_to_package(var_type).downcase
+              check = false
+            end
+            if !check
+              if Object.const_get(var_type).new.is_a? Object.const_get(Util::Utility.class_to_load(type))
+                check = true
+              end
+            end
+          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
+
+          values_ja = key_details[Constants::VALUES]
+
+          if value.is_a? Array
+            value_1 = value
+            value_1.each do |value_2|
+              if value_2.is_a? Util::Choice
+                choice = value_2
+                value_2 = choice.value
+              end
+              unless values_ja.include? value_2
+                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] = values_ja
+
+                raise SDKException.new(Constants::UNACCEPTED_VALUES_ERROR, nil, error, nil)
+              end
+            end
+          else
+            if value.is_a? Util::Choice
+              choice = value
+              value = choice.value
+            end
+            unless values_ja.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] = values_ja
+
+              raise SDKException.new(Constants::UNACCEPTED_VALUES_ERROR, nil, error, nil)
+            end
+          end
+        end
+
+        if key_details.key?(Constants::MIN_LENGTH) || key_details.key?(Constants::MAX_LENGTH)
+          count = value.to_s.length
+          if value.is_a? Array
+            count = value.length
+          end
+          if key_details.key?(Constants::MIN_LENGTH) && 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 key_details.key?(Constants::MAX_LENGTH) && 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::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
+
+        token = initializer.token
+
+        access_token = ''
+        refresh_token = ''
+        token_key = ''
+
+        if token.is_a? Authenticator::OAuthToken
+          oauth_token = token
+          refresh_token = oauth_token.refresh_token
+          if !refresh_token.nil? && refresh_token.length > 0
+            token_key = refresh_token.match(/.{32}$/).to_s
+          else
+            access_token = oauth_token.access_token
+            if !access_token.nil? && access_token.length > 0
+              token_key = access_token.match(/.{32}$/).to_s
+            end
+          end
+        end
+        file_name = initializer.environment.url
+        if !token_key.nil? && token_key.length > 0
+          file_name += token_key
+        end
+        bytes = file_name.force_encoding('utf-8').bytes
+
+        str = Base64.encode64(bytes.pack('"C*"'))
+
+        str = str.chomp
+
+        str.concat(".json")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+require 'date'
+require 'time'
+require 'monitor'
+require_relative 'constants'
+
+module ZOHOCRMSDK
+  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)
+
+          add_to_map("TimeZone",
+                     lambda do |obj|
+                       return TZInfo::Timezone.get(obj.to_s)
+                     end,
+                     lambda do |obj|
+                       return obj.identifier.to_s
+                     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
+        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.
+      # @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
+        if @@post_converter_map.key? type
+          return @@post_converter_map[type].call(obj)
+        end
+        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
+end

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

@@ -0,0 +1,86 @@
+require_relative 'converter'
+require_relative 'stream_wrapper'
+require_relative 'constants'
+
+module ZOHOCRMSDK
+  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[1])
+          file_name = Utility.classname_to_filename(class_path_split[2])
+        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
+end

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

@@ -0,0 +1,159 @@
+require_relative 'converter'
+require_relative 'stream_wrapper'
+require_relative 'constants'
+
+module ZOHOCRMSDK
+  module Util
+    # This class is to process the upload file and stream.
+    class FormDataConverter < Converter
+      attr_accessor :unique_hash
+
+      def initialize(common_api_handler)
+        @unique_hash = {}
+
+        super(common_api_handler)
+      end
+
+      def append_to_request(request_base, request_object)
+        request_base.set_form(set_file_body(request_object), Constants::MULTIPART_FORM_DATA) if request_object.is_a?(Hash)
+      end
+
+      def set_file_body(request_object)
+        data = []
+        request_object.each do |key, value|
+          if value.is_a? Array
+            value.each do |v|
+              if v.is_a? StreamWrapper
+                data.push([key, v.stream, { filename: v.name }])
+              else
+                data.push([key, v])
+              end
+            end
+          elsif value.is_a? StreamWrapper
+            data.push([key, value.stream, { filename: value.name }])
+          else
+            data.push([key, value])
+          end
+        end
+        data
+      end
+
+      def form_request(request_instance, class_path, instance_no, member_json_details = nil)
+        require_relative '../initializer'
+      
+        package_name = Utility.path_to_package(class_path)
+        class_details = Initializer.json_details[package_name]
+        request_hash = {}
+
+        class_details.each_key do |member_name|
+          member_details = class_details[member_name]
+          if (member_details.key?(Constants::READ_ONLY) && member_details[Constants::READ_ONLY]) || (!member_details.key? Constants::NAME)
+            next
+          end
+
+          begin
+            modified = request_instance.public_send(Constants::IS_KEY_MODIFIED, member_name)
+          rescue StandardError => e
+            raise SDKException.new(nil, Constants::EXCEPTION_IS_KEY_MODIFIED, nil, e)
+          end
+
+          if (modified.nil? || modified.zero?) && member_details.key?(Constants::REQUIRED) && member_details[Constants::REQUIRED]
+            raise SDKException.new(Constants::MANDATORY_KEY_ERROR, Constants::MANDATORY_VALUE_ERROR + member_name)
+          end
+
+          member_data = request_instance.instance_variable_get(Constants::AT + member_name)
+
+          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
+              request_hash[key_name] = set_json_array(member_data, member_details)
+            elsif (type.downcase == Constants::MAP_NAMESPACE.downcase) || (type.downcase == Constants::HASH_MAP_NAMESPACE.downcase)
+              request_hash[key_name] = set_json_object(member_data, member_details)
+            elsif member_details.key? Constants::STRUCTURE_NAME
+              request_hash[key_name] = form_request(member_data, member_details[Constants::STRUCTURE_NAME], 1, member_details)
+            else
+              request_hash[key_name] = member_data
+            end
+          end
+        end
+
+        request_hash
+      end
+
+      def set_json_object(field_value, member_json_details)
+        json_object = {}
+        request_object = field_value
+
+        if member_json_details.nil?
+          request_object.each_pair do |key, value|
+            json_object[key] = redirector_for_object_to_json(value)
+          end
+        else
+          keys_detail = request_object[Constants::KEYS]
+
+          keys_detail.each do |key_detail|
+            key_name = key_detail[Constants::NAME]
+
+            if json_object.key?(key_name) && !json_object[key_name].nil?
+
+              key_value = if key_detail.key? Constants::STRUCTURE_NAME
+                            form_request(request_object[key_name], key_detail[Constants::STRUCTURE_NAME], 1, member_json_details)
+                          else
+                            redirector_for_object_to_json(request_object[key_name])
+                          end
+              json_object[key_name] = key_value
+            end
+          end
+        end
+
+        json_object
+      end
+
+      def set_json_array(member_data, member_json_details)
+        json_array = []
+
+        if member_json_details.nil?
+
+          member_data.each do |value|
+            json_array.push(redirector_for_object_to_json(value))
+          end
+        elsif member_json_details.key? Constants::STRUCTURE_NAME
+
+          instance_count = 0
+          package = member_json_details[Constants::STRUCTURE_NAME]
+
+          member_data.each do |data|
+            instance_count += 1
+            json_array.push(form_request(data, package, instance_count, member_json_details))
+          end
+        else
+
+          member_data.each do |data|
+            json_array.push(redirector_for_object_to_json(data))
+          end
+
+        end
+        json_array
+      end
+
+      def redirector_for_object_to_json(request)
+        if request.is_a?(Hash)
+          set_json_object(request, nil)
+        elsif request.is_a?(Array)
+          set_json_array(request, nil)
+        else
+          request
+        end
+      end
+
+      def get_wrapped_response(response, class_path)
+        nil
+      end
+
+      def get_response(response_object, class_path)
+        nil
+      end
+    end
+  end
+end