stripe 1.30.2 → 1.30.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a832c74b94a7a2346a38e3053363aa80f31b04d5
-  data.tar.gz: 2b0d72e9641fdde9d3a4db16e39407ceb33ecd6b
+  metadata.gz: 57a7cdc2de64371c76c7f0a74cc2b179819a6589
+  data.tar.gz: 3d3f0155191a28d7cda3ae40f9551880d0c63f73
 SHA512:
-  metadata.gz: 019e999e649b2f9e39dd0a900aec1b0b44ff19a740ea37663f67ca77749fc93f540b7c4c588e47e30ba050be9ffaca7a8e7d43ccbd518c1781bcc92c077fa3e7
-  data.tar.gz: 692e479177426a0b3974ffa7ed6d5725e01b40ddd61afd0c42fe133b764a0f6b3201afb387f8f17efe7a7d66ed1e5e06e892f21c37a88fc172cdde4d4a3b3700
+  metadata.gz: 57b53ee9cce83fa1bd0a8e78b548594239799e46a1105dbda7d67d33302b7578bbc33280416f78058bc112808a49ea3a57e7e0fd42104fb331b82383832158a7
+  data.tar.gz: 804c78f9c635f021c6e8dec7c1c78a16c9ddf4b43ac81f60782ecec1c247bacd6bd9fd21a6b5b563eb12f815ee5d96b0b16fbe6ecaf8e31251a74a67e3290997

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.30.3 2015-10-28
+
+* Fix bug where arrays that were not `additional_owners` were not properly encoded for requests
+
 === 1.30.2 2015-10-12
 
 * Fix bug where `opts` didn't properly propagate to descendant `StripeObjects`

data/README.rdoc

@@ -1,5 +1,20 @@
 = Stripe Ruby bindings {<img src="https://travis-ci.org/stripe/stripe-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/stripe/stripe-ruby]
 
+The Stripe Ruby bindings provide a small SDK for convenient access to the
+Stripe API from applications written in the Ruby language. It provides a
+pre-defined set of classes for API resources that initialize themselves
+dynamically from API responses which allows the bindings to tolerate a number
+of different versions of the API.
+
+The bindings also provide other features. For example:
+
+* Easy configuration path for fast setup and use.
+* Helpers for pagination.
+* Tracking of "fresh" values in API resources so that partial updates can be
+  executed.
+* Built-in mechanisms for the serialization of parameters according to the
+  expectations of Stripe's API.
+
 == Documentation
 
 {Ruby API Docs}[https://stripe.com/docs/api/ruby#intro]

data/VERSION

@@ -1 +1 @@
-1.30.2
+1.30.3

data/lib/stripe/account.rb

@@ -16,17 +16,56 @@ module Stripe
     # @override To make id optional
     def self.retrieve(id=ARGUMENT_NOT_PROVIDED, opts={})
       id = id.equal?(ARGUMENT_NOT_PROVIDED) ? nil : Util.check_string_argument!(id)
-      # Account used to be a singleton, where this method's signature was `(opts={})`.
-      # For the sake of not breaking folks who pass in an OAuth key in opts, let's lurkily
-      # string match for it.
+
+      # Account used to be a singleton, where this method's signature was
+      # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
+      # key in opts, let's lurkily string match for it.
       if opts == {} && id.is_a?(String) && id.start_with?('sk_')
         # `super` properly assumes a String opts is the apiKey and normalizes as expected.
         opts = id
         id = nil
       end
+
       super(id, opts)
     end
 
+    # Somewhat unfortunately, we attempt to do a special encoding trick when
+    # serializing `additional_owners` under an account: when updating a value,
+    # we actually send the update parameters up as an integer-indexed hash
+    # rather than an array. So instead of this:
+    #
+    #     field[]=item1&field[]=item2&field[]=item3
+    #
+    # We send this:
+    #
+    #     field[0]=item1&field[1]=item2&field[2]=item3
+    #
+    # There are two major problems with this technique:
+    #
+    #     * Entities are addressed by array index, which is not stable and can
+    #       easily result in unexpected results between two different requests.
+    #
+    #     * A replacement of the array's contents is ambiguous with setting a
+    #       subset of the array. Because of this, the only way to shorten an
+    #       array is to unset it completely by making sure it goes into the
+    #       server as an empty string, then setting its contents again.
+    #
+    # We're trying to get this overturned on the server side, but for now,
+    # patch in a special allowance.
+    def self.serialize_params(obj, original_value=nil)
+      update_hash = StripeObject.serialize_params(obj, original_value)
+      case obj
+      when StripeObject
+        obj_values = obj.instance_variable_get(:@values)
+        obj_values.each do |k, v|
+          if k == :additional_owners && v.is_a?(Array)
+            update_hash[k] = serialize_additional_owners(obj, v)
+          end
+        end
+      end
+      update_hash
+    end
+
     def protected_fields
       [:legal_entity]
     end
@@ -47,5 +86,28 @@ module Stripe
     end
 
     ARGUMENT_NOT_PROVIDED = Object.new
+
+    private
+
+    def self.serialize_additional_owners(obj, value)
+      original_value = obj.instance_variable_get(:@original_values)[:additional_owners]
+      if original_value && original_value.length > value.length
+        # url params provide no mechanism for deleting an item in an array,
+        # just overwriting the whole array or adding new items. So let's not
+        # allow deleting without a full overwrite until we have a solution.
+        raise ArgumentError.new(
+          "You cannot delete an item from an array, you must instead set a new array"
+        )
+      end
+
+      update_hash = {}
+      value.each_with_index do |v, i|
+        update = StripeObject.serialize_params(v)
+        if update != {} && (!original_value || update != original_value[i])
+          update_hash[i.to_s] = update
+        end
+      end
+      update_hash
+    end
   end
 end

data/lib/stripe/stripe_object.rb

@@ -170,6 +170,13 @@ module Stripe
       case obj
       when nil
         ''
+      when Array
+        update = obj.map { |v| serialize_params(v) }
+        if original_value != update
+          update
+        else
+          nil
+        end
       when StripeObject
         unsaved_keys = obj.instance_variable_get(:@unsaved_values)
         obj_values = obj.instance_variable_get(:@values)
@@ -180,37 +187,23 @@ module Stripe
         end
 
         obj_values.each do |k, v|
-          if v.is_a?(StripeObject) || v.is_a?(Hash)
-            update_hash[k] = obj.serialize_nested_object(k)
-          elsif v.is_a?(Array)
-            original_value = obj.instance_variable_get(:@original_values)[k]
-            if original_value && original_value.length > v.length
-              # url params provide no mechanism for deleting an item in an array,
-              # just overwriting the whole array or adding new items. So let's not
-              # allow deleting without a full overwrite until we have a solution.
-              raise ArgumentError.new(
-                "You cannot delete an item from an array, you must instead set a new array"
-              )
-            end
-            update_hash[k] = serialize_params(v, original_value)
+           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
-      when Array
-        update_hash = {}
-        obj.each_with_index do |value, index|
-          update = serialize_params(value)
-          if update != {} && (!original_value || update != original_value[index])
-            update_hash[index] = update
-          end
-        end
-
-        if update_hash == {}
-          nil
-        else
-          update_hash
-        end
       else
         obj
       end

data/lib/stripe/util.rb

@@ -116,7 +116,10 @@ module Stripe
 
     def self.flatten_params(params, parent_key=nil)
       result = []
-      params.each do |key, value|
+
+      # 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|
         calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
         if value.is_a?(Hash)
           result += flatten_params(value, calculated_key)

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.30.2'
+  VERSION = '1.30.3'
 end

data/stripe.gemspec

@@ -20,6 +20,14 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('test-unit')
   s.add_development_dependency('rake')
 
+  # to avoid problems, bring Byebug in on just versions of Ruby under which
+  # it's known to work well
+  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0')
+    s.add_development_dependency("byebug")
+    s.add_development_dependency("pry")
+    s.add_development_dependency("pry-byebug")
+  end
+
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/test/stripe/account_test.rb

@@ -68,7 +68,7 @@ module Stripe
 
       @mock.expects(:post).
         once.
-        with('https://api.stripe.com/v1/accounts/acct_foo', nil, 'legal_entity[first_name]=Bob&legal_entity[address][line1]=2+Three+Four').
+        with('https://api.stripe.com/v1/accounts/acct_foo', nil, 'legal_entity[address][line1]=2+Three+Four&legal_entity[first_name]=Bob').
         returns(make_response(resp))
 
       a = Stripe::Account.retrieve('acct_foo')
@@ -151,5 +151,102 @@ module Stripe
       a = Stripe::Account.retrieve
       assert_equal(BankAccount, a.external_accounts.data[0].class)
     end
+
+    should "#serialize_params an a new additional_owners" do
+      obj = Stripe::Util.convert_to_stripe_object({
+        :object => "account",
+        :legal_entity => {
+        },
+      }, {})
+      obj.legal_entity.additional_owners = [
+        { :first_name => "Joe" },
+        { :first_name => "Jane" },
+      ]
+
+      expected = {
+        :legal_entity => {
+          :additional_owners => {
+            "0" => { :first_name => "Joe" },
+            "1" => { :first_name => "Jane" },
+          }
+        }
+      }
+      assert_equal(expected, obj.class.serialize_params(obj))
+    end
+
+    should "#serialize_params on an partially changed additional_owners" do
+      obj = Stripe::Util.convert_to_stripe_object({
+        :object => "account",
+        :legal_entity => {
+          :additional_owners => [
+            Stripe::StripeObject.construct_from({
+              :first_name => "Joe"
+            }),
+            Stripe::StripeObject.construct_from({
+              :first_name => "Jane"
+            }),
+          ]
+        }
+      }, {})
+      obj.legal_entity.additional_owners[1].first_name = "Stripe"
+
+      expected = {
+        :legal_entity => {
+          :additional_owners => {
+            "1" => { :first_name => "Stripe" }
+          }
+        }
+      }
+      assert_equal(expected, obj.class.serialize_params(obj))
+    end
+
+    should "#serialize_params on an unchanged additional_owners" do
+      obj = Stripe::Util.convert_to_stripe_object({
+        :object => "account",
+        :legal_entity => {
+          :additional_owners => [
+            Stripe::StripeObject.construct_from({
+              :first_name => "Joe"
+            }),
+            Stripe::StripeObject.construct_from({
+              :first_name => "Jane"
+            }),
+          ]
+        }
+      }, {})
+
+      expected = {
+        :legal_entity => {
+          :additional_owners => {}
+        }
+      }
+      assert_equal(expected, obj.class.serialize_params(obj))
+    end
+
+    # Note that the empty string that we send for this one has a special
+    # meaning for the server, which interprets it as an array unset.
+    should "#serialize_params on an unset additional_owners" do
+      obj = Stripe::Util.convert_to_stripe_object({
+        :object => "account",
+        :legal_entity => {
+          :additional_owners => [
+            Stripe::StripeObject.construct_from({
+              :first_name => "Joe"
+            }),
+            Stripe::StripeObject.construct_from({
+              :first_name => "Jane"
+            }),
+          ]
+        }
+      }, {})
+      obj.legal_entity.additional_owners = nil
+
+      expected = {
+        :legal_entity => {
+          :additional_owners => ""
+        }
+      }
+      assert_equal(expected, obj.class.serialize_params(obj))
+    end
   end
 end

data/test/stripe/metadata_test.rb

@@ -60,7 +60,7 @@ module Stripe
 
       if is_greater_than_ruby_1_9?
         check_metadata({:metadata => {:initial => 'true'}},
-                      'metadata[uuid]=6735&metadata[initial]=',
+                      'metadata[initial]=&metadata[uuid]=6735',
                       update_actions)
       end
     end

data/test/stripe/stripe_object_test.rb

@@ -99,5 +99,82 @@ module Stripe
       # it to something more useful).
       assert_equal opts, source.instance_variable_get(:@opts)
     end
+
+    should "#serialize_params on an empty object" do
+      obj = Stripe::StripeObject.construct_from({})
+      assert_equal({}, Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on a basic object" do
+      obj = Stripe::StripeObject.construct_from({ :foo => nil })
+      obj.update_attributes(:foo => "bar")
+      assert_equal({ :foo => "bar" }, Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on a more complex object" do
+      obj = Stripe::StripeObject.construct_from({
+        :foo => Stripe::StripeObject.construct_from({
+          :bar => nil,
+          :baz => nil,
+        }),
+      })
+      obj.foo.bar = "newbar"
+      assert_equal({ :foo => { :bar => "newbar" } },
+        Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on an array" do
+      obj = Stripe::StripeObject.construct_from({
+        :foo => nil,
+      })
+      obj.foo = ["new-value"]
+      assert_equal({ :foo => ["new-value"] },
+        Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on an array that shortens" do
+      obj = Stripe::StripeObject.construct_from({
+        :foo => ["0-index", "1-index", "2-index"],
+      })
+      obj.foo = ["new-value"]
+      assert_equal({ :foo => ["new-value"] },
+        Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on an array that lengthens" do
+      obj = Stripe::StripeObject.construct_from({
+        :foo => ["0-index", "1-index", "2-index"],
+      })
+      obj.foo = ["new-value"] * 4
+      assert_equal({ :foo => ["new-value"] * 4 },
+        Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on an array of hashes" do
+      obj = Stripe::StripeObject.construct_from({
+        :foo => nil,
+      })
+      obj.foo = [
+        Stripe::StripeObject.construct_from({
+          :bar => nil
+        })
+      ]
+      obj.foo[0].bar = "baz"
+      assert_equal({ :foo => [{ :bar => "baz" }] },
+        Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params doesn't include unchanged values" do
+      obj = Stripe::StripeObject.construct_from({ :foo => nil })
+      assert_equal({}, Stripe::StripeObject.serialize_params(obj))
+    end
+
+    should "#serialize_params on an array that is unchanged" do
+      obj = Stripe::StripeObject.construct_from({
+        :foo => ["0-index", "1-index", "2-index"],
+      })
+      obj.foo = ["0-index", "1-index", "2-index"]
+      assert_equal({}, Stripe::StripeObject.serialize_params(obj))
+    end
   end
 end

data/test/stripe/util_test.rb

@@ -10,6 +10,9 @@ module Stripe
         [:c, "bar&baz"],
         [:d, { :a => "a", :b => "b" }],
         [:e, [0, 1]],
+
+        # note the empty hash won't even show up in the request
+        [:f, []]
       ]
       assert_equal(
         "a=3&b=%2Bfoo%3F&c=bar%26baz&d[a]=a&d[b]=b&e[]=0&e[]=1",
@@ -33,8 +36,8 @@ module Stripe
         [:d, { :a => "a", :b => "b" }],
         [:e, [0, 1]],
         [:f, [
-          { :foo => "1", :bar => "2" },
-          { :foo => "3", :baz => "4" },
+          { :bar => "1", :foo => "2" },
+          { :baz => "3", :foo => "4" },
         ]],
       ]
       assert_equal([
@@ -49,10 +52,10 @@ module Stripe
         # *The key here is the order*. In order to be properly interpreted as
         # an array of hashes on the server, everything from a single hash must
         # come in at once. A duplicate key in an array triggers a new element.
-        ["f[][foo]", "1"],
-        ["f[][bar]", "2"],
-        ["f[][foo]", "3"],
-        ["f[][baz]", "4"],
+        ["f[][bar]", "1"],
+        ["f[][foo]", "2"],
+        ["f[][baz]", "3"],
+        ["f[][foo]", "4"],
       ], Stripe::Util.flatten_params(params))
     end
 
@@ -84,5 +87,31 @@ module Stripe
       assert_raise { Stripe::Util.normalize_opts(nil) }
       assert_raise { Stripe::Util.normalize_opts(:api_key => nil) }
     end
+
+    should "#convert_to_stripe_object should pass through unknown types" do
+      obj = Util.convert_to_stripe_object(7, {})
+      assert_equal 7, obj
+    end
+
+    should "#convert_to_stripe_object should turn hashes into StripeObjects" do
+      obj = Util.convert_to_stripe_object({ :foo => "bar" }, {})
+      assert obj.is_a?(StripeObject)
+      assert_equal "bar", obj.foo
+    end
+
+    should "#convert_to_stripe_object should turn lists into ListObjects" do
+      obj = Util.convert_to_stripe_object({ :object => "list" }, {})
+      assert obj.is_a?(ListObject)
+    end
+
+    should "#convert_to_stripe_object should marshal other classes" do
+      obj = Util.convert_to_stripe_object({ :object => "account" }, {})
+      assert obj.is_a?(Account)
+    end
+
+    should "#convert_to_stripe_object should marshal arrays" do
+      obj = Util.convert_to_stripe_object([1, 2, 3], {})
+      assert_equal [1, 2, 3], obj
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.30.2
+  version: 1.30.3
 platform: ruby
 authors:
 - Ross Boucher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -95,6 +95,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
 email: