stripe 5.38.0 → 6.0.0

data/lib/stripe/resources/payment_intent.rb

@@ -5,13 +5,26 @@ module Stripe
   class PaymentIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "payment_intent"
 
+    custom_method :apply_customer_balance, http_verb: :post
     custom_method :cancel, http_verb: :post
     custom_method :capture, http_verb: :post
     custom_method :confirm, http_verb: :post
+    custom_method :increment_authorization, http_verb: :post
+    custom_method :verify_microdeposits, http_verb: :post
+
+    def apply_customer_balance(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/apply_customer_balance",
+        params: params,
+        opts: opts
+      )
+    end
 
     def cancel(params = {}, opts = {})
       request_stripe_object(
@@ -39,5 +52,31 @@ module Stripe
         opts: opts
       )
     end
+
+    def increment_authorization(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/increment_authorization",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def verify_microdeposits(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/verify_microdeposits",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/payment_intents/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/payment_link.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentLink < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "payment_link"
+
+    custom_method :list_line_items, http_verb: :get, http_path: "line_items"
+
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/line_items",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/price.rb

@@ -5,8 +5,17 @@ module Stripe
   class Price < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "price"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/prices/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/product.rb

@@ -6,8 +6,17 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "product"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/products/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/refund.rb

@@ -8,5 +8,35 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "refund"
+
+    custom_method :cancel, http_verb: :post
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Refund
+
+      custom_method :expire, http_verb: :post
+
+      def expire(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: resource_url + "/expire",
+          params: params,
+          opts: opts
+        )
+      end
+    end
   end
 end

data/lib/stripe/resources/setup_intent.rb

@@ -11,6 +11,7 @@ module Stripe
 
     custom_method :cancel, http_verb: :post
     custom_method :confirm, http_verb: :post
+    custom_method :verify_microdeposits, http_verb: :post
 
     def cancel(params = {}, opts = {})
       request_stripe_object(
@@ -29,5 +30,14 @@ module Stripe
         opts: opts
       )
     end
+
+    def verify_microdeposits(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/verify_microdeposits",
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/shipping_rate.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ShippingRate < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "shipping_rate"
+  end
+end

data/lib/stripe/resources/source_transaction.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/subscription.rb

@@ -6,6 +6,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "subscription"
@@ -22,5 +23,13 @@ module Stripe
     end
 
     save_nested_resource :source
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/subscriptions/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/terminal/configuration.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "terminal.configuration"
+    end
+  end
+end

data/lib/stripe/resources/terminal/reader.rb

@@ -10,6 +10,66 @@ module Stripe
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "terminal.reader"
+
+      custom_method :cancel_action, http_verb: :post
+      custom_method :process_payment_intent, http_verb: :post
+      custom_method :process_setup_intent, http_verb: :post
+      custom_method :set_reader_display, http_verb: :post
+
+      def cancel_action(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/cancel_action",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def process_payment_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/process_payment_intent",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def process_setup_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/process_setup_intent",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def set_reader_display(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/set_reader_display",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = Reader
+
+        custom_method :present_payment_method, http_verb: :post
+
+        def present_payment_method(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: resource_url + "/present_payment_method",
+            params: params,
+            opts: opts
+          )
+        end
+      end
     end
   end
 end

data/lib/stripe/resources/test_helpers/test_clock.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TestClock < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "test_helpers.test_clock"
+
+      custom_method :advance, http_verb: :post
+
+      def advance(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/advance",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources.rb

@@ -16,6 +16,7 @@ require "stripe/resources/bitcoin_receiver"
 require "stripe/resources/bitcoin_transaction"
 require "stripe/resources/capability"
 require "stripe/resources/card"
+require "stripe/resources/cash_balance"
 require "stripe/resources/charge"
 require "stripe/resources/checkout/session"
 require "stripe/resources/country_spec"
@@ -31,6 +32,11 @@ require "stripe/resources/event"
 require "stripe/resources/exchange_rate"
 require "stripe/resources/file"
 require "stripe/resources/file_link"
+require "stripe/resources/financial_connections/account"
+require "stripe/resources/financial_connections/account_owner"
+require "stripe/resources/financial_connections/account_ownership"
+require "stripe/resources/financial_connections/session"
+require "stripe/resources/funding_instructions"
 require "stripe/resources/identity/verification_report"
 require "stripe/resources/identity/verification_session"
 require "stripe/resources/invoice"
@@ -46,8 +52,8 @@ require "stripe/resources/line_item"
 require "stripe/resources/login_link"
 require "stripe/resources/mandate"
 require "stripe/resources/order"
-require "stripe/resources/order_return"
 require "stripe/resources/payment_intent"
+require "stripe/resources/payment_link"
 require "stripe/resources/payment_method"
 require "stripe/resources/payout"
 require "stripe/resources/person"
@@ -68,6 +74,7 @@ require "stripe/resources/reversal"
 require "stripe/resources/review"
 require "stripe/resources/setup_attempt"
 require "stripe/resources/setup_intent"
+require "stripe/resources/shipping_rate"
 require "stripe/resources/sigma/scheduled_query_run"
 require "stripe/resources/sku"
 require "stripe/resources/source"
@@ -78,9 +85,11 @@ require "stripe/resources/subscription_schedule"
 require "stripe/resources/tax_code"
 require "stripe/resources/tax_id"
 require "stripe/resources/tax_rate"
+require "stripe/resources/terminal/configuration"
 require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
+require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/three_d_secure"
 require "stripe/resources/token"
 require "stripe/resources/topup"

data/lib/stripe/search_result_object.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Stripe
+  class SearchResultObject < StripeObject
+    include Enumerable
+    include Stripe::APIOperations::Search
+    include Stripe::APIOperations::Request
+
+    OBJECT_NAME = "search_result"
+
+    # This accessor allows a `SearchResultObject` to inherit various filters
+    # that were given to a predecessor. This allows for things like consistent
+    # limits, expansions, and predicates as a user pages through resources.
+    attr_accessor :filters
+
+    # An empty search result object. This is returned from +next+ when we know
+    # that 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_search_result(opts = {})
+      SearchResultObject.construct_from({ data: [] }, opts)
+    end
+
+    def initialize(*args)
+      super
+      self.filters = {}
+    end
+
+    def [](key)
+      case key
+      when String, Symbol
+        super
+      else
+        raise ArgumentError,
+              "You tried to access the #{key.inspect} index, but " \
+              "SearchResultObject types only support String keys. " \
+              "(HINT: Search calls return an object with a 'data' (which is " \
+              "the data array). You likely want to call #data[#{key.inspect}])"
+      end
+    end
+
+    # Iterates through each resource in the page represented by the current
+    # `SearchListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    # Returns true if the page object contains no elements.
+    def empty?
+      data.empty?
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_search_result_page+.
+    def auto_paging_each(&blk)
+      return enum_for(:auto_paging_each) unless block_given?
+
+      page = self
+
+      loop do
+        page.each(&blk)
+        page = page.next_search_result_page
+
+        break if page.empty?
+      end
+    end
+
+    # Fetches the next page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def next_search_result_page(params = {}, opts = {})
+      return self.class.empty_search_result(opts) unless has_more
+
+      params = filters.merge(page: next_page).merge(params)
+
+      _search(url, params, opts)
+    end
+  end
+end

data/lib/stripe/stripe_client.rb

@@ -585,7 +585,7 @@ module Stripe
           handle_error_response(resp, context)
         end
 
-        log_response(context, request_start, http_status, resp.body)
+        log_response(context, request_start, http_status, resp.body, resp)
         notify_request_end(context, request_duration, http_status,
                            num_retries, user_data)
 
@@ -609,7 +609,7 @@ module Stripe
           error_context = context.dup_from_response_headers(e.http_headers)
           http_status = resp.code.to_i
           log_response(error_context, request_start,
-                       e.http_status, e.http_body)
+                       e.http_status, e.http_body, resp)
         else
           log_response_error(error_context, request_start, e)
         end
@@ -903,10 +903,13 @@ module Stripe
                      body: context.body,
                      idempotency_key: context.idempotency_key,
                      query: context.query,
-                     config: config)
+                     config: config,
+                     process_id: Process.pid,
+                     thread_object_id: Thread.current.object_id,
+                     log_timestamp: Util.monotonic_time)
     end
 
-    private def log_response(context, request_start, status, body)
+    private def log_response(context, request_start, status, body, resp)
       Util.log_info("Response from Stripe API",
                     account: context.account,
                     api_version: context.api_version,
@@ -921,7 +924,11 @@ module Stripe
                      body: body,
                      idempotency_key: context.idempotency_key,
                      request_id: context.request_id,
-                     config: config)
+                     config: config,
+                     process_id: Process.pid,
+                     thread_object_id: Thread.current.object_id,
+                     response_object_id: resp.object_id,
+                     log_timestamp: Util.monotonic_time)
 
       return unless context.request_id
 

data/lib/stripe/util.rb

@@ -47,6 +47,53 @@ module Stripe
       Util.object_classes[object_name] == klass
     end
 
+    # Adds a custom method to a resource class. 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
+    # - resource: the resource implementation class
+    # - target: the class that custom static method will be added to
+    #
+    # 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(resource, target, name, http_verb, http_path)
+      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
+      unless target.respond_to?(:resource_url)
+        raise ArgumentError,
+              "Invalid target value: #{target}. Target class should have a " \
+              "`resource_url` method."
+      end
+      http_path ||= name.to_s
+      target.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 = "#{target.resource_url}/"\
+              "#{CGI.escape(id)}/"\
+              "#{CGI.escape(http_path)}"
+
+        resp, opts = resource.execute_resource_request(
+          http_verb,
+          url,
+          params,
+          opts
+        )
+
+        Util.convert_to_stripe_object(resp.data, opts)
+      end
+    end
+
     # Converts a hash of fields or an array of hashes into a +StripeObject+ or
     # array of +StripeObject+s. These new objects will be created as a concrete
     # type as dictated by their `object` field (e.g. an `object` value of

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.38.0"
+  VERSION = "6.0.0"
 end

data/lib/stripe.rb

@@ -24,6 +24,7 @@ require "stripe/api_operations/list"
 require "stripe/api_operations/nested_resource"
 require "stripe/api_operations/request"
 require "stripe/api_operations/save"
+require "stripe/api_operations/search"
 
 # API resource support classes
 require "stripe/errors"
@@ -35,8 +36,10 @@ require "stripe/stripe_client"
 require "stripe/stripe_object"
 require "stripe/stripe_response"
 require "stripe/list_object"
+require "stripe/search_result_object"
 require "stripe/error_object"
 require "stripe/api_resource"
+require "stripe/api_resource_test_helpers"
 require "stripe/singleton_api_resource"
 require "stripe/webhook"
 require "stripe/stripe_configuration"
@@ -103,7 +106,7 @@ module Stripe
   # with API requests. Useful for plugin authors to identify their plugin when
   # communicating with Stripe.
   #
-  # Takes a name and optional  partner program ID, plugin URL, and version.
+  # Takes a name and optional partner program ID, plugin URL, and version.
   def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
     @app_info = {
       name: name,

data/stripe.gemspec

@@ -13,16 +13,16 @@ Gem::Specification.new do |s|
                   "See https://stripe.com for details."
   s.author = "Stripe"
   s.email = "support@stripe.com"
-  s.homepage = "https://stripe.com/docs/api/ruby"
+  s.homepage = "https://stripe.com/docs/api?lang=ruby"
   s.license = "MIT"
 
   s.metadata = {
     "bug_tracker_uri" => "https://github.com/stripe/stripe-ruby/issues",
     "changelog_uri" =>
       "https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md",
-    "documentation_uri" => "https://stripe.com/docs/api/ruby",
+    "documentation_uri" => "https://stripe.com/docs/api?lang=ruby",
     "github_repo" => "ssh://github.com/stripe/stripe-ruby",
-    "homepage_uri" => "https://stripe.com/docs/api/ruby",
+    "homepage_uri" => "https://stripe.com/docs/api?lang=ruby",
     "source_code_uri" => "https://github.com/stripe/stripe-ruby",
   }