stripe 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa445bd78b07bd208f1b693f173ac8f554e3f9a0
-  data.tar.gz: c4f1334cf81a71e6ffbf8c2b87b1f6bb53e3c953
+  metadata.gz: 482b4a27be7ebd463dacdc270465e84dd6a59a7d
+  data.tar.gz: b594a2a801f966bbf72f2c8825e3a56620124d01
 SHA512:
-  metadata.gz: 95423d6dd94213f236d462fa0764bfa88cadc1a490ad89749fb0bdf78622e6c78a9523e35ca74a8c27e3be9e980a67d39c90e473219176e21a4f0970008edcce
-  data.tar.gz: 9fae58a91cad0929d902ba5c34e782260cfc998a708c20299d69f864fb09941b063ede335cbe455b03fd1c43bb45ca5d12dbcbd0b13f44887c16b3c63bb4a575
+  metadata.gz: 0bb43636c63f12d659e76d4e29cc02b960d738bdba5160c55232335c600845bd199bb780e4ee822b520bb8422d41450bf0f82992743f87679cd3d03f86018913
+  data.tar.gz: 919a6651eab63dd5b0da21841514bd904fc0ab0529778aaf36696aa81405aa863740ad78206b9d1fc5baaa56a40dcde5b0273e50728a80ae89cdf5b4a6adca7c

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1

data/Gemfile

@@ -1,8 +1,2 @@
 source "https://rubygems.org"
 gemspec
-
-if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.3')
-  gem 'i18n', '< 0.7'
-  gem 'rest-client', '~> 1.6.8'
-  gem 'activesupport', '~> 3.2'
-end

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.32.0 2016-01-05
+
+* Add configuration to optionally retry network failures
+* Use modern API endpoint for producing application fee refunds
+
 === 1.31.0 2015-10-29
 
 * Add BankAccount#verify convenience method

data/README.rdoc

@@ -32,14 +32,7 @@ If you want to build the gem from source:
 
 == Requirements
 
-* Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load
-  ActiveSupport.) For Ruby versions before 1.9.2, you'll need to add this to your Gemfile:
-
-    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.2')
-      gem 'rest-client', '~> 1.6.8'
-    end
-
-
+* Ruby 1.9.3 or above.
 * rest-client, json
 
 == Bundler
@@ -66,3 +59,16 @@ Run a single test suite:
 Run a single test:
 
     bundle exec ruby -Ilib/ test/stripe/util_test.rb -n /should.convert.names.to.symbols/
+
+== Configuration
+
+=== max_network_retries
+
+When `max_network_retries` is set to a positive integer, stripe will retry requests that 
+fail on a network error.  Idempotency keys will be added to post and get requests to ensure the 
+safety of retrying.  There will be a short delay between each retry, with an exponential backoff
+algorithm used to determine the length of the delay.  Default value is 0.
+
+Example:
+
+    Stripe.max_network_retries = 2

data/VERSION

@@ -1 +1 @@
-1.31.0
+1.32.0

data/gemfiles/default-with-activesupport.gemfile

@@ -1,10 +1,4 @@
 source "https://rubygems.org"
 gemspec :path => File.join(File.dirname(__FILE__), "..")
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
-  gem 'i18n', '< 0.7'
-  gem 'rest-client', '~> 1.6.8'
-  gem 'activesupport', '~> 3.2'
-else
-  gem 'activesupport'
-end
+gem 'activesupport'

data/gemfiles/json.gemfile

@@ -1,12 +1,5 @@
 source "https://rubygems.org"
 gemspec :path => File.join(File.dirname(__FILE__), "..")
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
-  gem 'i18n', '< 0.7'
-  gem 'rest-client', '~> 1.6.8'
-  gem 'activesupport', '~> 3.2'
-else
-  gem 'activesupport'
-end
-
+gem 'activesupport'
 gem 'json'

data/gemfiles/yajl.gemfile

@@ -1,12 +1,5 @@
 source "https://rubygems.org"
 gemspec :path => File.join(File.dirname(__FILE__), "..")
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
-  gem 'i18n', '< 0.7'
-  gem 'rest-client', '~> 1.6.8'
-  gem 'activesupport', '~> 3.2'
-else
-  gem 'activesupport'
-end
-
+gem 'activesupport'
 gem 'yajl-ruby'

data/lib/stripe.rb

@@ -69,6 +69,9 @@ module Stripe
   @connect_base = 'https://connect.stripe.com'
   @uploads_base = 'https://uploads.stripe.com'
 
+  @max_network_retry_delay = 2
+  @initial_network_retry_delay = 0.5
+
   @ssl_bundle_path  = DEFAULT_CA_BUNDLE_PATH
   @verify_ssl_certs = true
 
@@ -78,6 +81,8 @@ module Stripe
   class << self
     attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version, :connect_base, :uploads_base,
                   :open_timeout, :read_timeout
+
+    attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 
   def self.api_url(url='', api_base_url=nil)
@@ -131,19 +136,35 @@ module Stripe
       end
     end
 
-    request_opts.update(:headers => request_headers(api_key).update(headers),
+    request_opts.update(:headers => request_headers(api_key, method).update(headers),
                         :method => method, :open_timeout => open_timeout,
                         :payload => payload, :url => url, :timeout => read_timeout)
 
+    response = execute_request_with_rescues(request_opts, api_base_url)
+
+    [parse(response), api_key]
+  end
+
+  def self.max_network_retries
+    @max_network_retries || 0
+  end
+
+  def self.max_network_retries=(val)
+    @max_network_retries = val.to_i
+  end
+
+  private
+
+  def self.execute_request_with_rescues(request_opts, api_base_url, retry_count = 0)
     begin
       response = execute_request(request_opts)
     rescue SocketError => e
-      handle_restclient_error(e, api_base_url)
+      response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
     rescue NoMethodError => e
       # Work around RestClient bug
       if e.message =~ /\WRequestFailed\W/
         e = APIConnectionError.new('Unexpected HTTP response code')
-        handle_restclient_error(e, api_base_url)
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
       else
         raise
       end
@@ -151,17 +172,15 @@ module Stripe
       if e.response
         handle_api_error(e.response)
       else
-        handle_restclient_error(e, api_base_url)
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
       end
     rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e, api_base_url)
+      response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
     end
 
-    [parse(response), api_key]
+    response
   end
 
-  private
-
   def self.user_agent
     @uname ||= get_uname
     lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
@@ -215,13 +234,19 @@ module Stripe
     deprecate :uri_encode, "Stripe::Util#encode_parameters", 2016, 01
   end
 
-  def self.request_headers(api_key)
+  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'
     }
 
+    # 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 
+    end
+
     headers[:stripe_version] = api_version if api_version
 
     begin
@@ -303,7 +328,15 @@ module Stripe
     APIError.new(error[:message], resp.code, resp.body, error_obj, resp.headers)
   end
 
-  def self.handle_restclient_error(e, api_base_url=nil)
+  def self.handle_restclient_error(e, request_opts, retry_count, api_base_url=nil)
+
+    if should_retry?(e, retry_count)
+      retry_count = retry_count + 1
+      sleep sleep_time(retry_count)
+      response = execute_request_with_rescues(request_opts, api_base_url, retry_count)
+      return response
+    end
+
     api_base_url = @api_base unless api_base_url
     connection_message = "Please check your internet connection and try again. " \
         "If this problem persists, you should check Stripe's service status at " \
@@ -334,6 +367,31 @@ module Stripe
 
     end
 
+    if retry_count > 0
+      message += " Request was retried #{retry_count} times."
+    end
+
     raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
   end
+
+  def self.should_retry?(e, retry_count)
+    return false if retry_count >= self.max_network_retries
+    return false if e.is_a?(RestClient::SSLCertificateNotVerified)
+    return true
+  end
+
+  def self.sleep_time(retry_count)
+    # This method was adapted from https://github.com/ooyala/retries/blob/master/lib/retries.rb
+
+    # The sleep time is an exponentially-increasing function of base_sleep_seconds. But, it never exceeds
+    # max_sleep_seconds.
+    sleep_seconds = [initial_network_retry_delay * (2 ** (retry_count - 1)), max_network_retry_delay].min
+    # Randomize to a random value in the range sleep_seconds/2 .. sleep_seconds
+
+    sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
+    # But never sleep less than base_sleep_seconds
+    sleep_seconds = [initial_network_retry_delay, sleep_seconds].max
+
+    sleep_seconds
+  end
 end

data/lib/stripe/application_fee.rb

@@ -6,15 +6,15 @@ module Stripe
       '/v1/application_fees'
     end
 
+    # If you don't need access to an updated fee object after the refund, it's
+    # more performant to just call `fee.refunds.create` directly.
     def refund(params={}, opts={})
-      response, opts = request(:post, refund_url, params, opts)
-      initialize_from(response, opts)
-    end
-
-    private
+      self.refunds.create
 
