apimatic_core 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a7a24dd99dffe816667bdbd683775d7b4961a2159cdcca5f6d01202aaad8cb
-  data.tar.gz: e869b19703d585e264d2786da045a2689f14cd5a905b1124bbd4f37df097ec63
+  metadata.gz: d6999e5f75a815faf7120e5f551b3ea2661e6d146a84e087426f64b27863d2fc
+  data.tar.gz: f9c63258f67b4798393569aa35ca04c54bd70b0109f32d2f3bd756b6aed7838d
 SHA512:
-  metadata.gz: e49802888b0b9e38e94f8e287ba5b4fdfd049145643ec2f39076f5b2d4a5d8ebb6d54599aa89f016597ca9ad2f7d6d4f2a60f4a10654d654ee0a7429a809866f
-  data.tar.gz: 95cff96de07545fe02287eff869b34b43e424ca094ccde6ecf9ef892c0f0b019c1b5b9fd9959962ceaef10a9b541329288a3db881421b35d6f8057c6d4a383dc
+  metadata.gz: c86684bed17cbe67d0750a78bda0bc03b2385414a8ebba30088fa7990d45ae2471426cb8c0457ead6d3d1dbcbb5a11003e435fc2105917e234b6e13cd2a292b2
+  data.tar.gz: 5c539fe7981f7aa5196ad81e9f0e76ffaa3d3729d536f824ab3b5c2170e5cce61300f3f6018db93785121487b18db580d0eed60c67443ed4c2b72c8445a89899

data/README.md

@@ -72,7 +72,12 @@ gem 'apimatic_core'
 ## Logger
 | Name                                                              | Description                                |
 |-------------------------------------------------------------------|--------------------------------------------|
-| [`EndpointLogger`](lib/apimatic-core/logger/endpoint_logger.rb)   | A class to provide logging for an API call |
+| [`SdkLogger`](lib/apimatic-core/logger/sdk_logger.rb)   | A class responsible for logging request and response of an api call|
+| [`NilSdkLogger`](lib/apimatic-core/logger/nil_sdk_logger.rb)   | A class responsible for no logging|
+| [`ConsoleLogger`](lib/apimatic-core/logger/default_logger.rb)   | Represents default implementation of logger interface|
+| [`ApiLoggingConfiguration`](lib/apimatic-core/logger/api_logging_configuration.rb)   | Represents logging configuration|
+| [`ApiRequestLoggingConfiguration`](lib/apimatic-core/logger/api_logging_configuration.rb)   | Represents request logging configuration.|
+| [`ApiResponseLoggingConfiguration`](lib/apimatic-core/logger/api_logging_configuration.rb)   | Represents response logging configuration.|
 
 ## Types
 | Name                                                                            | Description                                                                   |

data/lib/apimatic-core/api_call.rb

@@ -4,19 +4,17 @@ module CoreLibrary
     # Creates a new builder instance of the API call with pre-configured global and logging configurations.
     # @return [ApiCall] The instance of ApiCall object.
     def new_builder
-      ApiCall.new(@global_configuration, logger: @endpoint_logger.logger)
+      ApiCall.new(@global_configuration)
     end
 
     # Initializes a new instance of ApiCall.
     # @param [GlobalConfiguration] global_configuration An instance of GlobalConfiguration.
-    # @param logger An optional logger to log execution of program.
-    def initialize(global_configuration, logger: nil)
+    def initialize(global_configuration)
       @global_configuration = global_configuration
       @request_builder = RequestBuilder.new
       @response_handler = ResponseHandler.new
-      @endpoint_logger = EndpointLogger.new(logger)
-      @endpoint_name_for_logging = nil
       @endpoint_context = {}
+      initialize_api_logger(@global_configuration.client_configuration.logging_configuration)
     end
 
     # The setter for the request builder to be used for building the request of an API call.
@@ -35,14 +33,6 @@ module CoreLibrary
       self
     end
 
