stripe 1.29.1 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b9e8f6bee77355210ab7840518f5431fa5f6d64
-  data.tar.gz: 41d8c8947f222064f0828654a4c50a427e4e1c1c
+  metadata.gz: 061c68a3e8fbf7b2adfa0a93489b1b124b08cb37
+  data.tar.gz: 4fda58089700ad1f39ab8a084b09982679b4e9a1
 SHA512:
-  metadata.gz: 1a8cb17d34c2059cea9e03130a8f866bf69f97e50c7b7a9db0d7996e303dad9a6513cd912aac2f761201564b1bd00796dda984244d88bc843f6c544662eead7b
-  data.tar.gz: 424ec01caad2a38b43e2655381ccad190fba4e7fc8bfb1e46111b181d364273de0215e07b6bd6773a1557b9267eb054d0d91b1ae464c68b726fa2f1573c1edca
+  metadata.gz: b2f3f7dff2c30038b9608f825f542061eccb6461bb1c0a9bebfb754ac5d7031c00e4df16e0a753edf92c5934435dcd1bfe191dfd2bdd5744c67ffdc268f3e16c
+  data.tar.gz: b68dfc54c11b18e6081a5794c89d717812607f334c60744f7b0cf0ba2a65a337f8f0465c4e092471cb3709e30df8fc62267550b73d255857914b40c1d9f32c47

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.30.0 2015-10-09
+
+* Add `StripeObject#deleted?` for a reliable way to check whether an object is alive
+* Deprecate `StripeObject#refresh_from`
+* New parameter encoding scheme that doesn't use `URI.escape`
+
 === 1.29.1 2015-10-06
 
 * Fix bug where ampersands were not being properly encoded

data/VERSION

@@ -1 +1 @@
-1.29.1
+1.30.0

data/lib/stripe.rb

@@ -64,6 +64,7 @@ require 'stripe/errors/rate_limit_error'
 
 module Stripe
   DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
+
   @api_base = 'https://api.stripe.com'
   @connect_base = 'https://connect.stripe.com'
   @uploads_base = 'https://uploads.stripe.com'
@@ -120,13 +121,13 @@ module Stripe
     case method.to_s.downcase.to_sym
     when :get, :head, :delete
       # Make params into GET parameters
-      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+      url += "#{URI.parse(url).query ? '&' : '?'}#{Util.encode_parameters(params)}" if params && params.any?
       payload = nil
     else
       if headers[:content_type] && headers[:content_type] == "multipart/form-data"
         payload = params
       else
-        payload = uri_encode(params)
+        payload = Util.encode_parameters(params)
       end
     end
 
@@ -205,10 +206,13 @@ module Stripe
     "uname lookup failed"
   end
 
-
+  # DEPRECATED. Use `Util#encode_parameters` instead.
   def self.uri_encode(params)
-    Util.flatten_params(params).
-      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+    Util.encode_parameters(params)
+  end
+  class << self
+    extend Gem::Deprecate
+    deprecate :uri_encode, "Stripe::Util#encode_parameters", 2016, 01
   end
 
   def self.request_headers(api_key)

data/lib/stripe/account.rb

@@ -36,7 +36,7 @@ module Stripe
     end
 
     def legal_entity=(_)
-      raise NoMethodError.new('Overridding legal_entity can cause cause serious issues. Instead, set the individual fields of legal_entity like blah.legal_entity.first_name = \'Blah\'')
+      raise NoMethodError.new('Overridding legal_entity can cause serious issues. Instead, set the individual fields of legal_entity like blah.legal_entity.first_name = \'Blah\'')
     end
 
     def deauthorize(client_id, opts={})

data/lib/stripe/api_operations/delete.rb

@@ -4,7 +4,7 @@ module Stripe
       def delete(params={}, opts={})
         opts = Util.normalize_opts(opts)
         response, opts = request(:delete, url, params, opts)
-        refresh_from(response, opts)
+        initialize_from(response, opts)
       end
     end
   end

data/lib/stripe/api_operations/update.rb

@@ -20,7 +20,7 @@ module Stripe
         # We started unintentionally (sort of) allowing attributes send to
         # +save+ to override values used during the update. So as not to break
         # the API, this makes that official here.
-        update_attributes_with_options(params, :raise_error => false)
+        update_attributes(params)
 
         # Now remove any parameters that look like object attributes.
         params = params.reject { |k, _| respond_to?(k) }
@@ -33,7 +33,7 @@ module Stripe
           values.delete(:id)
 
           response, opts = request(:post, req_url, values)
-          refresh_from(response, opts)
+          initialize_from(response, opts)
         end
         self
       end

data/lib/stripe/api_resource.rb

@@ -22,7 +22,7 @@ module Stripe
 
     def refresh
       response, opts = request(:get, url, @retrieve_params)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     def self.retrieve(id, opts={})

data/lib/stripe/application_fee.rb

@@ -8,7 +8,7 @@ module Stripe
 
     def refund(params={}, opts={})
       response, opts = request(:post, refund_url, params, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     private

data/lib/stripe/charge.rb

@@ -6,23 +6,23 @@ module Stripe
 
     def refund(params={}, opts={})
       response, opts = request(:post, refund_url, params, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     def capture(params={}, opts={})
       response, opts = request(:post, capture_url, params, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     def update_dispute(params={}, opts={})
       response, opts = request(:post, dispute_url, params, opts)
-      refresh_from({ :dispute => response }, opts, true)
+      initialize_from({ :dispute => response }, opts, true)
       dispute
     end
 
     def close_dispute(params={}, opts={})
       response, opts = request(:post, close_dispute_url, params, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     def mark_as_fraudulent
@@ -30,7 +30,7 @@ module Stripe
         :fraud_details => { :user_report => 'fraudulent' }
       }
       response, opts = request(:post, url, params)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     def mark_as_safe
@@ -38,7 +38,7 @@ module Stripe
         :fraud_details => { :user_report => 'safe' }
       }
       response, opts = request(:post, url, params)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     private

data/lib/stripe/customer.rb

@@ -37,25 +37,25 @@ module Stripe
 
     def cancel_subscription(params={}, opts={})
       response, opts = request(:delete, subscription_url, params, opts)
-      refresh_from({ :subscription => response }, opts, true)
+      initialize_from({ :subscription => response }, opts, true)
       subscription
     end
 
     def update_subscription(params={}, opts={})
       response, opts = request(:post, subscription_url, params, opts)
-      refresh_from({ :subscription => response }, opts, true)
+      initialize_from({ :subscription => response }, opts, true)
       subscription
     end
 
     def create_subscription(params={}, opts={})
       response, opts = request(:post, subscriptions_url, params, opts)
-      refresh_from({ :subscription => response }, opts, true)
+      initialize_from({ :subscription => response }, opts, true)
       subscription
     end
 
     def delete_discount
       _, opts = request(:delete, discount_url)
-      refresh_from({ :discount => nil }, opts, true)
+      initialize_from({ :discount => nil }, opts, true)
     end
 
     private

data/lib/stripe/dispute.rb

@@ -6,7 +6,7 @@ module Stripe
 
     def close(params={}, opts={})
       response, opts = request(:post, close_url, params, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     def close_url

data/lib/stripe/invoice.rb

@@ -11,7 +11,7 @@ module Stripe
 
     def pay(opts={})
       response, opts = request(:post, pay_url, {}, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     private

data/lib/stripe/order.rb

@@ -6,7 +6,7 @@ module Stripe
 
     def pay(params, opts={})
       response, opts = request(:post, pay_url, params, opts)
-      refresh_from(response, opts)
+      initialize_from(response, opts)
     end
 
     private

data/lib/stripe/stripe_object.rb

@@ -22,7 +22,9 @@ module Stripe
 
     def self.construct_from(values, opts={})
       values = Stripe::Util.symbolize_names(values)
-      self.new(values[:id]).refresh_from(values, opts)
+
+      # work around protected #initialize_from for now
+      self.new(values[:id]).send(:initialize_from, values, opts)
     end
 
     # Determines the equality of two Stripe objects. Stripe objects are
@@ -32,6 +34,13 @@ module Stripe
       @values == other.instance_variable_get(:@values)
     end
 
+    # Indicates whether or not the resource has been deleted on the server.
+    # Note that some, but not all, resources can indicate whether they have
+    # been deleted.
+    def deleted?
+      @values.fetch(:deleted, false)
+    end
+
     def to_s(*args)
       JSON.pretty_generate(@values)
     end
@@ -41,40 +50,36 @@ module Stripe
       "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
     end
 
+    # Re-initializes the object based on a hash of values (usually one that's
+    # come back from an API call). Adds or removes value accessors as necessary
+    # and updates the state of internal data.
+    #
+    # Please don't use this method. If you're trying to do mass assignment, try
+    # #initialize_from instead.
     def refresh_from(values, opts, partial=false)
-      @opts = Util.normalize_opts(opts)
-      @original_values = Marshal.load(Marshal.dump(values)) # deep copy
-
-      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
-      added = Set.new(values.keys - @values.keys)
-
-      # Wipe old state before setting new.  This is useful for e.g. updating a
-      # customer, where there is no persistent card parameter.  Mark those values
-      # which don't persist as transient
-
-      instance_eval do
-        remove_accessors(removed)
-        add_accessors(added, values)
-      end
-
-      removed.each do |k|
-        @values.delete(k)
-        @transient_values.add(k)
-        @unsaved_values.delete(k)
-      end
-
-      update_attributes_with_options(values, :opts => opts)
-      values.each do |k, _|
-        @transient_values.delete(k)
-        @unsaved_values.delete(k)
-      end
-
-      return self
+      initialize_from(values, opts, partial)
     end
+    extend Gem::Deprecate
+    deprecate :refresh_from, "#update_attributes", 2016, 01
 
     # Mass assigns attributes on the model.
-    def update_attributes(values)
-      update_attributes_with_options(values, {})
+    #
+    # This is a version of +update_attributes+ that takes some extra options
+    # for internal use.
+    #
+    # ==== Attributes
+    #
+    # * +values+ - Hash of values to use to update the current attributes of
+    #   the object.
+    #
+    # ==== Options
+    #
+    # * +:opts+ Options for StripeObject like an API key.
+    def update_attributes(values, opts = {})
+      values.each do |k, v|
+        @values[k] = Util.convert_to_stripe_object(v, opts)
+        @unsaved_values.add(k)
+      end
     end
 
     def [](k)
@@ -294,6 +299,49 @@ module Stripe
       @values && @values.has_key?(symbol) || super
     end
 
+    # Re-initializes the object based on a hash of values (usually one that's
+    # come back from an API call). Adds or removes value accessors as necessary
+    # and updates the state of internal data.
+    #
+    # Protected on purpose! Please do not expose.
+    #
+    # ==== Options
+    #
+    # * +:values:+ Hash used to update accessors and values.
+    # * +:opts:+ Options for StripeObject like an API key.
+    # * +:partial:+ Indicates that the re-initialization should not attempt to
+    #   remove accessors.
+    def initialize_from(values, opts, partial=false)
+      @opts = Util.normalize_opts(opts)
+      @original_values = Marshal.load(Marshal.dump(values)) # deep copy
+
+      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      added = Set.new(values.keys - @values.keys)
+
+      # Wipe old state before setting new.  This is useful for e.g. updating a
+      # customer, where there is no persistent card parameter.  Mark those values
+      # which don't persist as transient
+
+      instance_eval do
+        remove_accessors(removed)
+        add_accessors(added, values)
+      end
+
+      removed.each do |k|
+        @values.delete(k)
+        @transient_values.add(k)
+        @unsaved_values.delete(k)
+      end
+
+      update_attributes(values, :opts => opts)
+      values.each do |k, _|
+        @transient_values.delete(k)
+        @unsaved_values.delete(k)
+      end
+
+      self
+    end
+
     # Mass assigns attributes on the model.
     #
     # This is a version of +update_attributes+ that takes some extra options

data/lib/stripe/subscription.rb

@@ -13,7 +13,7 @@ module Stripe
 
     def delete_discount
       response, opts = request(:delete, discount_url)
-      refresh_from({ :discount => nil }, opts, true)
+      initialize_from({ :discount => nil }, opts, true)
     end
 
     private

data/lib/stripe/transfer.rb

@@ -6,7 +6,7 @@ module Stripe
 
     def cancel
       response, api_key = Stripe.request(:post, cancel_url, @api_key)
-      refresh_from(response, api_key)
+      initialize_from(response, api_key)
     end
 
     def cancel_url

data/lib/stripe/util.rb

@@ -1,3 +1,5 @@
+require "cgi"
+
 module Stripe
   module Util
     def self.objects_to_ids(h)
@@ -92,14 +94,30 @@ module Stripe
       end
     end
 
+    # Encodes a hash of parameters in a way that's suitable for use as query
+    # parameters in a URI or as form parameters in a request body. This mainly
+    # involves escaping special characters from parameter keys and values (e.g.
+    # `&`).
+    def self.encode_parameters(params)
+      Util.flatten_params(params).
+        map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
+    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.
     def self.url_encode(key)
-      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      CGI.escape(key.to_s).
+        # Don't use strict form encoding by changing the square bracket control
+        # characters back to their literals. This is fine by the server, and
+        # makes these parameter strings easier to read.
+        gsub('%5B', '[').gsub('%5D', ']')
     end
 
     def self.flatten_params(params, parent_key=nil)
       result = []
       params.each do |key, value|
-        calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
+        calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
         if value.is_a?(Hash)
           result += flatten_params(value, calculated_key)
         elsif value.is_a?(Array)
@@ -108,7 +126,12 @@ module Stripe
           result << [calculated_key, value]
         end
       end
-      result
+
+      # The #sort_by call here is mostly so that we can get some stability in
+      # our 1.8.7 test suite where Hash key order is not preserved.
+      #
+      # https://www.igvita.com/2009/02/04/ruby-19-internals-ordered-hash/
+      result.sort_by { |(k, _)| k }
     end
 
     def self.flatten_params_array(value, calculated_key)

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.29.1'
+  VERSION = '1.30.0'
 end

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%20Three%20Four').
+        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')

data/test/stripe/api_resource_test.rb

@@ -230,7 +230,7 @@ module Stripe
 
       should "urlencode values in GET params" do
         response = make_response(make_charge_array)
-        @mock.expects(:get).with("#{Stripe.api_base}/v1/charges?customer=test%20customer", nil, nil).returns(response)
+        @mock.expects(:get).with("#{Stripe.api_base}/v1/charges?customer=test+customer", nil, nil).returns(response)
         charges = Stripe::Charge.list(:customer => 'test customer').data
         assert charges.kind_of? Array
       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
@@ -93,7 +93,7 @@ module Stripe
           obj.metadata['uuid'] = '6735'
         end
         params = {:metadata => {'type' => 'summer', 'uuid' => '6735'}}
-        curl_args = Stripe.uri_encode(params)
+        curl_args = Stripe::Util.encode_parameters(params)
         check_metadata({:metadata => {'type' => 'christmas'}},
                        curl_args,
                        update_actions)

data/test/stripe/stripe_object_test.rb

@@ -11,6 +11,17 @@ module Stripe
       refute obj1 == obj3
     end
 
+    should "implement #deleted?" do
+      obj = Stripe::StripeObject.construct_from({})
+      refute obj.deleted?
+
+      obj = Stripe::StripeObject.construct_from({ :deleted => false })
+      refute obj.deleted?
+
+      obj = Stripe::StripeObject.construct_from({ :deleted => true })
+      assert obj.deleted?
+    end
+
     should "implement #respond_to" do
       obj = Stripe::StripeObject.construct_from({ :id => 1, :foo => 'bar' })
       assert obj.respond_to?(:id)
@@ -53,10 +64,25 @@ module Stripe
       obj.update_attributes(:name => 'STRIPE')
       assert_equal "STRIPE", obj.name
 
-      e = assert_raises(ArgumentError) do
-        obj.update_attributes(:foo => 'bar')
+      # unfortunately, we even assign unknown properties to duplicate the
+      # behavior that we currently have via magic accessors with
+      # method_missing
+      obj.update_attributes(:unknown => 'foo')
+      assert_equal "foo", obj.unknown
+    end
+
+    should "warn that #refresh_from is deprecated" do
+      old_stderr = $stderr
+      $stderr = StringIO.new
+      begin
+        obj = Stripe::StripeObject.construct_from({})
+        obj.refresh_from({}, {})
+        message = "NOTE: Stripe::StripeObject#refresh_from is " +
+          "deprecated; use #update_attributes instead"
+        assert_match Regexp.new(message), $stderr.string
+      ensure
+        $stderr = old_stderr
       end
-      assert_equal "foo is not an attribute that can be assigned on this object", e.message
     end
   end
 end

data/test/stripe/util_test.rb

@@ -2,7 +2,48 @@ require File.expand_path('../../test_helper', __FILE__)
 
 module Stripe
   class UtilTest < Test::Unit::TestCase
-    should "symbolize_names should convert names to symbols" do
+    should "#encode_parameters should prepare parameters for an HTTP request" do
+      params = {
+        :a => 3,
+        :b => "+foo?",
+        :c => "bar&baz",
+        :d => { :a => "a", :b => "b" },
+        :e => [0, 1],
+      }
+      assert_equal(
+        "a=3&b=%2Bfoo%3F&c=bar%26baz&d[a]=a&d[b]=b&e[]=0&e[]=1",
+        Stripe::Util.encode_parameters(params)
+      )
+    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)
+      assert_equal "foo%2B",   Stripe::Util.url_encode("foo+")
+      assert_equal "foo%26",   Stripe::Util.url_encode("foo&")
+      assert_equal "foo[bar]", Stripe::Util.url_encode("foo[bar]")
+    end
+
+    should "#flatten_params should encode parameters according to Rails convention" do
+      params = {
+        :a => 3,
+        :b => "foo?",
+        :c => "bar&baz",
+        :d => { :a => "a", :b => "b" },
+        :e => [0, 1],
+      }
+      assert_equal([
+        ["a",    3],
+        ["b",    "foo?"],
+        ["c",    "bar&baz"],
+        ["d[a]", "a"],
+        ["d[b]", "b"],
+        ["e[]",  0],
+        ["e[]",  1],
+      ], Stripe::Util.flatten_params(params))
+    end
+
+    should "#symbolize_names should convert names to symbols" do
       start = {
         'foo' => 'bar',
         'array' => [{ 'foo' => 'bar' }],
@@ -26,7 +67,7 @@ module Stripe
       assert_equal(finish, symbolized)
     end
 
-    should "normalize_opts should reject nil keys" do
+    should "#normalize_opts should reject nil keys" do
       assert_raise { Stripe::Util.normalize_opts(nil) }
       assert_raise { Stripe::Util.normalize_opts(:api_key => nil) }
     end

data/test/stripe_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class StripeTest < Test::Unit::TestCase
+  should "warn that #refresh_from is deprecated" do
+    old_stderr = $stderr
+    $stderr = StringIO.new
+    begin
+      Stripe.uri_encode({})
+      message = "NOTE: Stripe.uri_encode is deprecated; use " +
+        "Stripe::Util#encode_parameters instead"
+      assert_match Regexp.new(message), $stderr.string
+    ensure
+      $stderr = old_stderr
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.29.1
+  version: 1.30.0
 platform: ruby
 authors:
 - Ross Boucher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -193,6 +193,7 @@ files:
 - test/stripe/subscription_test.rb
 - test/stripe/transfer_test.rb
 - test/stripe/util_test.rb
+- test/stripe_test.rb
 - test/test_data.rb
 - test/test_helper.rb
 homepage: https://stripe.com/api
@@ -247,6 +248,7 @@ test_files:
 - test/stripe/subscription_test.rb
 - test/stripe/transfer_test.rb
 - test/stripe/util_test.rb
+- test/stripe_test.rb
 - test/test_data.rb
 - test/test_helper.rb
 has_rdoc: