stripe 1.50.1 → 1.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7a6e05be384fc9ff98e33581d00aeb9deead4fb
-  data.tar.gz: 4dde279ff2795efc7d7607b0772ca594fa4afd26
+  metadata.gz: 53821741b8b4c5d1ab26760b8dc79065a2b2ebf9
+  data.tar.gz: d61f8ae7d2501b2d4d3198fd31aebea2a07cf105
 SHA512:
-  metadata.gz: 0773fbcc58390263df79f5d53b186689b4f6b95ca22463502b99754c47227f49610d92e85fb48a529f38c05ceb23ea2c7769582b17179ea9352dc9a8a68ac8a4
-  data.tar.gz: 260b73c85e24a8fc19fede4dd078e3b84ecb217b0edcb5f720c33cbf20ba9778ed006d1ef721c46a89147893a4599bee29aaade8e9686d4a81bed0cdf4399e35
+  metadata.gz: 6c4d5995dd5bbdd5ea063a79023a9467932470fb1299c69e73d1e9758600a4e890d66caa410680a7e2c13579a7b76bec62565d0cb665fbee5feb3c6124a049ce
+  data.tar.gz: 8db2e0a89f0327bb3b9c3fcbd61630dbab4d19d2b2150381ca551db9c4fda1b4778b8f972bf62f358db45173395e25969031466a9fb3352cc6de092d45cb9766

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.51.0 2016-08-26
+
+* Error when an array of maps is detected that cannot be accurately encoded
+* Start using strings for header names instead of symbols for better clarity
+
 === 1.50.1 2016-08-25
 
 * Fix encoding of arrays of maps where maps unequal sets of keys

data/VERSION

@@ -1 +1 @@
-1.50.1
+1.51.0

data/lib/stripe.rb

@@ -303,24 +303,24 @@ module Stripe
 
   def self.request_headers(api_key, method)
     headers = {
-      :user_agent => "Stripe/v1 RubyBindings/#{Stripe::VERSION}",
-      :authorization => "Bearer #{api_key}",
-      :content_type => 'application/x-www-form-urlencoded'
+      'User-Agent' => "Stripe/v1 RubyBindings/#{Stripe::VERSION}",
+      'Authorization' => "Bearer #{api_key}",
+      'Content-Type' => 'application/x-www-form-urlencoded'
     }
 
     # It is only safe to retry network failures on post and delete
     # requests if we add an Idempotency-Key header
     if [:post, :delete].include?(method) && self.max_network_retries > 0
-      headers[:idempotency_key] ||= SecureRandom.uuid
+      headers['Idempotency-Key'] ||= SecureRandom.uuid
     end
 
-    headers[:stripe_version] = api_version if api_version
-    headers[:stripe_account] = stripe_account if stripe_account
+    headers['Stripe-Version'] = api_version if api_version
+    headers['Stripe-Account'] = stripe_account if stripe_account
 
     begin
-      headers.update(:x_stripe_client_user_agent => JSON.generate(user_agent))
+      headers.update('X-Stripe-Client-User-Agent' => JSON.generate(user_agent))
     rescue => e
-      headers.update(:x_stripe_client_raw_user_agent => user_agent.inspect,
+      headers.update('X-Stripe-Client-Raw-User-Agent' => user_agent.inspect,
                      :error => "#{e} (#{e.class})")
     end
   end

data/lib/stripe/util.rb

@@ -140,6 +140,7 @@ module Stripe
         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]
@@ -196,5 +197,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.50.1'
+  VERSION = '1.51.0'
 end

data/test/stripe/api_resource_test.rb

@@ -174,7 +174,7 @@ module Stripe
       context "with no global API key set" do
         should "use the per-object credential when creating" do
           Stripe.expects(:execute_request).with do |opts|
