orb-billing 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 419ff101a6d09de79a68655064cd315df1915451f0d1b395f411f75fd823623a
-  data.tar.gz: 38ef3fa62382d435a88b1d394f7bd28b18cd70d6c9f003ad252e29fa3d1fe53b
+  metadata.gz: 38b3bf74b4e8dd32bd70721c88a432e1700d34742b5435fb1f623124f9d69aae
+  data.tar.gz: 67304b3d1242e85d48a26dd2a108cdac385698fba02c7d6109d850836bb71b91
 SHA512:
-  metadata.gz: 55004f9c82b06ae34185b2ab4a3ba837772129b737ebb84675f0ffc8a42e7648ce07d2cc476f3d4413c3501181ae72be05e8b94527c2d869f24fb36fba3f552b
-  data.tar.gz: b04180071d9065d617e62dc13d4504e132f84ffeda3ecbc2d9b72b5f0c278d37763851a1e35f9d4f75c6c15086a4909715494c72fd2caf3d630fa5c2a1a198b8
+  metadata.gz: 4d6cdb145141d9b8c1cc43175bb784b1b07288414147c0e8c9eaf36a4928e5c13e0f610c8a16282774c42c5706272b52a78babd80e4ae973dc873c47709be06c
+  data.tar.gz: 3fa6dd7dd0f921f286993942bb61621d646c8462110ec2a02628aae0eb8a1db9ff3f1fbefd818b4612c3827eaf240b732989a9be008270830388704d5a6bdd30

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 0.4.0 (2025-05-13)
+
+Full Changelog: [v0.3.2...v0.4.0](https://github.com/orbcorp/orb-ruby/compare/v0.3.2...v0.4.0)
+
+### Features
+
+* expose base client options as read only attributes ([1f638b6](https://github.com/orbcorp/orb-ruby/commit/1f638b60ad1679bc7969f441650ba61fb9a65e8a))
+* expose recursive `#to_h` conversion ([cfd49a1](https://github.com/orbcorp/orb-ruby/commit/cfd49a15d805ffaa5828249c5b91565661ae7e52))
+* support sorbet aliases at the runtime ([786d1e3](https://github.com/orbcorp/orb-ruby/commit/786d1e3dd882054bd298e33a448a194f1d68bac4))
+
+
+### Bug Fixes
+
+* **internal:** update gemspec name ([852ab56](https://github.com/orbcorp/orb-ruby/commit/852ab562ee4948d3fe4de8dd877f9301f36c8a4b))
+
+
+### Chores
+
+* fix misc linting / minor issues ([0e7dd84](https://github.com/orbcorp/orb-ruby/commit/0e7dd846c906cc2e72827f5477a93e4799ab9482))
+* **internal:** version bump ([359839c](https://github.com/orbcorp/orb-ruby/commit/359839c734c4bcf8051490b1e8723674ef634753))
+
+## 0.3.2 (2025-05-07)
+
+Full Changelog: [v0.3.1...v0.3.2](https://github.com/orbcorp/orb-ruby/compare/v0.3.1...v0.3.2)
+
+### Bug Fixes
+
+* **internal:** ensure formatting always uses c.utf-8 locale ([c4cc44a](https://github.com/orbcorp/orb-ruby/commit/c4cc44a8e280089938586de353b08e8091056ca0))
+
+
+### Chores
+
+* **internal:** version bump ([fede0e6](https://github.com/orbcorp/orb-ruby/commit/fede0e64ca4753cc961e8308ddcef2b39dcb6f24))
+* revert ignoring Gemfile.lock ([e572719](https://github.com/orbcorp/orb-ruby/commit/e572719854490cfa7735dcc70d9cfd1dc4d4a122))
+
 ## 0.3.1 (2025-05-06)
 
 Full Changelog: [v0.3.0...v0.3.1](https://github.com/orbcorp/orb-ruby/compare/v0.3.0...v0.3.1)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 0.3.1"
+gem "orb-billing", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->
@@ -200,9 +200,9 @@ Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbe
 Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
 
 ```ruby
-module Orb::Models::BillingCycleRelativeDate
+module Orb::BillingCycleRelativeDate
   # This alias aids language service driven navigation.
-  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillingCycleRelativeDate) }
+  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::BillingCycleRelativeDate) }
 end
 ```
 

data/lib/orb/errors.rb

@@ -99,7 +99,7 @@ module Orb
       # @param response [nil]
       # @param message [String, nil]
       #
-      # @return [Orb::Errors::APIStatusError]
+      # @return [self]
       def self.for(url:, status:, body:, request:, response:, message: nil)
         key = Orb::Internal::Util.dig(body, :type)
         kwargs = {

data/lib/orb/file_part.rb

@@ -45,9 +45,9 @@ module Orb
       @filename =
         case content
         in Pathname
-          filename.nil? ? content.basename.to_path : File.basename(filename)
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
         else
-          filename.nil? ? nil : File.basename(filename)
+          filename.nil? ? nil : ::File.basename(filename)
         end
       @content_type = content_type
     end

data/lib/orb/internal/transport/base_client.rb

@@ -7,6 +7,8 @@ module Orb
       #
       # @abstract
       class BaseClient
+        extend Orb::Internal::Util::SorbetRuntimeSupport
+
         # from whatwg fetch spec
         MAX_REDIRECTS = 20
 
@@ -151,6 +153,27 @@ module Orb
           end
         end
 
+        # @return [URI::Generic]
+        attr_reader :base_url
+
+        # @return [Float]
+        attr_reader :timeout
+
+        # @return [Integer]
+        attr_reader :max_retries
+
+        # @return [Float]
+        attr_reader :initial_retry_delay
+
+        # @return [Float]
+        attr_reader :max_retry_delay
+
+        # @return [Hash{String=>String}]
+        attr_reader :headers
+
+        # @return [String, nil]
+        attr_reader :idempotency_header
+
         # @api private
         # @return [Orb::Internal::Transport::PooledNetRequester]
         attr_reader :requester
@@ -182,10 +205,11 @@ module Orb
             },
             headers
           )
-          @base_url = Orb::Internal::Util.parse_uri(base_url)
+          @base_url_components = Orb::Internal::Util.parse_uri(base_url)
+          @base_url = Orb::Internal::Util.unparse_uri(@base_url_components)
           @idempotency_header = idempotency_header&.to_s&.downcase
-          @max_retries = max_retries
           @timeout = timeout
+          @max_retries = max_retries
           @initial_retry_delay = initial_retry_delay
           @max_retry_delay = max_retry_delay
         end
@@ -276,10 +300,11 @@ module Orb
               Orb::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          url = Orb::Internal::Util.join_parsed_uri(@base_url_components, {**req, path: path, query: query})
           headers, encoded = Orb::Internal::Util.encode_content(headers, body)
           {
             method: method,
-            url: Orb::Internal::Util.join_parsed_uri(@base_url, {**req, path: path, query: query}),
+            url: url,
             headers: headers,
             body: encoded,
             max_retries: opts.fetch(:max_retries, @max_retries),
@@ -473,10 +498,54 @@ module Orb
         # @return [String]
         def inspect
           # rubocop:disable Layout/LineLength
-          base_url = Orb::Internal::Util.unparse_uri(@base_url)
-          "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
+          "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
           # rubocop:enable Layout/LineLength
         end
+
+        define_sorbet_constant!(:RequestComponents) do
+          T.type_alias do
+            {
+              method: Symbol,
+              path: T.any(String, T::Array[String]),
+              query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+              headers: T.nilable(
+                T::Hash[String,
+                        T.nilable(
+                          T.any(
+                            String,
+                            Integer,
+                            T::Array[T.nilable(T.any(String, Integer))]
+                          )
+                        )]
+              ),
+              body: T.nilable(T.anything),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
+              page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
+              stream: T.nilable(T::Class[T.anything]),
+              model: T.nilable(Orb::Internal::Type::Converter::Input),
+              options: T.nilable(Orb::RequestOptions::OrHash)
+            }
+          end
+        end
+        define_sorbet_constant!(:RequestInput) do
+          T.type_alias do
+            {
+              method: Symbol,
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              body: T.anything,
+              max_retries: Integer,
+              timeout: Float
+            }
+          end
+        end
       end
     end
   end

data/lib/orb/internal/transport/pooled_net_requester.rb

@@ -5,6 +5,8 @@ module Orb
     module Transport
       # @api private
       class PooledNetRequester
+        extend Orb::Internal::Util::SorbetRuntimeSupport
+
         # from the golang stdlib
         # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
@@ -187,6 +189,18 @@ module Orb
           @size = size
           @pools = {}
         end
+
+        define_sorbet_constant!(:Request) do
+          T.type_alias do
+            {
+              method: Symbol,
+              url: URI::Generic,
+              headers: T::Hash[String, String],
+              body: T.anything,
+              deadline: Float
+            }
+          end
+        end
       end
     end
   end

data/lib/orb/internal/type/array_of.rb

@@ -29,7 +29,7 @@ module Orb
         #
         #   @option spec [Boolean] :"nil?"
         #
-        # @return [Orb::Internal::Type::ArrayOf]
+        # @return [self]
         def self.[](...) = new(...)
 
         # @api public

data/lib/orb/internal/type/base_model.rb

@@ -6,6 +6,7 @@ module Orb
       # @abstract
       class BaseModel
         extend Orb::Internal::Type::Converter
+        extend Orb::Internal::Util::SorbetRuntimeSupport
 
         class << self
           # @api private
@@ -13,11 +14,17 @@ module Orb
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
           #
-          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
-          def known_fields
-            @known_fields ||= (self < Orb::Internal::Type::BaseModel ? superclass.known_fields.dup : {})
+          # @param child [Class<Orb::Internal::Type::BaseModel>]
+          def inherited(child)
+            super
+            child.known_fields.replace(known_fields.dup)
           end
 
+          # @api private
+          #
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def known_fields = @known_fields ||= {}
+
           # @api private
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
@@ -199,7 +206,7 @@ module Orb
           #
           #   @option state [Integer] :branched
           #
-          # @return [Orb::Internal::Type::BaseModel, Object]
+          # @return [self, Object]
           def coerce(value, state:)
             exactness = state.fetch(:exactness)
 
@@ -258,7 +265,7 @@ module Orb
 
           # @api private
           #
-          # @param value [Orb::Internal::Type::BaseModel, Object]
+          # @param value [self, Object]
           #
           # @param state [Hash{Symbol=>Object}] .
           #
@@ -299,6 +306,39 @@ module Orb
           end
         end
 
+        class << self
+          # @api private
+          #
+          # @param model [Orb::Internal::Type::BaseModel]
+          # @param convert [Boolean]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def recursively_to_h(model, convert:)
+            rec = ->(x) do
+              case x
+              in Orb::Internal::Type::BaseModel
+                if convert
+                  fields = x.class.known_fields
+                  x.to_h.to_h do |key, val|
+                    [key, rec.call(fields.key?(key) ? x.public_send(key) : val)]
+                  rescue Orb::Errors::ConversionError
+                    [key, rec.call(val)]
+                  end
+                else
+                  rec.call(x.to_h)
+                end
+              in Hash
+                x.transform_values(&rec)
+              in Array
+                x.map(&rec)
+              else
+                x
+              end
+            end
+            rec.call(model)
+          end
+        end
+
         # @api public
         #
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
@@ -335,6 +375,14 @@ module Orb
 
         alias_method :to_hash, :to_h
 
+        # @api public
+        #
+        # In addition to the behaviour of `#to_h`, this method will recursively call
+        # `#to_h` on nested models.
+        #
+        # @return [Hash{Symbol=>Object}]
+        def deep_to_h = self.class.recursively_to_h(@data, convert: false)
+
         # @param keys [Array<Symbol>, nil]
         #
         # @return [Hash{Symbol=>Object}]
@@ -350,29 +398,6 @@ module Orb
             .to_h
         end
 
-        class << self
-          # @api private
-          #
-          # @param model [Orb::Internal::Type::BaseModel]
-          #
-          # @return [Hash{Symbol=>Object}]
-          def walk(model)
-            walk = ->(x) do
-              case x
-              in Orb::Internal::Type::BaseModel
-                walk.call(x.to_h)
-              in Hash
-                x.transform_values(&walk)
-              in Array
-                x.map(&walk)
-              else
-                x
-              end
-            end
-            walk.call(model)
-          end
-        end
-
         # @api public
         #
         # @param a [Object]
@@ -418,12 +443,19 @@ module Orb
         # @api public
         #
         # @return [String]
-        def to_s = self.class.walk(@data).to_s
+        def to_s = deep_to_h.to_s
 
         # @api private
         #
         # @return [String]
-        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
+        def inspect
+          converted = self.class.recursively_to_h(self, convert: true)
+          "#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>"
+        end
+
+        define_sorbet_constant!(:KnownField) do
+          T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} }
+        end
       end
     end
   end

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

@@ -5,6 +5,8 @@ module Orb
     module Type
       # @api private
       module Converter
+        extend Orb::Internal::Util::SorbetRuntimeSupport
+
         # rubocop:disable Lint/UnusedMethodArgument
 
         # @api private
@@ -268,6 +270,22 @@ module Orb
             end
           end
         end
+
+        define_sorbet_constant!(:Input) do
+          T.type_alias { T.any(Orb::Internal::Type::Converter, T::Class[T.anything]) }
+        end
+        define_sorbet_constant!(:CoerceState) do
+          T.type_alias do
+            {
+              strictness: T.any(T::Boolean, Symbol),
+              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              branched: Integer
+            }
+          end
+        end
+        define_sorbet_constant!(:DumpState) do
+          T.type_alias { {can_retry: T::Boolean} }
+        end
       end
     end
   end

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

@@ -17,11 +17,11 @@ module Orb
       # values safely.
       #
       # @example
-      #   # `billing_cycle_relative_date` is a `Orb::Models::BillingCycleRelativeDate`
+      #   # `billing_cycle_relative_date` is a `Orb::BillingCycleRelativeDate`
       #   case billing_cycle_relative_date
-      #   when Orb::Models::BillingCycleRelativeDate::START_OF_TERM
+      #   when Orb::BillingCycleRelativeDate::START_OF_TERM
       #     # ...
-      #   when Orb::Models::BillingCycleRelativeDate::END_OF_TERM
+      #   when Orb::BillingCycleRelativeDate::END_OF_TERM
       #     # ...
       #   else
       #     puts(billing_cycle_relative_date)
@@ -38,6 +38,7 @@ module Orb
       #   end
       module Enum
         include Orb::Internal::Type::Converter
+        include Orb::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
         #

data/lib/orb/internal/type/hash_of.rb

@@ -29,7 +29,7 @@ module Orb
         #
         #   @option spec [Boolean] :"nil?"
         #
-        # @return [Orb::Internal::Type::HashOf]
+        # @return [self]
         def self.[](...) = new(...)
 
         # @api public

data/lib/orb/internal/type/request_parameters.rb

@@ -5,10 +5,10 @@ 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
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [Orb::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)

data/lib/orb/internal/type/union.rb

@@ -6,13 +6,13 @@ module Orb
       # @api private
       #
       # @example
-      #   # `discount` is a `Orb::Models::Discount`
+      #   # `discount` is a `Orb::Discount`
       #   case discount
-      #   when Orb::Models::PercentageDiscount
+      #   when Orb::PercentageDiscount
       #     puts(discount.applies_to_price_ids)
-      #   when Orb::Models::TrialDiscount
+      #   when Orb::TrialDiscount
       #     puts(discount.discount_type)
-      #   when Orb::Models::UsageDiscount
+      #   when Orb::UsageDiscount
       #     puts(discount.usage_discount)
       #   else
       #     puts(discount)
@@ -46,6 +46,7 @@ module Orb
       #   end
       module Union
         include Orb::Internal::Type::Converter
+        include Orb::Internal::Util::SorbetRuntimeSupport
 
         # @api private
         #

data/lib/orb/internal/util.rb

@@ -535,7 +535,7 @@ module Orb
             filename = ERB::Util.url_encode(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            filename = ERB::Util.url_encode(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -801,6 +801,62 @@ module Orb
           end
         end
       end
+
+      # @api private
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        # @api private
+        #
+        # @return [Hash{Symbol=>Object}]
+        private def sorbet_runtime_constants = @sorbet_runtime_constants ||= {}
+
+        # @api private
+        #
+        # @param name [Symbol]
+        def const_missing(name)
+          super unless sorbet_runtime_constants.key?(name)
+
+          unless Object.const_defined?(:T)
+            message = "Trying to access a Sorbet constant #{name.inspect} without `sorbet-runtime`."
+            raise MissingSorbetRuntimeError.new(message)
+          end
+
+          sorbet_runtime_constants.fetch(name).call
+        end
+
+        # @api private
+        #
+        # @param name [Symbol]
+        # @param blk [Proc]
+        def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+      end
+
+      extend Orb::Internal::Util::SorbetRuntimeSupport
+
+      define_sorbet_constant!(:ParsedUri) do
+        T.type_alias do
+          {
+            scheme: T.nilable(String),
+            host: T.nilable(String),
+            port: T.nilable(Integer),
+            path: T.nilable(String),
+            query: T::Hash[String, T::Array[String]]
+          }
+        end
+      end
+
+      define_sorbet_constant!(:ServerSentEvent) do
+        T.type_alias do
+          {
+            event: T.nilable(String),
+            data: T.nilable(String),
+            id: T.nilable(String),
+            retry: T.nilable(Integer)
+          }
+        end
+      end
     end
   end
 end

data/lib/orb/internal.rb

@@ -2,10 +2,16 @@
 
 module Orb
   module Internal
+    extend Orb::Internal::Util::SorbetRuntimeSupport
+
     OMIT =
       Object.new.tap do
         _1.define_singleton_method(:inspect) { "#<#{Orb::Internal}::OMIT>" }
       end
         .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
   end
 end