orb-billing 0.1.0.pre.alpha.36 → 0.1.0.pre.alpha.37

data/lib/orb/type/converter.rb

@@ -1,217 +0,0 @@
-# frozen_string_literal: true
-
-module Orb
-  module Type
-    # rubocop:disable Metrics/ModuleLength
-    # @api private
-    module Converter
-      # rubocop:disable Lint/UnusedMethodArgument
-
-      # @api private
-      #
-      # @param value [Object]
-      #
-      # @param state [Hash{Symbol=>Object}] .
-      #
-      #   @option state [Boolean, :strong] :strictness
-      #
-      #   @option state [Hash{Symbol=>Object}] :exactness
-      #
-      #   @option state [Integer] :branched
-      #
-      # @return [Object]
-      def coerce(value, state:) = (raise NotImplementedError)
-
-      # @api private
-      #
-      # @param value [Object]
-      #
-      # @return [Object]
-      def dump(value)
-        case value
-        in Array
-          value.map { Orb::Unknown.dump(_1) }
-        in Hash
-          value.transform_values { Orb::Unknown.dump(_1) }
-        in Orb::BaseModel
-          value.class.dump(value)
-        else
-          value
-        end
-      end
-
-      # rubocop:enable Lint/UnusedMethodArgument
-
-      class << self
-        # @api private
-        #
-        # @param spec [Hash{Symbol=>Object}, Proc, Orb::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
-            -> { Orb::BooleanModel }
-          in Orb::Type::Converter | Class | Symbol
-            -> { spec }
-          in NilClass | Integer | Float
-            -> { spec.class }
-          end
-        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 [Orb::Type::Converter, Class]
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`, or `:strong`. 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.
-        #   - `:strong`: the conversion must be exact, with no coercion, and raise an error
-        #     if not possible.
-        #
-        #   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, :strong] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Object]
-        def coerce(
-          target,
-          value,
-          state: {strictness: true, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0}
-        )
-          # rubocop:disable Lint/SuppressedException
-          # rubocop:disable Metrics/BlockNesting
-          strictness, exactness = state.fetch_values(:strictness, :exactness)
-
-          case target
-          in Orb::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 }
-              if value.is_a?(Integer)
-                exactness[:yes] += 1
-                return value
-              elsif strictness == :strong
-                message = "no implicit conversion of #{value.class} into #{target.inspect}"
-                raise TypeError.new(message)
-              else
-                Kernel.then do
-                  return Integer(value).tap { exactness[:maybe] += 1 }
-                rescue ArgumentError, TypeError
-                end
-              end
-            in -> { _1 <= Float }
-              if value.is_a?(Numeric)
-                exactness[:yes] += 1
-                return Float(value)
-              elsif strictness == :strong
-                message = "no implicit conversion of #{value.class} into #{target.inspect}"
-                raise TypeError.new(message)
-              else
-                Kernel.then do
-                  return Float(value).tap { exactness[:maybe] += 1 }
-                rescue ArgumentError, TypeError
-                end
-              end
-            in -> { _1 <= String }
-              case value
-              in String | Symbol | Numeric
-                exactness[value.is_a?(Numeric) ? :maybe : :yes] += 1
-                return value.to_s
-              else
-                if strictness == :strong
-                  message = "no implicit conversion of #{value.class} into #{target.inspect}"
-                  raise TypeError.new(message)
-                end
-              end
-            in -> { _1 <= Date || _1 <= Time }
-              Kernel.then do
-                return target.parse(value).tap { exactness[:yes] += 1 }
-              rescue ArgumentError, TypeError => e
-                raise e if strictness == :strong
-              end
-            in -> { _1 <= IO } if value.is_a?(String)
-              exactness[:yes] += 1
-              return StringIO.new(value.b)
-            else
-            end
-          in Symbol
-            if (value.is_a?(Symbol) || value.is_a?(String)) && value.to_sym == target
-              exactness[:yes] += 1
-              return target
-            elsif strictness == :strong
-              message = "cannot convert non-matching #{value.class} into #{target.inspect}"
-              raise ArgumentError.new(message)
-            end
-          else
-          end
-
-          exactness[:no] += 1
-          value
-          # rubocop:enable Metrics/BlockNesting
-          # rubocop:enable Lint/SuppressedException
-        end
-
-        # @api private
-        #
-        # @param target [Orb::Type::Converter, Class]
-        # @param value [Object]
-        #
-        # @return [Object]
-        def dump(target, value)
-          target.is_a?(Orb::Type::Converter) ? target.dump(value) : Orb::Unknown.dump(value)
-        end
-      end
-    end
-    # rubocop:enable Metrics/ModuleLength
-  end
-end

data/lib/orb/type/enum.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module Orb
-  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
-    #   # `billing_cycle_relative_date` is a `Orb::Models::BillingCycleRelativeDate`
-    #   case billing_cycle_relative_date
-    #   when Orb::Models::BillingCycleRelativeDate::START_OF_TERM
-    #     # ...
-    #   when Orb::Models::BillingCycleRelativeDate::END_OF_TERM
-    #     # ...
-    #   else
-    #     puts(billing_cycle_relative_date)
-    #   end
-    #
-    # @example
-    #   case billing_cycle_relative_date
-    #   in :start_of_term
-    #     # ...
-    #   in :end_of_term
-    #     # ...
-    #   else
-    #     puts(billing_cycle_relative_date)
-    #   end
-    module Enum
-      include Orb::Type::Converter
-
-      # All of the valid Symbol values for this enum.
-      #
-      # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
-      def values = (@values ||= constants.map { const_get(_1) })
-
-      # @api private
-      #
-      # Guard against thread safety issues by instantiating `@values`.
-      private def finalize! = values
-
-      # @param other [Object]
-      #
-      # @return [Boolean]
-      def ===(other) = values.include?(other)
-
-      # @param other [Object]
-      #
-      # @return [Boolean]
-      def ==(other)
-        other.is_a?(Module) && other.singleton_class <= Orb::Enum && other.values.to_set == values.to_set
-      end
-
-      # @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, :strong] :strictness
-      #
-      #   @option state [Hash{Symbol=>Object}] :exactness
-      #
-      #   @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
-        else
-          exactness[values.first&.class == val.class ? :maybe : :no] += 1
-          value
-        end
-      end
-
-      # @!parse
-      #   # @api private
-      #   #
-      #   # @param value [Symbol, Object]
-      #   #
-      #   # @return [Symbol, Object]
-      #   def dump(value) = super
-    end
-  end
-end

data/lib/orb/type/hash_of.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Orb
-  module Type
-    # @api private
-    #
-    # @abstract
-    #
-    # Hash of items of a given type.
-    class HashOf
-      include Orb::Type::Converter
-
-      # @param type_info [Hash{Symbol=>Object}, Proc, Orb::Type::Converter, Class]
-      #
-      # @param spec [Hash{Symbol=>Object}] .
-      #
-      #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-      #
-      #   @option spec [Proc] :enum
-      #
-      #   @option spec [Proc] :union
-      #
-      #   @option spec [Boolean] :"nil?"
-      def self.[](type_info, spec = {}) = new(type_info, spec)
-
-      # @param other [Object]
-      #
-      # @return [Boolean]
-      def ===(other)
-        type = item_type
-        case other
-        in Hash
-          other.all? do |key, val|
-            case [key, val]
-            in [Symbol | String, ^type]
-              true
-            else
-              false
-            end
-          end
-        else
-          false
-        end
-      end
-
-      # @param other [Object]
-      #
-      # @return [Boolean]
-      def ==(other)
-        other.is_a?(Orb::HashOf) && other.nilable? == nilable? && other.item_type == item_type
-      end
-
-      # @api private
-      #
-      # @param value [Hash{Object=>Object}, Object]
-      #
-      # @param state [Hash{Symbol=>Object}] .
-      #
-      #   @option state [Boolean, :strong] :strictness
-      #
-      #   @option state [Hash{Symbol=>Object}] :exactness
-      #
-      #   @option state [Integer] :branched
-      #
-      # @return [Hash{Symbol=>Object}, Object]
-      def coerce(value, state:)
-        exactness = state.fetch(:exactness)
-
-        unless value.is_a?(Hash)
-          exactness[:no] += 1
-          return value
-        end
-
-        target = item_type
-        exactness[:yes] += 1
-        value
-          .to_h do |key, val|
-            k = key.is_a?(String) ? key.to_sym : key
-            v =
-              case [nilable?, val]
-              in [true, nil]
-                exactness[:yes] += 1
-                nil
-              else
-                Orb::Type::Converter.coerce(target, val, state: state)
-              end
-
-            exactness[:no] += 1 unless k.is_a?(Symbol)
-            [k, v]
-          end
-      end
-
-      # @api private
-      #
-      # @param value [Hash{Object=>Object}, Object]
-      #
-      # @return [Hash{Symbol=>Object}, Object]
-      def dump(value)
-        target = item_type
-        value.is_a?(Hash) ? value.transform_values { Orb::Type::Converter.dump(target, _1) } : super
-      end
-
-      # @api private
-      #
-      # @return [Orb::Type::Converter, Class]
-      protected def item_type = @item_type_fn.call
-
-      # @api private
-      #
-      # @return [Boolean]
-      protected def nilable? = @nilable
-
-      # @api private
-      #
-      # @param type_info [Hash{Symbol=>Object}, Proc, Orb::Type::Converter, Class]
-      #
-      # @param spec [Hash{Symbol=>Object}] .
-      #
-      #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-      #
-      #   @option spec [Proc] :enum
-      #
-      #   @option spec [Proc] :union
-      #
-      #   @option spec [Boolean] :"nil?"
-      def initialize(type_info, spec = {})
-        @item_type_fn = Orb::Type::Converter.type_info(type_info || spec)
-        @nilable = spec[:nil?]
-      end
-    end
-  end
-end

data/lib/orb/type/request_parameters.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Orb
-  module Type
-    # @api private
-    module RequestParameters
-      # @!parse
-      #   # Options to specify HTTP behaviour for this request.
-      #   # @return [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   attr_accessor :request_options
-
-      # @param mod [Module]
-      def self.included(mod)
-        return unless mod <= Orb::BaseModel
-
-        mod.extend(Orb::Type::RequestParameters::Converter)
-        mod.optional(:request_options, Orb::RequestOptions)
-      end
-
-      # @api private
-      module Converter
-        # @api private
-        #
-        # @param params [Object]
-        #
-        # @return [Array(Object, Hash{Symbol=>Object})]
-        def dump_request(params)
-          case (dumped = dump(params))
-          in Hash
-            [dumped.except(:request_options), dumped[:request_options]]
-          else
-            [dumped, nil]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/orb/type/union.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-module Orb
-  module Type
-    # @api private
-    #
-    # @example
-    #   # `discount` is a `Orb::Models::Discount`
-    #   case discount
-    #   when Orb::Models::PercentageDiscount
-    #     puts(discount.applies_to_price_ids)
-    #   when Orb::Models::TrialDiscount
-    #     puts(discount.discount_type)
-    #   when Orb::Models::UsageDiscount
-    #     puts(discount.usage_discount)
-    #   else
-    #     puts(discount)
-    #   end
-    #
-    # @example
-    #   case discount
-    #   in {
-    #     discount_type: :percentage,
-    #     applies_to_price_ids: applies_to_price_ids,
-    #     percentage_discount: percentage_discount,
-    #     reason: reason
-    #   }
-    #     puts(applies_to_price_ids)
-    #   in {
-    #     discount_type: :trial,
-    #     applies_to_price_ids: applies_to_price_ids,
-    #     reason: reason,
-    #     trial_amount_discount: trial_amount_discount
-    #   }
-    #     puts(reason)
-    #   in {
-    #     discount_type: :usage,
-    #     applies_to_price_ids: applies_to_price_ids,
-    #     usage_discount: usage_discount,
-    #     reason: reason
-    #   }
-    #     puts(usage_discount)
-    #   else
-    #     puts(discount)
-    #   end
-    module Union
-      include Orb::Type::Converter
-
-      # @api private
-      #
-      # All of the specified variant info for this union.
-      #
-      # @return [Array<Array(Symbol, Proc)>]
-      private def known_variants = (@known_variants ||= [])
-
-      # @api private
-      #
-      # @return [Array<Array(Symbol, Object)>]
-      protected def derefed_variants
-        @known_variants.map { |key, variant_fn| [key, variant_fn.call] }
-      end
-
-      # All of the specified variants for this union.
-      #
-      # @return [Array<Object>]
-      def variants = derefed_variants.map(&:last)
-
-      # @api private
-      #
-      # @param property [Symbol]
-      private def discriminator(property)
-        case property
-        in Symbol
-          @discriminator = property
-        end
-      end
-
-      # @api private
-      #
-      # @param key [Symbol, Hash{Symbol=>Object}, Proc, Orb::Type::Converter, Class]
-      #
-      # @param spec [Hash{Symbol=>Object}, Proc, Orb::Type::Converter, Class] .
-      #
-      #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-      #
-      #   @option spec [Proc] :enum
-      #
-      #   @option spec [Proc] :union
-      #
-      #   @option spec [Boolean] :"nil?"
-      private def variant(key, spec = nil)
-        variant_info =
-          case key
-          in Symbol
-            [key, Orb::Type::Converter.type_info(spec)]
-          in Proc | Orb::Type::Converter | Class | Hash
-            [nil, Orb::Type::Converter.type_info(key)]
-          end
-
-        known_variants << variant_info
-      end
-
-      # @api private
-      #
-      # @param value [Object]
-      #
-      # @return [Orb::Type::Converter, Class, nil]
-      private def resolve_variant(value)
-        case [@discriminator, value]
-        in [_, Orb::BaseModel]
-          value.class
-        in [Symbol, Hash]
-          key = value.fetch(@discriminator) do
-            value.fetch(@discriminator.to_s, Orb::Util::OMIT)
-          end
-
-          return nil if key == Orb::Util::OMIT
-
-          key = key.to_sym if key.is_a?(String)
-          known_variants.find { |k,| k == key }&.last&.call
-        else
-          nil
-        end
-      end
-
-      # rubocop:disable Style/HashEachMethods
-      # rubocop:disable Style/CaseEquality
-
-      # @param other [Object]
-      #
-      # @return [Boolean]
-      def ===(other)
-        known_variants.any? do |_, variant_fn|
-          variant_fn.call === other
-        end
-      end
-
-      # @param other [Object]
-      #
-      # @return [Boolean]
-      def ==(other)
-        # rubocop:disable Layout/LineLength
-        other.is_a?(Module) && other.singleton_class <= Orb::Union && other.derefed_variants == derefed_variants
-        # rubocop:enable Layout/LineLength
-      end
-
-      # @api private
-      #
-      # @param value [Object]
-      #
-      # @param state [Hash{Symbol=>Object}] .
-      #
-      #   @option state [Boolean, :strong] :strictness
-      #
-      #   @option state [Hash{Symbol=>Object}] :exactness
-      #
-      #   @option state [Integer] :branched
-      #
-      # @return [Object]
-      def coerce(value, state:)
-        if (target = resolve_variant(value))
-          return Orb::Type::Converter.coerce(target, value, state: state)
-        end
-
-        strictness = state.fetch(:strictness)
-        exactness = state.fetch(:exactness)
-        state[:strictness] = strictness == :strong ? true : strictness
-
-        alternatives = []
-        known_variants.each do |_, variant_fn|
-          target = variant_fn.call
-          exact = state[:exactness] = {yes: 0, no: 0, maybe: 0}
-          state[:branched] += 1
-
-          coerced = Orb::Type::Converter.coerce(target, value, state: state)
-          yes, no, maybe = exact.values
-          if (no + maybe).zero? || (!strictness && yes.positive?)
-            exact.each { exactness[_1] += _2 }
-            state[:exactness] = exactness
-            return coerced
-          elsif maybe.positive?
-            alternatives << [[-yes, -maybe, no], exact, coerced]
-          end
-        end
-
-        case alternatives.sort_by(&:first)
-        in []
-          exactness[:no] += 1
-          if strictness == :strong
-            message = "no possible conversion of #{value.class} into a variant of #{target.inspect}"
-            raise ArgumentError.new(message)
-          end
-          value
-        in [[_, exact, coerced], *]
-          exact.each { exactness[_1] += _2 }
-          coerced
-        end
-          .tap { state[:exactness] = exactness }
-      ensure
-        state[:strictness] = strictness
-      end
-
-      # @api private
-      #
-      # @param value [Object]
-      #
-      # @return [Object]
-      def dump(value)
-        if (target = resolve_variant(value))
-          return Orb::Type::Converter.dump(target, value)
-        end
-
-        known_variants.each do
-          target = _2.call
-          return Orb::Type::Converter.dump(target, value) if target === value
-        end
-
-        super
-      end
-
-      # rubocop:enable Style/CaseEquality
-      # rubocop:enable Style/HashEachMethods
-    end
-  end
-end