apimatic_core 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43a0787b023f7ffa1b7c2a85955b951607f73678560cd1ae5ed5093a98e39787
-  data.tar.gz: 6753fbba0aeb9f496c4a926a226b55fe6aa6245b836ac027fd86d0b9cb295a12
+  metadata.gz: d29b21091f739c5f0023b01fd70b174a41b6b25637248a02f5be3283874a25eb
+  data.tar.gz: f21de623d02c62af2818602f81657983883d0885187836e609b16ddf890d0d3c
 SHA512:
-  metadata.gz: a3d9f9fe3b80a7980b632ac2a6b3fa34780aec0e94cefc7f8f0f1a4a632e99e0da7b2d66cf48f279356cee3486c4595e1ebe48764afcaa7344562732a91ea7f2
-  data.tar.gz: 125c4d4c4dadcd5c069b78eed5b703493e46e666575d1e926acb0e7a4b62099627ed97d8703b502e5e2d476edbf14e34f4438b4733198e00ca5b13a8378cbbf6
+  metadata.gz: abd28994bd548acfd533bcdd1879d2d8c5ebf67198b97d3172f559d537a1ea9e688c0b5ff076849c4d818d32389814f0b5e42090d11aaf3866de73e626ff1ea6
+  data.tar.gz: 011162e182da68a14d8e820ddf3ca2932f2658afc0e2a15836f042a02d104476888d90c4ce0932f6d47ee8e3df5c5bc23b489bd16bf9f628551ff9183492dcf9

data/LICENSE

@@ -1,26 +1,21 @@
-APIMATIC REFERENCE SOURCE LICENSE
-
-This license governs the use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.
-
-1. Definitions
-The terms "reproduce," "reproduction" and "distribution" have the same meaning here as under U.S. copyright law.
-
-"You" means the licensee of the software.
-
-"Your company" means the company you worked for when you downloaded the software.
-
-"Reference use" means the use of the software within your company as a reference, in read-only form, for the sole purposes of debugging your products, maintaining your products, or enhancing the interoperability of your products with the software, and specifically excludes the right to distribute the software outside of your company.
-
-"Licensed patents" means any Licensor patent claims which read directly on the software as distributed by the Licensor under this license.
-
-2. Grant of Rights
-(A) Copyright Grant- Subject to the terms of this license, the Licensor grants you a non-transferable, non-exclusive, worldwide, royalty-free copyright license to reproduce the software for reference use.
-
-(B) Patent Grant- Subject to the terms of this license, the Licensor grants you a non-transferable, non-exclusive, worldwide, royalty-free patent license under licensed patents for reference use.
-
-3. Limitations
-(A) No Trademark License- This license does not grant you any rights to use the Licensor's name, logo, or trademarks.
-
-(B) If you begin patent litigation against the Licensor over patents that you think may apply to the software (including a cross-claim or counterclaim in a lawsuit), your license to the software ends automatically.
-
-(C) The software is licensed "as-is." You bear the risk of using it. The Licensor gives no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the Licensor excludes the implied warranties of merchantability, fitness for a particular purpose and non-infringement.
+MIT License
+
+Copyright (c) 2023 APIMatic Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -95,5 +95,5 @@ gem 'apimatic_core'
 [code-climate-url]: https://codeclimate.com/github/apimatic/core-lib-ruby
 [maintainability-url]: https://api.codeclimate.com/v1/badges/85d658cd4e879f057e7d/maintainability
 [test-coverage-url]: https://api.codeclimate.com/v1/badges/85d658cd4e879f057e7d/test_coverage
-[license-badge]: https://img.shields.io/badge/licence-APIMATIC-blue
+[license-badge]: https://img.shields.io/badge/licence-MIT-blue
 [license-url]: LICENSE

data/lib/apimatic-core/api_call.rb

@@ -7,6 +7,9 @@ module CoreLibrary
       ApiCall.new(@global_configuration, logger: @endpoint_logger.logger)
     end
 
+    # Initializes a new instance of ApiCall.
+    # @param [GlobalConfiguration] global_configuration An instance of GlobalConfiguration.
+    # @param logger An optional logger to log execution of program.
     def initialize(global_configuration, logger: nil)
       @global_configuration = global_configuration
       @request_builder = RequestBuilder.new

