stripe 5.28.0 → 8.7.0

data/lib/stripe/api_operations/create.rb

@@ -4,8 +4,12 @@ module Stripe
   module APIOperations
     module Create
       def create(params = {}, opts = {})
-        resp, opts = execute_resource_request(:post, resource_url, params, opts)
-        Util.convert_to_stripe_object(resp.data, opts)
+        request_stripe_object(
+          method: :post,
+          path: resource_url,
+          params: params,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_operations/delete.rb

@@ -18,17 +18,22 @@ module Stripe
         #   api_key to be overwritten. See
         #   {APIOperations::Request.execute_resource_request}.
         def delete(id, params = {}, opts = {})
-          resp, opts = execute_resource_request(:delete,
-                                                "#{resource_url}/#{id}",
-                                                params, opts)
-          Util.convert_to_stripe_object(resp.data, opts)
+          request_stripe_object(
+            method: :delete,
+            path: "#{resource_url}/#{id}",
+            params: params,
+            opts: opts
+          )
         end
       end
 
       def delete(params = {}, opts = {})
-        resp, opts = execute_resource_request(:delete, resource_url,
-                                              params, opts)
-        initialize_from(resp.data, opts)
+        request_stripe_object(
+          method: :delete,
+          path: resource_url,
+          params: params,
+          opts: opts
+        )
       end
 
       def self.included(base)

data/lib/stripe/api_operations/list.rb

@@ -4,15 +4,12 @@ module Stripe
   module APIOperations
     module List
       def list(filters = {}, opts = {})
-        opts = Util.normalize_opts(opts)
-
-        resp, opts = execute_resource_request(:get, resource_url, filters, opts)
-        obj = ListObject.construct_from(resp.data, opts)
-
-        # set filters so that we can fetch the same limit, expansions, and
-        # predicates when accessing the next and previous pages
-        obj.filters = filters.dup
-        obj
+        request_stripe_object(
+          method: :get,
+          path: resource_url,
+          params: filters,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_operations/nested_resource.rb

@@ -26,46 +26,74 @@ module Stripe
         end
 
         operations.each do |operation|
-          case operation
-          when :create
-            define_singleton_method(:"create_#{resource}") \
+          define_operation(
+            resource,
+            operation,
+            resource_url_method,
+            resource_plural
+          )
+        end
+      end
+
+      private def define_operation(
+        resource,
+        operation,
+        resource_url_method,
+        resource_plural
+      )
+        case operation
+        when :create
+          define_singleton_method(:"create_#{resource}") \
               do |id, params = {}, opts = {}|
-                url = send(resource_url_method, id)
-                resp, opts = execute_resource_request(:post, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :retrieve
-            define_singleton_method(:"retrieve_#{resource}") \
+            request_stripe_object(
+              method: :post,
+              path: send(resource_url_method, id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :retrieve
+          define_singleton_method(:"retrieve_#{resource}") \
               do |id, nested_id, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:get, url, {}, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :update
-            define_singleton_method(:"update_#{resource}") \
+            request_stripe_object(
+              method: :get,
+              path: send(resource_url_method, id, nested_id),
+              params: {},
+              opts: opts
+            )
+          end
+        when :update
+          define_singleton_method(:"update_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:post, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :delete
-            define_singleton_method(:"delete_#{resource}") \
+            request_stripe_object(
+              method: :post,
+              path: send(resource_url_method, id, nested_id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :delete
+          define_singleton_method(:"delete_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:delete, url, params,
-                                                      opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :list
-            define_singleton_method(:"list_#{resource_plural}") \
+            request_stripe_object(
+              method: :delete,
+              path: send(resource_url_method, id, nested_id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :list
+          define_singleton_method(:"list_#{resource_plural}") \
               do |id, params = {}, opts = {}|
-                url = send(resource_url_method, id)
-                resp, opts = execute_resource_request(:get, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          else
-            raise ArgumentError, "Unknown operation: #{operation.inspect}"
+            request_stripe_object(
+              method: :get,
+              path: send(resource_url_method, id),
+              params: params,
+              opts: opts
+            )
           end
+        else
+          raise ArgumentError, "Unknown operation: #{operation.inspect}"
         end
       end
     end

data/lib/stripe/api_operations/request.rb

@@ -6,6 +6,33 @@ module Stripe
       module ClassMethods
         def execute_resource_request(method, url,
                                      params = {}, opts = {})
+          execute_resource_request_internal(
+            :execute_request, method, url, params, opts
+          )
+        end
+
+        def execute_resource_request_stream(method, url,
+                                            params = {}, opts = {},
+                                            &read_body_chunk_block)
+          execute_resource_request_internal(
+            :execute_request_stream,
+            method,
+            url,
+            params,
+            opts,
+            &read_body_chunk_block
+          )
+        end
+
+        private def request_stripe_object(method:, path:, params:, opts: {})
+          resp, opts = execute_resource_request(method, path, params, opts)
+          Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+        end
+
+        private def execute_resource_request_internal(client_request_method_sym,
+                                                      method, url,
+                                                      params, opts,
+                                                      &read_body_chunk_block)
           params ||= {}
 
           error_on_invalid_params(params)
@@ -22,10 +49,12 @@ module Stripe
           client = headers.delete(:client)
           # Assume all remaining opts must be headers
 
-          resp, opts[:api_key] = client.execute_request(
+          resp, opts[:api_key] = client.send(
+            client_request_method_sym,
             method, url,
             api_base: api_base, api_key: api_key,
-            headers: headers, params: params
+            headers: headers, params: params,
+            &read_body_chunk_block
           )
 
           # Hash#select returns an array before 1.9
@@ -89,6 +118,20 @@ module Stripe
         self.class.execute_resource_request(method, url, params, opts)
       end
 
+      protected def execute_resource_request_stream(method, url,
+                                                    params = {}, opts = {},
+                                                    &read_body_chunk_block)
+        opts = @opts.merge(Util.normalize_opts(opts))
+        self.class.execute_resource_request_stream(
+          method, url, params, opts, &read_body_chunk_block
+        )
+      end
+
+      private def request_stripe_object(method:, path:, params:, opts: {})
+        resp, opts = execute_resource_request(method, path, params, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+      end
+
       # See notes on `alias` above.
       alias request execute_resource_request
     end

data/lib/stripe/api_operations/save.rb

@@ -24,12 +24,18 @@ module Stripe
             end
           end
 
-          resp, opts = execute_resource_request(:post, "#{resource_url}/#{id}",
-                                                params, opts)
-          Util.convert_to_stripe_object(resp.data, opts)
+          request_stripe_object(
+            method: :post,
+            path: "#{resource_url}/#{id}",
+            params: params,
+            opts: opts
+          )
         end
       end
 
+      # The `save` method is DEPRECATED and will be removed in a future major
+      # version of the library. Use the `update` method on the resource instead.
+      #
       # Creates or updates an API resource.
       #
       # If the resource doesn't yet have an assigned ID and the resource is one
@@ -65,6 +71,10 @@ module Stripe
         resp, opts = execute_resource_request(:post, save_url, values, opts)
         initialize_from(resp.data, opts)
       end
+      extend Gem::Deprecate
+      deprecate :save, "the `update` class method (for examples"\
+                " see https://github.com/stripe/stripe-ruby"\
+                "/wiki/Migration-guide-for-v8)", 2022, 11
 
       def self.included(base)
         # Set `metadata` as additive so that when it's set directly we remember

data/lib/stripe/api_operations/search.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Stripe
+  module APIOperations
+    module Search
+      def _search(search_url, filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: search_url,
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/api_resource.rb

@@ -63,22 +63,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
@@ -105,15 +90,23 @@ module Stripe
       instance
     end
 
-    protected def request_stripe_object(method:, path:, params:, opts: {})
+    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)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
       end
     end
+
+    protected def request_stream(method:, path:, params:, opts: {},
+                                 &read_body_chunk_block)
+      resp, = execute_resource_request_stream(
+        method, path, params, opts, &read_body_chunk_block
+      )
+      resp
+    end
   end
 end

data/lib/stripe/api_resource_test_helpers.rb

@@ -0,0 +1,49 @@
+# 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
+
+    # 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 self::RESOURCE_CLASS, self, name, http_verb, http_path
+    end
+
+    def self.resource_url
+      "/v1/test_helpers/"\
+      "#{self::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/api_version.rb

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ApiVersion
+    CURRENT = "2022-11-15"
+  end
+end

data/lib/stripe/connection_manager.rb

@@ -15,8 +15,10 @@ module Stripe
     # by `StripeClient` to determine whether a connection manager should be
     # garbage collected or not.
     attr_reader :last_used
+    attr_reader :config
 
-    def initialize
+    def initialize(config = Stripe.config)
+      @config = config
       @active_connections = {}
       @last_used = Util.monotonic_time
 
@@ -64,7 +66,8 @@ module Stripe
 
     # Executes an HTTP request to the given URI with the given method. Also
     # allows a request body, headers, and query string to be specified.
-    def execute_request(method, uri, body: nil, headers: nil, query: nil)
+    def execute_request(method, uri, body: nil, headers: nil, query: nil,
+                        &block)
       # Perform some basic argument validation because it's easy to get
       # confused between strings and hashes for things like body and query
       # parameters.
@@ -90,9 +93,44 @@ module Stripe
                u.path
              end
 
-      @mutex.synchronize do
-        connection.send_request(method.to_s.upcase, path, body, headers)
+      method_name = method.to_s.upcase
+      has_response_body = method_name != "HEAD"
+      request = Net::HTTPGenericRequest.new(
+        method_name,
+        (body ? true : false),
+        has_response_body,
+        path,
+        headers
+      )
+
+      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
 
     #
@@ -117,17 +155,17 @@ module Stripe
       # reused Go's default for `DefaultTransport`.
       connection.keep_alive_timeout = 30
 
-      connection.open_timeout = Stripe.open_timeout
-      connection.read_timeout = Stripe.read_timeout
+      connection.open_timeout = config.open_timeout
+      connection.read_timeout = config.read_timeout
       if connection.respond_to?(:write_timeout=)
-        connection.write_timeout = Stripe.write_timeout
+        connection.write_timeout = config.write_timeout
       end
 
       connection.use_ssl = uri.scheme == "https"
 
-      if Stripe.verify_ssl_certs
+      if config.verify_ssl_certs
         connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        connection.cert_store = Stripe.ca_store
+        connection.cert_store = config.ca_store
       else
         connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
         warn_ssl_verify_none
@@ -141,10 +179,10 @@ module Stripe
     # out those pieces to make passing them into a new connection a little less
     # ugly.
     private def proxy_parts
-      if Stripe.proxy.nil?
+      if config.proxy.nil?
         [nil, nil, nil, nil]
       else
-        u = URI.parse(Stripe.proxy)
+        u = URI.parse(config.proxy)
         [u.host, u.port, u.user, u.password]
       end
     end

data/lib/stripe/error_object.rb

@@ -69,9 +69,8 @@ module Stripe
       @values[:source]
     end
 
-    # The type of error returned. One of `api_connection_error`, `api_error`,
-    # `authentication_error`, `card_error`, `idempotency_error`,
-    # `invalid_request_error`, or `rate_limit_error`.
+    # The type of error returned. One of `api_error`, `card_error`,
+    # `idempotency_error`, or `invalid_request_error`.
     def type
       @values[:type]
     end

data/lib/stripe/instrumentation.rb

@@ -32,6 +32,11 @@ module Stripe
       attr_reader :method
       attr_reader :num_retries
       attr_reader :path
+      attr_reader :request_id
+      attr_reader :response_header
+      attr_reader :response_body
+      attr_reader :request_header
+      attr_reader :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`.
@@ -39,18 +44,53 @@ module Stripe
       # in `request_end`.
       attr_reader :user_data
 
-      def initialize(duration:, http_status:, method:, num_retries:, path:,
-                     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
+        @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
+      attr_reader :method
+      attr_reader :path
+      attr_reader :request_id
+      attr_reader :body
+      attr_reader :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
+      attr_reader :body
+      attr_reader :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/oauth.rb

@@ -7,8 +7,8 @@ module Stripe
 
       def self.execute_resource_request(method, url, params, opts)
         opts = Util.normalize_opts(opts)
-        opts[:client] ||= StripeClient.active_client
-        opts[:api_base] ||= Stripe.connect_base
+        opts[:client] ||= opts[:client] || StripeClient.active_client
+        opts[:api_base] ||= opts[:client].config.connect_base
 
         super(method, url, params, opts)
       end
@@ -29,7 +29,8 @@ module Stripe
     end
 
     def self.authorize_url(params = {}, opts = {})
-      base = opts[:connect_base] || Stripe.connect_base
+      client = opts[:client] || StripeClient.active_client
+      base = opts[:connect_base] || client.config.connect_base
 
       path = "/oauth/authorize"
       path = "/express" + path if opts[:express]