stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/stripe_object.rb

@@ -4,6 +4,8 @@ module Stripe
   class StripeObject
     include Enumerable
 
+    attr_reader :last_response
+
     @@permanent_attributes = Set.new([:id]) # rubocop:disable Style/ClassVars
 
     # The default :id method is deprecated and isn't useful to us
@@ -70,7 +72,8 @@ module Stripe
       @additive_params.include?(name)
     end
 
-    def initialize(id = nil, opts = {})
+    def initialize(id = nil, opts = {}, api_mode = :v1, requestor = nil)
+      @api_mode = api_mode
       id, @retrieve_params = Util.normalize_id(id)
       @opts = Util.normalize_opts(opts)
       @original_values = {}
@@ -80,13 +83,16 @@ module Stripe
       @unsaved_values = Set.new
       @transient_values = Set.new
       @values[:id] = id if id
+      @id = id
+      @last_response = nil
+      @requestor = requestor || APIRequestor.active_requestor
     end
 
-    def self.construct_from(values, opts = {})
+    def self.construct_from(values, opts = {}, last_response = nil, api_mode = :v1, requestor = nil)
       values = Stripe::Util.symbolize_names(values)
 
       # work around protected #initialize_from for now
-      new(values[:id]).send(:initialize_from, values, opts)
+      new(values[:id]).send(:initialize_from, values, opts, last_response, api_mode: api_mode, requestor: requestor)
     end
 
     # Determines the equality of two Stripe objects. Stripe objects are
@@ -148,14 +154,36 @@ module Stripe
     def update_attributes(values, opts = {}, dirty: true)
       values.each do |k, v|
         add_accessors([k], values) unless metaclass.method_defined?(k.to_sym)
-        @values[k] = Util.convert_to_stripe_object(v, opts)
+        @values[k] = convert_value_with_inner_types(k, v, opts)
         dirty_value!(@values[k]) if dirty
         @unsaved_values.add(k)
       end
     end
 
+    private def convert_value_with_inner_types(key, value, opts)
+      inner_class = _get_inner_class_type(key)
+
+      if inner_class
+        Util.convert_to_stripe_object(value, opts, api_mode: @api_mode, requestor: @requestor, klass: inner_class)
+      else
+        Util.convert_to_stripe_object(value, opts, api_mode: @api_mode, requestor: @requestor)
+      end
+    end
+
     def [](key)
-      @values[key.to_sym]
+      key_sym = key.to_sym
+      return @values[key_sym] if @values.key?(key_sym)
+
+      # super specific one-off case to help users debug this property disappearing
+      # see also: https://go/j/DEVSDK-2835
+      if is_a?(Invoice) && key_sym == :payment_intent
+        raise KeyError,
+              "The 'payment_intent' attribute is no longer available on Invoice objects. " \
+              "See the docs for more details: https://docs.stripe.com/changelog/basil/2025-03-31/" \
+              "add-support-for-multiple-partial-payments-on-invoices#why-is-this-a-breaking-change"
+      end
+
+      nil
     end
 
     def []=(key, value)
@@ -186,13 +214,13 @@ module Stripe
         value.respond_to?(:to_hash) ? value.to_hash : value
       end
 
-      @values.each_with_object({}) do |(key, value), acc|
-        acc[key] = case value
-                   when Array
-                     value.map(&maybe_to_hash)
-                   else
-                     maybe_to_hash.call(value)
-                   end
+      @values.transform_values do |value|
+        case value
+        when Array
+          value.map(&maybe_to_hash)
+        else
+          maybe_to_hash.call(value)
+        end
       end
     end
 
@@ -217,20 +245,22 @@ module Stripe
     # This allows us to remove certain features that cannot or should not be
     # serialized.
     def marshal_dump
-      # The StripeClient instance in @opts is not serializable and is not
+      # The APIRequestor instance in @opts is not serializable and is not
       # really a property of the StripeObject, so we exclude it when
       # dumping
       opts = @opts.clone
+
+      # TODO: (major) Remove the :client option. This is not explicitly supported as a user-specified option.
       opts.delete(:client)
       [@values, opts]
     end
 
     # Implements custom decoding for Ruby's Marshal. Consumes data that's
     # produced by #marshal_dump.
-    def marshal_load(data)
+    def marshal_load(data, api_mode: :v1)
       values, opts = data
-      initialize(values[:id])
-      initialize_from(values, opts)
+      initialize(values[:id], api_mode: api_mode)
+      initialize_from(values, opts, api_mode: api_mode, requestor: @requestor)
     end
 
     def serialize_params(options = {})
@@ -255,7 +285,7 @@ module Stripe
 
       # a `nil` that makes it out of `#serialize_params_value` signals an empty
       # value that we shouldn't appear in the serialized form of the object
-      update_hash.reject! { |_, v| v.nil? }
+      update_hash.compact!
 
       update_hash
     end
@@ -295,6 +325,7 @@ module Stripe
     protected def remove_accessors(keys)
       # not available in the #instance_eval below
       protected_fields = self.class.protected_fields
+      obj = self # capture self to use inside instance_eval
 
       metaclass.instance_eval do
         keys.each do |k|
@@ -320,10 +351,15 @@ module Stripe
               # Here we swallow that error and issue a warning so at least
               # the program doesn't crash.
               warn("WARNING: Unable to remove method `#{method_name}`; " \
-                "if custom, please consider renaming to a name that doesn't " \
-                "collide with an API property name.")
+                   "if custom, please consider renaming to a name that doesn't " \
+                   "collide with an API property name.")
             end
           end
+
+          # Also remove instance variables so that static attr_readers (if any exist)
+          # will return nil instead of stale data or data of the wrong type
+          ivar_name = :"@#{k}"
+          obj.remove_instance_variable(ivar_name) if obj.instance_variable_defined?(ivar_name)
         end
       end
     end
@@ -351,17 +387,28 @@ module Stripe
           define_method(:"#{k}=") do |v|
             if v == ""
               raise ArgumentError, "You cannot set #{k} to an empty string. " \
-                "We interpret empty strings as nil in requests. " \
-                "You may set (object).#{k} = nil to delete the property."
+                                   "We interpret empty strings as nil in requests. " \
+                                   "You may set (object).#{k} = nil to delete the property."
             end
-            @values[k] = Util.convert_to_stripe_object(v, @opts)
+            @values[k] = Util.convert_to_stripe_object(v, @opts, api_mode: @api_mode, requestor: @requestor)
             dirty_value!(@values[k])
             @unsaved_values.add(k)
           end
 
-          if [FalseClass, TrueClass].include?(values[k].class)
-            define_method(:"#{k}?") { @values[k] }
-          end
+          define_method(:"#{k}?") { @values[k] } if [FalseClass, TrueClass].include?(values[k].class)
+        end
+      end
+
+      keys.each do |k|
+        if Util.valid_variable_name?(k)
+          instance_variable_set(:"@#{k}", values[k])
+        else
+          Util.log_info(<<~LOG
+            The variable name '#{k}' is not a valid Ruby variable name.
+            Use ["#{k}"] to access this field, skipping instance variable instantiation...
+          LOG
+                       )
+
         end
       end
     end
@@ -369,7 +416,6 @@ module Stripe
     # Disabling the cop because it's confused by the fact that the methods are
     # protected, but we do define `#respond_to_missing?` just below. Hopefully
     # this is fixed in more recent Rubocop versions.
-    # rubocop:disable Style/MissingRespondToMissing
     protected def method_missing(name, *args)
       # TODO: only allow setting in updateable classes.
       if name.to_s.end_with?("=")
@@ -398,6 +444,23 @@ module Stripe
       begin
         super
       rescue NoMethodError => e
+        # super specific one-off case to help users debug this property disappearing
+        # see also: https://go/j/DEVSDK-2835
+        if is_a?(Invoice) && name == :payment_intent
+          raise NoMethodError,
+                "\n\n" \
+                "-----------------\n " \
+                "BREAKING CHANGE \n" \
+                "-----------------\n" \
+                "The 'payment_intent' attribute is no longer available on Invoice objects.\n\n" \
+                "See the docs for more details:\n" \
+                "https://docs.stripe.com/changelog/basil/2025-03-31/" \
+                "add-support-for-multiple-partial-payments-on-invoices#why-is-this-a-breaking-change\n" \
+                "-----------------\n " \
+                "BREAKING CHANGE \n" \
+                "-----------------" \
+        end
+
         # If we notice the accessed name of our set of transient values we can
         # give the user a slightly more helpful error message. If not, just
         # raise right away.
@@ -405,16 +468,14 @@ module Stripe
 
         raise NoMethodError,
               e.message + ".  HINT: The '#{name}' attribute was set in the " \
-              "past, however.  It was then wiped when refreshing the object " \
-              "with the result returned by Stripe's API, probably as a " \
-              "result of a save().  The attributes currently available on " \
-              "this object are: #{@values.keys.join(', ')}"
+                          "past, however.  It was then wiped when refreshing the object " \
+                          "with the result returned by Stripe's API, probably as a " \
+                          "result of a save().  The attributes currently available on " \
+                          "this object are: #{@values.keys.join(', ')}"
       end
     end
-    # rubocop:enable Style/MissingRespondToMissing
-
     protected def respond_to_missing?(symbol, include_private = false)
-      @values && @values.key?(symbol) || super
+      (@values && @values.key?(symbol)) || super
     end
 
     # Re-initializes the object based on a hash of values (usually one that's
@@ -429,13 +490,17 @@ module Stripe
     # * +:opts:+ Options for StripeObject like an API key.
     # * +:partial:+ Indicates that the re-initialization should not attempt to
     #   remove accessors.
-    protected def initialize_from(values, opts, partial = false)
+    protected def initialize_from(values, opts, last_response = nil, api_mode:, requestor: nil)
+      @api_mode = api_mode
+      @last_response = last_response
+      @requestor = requestor
+
       @opts = Util.normalize_opts(opts)
 
       # the `#send` is here so that we can keep this method private