data/lib/apimatic-core/authentication/header_auth.rb

@@ -1,6 +1,8 @@
 module CoreLibrary
   # This class is responsible for adding authentication in request header parameter.
   class HeaderAuth < Authentication
+    # Initializes a new instance of HeaderAuth.
+    # @param [Hash] auth_params Auth params for header auth.
     def initialize(auth_params)
       @auth_params = auth_params
       @error_message = nil

data/lib/apimatic-core/authentication/multiple/and_auth_group.rb

@@ -7,6 +7,8 @@ module CoreLibrary
       @error_messages.join(' and ')
     end
 
+    # Initializes a new instance of And.
+    # @param [String | AuthGroup] auth_group AuthGroup instance or string.
     def initialize(*auth_group)
       super auth_group
       @is_valid_group = true

data/lib/apimatic-core/authentication/multiple/auth_group.rb

@@ -4,6 +4,8 @@ module CoreLibrary
   class AuthGroup < Authentication
     attr_accessor :auth_participants, :mapped_group, :error_messages, :is_valid_group
 
+    # Initializes a new instance of AuthGroup.
+    # @param [String | AuthGroup] auth_group AuthGroup instance or string.
     def initialize(auth_group)
       @auth_participants = []
       auth_group.each do |auth_participant|

data/lib/apimatic-core/authentication/multiple/or_auth_group.rb

@@ -7,6 +7,8 @@ module CoreLibrary
       @error_messages.join(' or ')
     end
 
+    # Initializes a new instance of Or.
+    # @param [String | AuthGroup] auth_group AuthGroup instance or string.
     def initialize(*auth_group)
       super auth_group
       @is_valid_group = false

data/lib/apimatic-core/authentication/multiple/single_auth.rb

@@ -7,6 +7,8 @@ module CoreLibrary
       "[#{@error_message}]"
     end
 
+    # Initializes a new instance of Single.
+    # @param [String] auth_participant Auth participant name.
     def initialize(auth_participant)
       @auth_participant = auth_participant
       @mapped_auth = nil

data/lib/apimatic-core/authentication/query_auth.rb

@@ -1,6 +1,8 @@
 module CoreLibrary
   # This class is responsible for adding authentication in request query parameter.
   class QueryAuth < Authentication
+    # Initializes a new instance of QueryAuth.
+    # @param [Hash] auth_params Auth params for query auth.
     def initialize(auth_params)
       @auth_params = auth_params
       @error_message = nil

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

@@ -3,6 +3,8 @@ module CoreLibrary
   class GlobalConfiguration
     attr_reader :client_configuration
 
+    # Initializes a new instance of GlobalConfiguration.
+    # @param [HttpClientConfiguration] client_configuration Current HttpClientConfiguration.
     def initialize(client_configuration: HttpClientConfiguration.new)
       @client_configuration = client_configuration
       @global_errors = {}
@@ -29,11 +31,14 @@ module CoreLibrary
     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

data/lib/apimatic-core/http/configurations/http_client_configuration.rb

@@ -3,6 +3,19 @@ module CoreLibrary
   class HttpClientConfiguration < ClientConfiguration
     attr_reader :http_client, :http_callback
 
