stripe 3.11.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 981d54e75ed0dc6a6c6e9134cbf338a2d8ed02e7169afc93f37c5c65d1e23955
-  data.tar.gz: 844de1199f90a2e1eb32f2a011fda913b0ee3c799cd670c8dd42d441d0135805
+SHA1:
+  metadata.gz: 78c2ddb890e46edf9e8e3d9b726ea6799d3aea52
+  data.tar.gz: ac32ac6e198a21dc2dd448a00601801d604e56fb
 SHA512:
-  metadata.gz: 7890d0984cb8d83aec246a5fe745f2e57343e1b1c256343e79c49f35479de9cbafd90046dd00b537339a6b08257eb9dd39a1aa96f420059d5596584f7f2b7bd5
-  data.tar.gz: 371d48d97dedf110422c91e70b25be7aa092576f55e87d5b1cf3e3d336b847ff9e0000fa18bd5f234459f33dd9b5826a7400fc53c7ac8939ac42de3c831220f3
+  metadata.gz: df6c4329f75ef7bb548630cc4d097d900b2a006c45d14c9bdea8884c9d27ccf7cfe746c302bc8e14bff25dc02c5a1d6b9f10967c97f86aa29628d6cfe0bcc5dd
+  data.tar.gz: 1e467d30f83de17b389f656343e90f5f9725e769e16b2c54fa755e8767cb7c13bb81d375f2671dccf8831d2d0a73f3a505939c3861860d9ecadf153a006d9d7d

data/.rubocop_todo.yml