-    # The setter for the name of the endpoint controller method to used while logging an endpoint call.
-    # @param [String] endpoint_name_for_logging The name of the endpoint controller method to used while logging.
-    # @return [ApiCall] An updated instance of ApiCall.
-    def endpoint_name_for_logging(endpoint_name_for_logging)
-      @endpoint_name_for_logging = endpoint_name_for_logging
-      self
-    end
-
     # The setter for the context for an endpoint call.
     # @param [String] context_key The name of the endpoint context.
     # @param [Object] context_value The value of the endpoint context.
@@ -61,45 +51,45 @@ module CoreLibrary
           raise ArgumentError, 'An HTTP client instance is required to execute an Api call.'
         end
 
-        _http_request = @request_builder.endpoint_logger(@endpoint_logger)
-                                        .endpoint_name_for_logging(@endpoint_name_for_logging)
-                                        .global_configuration(@global_configuration)
+        _http_request = @request_builder.global_configuration(@global_configuration)
                                         .build(@endpoint_context)
-        @endpoint_logger.debug("Raw request for #{@endpoint_name_for_logging} is: #{_http_request.inspect}")
+        @logger.log_request(_http_request)
 
         _http_callback = _client_configuration.http_callback
         unless _http_callback.nil?
           update_http_callback(proc do
             _http_callback&.on_before_request(_http_request)
-          end, "Calling the on_before_request method of http_call_back for #{@endpoint_name_for_logging}.")
+          end)
         end
-
         _http_response = _client_configuration.http_client.execute(_http_request)
-        @endpoint_logger.debug("Raw response for #{@endpoint_name_for_logging} is: #{_http_response.inspect}")
+        @logger.log_response(_http_response)
 
         unless _http_callback.nil?
           update_http_callback(proc do
             _http_callback&.on_after_response(_http_response)
-          end, "Calling the on_after_response method of http_call_back for #{@endpoint_name_for_logging}.")
+          end)
         end
 
-        _deserialized_response = @response_handler.endpoint_logger(@endpoint_logger)
-                                                  .endpoint_name_for_logging(@endpoint_name_for_logging)
-                                                  .handle(_http_response, @global_configuration.get_global_errors,
+        _deserialized_response = @response_handler.handle(_http_response, @global_configuration.get_global_errors,
                                                           @global_configuration.should_symbolize_hash)
         _deserialized_response
       rescue StandardError => e
-        @endpoint_logger.error(e)
         raise e
       end
     end
 
     # Registers request and response with the provided http_callback
     # @param [Callable] callable The callable to be called for registering into the HttpCallback instance.
-    # @param [String] log_message The message to be logged if HttpCallback is set.
-    def update_http_callback(callable, log_message)
-      @endpoint_logger.info(log_message)
+    def update_http_callback(callable)
       callable.call
     end
+
+    def initialize_api_logger(logging_config)
+      @logger = if logging_config.nil?
+                  NilSdkLogger.new
+                else
+                  SdkLogger.new(logging_config)
+                end
+    end
   end
 end

data/lib/apimatic-core/http/configurations/http_client_configuration.rb

@@ -1,7 +1,7 @@
 module CoreLibrary
   # Configuration for an HttpClient.
   class HttpClientConfiguration < ClientConfiguration
-    attr_reader :http_client, :http_callback
+    attr_reader :http_client, :http_callback, :logging_configuration
 
     # Initializes a new instance of HttpClientConfiguration.
     # @param connection Connection information
@@ -20,7 +20,8 @@ module CoreLibrary
       connection: nil, adapter: :net_http_persistent, timeout: 60,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], cache: false, verify: true, http_callback: nil, http_client: nil
+      retry_methods: %i[get put], cache: false, verify: true, http_callback: nil, http_client: nil,
+      logging_configuration: nil
     )
       @response_factory = HttpResponseFactory.new
       @connection = connection
@@ -35,6 +36,7 @@ module CoreLibrary
       @verify = verify
       @cache = cache
       @http_client = http_client
+      @logging_configuration = logging_configuration
     end
 
     # Setter for http_client.

