apimatic_core 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d29b21091f739c5f0023b01fd70b174a41b6b25637248a02f5be3283874a25eb
-  data.tar.gz: f21de623d02c62af2818602f81657983883d0885187836e609b16ddf890d0d3c
+  metadata.gz: c05d9bcfc3de9b4a1b64bef3e97ddc26be097d03a46c921526a7a0a0ab4ad083
+  data.tar.gz: aa0f7ae505663bc00d919cf4c8a9a661ce0ba2703cfa0aa1a82697aea5913472
 SHA512:
-  metadata.gz: abd28994bd548acfd533bcdd1879d2d8c5ebf67198b97d3172f559d537a1ea9e688c0b5ff076849c4d818d32389814f0b5e42090d11aaf3866de73e626ff1ea6
-  data.tar.gz: 011162e182da68a14d8e820ddf3ca2932f2658afc0e2a15836f042a02d104476888d90c4ce0932f6d47ee8e3df5c5bc23b489bd16bf9f628551ff9183492dcf9
+  metadata.gz: fcfbdbab3adcf1d8c5463a2402e2cfa3253554a72ff4ddfe5625ababf23ff980ac4efb175d6959176bec6bf181f8554ae539181b7c8060c088ceff94c17ec1c7
+  data.tar.gz: 3a22ad6f9424b9a227020fc03f00a0b3d6537a7d3d11d2823d025fc0a4de8eb1b056c9e68af9b312f5809ff4ef6b7997d9921763befada28135962422e2a53f1

data/README.md

@@ -12,7 +12,7 @@ Core library ruby does the job of congregating common and core functionality fro
 
 
 ## Installation