+    # Initializes a new instance of HttpClientConfiguration.
+    # @param connection Connection information
+    # @param adapter Adapter configuration
+    # @param [Integer] timeout Timeout value
+    # @param [Integer] max_retries Max retries values
+    # @param [Integer] retry_interval Retry interval value, in seconds
+    # @param [Integer] backoff_factor Backoff factor
+    # @param [Array] retry_statuses An integer array of http status codes
+    # @param [Hash] retry_methods A string array of methods
+    # @param [Boolean] cache Should cache be enabled
+    # @param [Boolean] verify Should verification be enabled.
+    # @param http_callback A method to be used as http callback
+    # @param [HttpClient] http_client An instance of HttpClient
     def initialize(
       connection: nil, adapter: :net_http_persistent, timeout: 60,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,

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

@@ -3,6 +3,8 @@ module CoreLibrary
   class EndpointLogger
     attr_reader :logger
 
+    # Initializes a new instance of EndpointLogger.
+    # @param logger A logger with methods info, debug and error.
     def initialize(logger)
       @logger = logger
     end

data/lib/apimatic-core/request_builder.rb

@@ -1,6 +1,7 @@
 module CoreLibrary
   # This class is the builder of the http request for an API call.
   class RequestBuilder
+    # Creates an instance of RequestBuilder.
     def initialize
       @server = nil
       @path = nil

data/lib/apimatic-core/response_handler.rb

@@ -1,6 +1,7 @@
 module CoreLibrary
-  # This class is for handling of the http response for an API call.
+  # Creates an instance of ResponseHandler.
   class ResponseHandler
+    # Creates an instance of ResponseHandler.
     def initialize
       @deserializer = nil
       @convertor = nil

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

@@ -1,6 +1,7 @@
 module CoreLibrary
   # This data class represents the expected errors to be handled after the API call.
   class ErrorCase
+    # Initializes a new instance of ErrorCase.
     def initialize
       @error_message = nil
       @error_message_template = nil

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

@@ -1,6 +1,7 @@
 module CoreLibrary
   # This data class represents the parameter to be sent in the request.
   class Parameter
+    # Initializes a new instance of Parameter.
     def initialize
       @key = nil
       @value = nil
@@ -87,12 +88,16 @@ module CoreLibrary
       @default_content_type
     end
 
-    # Template in case of oneOf or anyOf
+    # 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
       self
     end
 
+    # Template getter in case a template is set.
+    # @return [Parameter] Returns template for the parameter.
     def get_template
       @template
     end

data/lib/apimatic-core/types/sdk/file_wrapper.rb

@@ -3,6 +3,9 @@ module CoreLibrary
   class FileWrapper
     attr_reader :content_type, :file
 
+    # Initializes a new instance of FileWrapper.
+    # @param [File] file File to enclose within file wrapper.
+    # @param [String] content_type Content type of file.
     def initialize(file, content_type: 'application/octet-stream')
       @file = file
       @content_type = content_type

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

@@ -1,35 +1,45 @@
 module CoreLibrary
   # The class to hold the configuration for XML parameter in request and response.
   class XmlAttributes
+    # Initializes a new instance of XmlAttributes.
     def initialize
       @value = nil
       @root_element_name = nil
       @array_item_name = nil
     end
 
+    # Value setter for XML parameter.
+    # @return [XmlAttributes] An updated instance of XmlAttributes.
     def value(value)
       @value = value
       self
     end
 
+    # Setter for root_element_name of XmlAttributes.
+    # @return [XmlAttributes] An updated instance of XmlAttributes.
     def root_element_name(root_element_name)
       @root_element_name = root_element_name
       self
     end
 
+    # Setter for array item name in XmlAttributes.
+    # @return [XmlAttributes] An updated instance of XmlAttributes.
     def array_item_name(array_item_name)
       @array_item_name = array_item_name
       self
     end
 
+    # Getter for root element of XmlAttributes.
     def get_root_element_name
       @root_element_name
     end
 
+    # Getter for value of XmlAttributes.
     def get_value
       @value
     end
 
+    # Getter for the set array item name in XmlAttributes.
     def get_array_item_name
       @array_item_name
     end

data/lib/apimatic-core/utilities/comparison_helper.rb

@@ -2,7 +2,7 @@ module CoreLibrary
   # A utility that perform the comparison of the Response body and headers.
   class ComparisonHelper
 
-    # Class method to compare the received headers with the expected headers.
+    # Compares the received headers with the expected headers.
     # @param [Hash] expected_headers A hash of expected headers (keys in lower case).
     # @param [Hash] actual_headers A hash of actual headers.
     # @param [Boolean, optional] allow_extra A flag which determines if we allow extra headers.
@@ -24,7 +24,7 @@ module CoreLibrary
       return true
     end
 
-    # Class method to compare the received body with the expected body.
+    # Compares the received body with the expected body.
     # @param [Dynamic] expected_body The expected body.
     # @param [Dynamic] actual_body The actual body.
     # @param [Boolean, optional] check_values A flag which determines if we check values in dictionaries.

data/lib/apimatic-core/utilities/xml_helper.rb

@@ -4,9 +4,10 @@ module CoreLibrary
   # A utility class for handling xml parsing.
   class XmlHelper
     class << self
-      # Serialized the provided value to XML.
-      # @param root_element_name Root element for the XML provided.
-      # @param value Value to convert to XML.
+      # Serializes the provided value to XML.
+      # @param [String] root_element_name Root element for the XML provided.
+      # @param [String] value Value to convert to XML.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def serialize_to_xml(root_element_name, value, datetime_format: nil)
         doc = Nokogiri::XML::Document.new
         add_as_subelement(doc, doc, root_element_name, value,
@@ -14,10 +15,11 @@ module CoreLibrary
         doc.to_xml
       end
 
-      # Serialized the provided array value to XML.
-      # @param root_element_name Root element for the xml provided.
-      # @param item_name Item name for XML.
+      # Serializes the provided array value to XML.
+      # @param [String] root_element_name Root element for the xml provided.
+      # @param [String] item_name Item name for XML.
       # @param value Value to convert to XML.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def serialize_array_to_xml(root_element_name, item_name, value,
                                  datetime_format: nil)
         doc = Nokogiri::XML::Document.new
@@ -27,8 +29,10 @@ module CoreLibrary
         doc.to_xml
       end
 
-      # Serialized the provided hash to XML.
-      # @param root_element_name Root element for the XML provided.
+      # Serializes the provided hash to XML.
+      # @param [string] root_element_name Root element for the XML provided.
+      # @param [Hash] entries Entries to convert to XML.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def serialize_hash_to_xml(root_element_name, entries,
                                 datetime_format: nil)
         doc = Nokogiri::XML::Document.new
