stripe 1.36.1 → 1.36.2

data/lib/stripe/reversal.rb

@@ -3,8 +3,8 @@ module Stripe
     include Stripe::APIOperations::Update
     extend Stripe::APIOperations::List
 
-    def url
-      "#{Transfer.url}/#{CGI.escape(transfer)}/reversals/#{CGI.escape(id)}"
+    def resource_url
+      "#{Transfer.resource_url}/#{CGI.escape(transfer)}/reversals/#{CGI.escape(id)}"
     end
 
     def self.retrieve(id, opts={})

data/lib/stripe/singleton_api_resource.rb

@@ -1,14 +1,14 @@
 module Stripe
   class SingletonAPIResource < APIResource
-    def self.url
+    def self.resource_url
       if self == SingletonAPIResource
         raise NotImplementedError.new('SingletonAPIResource is an abstract class.  You should perform actions on its subclasses (Account, etc.)')
       end
       "/v1/#{CGI.escape(class_name.downcase)}"
     end
 
-    def url
-      self.class.url
+    def resource_url
+      self.class.resource_url
     end
 
     def self.retrieve(opts={})

data/lib/stripe/stripe_object.rb

@@ -72,13 +72,21 @@ module Stripe
     #
     # * +values+ - Hash of values to use to update the current attributes of
     #   the object.
+    # * +:opts+ Options for StripeObject like an API key.
     #
     # ==== Options
     #
-    # * +:opts+ Options for StripeObject like an API key.
-    def update_attributes(values, opts = {})
+    # * +:dirty+ Whether values should be initiated as "dirty" (unsaved) and
+    #   which applies only to new StripeObjects being ininiated under this
+    #   StripeObject. Defaults to true.
+    def update_attributes(values, opts = {}, method_options = {})
+      # Default to true. TODO: Convert to optional arguments after we're off
+      # 1.9 which will make this quite a bit more clear.
+      dirty = method_options.fetch(:dirty, true)
+
       values.each do |k, v|
         @values[k] = Util.convert_to_stripe_object(v, opts)
+        dirty_value!(@values[k]) if dirty
         @unsaved_values.add(k)
       end
     end
@@ -142,73 +150,51 @@ module Stripe
       end
     end
 
-    def serialize_nested_object(key)
-      new_value = @values[key]
-      if new_value.is_a?(APIResource)
-        return {}
-      end
-
-      if @unsaved_values.include?(key)
-        # the object has been reassigned
-        # e.g. as object.key = {foo => bar}
-        update = new_value
-        update = update.to_hash if update.is_a?(StripeObject)
-        new_keys = update.keys.map(&:to_sym)
-
-        # remove keys at the server, but not known locally
-        if @original_values[key]
-          keys_to_unset = @original_values[key].keys - new_keys
-          keys_to_unset.each {|key| update[key] = ''}
-        end
-
-        update
-      else
-        # can be serialized normally
-        self.class.serialize_params(new_value)
+    # Sets all keys within the StripeObject as unsaved so that they will be
+    # included with an update when #serialize_params is called. This method is
+    # also recursive, so any StripeObjects contained as values or which are
+    # values in a tenant array are also marked as dirty.
+    def dirty!
+      @unsaved_values = Set.new(@values.keys)
+      @values.each do |k, v|
+        dirty_value!(v)
       end
     end
 
-    def self.serialize_params(obj, original_value=nil)
-      case obj
-      when nil
-        ''
-      when Array
-        update = obj.map { |v| serialize_params(v) }
-        if original_value != update
-          update
-        else
-          nil
+    def serialize_params(options = {})
+      update_hash = {}
+
+      @values.each do |k, v|
+        # There are a few reasons that we may want to add in a parameter for
+        # update:
+        #
+        #   1. The `force` option has been set.
+        #   2. We know that it was modified.
+        #   3. Its value is a StripeObject. A StripeObject may contain modified
+        #      values within in that its parent StripeObject doesn't know about.
+        #
+        unsaved = @unsaved_values.include?(k)
+        if options[:force] || unsaved || v.is_a?(StripeObject)
+          update_hash[k.to_sym] =
+            serialize_params_value(@values[k], @original_values[k], unsaved, options[:force])
         end
-      when StripeObject
-        unsaved_keys = obj.instance_variable_get(:@unsaved_values)
-        obj_values = obj.instance_variable_get(:@values)
-        update_hash = {}
+      end
 
-        unsaved_keys.each do |k|
-          update_hash[k] = serialize_params(obj_values[k])
-        end
+      # a `nil` that makes it out of `#serialize_params_value` signals an empty
+      # value that we shouldn't appear in the serialized form of the object
+      update_hash.reject! { |_, v| v == nil }
 
-        obj_values.each do |k, v|
-          if v.is_a?(Array)
-            original_value = obj.instance_variable_get(:@original_values)[k]
-
-            # the conditional here tests whether the old and new values are
-            # different (and therefore needs an update), or the same (meaning
-            # we can leave it out of the request)
-            if updated = serialize_params(v, original_value)
-              update_hash[k] = updated
-            else
-              update_hash.delete(k)
-            end
-          elsif v.is_a?(StripeObject) || v.is_a?(Hash)
-            update_hash[k] = obj.serialize_nested_object(k)
-          end
-        end
+      update_hash
+    end
 
-        update_hash
-      else
-        obj
+    class << self
+      # This class method has been deprecated in favor of the instance method
+      # of the same name.
+      def serialize_params(obj, options = {})
+        obj.serialize_params(options)
       end
+      extend Gem::Deprecate
+      deprecate :serialize_params, "#serialize_params", 2016, 9
     end
 
     protected
@@ -249,7 +235,8 @@ module Stripe
                 "We interpret empty strings as nil in requests. " \
                 "You may set #{self}.#{k} = nil to delete the property.")
             end
-            @values[k] = v
+            @values[k] = Util.convert_to_stripe_object(v, @opts)
+            dirty_value!(@values[k])
             @unsaved_values.add(k)
           end
 
@@ -328,7 +315,7 @@ module Stripe
         @unsaved_values.delete(k)
       end
 
-      update_attributes(values, opts)
+      update_attributes(values, opts, :dirty => false)
       values.each do |k, _|
         @transient_values.delete(k)
         @unsaved_values.delete(k)
@@ -336,5 +323,83 @@ module Stripe
 
       self
     end
+
+    def serialize_params_value(value, original, unsaved, force)
+      case value
+      when nil
+        ''
+
+      # The logic here is that essentially any object embedded in another
+      # object that had a `type` is actually an API resource of a different
+      # type that's been included in the response. These other resources must
+      # be updated from their proper endpoints, and therefore they are not
+      # included when serializing even if they've been modified.
+      when APIResource
+        nil
+
+      when Array
+        update = value.map { |v| serialize_params_value(v, nil, true, force) }
+
+        # This prevents an array that's unchanged from being resent.
+        if update != serialize_params_value(original, nil, true, force)
+          update
+        else
+          nil
+        end
+
+      # Handle a Hash for now, but in the long run we should be able to
+      # eliminate all places where hashes are stored as values internally by
+      # making sure any time one is set, we convert it to a StripeObject. This
+      # will simplify our model by making data within an object more
+      # consistent.
+      #
+      # For now, you can still run into a hash if someone appends one to an
+      # existing array being held by a StripeObject. This could happen for
+      # example by appending a new hash onto `additional_owners` for an
+      # account.
+      when Hash
+        Util.convert_to_stripe_object(value, @opts).serialize_params
+
+      when StripeObject
+        update = value.serialize_params(:force => force)
+
+        # If the entire object was replaced, then we need blank each field of
+        # the old object that held a value. The new serialized values will
+        # override any of these empty values.
+        update = empty_values(original).merge(update) if original && unsaved
+
+        update
+
+      else
+        value
+      end
+    end
+
+    private
+
+    def dirty_value!(value)
+      case value
+      when Array
+        value.map { |v| dirty_value!(v) }
+      when StripeObject
+        value.dirty!
+      end
+    end
+
+    # Returns a hash of empty values for all the values that are in the given
+    # StripeObject.
+    def empty_values(obj)
+      values = case obj
+      when Hash         then obj
+      when StripeObject then obj.instance_variable_get(:@values)
+      else
+        raise ArgumentError, "#empty_values got unexpected object type: #{obj.class.name}"
+      end
+
+      values.inject({}) do |update, (k, _)|
+        update[k] = ''
+        update
+      end
+    end
   end
 end

data/lib/stripe/subscription.rb

@@ -3,8 +3,8 @@ module Stripe
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::Delete
 
-    def url
-      "#{Customer.url}/#{CGI.escape(customer)}/subscriptions/#{CGI.escape(id)}"
+    def resource_url
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/subscriptions/#{CGI.escape(id)}"
     end
 
     def self.retrieve(id, opts=nil)
