apimatic_core_interfaces 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaf47cc9c42b3a20af7fa3b74bdabd33852f43d29e7f2fe426ee17f51fb0ff42
-  data.tar.gz: 4d9200846000fa6492e05d04d4dbc51b27ff7a3e077b583f96af5e9d89c8a420
+  metadata.gz: bb1641a899a871a9ce535ef8f0067428fadfeef40a4225caf6e2888f4efe2bba
+  data.tar.gz: 96cea708ad59e88a0d2f3058a2411718032fd1d68528ee374755b93f4fb90fe4
 SHA512:
-  metadata.gz: b9a7ca20453fd54f0342271f1a4173fe3165c0cb53a45e1bbdff5e8379d0c9edd6a7b5135cb960ecb23ec97543d7d4f196290645ca11bafe23bf36c4490099bc
-  data.tar.gz: be574e6033423b730fe3e8a4e5f5c3d9b5167e0e4bfa376645cdee46310ea692a15cb297c82d42894bcd790647d2517d735afc0b630b45d601ba23aed08fa1bf
+  metadata.gz: 1c8ef44909e9ad1bd2b9fa303610b4b0850355b5d15f31544255fcc0857b8ba02115f36ca99d06fdbda44af94d53b2bb4aa99d46a75512c97e6f0734c3f1acb7
+  data.tar.gz: 831893359497ca2843612c9d3ff6b31b867e282e0c1483b4b145986963e9dd623157e3b82eb925a7a33e4debcc4539003a5d04997e67a1add8dbdb45453e5d9e

data/README.md

@@ -3,7 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/apimatic_core_interfaces.svg)](https://badge.fury.io/rb/apimatic_core_interfaces)
 [![Linting][lint-badge]][lint-url]
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
-[![Maintainability][maintainability-url]][code-climate-url]
+[![Maintainability Rating][maintainability-badge]][maintainability-url]
+[![Vulnerabilities][vulnerabilities-badge]][vulnerabilities-url]
 [![Licence][license-badge]][license-url]
 
 ## Introduction
@@ -30,7 +31,8 @@ gem 'apimatic_core_interfaces'
 | [`ResponseFactory`](lib/apimatic-core-interfaces/factories/response_factory.rb)      | To convert the client-adapter response into a custom HTTP response                                |
 | [`Authentication`](lib/apimatic-core-interfaces/types/authentication.rb)             | To setup methods for the validation and application of the required authentication scheme         |
 | [`UnionType`](lib/apimatic-core-interfaces/types/union_type.rb)                      | To setup methods for the validation, serialization and deserialization of OneOf/AnyOf union types |
-| [`ClientConfiguration`](lib/apimatic-core-interfaces/client/client_configuration.rb) | To setup the http client configurations including retries, timeouts and connections etc.          |
+| [`ApiLogger`](lib/apimatic-core-interfaces/logger/api_logger.rb) | An interface for logging API requests and responses.                                                               |
+| [`Logger`](lib/apimatic-core-interfaces/logger/logger.rb) | An interface for the generic logger facade |
 
 
 ## Enumerations
@@ -42,7 +44,9 @@ gem 'apimatic_core_interfaces'
 
 [lint-badge]: https://github.com/apimatic/core-interfaces-ruby/actions/workflows/lint-runner.yml/badge.svg
 [lint-url]: https://github.com/apimatic/core-interfaces-ruby/actions/workflows/lint-runner.yml
-[code-climate-url]: https://codeclimate.com/github/apimatic/core-interfaces-ruby
-[maintainability-url]: https://api.codeclimate.com/v1/badges/6557a25e71f7e97e4bb5/maintainability
+[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-interfaces-ruby&metric=sqale_rating
+[maintainability-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-interfaces-ruby
+[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-interfaces-ruby&metric=vulnerabilities
+[vulnerabilities-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-interfaces-ruby
 [license-badge]: https://img.shields.io/badge/licence-MIT-blue
 [license-url]: LICENSE

data/lib/apimatic-core-interfaces/client/client_configuration.rb

@@ -4,6 +4,7 @@ module CoreLibrary
   # for HTTP Client Configuration class.
   class ClientConfiguration
     attr_reader :timeout, :max_retries, :retry_interval, :backoff_factor, :retry_statuses,
-                :retry_methods, :connection, :adapter, :response_factory, :cache, :verify
+                :retry_methods, :connection, :adapter, :response_factory, :cache, :verify,
+                :proxy_settings
   end
 end

data/lib/apimatic-core-interfaces/logger/api_logger.rb

@@ -0,0 +1,18 @@
+module CoreLibrary
+  # An interface for logging API requests and responses.
+  # This class should not be instantiated but should be used as a base class
+  # for API logger class.
+  class ApiLogger
+    # Logs the details of an HTTP request.
+    # @param request [HttpRequest] The HTTP request to log.
+    def log_request(request)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+
+    # Logs the details of an HTTP response.
+    # @param response [HttpResponse] The HTTP response to log.
+    def log_response(response)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module CoreLibrary
+  # An interface for the generic logger facade.
+  # This class should not be instantiated but should be used as a base class
+  # for Logger class.
+  class 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/apimatic_core_interfaces.rb

@@ -3,6 +3,9 @@ require_relative 'apimatic-core-interfaces/client/client_configuration'
 
 require_relative 'apimatic-core-interfaces/factories/response_factory'
 
+require_relative 'apimatic-core-interfaces/logger/logger'
+require_relative 'apimatic-core-interfaces/logger/api_logger'
+
 require_relative 'apimatic-core-interfaces/types/authentication'
 require_relative 'apimatic-core-interfaces/types/union_type'
 require_relative 'apimatic-core-interfaces/types/http_callback'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apimatic_core_interfaces
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - APIMatic Ltd.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies: []
 description: This project contains the abstract layer for APIMatic's core library.
   The purpose of creating interfaces is to separate out the functionalities needed
@@ -25,6 +25,8 @@ files:
 - lib/apimatic-core-interfaces/client/client_configuration.rb
 - lib/apimatic-core-interfaces/client/http_client.rb
 - lib/apimatic-core-interfaces/factories/response_factory.rb
+- lib/apimatic-core-interfaces/logger/api_logger.rb
+- lib/apimatic-core-interfaces/logger/logger.rb
 - lib/apimatic-core-interfaces/types/array_serialization_format.rb
 - lib/apimatic-core-interfaces/types/authentication.rb
 - lib/apimatic-core-interfaces/types/datetime_format.rb
@@ -36,7 +38,7 @@ homepage: https://apimatic.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: An abstract layer of the functionalities provided by apimatic-core, faraday-client-adapter
   and APIMatic SDKs.