test-words-api-client-sdk 4.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc853944386042955805e31d75893eb16831b221271ba5e6e6cfbe3edb246807
-  data.tar.gz: 9e8aecf25fdabd5cc70ad1960e5f17af270bc9bca18cfcff1625b69cb5780e31
+  metadata.gz: 7aa6d9df0cff204ce217ed8c3adc1bffbc7f5f68f91a92346e8a4955b91084d9
+  data.tar.gz: e4282ba194c12e54567a0ac293f1557175b4ad03397910561f7e94065eb69641
 SHA512:
-  metadata.gz: a0dcabe30a1672e5cdd583aca52482f8333493558476d7a55fa8d53febd0aef0bdcaed3be50512306ecab88e02b7325ecbbcbfa935eb8a2ae64c6ac35ec43959
-  data.tar.gz: f0819b6e2989d99464e9afec89f1952e09c991d5c55bd0ac8afc8e66b73afd9594162681694e37a44ce1535dc0b387204e94e99d31bd7265d488d19c231dbffa
+  metadata.gz: 992c9d288afdb6cf0f16caf985bf2075ae7f478777c7982f39562452e6de20ac866afb7a342e8b3a9474bc7e1ecc53c4159c33da6d7655b214bbf0c8e538e6c2
+  data.tar.gz: 99e926253b2af43e52ec51ac938c26a1249de9e67f08a1b5095c9875b82cf5c73484ffe4e5d08746114879dd6d289ae1108448a0598a042fdcee025efda8bffe

data/README.md

@@ -10,16 +10,16 @@ Words API lets you retrieve information about English words, including definitio
 Install the gem from the command line:
 
 ```ruby
-gem install test-words-api-client-sdk -v 4.0.0
+gem install test-words-api-client-sdk -v 5.0.1
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'test-words-api-client-sdk', '4.0.0'
+gem 'test-words-api-client-sdk', '5.0.1'
 ```
 
-For additional gem details, see the [RubyGems page for the test-words-api-client-sdk gem](https://rubygems.org/gems/test-words-api-client-sdk/versions/4.0.0).
+For additional gem details, see the [RubyGems page for the test-words-api-client-sdk gem](https://rubygems.org/gems/test-words-api-client-sdk/versions/5.0.1).
 
 ## Test the SDK
 
@@ -31,7 +31,7 @@ rake
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -46,7 +46,8 @@ The following parameters are configurable for the API Client:
 | `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
 | `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| `logging_configuration` | [`LoggingConfiguration`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
 
 The API client can be initialized as follows:
 
@@ -54,6 +55,15 @@ The API client can be initialized as follows:
 client = WordsApi::Client.new(
   custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
     x_rapid_api_key: 'X-RapidAPI-Key'
+  ),
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
   )
 )
 ```
@@ -62,15 +72,19 @@ client = WordsApi::Client.new(
 
 This API uses the following authentication schemes.
 
-* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/auth/custom-header-signature.md)
+* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/auth/custom-header-signature.md)
 
 ## List of APIs
 
-* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/controllers/ap-is.md)
+* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/controllers/ap-is.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/4.0.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/http-request.md)
+* [LoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/response-logging-configuration.md)
+* [Abstract Logger](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/5.0.1/doc/abstract-logger.md)
 

data/lib/words_api/client.rb

@@ -20,8 +20,9 @@ module WordsApi
       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], http_callback: nil,
-      environment: Environment::PRODUCTION, x_rapid_api_key: nil,
-      custom_header_authentication_credentials: nil, config: nil
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      x_rapid_api_key: nil, custom_header_authentication_credentials: nil,
+      config: nil
     )
       @config = if config.nil?
                   Configuration.new(
@@ -30,6 +31,7 @@ module WordsApi
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
+                    logging_configuration: logging_configuration,
                     environment: environment, x_rapid_api_key: x_rapid_api_key,
                     custom_header_authentication_credentials: custom_header_authentication_credentials
                   )

data/lib/words_api/configuration.rb

@@ -37,14 +37,15 @@ module WordsApi
       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], http_callback: nil,
-      environment: Environment::PRODUCTION, x_rapid_api_key: nil,
-      custom_header_authentication_credentials: nil
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      x_rapid_api_key: nil, custom_header_authentication_credentials: nil
     )
 
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
             backoff_factor: backoff_factor, retry_statuses: retry_statuses,
-            retry_methods: retry_methods, http_callback: http_callback
+            retry_methods: retry_methods, http_callback: http_callback,
+            logging_configuration: logging_configuration
 
       # Current API environment
       @environment = String(environment)
@@ -64,7 +65,8 @@ module WordsApi
     def clone_with(connection: nil, adapter: nil, timeout: nil,
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, http_callback: nil,
-                   environment: nil, x_rapid_api_key: nil,
+                   logging_configuration: nil, environment: nil,
+                   x_rapid_api_key: nil,
                    custom_header_authentication_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
@@ -75,6 +77,7 @@ module WordsApi
       retry_statuses ||= self.retry_statuses
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
+      logging_configuration ||= self.logging_configuration
       environment ||= self.environment
       custom_header_authentication_credentials = create_auth_credentials_object(
         x_rapid_api_key,
@@ -86,7 +89,7 @@ module WordsApi
         max_retries: max_retries, retry_interval: retry_interval,
         backoff_factor: backoff_factor, retry_statuses: retry_statuses,
         retry_methods: retry_methods, http_callback: http_callback,
-        environment: environment,
+        logging_configuration: logging_configuration, environment: environment,
         custom_header_authentication_credentials: custom_header_authentication_credentials
       )
     end

data/lib/words_api/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,114 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::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: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.class.new(log_body: log_body, log_headers: log_headers,
+                                            headers_to_include: headers_to_include,
+                                            headers_to_exclude: headers_to_exclude,
+                                            headers_to_unmask: headers_to_unmask,
+                                            include_query_in_path: include_query_in_path)
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::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.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(log_body: log_body, log_headers: log_headers,
+                                       headers_to_include: headers_to_include,
+                                       headers_to_exclude: headers_to_exclude,
+                                       headers_to_unmask: headers_to_unmask)
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::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 [RequestLoggingConfiguration] Options for logging HTTP requests.
+    # @param response_logging_config [ResponseLoggingConfiguration] Options for logging HTTP responses.
+    # @param mask_sensitive_headers [Boolean] Indicates whether sensitive headers should be masked in logged messages.
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers = self.mask_sensitive_headers ||= mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(logger: logger, log_level: log_level,
+                               mask_sensitive_headers: mask_sensitive_headers,
+                               request_logging_config: request_logging_config,
+                               response_logging_config: response_logging_config)
+    end
+  end
+end

data/lib/words_api/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# words_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module WordsApi
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @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)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/words_api.rb

@@ -24,6 +24,8 @@ require_relative 'words_api/http/http_request'
 require_relative 'words_api/http/http_response'
 
 # Logger
+require_relative 'words_api/logging/configuration/api_logging_configuration'
+require_relative 'words_api/logging/sdk_logger'
 require_relative 'words_api/http/auth/custom_header_authentication'
 
 # Models

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-words-api-client-sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Sufyan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -103,6 +103,8 @@ files:
 - lib/words_api/http/http_method_enum.rb
 - lib/words_api/http/http_request.rb
 - lib/words_api/http/http_response.rb
+- lib/words_api/logging/configuration/api_logging_configuration.rb
+- lib/words_api/logging/sdk_logger.rb
 - lib/words_api/models/base_model.rb
 - lib/words_api/models/definitions_response.rb
 - lib/words_api/models/examples_response.rb