apimatic_core_interfaces 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e066016582514a809448dcd2268022b4a9876641ef77dfd5ae88915bd605a0
-  data.tar.gz: fc00d445cfd4e983cf3fecd034834bbac9ec649c10e18d7f245501959baa6446
+  metadata.gz: aaf47cc9c42b3a20af7fa3b74bdabd33852f43d29e7f2fe426ee17f51fb0ff42
+  data.tar.gz: 4d9200846000fa6492e05d04d4dbc51b27ff7a3e077b583f96af5e9d89c8a420
 SHA512:
-  metadata.gz: a1d9b6e320aa1b921f1018a5017595476574977fdb34233db073c64f1a6e8107b9ea8b3a8b961cfbc89b5223e419e7b0645d14d8ec1e57367d26dd0e1bd5480b
-  data.tar.gz: ae062e11518bc9a72b0374f52556af263e3b5e32419cd0a6ab18519ee1a2fc5aa81a1de8bcbad308ffaf6e4ab53b4571f7872407cd123bbc4deb9bc67a2e575e
+  metadata.gz: b9a7ca20453fd54f0342271f1a4173fe3165c0cb53a45e1bbdff5e8379d0c9edd6a7b5135cb960ecb23ec97543d7d4f196290645ca11bafe23bf36c4490099bc
+  data.tar.gz: be574e6033423b730fe3e8a4e5f5c3d9b5167e0e4bfa376645cdee46310ea692a15cb297c82d42894bcd790647d2517d735afc0b630b45d601ba23aed08fa1bf

data/README.md

@@ -24,12 +24,13 @@ 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 |
+| [`ClientConfiguration`](lib/apimatic-core-interfaces/client/client_configuration.rb) | To setup the http client configurations including retries, timeouts and connections etc.          |
 
 
 ## Enumerations

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

@@ -4,6 +4,7 @@ require_relative 'apimatic-core-interfaces/client/client_configuration'
 require_relative 'apimatic-core-interfaces/factories/response_factory'
 
 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.0
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-07-04 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
@@ -30,6 +30,7 @@ files:
 - 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: