stripe 4.24.0 → 5.36.0

data/lib/stripe/list_object.rb

@@ -7,7 +7,7 @@ module Stripe
     include Stripe::APIOperations::Request
     include Stripe::APIOperations::Create
 
-    OBJECT_NAME = "list".freeze
+    OBJECT_NAME = "list"
 
     # This accessor allows a `ListObject` to inherit various filters that were
     # given to a predecessor. This allows for things like consistent limits,
@@ -51,6 +51,16 @@ module Stripe
     # Iterates through each resource in all pages, making additional fetches to
     # the API as necessary.
     #
+    # The default iteration direction is forwards according to Stripe's API
+    # "natural" ordering direction -- newer objects first, and moving towards
+    # older objects.
+    #
+    # However, if the initial list object was fetched using an `ending_before`
+    # cursor (and only `ending_before`, `starting_after` cannot also be
+    # included), the method assumes that the user is trying to iterate
+    # backwards compared to natural ordering and returns results that way --
+    # older objects first, and moving towards newer objects.
+    #
     # 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_page+.
@@ -59,8 +69,18 @@ module Stripe
 
       page = self
       loop do
-        page.each(&blk)
-        page = page.next_page
+        # Backward iterating activates if we have an `ending_before` constraint
+        # and _just_ an `ending_before` constraint. If `starting_after` was
+        # also used, we iterate forwards normally.
+        if filters.include?(:ending_before) &&
+           !filters.include?(:starting_after)
+          page.reverse_each(&blk)
+          page = page.previous_page
+        else
+          page.each(&blk)
+          page = page.next_page
+        end
+
         break if page.empty?
       end
     end
@@ -72,8 +92,8 @@ module Stripe
 
     def retrieve(id, opts = {})
       id, retrieve_params = Util.normalize_id(id)
-      resp, opts = request(:get, "#{resource_url}/#{CGI.escape(id)}",
-                           retrieve_params, opts)
+      url = "#{resource_url}/#{CGI.escape(id)}"
+      resp, opts = execute_resource_request(:get, url, retrieve_params, opts)
       Util.convert_to_stripe_object(resp.data, opts)
     end
 
@@ -83,6 +103,7 @@ module Stripe
     # was given, the default limit will be fetched again.
     def next_page(params = {}, opts = {})
       return self.class.empty_list(opts) unless has_more
+
       last_id = data.last.id
 
       params = filters.merge(starting_after: last_id).merge(params)
@@ -95,6 +116,8 @@ module Stripe
     # This method will try to respect the limit of the current page. If none
     # was given, the default limit will be fetched again.
     def previous_page(params = {}, opts = {})
+      return self.class.empty_list(opts) unless has_more
+
       first_id = data.first.id
 
       params = filters.merge(ending_before: first_id).merge(params)
@@ -106,5 +129,11 @@ module Stripe
       url ||
         raise(ArgumentError, "List object does not contain a 'url' field.")
     end
+
+    # Iterates through each resource in the page represented by the current
+    # `ListObject` in reverse.
+    def reverse_each(&blk)
+      data.reverse_each(&blk)
+    end
   end
 end

data/lib/stripe/multipart_encoder.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "tempfile"
+
+module Stripe
+  # Encodes parameters into a `multipart/form-data` payload as described by RFC
+  # 2388:
+  #
+  #     https://tools.ietf.org/html/rfc2388
+  #
+  # This is most useful for transferring file-like objects.
+  #
+  # Parameters should be added with `#encode`. When ready, use `#body` to get
+  # the encoded result and `#content_type` to get the value that should be
+  # placed in the `Content-Type` header of a subsequent request (which includes
+  # a boundary value).
+  class MultipartEncoder
+    MULTIPART_FORM_DATA = "multipart/form-data"
+
+    # A shortcut for encoding a single set of parameters and finalizing a
+    # result.
+    #
+    # Returns an encoded body and the value that should be set in the content
+    # type header of a subsequent request.
+    def self.encode(params)
+      encoder = MultipartEncoder.new
+      encoder.encode(params)
+      encoder.close
+      [encoder.body, encoder.content_type]
+    end
+
+    # Gets the object's randomly generated boundary string.
+    attr_reader :boundary
+
+    # Initializes a new multipart encoder.
+    def initialize
+      # Kind of weird, but required by Rubocop because the unary plus operator
+      # is considered faster than `Stripe.new`.
+      @body = +""
+
+      # Chose the same number of random bytes that Go uses in its standard
+      # library implementation. Easily enough entropy to ensure that it won't
+      # be present in a file we're sending.
+      @boundary = SecureRandom.hex(30)
+
+      @closed = false
+      @first_field = true
+    end
+
+    # Gets the encoded body. `#close` must be called first.
+    def body
+      raise "object must be closed before getting body" unless @closed
+
+      @body
+    end
+
+    # Finalizes the object by writing the final boundary.
+    def close
+      raise "object already closed" if @closed
+
+      @body << "\r\n"
+      @body << "--#{@boundary}--"
+
+      @closed = true
+
+      nil
+    end
+
+    # Gets the value including boundary that should be put into a multipart
+    # request's `Content-Type`.
+    def content_type
+      "#{MULTIPART_FORM_DATA}; boundary=#{@boundary}"
+    end
+
+    # Encodes a set of parameters to the body.
+    #
+    # Note that parameters are expected to be a hash, but a "flat" hash such
+    # that complex substructures like hashes and arrays have already been
+    # appropriately Stripe-encoded. Pass a complex structure through
+    # `Util.flatten_params` first before handing it off to this method.
+    def encode(params)
+      raise "no more parameters can be written to closed object" if @closed
+
+      params.each do |name, val|
+        if val.is_a?(::File) || val.is_a?(::Tempfile)
+          write_field(name, val.read, filename: ::File.basename(val.path))
+        elsif val.respond_to?(:read)
+          write_field(name, val.read, filename: "blob")
+        else
+          write_field(name, val, filename: nil)
+        end
+      end
+
+      nil
+    end
+
+    #
+    # private
+    #
+
+    # Escapes double quotes so that the given value can be used in a
+    # double-quoted string and replaces any linebreak characters with spaces.
+    private def escape(str)
+      str.gsub('"', "%22").tr("\n", " ").tr("\r", " ")
+    end
+
+    private def write_field(name, data, filename:)
+      if !@first_field
+        @body << "\r\n"
+      else
+        @first_field = false
+      end
+
+      @body << "--#{@boundary}\r\n"
+
+      if filename
+        @body << %(Content-Disposition: form-data) +
+                 %(; name="#{escape(name.to_s)}") +
+                 %(; 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)
+      end
+
+      @body << "\r\n"
+      @body << data.to_s
+    end
+  end
+end

data/lib/stripe/oauth.rb

@@ -5,10 +5,10 @@ module Stripe
     module OAuthOperations
       extend APIOperations::Request::ClassMethods
 
-      def self.request(method, url, params, opts)
+      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]
@@ -43,7 +44,8 @@ module Stripe
 
     def self.token(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
-      resp, opts = OAuthOperations.request(
+      opts[:api_key] = params[:client_secret] if params[:client_secret]
+      resp, opts = OAuthOperations.execute_resource_request(
         :post, "/oauth/token", params, opts
       )
       # This is just going to return a generic StripeObject, but that's okay
@@ -53,7 +55,7 @@ module Stripe
     def self.deauthorize(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
       params[:client_id] = get_client_id(params)
-      resp, opts = OAuthOperations.request(
+      resp, opts = OAuthOperations.execute_resource_request(
         :post, "/oauth/deauthorize", params, opts
       )
       # This is just going to return a generic StripeObject, but that's okay

data/lib/stripe/object_types.rb

@@ -19,6 +19,8 @@ module Stripe
         Balance::OBJECT_NAME => Balance,
         BalanceTransaction::OBJECT_NAME => BalanceTransaction,
         BankAccount::OBJECT_NAME => BankAccount,
+        BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
+        BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
         BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
         BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
         Capability::OBJECT_NAME => Capability,
@@ -28,6 +30,7 @@ module Stripe
         CountrySpec::OBJECT_NAME => CountrySpec,
         Coupon::OBJECT_NAME => Coupon,
         CreditNote::OBJECT_NAME => CreditNote,
+        CreditNoteLineItem::OBJECT_NAME => CreditNoteLineItem,
         Customer::OBJECT_NAME => Customer,
         CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
         Discount::OBJECT_NAME => Discount,
@@ -38,17 +41,20 @@ module Stripe
         File::OBJECT_NAME => File,
         File::OBJECT_NAME_ALT => File,
         FileLink::OBJECT_NAME => FileLink,
+        Identity::VerificationReport::OBJECT_NAME => Identity::VerificationReport,
+        Identity::VerificationSession::OBJECT_NAME => Identity::VerificationSession,
         Invoice::OBJECT_NAME => Invoice,
         InvoiceItem::OBJECT_NAME => InvoiceItem,
         InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
-        IssuerFraudRecord::OBJECT_NAME => IssuerFraudRecord,
         Issuing::Authorization::OBJECT_NAME => Issuing::Authorization,
         Issuing::Card::OBJECT_NAME => Issuing::Card,
         Issuing::CardDetails::OBJECT_NAME => Issuing::CardDetails,
         Issuing::Cardholder::OBJECT_NAME => Issuing::Cardholder,
         Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
         Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
+        LineItem::OBJECT_NAME => LineItem,
         LoginLink::OBJECT_NAME => LoginLink,
+        Mandate::OBJECT_NAME => Mandate,
         Order::OBJECT_NAME => Order,
         OrderReturn::OBJECT_NAME => OrderReturn,
         PaymentIntent::OBJECT_NAME => PaymentIntent,
@@ -56,7 +62,10 @@ module Stripe
         Payout::OBJECT_NAME => Payout,
         Person::OBJECT_NAME => Person,
         Plan::OBJECT_NAME => Plan,
+        Price::OBJECT_NAME => Price,
         Product::OBJECT_NAME => Product,
+        PromotionCode::OBJECT_NAME => PromotionCode,
+        Quote::OBJECT_NAME => Quote,
         Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
         Radar::ValueList::OBJECT_NAME => Radar::ValueList,
         Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
@@ -68,6 +77,7 @@ module Stripe
         Reversal::OBJECT_NAME => Reversal,
         Review::OBJECT_NAME => Review,
         SKU::OBJECT_NAME => SKU,
+        SetupAttempt::OBJECT_NAME => SetupAttempt,
         SetupIntent::OBJECT_NAME => SetupIntent,
         Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
         Source::OBJECT_NAME => Source,
@@ -75,6 +85,7 @@ module Stripe
         Subscription::OBJECT_NAME => Subscription,
         SubscriptionItem::OBJECT_NAME => SubscriptionItem,
         SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
+        TaxCode::OBJECT_NAME => TaxCode,
         TaxId::OBJECT_NAME => TaxId,
         TaxRate::OBJECT_NAME => TaxRate,
         Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,

data/lib/stripe/resources.rb

@@ -9,6 +9,8 @@ require "stripe/resources/application_fee_refund"
 require "stripe/resources/balance"
 require "stripe/resources/balance_transaction"
 require "stripe/resources/bank_account"
+require "stripe/resources/billing_portal/configuration"
+require "stripe/resources/billing_portal/session"
 require "stripe/resources/bitcoin_receiver"
 require "stripe/resources/bitcoin_transaction"
 require "stripe/resources/capability"
@@ -18,6 +20,7 @@ require "stripe/resources/checkout/session"
 require "stripe/resources/country_spec"
 require "stripe/resources/coupon"
 require "stripe/resources/credit_note"
+require "stripe/resources/credit_note_line_item"
 require "stripe/resources/customer"
 require "stripe/resources/customer_balance_transaction"
 require "stripe/resources/discount"
@@ -27,17 +30,20 @@ require "stripe/resources/event"
 require "stripe/resources/exchange_rate"
 require "stripe/resources/file"
 require "stripe/resources/file_link"
+require "stripe/resources/identity/verification_report"
+require "stripe/resources/identity/verification_session"
 require "stripe/resources/invoice"
 require "stripe/resources/invoice_item"
 require "stripe/resources/invoice_line_item"
-require "stripe/resources/issuer_fraud_record"
 require "stripe/resources/issuing/authorization"
 require "stripe/resources/issuing/card"
 require "stripe/resources/issuing/card_details"
 require "stripe/resources/issuing/cardholder"
 require "stripe/resources/issuing/dispute"
 require "stripe/resources/issuing/transaction"
+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"
@@ -45,7 +51,10 @@ require "stripe/resources/payment_method"
 require "stripe/resources/payout"
 require "stripe/resources/person"
 require "stripe/resources/plan"
+require "stripe/resources/price"
 require "stripe/resources/product"
+require "stripe/resources/promotion_code"
+require "stripe/resources/quote"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
@@ -56,6 +65,7 @@ require "stripe/resources/reporting/report_run"
 require "stripe/resources/reporting/report_type"
 require "stripe/resources/reversal"
 require "stripe/resources/review"
+require "stripe/resources/setup_attempt"
 require "stripe/resources/setup_intent"
 require "stripe/resources/sigma/scheduled_query_run"
 require "stripe/resources/sku"
@@ -64,6 +74,7 @@ require "stripe/resources/source_transaction"
 require "stripe/resources/subscription"
 require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax_code"
 require "stripe/resources/tax_id"
 require "stripe/resources/tax_rate"
 require "stripe/resources/terminal/connection_token"

data/lib/stripe/resources/account.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -9,7 +10,7 @@ module Stripe
     include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
 
-    OBJECT_NAME = "account".freeze
+    OBJECT_NAME = "account"
 
     custom_method :reject, http_verb: :post
 
@@ -35,10 +36,6 @@ module Stripe
 
     nested_resource_class_methods :login_link, operations: %i[create]
 
-    # This method is deprecated. Please use `#external_account=` instead.
-    save_nested_resource :bank_account
-    deprecate :bank_account=, "#external_account=", 2017, 8
-
     def resource_url
       if self["id"]
         super
@@ -48,12 +45,8 @@ module Stripe
     end
 
     # @override To make id optional
-    def self.retrieve(id = ARGUMENT_NOT_PROVIDED, opts = {})
-      id = if id.equal?(ARGUMENT_NOT_PROVIDED)
-             nil
-           else
-             Util.check_string_argument!(id)
-           end
+    def self.retrieve(id = nil, opts = {})
+      Util.check_string_argument!(id) if id
 
       # Account used to be a singleton, where this method's signature was
       # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
@@ -68,7 +61,7 @@ module Stripe
     end
 
     def persons(params = {}, opts = {})
-      resp, opts = request(:get, resource_url + "/persons", params, opts)
+      resp, opts = execute_resource_request(:get, resource_url + "/persons", params, opts)
       Util.convert_to_stripe_object(resp.data, opts)
     end
 
@@ -139,11 +132,10 @@ module Stripe
         client_id: client_id,
         stripe_user_id: id,
       }
+      opts = @opts.merge(Util.normalize_opts(opts))
       OAuth.deauthorize(params, opts)
     end
 
-    ARGUMENT_NOT_PROVIDED = Object.new
-
     private def serialize_additional_owners(legal_entity, additional_owners)
       original_value =
         legal_entity

data/lib/stripe/resources/account_link.rb

@@ -1,9 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 
-    OBJECT_NAME = "account_link".freeze
+    OBJECT_NAME = "account_link"
   end
 end