data/lib/apimatic-core/logger/configurations/api_logging_configuration.rb

@@ -0,0 +1,97 @@
+module CoreLibrary
+  # Represents options for configuring logging behavior.
+  class ApiLoggingConfiguration
+    attr_reader :logger, :log_level, :request_logging_config, :response_logging_config, :mask_sensitive_headers
+
+    # Initializes a new instance of ApiLoggingConfiguration.
+    #
+    # @param logger [LoggerInterface] The logger to use for logging messages.
+    # @param log_level [LogLevel] The log level to determine which messages should be logged.
+    # @param request_logging_config [ApiRequestLoggingConfiguration] Options for logging HTTP requests.
+    # @param response_logging_config [ApiResponseLoggingConfiguration] Options for logging HTTP responses.
+    # @param mask_sensitive_headers [Boolean] Indicates whether sensitive headers should be masked in logged messages.
+    def initialize(
+      logger,
+      log_level,
+      request_logging_config,
+      response_logging_config,
+      mask_sensitive_headers
+    )
+      @logger = logger || ConsoleLogger.new
+      @log_level = log_level || ::Logger::INFO
+      @request_logging_config = request_logging_config
+      @response_logging_config = response_logging_config
+      @mask_sensitive_headers = mask_sensitive_headers
+    end
+  end
+
+  # Represents configuration for logging HTTP messages.
+  class BaseHttpLoggingConfiguration
+    attr_reader :log_body, :log_headers, :headers_to_exclude, :headers_to_include, :headers_to_unmask
+
+    # Initializes a new instance of BaseHttpLoggingConfiguration.
+    #
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(
+      log_body,
+      log_headers,
+      headers_to_exclude,
+      headers_to_include,
+      headers_to_unmask
+    )
+      @log_body = log_body
+      @log_headers = log_headers
+      @headers_to_exclude = headers_to_exclude || []
+      @headers_to_include = headers_to_include || []
+      @headers_to_unmask = headers_to_unmask || []
+    end
+  end
+
+  # Represents request logging configuration.
+  class ApiRequestLoggingConfiguration < BaseHttpLoggingConfiguration
+    attr_reader :include_query_in_path
+
+    # Initializes a new instance of ApiRequestLoggingConfiguration.
+    #
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(
+      log_body,
+      log_headers,
+      headers_to_exclude,
+      headers_to_include,
+      headers_to_unmask,
+      include_query_in_path
+    )
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+      @include_query_in_path = include_query_in_path
+    end
+  end
+
+  # Represents response logging configuration.
+  class ApiResponseLoggingConfiguration < BaseHttpLoggingConfiguration
+    # Initializes a new instance of ApiResponseLoggingConfiguration.
+    #
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+  end
+end

data/lib/apimatic-core/logger/default_logger.rb

@@ -0,0 +1,44 @@
+# Represents a logger implementation that logs messages to the console.
+class ConsoleLogger < Logger
+  # Initializes a new instance of DefaultLogger.
+  def initialize
+    @logger = ::Logger.new($stdout)
+    @logger.formatter = method(:format_log_message)
+  end
+
+  # Logs a message to the console with the specified log level.
+  # @param level [Symbol] The log level of the message.
+  # @param message [String] The message to log.
+  # @param params [Hash] Additional parameters to include in the log message.
+  def log(level, message, params = {})
+    formatted_message = message_with_params(message, params)
+    case level
+    when Logger::DEBUG
+      @logger.debug(formatted_message)
+    when Logger::INFO
+      @logger.info(formatted_message)
+    when Logger::WARN
+      @logger.warn(formatted_message)
+    when Logger::ERROR
+      @logger.error(formatted_message)
+    when Logger::FATAL
+      @logger.fatal(formatted_message)
+    else
+      @logger.unknown(formatted_message)
+    end
+  end
+
+  def format_log_message(severity, _datetime, _progname, msg)
+    "#{
+       severity.ljust(5) +
+       msg
+     }\n"
+  end
+
+  def message_with_params(message, params)
+    message.gsub(/\{([\w-]+)\}/) do |match|
+      key = match[1..-2]
+      params[key.to_sym] || params[key.to_s]
+    end
+  end
+end