-            opts[:headers][:authorization] == 'Bearer sk_test_local'
+            opts[:headers]['Authorization'] == 'Bearer sk_test_local'
           end.returns(make_response(make_charge))
 
           Stripe::Charge.create({:card => {:number => '4242424242424242'}},
@@ -193,7 +193,7 @@ module Stripe
 
         should "use the per-object credential when creating" do
           Stripe.expects(:execute_request).with do |opts|
-            opts[:headers][:authorization] == 'Bearer local'
+            opts[:headers]['Authorization'] == 'Bearer local'
           end.returns(make_response(make_charge))
 
           Stripe::Charge.create({:card => {:number => '4242424242424242'}},
@@ -203,11 +203,11 @@ module Stripe
         should "use the per-object credential when retrieving and making other calls" do
           Stripe.expects(:execute_request).with do |opts|
             opts[:url] == "#{Stripe.api_base}/v1/charges/ch_test_charge" &&
-              opts[:headers][:authorization] == 'Bearer local'
+              opts[:headers]['Authorization'] == 'Bearer local'
           end.returns(make_response(make_charge))
           Stripe.expects(:execute_request).with do |opts|
             opts[:url] == "#{Stripe.api_base}/v1/charges/ch_test_charge/refunds" &&
-              opts[:headers][:authorization] == 'Bearer local'
+              opts[:headers]['Authorization'] == 'Bearer local'
           end.returns(make_response(make_refund))
 
           ch = Stripe::Charge.retrieve('ch_test_charge', 'local')
@@ -405,7 +405,7 @@ module Stripe
 
       should "updating should use the supplied api_key" do
         Stripe.expects(:execute_request).with do |opts|
-          opts[:headers][:authorization] == 'Bearer sk_test_local'
+          opts[:headers]['Authorization'] == 'Bearer sk_test_local'
         end.returns(make_response(make_customer))
         c = Stripe::Customer.new
         c.save({}, { :api_key => 'sk_test_local' })
@@ -725,7 +725,7 @@ module Stripe
       should 'ensure there is always an idempotency_key on POST requests' do
         SecureRandom.expects(:uuid).at_least_once.returns("random_key")
         Stripe.expects(:execute_request).with do |opts|
-          opts[:headers][:idempotency_key] == "random_key"
+          opts[:headers]['Idempotency-Key'] == "random_key"
         end.returns(make_response({"id" => "myid"}))
 
         Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
@@ -734,7 +734,7 @@ module Stripe
       should 'ensure there is always an idempotency_key on DELETE requests' do
         SecureRandom.expects(:uuid).at_least_once.returns("random_key")
         Stripe.expects(:execute_request).with do |opts|
-          opts[:headers][:idempotency_key] == "random_key"
+          opts[:headers]['Idempotency-Key'] == "random_key"
         end.returns(make_response({"id" => "myid"}))
 
         c = Stripe::Customer.construct_from(make_customer)
@@ -742,6 +742,12 @@ module Stripe
       end
 
       should 'not override a provided idempotency_key' do
+        # Note that this expectation looks like `:idempotency_key` instead of
+        # the header `Idempotency-Key` because it's user provided as seen
+        # below. The ones injected by the library itself look like headers
+        # (`Idempotency-Key`), but rest-client does allow this symbol
+        # formatting and will properly override the system generated one as
+        # expected.
         Stripe.expects(:execute_request).with do |opts|
           opts[:headers][:idempotency_key] == "provided_key"
         end.returns(make_response({"id" => "myid"}))

data/test/stripe/charge_test.rb

@@ -138,7 +138,7 @@ module Stripe
         :amount => 100,
         :source => 'btcrcv_test_receiver',
         :currency => "usd",
-        :level3 => [{:red => 'firstred'}, {:one => 'fish', :red => 'another'}]
+        :level3 => [{:red => 'firstred'}, {:red => 'another', :one => 'fish'}]
       })
       assert c.paid
     end

data/test/stripe/invoice_test.rb

@@ -38,7 +38,7 @@ module Stripe
       Stripe.expects(:execute_request).with do |opts|
         opts[:url] == "#{Stripe.api_base}/v1/invoices/in_test_invoice/pay" &&
           opts[:method] == :post &&
-          opts[:headers][:authorization] == 'Bearer foobar'
+          opts[:headers]['Authorization'] == 'Bearer foobar'
       end.returns(make_response(make_paid_invoice))
 
       i.pay

data/test/stripe/util_test.rb

@@ -20,6 +20,34 @@ module Stripe
       )
     end
 
+    should "#encode_params should throw an error on an array of maps that cannot be encoded" do
+      params = {
+        :a => [
+          { :a => 1, :b => 2 },
+          { :c => 3, :a => 4 },
+        ]
+      }
+      e = assert_raises(ArgumentError) do
+        Stripe::Util.encode_parameters(params)
+      end
+      expected = "All maps nested in an array should start with the same key " +
+        "(expected starting key 'a', got 'c')"
+      assert_equal expected, e.message
+
+      # Make sure the check is recursive by taking our original params and
+      # nesting it into yet another map and array. Should throw exactly the
+      # same error because it's still the in inner array of maps that's wrong.
+      params = {
+        :x => [
+          params
+        ]
+      }
+      e = assert_raises(ArgumentError) do
+        Stripe::Util.encode_parameters(params)
+      end
+      assert_equal expected, e.message
+    end
+
     should "#url_encode should prepare strings for HTTP" do
       assert_equal "foo",      Stripe::Util.url_encode("foo")
       assert_equal "foo",      Stripe::Util.url_encode(:foo)

data/test/stripe_test.rb

@@ -43,7 +43,7 @@ class StripeTest < Test::Unit::TestCase
     Stripe.stripe_account = 'acct_1234'
 
     Stripe.expects(:execute_request).with(
-      has_entry(:headers, has_entry(:stripe_account, 'acct_1234')),
+      has_entry(:headers, has_entry('Stripe-Account', 'acct_1234')),
     ).returns(make_response(response))
 
     Stripe.request(:post, '/v1/account', 'sk_live12334566')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.50.1
+  version: 1.51.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client