ZCRMSDK 1.0.2 → 2.1.0

data/src/com/zoho/crm/api/files/body_wrapper.rb

@@ -0,0 +1,62 @@
+require_relative '../util/stream_wrapper'
+require_relative '../util/model'
+
+module Files
+  class BodyWrapper
+    include Util::Model
+
+    # Creates an instance of BodyWrapper
+    def initialize
+      @file = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the file
+      # @return An instance of Array
+
+    def file
+      @file
+    end
+
+      # The method to set the value to file
+      # @param file [Array] An instance of Array
+
+    def file=(file)
+      if file!=nil and !file.is_a? Array
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: Array', nil, nil)
+      end
+      @file = file
+      @key_modified['file'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/files/file_body_wrapper.rb

@@ -0,0 +1,64 @@
+require_relative '../util/stream_wrapper'
+require_relative '../util/model'
+
+module Files
+  require_relative 'response_handler'
+  class FileBodyWrapper
+    include Util::Model
+    include ResponseHandler
+
+    # Creates an instance of FileBodyWrapper
+    def initialize
+      @file = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the file
+      # @return An instance of Util::StreamWrapper
+
+    def file
+      @file
+    end
+
+      # The method to set the value to file
+      # @param file [Util::StreamWrapper] An instance of Util::StreamWrapper
+
+    def file=(file)
+      if file!=nil and !file.is_a? Util::StreamWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: Util::StreamWrapper', nil, nil)
+      end
+      @file = file
+      @key_modified['file'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

data/src/com/zoho/crm/api/files/file_operations.rb

@@ -0,0 +1,75 @@
+require_relative '../param'
+require_relative '../parameter_map'
+require_relative '../exception/sdk_exception'
+require_relative '../util/api_response'
+require_relative '../util/common_api_handler'
+require_relative '../util/constants'
+
+module Files
+  class FileOperations
+
+    # Creates an instance of FileOperations
+    def initialize
+    end
+
+      # The method to upload files
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def upload_files(request, param_instance=nil)
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      if param_instance!=nil and !param_instance.is_a? ParameterMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/files'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'CREATE'
+      handler_instance.content_type = 'multipart/form-data'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      handler_instance.param = param_instance
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to get file
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_file(param_instance=nil)
+      if param_instance!=nil and !param_instance.is_a? ParameterMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: param_instance EXPECTED TYPE: ParameterMap', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/files'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.param = param_instance
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/x-download')
+    end
+
+    class UploadFilesParam
+      @@type = Param.new('type', 'com.zoho.crm.api.File.UploadFilesParam')
+      def self.type
+        @@type
+      end
+    end
+
+    class GetFileParam
+      @@id = Param.new('id', 'com.zoho.crm.api.File.GetFileParam')
+      def self.id
+        @@id
+      end
+    end
+
+  end
+end

data/src/com/zoho/crm/api/files/response_handler.rb

@@ -0,0 +1,10 @@
+module Files
+  module ResponseHandler
+
+    # Creates an instance of ResponseHandler
+    def initialize
+    end
+
+
+  end
+end

data/src/com/zoho/crm/api/files/success_response.rb

@@ -0,0 +1,121 @@
+require_relative '../util/choice'
+require_relative '../util/model'
+
+module Files
+  require_relative 'action_response'
+  class SuccessResponse
+    include Util::Model
+    include ActionResponse
+
+    # Creates an instance of SuccessResponse
+    def initialize
+      @status = nil
+      @code = nil
+      @message = nil
+      @details = nil
+      @key_modified = Hash.new
+    end
+
+      # The method to get the status
+      # @return An instance of Util::Choice
+
+    def status
+      @status
+    end
+
+      # The method to set the value to status
+      # @param status [Util::Choice] An instance of Util::Choice
+
+    def status=(status)
+      if status!=nil and !status.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @status = status
+      @key_modified['status'] = 1
+    end
+
+      # The method to get the code
+      # @return An instance of Util::Choice
+
+    def code
+      @code
+    end
+
+      # The method to set the value to code
+      # @param code [Util::Choice] An instance of Util::Choice
+
+    def code=(code)
+      if code!=nil and !code.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @code = code
+      @key_modified['code'] = 1
+    end
+
+      # The method to get the message
+      # @return An instance of Util::Choice
+
+    def message
+      @message
+    end
+
+      # The method to set the value to message
+      # @param message [Util::Choice] An instance of Util::Choice
+
+    def message=(message)
+      if message!=nil and !message.is_a? Util::Choice
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Util::Choice', nil, nil)
+      end
+      @message = message
+      @key_modified['message'] = 1
+    end
+
+      # The method to get the details
+      # @return An instance of Hash
+
+    def details
+      @details
+    end
+
+      # The method to set the value to details
+      # @param details [Hash] An instance of Hash
+
+    def details=(details)
+      if details!=nil and !details.is_a? Hash
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Hash', nil, nil)
+      end
+      @details = details
+      @key_modified['details'] = 1
+    end
+
+      # The method to check if the user has modified the given key
+      # @param key [String] A String
+      # @return A Integer value
+
+    def is_key_modified(key)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if @key_modified.key?(key)
+        return @key_modified[key]
+      end
+
+      nil
+    end
+
+      # The method to mark the given key as modified
+      # @param key [String] A String
+      # @param modification [Integer] A Integer
+
+    def set_key_modified(key, modification)
+      if key!=nil and !key.is_a? String
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: String', nil, nil)
+      end
+      if modification!=nil and !modification.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: Integer', nil, nil)
+      end
+      @key_modified[key] = modification
+    end
+
+  end
+end

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

@@ -0,0 +1,10 @@
+# This class represents the HTTP header name
+class Header
+  attr_accessor :name, :class_name
+  # Creates an Header class instance with the specified header name.
+  # @param name [String] A String containing the header name.
+  def initialize(name, class_name = nil)
+    @name = name
+    @class_name = class_name
+  end
+end

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

@@ -0,0 +1,55 @@
+# This class represents the HTTP header name and value.
+require_relative 'util/data_type_converter'
+require_relative 'exception/sdk_exception'
+require_relative 'util/header_param_validator'
+
+class HeaderMap
+  attr_accessor :header_hash
+
+  def initialize
+    @header_hash = {}
+  end
+
+  # This method is to add header name and value.
+  # @param header [Header] A Header class instance.
+  # @param value [Object] An object containing the header value.
+  def add(header, value)
+    unless header.is_a? Header
+      raise SDKException.new(Constants::HEADER_NULL_ERROR, Constants::HEADER_INSTANCE_NULL_ERROR)
+    end
+
+    header_name = header.name
+
+    if header_name.nil?
+      raise SDKException.new(Constants::HEADER_NAME_NULL_ERROR, Constants::HEADER_NAME_NULL_ERROR_MESSAGE)
+    end
+
+    if value.nil?
+      raise SDKException.new(Constants::HEADER_NULL_ERROR, header_name + Constants::NULL_VALUE_ERROR_MESSAGE)
+    end
+
+    header_value = nil
+
+    if header.class_name.nil?
+      begin
+        header_value = value.to_s
+      rescue StandardError
+        header_value = value
+      end
+    else
+      header_param_validator = Util::HeaderParamValidator.new
+      header_value = header_param_validator.validate(header, value)
+    end
+
+    header_value = header_value.to_s
+    if (@header_hash.key? header_name) && !@header_hash[header_name].nil?
+      existing_header_value = @header_hash[header_name]
+
+      existing_header_value = existing_header_value + ',' + header_value
+
+      @header_hash[header_name] = existing_header_value
+    else
+      @header_hash[header_name] = header_value
+    end
+  end
+end

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

@@ -0,0 +1,192 @@
+require 'uri'
+require 'net/http'
+require 'cgi'
+require 'json'
+require_relative '../../api/logger/sdk_logger'
+require_relative 'util/constants'
+
+# This class to initialize Zoho CRM SDK.
+class Initializer
+  attr_accessor :json_details, :user, :environment, :store, :token, :initializer, :local, :sdk_config, :resources_path, :request_proxy
+
+  @@json_details = nil
+
+  Thread.current['initi'] = nil
+
+  def self.json_details
+    @@json_details
+  end
+
+  def self.initialize(user, environment, token, store, sdk_config, resources_path, log = nil, request_proxy = nil)
+    error = {}
+
+    require_relative 'user_signature'
+
+    unless user.is_a?(UserSignature)
+      error[Constants::ERROR_HASH_FIELD] = 'user'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
+
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::USERSIGNATURE_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative '../../crm/api/dc/datacenter'
+
+    unless environment.is_a?(DC::DataCenter::Environment)
+      error[Constants::ERROR_HASH_FIELD] = 'environment'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
+
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative '../../api/authenticator/token'
+
+    unless token.is_a?(Authenticator::Token)
+      error[Constants::ERROR_HASH_FIELD] = 'token'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
+
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative '../../api/authenticator/store/token_store'
+
+    unless store.is_a?(Store::TokenStore)
+      error[Constants::ERROR_HASH_FIELD] = 'store'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Store::TokenStore
+
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::STORE_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative 'sdk_config'
+
+    unless sdk_config.is_a?(SDKConfig)
+      error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
+
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
+
+    end
+
+    if resources_path.nil? || resources_path.empty?
+      raise SDKException.new(Constants::INITIALIZATION_ERROR, Constants::RESOURCE_PATH_ERROR_MESSAGE, nil, nil)
+    end
+
+    log = SDKLog::Log.initialize(Levels::INFO, File.join(Dir.pwd, Constants::LOGFILE_NAME)) if log.nil? 
+
+    SDKLog::SDKLogger.initialize(log)
+
+    @@initializer = Initializer.new
+
+    @@initializer.user = user
+
+    @@initializer.environment = environment
+
+    @@initializer.sdk_config = sdk_config
+
+    @@initializer.token = token
+
+    @@initializer.store = store
+
+    @@initializer.resources_path = resources_path
+
+    @@initializer.request_proxy = request_proxy
+
+    @@json_details = get_JSONDetails
+
+    SDKLog::SDKLogger.info(Constants::INITIALIZATION_SUCCESSFUL + @@initializer.to_s)
+  rescue SDKException => e
+    raise e
+  rescue StandardError => e
+    raise SDKException.new(nil, Constants::INITIALIZATION_ERROR, nil, e)
+  end
+
+  def self.get_JSONDetails
+    JSON.parse(File.open(File.join(File.dirname(File.expand_path(__FILE__)), '../../../../' + Constants::JSON_DETAILS_FILE_PATH)).read)
+  rescue StandardError => e
+    raise SDKException.new(nil, Constants::EXCEPTION_JSONDETAILS, nil, e)
+  end
+
+  def self.get_initializer
+    return Thread.current['initi'] unless Thread.current['initi'].nil?
+
+    @@initializer
+  end
+
+  def self.switch_user(user, environment, token, sdk_config, request_proxy = nil)
+    require_relative 'user_signature'
+
+    unless user.is_a?(UserSignature)
+      error[Constants::ERROR_HASH_FIELD] = 'user'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = UserSignature
+
+      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::USERSIGNATURE_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative '../../crm/api/dc/datacenter'
+
+    unless environment.is_a?(DC::DataCenter::Environment)
+      error[Constants::ERROR_HASH_FIELD] = 'environment'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = DC::DataCenter::Environment
+
+      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::ENVIRONMENT_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative '../../api/authenticator/token'
+
+    unless token.is_a?(Authenticator::Token)
+      error[Constants::ERROR_HASH_FIELD] = 'token'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = Authenticator::Token
+
+      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::TOKEN_ERROR_MESSAGE, error, nil)
+
+    end
+
+    require_relative 'sdk_config'
+
+    unless sdk_config.is_a?(SDKConfig)
+      error[Constants::ERROR_HASH_FIELD] = 'sdk_config'
+
+      error[Constants::ERROR_HASH_EXPECTED_TYPE] = SDKConfig
+
+      raise SDKException.new(Constants::SWITCH_USER_ERROR, Constants::SDK_CONFIG_ERROR_MESSAGE, error, nil)
+
+    end
+
+    initializer = Initializer.new
+
+    initializer.user = user
+
+    initializer.environment = environment
+
+    initializer.sdk_config = sdk_config
+
+    initializer.token = token
+
+    initializer.store = @@initializer.store
+
+    initializer.resources_path = @@initializer.resources_path
+
+    initializer.request_proxy = request_proxy
+
+    Thread.current['initi'] = initializer
+
+    SDKLog::SDKLogger.info(Constants::INITIALIZATION_SWITCHED + initializer.to_s)
+  end
+
+  def to_s
+    Constants::FOR_EMAIL_ID + Initializer.get_initializer.user.email + Constants::IN_ENVIRONMENT + Initializer.get_initializer.environment.url + '.'
+  end
+end