@@ -19,7 +19,7 @@ module Stripe
     private
 
     def discount_url
-      url + '/discount'
+      resource_url + '/discount'
     end
   end
 end

data/lib/stripe/transfer.rb

@@ -10,7 +10,7 @@ module Stripe
     end
 
     def cancel_url
-      url + '/cancel'
+      resource_url + '/cancel'
     end
 
   end

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.36.1'
+  VERSION = '1.36.2'
 end

data/test/stripe/account_test.rb

@@ -121,7 +121,7 @@ module Stripe
         :id => 'acct_1234',
         :external_accounts => {
           :object => "list",
-          :url => "/v1/accounts/acct_1234/external_accounts",
+          :resource_url => "/v1/accounts/acct_1234/external_accounts",
           :data => [],
         }
       }
@@ -140,7 +140,7 @@ module Stripe
         :id => 'acct_1234',
         :external_accounts => {
           :object => "list",
-          :url => "/v1/accounts/acct_1234/external_accounts",
+          :resource_url => "/v1/accounts/acct_1234/external_accounts",
           :data => [{
             :id => "ba_1234",
             :object => "bank_account",
@@ -155,8 +155,8 @@ module Stripe
     should "#serialize_params an a new additional_owners" do
       obj = Stripe::Util.convert_to_stripe_object({
         :object => "account",
-        :legal_entity => {
-        },
+        :legal_entity => Stripe::StripeObject.construct_from({
+        }),
       }, {})
       obj.legal_entity.additional_owners = [
         { :first_name => "Joe" },
@@ -171,7 +171,7 @@ module Stripe
           }
         }
       }
-      assert_equal(expected, obj.class.serialize_params(obj))
+      assert_equal(expected, obj.serialize_params)
     end
 
     should "#serialize_params on an partially changed additional_owners" do
@@ -197,7 +197,7 @@ module Stripe
           }
         }
       }
-      assert_equal(expected, obj.class.serialize_params(obj))
+      assert_equal(expected, obj.serialize_params)
     end
 
     should "#serialize_params on an unchanged additional_owners" do
@@ -220,7 +220,7 @@ module Stripe
           :additional_owners => {}
         }
       }
-      assert_equal(expected, obj.class.serialize_params(obj))
+      assert_equal(expected, obj.serialize_params)
     end
 
     # Note that the empty string that we send for this one has a special
@@ -246,7 +246,7 @@ module Stripe
           :additional_owners => ""
         }
       }
-      assert_equal(expected, obj.class.serialize_params(obj))
+      assert_equal(expected, obj.serialize_params)
     end
   end
 end

data/test/stripe/api_resource_test.rb

@@ -671,7 +671,7 @@ module Stripe
 
         err = assert_raises Stripe::APIConnectionError do
           Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
-        end   
+        end
         assert_match(/Request was retried 2 times/, err.message)
       end
 

data/test/stripe/country_spec_test.rb

@@ -6,8 +6,8 @@ module Stripe
       @mock.expects(:get).once.
       returns(make_response(country_spec_array))
       c = Stripe::CountrySpec.list
-      
-      assert_equal('/v1/country_specs', c.url)
+
+      assert_equal('/v1/country_specs', c.resource_url)
       assert_equal('list', c.object)
       assert(c.data.kind_of?(Array))
       assert_equal('US', c.data[0].id)
@@ -20,17 +20,17 @@ module Stripe
       with('https://api.stripe.com/v1/country_specs/US', nil, nil).
       returns(make_response(resp))
       s = Stripe::CountrySpec.retrieve('US')
-      
-      assert_equal('/v1/country_specs/US', s.url)
+
+      assert_equal('/v1/country_specs/US', s.resource_url)
       assert_equal('country_spec', s.object)
       assert(s.kind_of?(Stripe::CountrySpec))
-      
+
       s.supported_bank_account_currencies.map{ |k,v|  assert v.kind_of?(Array) }
       assert_equal(['US'], s.supported_bank_account_currencies['usd'])
       assert(s.supported_payment_currencies.include?('usd'))
       assert s.supported_payment_currencies.kind_of?(Array)
       assert s.supported_payment_methods.kind_of?(Array)
-      
+
       ['individual', 'company'].map{ |type|
         item = s.verification_fields[type]
         assert item.minimum.include?('external_account')
@@ -40,4 +40,4 @@ module Stripe
       }
     end
   end
-end
+end

data/test/stripe/customer_card_test.rb

@@ -17,14 +17,14 @@ module Stripe
       assert cards[0].kind_of? Stripe::Card
     end
 
-    should "customer cards should have the correct url" do
+    should "customer cards should have the correct resource url" do
       c = customer
       @mock.expects(:get).once.returns(make_response(make_card(
         :id => 'test_card',
         :customer => 'test_customer'
       )))
       card = c.sources.retrieve('card')
-      assert_equal CUSTOMER_CARD_URL, card.url
+      assert_equal CUSTOMER_CARD_URL, card.resource_url
     end
 
     should "customer cards should be deletable" do

data/test/stripe/list_object_test.rb

@@ -31,7 +31,11 @@ module Stripe
       ]
       expected = Util.convert_to_stripe_object(arr, {})
 
-      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 1 }],
+        :has_more => true,
+        :url => "/things",
+      })
       @mock.expects(:get).once.with("#{Stripe.api_base}/things?starting_after=1", nil, nil).
         returns(make_response({ :data => [{ :id => 2 }, { :id => 3}], :has_more => false }))
 
@@ -46,7 +50,11 @@ module Stripe
       ]
       expected = Util.convert_to_stripe_object(arr, {})
 
-      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 1 }],
+        :has_more => true,
+        :url => "/things",
+      })
       @mock.expects(:get).once.with("#{Stripe.api_base}/things?starting_after=1", nil, nil).
         returns(make_response({ :data => [{ :id => 2 }, { :id => 3}], :has_more => false }))
 
@@ -70,7 +78,11 @@ module Stripe
     #
 
     should "fetch a next page through #next_page" do
-      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 1 }],
+        :has_more => true,
+        :url => "/things",
+      })
       @mock.expects(:get).once.with("#{Stripe.api_base}/things?starting_after=1", nil, nil).
         returns(make_response({ :data => [{ :id => 2 }], :has_more => false }))
       next_list = list.next_page
@@ -78,7 +90,11 @@ module Stripe
     end
 
     should "fetch a next page through #next_page and respect limit" do
-      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 1 }],
+        :has_more => true,
+        :url => "/things",
+      })
       list.filters = { :expand => ['data.source'], :limit => 3 }
       @mock.expects(:get).with do |url, _, _|
         u = URI.parse(url)
@@ -94,7 +110,11 @@ module Stripe
     end
 
     should "fetch an empty page through #next_page" do
-      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => false })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 1 }],
+        :has_more => false,
+        :url => "/things",
+      })
       next_list = list.next_page
       assert_equal Stripe::ListObject.empty_list, next_list
     end
@@ -104,7 +124,10 @@ module Stripe
     #
 
     should "fetch a next page through #previous_page" do
-      list = TestListObject.construct_from({ :data => [{ :id => 2 }] })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 2 }],
+        :url => "/things",
+      })
       @mock.expects(:get).once.with("#{Stripe.api_base}/things?ending_before=2", nil, nil).
         returns(make_response({ :data => [{ :id => 1 }] }))
       next_list = list.previous_page
@@ -112,7 +135,10 @@ module Stripe
     end
 
     should "fetch a next page through #previous_page and respect limit" do
-      list = TestListObject.construct_from({ :data => [{ :id => 2 }] })
+      list = TestListObject.construct_from({
+        :data => [{ :id => 2 }],
+        :url => "/things",
+      })
       list.filters = { :expand => ['data.source'], :limit => 3 }
       @mock.expects(:get).with do |url, _, _|
         # apparently URI.parse in 1.8.7 doesn't support query parameters ...
@@ -139,10 +165,10 @@ module Stripe
       @mock.expects(:get).twice.returns(make_response(make_charge_array))
       c = Stripe::Charge.all
       assert c.kind_of?(Stripe::ListObject)
-      assert_equal('/v1/charges', c.url)
+      assert_equal('/v1/charges', c.resource_url)
       all = c.all
       assert all.kind_of?(Stripe::ListObject)
-      assert_equal('/v1/charges', all.url)
+      assert_equal('/v1/charges', all.resource_url)
       assert all.data.kind_of?(Array)
     end
   end
@@ -150,7 +176,4 @@ end
 
 # A helper class with a URL that allows us to try out pagination.
 class TestListObject < Stripe::ListObject
-  def url
-    "/things"
-  end
 end