stripe 1.31.0 → 1.58.0

data/lib/stripe/subscription.rb

@@ -1,25 +1,31 @@
 module Stripe
   class Subscription < APIResource
-    include Stripe::APIOperations::Update
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
 
-    def url
-      "#{Customer.url}/#{CGI.escape(customer)}/subscriptions/#{CGI.escape(id)}"
+    save_nested_resource :source
+
+    def delete_discount
+      _, opts = request(:delete, discount_url)
+      initialize_from({ :discount => nil }, opts, true)
     end
 
-    def self.retrieve(id, opts=nil)
-      raise NotImplementedError.new("Subscriptions cannot be retrieved without a customer ID. Retrieve a subscription using customer.subscriptions.retrieve('subscription_id')")
+    def self.update(id, params={}, opts={})
+      params[:items] = Util.array_to_hash(params[:items]) if params[:items]
+      super(id, params, opts)
     end
 
-    def delete_discount
-      response, opts = request(:delete, discount_url)
-      initialize_from({ :discount => nil }, opts, true)
+    def self.create(params={}, opts={})
+      params[:items] = Util.array_to_hash(params[:items]) if params[:items]
+      super(params, opts)
     end
 
     private
 
     def discount_url
-      url + '/discount'
+      resource_url + '/discount'
     end
   end
 end

data/lib/stripe/subscription_item.rb

@@ -0,0 +1,12 @@
+module Stripe
+  class SubscriptionItem < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    def self.resource_url
+      '/v1/subscription_items'
+    end
+  end
+end

data/lib/stripe/three_d_secure.rb

@@ -0,0 +1,9 @@
+module Stripe
+  class ThreeDSecure < APIResource
+    extend Stripe::APIOperations::Create
+
+    def self.resource_url
+      "/v1/3d_secure"
+    end
+  end
+end

data/lib/stripe/transfer.rb

@@ -2,16 +2,15 @@ module Stripe
   class Transfer < APIResource
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
 
     def cancel
-      response, api_key = Stripe.request(:post, cancel_url, @api_key)
+      response, api_key = self.request(:post, cancel_url)
       initialize_from(response, api_key)
     end
 
     def cancel_url
-      url + '/cancel'
+      resource_url + '/cancel'
     end
-
   end
 end

data/lib/stripe/util.rb

@@ -23,36 +23,54 @@ module Stripe
         'list' => ListObject,
 
         # business objects
-        'account' => Account,
-        'application_fee' => ApplicationFee,
-        'balance' => Balance,
-        'balance_transaction' => BalanceTransaction,
-        'bank_account' => BankAccount,
-        'card' => Card,
-        'charge' => Charge,
-        'coupon' => Coupon,
-        'customer' => Customer,
-        'event' => Event,
-        'fee_refund' => ApplicationFeeRefund,
-        'invoiceitem' => InvoiceItem,
-        'invoice' => Invoice,
-        'plan' => Plan,
-        'recipient' => Recipient,
-        'refund' => Refund,
-        'subscription' => Subscription,
-        'file_upload' => FileUpload,
-        'token' => Token,
-        'transfer' => Transfer,
-        'transfer_reversal' => Reversal,
-        'bitcoin_receiver' => BitcoinReceiver,
-        'bitcoin_transaction' => BitcoinTransaction,
-        'dispute' => Dispute,
-        'product' => Product,
-        'sku' => SKU,
-        'order' => Order,
+        'account'                 => Account,
+        'alipay_account'          => AlipayAccount,
+        'apple_pay_domain'        => ApplePayDomain,
+        'application_fee'         => ApplicationFee,
+        'balance'                 => Balance,
+        'balance_transaction'     => BalanceTransaction,
+        'bank_account'            => BankAccount,
+        'bitcoin_receiver'        => BitcoinReceiver,
+        'bitcoin_transaction'     => BitcoinTransaction,
+        'card'                    => Card,
+        'charge'                  => Charge,
+        'country_spec'            => CountrySpec,
+        'coupon'                  => Coupon,
+        'customer'                => Customer,
+        'dispute'                 => Dispute,
+        'event'                   => Event,
+        'fee_refund'              => ApplicationFeeRefund,
+        'file_upload'             => FileUpload,
+        'invoice'                 => Invoice,
+        'invoiceitem'             => InvoiceItem,
+        'order'                   => Order,
+        'order_return'            => OrderReturn,
+        'plan'                    => Plan,
+        'product'                 => Product,
+        'recipient'               => Recipient,
+        'refund'                  => Refund,
+        'sku'                     => SKU,
+        'subscription'            => Subscription,
+        'subscription_item'       => SubscriptionItem,
+        'three_d_secure'          => ThreeDSecure,
+        'token'                   => Token,
+        'transfer'                => Transfer,
+        'transfer_reversal'       => Reversal,
       }
     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
+    # `charge` would create an instance of +Charge+), but if `object` is not
+    # present or of an unknown type, the newly created instance will fall back
+    # to being a +StripeObject+.
+    #
+    # ==== Attributes
+    #
+    # * +resp+ - Hash of fields and values to be converted into a StripeObject.
+    # * +opts+ - Options for +StripeObject+ like an API key that will be reused
+    #   on subsequent API calls.
     def self.convert_to_stripe_object(resp, opts)
       case resp
       when Array
@@ -103,6 +121,20 @@ module Stripe
         map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
     end
 
+    # Transforms an array into a hash with integer keys. Used for a small
+    # number of API endpoints. If the argument is not an Array, return it
+    # unchanged. Example: [{foo: 'bar'}] => {"0" => {foo: "bar"}}
+    def self.array_to_hash(array)
+      case array
+      when Array
+        hash = {}
+        array.each_with_index { |v,i| hash[i.to_s] = v }
+        hash
+      else
+        array
+      end
+    end
+
     # Encodes a string in a way that makes it suitable for use in a set of
     # query parameters in a URI or in a set of form parameters in a request
     # body.
@@ -119,11 +151,12 @@ module Stripe
 
       # do not sort the final output because arrays (and arrays of hashes
       # especially) can be order sensitive, but do sort incoming parameters
-      params.sort_by { |(k, v)| k.to_s }.each do |key, value|
+      params.each do |key, value|
         calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
         if value.is_a?(Hash)
           result += flatten_params(value, calculated_key)
         elsif value.is_a?(Array)
+          check_array_of_maps_start_keys!(value)
           result += flatten_params_array(value, calculated_key)
         else
           result << [calculated_key, value]
@@ -180,5 +213,44 @@ module Stripe
       raise TypeError.new("api_key must be a string") unless key.is_a?(String)
       key
     end
+
+    private
+
+    # We use a pretty janky version of form encoding (Rack's) that supports
+    # more complex data structures like maps and arrays through the use of
+    # specialized syntax. To encode an array of maps like:
+    #
+    #     [{a: 1, b: 2}, {a: 3, b: 4}]
+    #
+    # We have to produce something that looks like this:
+    #
+    #     arr[][a]=1&arr[][b]=2&arr[][a]=3&arr[][b]=4
+    #
+    # The only way for the server to recognize that this is a two item array is
+    # that it notices the repetition of element "a", so it's key that these
+    # repeated elements are encoded first.
+    #
+    # This method is invoked for any arrays being encoded and checks that if
+    # the array contains all non-empty maps, that each of those maps must start
+    # with the same key so that their boundaries can be properly encoded.
+    def self.check_array_of_maps_start_keys!(arr)
+      expected_key = nil
+      arr.each do |item|
+        return if !item.is_a?(Hash)
+        return if item.count == 0
+
+        first_key = item.first[0]
+
+        if expected_key
+          if expected_key != first_key
+            raise ArgumentError,
+              "All maps nested in an array should start with the same key " +
+              "(expected starting key '#{expected_key}', got '#{first_key}')"
+          end
+        else
+          expected_key = first_key
+        end
+      end
+    end
   end
 end

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.31.0'
+  VERSION = '1.58.0'
 end