stripe 5.38.0 → 15.2.1

data/lib/stripe/api_resource.rb

@@ -11,11 +11,26 @@ module Stripe
     # for example, where this is allowed.
     attr_accessor :save_with_parent
 
+    # TODO: (major) Remove OBJECT_NAME and stop using const_get here
+    # This is a workaround to avoid breaking users who have defined their own
+    # APIResource subclasses with a custom OBJECT_NAME. We should never fallback
+    # on this case otherwise.
+    OBJECT_NAME = ""
+    def self.object_name
+      const_get(:OBJECT_NAME)
+    end
+
     def self.class_name
       name.split("::")[-1]
     end
 
     def self.resource_url
+      if name.include?("Stripe::V2")
+        raise NotImplementedError,
+              "V2 resources do not have a defined URL. Please use the StripeClient " \
+              "to make V2 requests"
+      end
+
       if self == APIResource
         raise NotImplementedError,
               "APIResource is an abstract class. You should perform actions " \
@@ -23,7 +38,7 @@ module Stripe
       end
       # Namespaces are separated in object names with periods (.) and in URLs
       # with forward slashes (/), so replace the former with the latter.
-      "/v1/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
+      "/v1/#{object_name.downcase.tr('.', '/')}s"
     end
 
     # A metaprogramming call that specifies that a field of a resource can be
@@ -63,22 +78,7 @@ module Stripe
     # adds a `capture` class method to the resource class that, when called,
     # will send a POST request to `/v1/<object_name>/capture`.
     def self.custom_method(name, http_verb:, http_path: nil)
-      unless %i[get post delete].include?(http_verb)
-        raise ArgumentError,
-              "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
-              "of :get, :post or :delete."
-      end
-      http_path ||= name.to_s
-      define_singleton_method(name) do |id, params = {}, opts = {}|
-        unless id.is_a?(String)
-          raise ArgumentError,
-                "id should be a string representing the ID of an API resource"
-        end
-
-        url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(http_path)}"
-        resp, opts = execute_resource_request(http_verb, url, params, opts)
-        Util.convert_to_stripe_object(resp.data, opts)
-      end
+      Util.custom_method self, self, name, http_verb, http_path
     end
 
     def resource_url
@@ -93,33 +93,48 @@ module Stripe
     end
 
     def refresh
-      resp, opts = execute_resource_request(:get, resource_url,
-                                            @retrieve_params)
-      initialize_from(resp.data, opts)
+      if self.class.name.include?("Stripe::V2")
+        raise NotImplementedError,
+              "It is not possible to refresh v2 objects. Please retrieve the object using the StripeClient instead."
+      end
+
+      opts = RequestOptions.extract_opts_from_hash(@retrieve_opts || {})
+      @retrieve_opts = {} # Make sure to clear the retrieve options
+      @obj = @requestor.execute_request_initialize_from(:get, resource_url, :api, self, params: @retrieve_params,
+                                                                                        opts: opts)
+      initialize_from(
+        @obj.last_response.data,
+        @obj.instance_variable_get(:@opts),
+        @obj.last_response,
+        api_mode: :v1,
+        requestor: @requestor
+      )
     end
 
     def self.retrieve(id, opts = {})
-      opts = Util.normalize_opts(opts)
-      instance = new(id, opts)
+      if name.include?("Stripe::V2")
+        raise NotImplementedError,
+              "It is not possible to retrieve v2 objects on the resource. Please use the StripeClient instead."
+      end
+
+      instance = new(id)
+      # Explicitly send options for the retrieve call, to preserve custom headers
+      # This is so we can pass custom headers from this static function
+      # to the instance variable method call
+      # The custom headers will be cleaned up with the rest of the RequestOptions
+      instance.instance_variable_set(:@retrieve_opts, Util.normalize_opts(opts))
       instance.refresh
-      instance
     end
 
-    protected def request_stripe_object(method:, path:, params:, opts: {})
-      resp, opts = execute_resource_request(method, path, params, opts)
-
-      # If we're getting back this thing, update; otherwise, instantiate.
-      if Util.object_name_matches_class?(resp.data[:object], self.class)
-        initialize_from(resp.data, opts)
-      else
-        Util.convert_to_stripe_object(resp.data, opts)
-      end
+    def request_stripe_object(method:, path:, params:, base_address: :api, opts: {})
+      APIRequestor.active_requestor.execute_request_initialize_from(method, path, base_address, self,
+                                                                    params: params, opts: opts)
     end
 