-    def refund_url
-      url + '/refund'
+      # now that a refund has been created, we expect the state of this object
+      # to change as well (i.e. `refunded` will now be `true`) so refresh it
+      # from the server
+      self.refresh
     end
   end
 end

data/lib/stripe/stripe_object.rb

@@ -187,19 +187,19 @@ module Stripe
         end
 
         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
+          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)
+            update_hash[k] = obj.serialize_nested_object(k)
           end
         end
 
@@ -243,8 +243,8 @@ module Stripe
           define_method(k_eq) do |v|
             if v == ""
               raise ArgumentError.new(
-                "You cannot set #{k} to an empty string." \
-                "We interpret empty strings as nil in requests." \
+                "You cannot set #{k} to an empty string. " \
+                "We interpret empty strings as nil in requests. " \
                 "You may set #{self}.#{k} = nil to delete the property.")
             end
             @values[k] = v

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.31.0'
+  VERSION = '1.32.0'
 end

data/stripe.gemspec

@@ -5,6 +5,7 @@ require 'stripe/version'
 spec = Gem::Specification.new do |s|
   s.name = 'stripe'
   s.version = Stripe::VERSION
+  s.required_ruby_version = '>= 1.9.3'
   s.summary = 'Ruby bindings for the Stripe API'
   s.description = 'Stripe is the easiest way to accept payments online.  See https://stripe.com for details.'
   s.authors = ['Ross Boucher', 'Greg Brockman']

data/test/stripe/api_resource_test.rb

@@ -658,5 +658,119 @@ module Stripe
         account.save(:display_name => 'stripe')
       end
     end
+
+    context "with retries" do
+
+      setup do
+        Stripe.stubs(:max_network_retries).returns(2)
+      end
+
+      should 'retry failed network requests if specified and raise if error persists' do        
+        Stripe.expects(:sleep_time).at_least_once.returns(0)
+        @mock.expects(:post).times(3).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(Errno::ECONNREFUSED.new)
+        
+        err = assert_raises Stripe::APIConnectionError do
+          Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
+        end   
+        assert_match(/Request was retried 2 times/, err.message)   
+      end
+
+      should 'retry failed network requests if specified and return successful response' do
+        Stripe.expects(:sleep_time).at_least_once.returns(0)
+        response = make_response({"id" => "myid"})
+        err = Errno::ECONNREFUSED.new
+        @mock.expects(:post).times(2).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(err).then.returns(response)
+
+        result = Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
+        assert_equal "myid", result.id
+      end
+
+      should 'not retry a SSLCertificateNotVerified error' do
+        @mock.expects(:post).times(1).with('https://api.stripe.com/v1/charges', nil, 'amount=50&currency=usd').raises(RestClient::SSLCertificateNotVerified.new('message'))
+        
+        err = assert_raises Stripe::APIConnectionError do
+          Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
+        end   
+        assert_no_match(/retried/, err.message)   
+      end
+
+      should 'not add an idempotency key to GET requests' do
+        SecureRandom.expects(:uuid).times(0)
+        Stripe.expects(:execute_request).with do |opts|
+          opts[:headers][:idempotency_key].nil?
+        end.returns(make_response({"id" => "myid"}))
+
+        Stripe::Charge.list
+      end
+
+      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"
+        end.returns(make_response({"id" => "myid"}))
+
+        Stripe::Charge.create(:amount => 50, :currency => 'usd', :card => { :number => nil })
+      end
+
+      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"
+        end.returns(make_response({"id" => "myid"}))
+
+        c = Stripe::Customer.construct_from(make_customer)
+        c.delete
+      end
+
+      should 'not override a provided idempotency_key' do
+        Stripe.expects(:execute_request).with do |opts|
+          opts[:headers][:idempotency_key] == "provided_key"
+        end.returns(make_response({"id" => "myid"}))
+
+        Stripe::Charge.create({:amount => 50, :currency => 'usd', :card => { :number => nil }}, {:idempotency_key => 'provided_key'})
+      end
+
+    end
+
+    context "sleep_time" do
+
+      should "should grow exponentially" do
+        Stripe.stubs(:rand).returns(1)
+        Stripe.stubs(:max_network_retry_delay).returns(999)
+        assert_equal(Stripe.initial_network_retry_delay, Stripe.sleep_time(1))
+        assert_equal(Stripe.initial_network_retry_delay * 2, Stripe.sleep_time(2))
+        assert_equal(Stripe.initial_network_retry_delay * 4, Stripe.sleep_time(3))
+        assert_equal(Stripe.initial_network_retry_delay * 8, Stripe.sleep_time(4))
+      end
+
+      should "enforce the max_network_retry_delay" do
+        Stripe.stubs(:rand).returns(1)
+        Stripe.stubs(:initial_network_retry_delay).returns(1)
+        Stripe.stubs(:max_network_retry_delay).returns(2)
+        assert_equal(1, Stripe.sleep_time(1))
+        assert_equal(2, Stripe.sleep_time(2))
+        assert_equal(2, Stripe.sleep_time(3))
+        assert_equal(2, Stripe.sleep_time(4))
+      end
+
+      should "add some randomness" do
+        random_value = 0.8
+        Stripe.stubs(:rand).returns(random_value)
+        Stripe.stubs(:initial_network_retry_delay).returns(1)
+        Stripe.stubs(:max_network_retry_delay).returns(8)
+
+        base_value = Stripe.initial_network_retry_delay * (0.5 * (1 + random_value))
+
+        # the initial value cannot be smaller than the base,
+        # so the randomness is ignored
+        assert_equal(Stripe.initial_network_retry_delay, Stripe.sleep_time(1))
+
+        # after the first one, the randomness is applied
+        assert_equal(base_value * 2, Stripe.sleep_time(2))
+        assert_equal(base_value * 4, Stripe.sleep_time(3))
+        assert_equal(base_value * 8, Stripe.sleep_time(4))
+      end
+
+    end
   end
 end

data/test/stripe/application_fee_test.rb

@@ -12,9 +12,18 @@ module Stripe
     end
 
     should "application fees should be refundable" do
-      @mock.expects(:get).never
-      @mock.expects(:post).once.returns(make_response({:id => "fee_test_fee", :refunded => true}))
-      fee = Stripe::ApplicationFee.new("test_application_fee")
+      fee = Stripe::ApplicationFee.construct_from(make_application_fee)
+
+      # first a post to create a refund
+      @mock.expects(:post).once.
+        with("#{Stripe.api_base}/v1/application_fees/#{fee.id}/refunds", nil, '').
+        returns(make_response(make_application_fee_refund))
+
+      # then a get to refresh the current object
+      @mock.expects(:get).once.
+        with("#{Stripe.api_base}/v1/application_fees/#{fee.id}", nil, nil).
+        returns(make_response({:id => "fee_test_fee", :refunded => true}))
+
       fee.refund
       assert fee.refunded
     end

data/test/stripe/list_object_test.rb

@@ -81,10 +81,8 @@ module Stripe
       list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
       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 ...
-        url, query = url.split("?")
         u = URI.parse(url)
-        params = CGI.parse(query)
+        params = CGI.parse(u.query)
         u.host == URI.parse(Stripe.api_base).host && u.path == "/things" && params == {
           "expand[]"       => ["data.source"],
           "limit"          => ["3"],

data/test/stripe/util_test.rb

@@ -3,19 +3,19 @@ require File.expand_path('../../test_helper', __FILE__)
 module Stripe
   class UtilTest < Test::Unit::TestCase
     should "#encode_parameters should prepare parameters for an HTTP request" do
-      # use array instead of hash for 1.8.7 ordering
-      params = [
-        [:a, 3],
-        [:b, "+foo?"],
-        [:c, "bar&baz"],
-        [:d, { :a => "a", :b => "b" }],
-        [:e, [0, 1]],
+      params = {
+        :a => 3,
+        :b => "+foo?",
+        :c => "bar&baz",
+        :d => { :a => "a", :b => "b" },
+        :e => [0, 1],
+        :f => "",
 
         # note the empty hash won't even show up in the request
-        [:f, []]
-      ]
+        :g => [],
+      }
       assert_equal(
-        "a=3&b=%2Bfoo%3F&c=bar%26baz&d[a]=a&d[b]=b&e[]=0&e[]=1",
+        "a=3&b=%2Bfoo%3F&c=bar%26baz&d[a]=a&d[b]=b&e[]=0&e[]=1&f=",
         Stripe::Util.encode_parameters(params)
       )
     end

data/test/test_helper.rb

@@ -31,11 +31,11 @@ class Test::Unit::TestCase
   setup do
     @mock = mock
     Stripe.mock_rest_client = @mock
-    Stripe.api_key="foo"
+    Stripe.api_key = "foo"
   end
 
   teardown do
     Stripe.mock_rest_client = nil
-    Stripe.api_key=nil
+    Stripe.api_key = nil
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Ross Boucher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -251,7 +251,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="