ZOHOCRMSDK2_0 1.0.0 → 5.0.0

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

@@ -7,175 +7,177 @@ require_relative '../util/api_response'
 require_relative '../util/common_api_handler'
 require_relative '../util/constants'
 
-module Users
-  class UsersOperations
+module ZOHOCRMSDK
+  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)
+      # Creates an instance of UsersOperations
+      def initialize
       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)
+        # 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
-      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)
+        # 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
-      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)
+        # 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
-      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)
+        # 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
-      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)
+        # 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
-      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
+        # 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
-      @@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
+
+      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
-    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
+      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
-    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
+      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
   end
 end

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

@@ -4,109 +4,111 @@ 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
+module ZOHOCRMSDK
+  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
+      def initialize
+        @url = nil
 
-      @headers = {}
+        @headers = {}
 
-      @request_method = nil
+        @request_method = nil
 
-      @parameters = {}
+        @parameters = {}
 
-      @request_body = nil
+        @request_body = nil
 
-      @content_type = nil
-    end
+        @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
+      def set_content_type_header
+        Constants::SET_CONTENT_TYPE_HEADER.each do |content_type|
+          if @url.include? content_type
+            @headers[Constants::CONTENT_TYPE] = @content_type
+            break
+          end
         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
+      # 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
+        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 = 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
+        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?
+        set_content_type_header unless @content_type.nil?
 
-      @headers&.each { |key, value| req.add_field(key, value) }
+        @headers&.each { |key, value| req.add_field(key, value) }
 
-      converter_instance.append_to_request(req, @request_body) unless @request_body.nil?
+        converter_instance.append_to_request(req, @request_body) unless @request_body.nil?
 
-      SDKLog::SDKLogger.info(to_s)
+        SDKLog::SDKLogger.info(to_s)
 
-      response = http.request(req)
-      response
-    end
+        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 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
+      def proxy_log(request_proxy)
+        proxy_log = Constants::PROXY_SETTINGS + Constants::PROXY_HOST + request_proxy.host + " , "
+        proxy_log += Constants::PROXY_PORT + request_proxy.port.to_s
+        if request_proxy.user_name.nil?
+          proxy_log +=  " , " + Constants::PROXY_USER + request_proxy.user_name
+        end
+        proxy_log
       end
     end
   end
-end
+end

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

@@ -1,16 +1,18 @@
-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
+module ZOHOCRMSDK
+  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
-end
+end

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

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