apimatic_core_interfaces 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaf47cc9c42b3a20af7fa3b74bdabd33852f43d29e7f2fe426ee17f51fb0ff42
-  data.tar.gz: 4d9200846000fa6492e05d04d4dbc51b27ff7a3e077b583f96af5e9d89c8a420
+  metadata.gz: 01a4e34ebafdba39e2611a2b683cd55dfc9e28d1ba990680b247e82e0258eebb
+  data.tar.gz: 100242792ff4890d5a68fd9ec72dea9027583630b42db0791156cb26cc88dcb6
 SHA512:
-  metadata.gz: b9a7ca20453fd54f0342271f1a4173fe3165c0cb53a45e1bbdff5e8379d0c9edd6a7b5135cb960ecb23ec97543d7d4f196290645ca11bafe23bf36c4490099bc
-  data.tar.gz: be574e6033423b730fe3e8a4e5f5c3d9b5167e0e4bfa376645cdee46310ea692a15cb297c82d42894bcd790647d2517d735afc0b630b45d601ba23aed08fa1bf
+  metadata.gz: 416839b0980056003f53c6a9329edd837ffb7c4ce0e01cd8a5580a9e19fcb142c76a14dd77b082fbc6741167fe92a62f166902d77fae1b46710c2089d93871fc
+  data.tar.gz: 9b056e3bde0d308e524b526b597d32e0289c3ad3594f5f070479b80ad782d7905f31eac1b25a6833c1a9079f892eedf761dda0d0ad3cef8b3d4a07b6fca34337

data/README.md

@@ -30,7 +30,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

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.1
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2024-05-13 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
@@ -51,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: An abstract layer of the functionalities provided by apimatic-core, faraday-client-adapter