stripe 4.24.0 → 5.0.0

data/lib/stripe/error_object.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Stripe
+  # Represents an error object as returned by the API.
+  #
+  # @see https://stripe.com/docs/api/errors
+  class ErrorObject < StripeObject
+    # Unlike other objects, we explicitly declare getter methods here. This
+    # is because the API doesn't return `null` values for fields on this
+    # object, rather the fields are omitted entirely. Not declaring the getter
+    # methods would cause users to run into `NoMethodError` exceptions and
+    # get in the way of generic error handling.
+
+    # For card errors, the ID of the failed charge.
+    def charge
+      @values[:charge]
+    end
+
+    # For some errors that could be handled programmatically, a short string
+    # indicating the error code reported.
+    def code
+      @values[:code]
+    end
+
+    # For card errors resulting from a card issuer decline, a short string
+    # indicating the card issuer's reason for the decline if they provide one.
+    def decline_code
+      @values[:decline_code]
+    end
+
+    # A URL to more information about the error code reported.
+    def doc_url
+      @values[:doc_url]
+    end
+
+    # A human-readable message providing more details about the error. For card
+    # errors, these messages can be shown to your users.
+    def message
+      @values[:message]
+    end
+
+    # If the error is parameter-specific, the parameter related to the error.
+    # For example, you can use this to display a message near the correct form
+    # field.
+    def param
+      @values[:param]
+    end
+
+    # The PaymentIntent object for errors returned on a request involving a
+    # PaymentIntent.
+    def payment_intent
+      @values[:payment_intent]
+    end
+
+    # The PaymentMethod object for errors returned on a request involving a
+    # PaymentMethod.
+    def payment_method
+      @values[:payment_method]
+    end
+
+    # The SetupIntent object for errors returned on a request involving a
+    # SetupIntent.
+    def setup_intent
+      @values[:setup_intent]
+    end
+
+    # The source object for errors returned on a request involving a source.
+    def source
+      @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`.
+    def type
+      @values[:type]
+    end
+  end
+
+  # Represents on OAuth error returned by the OAuth API.
+  #
+  # @see https://stripe.com/docs/connect/oauth-reference#post-token-errors
+  class OAuthErrorObject < StripeObject
+    # A unique error code per error type.
+    def error
+      @values[:error]
+    end
+
+    # A human readable description of the error.
+    def error_description
+      @values[:error_description]
+    end
+  end
+end

data/lib/stripe/errors.rb

@@ -11,6 +11,7 @@ module Stripe
     attr_accessor :response
 
     attr_reader :code
+    attr_reader :error
     attr_reader :http_body
     attr_reader :http_headers
     attr_reader :http_status
@@ -27,6 +28,13 @@ module Stripe
       @json_body = json_body
       @code = code
       @request_id = @http_headers[:request_id]
+      @error = construct_error_object
+    end
+
+    def construct_error_object
+      return nil if @json_body.nil? || !@json_body.key?(:error)
+
+      ErrorObject.construct_from(@json_body[:error])
     end
 
     def to_s
@@ -59,8 +67,7 @@ module Stripe
   class CardError < StripeError
     attr_reader :param
 
-    # TODO: make code a keyword arg in next major release
-    def initialize(message, param, code, http_status: nil, http_body: nil,
+    def initialize(message, param, code: nil, http_status: nil, http_body: nil,
                    json_body: nil, http_headers: nil)
       super(message, http_status: http_status, http_body: http_body,
                      json_body: json_body, http_headers: http_headers,
@@ -119,6 +126,12 @@ module Stripe
                            json_body: json_body, http_headers: http_headers,
                            code: code)
       end
+
+      def construct_error_object
+        return nil if @json_body.nil?
+
+        OAuthErrorObject.construct_from(@json_body)
+      end
     end
 
     # InvalidClientError is raised when the client doesn't belong to you, or

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,
@@ -83,6 +83,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)

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/object_types.rb

@@ -41,7 +41,6 @@ module Stripe
         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,

data/lib/stripe/resources.rb

@@ -30,7 +30,6 @@ require "stripe/resources/file_link"
 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"

data/lib/stripe/resources/account.rb

@@ -9,7 +9,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 +35,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

data/lib/stripe/resources/account_link.rb

@@ -4,6 +4,6 @@ module Stripe
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 
-    OBJECT_NAME = "account_link".freeze
+    OBJECT_NAME = "account_link"
   end
 end

data/lib/stripe/resources/alipay_account.rb

@@ -5,7 +5,7 @@ module Stripe
     include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
 
-    OBJECT_NAME = "alipay_account".freeze
+    OBJECT_NAME = "alipay_account"
 
     def resource_url
       if !respond_to?(:customer) || customer.nil?

data/lib/stripe/resources/apple_pay_domain.rb

@@ -7,7 +7,7 @@ module Stripe
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "apple_pay_domain".freeze
+    OBJECT_NAME = "apple_pay_domain"
 
     def self.resource_url
       "/v1/apple_pay/domains"

data/lib/stripe/resources/application_fee.rb

@@ -5,20 +5,9 @@ module Stripe
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::NestedResource
 
-    OBJECT_NAME = "application_fee".freeze
+    OBJECT_NAME = "application_fee"
 
     nested_resource_class_methods :refund,
                                   operations: %i[create retrieve update list]
-
-    # If you don't need access to an updated fee object after the refund, it's
-    # more performant to just call `fee.refunds.create` directly.
-    def refund(params = {}, opts = {})
-      refunds.create(params, opts)
-
-      # now that a refund has been created, we expect the state of this object
-      # to change as well (i.e. `refunded` will now be `true`) so refresh it
-      # from the server
-      refresh
-    end
   end
 end

data/lib/stripe/resources/application_fee_refund.rb

@@ -5,7 +5,7 @@ module Stripe
     include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "fee_refund".freeze
+    OBJECT_NAME = "fee_refund"
 
     def resource_url
       "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds" \

data/lib/stripe/resources/balance.rb

@@ -2,6 +2,6 @@
 
 module Stripe
   class Balance < SingletonAPIResource
-    OBJECT_NAME = "balance".freeze
+    OBJECT_NAME = "balance"
   end
 end

data/lib/stripe/resources/balance_transaction.rb

@@ -4,6 +4,6 @@ module Stripe
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "balance_transaction".freeze
+    OBJECT_NAME = "balance_transaction"
   end
 end

data/lib/stripe/resources/bank_account.rb

@@ -6,7 +6,7 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "bank_account".freeze
+    OBJECT_NAME = "bank_account"
 
     def verify(params = {}, opts = {})
       resp, opts = request(:post, resource_url + "/verify", params, opts)

data/lib/stripe/resources/bitcoin_receiver.rb

@@ -6,7 +6,7 @@ module Stripe
   class BitcoinReceiver < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "bitcoin_receiver".freeze
+    OBJECT_NAME = "bitcoin_receiver"
 
     def self.resource_url
       "/v1/bitcoin/receivers"

data/lib/stripe/resources/bitcoin_transaction.rb

@@ -6,7 +6,7 @@ module Stripe
     # Sources API instead: https://stripe.com/docs/sources/bitcoin
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "bitcoin_transaction".freeze
+    OBJECT_NAME = "bitcoin_transaction"
 
     def self.resource_url
       "/v1/bitcoin/transactions"

data/lib/stripe/resources/capability.rb

@@ -5,7 +5,7 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "capability".freeze
+    OBJECT_NAME = "capability"
 
     def resource_url
       if !respond_to?(:account) || account.nil?

data/lib/stripe/resources/card.rb

@@ -6,7 +6,7 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "card".freeze
+    OBJECT_NAME = "card"
 
     def resource_url
       if respond_to?(:recipient) && !recipient.nil? && !recipient.empty?