stripe 3.3.2 → 3.4.1

data/lib/stripe/alipay_account.rb

@@ -3,20 +3,23 @@ module Stripe
     include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
 
-    OBJECT_NAME = 'alipay_account'
+    OBJECT_NAME = "alipay_account".freeze
 
     def resource_url
-      if respond_to?(:customer) && !self.customer.nil?
-        "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Alipay accounts cannot be accessed without a customer ID."
       end
+
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
     end
 
-    def self.update(id, params=nil, opts=nil)
-      raise NotImplementedError.new("Alipay accounts cannot be updated without a customer ID. Update an Alipay account by `a = customer.sources.retrieve('alipay_account_id'); a.save`")
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError, "Alipay accounts cannot be updated without a customer ID. Update an Alipay account by `a = customer.sources.retrieve('alipay_account_id'); a.save`"
     end
 
-    def self.retrieve(id, opts=nil)
-      raise NotImplementedError.new("Alipay accounts cannot be retrieved without a customer ID. Retrieve an Alipay account using customer.sources.retrieve('alipay_account_id')")
+    def self.retrieve(_id, _opts = nil)
+      raise NotImplementedError, "Alipay accounts cannot be retrieved without a customer ID. Retrieve an Alipay account using customer.sources.retrieve('alipay_account_id')"
     end
   end
 end

data/lib/stripe/api_operations/create.rb

@@ -1,7 +1,7 @@
 module Stripe
   module APIOperations
     module Create
-      def create(params={}, opts={})
+      def create(params = {}, opts = {})
         resp, opts = request(:post, resource_url, params, opts)
         Util.convert_to_stripe_object(resp.data, opts)
       end

data/lib/stripe/api_operations/delete.rb

@@ -1,7 +1,7 @@
 module Stripe
   module APIOperations
     module Delete
-      def delete(params={}, opts={})
+      def delete(params = {}, opts = {})
         opts = Util.normalize_opts(opts)
         resp, opts = request(:delete, resource_url, params, opts)
         initialize_from(resp.data, opts)

data/lib/stripe/api_operations/list.rb

@@ -1,7 +1,7 @@
 module Stripe
   module APIOperations
     module List
-      def list(filters={}, opts={})
+      def list(filters = {}, opts = {})
         opts = Util.normalize_opts(opts)
 
         resp, opts = request(:get, resource_url, filters, opts)
@@ -22,7 +22,7 @@ module Stripe
       # #all, and this alias allows us to maintain backward compatibility (the
       # choice was somewhat misleading in the way that it only returned a single
       # page rather than all objects).
-      alias :all :list
+      alias all list
     end
   end
 end

data/lib/stripe/api_operations/request.rb

@@ -2,9 +2,7 @@ module Stripe
   module APIOperations
     module Request
       module ClassMethods
-        OPTS_KEYS_TO_PERSIST = Set[:api_key, :api_base, :client, :stripe_account, :stripe_version]
-
-        def request(method, url, params={}, opts={})
+        def request(method, url, params = {}, opts = {})
           warn_on_opts_in_params(params)
 
           opts = Util.normalize_opts(opts)
@@ -25,9 +23,7 @@ module Stripe
           # Hash#select returns an array before 1.9
           opts_to_persist = {}
           opts.each do |k, v|
-            if OPTS_KEYS_TO_PERSIST.include?(k)
-              opts_to_persist[k] = v
-            end
+            opts_to_persist[k] = v if Util::OPTS_KEYS_TO_PERSIST.include?(k)
           end
 
           [resp, opts_to_persist]
@@ -35,12 +31,9 @@ module Stripe
 
         private
 
-        KNOWN_OPTS = Set[:api_key, :idempotency_key, :stripe_account, :stripe_version]
-        private_constant :KNOWN_OPTS
-
         def warn_on_opts_in_params(params)