data/lib/apimatic-core/logger/nil_sdk_logger.rb

@@ -0,0 +1,16 @@
+module CoreLibrary
+  # This class is nil implementation of ApiLogger.
+  class NilSdkLogger < ApiLogger
+    # Logs the details of an HTTP request.
+    # @param request [HttpRequest] The HTTP request to log.
+    def log_request(request)
+      # This function is intentionally left empty because this logger does not perform any logging.
+    end
+
+    # Logs the details of an HTTP response.
+    # @param response [HttpResponse] The HTTP response to log.
+    def log_response(response)
+      # This function is intentionally left empty because this logger does not perform any logging.
+    end
+  end
+end

data/lib/apimatic-core/logger/sdk_logger.rb

@@ -0,0 +1,78 @@
+module CoreLibrary
+  # This class is responsible for logging request and response info.
+  class SdkLogger < ApiLogger
+    def initialize(logging_config)
+      @log_level = logging_config.log_level
+      @logger = logging_config.logger
+      @request_logging_config = logging_config.request_logging_config
+      @response_logging_config = logging_config.response_logging_config
+      @mask_sensitive_headers = logging_config.mask_sensitive_headers
+    end
+
+    def log_request(request)
+      content_type_header = LoggerHelper.get_content_type(request.headers)
+      url = @request_logging_config.include_query_in_path ? request.query_url : request.query_url.split('?').first
+
+      @logger.log(@log_level, "Request {#{METHOD}} {#{URL}} {#{CONTENT_TYPE_HEADER}}", {
+                    METHOD => request.http_method,
+                    URL => url,
+                    CONTENT_TYPE_HEADER => content_type_header
+                  })
+
+      apply_log_request_options(request)
+    end
+
+    def log_response(response)
+      content_type_header = LoggerHelper.get_content_type(response.headers)
+      content_length_header = LoggerHelper.get_content_length(response.headers)
+
+      @logger.log(@log_level, "Response {#{STATUS_CODE}} {#{CONTENT_LENGTH_HEADER}} {#{CONTENT_TYPE_HEADER}}", {
+                    STATUS_CODE => response.status_code,
+                    CONTENT_LENGTH_HEADER => content_length_header,
+                    CONTENT_TYPE_HEADER => content_type_header
+                  })
+
+      apply_log_response_options(response)
+    end
+
+    private
+
+    def apply_log_request_options(request)
+      headers_to_log = LoggerHelper.extract_headers_to_log(
+        @request_logging_config,
+        request.headers
+      )
+
+      if @request_logging_config.log_headers
+        @logger.log(@log_level, 'Request headers {headers}', {
+                      headers: headers_to_log
+                    })
+      end
+
+      return unless @request_logging_config.log_body
+
+      @logger.log(@log_level, 'Request body {body}', {
+                    body: request.parameters
+                  })
+    end
+
+    def apply_log_response_options(response)
+      headers_to_log = LoggerHelper.extract_headers_to_log(
+        @response_logging_config,
+        response.headers
+      )
+
+      if @response_logging_config.log_headers
+        @logger.log(@log_level, 'Response headers {headers}', {
+                      headers: headers_to_log
+                    })
+      end
+
+      return unless @response_logging_config.log_body
+
+      @logger.log(@log_level, 'Response body {body}', {
+                    body: response.raw_body
+                  })
+    end
+  end
+end

data/lib/apimatic-core/request_builder.rb

@@ -18,8 +18,6 @@ module CoreLibrary
       @auth = nil
       @array_serialization_format = ArraySerializationFormat::INDEXED
       @xml_attributes = nil
-      @endpoint_name_for_logging = nil
-      @endpoint_logger = nil
     end
 
     # The setter for the server.
@@ -154,22 +152,6 @@ module CoreLibrary
       self
     end
 
-    # The setter for the name of the endpoint controller method to used while logging an endpoint call.
-    # @param [String] endpoint_name_for_logging The name of the endpoint controller method to used while logging.
-    # @return [RequestBuilder] An updated instance of RequestBuilder.
-    def endpoint_name_for_logging(endpoint_name_for_logging)
-      @endpoint_name_for_logging = endpoint_name_for_logging
-      self
-    end
-
-    # The setter for the name of the endpoint controller method to used while logging an endpoint call.
-    # @param [EndpointLogger] endpoint_logger The name of the endpoint controller method to used while logging.
-    # @return [RequestBuilder] An updated instance of RequestBuilder.
-    def endpoint_logger(endpoint_logger)
-      @endpoint_logger = endpoint_logger
-      self
-    end
-
     # Sets global configuration object for the request builder.
     def global_configuration(global_configuration)
       @global_configuration = global_configuration
@@ -195,7 +177,6 @@ module CoreLibrary
     # Processes and resolves the endpoint URL.
     # @return [String] The processed URL.
     def process_url
-      @endpoint_logger.info("Preparing query URL for #{@endpoint_name_for_logging}.")
       _base_url = @global_configuration.get_base_uri_executor.call(@server)
       _updated_url_with_template_params = ApiHelper.append_url_with_template_parameters(@path, @template_params)
       _url = _base_url + _updated_url_with_template_params
@@ -233,10 +214,6 @@ module CoreLibrary
       _has_additional_headers = !_additional_headers.nil? && _additional_headers.any?
       _has_local_headers = !@header_params.nil? and @header_params.any?
 
-      if _has_global_headers || _has_additional_headers || _has_local_headers
-        @endpoint_logger.info("Preparing headers for #{@endpoint_name_for_logging}.")
-      end
-
       _request_headers.merge!(_global_headers) if _has_global_headers
       _request_headers.merge!(_additional_headers) if _has_additional_headers
 
@@ -258,12 +235,6 @@ module CoreLibrary
       _has_body_serializer = !@body_serializer.nil?
       _has_xml_attributes = !@xml_attributes.nil?
 
-      if _has_form_params || _has_additional_form_params
-        @endpoint_logger.info("Preparing form parameters for #{@endpoint_name_for_logging}.")
-      elsif _has_body_param
-        @endpoint_logger.info("Preparing body parameters for #{@endpoint_name_for_logging}.")
-      end
-
       if _has_xml_attributes
         return process_xml_parameters
       elsif _has_form_params || _has_additional_form_params || _has_multipart_param

data/lib/apimatic-core/response_handler.rb

@@ -12,8 +12,6 @@ module CoreLibrary
       @datetime_format = nil
       @is_xml_response = false
       @xml_attribute = nil
-      @endpoint_name_for_logging = nil
-      @endpoint_logger = nil
       @is_primitive_response = false
       @is_date_response = false
       @is_response_array = false
@@ -84,22 +82,6 @@ module CoreLibrary
       self
     end
 
-    # Sets the endpoint_name_for_logging property.
-    # @param [String] endpoint_name_for_logging The endpoint method name to be used while logging.
-    # @return [ResponseHandler] An updated instance of ResponseHandler.
-    def endpoint_name_for_logging(endpoint_name_for_logging)
-      @endpoint_name_for_logging = endpoint_name_for_logging
-      self
-    end
-
-    # Sets endpoint logger to be used.
-    # @param [EndpointLogger] endpoint_logger The logger to be used for logging API call steps.
-    # @return [ResponseHandler] An updated instance of ResponseHandler.
-    def endpoint_logger(endpoint_logger)
-      @endpoint_logger = endpoint_logger
-      self
-    end
-
     # Sets the is_primitive_response property.
     # @param [Boolean] is_primitive_response Flag if the response is of primitive type.
     # @return [ResponseHandler] An updated instance of ResponseHandler.
@@ -164,13 +146,8 @@ module CoreLibrary
     # @param [Boolean] should_symbolize_hash Flag to symbolize the hash during response deserialization.
     # @return [Object] The deserialized response of the API Call.
     def handle(response, global_errors, should_symbolize_hash = false)
-      @endpoint_logger.info("Validating response for #{@endpoint_name_for_logging}.")
-
       # checking Nullify 404
-      if response.status_code == 404 && @is_nullify404
-        @endpoint_logger.info("Status code 404 received for #{@endpoint_name_for_logging}. Returning None.")
-        return nil
-      end
+      return nil if response.status_code == 404 && @is_nullify404
 
       # validating response if configured
       validate(response, global_errors)

data/lib/apimatic-core/utilities/constants.rb

@@ -0,0 +1,7 @@
+module CoreLibrary
+  CONTENT_TYPE_HEADER = 'content-type'.freeze
+  CONTENT_LENGTH_HEADER = 'content-length'.freeze
+  METHOD = 'method'.freeze
+  URL = 'url'.freeze
+  STATUS_CODE = 'status_code'.freeze
+end

data/lib/apimatic-core/utilities/logger_helper.rb

@@ -0,0 +1,82 @@
+module CoreLibrary
+  # logger helper methods.
+  class LoggerHelper
+    NON_SENSITIVE_HEADERS = %w[
+      accept accept-charset accept-encoding accept-language access-control-allow-origin
+      cache-control connection content-encoding content-language content-length
+      content-location content-md5 content-range content-type date etag expect
+      expires from host if-match if-modified-since if-none-match if-range
+      if-unmodified-since keep-alive last-modified location max-forwards pragma
+      range referer retry-after server trailer transfer-encoding upgrade user-agent
+      vary via warning x-forwarded-for x-requested-with x-powered-by
+    ].map(&:downcase).freeze
+
+    def self.get_content_type(headers)
+      return '' if headers.nil?
+
+      headers.find { |key, _| key.downcase == CONTENT_TYPE_HEADER }&.last || ''
+    end
+
+    def self.get_content_length(headers)
+      return '' if headers.nil?
+
+      headers.find { |key, _| key.downcase == CONTENT_LENGTH_HEADER }&.last || ''
+    end
+
+    def self.extract_headers_to_log(http_logging_config, headers)
+      return headers if headers.nil?
+
+      filtered_headers = if http_logging_config.headers_to_include.any?
+                           include_headers(headers, http_logging_config.headers_to_include)
+                         elsif http_logging_config.headers_to_exclude.any?
+                           exclude_headers(headers, http_logging_config.headers_to_exclude)
+                         else
+                           headers
+                         end
+
+      mask_sensitive_headers(filtered_headers, http_logging_config.headers_to_unmask)
+    end
+
+    def self.include_headers(headers, headers_to_include)
+      included_headers = {}
+
+      headers_to_include.each do |name|
+        key = headers.keys.find { |header_key| header_key.downcase == name.downcase }
+        included_headers[key] = headers[key] if headers[key]
+      end
+
+      included_headers
+    end
+
+    def self.exclude_headers(headers, headers_to_exclude)
+      excluded_headers = {}
+
+      headers.each do |key, val|
+        excluded_headers[key] = val unless headers_to_exclude.any? do |excluded_name|
+          excluded_name.downcase == key.downcase
+        end
+      end
+
+      excluded_headers
+    end
+
+    def self.mask_sensitive_headers(headers, headers_to_unmask)
+      return headers unless @mask_sensitive_headers || !headers.nil?
+
+      headers.each do |key, val|
+        headers[key] = mask_if_sensitive_header(key, val, headers_to_unmask)
+      end
+
+      headers
+    end
+
+    def self.mask_if_sensitive_header(name, value, headers_to_unmask)
+      headers_to_unmask ||= []
+      headers_to_unmask = headers_to_unmask.map(&:downcase)
+      name_downcase = name.downcase
+
+      NON_SENSITIVE_HEADERS.include?(name_downcase) || headers_to_unmask.include?(name_downcase) ?
+        value : '**Redacted**'
+    end
+  end
+end

