apimatic_core 0.1.0

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

@@ -0,0 +1,126 @@
+module CoreLibrary
+  # A utility that supports dateTime conversion to different formats.
+  class DateTimeHelper
+    # Safely converts a DateTime object into a rfc1123 format string.
+    # @param [DateTime] date_time The DateTime object.
+    # @return [String] The rfc1123 formatted datetime string.
+    def self.to_rfc1123(date_time)
+      date_time&.httpdate
+    end
+
+    # Safely converts a map of DateTime objects into a map of rfc1123 format string.
+    # @param [hash] date_time A map of DateTime objects.
+    # @return [hash] A map of rfc1123 formatted datetime string.
+    def self.to_rfc1123_map(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = {}
+      date_time.each do |k, v|
+        hash[key][k] =
+          v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
+      end
+      hash[key]
+    end
+
+    # Safely converts an array of DateTime objects into an array of rfc1123 format string.
+    # @param [Array] date_time An array of DateTime objects.
+    # @return [Array] An array of rfc1123 formatted datetime string.
+    def self.to_rfc1123_array(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = date_time.map do |v|
+        v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
+      end
+    end
+
+    # Safely converts a DateTime object into a unix format string.
+    # @param [DateTime] date_time The DateTime object.
+    # @return [String] The unix formatted datetime string.
+    def self.to_unix(date_time)
+      date_time.to_time.utc.to_i unless date_time.nil?
+    end
+
+    # Safely converts a map of DateTime objects into a map of unix format string.
+    # @param [hash] date_time A map of DateTime objects.
+    # @return [hash] A map of unix formatted datetime string.
+    def self.to_unix_map(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = {}
+      date_time.each do |k, v|
+        hash[key][k] =
+          v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
+      end
+      hash[key]
+    end
+
+    # Safely converts an array of DateTime objects into a map of unix format string.
+    # @param [hash] date_time An array of DateTime objects.
+    # @return [hash] An array of unix formatted datetime string.
+    def self.to_unix_array(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = date_time.map do |v|
+        v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
+      end
+    end
+
+    # Safely converts a DateTime object into a rfc3339 format string.
+    # @param [DateTime] date_time The DateTime object.
+    # @return [String] The rfc3339 formatted datetime string.
+    def self.to_rfc3339(date_time)
+      date_time&.rfc3339
+    end
+
+    # Safely converts a map of DateTime objects into a map of rfc1123 format string.
+    # @param [hash] date_time A map of DateTime objects.
+    # @return [hash] A map of rfc1123 formatted datetime string.
+    def self.to_rfc3339_map(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = {}
+      date_time.each do |k, v|
+        hash[key][k] =
+          v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
+      end
+      hash[key]
+    end
+
+    # Safely converts an array of DateTime objects into an array of rfc1123 format string.
+    # @param [Array] date_time An array of DateTime objects.
+    # @return [Array] An array of rfc1123 formatted datetime string.
+    def self.to_rfc3339_array(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = date_time.map do |v|
+        v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
+      end
+    end
+
+    # Safely converts a rfc1123 format string into a DateTime object.
+    # @param [String] date_time The rfc1123 formatted datetime string.
+    # @return [DateTime] A DateTime object.
+    def self.from_rfc1123(date_time)
+      DateTime.httpdate(date_time)
+    end
+
+    # Safely converts a unix format string into a DateTime object.
+    # @param [String] date_time The unix formatted datetime string.
+    # @return [DateTime] A DateTime object.
+    def self.from_unix(date_time)
+      Time.at(date_time.to_i).utc.to_datetime
+    end
+
+    # Safely converts a rfc3339 format string into a DateTime object.
+    # @param [String] date_time The rfc3339 formatted datetime string.
+    # @return [DateTime] A DateTime object.
+    def self.from_rfc3339(date_time)
+      # missing timezone information
+      if date_time.end_with?('Z') || date_time.index('+')
+        DateTime.rfc3339(date_time)
+      else
+        DateTime.rfc3339("#{date_time}Z")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'tempfile'
+require 'open-uri'
+module CoreLibrary
+  # A utility for file specific operations.
+  class FileHelper
+    @cache = {}
+
+    # Class method which takes a URL, downloads the file (if not already downloaded.
+    # for this test session) and returns the path of the file.
+    # @param [String] url The URL of the required file.
+    def self.get_file(url)
+      unless @cache.keys.include? url
+        @cache[url] = Tempfile.new('APIMatic')
+        @cache[url].binmode
+        @cache[url].write(URI.parse(url).open({ ssl_ca_cert: Certifi.where }).read)
+      end
+      @cache[url].rewind
+      @cache[url].path
+    end
+  end
+end

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

@@ -0,0 +1,215 @@
+require 'nokogiri'
+
+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.
+      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,
+                          datetime_format: datetime_format)
+        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.
+      # @param value Value to convert to XML.
+      def serialize_array_to_xml(root_element_name, item_name, value,
+                                 datetime_format: nil)
+        doc = Nokogiri::XML::Document.new
+        add_array_as_subelement(doc, doc, item_name, value,
+                                wrapping_element_name: root_element_name,
+                                datetime_format: datetime_format)
+        doc.to_xml
+      end
+
+      # Serialized the provided hash to XML.
+      # @param root_element_name Root element for the XML provided.
+      def serialize_hash_to_xml(root_element_name, entries,
+                                datetime_format: nil)
+        doc = Nokogiri::XML::Document.new
+        add_hash_as_subelement(doc, doc, root_element_name, entries,
+                               datetime_format: datetime_format)
+        doc.to_xml
+      end
+
+      # Adds the value as an attribute.
+      def add_as_attribute(root, name, value, datetime_format: nil)
+        return if value.nil?
+
+        value = datetime_to_s(value, datetime_format) if value.instance_of?(DateTime)
+
+        root[name] = value
+      end
+
+      # Adds hash as a sub-element.
+      def add_hash_as_subelement(doc, root, name, entries,
+                                 datetime_format: nil)
+        return if entries.nil?
+
+        parent = doc.create_element(name)
+        root.add_child(parent)
+
+        entries.each do |key, value|
+          add_as_subelement(doc, parent, key, value,
+                            datetime_format: datetime_format)
+        end
+      end
+
+      # Adds array as a sub-element.
+      def add_array_as_subelement(doc, root, item_name, items,
+                                  wrapping_element_name: nil,
+                                  datetime_format: nil)
+        return if items.nil?
+
+        if wrapping_element_name.nil?
+          parent = root
+        else
+          parent = doc.create_element(wrapping_element_name)
+          root.add_child(parent)
+        end
+
+        items.each do |item|
+          add_as_subelement(doc, parent, item_name, item,
+                            datetime_format: datetime_format)
+        end
+      end
+
+      # Adds as a sub-element.
+      def add_as_subelement(doc, root, name, value, datetime_format: nil)
+        return if value.nil?
+
+        value = datetime_to_s(value, datetime_format) if value.instance_of?(DateTime)
+
+        element = if value.respond_to? :to_xml_element
+                    value.to_xml_element(doc, name)
+                  else
+                    doc.create_element(name, value)
+                  end
+
+        root.add_child(element)
+      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.
+      def datetime_to_s(value, datetime_format)
+        case datetime_format
+        when 'UnixDateTime'
+          value.to_time.to_i
+        when 'HttpDateTime'
+          value.httpdate
+        else
+          value
+        end
+      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.
+      def deserialize_xml(xml, root_element_name, clazz, datetime_format = nil)
+        doc = Nokogiri::XML::Document.parse xml
+        from_element(doc, root_element_name, clazz,
+                     datetime_format: datetime_format)
+      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.
+      def deserialize_xml_to_array(xml, root_element_name, item_name, clazz,
+                                   datetime_format = nil)
+        doc = Nokogiri::XML::Document.parse xml
+        from_element_to_array(doc, item_name, clazz,
+                              wrapping_element_name: root_element_name,
+                              datetime_format: datetime_format)
+      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.
+      def deserialize_xml_to_hash(xml, root_element_name, clazz,
+                                  datetime_format = nil)
+        doc = Nokogiri::XML::Document.parse xml
+        from_element_to_hash(doc, root_element_name, clazz,
+                             datetime_format: datetime_format)
+      end
+
+      # Converts attribute to a specific class.
+      def from_attribute(parent, name, clazz, datetime_format: nil)
+        attribute = parent[name]
+        return nil if attribute.nil?
+
+        convert(attribute, clazz, datetime_format)
+      end
+
+      # Converts element to a specific class.
+      def from_element(parent, name, clazz, datetime_format: nil)
+        element = parent.at_xpath(name)
+        return nil if element.nil?
+        return clazz.from_element element if clazz.respond_to? :from_element
+
+        convert(element.text, clazz, datetime_format)
+      end
+
+      # Converts element to an array.
+      def from_element_to_array(parent, item_name, clazz,
+                                wrapping_element_name: nil,
+                                datetime_format: nil)
+        elements = if wrapping_element_name.nil?
+                     parent.xpath(item_name)
+                   elsif parent.at_xpath(wrapping_element_name).nil?
+                     nil
+                   else
+                     parent.at_xpath(wrapping_element_name).xpath(item_name)
+                   end
+
+        return nil if elements.nil?
+
+        if clazz.respond_to? :from_element
+          elements.map { |element| clazz.from_element element }
+        else
+          elements.map do |element|
+            convert(element.text, clazz, datetime_format)
+          end
+        end
+      end
+
+      # Converts element to hash.
+      def from_element_to_hash(parent, name, clazz,
+                               datetime_format: nil)
+        entries = parent.at_xpath(name)
+        return nil if entries.nil? || entries.children.nil?
+
+        hash = {}
+
+        entries.element_children.each do |element|
+          hash[element.name] = convert(element.text, clazz, datetime_format)
+        end
+
+        hash
+      end
+
+      # Basic convert method.
+      def convert(value, clazz, datetime_format)
+        if clazz == DateTime
+          return DateTime.rfc3339(value) if datetime_format == 'RFC3339DateTime'
+          return DateTime.httpdate(value) if datetime_format == 'HttpDateTime'
+          return DateTime.strptime(value, '%s') if datetime_format == 'UnixDateTime'
+        end
+
+        return value.to_f if clazz == Float
+        return value.to_i if clazz == Integer
+        return value.casecmp('true').zero? if clazz == TrueClass
+
+        value
+      end
+    end
+  end
+end

data/lib/apimatic_core.rb

@@ -0,0 +1,44 @@
+require 'date'
+require 'json'
+require 'certifi'
+require 'apimatic_core_interfaces'
+require 'cgi'
+
+require_relative 'apimatic-core/request_builder'
+require_relative 'apimatic-core/response_handler'
+require_relative 'apimatic-core/api_call'
+
+require_relative 'apimatic-core/factories/http_response_factory'
+
+require_relative 'apimatic-core/configurations/global_configuration'
+
+require_relative 'apimatic-core/exceptions/invalid_auth_credential'
+
+require_relative 'apimatic-core/logger/endpoint_logger'
+
+require_relative 'apimatic-core/http/configurations/http_client_configuration'
+require_relative 'apimatic-core/http/request/http_request'
+require_relative 'apimatic-core/http/response/http_response'
+require_relative 'apimatic-core/http/response/api_response'
+
+require_relative 'apimatic-core/types/parameter'
+require_relative 'apimatic-core/types/error_case'
+require_relative 'apimatic-core/types/sdk/base_model'
+require_relative 'apimatic-core/types/sdk/file_wrapper'
+require_relative 'apimatic-core/types/sdk/validation_exception'
+require_relative 'apimatic-core/types/sdk/api_exception'
+require_relative 'apimatic-core/types/xml_attributes'
+
+require_relative 'apimatic-core/utilities/api_helper'
+require_relative 'apimatic-core/utilities/date_time_helper'
+require_relative 'apimatic-core/utilities/comparison_helper'
+require_relative 'apimatic-core/utilities/file_helper'
+require_relative 'apimatic-core/utilities/xml_helper'
+require_relative 'apimatic-core/utilities/auth_helper'
+
+require_relative 'apimatic-core/authentication/header_auth'
+require_relative 'apimatic-core/authentication/query_auth'
+require_relative 'apimatic-core/authentication/multiple/auth_group'
+require_relative 'apimatic-core/authentication/multiple/and_auth_group'
+require_relative 'apimatic-core/authentication/multiple/or_auth_group'
+require_relative 'apimatic-core/authentication/multiple/single_auth'

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: apimatic_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- APIMatic Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.10
+- !ruby/object:Gem::Dependency
+  name: certifi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: The APIMatic Core libraries provide a stable runtime that powers all
+  the functionality of SDKs. This includes functionality like the ability to create
+  HTTP requests, handle responses, apply authentication schemes, convert API responses
+  back to object instances, and validate user and server data.
+email: support@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apimatic-core/api_call.rb
+- lib/apimatic-core/authentication/header_auth.rb
+- lib/apimatic-core/authentication/multiple/and_auth_group.rb
+- lib/apimatic-core/authentication/multiple/auth_group.rb
+- lib/apimatic-core/authentication/multiple/or_auth_group.rb
+- lib/apimatic-core/authentication/multiple/single_auth.rb
+- lib/apimatic-core/authentication/query_auth.rb
+- lib/apimatic-core/configurations/global_configuration.rb
+- lib/apimatic-core/exceptions/invalid_auth_credential.rb
+- lib/apimatic-core/factories/http_response_factory.rb
+- lib/apimatic-core/http/configurations/http_client_configuration.rb
+- lib/apimatic-core/http/request/http_request.rb
+- lib/apimatic-core/http/response/api_response.rb
+- lib/apimatic-core/http/response/http_response.rb
+- lib/apimatic-core/logger/endpoint_logger.rb
+- lib/apimatic-core/request_builder.rb
+- lib/apimatic-core/response_handler.rb
+- lib/apimatic-core/types/error_case.rb
+- lib/apimatic-core/types/parameter.rb
+- lib/apimatic-core/types/sdk/api_exception.rb
+- lib/apimatic-core/types/sdk/base_model.rb
+- lib/apimatic-core/types/sdk/file_wrapper.rb
+- lib/apimatic-core/types/sdk/validation_exception.rb
+- lib/apimatic-core/types/xml_attributes.rb
+- lib/apimatic-core/utilities/api_helper.rb
+- lib/apimatic-core/utilities/auth_helper.rb
+- lib/apimatic-core/utilities/comparison_helper.rb
+- lib/apimatic-core/utilities/date_time_helper.rb
+- lib/apimatic-core/utilities/file_helper.rb
+- lib/apimatic-core/utilities/xml_helper.rb
+- lib/apimatic_core.rb
+homepage: https://apimatic.io
+licenses:
+- APIMATIC REFERENCE SOURCE LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: A library that contains apimatic-apimatic-core logic and utilities for consuming
+  REST APIs using Python SDKs generated by APIMatic.
+test_files: []