-    protected def request_stream(method:, path:, params:, opts: {},
+    protected def request_stream(method:, path:, params:, base_address: :api, opts: {},
                                  &read_body_chunk_block)
       resp, = execute_resource_request_stream(
-        method, path, params, opts, &read_body_chunk_block
+        method, path, base_address, params, opts, &read_body_chunk_block
       )
       resp
     end

data/lib/stripe/api_resource_test_helpers.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Stripe
+  # The base class for nested TestHelpers classes in resource objects.
+  # The APIResourceTestHelpers handles URL generation and custom method
+  # support for test-helper methods.
+  #
+  #  class MyAPIResource < APIResource
+  #    class TestHelpers < APIResourceTestHelpers
+  class APIResourceTestHelpers
+    include Stripe::APIOperations::Request
+
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def self.resource_class
+      nil
+    end
+
+    # Adds a custom method to a test helper. This is used to add support for
+    # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
+    # following parameters:
+    # - name: the name of the custom method to create (as a symbol)
+    # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
+    # - http_path: the path to append to the resource's URL. If not provided,
+    #              the name is used as the path
+    #
+    # For example, this call:
+    #     custom_method :capture, http_verb: post
+    # adds a `capture` class method to the resource class that, when called,
+    # will send a POST request to `/v1/<object_name>/capture`.
+    def self.custom_method(name, http_verb:, http_path: nil)
+      Util.custom_method resource_class, self, name, http_verb, http_path
+    end
+
+    def self.resource_url
+      "/v1/test_helpers/" \
+        "#{resource_class.object_name.downcase.tr('.', '/')}s"
+    end
+
+    def resource_url
+      unless (id = @resource["id"])
+        raise InvalidRequestError.new(
+          "Could not determine which URL to request: #{self.class} instance " \
+          "has invalid ID: #{id.inspect}",
+          "id"
+        )
+      end
+      "#{self.class.resource_url}/#{CGI.escape(id)}"
+    end
+  end
+end

data/lib/stripe/{resources/usage_record.rb → api_version.rb}

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class UsageRecord < APIResource
-    OBJECT_NAME = "usage_record"
+  module ApiVersion
+    CURRENT = "2025-05-28.basil"
   end
 end

data/lib/stripe/connection_manager.rb

@@ -12,7 +12,7 @@ module Stripe
   class ConnectionManager
     # Timestamp (in seconds procured from the system's monotonic clock)
     # indicating when the connection manager last made a request. This is used
-    # by `StripeClient` to determine whether a connection manager should be
+    # by `APIRequestor` to determine whether a connection manager should be
     # garbage collected or not.
     attr_reader :last_used
     attr_reader :config
@@ -36,9 +36,7 @@ module Stripe
     # clears them from internal tracking.
     def clear
       @mutex.synchronize do
-        @active_connections.each do |_, connection|
-          connection.finish
-        end
+        @active_connections.each_value(&:finish)
         @active_connections = {}
       end
     end
@@ -103,13 +101,34 @@ module Stripe
         headers
       )
 
-      @mutex.synchronize do
+      Util.log_debug("ConnectionManager starting request",
+                     method_name: method_name,
+                     path: path,
+                     process_id: Process.pid,
+                     thread_object_id: Thread.current.object_id,
+                     connection_manager_object_id: object_id,
+                     connection_object_id: connection.object_id,
+                     log_timestamp: Util.monotonic_time)
+
+      resp = @mutex.synchronize do
         # The block parameter is special here. If a block is provided, the block
         # is invoked with the Net::HTTPResponse. However, the body will not have
         # been read yet in the block, and can be streamed by calling
         # HTTPResponse#read_body.
         connection.request(request, body, &block)
       end
+
+      Util.log_debug("ConnectionManager request complete",
+                     method_name: method_name,
+                     path: path,
+                     process_id: Process.pid,
+                     thread_object_id: Thread.current.object_id,
+                     connection_manager_object_id: object_id,
+                     connection_object_id: connection.object_id,
+                     response_object_id: resp.object_id,
+                     log_timestamp: Util.monotonic_time)
+
+      resp
     end
 
     #
