ZCRMSDK 1.0.2 → 2.1.0

data/src/com/zoho/crm/api/users/users_operations.rb

@@ -0,0 +1,181 @@
+require_relative '../header'
+require_relative '../header_map'
+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 Users
+  class UsersOperations
+
+    # Creates an instance of UsersOperations
+    def initialize
+    end
+
+      # The method to get users
+      # @param param_instance [ParameterMap] An instance of ParameterMap
+      # @param header_instance [HeaderMap] An instance of HeaderMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_users(param_instance=nil, header_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
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/users'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.param = param_instance
+      handler_instance.header = header_instance
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to create user
+      # @param request [RequestWrapper] An instance of RequestWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def create_user(request)
+      if request!=nil and !request.is_a? RequestWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RequestWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/users'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_POST
+      handler_instance.category_method = 'CREATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to update users
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_users(request)
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/users'
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      handler_instance.mandatory_checker = true
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to get user
+      # @param id [Integer] A Integer
+      # @param header_instance [HeaderMap] An instance of HeaderMap
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def get_user(id, header_instance=nil)
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if header_instance!=nil and !header_instance.is_a? HeaderMap
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/users/'
+      api_path = api_path + id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_GET
+      handler_instance.category_method = 'READ'
+      handler_instance.header = header_instance
+      require_relative 'response_handler'
+      handler_instance.api_call(ResponseHandler.name, 'application/json')
+    end
+
+      # The method to update user
+      # @param id [Integer] A Integer
+      # @param request [BodyWrapper] An instance of BodyWrapper
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def update_user(id, request)
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      if request!=nil and !request.is_a? BodyWrapper
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/users/'
+      api_path = api_path + id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_PUT
+      handler_instance.category_method = 'UPDATE'
+      handler_instance.content_type = 'application/json'
+      handler_instance.request = request
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+      # The method to delete user
+      # @param id [Integer] A Integer
+      # @return An instance of APIResponse
+    # @raise SDKException
+    def delete_user(id)
+      if !id.is_a? Integer
+        raise SDKException.new(Constants::DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: Integer', nil, nil)
+      end
+      handler_instance = Handler::CommonAPIHandler.new
+      api_path = ''
+      api_path = api_path + '/crm/v2/users/'
+      api_path = api_path + id.to_s
+      handler_instance.api_path = api_path
+      handler_instance.http_method = Constants::REQUEST_METHOD_DELETE
+      handler_instance.category_method = Constants::REQUEST_METHOD_DELETE
+      require_relative 'action_handler'
+      handler_instance.api_call(ActionHandler.name, 'application/json')
+    end
+
+    class GetUsersParam
+      @@type = Param.new('type', 'com.zoho.crm.api.Users.GetUsersParam')
+      def self.type
+        @@type
+      end
+      @@page = Param.new('page', 'com.zoho.crm.api.Users.GetUsersParam')
+      def self.page
+        @@page
+      end
+      @@per_page = Param.new('per_page', 'com.zoho.crm.api.Users.GetUsersParam')
+      def self.per_page
+        @@per_page
+      end
+    end
+
+    class GetUsersHeader
+      @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Users.GetUsersHeader')
+      def self.If_modified_since
+        @@If_modified_since
+      end
+    end
+
+    class GetUserHeader
+      @@If_modified_since = Header.new('If-Modified-Since', 'com.zoho.crm.api.Users.GetUserHeader')
+      def self.If_modified_since
+        @@If_modified_since
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,112 @@
+require 'net/http'
+
+require_relative '../initializer'
+require_relative '../../../api/logger/sdk_logger'
+require_relative 'constants'
+
+module Util
+  # This class is to make HTTP connections, trigger the requests and receive the response
+  class APIHTTPConnector
+    attr_accessor :url, :headers, :request_method, :parameters, :request_body, :content_type
+
+    def initialize
+      @url = nil
+
+      @headers = {}
+
+      @request_method = nil
+
+      @parameters = {}
+
+      @request_body = nil
+
+      @content_type = nil
+    end
+
+    def set_content_type_header
+      Constants::SET_TO_CONTENT_TYPE.each do |content_type|
+        if @url.include? content_type
+          @headers[Constants::CONTENT_TYPE] = @content_type
+          break
+        end
+      end
+    end
+
+    # This method makes a Zoho CRM Rest API request
+    # @param converterInstance A Converter class instance to call appendToRequest method.
+    # @return HttpResponse class instance or nil
+    # @raise Exception
+    def fire_request(converter_instance)
+      @parameters&.each do |param_key, value|
+        @parameters[param_key] = CGI.escape(value) if value.is_a? String
+      end
+
+      query_string = @parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
+
+      @url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
+
+      url = URI(@url)
+      http = nil
+      initializer = Initializer.get_initializer
+      request_proxy = initializer.request_proxy
+
+      if request_proxy.nil?
+        http = Net::HTTP.new(url.host, url.port)
+      else
+        proxy_host = request_proxy.host
+        proxy_port = request_proxy.port
+        proxy_user = nil
+        proxy_password = nil
+        unless proxy_user.nil?
+          proxy_user = request_proxy.user_name
+          proxy_password = request_proxy.password
+        end
+        http = Net::HTTP.new(url.host, url.port, proxy_host, proxy_port, proxy_user, proxy_password)
+        SDKLog::SDKLogger.info(proxy_log(request_proxy))
+      end
+
+      http.use_ssl = true
+      http.open_timeout = initializer.sdk_config.open_timeout
+      http.read_timeout = initializer.sdk_config.read_timeout
+      http.write_timeout = initializer.sdk_config.write_timeout
+      http.keep_alive_timeout = initializer.sdk_config.keep_alive_timeout
+
+      if @request_method == Constants::REQUEST_METHOD_GET
+        req = Net::HTTP::Get.new(url.request_uri)
+      elsif @request_method == Constants::REQUEST_METHOD_POST
+        req = Net::HTTP::Post.new(url.request_uri)
+      elsif @request_method == Constants::REQUEST_METHOD_PUT
+        req = Net::HTTP::Put.new(url.request_uri)
+      elsif @request_method == Constants::REQUEST_METHOD_PATCH
+        req = Net::HTTP::Patch.new(url.request_uri)
+      elsif @request_method == Constants::REQUEST_METHOD_DELETE
+        req = Net::HTTP::Delete.new(url.request_uri)
+      end
+
+      set_content_type_header unless @content_type.nil?
+
+      @headers&.each { |key, value| req.add_field(key, value) }
+
+      converter_instance.append_to_request(req, @request_body) unless @request_body.nil?
+
+      SDKLog::SDKLogger.info(to_s)
+
+      response = http.request(req)
+      response
+    end
+
+    def to_s
+      req_headers = @headers.clone
+      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)
+      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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Response
+  # This class is the common API response object.
+  class APIResponse
+    attr_reader :headers, :status_code, :data_object, :is_expected
+    # Creates an APIResponse class instance with the specified parameters.
+    # @param headers A Hash containing the API response headers.
+    # @param status_code A Integer containing the API response HTTP status code.
+    # @param object A Object containing the API response class instance.
+    def initialize(headers, status_code, object, is_expected)
+      @headers = headers
+      @status_code = status_code
+      @data_object = object
+      @is_expected = is_expected
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Util
+  class Choice
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+  end
+end

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

