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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 702ebd1a845c490ffa0ab6e32aa2b2d89f058b6eff8983c235ed55b0032f9dc4
-  data.tar.gz: 51b7d195d7807e89a4ed00bc6b3471835360177f217f3e125aed55f0b594e7fd
+  metadata.gz: 249d2973800ed2fb6c87fe4e0c7b22208082baef56fa69146ebd6b6eb464fd0f
+  data.tar.gz: e3db0fd166e2f0e698bc3487a9e69d6b0461bdab175a105624f43b4b230c150d
 SHA512:
-  metadata.gz: 13c4acc99fb84c9a0428238659ef2ac95ed4c7cc6f6dc0a7015ced4cb05c130ca9fb915fcb2f84682b0d6b3c5ef79fb1552b05c4f63d5939cb0af16616ca7311
-  data.tar.gz: 431ab89420d519418e56a2d6c096a967704cee137de97862e6fc1af093f4d85e9934eb1b8152915c6b35f574d09d7e5b66d9f341dff3c4d268b78f6792732046
+  metadata.gz: ce5534719e3cfa2faa48435c2ec0b84910f1f1cfb4e5679c43ae6cbe4d218855479bac17e467d723799ccf1953197a7cfe9a89442f5b904bcb252a66490b9fb8
+  data.tar.gz: fed3c6b0e6311ab74defabad0b7fa99f6b464de6dce1af15f2212e7c4725211eba89aae5fd4747611ebab9b778a5c036a3b7b8a1d808fdf8609f6b2af28869fe

data/README.md

@@ -12,10 +12,14 @@ The underlying REST API documentation can be found on [docs.withorb.com](https:/
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
 
+<!-- x-release-please-start-version -->
+
 ```ruby
-gem "orb-billing", "~> 0.1.0.pre.alpha.36"
+gem "orb-billing", "~> 0.1.0.pre.alpha.37"
 ```
 
+<!-- x-release-please-end -->
+
 To fetch an initial copy of the gem:
 
 ```sh
@@ -130,9 +134,23 @@ orb.customers.create(
 
 ## LSP Support
 
-### Sorbet
+### Solargraph
+
+This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
+
+```ruby
+gem "solargraph", group: :development
+```
+
+After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
 
-**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+```sh
+bundle exec solargraph gems
+```
+
+Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
+
+### Sorbet
 
 This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
 
@@ -143,11 +161,17 @@ Due to limitations with the Sorbet type system, where a method otherwise can tak
 Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
 
 ```ruby
-model = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer")
+params = Orb::Models::CustomerCreateParams.new(email: "example-customer@withorb.com", name: "My Customer")
 
-orb.customers.create(**model)
+orb.customers.create(**params)
 ```
 
+Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
+
+### Ruby LSP
+
+The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information.
+
 ## Advanced
 
 ### Making custom/undocumented requests

data/lib/orb/internal/page.rb

@@ -2,6 +2,8 @@
 
 module Orb
   module Internal
+    # @generic Elem
+    #
     # @example
     #   if page.has_next?
     #     page = page.next_page
@@ -14,7 +16,7 @@ module Orb
     class Page
       include Orb::Internal::Type::BasePage
 
-      # @return [Array<Object>, nil]
+      # @return [Array<generic<Elem>>, nil]
       attr_accessor :data
 
       # @return [PaginationMetadata]
@@ -65,6 +67,8 @@ module Orb
       end
 
       # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
       def auto_paging_each(&blk)
         unless block_given?
           raise ArgumentError.new("A block must be given to ##{__method__}")
@@ -88,7 +92,7 @@ module Orb
         # @!attribute has_more
         #
         #   @return [Boolean]
-        required :has_more, Orb::Internal::Type::BooleanModel
+        required :has_more, Orb::Internal::Type::Boolean
 
         # @!attribute next_cursor
         #

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

@@ -131,7 +131,7 @@ module Orb
           # @api private
           #
           # @param status [Integer, Orb::Errors::APIConnectionError]
-          # @param stream [Enumerable, nil]
+          # @param stream [Enumerable<String>, nil]
           def reap_connection!(status, stream:)
             case status
             in (..199) | (300..499)
@@ -328,7 +328,7 @@ module Orb
         # @param send_retry_header [Boolean]
         #
         # @raise [Orb::Errors::APIError]
-        # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
+        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: Orb::Internal::Util.monotonic_secs + timeout}

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

@@ -119,7 +119,7 @@ module Orb
         #
         #   @option request [Float] :deadline
         #
-        # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
+        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         def execute(request)
           url, deadline = request.fetch_values(:url, :deadline)
 

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

@@ -7,6 +7,8 @@ module Orb
       #
       # @abstract
       #
+      # @generic Elem
+      #
       # Array of items of a given type.
       class ArrayOf
         include Orb::Internal::Type::Converter
@@ -40,7 +42,7 @@ module Orb
 
         # @api private
         #
-        # @param value [Enumerable, Object]
+        # @param value [Array<Object>, Object]
         #
         # @param state [Hash{Symbol=>Object}] .
         #
@@ -75,7 +77,7 @@ module Orb
 
         # @api private
         #
-        # @param value [Enumerable, Object]
+        # @param value [Array<Object>, Object]
         #
         # @return [Array<Object>, Object]
         def dump(value)
@@ -85,7 +87,7 @@ module Orb
 
         # @api private
         #
-        # @return [Orb::Internal::Type::Converter, Class]
+        # @return [generic<Elem>]
         protected def item_type = @item_type_fn.call
 
         # @api private

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

@@ -168,7 +168,9 @@ module Orb
           # @param other [Object]
           #
           # @return [Boolean]
-          def ==(other) = other.is_a?(Class) && other <= Orb::Internal::Type::BaseModel && other.fields == fields
+          def ==(other)
+            other.is_a?(Class) && other <= Orb::Internal::Type::BaseModel && other.fields == fields
+          end
         end
 
         # @param other [Object]
@@ -256,6 +258,7 @@ module Orb
               return super
             end
 
+            is_param = singleton_class <= Orb::Internal::Type::RequestParameters::Converter
             acc = {}
 
             coerced.each do |key, val|
@@ -264,19 +267,21 @@ module Orb
               in nil
                 acc.store(name, super(val))
               else
-                mode, api_name, type_fn = field.fetch_values(:mode, :api_name, :type_fn)
+                mode, type_fn = field.fetch_values(:mode, :type_fn)
                 case mode
                 in :coerce
                   next
                 else
                   target = type_fn.call
+                  api_name = is_param ? name : field.fetch(:api_name)
                   acc.store(api_name, Orb::Internal::Type::Converter.dump(target, val))
                 end
               end
             end
 
-            known_fields.each_value do |field|
-              mode, api_name, const = field.fetch_values(:mode, :api_name, :const)
+            known_fields.each do |name, field|
+              mode, const = field.fetch_values(:mode, :const)
+              api_name = is_param ? name : field.fetch(:api_name)
               next if mode == :coerce || acc.key?(api_name) || const == Orb::Internal::OMIT
               acc.store(api_name, const)
             end
@@ -350,7 +355,8 @@ module Orb
           in Hash => coerced
             @data = coerced
           else
-            raise ArgumentError.new("Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}")
+            message = "Expected a #{Hash} or #{Orb::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
           end
         end
 
@@ -358,7 +364,7 @@ module Orb
         def inspect
           rows = self.class.known_fields.keys.map do
             "#{_1}=#{@data.key?(_1) ? public_send(_1) : ''}"
-          rescue Orb::ConversionError
+          rescue Orb::Errors::ConversionError
             "#{_1}=#{@data.fetch(_1)}"
           end
           "#<#{self.class.name}:0x#{object_id.to_s(16)} #{rows.join(' ')}>"

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

@@ -3,6 +3,8 @@
 module Orb
   module Internal
     module Type
+      # @generic Elem
+      #
       # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
@@ -16,10 +18,11 @@ module Orb
 
         # @param blk [Proc]
         #
+        # @yieldparam [generic<Elem>]
         # @return [void]
         def auto_paging_each(&blk) = (raise NotImplementedError)
 
-        # @return [Enumerable]
+        # @return [Enumerable<generic<Elem>>]
         def to_enum = super(:auto_paging_each)
 
         alias_method :enum_for, :to_enum

data/lib/orb/internal/type/{boolean_model.rb → boolean.rb}

@@ -8,7 +8,7 @@ module Orb
       # @abstract
       #
       # Ruby has no Boolean class; this is something for models to refer to.
-      class BooleanModel
+      class Boolean
         extend Orb::Internal::Type::Converter
 
         # @param other [Object]
@@ -19,7 +19,7 @@ module Orb
         # @param other [Object]
         #
         # @return [Boolean]
-        def self.==(other) = other.is_a?(Class) && other <= Orb::Internal::Type::BooleanModel
+        def self.==(other) = other.is_a?(Class) && other <= Orb::Internal::Type::Boolean
 
         class << self
           # @api private

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

@@ -64,7 +64,7 @@ module Orb
             in Hash
               type_info(spec.slice(:const, :enum, :union).first&.last)
             in true | false
-              -> { Orb::Internal::Type::BooleanModel }
+              -> { Orb::Internal::Type::Boolean }
             in Orb::Internal::Type::Converter | Class | Symbol
               -> { spec }
             in NilClass | Integer | Float
@@ -168,6 +168,9 @@ module Orb
                 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
                   if strictness == :strong
                     message = "no implicit conversion of #{value.class} into #{target.inspect}"
@@ -209,7 +212,9 @@ module Orb
           #
           # @return [Object]
           def dump(target, value)
+            # rubocop:disable Layout/LineLength
             target.is_a?(Orb::Internal::Type::Converter) ? target.dump(value) : Orb::Internal::Type::Unknown.dump(value)
+            # rubocop:enable Layout/LineLength
           end
         end
       end

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

@@ -58,7 +58,9 @@ module Orb
         #
         # @return [Boolean]
         def ==(other)
+          # rubocop:disable Layout/LineLength
           other.is_a?(Module) && other.singleton_class <= Orb::Internal::Type::Enum && other.values.to_set == values.to_set
+          # rubocop:enable Layout/LineLength
         end
 
         # @api private

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

@@ -7,6 +7,8 @@ module Orb
       #
       # @abstract
       #
+      # @generic Elem
+      #
       # Hash of items of a given type.
       class HashOf
         include Orb::Internal::Type::Converter
@@ -111,7 +113,7 @@ module Orb
 
         # @api private
         #
-        # @return [Orb::Internal::Type::Converter, Class]
+        # @return [generic<Elem>]
         protected def item_type = @item_type_fn.call
 
         # @api private

data/lib/orb/internal/util.rb

@@ -61,7 +61,7 @@ module Orb
         # @return [Boolean]
         def primitive?(input)
           case input
-          in true | false | Integer | Float | Symbol | String
+          in true | false | Numeric | Symbol | String
             true
           else
             false
@@ -70,13 +70,11 @@ module Orb
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Boolean]
         #
         # @return [Boolean, Object]
         def coerce_boolean(input)
           case input.is_a?(String) ? input.downcase : input
-          in Numeric
-            input.nonzero?
           in "true"
             true
           in "false"
@@ -88,7 +86,7 @@ module Orb
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Boolean]
         #
         # @raise [ArgumentError]
         # @return [Boolean, nil]
@@ -103,34 +101,20 @@ module Orb
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Integer]
         #
         # @return [Integer, Object]
         def coerce_integer(input)
-          case input
-          in true
-            1
-          in false
-            0
-          else
-            Integer(input, exception: false) || input
-          end
+          Integer(input, exception: false) || input
         end
 
         # @api private
         #
-        # @param input [Object]
+        # @param input [String, Integer, Float]
         #
         # @return [Float, Object]
         def coerce_float(input)
-          case input
-          in true
-            1.0
-          in false
-            0.0
-          else
-            Float(input, exception: false) || input
-          end
+          Float(input, exception: false) || input
         end
 
         # @api private
@@ -159,12 +143,7 @@ module Orb
         private def deep_merge_lr(lhs, rhs, concat: false)
           case [lhs, rhs, concat]
           in [Hash, Hash, _]
-            rhs_cleaned = rhs.reject { _2 == Orb::Internal::OMIT }
-            lhs
-              .reject { |key, _| rhs[key] == Orb::Internal::OMIT }
-              .merge(rhs_cleaned) do |_, old_val, new_val|
-                deep_merge_lr(old_val, new_val, concat: concat)
-              end
+            lhs.merge(rhs) { deep_merge_lr(_2, _3, concat: concat) }
           in [Array, Array, true]
             lhs.concat(rhs)
           else
@@ -362,7 +341,7 @@ module Orb
             value =
               case val
               in Array
-                val.map { _1.to_s.strip }.join(", ")
+                val.filter_map { _1&.to_s&.strip }.join(", ")
               else
                 val&.to_s&.strip
               end
@@ -419,7 +398,7 @@ module Orb
 
         # @api private
         #
-        # @param stream [String, IO, StringIO, Enumerable]
+        # @param stream [String, IO, StringIO, Enumerable<String>]
         # @param blk [Proc]
         #
         # @yieldparam [String]
@@ -434,7 +413,7 @@ module Orb
         # @param blk [Proc]
         #
         # @yieldparam [Enumerator::Yielder]
-        # @return [Enumerable]
+        # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
             y.define_singleton_method(:write) do
@@ -469,7 +448,7 @@ module Orb
           case val
           in IO
             y << "Content-Type: application/octet-stream\r\n\r\n"
-            IO.copy_stream(val, y)
+            IO.copy_stream(val.tap(&:rewind), y)
           in StringIO
             y << "Content-Type: application/octet-stream\r\n\r\n"
             y << val.string
@@ -490,7 +469,7 @@ module Orb
         #
         # @param body [Object]
         #
-        # @return [Array(String, Enumerable)]
+        # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
           boundary = SecureRandom.urlsafe_base64(60)
 
@@ -525,7 +504,7 @@ module Orb
         def encode_content(headers, body)
           content_type = headers["content-type"]
           case [content_type, body]
-          in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array]
+          in [%r{^application/(?:vnd\.api\+)?json}, _] unless body.nil?
             [headers, JSON.fast_generate(body)]
           in [%r{^application/(?:x-)?jsonl}, Enumerable]
             [headers, body.lazy.map { JSON.fast_generate(_1) }]
@@ -533,8 +512,12 @@ module Orb
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
             [headers, strio]
+          in [_, IO]
+            [headers, body.tap(&:rewind)]
           in [_, StringIO]
             [headers, body.string]
+          in [_, Symbol | Numeric]
+            [headers, body.to_s]
           else
             [headers, body]
           end
@@ -543,7 +526,7 @@ module Orb
         # @api private
         #
         # @param headers [Hash{String=>String}, Net::HTTPHeader]
-        # @param stream [Enumerable]
+        # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #
         # @raise [JSON::ParserError]
@@ -580,11 +563,11 @@ module Orb
         #
         # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
         #
-        # @param enum [Enumerable]
+        # @param enum [Enumerable<Object>]
         # @param external [Boolean]
         # @param close [Proc]
         #
-        # @return [Enumerable]
+        # @return [Enumerable<Object>]
         def fused_enum(enum, external: false, &close)
           fused = false
           iter = Enumerator.new do |y|
@@ -610,7 +593,7 @@ module Orb
 
         # @api private
         #
-        # @param enum [Enumerable, nil]
+        # @param enum [Enumerable<Object>, nil]
         def close_fused!(enum)
           return unless enum.is_a?(Enumerator)
 
@@ -621,11 +604,11 @@ module Orb
 
         # @api private
         #
-        # @param enum [Enumerable, nil]
+        # @param enum [Enumerable<Object>, nil]
         # @param blk [Proc]
         #
         # @yieldparam [Enumerator::Yielder]
-        # @return [Enumerable]
+        # @return [Enumerable<Object>]
         def chain_fused(enum, &blk)
           iter = Enumerator.new { blk.call(_1) }
           fused_enum(iter) { close_fused!(enum) }
@@ -635,9 +618,9 @@ module Orb
       class << self
         # @api private
         #
-        # @param enum [Enumerable]
+        # @param enum [Enumerable<String>]
         #
-        # @return [Enumerable]
+        # @return [Enumerable<String>]
         def decode_lines(enum)
           re = /(\r\n|\r|\n)/
           buffer = String.new.b
@@ -671,9 +654,9 @@ module Orb
         #
         # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
         #
-        # @param lines [Enumerable]
+        # @param lines [Enumerable<String>]
         #
-        # @return [Hash{Symbol=>Object}]
+        # @return [Enumerable<Hash{Symbol=>Object}>]
         def decode_sse(lines)
           # rubocop:disable Metrics/BlockLength
           chain_fused(lines) do |y|

data/lib/orb/models/alert.rb

@@ -32,7 +32,7 @@ module Orb
       #   Whether the alert is enabled or disabled.
       #
       #   @return [Boolean]
-      required :enabled, Orb::Internal::Type::BooleanModel
+      required :enabled, Orb::Internal::Type::Boolean
 
       # @!attribute metric
       #   The metric the alert applies to.

data/lib/orb/models/coupon_list_params.rb

@@ -36,7 +36,7 @@ module Orb
       #     coupons).
       #
       #   @return [Boolean, nil]
-      optional :show_archived, Orb::Internal::Type::BooleanModel, nil?: true
+      optional :show_archived, Orb::Internal::Type::Boolean, nil?: true
 
       # @!parse
       #   # @param cursor [String, nil]

data/lib/orb/models/customer.rb

@@ -17,7 +17,7 @@ module Orb
       # @!attribute auto_collection
       #
       #   @return [Boolean]
-      required :auto_collection, Orb::Internal::Type::BooleanModel
+      required :auto_collection, Orb::Internal::Type::Boolean
 
       # @!attribute balance
       #   The customer's current balance in their currency.
@@ -51,12 +51,12 @@ module Orb
       # @!attribute email_delivery
       #
       #   @return [Boolean]
-      required :email_delivery, Orb::Internal::Type::BooleanModel
+      required :email_delivery, Orb::Internal::Type::Boolean
 
       # @!attribute exempt_from_automated_tax
       #
       #   @return [Boolean, nil]
-      required :exempt_from_automated_tax, Orb::Internal::Type::BooleanModel, nil?: true
+      required :exempt_from_automated_tax, Orb::Internal::Type::Boolean, nil?: true
 
       # @!attribute external_customer_id
       #   An optional user-defined ID for this customer resource, used throughout the
@@ -807,7 +807,7 @@ module Orb
         # @!attribute excluded
         #
         #   @return [Boolean]
-        required :excluded, Orb::Internal::Type::BooleanModel
+        required :excluded, Orb::Internal::Type::Boolean
 
         # @!parse
         #   # @param accounting_providers [Array<Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider>]
@@ -858,7 +858,7 @@ module Orb
         # @!attribute exempt
         #
         #   @return [Boolean]
-        required :exempt, Orb::Internal::Type::BooleanModel
+        required :exempt, Orb::Internal::Type::Boolean
 
         # @!parse
         #   # @param exempt [Boolean]

data/lib/orb/models/customer_create_params.rb

@@ -42,7 +42,7 @@ module Orb
       #     when a payment provider is provided on customer creation.
       #
       #   @return [Boolean, nil]
-      optional :auto_collection, Orb::Internal::Type::BooleanModel, nil?: true
+      optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
 
       # @!attribute billing_address
       #
@@ -59,7 +59,7 @@ module Orb
       # @!attribute email_delivery
       #
       #   @return [Boolean, nil]
-      optional :email_delivery, Orb::Internal::Type::BooleanModel, nil?: true
+      optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
 
       # @!attribute external_customer_id
       #   An optional user-defined ID for this customer resource, used throughout the
@@ -292,7 +292,7 @@ module Orb
         # @!attribute excluded
         #
         #   @return [Boolean, nil]
-        optional :excluded, Orb::Internal::Type::BooleanModel, nil?: true
+        optional :excluded, Orb::Internal::Type::Boolean, nil?: true
 
         # @!parse
         #   # @param accounting_providers [Array<Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
@@ -420,7 +420,7 @@ module Orb
         # @!attribute exempt
         #
         #   @return [Boolean]
-        required :exempt, Orb::Internal::Type::BooleanModel
+        required :exempt, Orb::Internal::Type::Boolean
 
         # @!parse
         #   # @param exempt [Boolean]
@@ -487,7 +487,7 @@ module Orb
           # @!attribute tax_exempt
           #
           #   @return [Boolean]
-          required :tax_exempt, Orb::Internal::Type::BooleanModel
+          required :tax_exempt, Orb::Internal::Type::Boolean
 
           # @!attribute tax_provider
           #
@@ -513,7 +513,7 @@ module Orb
           # @!attribute tax_exempt
           #
           #   @return [Boolean]
-          required :tax_exempt, Orb::Internal::Type::BooleanModel
+          required :tax_exempt, Orb::Internal::Type::Boolean
 
           # @!attribute tax_provider
           #