-          KNOWN_OPTS.each do |opt|
-            if params.has_key?(opt)
+          Util::OPTS_USER_SPECIFIED.each do |opt|
+            if params.key?(opt)
               $stderr.puts("WARNING: #{opt} should be in opts instead of params.")
             end
           end
@@ -53,7 +46,7 @@ module Stripe
 
       protected
 
-      def request(method, url, params={}, opts={})
+      def request(method, url, params = {}, opts = {})
         opts = @opts.merge(Util.normalize_opts(opts))
         self.class.request(method, url, params, opts)
       end

data/lib/stripe/api_operations/save.rb

@@ -14,9 +14,9 @@ module Stripe
         #   object values) to be added to the request. E.g. to allow for an
         #   idempotency_key to be passed in the request headers, or for the
         #   api_key to be overwritten. See {APIOperations::Request.request}.
-        def update(id, params={}, opts={})
-          params.each do |k, v|
-            if self.protected_fields.include?(k)
+        def update(id, params = {}, opts = {})
+          params.each_key do |k|
+            if protected_fields.include?(k)
               raise ArgumentError, "Cannot update protected field: #{k}"
             end
           end
@@ -42,7 +42,7 @@ module Stripe
       #   object values) to be added to the request. E.g. to allow for an
       #   idempotency_key to be passed in the request headers, or for the
       #   api_key to be overwritten. See {APIOperations::Request.request}.
-      def save(params={}, opts={})
+      def save(params = {}, opts = {})
         # We started unintentionally (sort of) allowing attributes sent to
         # +save+ to override values used during the update. So as not to break
         # the API, this makes that official here.
@@ -51,7 +51,7 @@ module Stripe
         # Now remove any parameters that look like object attributes.
         params = params.reject { |k, _| respond_to?(k) }
 
-        values = self.serialize_params(self).merge(params)
+        values = serialize_params(self).merge(params)
 
         # note that id gets removed here our call to #url above has already
         # generated a uri for this object with an identifier baked in
@@ -74,7 +74,7 @@ module Stripe
         # Stripe::APIOperations::Create), then use the URL to create a new
         # resource. Otherwise, generate a URL based on the object's identifier
         # for a normal update.
-        if self[:id] == nil && self.class.respond_to?(:create)
+        if self[:id].nil? && self.class.respond_to?(:create)
           self.class.resource_url
         else
           resource_url

data/lib/stripe/api_resource.rb

@@ -10,12 +10,12 @@ module Stripe
     attr_accessor :save_with_parent
 
     def self.class_name
-      self.name.split('::')[-1]
+      name.split("::")[-1]
     end
 
     def self.resource_url
       if self == APIResource
-        raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (Charge, Customer, etc.)')
+        raise NotImplementedError, "APIResource is an abstract class.  You should perform actions on its subclasses (Charge, Customer, etc.)"
       end
       "/v1/#{CGI.escape(class_name.downcase)}s"
     end
@@ -38,17 +38,15 @@ module Stripe
         # Note that the value may be subresource, but could also be a scalar
         # (like a tokenized card's ID for example), so we check the type before
         # setting #save_with_parent here.
-        if value.is_a?(APIResource)
-          value.save_with_parent = true
-        end
+        value.save_with_parent = true if value.is_a?(APIResource)
 
         value
       end
     end
 
     def resource_url
-      unless id = self['id']
-        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
+      unless (id = self["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
@@ -58,9 +56,9 @@ module Stripe
       initialize_from(resp.data, opts)
     end
 
-    def self.retrieve(id, opts={})
+    def self.retrieve(id, opts = {})
       opts = Util.normalize_opts(opts)
-      instance = self.new(id, opts)
+      instance = new(id, opts)
       instance.refresh
       instance
     end

data/lib/stripe/apple_pay_domain.rb

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

data/lib/stripe/application_fee.rb

@@ -2,21 +2,21 @@ module Stripe
   class ApplicationFee < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'application_fee'
+    OBJECT_NAME = "application_fee".freeze
 
     def self.resource_url
-      '/v1/application_fees'
+      "/v1/application_fees"
     end
 
     # 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={})
-      self.refunds.create(params, opts)
+    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
-      self.refresh
+      refresh
     end
   end
 end

data/lib/stripe/application_fee_refund.rb

@@ -3,18 +3,18 @@ module Stripe
     include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'fee_refund'
+    OBJECT_NAME = "fee_refund".freeze
 
     def resource_url
       "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds/#{CGI.escape(id)}"
     end
 
-    def self.update(id, params=nil, opts=nil)
-      raise NotImplementedError.new("Refunds cannot be updated without an application fee ID. Update a refund by using `a = appfee.refunds.retrieve('refund_id'); a.save`")
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError, "Refunds cannot be updated without an application fee ID. Update a refund by using `a = appfee.refunds.retrieve('refund_id'); a.save`"
     end
 
-    def self.retrieve(id, api_key=nil)
-      raise NotImplementedError.new("Refunds cannot be retrieved without an application fee ID. Retrieve a refund using appfee.refunds.retrieve('refund_id')")
+    def self.retrieve(_id, _api_key = nil)
+      raise NotImplementedError, "Refunds cannot be retrieved without an application fee ID. Retrieve a refund using appfee.refunds.retrieve('refund_id')"
     end
   end
 end

data/lib/stripe/balance.rb

@@ -1,5 +1,5 @@
 module Stripe
   class Balance < SingletonAPIResource
-    OBJECT_NAME = 'balance'
+    OBJECT_NAME = "balance".freeze
   end
 end

data/lib/stripe/balance_transaction.rb

@@ -2,10 +2,10 @@ module Stripe
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'balance_transaction'
+    OBJECT_NAME = "balance_transaction".freeze
 
     def self.resource_url
-      '/v1/balance/history'
+      "/v1/balance/history"
     end
   end
 end

data/lib/stripe/bank_account.rb

@@ -4,10 +4,10 @@ module Stripe
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'bank_account'
+    OBJECT_NAME = "bank_account".freeze
 
-    def verify(params={}, opts={})
-      resp, opts = request(:post, resource_url + '/verify', params, opts)
+    def verify(params = {}, opts = {})
+      resp, opts = request(:post, resource_url + "/verify", params, opts)
       initialize_from(resp.data, opts)
     end
 
@@ -19,12 +19,12 @@ module Stripe
       end
     end
 
-    def self.update(id, params=nil, opts=nil)
-      raise NotImplementedError.new("Bank accounts cannot be updated without an account ID. Update a bank account by using `a = account.external_accounts.retrieve('card_id'); a.save`")
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError, "Bank accounts cannot be updated without an account ID. Update a bank account by using `a = account.external_accounts.retrieve('card_id'); a.save`"
     end
 
-    def self.retrieve(id, opts=nil)
-      raise NotImplementedError.new("Bank accounts cannot be retrieved without an account ID. Retrieve a bank account using account.external_accounts.retrieve('card_id')")
+    def self.retrieve(_id, _opts = nil)
+      raise NotImplementedError, "Bank accounts cannot be retrieved without an account ID. Retrieve a bank account using account.external_accounts.retrieve('card_id')"
     end
   end
 end

data/lib/stripe/bitcoin_receiver.rb

@@ -1,18 +1,20 @@
 module Stripe
   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::Create
     include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'bitcoin_receiver'
+    OBJECT_NAME = "bitcoin_receiver".freeze
 
     def self.resource_url
       "/v1/bitcoin/receivers"
     end
 
     def resource_url
-      if respond_to?(:customer) && !self.customer.nil? && self.customer != ""
+      if respond_to?(:customer) && !customer.nil? && customer != ""
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
       else
         "#{self.class.resource_url}/#{CGI.escape(id)}"

data/lib/stripe/bitcoin_transaction.rb

@@ -1,8 +1,10 @@
 module Stripe
   class BitcoinTransaction < APIResource
+    # Directly retrieving BitcoinTransactions is deprecated. Please use the
+    # Sources API instead: https://stripe.com/docs/sources/bitcoin
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'bitcoin_transaction'
+    OBJECT_NAME = "bitcoin_transaction".freeze
 
     def self.resource_url
       "/v1/bitcoin/transactions"

data/lib/stripe/card.rb

@@ -4,7 +4,7 @@ module Stripe
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'card'
+    OBJECT_NAME = "card".freeze
 
     def resource_url
       if respond_to?(:recipient) && !recipient.nil? && !recipient.empty?
@@ -16,12 +16,12 @@ module Stripe
       end
     end
 
-    def self.update(id, params=nil, opts=nil)
-      raise NotImplementedError.new("Cards cannot be updated without a customer ID. Update a card using `c = customer.sources.retrieve('card_id'); c.save`")
+    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`"
     end
 
-    def self.retrieve(id, opts=nil)
-      raise NotImplementedError.new("Cards cannot be retrieved without a customer ID. Retrieve a card using customer.sources.retrieve('card_id')")
+    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')"
     end
   end
 end

data/lib/stripe/charge.rb

@@ -4,9 +4,9 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = 'charge'
+    OBJECT_NAME = "charge".freeze
 
-    def refund(params={}, opts={})
+    def refund(params = {}, opts = {})
       # Old versions of charge objects included a `refunds` field that was just
       # a vanilla array instead of a Stripe list object.
       #
@@ -14,38 +14,38 @@ module Stripe
       # `self.refunds.create`), but detect the old API version by looking for
       # an `Array` and fall back to the old refund URL if necessary so as to
       # maintain internal compatibility.
-      unless self.refunds.is_a?(Array)
-        self.refunds.create(params, opts)
+      if refunds.is_a?(Array)
+        resp, opts = request(:post, refund_url, params, opts)
+        initialize_from(resp.data, opts)
+      else
+        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
-        self.refresh
-      else
-        resp, opts = request(:post, refund_url, params, opts)
-        initialize_from(resp.data, opts)
+        refresh
       end
     end
 
-    def capture(params={}, opts={})
+    def capture(params = {}, opts = {})
       resp, opts = request(:post, capture_url, params, opts)
       initialize_from(resp.data, opts)
     end
 
-    def update_dispute(params={}, opts={})
+    def update_dispute(params = {}, opts = {})
       resp, opts = request(:post, dispute_url, params, opts)
-      initialize_from({ :dispute => resp.data }, opts, true)
+      initialize_from({ dispute: resp.data }, opts, true)
       dispute
     end
 
-    def close_dispute(params={}, opts={})
+    def close_dispute(params = {}, opts = {})
       resp, opts = request(:post, close_dispute_url, params, opts)
       initialize_from(resp.data, opts)
     end
 
     def mark_as_fraudulent
       params = {
-        :fraud_details => { :user_report => 'fraudulent' }
+        fraud_details: { user_report: "fraudulent" },
       }
       resp, opts = request(:post, resource_url, params)
       initialize_from(resp.data, opts)
@@ -53,7 +53,7 @@ module Stripe
 
     def mark_as_safe
       params = {
-        :fraud_details => { :user_report => 'safe' }
+        fraud_details: { user_report: "safe" },
       }
       resp, opts = request(:post, resource_url, params)
       initialize_from(resp.data, opts)
@@ -62,21 +62,21 @@ module Stripe
     private
 
     def capture_url
-      resource_url + '/capture'
+      resource_url + "/capture"
     end
 
     def dispute_url
-      resource_url + '/dispute'
+      resource_url + "/dispute"
     end
 
     def close_dispute_url
-      resource_url + '/dispute/close'
+      resource_url + "/dispute/close"
     end
 
     # Note that this is actually the *old* refund URL and its use is no longer
     # preferred.
     def refund_url
-      resource_url + '/refund'
+      resource_url + "/refund"
     end
   end
 end