data/lib/apimatic_core.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'certifi'
 require 'apimatic_core_interfaces'
 require 'cgi'
+require 'logger'
 
 require_relative 'apimatic-core/request_builder'
 require_relative 'apimatic-core/response_handler'
@@ -16,7 +17,10 @@ require_relative 'apimatic-core/exceptions/auth_validation_exception'
 require_relative 'apimatic-core/exceptions/any_of_validation_exception'
 require_relative 'apimatic-core/exceptions/one_of_validation_exception'
 
-require_relative 'apimatic-core/logger/endpoint_logger'
+require_relative 'apimatic-core/logger/default_logger'
+require_relative 'apimatic-core/logger/nil_sdk_logger'
+require_relative 'apimatic-core/logger/sdk_logger'
+require_relative 'apimatic-core/logger/configurations/api_logging_configuration'
 
 require_relative 'apimatic-core/http/configurations/http_client_configuration'
 require_relative 'apimatic-core/http/request/http_request'
@@ -44,6 +48,8 @@ require_relative 'apimatic-core/utilities/xml_helper'
 require_relative 'apimatic-core/utilities/auth_helper'
 require_relative 'apimatic-core/utilities/union_type_helper'
 require_relative 'apimatic-core/utilities/json_pointer_helper'
+require_relative 'apimatic-core/utilities/logger_helper'
+require_relative 'apimatic-core/utilities/constants'
 
 require_relative 'apimatic-core/authentication/header_auth'
 require_relative 'apimatic-core/authentication/query_auth'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apimatic_core
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -173,7 +173,10 @@ files:
 - lib/apimatic-core/http/request/http_request.rb
 - lib/apimatic-core/http/response/api_response.rb
 - lib/apimatic-core/http/response/http_response.rb
-- lib/apimatic-core/logger/endpoint_logger.rb
+- lib/apimatic-core/logger/configurations/api_logging_configuration.rb
+- lib/apimatic-core/logger/default_logger.rb
+- lib/apimatic-core/logger/nil_sdk_logger.rb
+- lib/apimatic-core/logger/sdk_logger.rb
 - lib/apimatic-core/request_builder.rb
 - lib/apimatic-core/response_handler.rb
 - lib/apimatic-core/types/error_case.rb
@@ -190,9 +193,11 @@ files:
 - lib/apimatic-core/utilities/api_helper.rb
 - lib/apimatic-core/utilities/auth_helper.rb
 - lib/apimatic-core/utilities/comparison_helper.rb
+- lib/apimatic-core/utilities/constants.rb
 - lib/apimatic-core/utilities/date_time_helper.rb
 - lib/apimatic-core/utilities/file_helper.rb
 - lib/apimatic-core/utilities/json_pointer_helper.rb
+- lib/apimatic-core/utilities/logger_helper.rb
 - lib/apimatic-core/utilities/union_type_helper.rb
 - lib/apimatic-core/utilities/xml_helper.rb
 - lib/apimatic_core.rb

data/lib/apimatic-core/logger/endpoint_logger.rb

@@ -1,30 +0,0 @@
-module CoreLibrary
-  # This class is responsible for logging info messages, debug messages, and errors.
-  class EndpointLogger
-    attr_reader :logger
-
-    # Initializes a new instance of EndpointLogger.
-    # @param logger A logger with methods info, debug and error.
-    def initialize(logger)
-      @logger = logger
-    end
-
-    # Logs the info message.
-    # @param [String] info_message The message to be logged.
-    def info(info_message)
-      @logger&.info(info_message)
-    end
-
-    # Logs the debug message.
-    # @param [String] debug_message The message to be logged.
-    def debug(debug_message)
-      @logger&.debug(debug_message)
-    end
-
-    # Logs the error.
-    # @param [Exception] error The exception to be logged.
-    def error(error)
-      @logger&.error(error)
-    end
-  end
-end