apimatic_core_interfaces 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e066016582514a809448dcd2268022b4a9876641ef77dfd5ae88915bd605a0
-  data.tar.gz: fc00d445cfd4e983cf3fecd034834bbac9ec649c10e18d7f245501959baa6446
+  metadata.gz: 01a4e34ebafdba39e2611a2b683cd55dfc9e28d1ba990680b247e82e0258eebb
+  data.tar.gz: 100242792ff4890d5a68fd9ec72dea9027583630b42db0791156cb26cc88dcb6
 SHA512:
-  metadata.gz: a1d9b6e320aa1b921f1018a5017595476574977fdb34233db073c64f1a6e8107b9ea8b3a8b961cfbc89b5223e419e7b0645d14d8ec1e57367d26dd0e1bd5480b
-  data.tar.gz: ae062e11518bc9a72b0374f52556af263e3b5e32419cd0a6ab18519ee1a2fc5aa81a1de8bcbad308ffaf6e4ab53b4571f7872407cd123bbc4deb9bc67a2e575e
+  metadata.gz: 416839b0980056003f53c6a9329edd837ffb7c4ce0e01cd8a5580a9e19fcb142c76a14dd77b082fbc6741167fe92a62f166902d77fae1b46710c2089d93871fc
+  data.tar.gz: 9b056e3bde0d308e524b526b597d32e0289c3ad3594f5f070479b80ad782d7905f31eac1b25a6833c1a9079f892eedf761dda0d0ad3cef8b3d4a07b6fca34337

data/README.md

@@ -24,12 +24,14 @@ gem 'apimatic_core_interfaces'
 ```
 
 ## Interfaces
-| Name                                                                                 | Description                                                                                |
-|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
-| [`HttpClient`](lib/apimatic-core-interfaces/client/http_client.rb)                   | To save both Request and Response after the completion of response                         |
-| [`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  |
-| [`ClientConfiguration`](lib/apimatic-core-interfaces/client/client_configuration.rb) | To setup the http client configurations including retries, timeouts and connections etc.  |
+| Name                                                                                 | Description                                                                                       |
+|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
+| [`HttpClient`](lib/apimatic-core-interfaces/client/http_client.rb)                   | To save both Request and Response after the completion of response                                |
+| [`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 |
+| [`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/types/union_type.rb

@@ -0,0 +1,55 @@
+module CoreLibrary
+  # Represents a union type that can validate, serialize and deserialize values based on a set of allowed types.
+  class UnionType
+    # NATIVE_TYPES represents the list of native types in Ruby.
+    # These types are commonly used and built-in to the Ruby language.
+    # The constant contains the following types:
+    # - Integer: Represents whole numbers without a decimal point.
+    # - String: Represents a sequence of characters.
+    # - Float: Represents floating-point numbers with a decimal point.
+    # - TrueClass: Represents the boolean value `true`.
+    # - FalseClass: Represents the boolean value `false`.
+    # This constant is used within the UnionType class to define the allowed native types.
+    NATIVE_TYPES = [Integer, String, Float, TrueClass, FalseClass].freeze
+
+    attr_accessor :is_valid, :error_messages, :union_type_context, :union_types
+
+    # Initializes a new instance of UnionType.
+    # @param union_types [Array<Class>] An array of allowed types for the union.
+    # @param union_type_context [Object] The context of the union type.
+    def initialize(union_types, union_type_context)
+      @union_types = union_types
+      @union_type_context = union_type_context
+      @is_valid = false
+      @error_messages = Set.new
+    end
+
+    # Validates a value against the union type.
+    # This method should be implemented by subclasses.
+    # @param value [Object] The value to validate.
+    # @raise [NotImplementedError] If the method is not implemented in a subclass.
+    def validate(value)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+
+    # Serializes a given value.
+    # @param value [Object] The value to be serialized.
+    # @raise [NotImplementedError] If the method is not implemented in the child class.
+    # @return [String] The serialized representation of the value.
+    def serialize(value)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+
+    # Deserializes a value based on the union type.
+    # This method should be implemented by subclasses.
+    # @param value [Object] The value to deserialize.
+    # @param should_symbolize [Boolean] Indicates whether the deserialized value should be symbolized.
+    # @raise [NotImplementedError] If the method is not implemented in a subclass.
+    def deserialize(value, should_symbolize: false)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+  end
+end

data/lib/apimatic_core_interfaces.rb

@@ -3,7 +3,11 @@ 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'
 require_relative 'apimatic-core-interfaces/types/http_method'
 require_relative 'apimatic-core-interfaces/types/array_serialization_format'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apimatic_core_interfaces
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-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,11 +25,14 @@ 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
 - lib/apimatic-core-interfaces/types/http_callback.rb
 - lib/apimatic-core-interfaces/types/http_method.rb
+- lib/apimatic-core-interfaces/types/union_type.rb
 - lib/apimatic_core_interfaces.rb
 homepage: https://apimatic.io
 licenses:
@@ -50,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