vitable-connect 0.6.0 → 2.0.0

data/lib/vitable_connect/internal/type/converter.rb

@@ -1,327 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Internal
-    module Type
-      # @api private
-      module Converter
-        extend VitableConnect::Internal::Util::SorbetRuntimeSupport
-
-        # rubocop:disable Lint/UnusedMethodArgument
-
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Object]
-        def coerce(value, state:) = (raise NotImplementedError)
-
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :can_retry
-        #
-        # @return [Object]
-        def dump(value, state:)
-          case value
-          in Array
-            value.map { VitableConnect::Internal::Type::Unknown.dump(_1, state: state) }
-          in Hash
-            value.transform_values { VitableConnect::Internal::Type::Unknown.dump(_1, state: state) }
-          in VitableConnect::Internal::Type::BaseModel
-            value.class.dump(value, state: state)
-          in StringIO
-            value.string
-          in Pathname | IO
-            state[:can_retry] = false if value.is_a?(IO)
-            VitableConnect::FilePart.new(value)
-          in VitableConnect::FilePart
-            state[:can_retry] = false if value.content.is_a?(IO)
-            value
-          else
-            value
-          end
-        end
-
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
-        def inspect(depth: 0)
-          super()
-        end
-
-        # rubocop:enable Lint/UnusedMethodArgument
-
-        class << self
-          # @api private
-          #
-          # @param spec [Hash{Symbol=>Object}, Proc, VitableConnect::Internal::Type::Converter, Class] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
-          #
-          # @return [Proc]
-          def type_info(spec)
-            case spec
-            in Proc
-              spec
-            in Hash
-              type_info(spec.slice(:const, :enum, :union).first&.last)
-            in true | false
-              -> { VitableConnect::Internal::Type::Boolean }
-            in VitableConnect::Internal::Type::Converter | Class | Symbol
-              -> { spec }
-            in NilClass | Integer | Float
-              -> { spec.class }
-            end
-          end
-
-          # @api private
-          #
-          # @param type_info [Hash{Symbol=>Object}, Proc, VitableConnect::Internal::Type::Converter, Class] .
-          #
-          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option type_info [Proc] :enum
-          #
-          #   @option type_info [Proc] :union
-          #
-          #   @option type_info [Boolean] :"nil?"
-          #
-          # @param spec [Hash{Symbol=>Object}, Proc, VitableConnect::Internal::Type::Converter, Class] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
-          #
-          # @return [Hash{Symbol=>Object}]
-          def meta_info(type_info, spec)
-            [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
-          end
-
-          # @api private
-          #
-          # @param translate_names [Boolean]
-          #
-          # @return [Hash{Symbol=>Object}]
-          def new_coerce_state(translate_names: true)
-            {
-              translate_names: translate_names,
-              strictness: true,
-              exactness: {yes: 0, no: 0, maybe: 0},
-              error: nil,
-              branched: 0
-            }
-          end
-
-          # @api private
-          #
-          # Based on `target`, transform `value` into `target`, to the extent possible:
-          #
-          # 1. if the given `value` conforms to `target` already, return the given `value`
-          # 2. if it's possible and safe to convert the given `value` to `target`, then the
-          #    converted value
-          # 3. otherwise, the given `value` unaltered
-          #
-          # The coercion process is subject to improvement between minor release versions.
-          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
-          #
-          # @param target [VitableConnect::Internal::Type::Converter, Class]
-          #
-          # @param value [Object]
-          #
-          # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`. This informs the coercion strategy
-          # when we have to decide between multiple possible conversion targets:
-          #
-          # - `true`: the conversion must be exact, with minimum coercion.
-          # - `false`: the conversion can be approximate, with some coercion.
-          #
-          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          # any given conversion attempt, the exactness will be updated based on how closely
-          # the value recursively matches the target type:
-          #
-          # - `yes`: the value can be converted to the target type with minimum coercion.
-          # - `maybe`: the value can be converted to the target type with some reasonable
-          #   coercion.
-          # - `no`: the value cannot be converted to the target type.
-          #
-          # See implementation below for more details.
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [Object]
-          def coerce(target, value, state: VitableConnect::Internal::Type::Converter.new_coerce_state)
-            # rubocop:disable Metrics/BlockNesting
-            exactness = state.fetch(:exactness)
-
-            case target
-            in VitableConnect::Internal::Type::Converter
-              return target.coerce(value, state: state)
-            in Class
-              if value.is_a?(target)
-                exactness[:yes] += 1
-                return value
-              end
-
-              case target
-              in -> { _1 <= NilClass }
-                exactness[value.nil? ? :yes : :maybe] += 1
-                return nil
-              in -> { _1 <= Integer }
-                case value
-                in Integer
-                  exactness[:yes] += 1
-                  return value
-                else
-                  Kernel.then do
-                    return Integer(value).tap { exactness[:maybe] += 1 }
-                  rescue ArgumentError, TypeError => e
-                    state[:error] = e
-                  end
-                end
-              in -> { _1 <= Float }
-                if value.is_a?(Numeric)
-                  exactness[:yes] += 1
-                  return Float(value)
-                else
-                  Kernel.then do
-                    return Float(value).tap { exactness[:maybe] += 1 }
-                  rescue ArgumentError, TypeError => e
-                    state[:error] = e
-                  end
-                end
-              in -> { _1 <= String }
-                case value
-                in String | Symbol | Numeric
-                  exactness[value.is_a?(Numeric) ? :maybe : :yes] += 1
-                  return value.to_s
-                in StringIO
-                  exactness[:yes] += 1
-                  return value.string
-                else
-                  state[:error] = TypeError.new("#{value.class} can't be coerced into #{String}")
-                end
-              in -> { _1 <= Date || _1 <= Time }
-                Kernel.then do
-                  return target.parse(value).tap { exactness[:yes] += 1 }
-                rescue ArgumentError, TypeError => e
-                  state[:error] = e
-                end
-              in -> { _1 <= StringIO } if value.is_a?(String)
-                exactness[:yes] += 1
-                return StringIO.new(value.b)
-              else
-              end
-            in Symbol
-              case value
-              in Symbol | String
-                if value.to_sym == target
-                  exactness[:yes] += 1
-                  return target
-                else
-                  exactness[:maybe] += 1
-                  return value
-                end
-              else
-                message = "cannot convert non-matching #{value.class} into #{target.inspect}"
-                state[:error] = ArgumentError.new(message)
-              end
-            else
-            end
-
-            exactness[:no] += 1
-            value
-            # rubocop:enable Metrics/BlockNesting
-          end
-
-          # @api private
-          #
-          # @param target [VitableConnect::Internal::Type::Converter, Class]
-          #
-          # @param value [Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :can_retry
-          #
-          # @return [Object]
-          def dump(target, value, state: {can_retry: true})
-            case target
-            in VitableConnect::Internal::Type::Converter
-              target.dump(value, state: state)
-            else
-              VitableConnect::Internal::Type::Unknown.dump(value, state: state)
-            end
-          end
-
-          # @api private
-          #
-          # @param target [Object]
-          # @param depth [Integer]
-          #
-          # @return [String]
-          def inspect(target, depth:)
-            case target
-            in VitableConnect::Internal::Type::Converter
-              target.inspect(depth: depth.succ)
-            else
-              target.inspect
-            end
-          end
-        end
-
-        define_sorbet_constant!(:Input) do
-          T.type_alias { T.any(VitableConnect::Internal::Type::Converter, T::Class[T.anything]) }
-        end
-        define_sorbet_constant!(:CoerceState) do
-          T.type_alias do
-            {
-              translate_names: T::Boolean,
-              strictness: T::Boolean,
-              exactness: {yes: Integer, no: Integer, maybe: Integer},
-              error: T::Class[StandardError],
-              branched: Integer
-            }
-          end
-        end
-        define_sorbet_constant!(:DumpState) do
-          T.type_alias { {can_retry: T::Boolean} }
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/internal/type/enum.rb

@@ -1,156 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Internal
-    module Type
-      # @api private
-      #
-      # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      # values in the SDK as follows:
-      #
-      # 1. boolean => true | false
-      # 2. integer => Integer
-      # 3. float => Float
-      # 4. string => Symbol
-      #
-      # We can therefore convert string values to Symbols, but can't convert other
-      # values safely.
-      #
-      # @example
-      #   # `employee_class` is a `VitableConnect::EmployeeClass`
-      #   case employee_class
-      #   when VitableConnect::EmployeeClass::FULL_TIME
-      #     # ...
-      #   when VitableConnect::EmployeeClass::PART_TIME
-      #     # ...
-      #   when VitableConnect::EmployeeClass::TEMPORARY
-      #     # ...
-      #   else
-      #     puts(employee_class)
-      #   end
-      #
-      # @example
-      #   case employee_class
-      #   in :"Full Time"
-      #     # ...
-      #   in :"Part Time"
-      #     # ...
-      #   in :Temporary
-      #     # ...
-      #   else
-      #     puts(employee_class)
-      #   end
-      module Enum
-        include VitableConnect::Internal::Type::Converter
-        include VitableConnect::Internal::Util::SorbetRuntimeSupport
-
-        # All of the valid Symbol values for this enum.
-        #
-        # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
-        def values = constants.map { const_get(_1) }
-
-        # @api public
-        #
-        # @param other [Object]
-        #
-        # @return [Boolean]
-        def ===(other) = values.include?(other)
-
-        # @api public
-        #
-        # @param other [Object]
-        #
-        # @return [Boolean]
-        def ==(other)
-          # rubocop:disable Style/CaseEquality
-          VitableConnect::Internal::Type::Enum === other && other.values.to_set == values.to_set
-          # rubocop:enable Style/CaseEquality
-        end
-
-        # @api public
-        #
-        # @return [Integer]
-        def hash = values.to_set.hash
-
-        # @api private
-        #
-        # Unlike with primitives, `Enum` additionally validates that the value is a member
-        # of the enum.
-        #
-        # @param value [String, Symbol, Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Symbol, Object]
-        def coerce(value, state:)
-          exactness = state.fetch(:exactness)
-          val = value.is_a?(String) ? value.to_sym : value
-
-          if values.include?(val)
-            exactness[:yes] += 1
-            val
-          elsif values.first&.class == val.class
-            exactness[:maybe] += 1
-            value
-          else
-            exactness[:no] += 1
-            state[:error] = TypeError.new("#{value.class} can't be coerced into #{self}")
-            value
-          end
-        end
-
-        # @!method dump(value, state:)
-        #   @api private
-        #
-        #   @param value [Symbol, Object]
-        #
-        #   @param state [Hash{Symbol=>Object}] .
-        #
-        #     @option state [Boolean] :can_retry
-        #
-        #   @return [Symbol, Object]
-
-        # @api private
-        #
-        # @return [Object]
-        def to_sorbet_type
-          types = values.map { VitableConnect::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
-          case types
-          in []
-            T.noreturn
-          in [type]
-            type
-          else
-            T.any(*types)
-          end
-        end
-
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
-        def inspect(depth: 0)
-          if depth.positive?
-            return is_a?(Module) ? super() : self.class.name
-          end
-
-          members = values.map { VitableConnect::Internal::Type::Converter.inspect(_1, depth: depth.succ) }
-          prefix = is_a?(Module) ? name : self.class.name
-
-          "#{prefix}[#{members.join(' | ')}]"
-        end
-      end
-    end
-  end
-end

data/lib/vitable_connect/internal/type/file_input.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module VitableConnect
-  module Internal
-    module Type
-      # @api private
-      #
-      # @abstract
-      #
-      # Either `Pathname` or `StringIO`, or `IO`, or
-      # `VitableConnect::Internal::Type::FileInput`.
-      #
-      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
-      # not rewindable.
-      class FileInput
-        extend VitableConnect::Internal::Type::Converter
-
-        private_class_method :new
-
-        # @api public
-        #
-        # @param other [Object]
-        #
-        # @return [Boolean]
-        def self.===(other)
-          case other
-          in Pathname | StringIO | IO | String | VitableConnect::FilePart
-            true
-          else
-            false
-          end
-        end
-
-        # @api public
-        #
-        # @param other [Object]
-        #
-        # @return [Boolean]
-        def self.==(other) = other.is_a?(Class) && other <= VitableConnect::Internal::Type::FileInput
-
-        class << self
-          # @api private
-          #
-          # @param value [StringIO, String, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [StringIO, Object]
-          def coerce(value, state:)
-            exactness = state.fetch(:exactness)
-            case value
-            in String
-              exactness[:yes] += 1
-              StringIO.new(value)
-            in StringIO
-              exactness[:yes] += 1
-              value
-            else
-              state[:error] = TypeError.new("#{value.class} can't be coerced into #{StringIO}")
-              exactness[:no] += 1
-              value
-            end
-          end
-
-          # @api private
-          #
-          # @param value [Pathname, StringIO, IO, String, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :can_retry
-          #
-          # @return [Pathname, StringIO, IO, String, Object]
-          def dump(value, state:)
-            case value
-            in StringIO | String
-              # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
-              # while not required, a filename is recommended, and in practice many servers do expect this
-              VitableConnect::FilePart.new(value, filename: "upload")
-            in IO
-              state[:can_retry] = false
-              value.to_path.nil? ? VitableConnect::FilePart.new(value, filename: "upload") : value
-            in VitableConnect::FilePart if value.content.is_a?(IO)
-              state[:can_retry] = false
-              value
-            else
-              value
-            end
-          end
-
-          # @api private
-          #
-          # @return [Object]
-          def to_sorbet_type
-            T.any(Pathname, StringIO, IO, String, VitableConnect::FilePart)
-          end
-        end
-      end
-    end
-  end
-end