@@ -38,6 +42,10 @@ module CoreLibrary
       end
 
       # Adds the value as an attribute.
+      # @param [REXML::Element] root Root element of the XML to add the attribute to.
+      # @param [string] name Attribute name.
+      # @param [string] value Attribute value.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def add_as_attribute(root, name, value, datetime_format: nil)
         return if value.nil?
 
@@ -47,6 +55,11 @@ module CoreLibrary
       end
 
       # Adds hash as a sub-element.
+      # @param [Nokogiri::XML::Document] doc Document to add the hash to.
+      # @param [REXML::Element] root Root element of the XML to add the attribute to.
+      # @param [string] name Attribute name.
+      # @param [Hash] entries Hash to add as value.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def add_hash_as_subelement(doc, root, name, entries,
                                  datetime_format: nil)
         return if entries.nil?
@@ -61,6 +74,12 @@ module CoreLibrary
       end
 
       # Adds array as a sub-element.
+      # @param [Nokogiri::XML::Document] doc Document to add the hash to.
+      # @param [REXML::Element] root Root element of the XML to add the attribute to.
+      # @param [String] item_name Individual array item names.
+      # @param [Array] items Array of items.
+      # @param [String] wrapping_element_name Main array item name.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def add_array_as_subelement(doc, root, item_name, items,
                                   wrapping_element_name: nil,
                                   datetime_format: nil)
@@ -80,6 +99,11 @@ module CoreLibrary
       end
 
       # Adds as a sub-element.
+      # @param [Nokogiri::XML::Document] doc Document to add the hash to.
+      # @param [REXML::Element] root Root element of the XML to add the attribute to.
+      # @param [String] name Item name.
+      # @param [Array] value Item value.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format The format to convert the date time into.
       def add_as_subelement(doc, root, name, value, datetime_format: nil)
         return if value.nil?
 
@@ -95,8 +119,8 @@ module CoreLibrary
       end
 
       # Converts datetime to string of a specific format.
-      # @param value Value to convert to string.
-      # @param datetime_format Datetime format for the converted string.
+      # @param [DateTime] value Value to convert to string.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
       def datetime_to_s(value, datetime_format)
         case datetime_format
         when 'UnixDateTime'
@@ -109,9 +133,10 @@ module CoreLibrary
       end
 
       # Deserializes XML to a specific class.
-      # @param xml The XML value to deserialize.
-      # @param root_element_name Root element name for the XML provided.
-      # @param clazz The class to convert the XML into.
+      # @param [String] xml The XML value to deserialize.
+      # @param [String] root_element_name Root element name for the XML provided.
+      # @param [Class] clazz The class to convert the XML into.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
       def deserialize_xml(xml, root_element_name, clazz, datetime_format = nil)
         doc = Nokogiri::XML::Document.parse xml
         from_element(doc, root_element_name, clazz,
@@ -119,10 +144,10 @@ module CoreLibrary
       end
 
       # Deserializes XML to an array of a specific class.
-      # @param xml The XML value to deserialize.
-      # @param root_element_name Root element name for the XML provided.
-      # @param item_name Item name for XML.
-      # @param clazz The class to convert the XML into.
+      # @param [String] xml The XML value to deserialize.
+      # @param [String] root_element_name Root element name for the XML provided.
+      # @param [String] item_name Item name for XML.
+      # @param [Class] clazz The class to convert the XML into.
       def deserialize_xml_to_array(xml, root_element_name, item_name, clazz,
                                    datetime_format = nil)
         doc = Nokogiri::XML::Document.parse xml
@@ -132,8 +157,10 @@ module CoreLibrary
       end
 
       # Deserializes XML to an array of a specific class.
-      # @param xml The XML value to deserialize.
-      # @param root_element_name Root element name for the XML provided.
+      # @param [String] xml The XML value to deserialize.
+      # @param [String] root_element_name Root element name for the XML provided.
+      # @param [Class] clazz The class to convert the XML into.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
       def deserialize_xml_to_hash(xml, root_element_name, clazz,
                                   datetime_format = nil)
         doc = Nokogiri::XML::Document.parse xml
@@ -142,6 +169,10 @@ module CoreLibrary
       end
 
       # Converts attribute to a specific class.
+      # @param [String] parent Parent XML.
+      # @param [String] name Attribute name.
+      # @param [Class] clazz Attribute class.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
       def from_attribute(parent, name, clazz, datetime_format: nil)
         attribute = parent[name]
         return nil if attribute.nil?
@@ -150,6 +181,10 @@ module CoreLibrary
       end
 
       # Converts element to a specific class.
+      # @param [String] parent Parent XML.
+      # @param [String] name Attribute name.
+      # @param [Class] clazz Attribute class.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
       def from_element(parent, name, clazz, datetime_format: nil)
         element = parent.at_xpath(name)
         return nil if element.nil?
@@ -159,6 +194,11 @@ module CoreLibrary
       end
 
       # Converts element to an array.
+      # @param [String] parent Parent XML.
+      # @param [String] item_name Element name.
+      # @param [Class] clazz Element class.
+      # @param [String] wrapping_element_name Main element name.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
       def from_element_to_array(parent, item_name, clazz,
                                 wrapping_element_name: nil,
                                 datetime_format: nil)
@@ -182,6 +222,11 @@ module CoreLibrary
       end
 
       # Converts element to hash.
+      # @param [Nokogiri::XML::Document] parent Parent document.
+      # @param [String] name Element name.
+      # @param [Class] clazz Hash class to convert to.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion.
+      # @return [Object] Converted value.
       def from_element_to_hash(parent, name, clazz,
                                datetime_format: nil)
         entries = parent.at_xpath(name)
@@ -197,6 +242,10 @@ module CoreLibrary
       end
 
       # Basic convert method.
+      # @param [String] value Value to convert type of.
+      # @param [Class] clazz Type to convert into.
+      # @param [CoreLibrary::DateTimeFormat] datetime_format Datetime format to use for conversion..
+      # @return [Object] Converted value.
       def convert(value, clazz, datetime_format)
         if clazz == DateTime
           return DateTime.rfc3339(value) if datetime_format == 'RFC3339DateTime'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apimatic_core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -204,7 +204,7 @@ files:
 - lib/apimatic_core.rb
 homepage: https://apimatic.io
 licenses:
-- APIMATIC REFERENCE SOURCE LICENSE
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: A library that contains apimatic-apimatic-core logic and utilities for consuming