stripe 4.9.0 → 5.1.0

data/lib/stripe/{bitcoin_receiver.rb → resources/bitcoin_receiver.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Directly creating or retrieving BitcoinReceivers is deprecated. Please use
+  # the Sources API instead: https://stripe.com/docs/sources/bitcoin
   class BitcoinReceiver < APIResource
-    # Directly creating or retrieving BitcoinReceivers is deprecated. Please use
-    # the Sources API instead: https://stripe.com/docs/sources/bitcoin
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "bitcoin_receiver".freeze
+    OBJECT_NAME = "bitcoin_receiver"
 
     def self.resource_url
       "/v1/bitcoin/receivers"

data/lib/stripe/{bitcoin_transaction.rb → 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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Capability < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "capability"
+
+    def resource_url
+      if !respond_to?(:account) || account.nil?
+        raise NotImplementedError,
+              "Capabilities cannot be accessed without an account ID."
+      end
+      "#{Account.resource_url}/#{CGI.escape(account)}/capabilities" \
+      "/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Capabilities cannot be retrieve without an account ID. " \
+            "Retrieve a capability using Account.retrieve_capability(" \
+            "'account_id', 'capability_id')`"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Capabilities cannot be updated without an account ID. Update a " \
+            "capability using Account.update_capability('account_id', " \
+            "'capability_id', update_params)`"
+    end
+  end
+end

data/lib/stripe/{card.rb → resources/card.rb}

@@ -2,11 +2,11 @@
 
 module Stripe
   class Card < APIResource
-    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
     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?
@@ -19,11 +19,19 @@ module Stripe
     end
 
     def self.update(_id, _params = nil, _opts = nil)
-      raise NotImplementedError, "Cards cannot be updated without a customer ID. Update a card using `c = customer.sources.retrieve('card_id'); c.save`"
+      raise NotImplementedError,
+            "Card cannot be updated without a customer ID or an account ID. " \
+            "Update a card using `Customer.update_source('customer_id', " \
+            "'card_id', update_params)` or `Account.update_external_account(" \
+            "'account_id', 'card_id', update_params)`"
     end
 
     def self.retrieve(_id, _opts = nil)
-      raise NotImplementedError, "Cards cannot be retrieved without a customer ID. Retrieve a card using customer.sources.retrieve('card_id')"
+      raise NotImplementedError,
+            "Card cannot be retrieved without a customer ID or an account " \
+            "ID. Retrieve a card using `Customer.retrieve_source(" \
+            "'customer_id', 'card_id')` or " \
+            "`Account.retrieve_external_account('account_id', 'card_id')`"
     end
   end
 end

data/lib/stripe/resources/charge.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Charge < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "charge"
+
+    custom_method :capture, http_verb: :post
+
+    def capture(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/capture",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/{checkout → resources/checkout}/session.rb

@@ -2,10 +2,10 @@
 
 module Stripe
   module Checkout
-    class Session < Stripe::APIResource
+    class Session < APIResource
       extend Stripe::APIOperations::Create
 
-      OBJECT_NAME = "checkout.session".freeze
+      OBJECT_NAME = "checkout.session"
     end
   end
 end

data/lib/stripe/{country_spec.rb → resources/country_spec.rb}

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

data/lib/stripe/{coupon.rb → resources/coupon.rb}

@@ -3,10 +3,10 @@
 module Stripe
   class Coupon < APIResource
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "coupon".freeze
+    OBJECT_NAME = "coupon"
   end
 end

data/lib/stripe/resources/credit_note.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNote < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "credit_note"
+
+    custom_method :void_credit_note, http_verb: :post, http_path: "void"
+
+    def void_credit_note(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/void",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/customer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Customer < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "customer"
+
+    nested_resource_class_methods :balance_transaction,
+                                  operations: %i[create retrieve update list]
+    nested_resource_class_methods :tax_id,
+                                  operations: %i[create retrieve delete list]
+
+    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+
+    save_nested_resource :source
+    nested_resource_class_methods :source,
+                                  operations: %i[create retrieve update delete list]
+
+    # The API request for deleting a card or bank account and for detaching a
+    # source object are the same.
+    class << self
+      alias detach_source delete_source
+    end
+
+    def delete_discount
+      resp, opts = request(:delete, resource_url + "/discount")
+      initialize_from(resp.data, opts, true)
+    end
+  end
+end

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransaction < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "customer_balance_transaction"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Customer Balance Transactions cannot be accessed without a customer ID."
+      end
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/balance_transactions/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Customer Balance Transactions cannot be retrieved without a customer ID. " \
+            "Retrieve a Customer Balance Transaction using Customer.retrieve_balance_transaction('cus_123', 'cbtxn_123')"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Customer Balance Transactions cannot be retrieved without a customer ID. " \
+            "Update a Customer Balance Transaction using Customer.update_balance_transaction('cus_123', 'cbtxn_123', params)"
+    end
+  end
+end

data/lib/stripe/resources/discount.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Discount < StripeObject
+    OBJECT_NAME = "discount"
+  end
+end

data/lib/stripe/{dispute.rb → resources/dispute.rb}

@@ -5,15 +5,17 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "dispute".freeze
+    OBJECT_NAME = "dispute"
 
-    def close(params = {}, opts = {})
-      resp, opts = request(:post, close_url, params, opts)
-      initialize_from(resp.data, opts)
-    end
+    custom_method :close, http_verb: :post
 
-    def close_url
-      resource_url + "/close"
+    def close(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/close",
+        params: params,
+        opts: opts
+      )
     end
   end
 end

data/lib/stripe/{ephemeral_key.rb → resources/ephemeral_key.rb}

@@ -5,11 +5,14 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
 
-    OBJECT_NAME = "ephemeral_key".freeze
+    OBJECT_NAME = "ephemeral_key"
 
     def self.create(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
-      raise ArgumentError, "stripe_version must be specified to create an ephemeral key" unless opts[:stripe_version]
+      unless opts[:stripe_version]
+        raise ArgumentError,
+              "stripe_version must be specified to create an ephemeral key"
+      end
       super
     end
   end

data/lib/stripe/{event.rb → resources/event.rb}

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

data/lib/stripe/{exchange_rate.rb → resources/exchange_rate.rb}

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

data/lib/stripe/{file.rb → resources/file.rb}

@@ -5,33 +5,30 @@ module Stripe
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
 
+    OBJECT_NAME = "file"
+
     # This resource can have two different object names. In latter API
     # versions, only `file` is used, but since stripe-ruby may be used with
     # any API version, we need to support deserializing the older
     # `file_upload` object into the same class.
-    OBJECT_NAME = "file".freeze
-    OBJECT_NAME_ALT = "file_upload".freeze
+    OBJECT_NAME_ALT = "file_upload"
 
     def self.resource_url
       "/v1/files"
     end
 
     def self.create(params = {}, opts = {})
-      # rest-client would accept a vanilla `File` for upload, but Faraday does
-      # not. Support the old API by wrapping a `File`-like object with an
-      # `UploadIO` object if we're given one.
-      if params[:file] && params[:file].respond_to?(:path) && params[:file].respond_to?(:read)
-        params[:file] = Faraday::UploadIO.new(params[:file], nil)
+      if params[:file] && !params[:file].is_a?(String)
+        unless params[:file].respond_to?(:read)
+          raise ArgumentError, "file must respond to `#read`"
+        end
       end
 
       opts = {
         api_base: Stripe.uploads_base,
-        content_type: "multipart/form-data",
+        content_type: MultipartEncoder::MULTIPART_FORM_DATA,
       }.merge(Util.normalize_opts(opts))
       super
     end
   end
-
-  # For backwards compatibility, the `File` class is aliased to `FileUpload`.
-  FileUpload = File
 end

data/lib/stripe/{file_link.rb → resources/file_link.rb}

@@ -3,9 +3,9 @@
 module Stripe
   class FileLink < APIResource
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "file_link".freeze
+    OBJECT_NAME = "file_link"
   end
 end

data/lib/stripe/resources/invoice.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Invoice < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "invoice"
+
+    custom_method :finalize_invoice, http_verb: :post, http_path: "finalize"
+    custom_method :mark_uncollectible, http_verb: :post
+    custom_method :pay, http_verb: :post
+    custom_method :send_invoice, http_verb: :post, http_path: "send"
+    custom_method :void_invoice, http_verb: :post, http_path: "void"
+
+    def finalize_invoice(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/finalize",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def mark_uncollectible(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/mark_uncollectible",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def pay(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/pay",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def send_invoice(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/send",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def void_invoice(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/void",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.upcoming(params, opts = {})
+      resp, opts = request(:get, resource_url + "/upcoming", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+
+    def self.list_upcoming_line_items(params, opts = {})
+      resp, opts = request(:get, resource_url + "/upcoming/lines", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+  end
+end