@@ -0,0 +1,236 @@
+require 'uri'
+
+require_relative 'json_converter'
+require_relative 'form_data_converter'
+require_relative 'data_type_converter'
+require_relative 'downloader'
+require_relative 'api_response'
+require_relative 'api_http_connector'
+require_relative '../initializer'
+require_relative '../header'
+require_relative '../param'
+require_relative '../header_map'
+require_relative '../parameter_map'
+require_relative 'constants'
+require_relative '../exception/sdk_exception'
+require_relative '../../../api/logger/sdk_logger'
+
+module Handler
+  # This class is to process the API request and its response.
+  # Construct the objects that are to be sent as parameters or in the request body with the API.
+  # The Request parameter, header and body objects are constructed here.
+  # Process the response JSON and converts it to relevant objects in the library.
+  class CommonAPIHandler
+    attr_accessor :api_path, :header, :param, :category_method, :request, :http_method, :module_api_name, :content_type, :mandatory_checker
+
+    def initialize
+      @api_path = nil
+
+      @header = HeaderMap.new
+
+      @param = ParameterMap.new
+
+      @mandatory_checker = false
+
+      @request = nil
+
+      @http_method = nil
+
+      @category_method = nil
+
+      @module_api_name = nil
+
+      @content_type = nil
+    end
+
+    # This method is used in constructing API request and response details. To make the Zoho CRM API calls.
+    # @param class_name [String] A Class containing the method return type.
+    # @param encode_type [String] A String containing the expected API response content type.
+    # @see Util::APIHTTPConnector
+    # @return A APIResponse representing the Zoho CRM API response instance or nil.
+    def api_call(class_name, encode_type)
+      if Initializer.get_initializer.nil?
+        raise SDKException.new(Constants::SDK_UNINITIALIZATION_ERROR, Constants::SDK_UNINITIALIZATION_MESSAGE, nil, nil)
+      end
+
+      connector = Util::APIHTTPConnector.new
+
+      begin
+        set_api_url(connector)
+      rescue SDKException => e
+        SDKLog::SDKLogger.severe(Constants::SET_API_URL_EXCEPTION, e)
+        raise e
+      rescue StandardError => e
+        ex = SDKException.new(nil, nil, nil, e)
+        SDKLog::SDKLogger.severe(Constants::SET_API_URL_EXCEPTION, ex)
+        raise ex
+      end
+
+      connector.request_method = @http_method
+
+      connector.content_type = @content_type
+
+      connector.headers = @header.header_hash if !@header.nil? && !@header.header_hash.empty?
+
+      connector.parameters = @param.param_hash if !@param.nil? && !@param.param_hash.empty?
+
+      begin
+        Initializer.get_initializer.token.authenticate(connector)
+      rescue SDKException => e
+        SDKLog::SDKLogger.severe(Constants::AUTHENTICATION_EXCEPTION, e)
+        raise e
+      rescue StandardError => e
+        ex = SDKException.new(nil, nil, nil, e)
+        SDKLog::SDKLogger.severe(Constants::AUTHENTICATION_EXCEPTION, ex)
+        raise ex
+      end
+
+      converter_instance = nil
+
+      if !@content_type.nil? && (Constants::IS_GENERATE_REQUEST_BODY.include? http_method) 
+
+        request = nil
+
+        begin
+          converter_instance = get_converter_class_instance(@content_type.to_s.downcase)
+          request = converter_instance.form_request(@request, @request.class.name, nil, nil)
+        rescue SDKException => e
+          SDKLog::SDKLogger.severe(Constants::FORM_REQUEST_EXCEPTION, e)
+          raise e
+        rescue StandardError => e
+          ex = SDKException.new(nil, nil, nil, e)
+          SDKLog::SDKLogger.severe(Constants::FORM_REQUEST_EXCEPTION, ex)
+          raise ex
+        end
+
+        connector.request_body = request
+      end
+
+      begin
+        connector.headers[Constants::ZOHO_SDK] = RUBY_PLATFORM + ' Ruby/' + RUBY_VERSION + ':' + Constants::SDK_VERSION
+
+        response = connector.fire_request(converter_instance)
+
+        status_code = response.code.to_i
+
+        headers = response.each_header.to_h
+
+        is_model = false
+
+        return_object = nil
+
+        unless response.body.nil?
+          mime_type = headers[Constants::CONTENT_TYPE]
+
+          mime_type = mime_type.split(';')[0] if mime_type.include? ';'
+          converter_instance = get_converter_class_instance(mime_type.to_s.downcase)
+
+          return_object = converter_instance.get_wrapped_response(response, class_name)
+        end
+
+        unless return_object.nil?
+
+          is_model = true if (class_name == return_object.class.name) || is_expected_type(return_object, class_name)
+        end
+        Response::APIResponse.new(headers, status_code, return_object, is_model)
+      rescue SDKException => e
+        SDKLog::SDKLogger.severe(Constants::API_CALL_EXCEPTION, e)
+        raise e
+      rescue StandardError => e
+        ex = SDKException.new(nil, nil, nil, e)
+        SDKLog::SDKLogger.severe(Constants::API_CALL_EXCEPTION, ex)
+        raise ex
+      end
+    end
+
+    def is_expected_type(model, class_name)
+      ancestors = model.class.ancestors
+      ancestors.each do |ancestor|
+        return true if ancestor.name == class_name
+      end
+      false
+    end
+
+    # This method is to add an API request parameter.
+    # @param param [Param] A Param class instance.
+    # @param param_value [Object] An object containing the API request parameter value.
+    def add_param(param, param_value)
+      if param.is_a? Param
+        unless param_value.nil?
+          @param = ParameterMap.new if @param.nil?
+
+          @param.add(param, param_value)
+        end
+      end
+    end
+
+    def param=(param_instance)
+      return if (param_instance==nil)
+      @param = ParameterMap.new if @param.nil?
+      @param.param_hash = @param.param_hash.merge(param_instance.param_hash)
+    end
+
+    def header=(header_instance)
+      return if (header_instance==nil)
+      @header = HeaderMap.new if @header.nil?
+      @header.header_hash = @header.header_hash.merge(header_instance.header_hash)
+    end
+
+    # This method is to add an API request header.
+    # @param header [Header] A Header class instance.
+    # @param param_value [Object] An object containing the API request parameter value.
+    def add_header(header, header_value)
+      if header.is_a? Header
+        unless header_value.nil?
+
+          @header = HeaderMap.new if @header.nil?
+
+          @header.add(header, header_value)
+        end
+      end
+    end
+
+    def set_api_url(connector)
+      api_path = ''
+      initializer = Initializer.get_initializer
+      if @api_path.to_s.include? Constants::HTTP
+        if @api_path.to_s.include? Constants::CONTENT_API_URL
+          api_path = initializer.environment.file_upload_url
+          begin
+            uri = URI.parse(@api_path)
+
+            api_path += uri.path
+          rescue URI::InvalidURIError => e
+            ex = SDKException.new(nil, nil, nil, e)
+            SDKLog::SDKLogger.severe(Constants::INVALID_URL_ERROR, ex)
+
+            raise ex
+          end
+        else
+          @api_path = @api_path.to_s.slice(1..@api_path.to_s.length) if @api_path.to_s.slice(0..0) == '/'
+          api_path += @api_path
+        end
+      else
+        api_path += initializer.environment.url
+
+        api_path += @api_path
+      end
+      connector.url = api_path
+    end
+
+    # This method is used to get a Converter class instance.
+    # @param encode_type [String] A String containing the expected API response content type.
+    def get_converter_class_instance(encode_type)
+      case encode_type
+      when 'application/json', 'text/plain' , 'application/ld+json'
+        Util::JSONConverter.new(self)
+      when 'application/xml', 'text/xml'
+        Util::XMLConverter.new(self)
+      when 'multipart/form-data'
+        Util::FormDataConverter.new(self)
+      when 'image/png','image/jpeg','image/gif','image/tiff','image/svg+xml','image/bmp','image/webp','text/csv','text/html','text/css','text/javascript','text/calendar','application/x-download','application/zip','application/pdf','application/java-archive','application/javascript','application/octet-stream','application/xhtml+xml','application/x-bzip','application/msword','application/vnd.openxmlformats-officedocument.wordprocessingml.document','application/gzip','application/x-httpd-php','application/vnd.ms-powerpoint','application/vnd.rar','application/x-sh','application/x-tar','application/vnd.ms-excel','application/vnd.openxmlformats-officedocument.spreadsheetml.sheet','application/x-7z-compressed','audio/mpeg','audio/x-ms-wma','audio/vnd.rn-realaudio','audio/x-wav','audio/3gpp','audio/3gpp2','video/mpeg','video/mp4','video/webm','video/3gpp','video/3gpp2','font/ttf'
+        Util::Downloader.new(self)
+      end
+    end
+  end
+end