@@ -22,7 +22,7 @@ Metrics/ClassLength:
 
 # Offense count: 11
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 15
 
 # Offense count: 259
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
@@ -47,7 +47,7 @@ Metrics/ParameterLists:
 
 # Offense count: 5
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 17
 
 # Offense count: 2
 Style/ClassVars:

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.12.0 - 2018-04-05
+* [#632](https://github.com/stripe/stripe-ruby/pull/632) Introduce `additive_object_param` so that non-`metadata` subobjects don't zero their keys as they're being replaced
+
 ## 3.11.0 - 2018-02-26
 * [#628](https://github.com/stripe/stripe-ruby/pull/628) Add support for `code` attribute on all Stripe exceptions
 

data/VERSION

@@ -1 +1 @@
-3.11.0
+3.12.0

data/lib/stripe/api_operations/save.rb

@@ -62,6 +62,15 @@ module Stripe
       end
 
       def self.included(base)
+        # Set `metadata` as additive so that when it's set directly we remember
+        # to clear keys that may have been previously set by sending empty
+        # values for them.
+        #
+        # It's possible that not every object with `Save` has `metadata`, but
+        # it's a close enough heuristic, and having this option set when there
+        # is no `metadata` field is not harmful.
+        base.additive_object_param(:metadata)
+
         base.extend(ClassMethods)
       end
 

data/lib/stripe/stripe_object.rb

@@ -7,6 +7,66 @@ module Stripe
     # The default :id method is deprecated and isn't useful to us
     undef :id if method_defined?(:id)
 
+    # Sets the given parameter name to one which is known to be an additive
+    # object.
+    #
+    # Additive objects are subobjects in the API that don't have the same
+    # semantics as most subobjects, which are fully replaced when they're set.
+    # This is best illustrated by example. The `source` parameter sent when
+    # updating a subscription is *not* additive; if we set it:
+    #
+    #     source[object]=card&source[number]=123
+    #
+    # We expect the old `source` object to have been overwritten completely. If
+    # the previous source had an `address_state` key associated with it and we
+    # didn't send one this time, that value of `address_state` is gone.
+    #
+    # By contrast, additive objects are those that will have new data added to
+    # them while keeping any existing data in place. The only known case of its
+    # use is for `metadata`, but it could in theory be more general. As an
+    # example, say we have a `metadata` object that looks like this on the
+    # server side:
+    #
+    #     metadata = { old: "old_value" }
+    #
+    # If we update the object with `metadata[new]=new_value`, the server side
+    # object now has *both* fields:
+    #
+    #     metadata = { old: "old_value", new: "new_value" }
+    #
+    # This is okay in itself because usually users will want to treat it as
+    # additive:
+    #
+    #     obj.metadata[:new] = "new_value"
+    #     obj.save
+    #
+    # However, in other cases, they may want to replace the entire existing
+    # contents:
+    #
+    #     obj.metadata = { new: "new_value" }
+    #     obj.save
+    #
+    # This is where things get a little bit tricky because in order to clear
+    # any old keys that may have existed, we actually have to send an explicit
+    # empty string to the server. So the operation above would have to send
+    # this form to get the intended behavior:
+    #
+    #     metadata[old]=&metadata[new]=new_value
+    #
+    # This method allows us to track which parameters are considered additive,
+    # and lets us behave correctly where appropriate when serializing
+    # parameters to be sent.
+    def self.additive_object_param(name)
+      @additive_params ||= Set.new
+      @additive_params << name
+    end
+
+    # Returns whether the given name is an additive object parameter. See
+    # `.additive_object_param` for details.
+    def self.additive_object_param?(name)
+      !@additive_params.nil? && @additive_params.include?(name)
+    end
+
     def initialize(id = nil, opts = {})
       id, @retrieve_params = Util.normalize_id(id)
       @opts = Util.normalize_opts(opts)
@@ -410,10 +470,14 @@ module Stripe
       elsif value.is_a?(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
+        # If the entire object was replaced and this is an additive object,
+        # then we need blank each field of the old object that held a value
+        # because otherwise the update to the keys of the object will be
+        # additive instead of a full replacement. The new serialized values
+        # will override any of these empty values.
+        if original && unsaved && key && self.class.additive_object_param?(key)
+          update = empty_values(original).merge(update)
+        end
 
         update
 

data/lib/stripe/subscription.rb

@@ -25,13 +25,8 @@ module Stripe
     end
 
     def serialize_params(options = {})
-      update_hash = super
-      if @unsaved_values.include?(:items)
-        value = Util.array_to_hash(@values[:items])
-        update_hash[:items] =
-          serialize_params_value(value, nil, true, options[:force], key: :items)
-      end
-      update_hash
+      @values[:items] = Util.array_to_hash(@values[:items]) if @values[:items]
+      super
     end
 
     private

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = "3.11.0".freeze
+  VERSION = "3.12.0".freeze
 end

data/test/stripe/stripe_object_test.rb

@@ -303,12 +303,27 @@ module Stripe
       assert_equal({ foo: "bar" }, serialized[:metadata])
     end
 
-    should "#serialize_params with a StripeObject that's been replaced" do
-      obj = Stripe::StripeObject.construct_from(metadata: Stripe::StripeObject.construct_from(bar: "foo"))
+    should "#serialize_params with StripeObject that's been replaced" do
+      obj = Stripe::StripeObject.construct_from(source: Stripe::StripeObject.construct_from(bar: "foo"))
 
-      # Here we replace the object wholesale which means that the client must
-      # be able to blank out the values that were in the old object, but which
-      # are no longer present in the new one.
+      # Here we replace the object wholesale.
+      obj.source =
+        Stripe::StripeObject.construct_from(baz: "foo")
+
+      serialized = obj.serialize_params
+      assert_equal({ baz: "foo" }, serialized[:source])
+    end
+
+    should "#serialize_params with StripeObject that's been replaced which is `metadata`" do
+      class WithAdditiveObjectParam < Stripe::StripeObject
+        additive_object_param :metadata
+      end
+
+      obj = WithAdditiveObjectParam.construct_from(metadata: Stripe::StripeObject.construct_from(bar: "foo"))
+
+      # Here we replace the object wholesale. Because it's `metadata`, the
+      # client must be able to blank out the values that were in the old
+      # object, but which are no longer present in the new one.
       obj.metadata =
         Stripe::StripeObject.construct_from(baz: "foo")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Stripe API