@@ -136,9 +155,7 @@ module Stripe
 
       connection.open_timeout = config.open_timeout
       connection.read_timeout = config.read_timeout
-      if connection.respond_to?(:write_timeout=)
-        connection.write_timeout = config.write_timeout
-      end
+      connection.write_timeout = config.write_timeout if connection.respond_to?(:write_timeout=)
 
       connection.use_ssl = uri.scheme == "https"
 
@@ -171,9 +188,9 @@ module Stripe
 
       @verify_ssl_warned = true
       warn("WARNING: Running without SSL cert verification. " \
-        "You should never do this in production. " \
-        "Execute `Stripe.verify_ssl_certs = true` to enable " \
-        "verification.")
+           "You should never do this in production. " \
+           "Execute `Stripe.verify_ssl_certs = true` to enable " \
+           "verification.")
     end
   end
 end

data/lib/stripe/errors.rb

@@ -4,22 +4,14 @@ module Stripe
   # StripeError is the base error from which all other more specific Stripe
   # errors derive.
   class StripeError < StandardError
-    attr_reader :message
+    attr_reader :message, :code, :error, :http_body, :http_headers, :http_status, :json_body, :request_id
 
     # Response contains a StripeResponse object that has some basic information
     # about the response that conveyed the error.
-    attr_accessor :response
-
-    attr_reader :code
-    attr_reader :error
-    attr_reader :http_body
-    attr_reader :http_headers
-    attr_reader :http_status
-    attr_reader :json_body # equivalent to #data
-    attr_reader :request_id
+    attr_accessor :response # equivalent to #data
 
     # Initializes a StripeError.
-    def initialize(message = nil, http_status: nil, http_body: nil,
+    def initialize(message = nil, http_status: nil, http_body: nil, # rubocop:todo Lint/MissingSuper
                    json_body: nil, http_headers: nil, code: nil)
       @message = message
       @http_status = http_status
@@ -35,14 +27,8 @@ module Stripe
     def construct_error_object
       return nil if @json_body.nil? || !@json_body.key?(:error)
 
-      ErrorObject.construct_from(@json_body[:error])
-    end
-
-    # Whether the error was the result of an idempotent replay, meaning that it
-    # originally occurred on a previous request and is being replayed back
-    # because the user sent the same idempotency key for this one.
-    def idempotent_replayed?
-      @idempotent_replayed
+      # ErrorObject is shared between v1 and v2, so use original object_classes to find
+      ErrorObject.construct_from(@json_body[:error], {}, nil, :v1)
     end
 
     def to_s
@@ -138,7 +124,7 @@ module Stripe
       def construct_error_object
         return nil if @json_body.nil?
 
-        OAuthErrorObject.construct_from(@json_body)
+        OAuthErrorObject.construct_from(@json_body, {}, nil, :v1)
       end
     end
 
@@ -174,4 +160,9 @@ module Stripe
     class UnsupportedResponseTypeError < OAuthError
     end
   end
+
+  # class definitions: The beginning of the section generated from our OpenAPI spec
+  class TemporarySessionExpiredError < StripeError
+  end
+  # class definitions: The end of the section generated from our OpenAPI spec
 end

data/lib/stripe/event_types.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Stripe
+  module EventTypes
+    def self.thin_event_names_to_classes
+      {
+        # The beginning of the section generated from our OpenAPI spec
+        V1BillingMeterErrorReportTriggeredEvent.lookup_type => V1BillingMeterErrorReportTriggeredEvent,
+        V1BillingMeterNoMeterFoundEvent.lookup_type => V1BillingMeterNoMeterFoundEvent,
+        V2CoreEventDestinationPingEvent.lookup_type => V2CoreEventDestinationPingEvent,
+        # The end of the section generated from our OpenAPI spec
+      }
+    end
+  end
+end

data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Occurs when a Meter has invalid async usage events.
+  class V1BillingMeterErrorReportTriggeredEvent < Stripe::V2::Event
+    def self.lookup_type
+      "v1.billing.meter.error_report_triggered"
+    end
+    # There is additional data present for this event, accessible with the `data` property.
+    # See the Stripe API docs for more information.
+
+    # Retrieves the related object from the API. Make an API request on every call.
+    def fetch_related_object
+      _request(
+        method: :get,
+        path: related_object.url,
+        base_address: :api,
+        opts: { stripe_account: context }
+      )
+    end
+  end
+end

data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Occurs when a Meter's id is missing or invalid in async usage events.
+  class V1BillingMeterNoMeterFoundEvent < Stripe::V2::Event
+    def self.lookup_type
+      "v1.billing.meter.no_meter_found"
+    end
+    # There is additional data present for this event, accessible with the `data` property.
+    # See the Stripe API docs for more information.
+  end
+end

data/lib/stripe/events/v2_core_event_destination_ping_event.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A ping event used to test the connection to an event destination.
+  class V2CoreEventDestinationPingEvent < Stripe::V2::Event
+    def self.lookup_type
+      "v2.core.event_destination.ping"
+    end
+
+    # Retrieves the related object from the API. Make an API request on every call.
+    def fetch_related_object
+      _request(
+        method: :get,
+        path: related_object.url,
+        base_address: :api,
+        opts: { stripe_account: context }
+      )
+    end
+  end
+end

data/lib/stripe/instrumentation.rb

@@ -4,8 +4,7 @@ module Stripe
   class Instrumentation
     # Event emitted on `request_begin` callback.
     class RequestBeginEvent
-      attr_reader :method
-      attr_reader :path
+      attr_reader :method, :path
 
       # Arbitrary user-provided data in the form of a Ruby hash that's passed
       # from subscribers on `request_begin` to subscribers on `request_end`.
@@ -27,12 +26,8 @@ module Stripe
 
     # Event emitted on `request_end` callback.
     class RequestEndEvent
-      attr_reader :duration
-      attr_reader :http_status
-      attr_reader :method
-      attr_reader :num_retries
-      attr_reader :path
-      attr_reader :request_id
+      attr_reader :duration, :http_status, :method, :num_retries, :path, :request_id, :response_header, :response_body,
+                  :request_header, :request_body
 
       # Arbitrary user-provided data in the form of a Ruby hash that's passed
       # from subscribers on `request_begin` to subscribers on `request_end`.
@@ -40,19 +35,46 @@ module Stripe
       # in `request_end`.
       attr_reader :user_data
 
-      def initialize(duration:, http_status:, method:, num_retries:, path:,
-                     request_id:, user_data: nil)
-        @duration = duration
-        @http_status = http_status
-        @method = method
+      def initialize(request_context:, response_context:,
+                     num_retries:, user_data: nil)
+        @duration = request_context.duration
+        @http_status = response_context.http_status
+        @method = request_context.method
         @num_retries = num_retries
-        @path = path
-        @request_id = request_id
+        @path = request_context.path
+        @request_id = request_context.request_id
         @user_data = user_data
+        @response_header = response_context.header
+        @response_body = response_context.body
+        @request_header = request_context.header
+        @request_body = request_context.body
         freeze
       end
     end
 
+    class RequestContext
+      attr_reader :duration, :method, :path, :request_id, :body, :header
+
+      def initialize(duration:, context:, header:)
+        @duration = duration
+        @method = context.method
+        @path = context.path
+        @request_id = context.request_id
+        @body = context.body
+        @header = header
+      end
+    end
+
+    class ResponseContext
+      attr_reader :http_status, :body, :header
+
+      def initialize(http_status:, response:)
+        @http_status = http_status
+        @header = response ? response.to_hash : nil
+        @body = response ? response.body : nil
+      end
+    end
+
     # This class was renamed for consistency. This alias is here for backwards
     # compatibility.
     RequestEvent = RequestEndEvent

data/lib/stripe/list_object.rb

@@ -8,6 +8,9 @@ module Stripe
     include Stripe::APIOperations::Create
 
     OBJECT_NAME = "list"
+    def self.object_name
+      "list"
+    end
 
     # This accessor allows a `ListObject` to inherit various filters that were
     # given to a predecessor. This allows for things like consistent limits,
@@ -18,7 +21,7 @@ module Stripe
     # there isn't a next page in order to replicate the behavior of the API
     # when it attempts to return a page beyond the last.
     def self.empty_list(opts = {})
-      ListObject.construct_from({ data: [] }, opts)
+      ListObject.construct_from({ data: [] }, opts, nil, :v1)
     end
 
     def initialize(*args)
@@ -93,8 +96,7 @@ module Stripe
     def retrieve(id, opts = {})
       id, retrieve_params = Util.normalize_id(id)
       url = "#{resource_url}/#{CGI.escape(id)}"
-      resp, opts = execute_resource_request(:get, url, retrieve_params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      execute_resource_request(:get, url, :api, retrieve_params, opts)
     end
 
     # Fetches the next page in the resource list (if there is one).

data/lib/stripe/multipart_encoder.rb

@@ -106,22 +106,22 @@ module Stripe
     end
 
     private def write_field(name, data, filename:)
-      if !@first_field
-        @body << "\r\n"
-      else
+      if @first_field
         @first_field = false
+      else
+        @body << "\r\n"
       end
 
       @body << "--#{@boundary}\r\n"
 
       if filename
-        @body << %(Content-Disposition: form-data) +
+        @body << (%(Content-Disposition: form-data) +
                  %(; name="#{escape(name.to_s)}") +
-                 %(; filename="#{escape(filename)}"\r\n)
+                 %(; filename="#{escape(filename)}"\r\n))
         @body << %(Content-Type: application/octet-stream\r\n)
       else
-        @body << %(Content-Disposition: form-data) +
-                 %(; name="#{escape(name.to_s)}"\r\n)
+        @body << (%(Content-Disposition: form-data) +
+                 %(; name="#{escape(name.to_s)}"\r\n))
       end
 
       @body << "\r\n"

data/lib/stripe/oauth.rb

@@ -5,12 +5,10 @@ module Stripe
     module OAuthOperations
       extend APIOperations::Request::ClassMethods
 
-      def self.execute_resource_request(method, url, params, opts)
+      def self.execute_resource_request(method, url, base_address, params, opts)
         opts = Util.normalize_opts(opts)
-        opts[:client] ||= opts[:client] || StripeClient.active_client
-        opts[:api_base] ||= opts[:client].config.connect_base
 
-        super(method, url, params, opts)
+        super
       end
     end
 
@@ -18,26 +16,25 @@ module Stripe
       client_id = params[:client_id] || Stripe.client_id
       unless client_id
         raise AuthenticationError, "No client_id provided. " \
-          'Set your client_id using "Stripe.client_id = <CLIENT-ID>". ' \
-          "You can find your client_ids in your Stripe dashboard at " \
-          "https://dashboard.stripe.com/account/applications/settings, " \
-          "after registering your account as a platform. See " \
-          "https://stripe.com/docs/connect/standalone-accounts for details, " \
-          "or email support@stripe.com if you have any questions."
+                                   'Set your client_id using "Stripe.client_id = <CLIENT-ID>". ' \
+                                   "You can find your client_ids in your Stripe dashboard at " \
+                                   "https://dashboard.stripe.com/account/applications/settings, " \
+                                   "after registering your account as a platform. See " \
+                                   "https://stripe.com/docs/connect/standalone-accounts for details, " \
+                                   "or email support@stripe.com if you have any questions."
       end
       client_id
     end
 
     def self.authorize_url(params = {}, opts = {})
-      client = opts[:client] || StripeClient.active_client
-      base = opts[:connect_base] || client.config.connect_base
+      base = opts[:connect_base] || APIRequestor.active_requestor.config.connect_base
 
       path = "/oauth/authorize"
       path = "/express" + path if opts[:express]
 
       params[:client_id] = get_client_id(params)
       params[:response_type] ||= "code"
-      query = Util.encode_parameters(params)
+      query = Util.encode_parameters(params, :v1)
 
       "#{base}#{path}?#{query}"
     end
@@ -45,21 +42,17 @@ module Stripe
     def self.token(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
       opts[:api_key] = params[:client_secret] if params[:client_secret]
-      resp, opts = OAuthOperations.execute_resource_request(
-        :post, "/oauth/token", params, opts
+      OAuthOperations.execute_resource_request(
+        :post, "/oauth/token", :connect, params, opts
       )
-      # This is just going to return a generic StripeObject, but that's okay
-      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     def self.deauthorize(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
       params[:client_id] = get_client_id(params)
-      resp, opts = OAuthOperations.execute_resource_request(
-        :post, "/oauth/deauthorize", params, opts
+      OAuthOperations.execute_resource_request(
+        :post, "/oauth/deauthorize", :connect, params, opts
       )
-      # This is just going to return a generic StripeObject, but that's okay
-      Util.convert_to_stripe_object(resp.data, opts)
     end
   end
 end