-      @original_values = self.class.send(:deep_copy, values)
+      @original_values = self.class.send(:deep_copy, values, api_mode: api_mode)
 
-      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      removed = Set.new(@values.keys - values.keys)
       added = Set.new(values.keys - @values.keys)
 
       # Wipe old state before setting new.  This is useful for e.g. updating a
@@ -460,7 +525,21 @@ module Stripe
       self
     end
 
-    protected def serialize_params_value(value, original, unsaved, force,
+    # Should only be for v2 events and lists, for now.
+    protected def _request(method:, path:, base_address:, params: {}, opts: {})
+      req_opts = RequestOptions.extract_opts_from_hash(opts)
+      req_opts = RequestOptions.combine_opts(@opts, req_opts)
+      @requestor.execute_request(
+        method,
+        path,
+        base_address,
+        params: params,
+        opts: req_opts
+      )
+    end
+
+    # rubocop:todo Metrics/PerceivedComplexity
+    protected def serialize_params_value(value, original, unsaved, force, # rubocop:todo Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
                                          key: nil)
       if value.nil?
         ""
@@ -494,8 +573,8 @@ module Stripe
           value
         else
           raise ArgumentError, "Cannot save property `#{key}` containing " \
-            "an API resource. It doesn't appear to be persisted and is " \
-            "not marked as `save_with_parent`."
+                               "an API resource. It doesn't appear to be persisted and is " \
+                               "not marked as `save_with_parent`."
         end
 
       elsif value.is_a?(Array)
@@ -515,7 +594,7 @@ module Stripe
       # example by appending a new hash onto `additional_owners` for an
       # account.
       elsif value.is_a?(Hash)
-        Util.convert_to_stripe_object(value, @opts).serialize_params
+        Util.convert_to_stripe_object(value, @opts, api_mode: @api_mode, requestor: @requestor).serialize_params
 
       elsif value.is_a?(StripeObject)
         update = value.serialize_params(force: force)
@@ -535,24 +614,26 @@ module Stripe
         value
       end
     end
+    # rubocop:enable Metrics/PerceivedComplexity
 
     # Produces a deep copy of the given object including support for arrays,
     # hashes, and StripeObjects.
-    private_class_method def self.deep_copy(obj)
+    private_class_method def self.deep_copy(obj, api_mode:)
       case obj
       when Array
-        obj.map { |e| deep_copy(e) }
+        obj.map { |e| deep_copy(e, api_mode: api_mode) }
       when Hash
         obj.each_with_object({}) do |(k, v), copy|
-          copy[k] = deep_copy(v)
+          copy[k] = deep_copy(v, api_mode: api_mode)
           copy
         end
       when StripeObject
         obj.class.construct_from(
-          deep_copy(obj.instance_variable_get(:@values)),
-          obj.instance_variable_get(:@opts).select do |k, _v|
-            Util::OPTS_COPYABLE.include?(k)
-          end
+          deep_copy(obj.instance_variable_get(:@values), api_mode: api_mode),
+          RequestOptions.copyable(obj.instance_variable_get(:@opts)),
+          nil,
+          api_mode,
+          obj.instance_variable_get(:@requestor)
         )
       else
         obj
@@ -584,5 +665,19 @@ module Stripe
         update[k] = ""
       end
     end
+
+    # Instance methods to get inner class types
+    def _get_inner_class_type(field_name)
+      self.class.inner_class_types[field_name.to_sym]
+    end
+
+    # Class methods for inner class types, similar to Python's implementation
+    def self.inner_class_types
+      @inner_class_types ||= {}
+    end
+
+    def self.field_remappings
+      @field_remappings ||= {}
+    end
   end
 end

data/lib/stripe/stripe_response.rb

@@ -41,9 +41,7 @@ module Stripe
 
     def [](name)
       values = @hash[name.downcase]
-      if values && values.count > 1
-        warn("Duplicate header values for `#{name}`; returning only first")
-      end
+      warn("Duplicate header values for `#{name}`; returning only first") if values && values.count > 1
       values ? values.first : nil
     end
   end

data/lib/stripe/stripe_service.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: true
+
+module Stripe
+  class StripeService
+    # Initializes a new StripeService
+    def initialize(requestor)
+      @requestor = requestor
+    end
+
+    def request(method:, path:, base_address:, params: {}, opts: {})
+      @requestor.execute_request(
+        method,
+        path,
+        base_address,
+        params: params,
+        opts: RequestOptions.extract_opts_from_hash(opts),
+        usage: ["stripe_client"]
+      )
+    end
+
+    def request_stream(method:, path:, base_address:, params: {}, opts: {}, &read_body_chunk_block)
+      @requestor.execute_request_stream(
+        method,
+        path,
+        base_address,
+        params: params,
+        opts: RequestOptions.extract_opts_from_hash(opts),
+        usage: ["stripe_client"],
+        &read_body_chunk_block
+      )
+    end
+  end
+end