-You will need `2.6 <= Ruby version < 3.1` to support this package.
+You will need `2.6 <= Ruby version <= 3.2` to support this package.
 
 Installation is quite simple, just execute the following command:
 ```
@@ -48,6 +48,14 @@ gem 'apimatic_core'
 |------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
 | [`GlobalConfiguration`](lib/apimatic-core/configurations/global_configuration.rb )             | Class holding the global configuration properties to make a successful API Call |
 
+
+## Exceptions
+| Name                                                                                      | Description                                         |
+|-------------------------------------------------------------------------------------------|-----------------------------------------------------|
+| [`OneOfValidationException`](lib/apimatic-core/exceptions/one_of_validation_exception.rb) | Exception thrown in case of OneOf validation errors |
+| [`AnyOfValidationException`](lib/apimatic-core/exceptions/any_of_validation_exception.rb) | Exception thrown in case of AnyOf validation errors |
+
+
 ## Factories
 | Name                                                                          | Description                              |
 |-------------------------------------------------------------------------------|------------------------------------------|
@@ -67,23 +75,28 @@ gem 'apimatic_core'
 | [`EndpointLogger`](lib/apimatic-core/logger/endpoint_logger.rb)   | A class to provide logging for an API call |
 
 ## Types
-| Name                                                                         | Description                                                                   |
-|------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
-| [`ApiException`](lib/apimatic-core/types/sdk/api_exception.rb)               | Basic exception type for the SDK                                              |
-| [`ValidationException`](lib/apimatic-core/types/sdk/validation_exception.rb) | Exception thrown in case of validation error or failure                       |
-| [`ErrorCase`](lib/apimatic-core/types/error_case.rb)                         | A class to represent Exception types                                          |
-| [`FileWrapper`](lib/apimatic-core/types/sdk/file_wrapper.rb)                 | A wrapper to allow passing in content type for file uploads                   |
-| [`Parameter`](lib/apimatic-core/types/parameter.rb)                          | A class to represent information about a Parameter passed in an endpoint      |
-| [`XmlAttributes`](lib/apimatic-core/types/xml_attributes.rb)                 | A class to represent information about an XML Parameter passed in an endpoint |
+| Name                                                                            | Description                                                                   |
+|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
+| [`ApiException`](lib/apimatic-core/types/sdk/api_exception.rb)                  | Basic exception type for the SDK                                              |
+| [`AnyOf`](lib/apimatic-core/types/union_types/any_of.rb)                        | Represents the AnyOf union type                                               |
+| [`OneOf`](lib/apimatic-core/types/union_types/one_of.rb)                        | Represents the OneOf union type                                               |
+| [`LeafType`](lib/apimatic-core/types/union_types/leaf_type.rb)                  | Represents the LeafOf union type                                              |
+| [`UnionTypeContext`](lib/apimatic-core/types/union_types/union_type_context.rb) | Represents the context for a UnionType                                        |
+| [`ValidationException`](lib/apimatic-core/types/sdk/validation_exception.rb)    | Exception thrown in case of validation error or failure                       |
+| [`ErrorCase`](lib/apimatic-core/types/error_case.rb)                            | A class to represent Exception types                                          |
+| [`FileWrapper`](lib/apimatic-core/types/sdk/file_wrapper.rb)                    | A wrapper to allow passing in content type for file uploads                   |
+| [`Parameter`](lib/apimatic-core/types/parameter.rb)                             | A class to represent information about a Parameter passed in an endpoint      |
+| [`XmlAttributes`](lib/apimatic-core/types/xml_attributes.rb)                    | A class to represent information about an XML Parameter passed in an endpoint |
 
 ## Utilities
-| Name                                                                   | Description                                                                          |
-|------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
-| [`ApiHelper`](lib/apimatic-core/utilities/api_helper.rb)               | A Helper Class with various functions associated with making an API Call             |
-| [`AuthHelper`](lib/apimatic-core/utilities/auth_helper.rb)             | A Helper Class with various functions associated with authentication in API Calls    |
-| [`ComparisonHelper`](lib/apimatic-core/utilities/comparison_helper.rb) | A Helper Class used for the comparison of expected and actual API response           |
-| [`FileHelper`](lib/apimatic-core/utilities/file_helper.rb)             | A Helper Class for files                                                             |
-| [`XmlHelper`](lib/apimatic-core/utilities/xml_helper.rb )              | A Helper class that holds utility methods for xml serialization and deserialization. |
+| Name                                                                   | Description                                                                           |
+|------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
+| [`ApiHelper`](lib/apimatic-core/utilities/api_helper.rb)               | A Helper Class with various functions associated with making an API Call              |
+| [`AuthHelper`](lib/apimatic-core/utilities/auth_helper.rb)             | A Helper Class with various functions associated with authentication in API Calls     |
+| [`UnionTypeHelper`](lib/apimatic-core/utilities/union_type_helper.rb)  | A Helper Class with various functions associated with Union type in API Calls         |
+| [`ComparisonHelper`](lib/apimatic-core/utilities/comparison_helper.rb) | A Helper Class used for the comparison of expected and actual API response            |
+| [`FileHelper`](lib/apimatic-core/utilities/file_helper.rb)             | A Helper Class for files                                                              |
+| [`XmlHelper`](lib/apimatic-core/utilities/xml_helper.rb )              | A Helper class that holds utility methods for xml serialization and deserialization.  |
 
 ## Links
 * [apimatic_core_interfaces](https://rubygems.org/gems/apimatic_core_interfaces)

data/lib/apimatic-core/api_call.rb

@@ -86,7 +86,6 @@ module CoreLibrary
         _deserialized_response = @response_handler.endpoint_logger(@endpoint_logger)
                                                   .endpoint_name_for_logging(@endpoint_name_for_logging)
                                                   .handle(_http_response, @global_configuration.get_global_errors,
-                                                          @global_configuration.get_sdk_module,
                                                           @global_configuration.should_symbolize_hash)
         _deserialized_response
       rescue StandardError => e

data/lib/apimatic-core/configurations/global_configuration.rb

@@ -12,7 +12,6 @@ module CoreLibrary
       @additional_headers = {}
       @auth_managers = {}
       @base_uri_executor = nil
-      @sdk_module = nil
       @symbolize_hash = false
     end
 
@@ -30,19 +29,6 @@ module CoreLibrary
       @global_errors
     end
 
-    # Sets the current SDK module core library is being used for.
-    # @return [GlobalConfiguration] Current Instance.
-    def sdk_module(sdk_module)
-      @sdk_module = sdk_module
-      self
-    end
-
-    # Getter for the current SDK module the core library is being used for.
-    # @return [Module] Current SDK module.
-    def get_sdk_module
-      @sdk_module
-    end
-
     # The setter for the global headers to be attached with all requests.
     # @param [Hash] global_headers The hash of global headers.
     # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.

data/lib/apimatic-core/exceptions/any_of_validation_exception.rb

@@ -0,0 +1,13 @@
+module CoreLibrary
+  # Custom exception class for AnyOfValidation
+  class AnyOfValidationException < StandardError
+    attr_reader :message
+
+    # Initializes a new instance of AnyOfValidationException with the specified message.
+    # @param [String] message The error message.
+    def initialize(message)
+      @message = message
+      super(message)
+    end
+  end
+end

data/lib/apimatic-core/exceptions/one_of_validation_exception.rb

@@ -0,0 +1,13 @@
+module CoreLibrary
+  # Custom exception class for OneOfValidation
+  class OneOfValidationException < StandardError
+    attr_reader :message
+
+    # Initializes a new instance of OneOfValidationException with the specified message.
+    # @param [String] message The error message.
+    def initialize(message)
+      @message = message
+      super(message)
+    end
+  end
+end

data/lib/apimatic-core/request_builder.rb

@@ -14,14 +14,12 @@ module CoreLibrary
       @additional_query_params = {}
       @multipart_params = {}
       @body_param = nil
-      @should_wrap_body_param = nil
       @body_serializer = nil
       @auth = nil
       @array_serialization_format = ArraySerializationFormat::INDEXED
       @xml_attributes = nil
       @endpoint_name_for_logging = nil
       @endpoint_logger = nil
-      @template_validation_array = []
     end
 
     # The setter for the server.
@@ -53,7 +51,6 @@ module CoreLibrary
     # @return [RequestBuilder] An updated instance of RequestBuilder.
     def template_param(template_param)
       template_param.validate
-      conditional_add_to_template_validation_array(template_param)
       @template_params[template_param.get_key] = {  'value' => template_param.get_value,
                                                     'encode' => template_param.need_to_encode }
       self
@@ -64,7 +61,6 @@ module CoreLibrary
     # @return [RequestBuilder] An updated instance of RequestBuilder.
     def header_param(header_param)
       header_param.validate
-      conditional_add_to_template_validation_array(header_param)
       @header_params[header_param.get_key] = header_param.get_value
       self
     end
@@ -74,7 +70,6 @@ module CoreLibrary
     # @return [RequestBuilder] An updated instance of RequestBuilder.
     def query_param(query_param)
       query_param.validate
-      conditional_add_to_template_validation_array(query_param)
       @query_params[query_param.get_key] = query_param.get_value
       self
     end
@@ -84,7 +79,6 @@ module CoreLibrary
     # @return [RequestBuilder] An updated instance of RequestBuilder.
     def form_param(form_param)
       form_param.validate
-      conditional_add_to_template_validation_array(form_param)
       @form_params[form_param.get_key] = form_param.get_value
       self
     end
@@ -110,7 +104,6 @@ module CoreLibrary
     # @return [RequestBuilder] An updated instance of RequestBuilder.
     def multipart_param(multipart_param)
       multipart_param.validate
-      conditional_add_to_template_validation_array(multipart_param)
       @multipart_params[multipart_param.get_key] = get_part(multipart_param)
       self
     end
@@ -120,7 +113,6 @@ module CoreLibrary
     # @return [RequestBuilder] An updated instance of RequestBuilder.
     def body_param(body_param)
       body_param.validate
-      conditional_add_to_template_validation_array(body_param)
       if !body_param.get_key.nil?
         @body_param = {} if @body_param.nil?
         @body_param[body_param.get_key] = body_param.get_value
@@ -184,28 +176,10 @@ module CoreLibrary
       self
     end
 
-    # Add param to the template validation array, in case a template is provided.
-    def conditional_add_to_template_validation_array(parameter)
-      return if parameter.get_template.nil?
-
-      @template_validation_array.push(parameter)
-    end
-
-    # Validates the template for the params provided with a template.
-    def validate_templates
-      return if @template_validation_array.nil? || @template_validation_array.empty?
-
-      @template_validation_array.each do |parameter|
-        parameter.validate_template(@global_configuration.get_sdk_module,
-                                    @global_configuration.should_symbolize_hash)
-      end
-    end
-
     # Builds the Http Request.
     # @param [Hash] endpoint_context The endpoint configuration to be used while executing the request.
     # @return [HttpRequest] An instance of HttpRequest.
     def build(endpoint_context)
-      validate_templates
       _url = process_url
       _request_body = process_body
       _request_headers = process_headers(@global_configuration)

data/lib/apimatic-core/response_handler.rb

@@ -18,7 +18,6 @@ module CoreLibrary
       @is_date_response = false
       @is_response_array = false
       @is_response_void = false
-      @type_group = nil
     end
 
     # Sets deserializer for the response.
@@ -159,22 +158,12 @@ module CoreLibrary
     end
     # rubocop:enable Naming/PredicateName
 
-    # Sets type group for the response.
-    # @param [String] type_group The oneOf/anyOf type group template.
-    # @return [ResponseHandler] An updated instance of ResponseHandler.
-    def type_group(type_group)
-      @type_group = type_group
-      self
-    end
-
     # Main method to handle the response with all the set properties.
     # @param [HttpResponse] response The response received.
     # @param [Hash] global_errors The global errors object.
-    # @param [Module] sdk_module The module of the SDK core library is being used for.
     # @param [Boolean] should_symbolize_hash Flag to symbolize the hash during response deserialization.
     # @return [Object] The deserialized response of the API Call.
-    # rubocop:disable Style/OptionalBooleanParameter
-    def handle(response, global_errors, sdk_module, should_symbolize_hash = false)
+    def handle(response, global_errors, should_symbolize_hash = false)
       @endpoint_logger.info("Validating response for #{@endpoint_name_for_logging}.")
 
       # checking Nullify 404
@@ -189,7 +178,7 @@ module CoreLibrary
       return if @is_response_void
 
       # applying deserializer if configured
-      deserialized_value = apply_deserializer(response, sdk_module, should_symbolize_hash)
+      deserialized_value = apply_deserializer(response, should_symbolize_hash)
 
       # applying api_response if configured
       deserialized_value = apply_api_response(response, deserialized_value)
@@ -199,7 +188,6 @@ module CoreLibrary
 
       deserialized_value
     end
-    # rubocop:enable Style/OptionalBooleanParameter
 
     # Validates the response provided and throws an error against the configured status code.
     # @param [HttpResponse] response The received response.
@@ -224,15 +212,12 @@ module CoreLibrary
     end
 
     # Applies deserializer to the response.
-    # @param sdk_module Module of the SDK using the core library.
     # @param [Boolean] should_symbolize_hash Flag to symbolize the hash during response deserialization.
-    def apply_deserializer(response, sdk_module, should_symbolize_hash)
+    def apply_deserializer(response, should_symbolize_hash)
       return apply_xml_deserializer(response) if @is_xml_response
       return response.raw_body if @deserializer.nil?
 
-      if !@type_group.nil?
-        @deserializer.call(@type_group, response.raw_body, sdk_module, should_symbolize_hash)
-      elsif @datetime_format
+      if @datetime_format
         @deserializer.call(response.raw_body, @datetime_format, @is_response_array, should_symbolize_hash)
       elsif @is_date_response
         @deserializer.call(response.raw_body, @is_response_array, should_symbolize_hash)

data/lib/apimatic-core/types/parameter.rb

@@ -9,7 +9,7 @@ module CoreLibrary
       @should_encode = false
       @default_content_type = nil
       @value_convertor = nil
-      @template = nil
+      @validator = nil
     end
 
     # The setter for the parameter key.
@@ -88,34 +88,23 @@ module CoreLibrary
       @default_content_type
     end
 
-    # Template setter in case of oneOf or anyOf.
-    # @param [String] template Template for the parameter.
-    # @return [Parameter] An updated instance of Parameter.
-    def template(template)
-      @template = template
+    # Setter for the validator.
+    # @param validator [callable] The validator function to be set.
+    # @return [Parameter] An updated instance of the Parameter class.
+    def validator(validator)
+      @validator = validator
       self
     end
 
-    # Template getter in case a template is set.
-    # @return [Parameter] Returns template for the parameter.
-    def get_template
-      @template
-    end
-
     # Validates the parameter value to be sent in the request.
-    # @raise [ValueError] The value error if the parameter is required but the value is nil.
+    # @raise [ArgumentError] If the parameter is required but the value is nil.
     def validate
       raise ArgumentError, "Required parameter #{@key} cannot be nil." if @is_required && @value.nil?
-    end
 
-    # Validates the oneOf/anyOf parameter value to be sent in the request.
-    # @param [Module] sdk_module The module configured by the SDK.
-    # @param [Boolean] should_symbolize_hash Whether to symbolize the hash during the deserialization of the value.
-    # @raise [ValidationException] The validation error if value violates the oneOf/anyOf constraints.
-    # rubocop:disable Style/OptionalBooleanParameter
-    def validate_template(sdk_module, should_symbolize_hash = false)
-      ApiHelper.validate_types(@value, @template, sdk_module, should_symbolize_hash) unless @value.nil?
+      return if @validator.nil?
+
+      validated_type = @validator.call(@value)
+      @value_convertor = proc { |value| validated_type.serialize(value) } if validated_type.is_valid
     end
-    # rubocop:enable Style/OptionalBooleanParameter
   end
 end

data/lib/apimatic-core/types/union_types/any_of.rb

@@ -0,0 +1,90 @@
+module CoreLibrary
+  # Represents the AnyOf union type in the core library
+  class AnyOf < UnionType
+    # Initializes a new instance of AnyOf
+    # @param union_types [Array] The array of nested union types
+    # @param union_type_context [UnionTypeContext] The context for the union type
+    def initialize(union_types, union_type_context = UnionTypeContext.new)
+      super(union_types, union_type_context)
+      @collection_cases = nil
+    end
+
+    # Validates a value against the AnyOf union type
+    # @param value [Object] The value to validate
+    # @return [AnyOf] The validated AnyOf object
+    def validate(value)
+      context = @union_type_context
+      UnionTypeHelper.update_nested_flag_for_union_types(union_types)
+      is_optional_or_nullable = UnionTypeHelper.optional_or_nullable_case?(
+        context,
+        @union_types.map(&:union_type_context)
+      )
+
+      if value.nil? && is_optional_or_nullable
+        @is_valid = true
+        return self
+      end
+
+      if value.nil?
+        @is_valid = false
+        @error_messages = UnionTypeHelper.process_errors(value, @union_types, @error_messages,
+                                                         union_type_context.is_nested, false)
+      end
+
+      validate_value_against_case(value, context)
+
+      unless @is_valid
+        @error_messages = UnionTypeHelper.process_errors(value, @union_types, @error_messages,
+                                                         union_type_context.is_nested, false)
+      end
+
+      self
+    end
+
+    # Serializes a given value.
+    # @param value [Object] The value to be serialized.
+    # @return [Object, nil] The serialized representation of the value, or nil if the value is nil.
+    def serialize(value)
+      return nil if value.nil?
+
+      UnionTypeHelper.serialize_value(
+        value,
+        @union_type_context,
+        @collection_cases,
+        @union_types
+      )
+    end
+
+    # Deserializes a value based on the AnyOf union type
+    # @param value [Object] The value to deserialize
+    # @param should_symbolize [Boolean] Indicates whether the deserialized value should be symbolized.
+    # @return [Object, nil] The deserialized value, or nil if the input value is nil
+    def deserialize(value, should_symbolize: false)
+      return nil if value.nil?
+
+      UnionTypeHelper.deserialize_value(value, @union_type_context, @collection_cases,
+                                        @union_types, should_symbolize: should_symbolize)
+    end
+
+    private
+
+    # Validates a value against the appropriate case of the AnyOf union type
+    # @param value [Object] The value to validate
+    # @param context [UnionTypeContext] The context for the union type
+    def validate_value_against_case(value, context)
+      if context.is_array && context.is_dict && context.is_array_of_dict
+        @is_valid, @collection_cases = UnionTypeHelper.validate_array_of_dict_case(@union_types, value,
+                                                                                   false)
+      elsif context.is_array && context.is_dict
+        @is_valid, @collection_cases = UnionTypeHelper.validate_dict_of_array_case(@union_types, value,
+                                                                                   false)
+      elsif context.is_array
+        @is_valid, @collection_cases = UnionTypeHelper.validate_array_case(@union_types, value, false)
+      elsif context.is_dict
+        @is_valid, @collection_cases = UnionTypeHelper.validate_dict_case(@union_types, value, false)
+      else
+        @is_valid = UnionTypeHelper.get_matched_count(value, @union_types, false) >= 1
+      end
+    end
+  end
+end