stripe 5.4.0 → 5.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a4f568f2aa887474af9b072e52b0b97de8ec04f72ee52595682192f3c75998
-  data.tar.gz: 7791a3d16f6b79d8e100821d241981532326527bbd805be585f20f2bb70338d8
+  metadata.gz: dc4c445567a38782dc843a338247615185c7f7f37a41e7fc7112ae09a9b80863
+  data.tar.gz: 3feccf9203d4c39fcb2abb6ceee3cae6e501d2194a91117d6802fb2ecf151f2a
 SHA512:
-  metadata.gz: 31a50d23fc166cf97222b0e51b307d5356693d92596d56ab1bdefb885f8c9de941567d2c38102dca0ce1ae8f92a38a6ccb36f52b98293ed16b1c944c5d298a45
-  data.tar.gz: bf4c8207a3f9c6a4ec955309fd54f235002edb9e82a7a313d3c5dff0f7ff83f0b57bfb683c77ac693a3132977dd6c7ddf48f58176c985c1a34b6b9bfc072f806
+  metadata.gz: bb4acdf7e1d6c198f93b383fa6963a1222fcfc40fc3893ce005978e350a48995a2cd8c2507ac957284406a36eaeaa018db5b29d53092269b5dba1302dddfcc7f
+  data.tar.gz: 56f2cb939da176b60462370323bd5aff987b6d7ab2d12965833843d3fd8ad81bf9f1cd9f4ae65ebda1340a6c9eeba1a634d77ccaeff41e437abf3660c081dcb5

data/.rubocop.yml

@@ -4,6 +4,12 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3
 
+  Exclude:
+    # brandur: Exclude ephmeral script-like files that I use to try and
+    # reproduce problems with the library. If you know of a better way of doing
+    # this (e.g. exclude files not tracked by Git), feel free to change it.
+    - "example_*"
+
 Layout/CaseIndentation:
   EnforcedStyle: end
 

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 5.7.1 - 2019-10-15
+* [#869](https://github.com/stripe/stripe-ruby/pull/869) Fixes the misnamed `connection_base=` setter to be named `connect_base=`
+
+## 5.7.0 - 2019-10-10
+* [#865](https://github.com/stripe/stripe-ruby/pull/865) Support backwards pagination with list's `#auto_paging_each`
+
+## 5.6.0 - 2019-10-04
+* [#861](https://github.com/stripe/stripe-ruby/pull/861) Nicer error when specifying non-nil non-string opt value
+
+## 5.5.0 - 2019-10-03
+* [#859](https://github.com/stripe/stripe-ruby/pull/859) User-friendly messages and retries for `EOFError`, `Errno::ECONNRESET`, `Errno::ETIMEDOUT`, and `Errno::EHOSTUNREACH` network errors
+
+## 5.4.1 - 2019-10-01
+* [#858](https://github.com/stripe/stripe-ruby/pull/858) Drop Timecop dependency
+
 ## 5.4.0 - 2019-10-01
 * [#857](https://github.com/stripe/stripe-ruby/pull/857) Move to monotonic time for duration calculations
 

data/Gemfile

@@ -11,7 +11,6 @@ group :development do
   gem "rake"
   gem "shoulda-context"
   gem "test-unit"
-  gem "timecop"
   gem "webmock"
 
   # Rubocop changes pretty quickly: new cops get added and old cops change

data/VERSION

@@ -1 +1 @@
-5.4.0
+5.7.1

data/lib/stripe.rb

@@ -139,8 +139,8 @@ module Stripe
     end
   end
 
-  def self.connection_base=(connection_base)
-    @connection_base = connection_base
+  def self.connect_base=(connect_base)
+    @connect_base = connect_base
     StripeClient.clear_all_connection_managers
   end
 

data/lib/stripe/api_operations/list.rb

@@ -11,12 +11,7 @@ module Stripe
 
         # set filters so that we can fetch the same limit, expansions, and
         # predicates when accessing the next and previous pages
-        #
-        # just for general cleanliness, remove any paging options
         obj.filters = filters.dup
-        obj.filters.delete(:ending_before)
-        obj.filters.delete(:starting_after)
-
         obj
       end
     end

data/lib/stripe/api_operations/request.rb

@@ -8,6 +8,8 @@ module Stripe
           warn_on_opts_in_params(params)
 
           opts = Util.normalize_opts(opts)
+          error_on_non_string_user_opts(opts)
+
           opts[:client] ||= StripeClient.active_client
 
           headers = opts.clone
@@ -31,10 +33,24 @@ module Stripe
           [resp, opts_to_persist]
         end
 
+        private def error_on_non_string_user_opts(opts)
+          Util::OPTS_USER_SPECIFIED.each do |opt|
+            next unless opts.key?(opt)
+
+            val = opts[opt]
+            next if val.nil?
+            next if val.is_a?(String)
+
+            raise ArgumentError,
+                  "request option '#{opt}' should be a string value " \
+                    "(was a #{val.class})"
+          end
+        end
+
         private def warn_on_opts_in_params(params)
           Util::OPTS_USER_SPECIFIED.each do |opt|
             if params.key?(opt)
-              warn("WARNING: #{opt} should be in opts instead of params.")
+              warn("WARNING: '#{opt}' should be in opts instead of params.")
             end
           end
         end

data/lib/stripe/list_object.rb

@@ -51,6 +51,16 @@ module Stripe
     # Iterates through each resource in all pages, making additional fetches to
     # the API as necessary.
     #
+    # The default iteration direction is forwards according to Stripe's API
+    # "natural" ordering direction -- newer objects first, and moving towards
+    # older objects.
+    #
+    # However, if the initial list object was fetched using an `ending_before`
+    # cursor (and only `ending_before`, `starting_after` cannot also be
+    # included), the method assumes that the user is trying to iterate
+    # backwards compared to natural ordering and returns results that way --
+    # older objects first, and moving towards newer objects.
+    #
     # Note that this method will make as many API calls as necessary to fetch
     # all resources. For more granular control, please see +each+ and
     # +next_page+.
@@ -59,8 +69,18 @@ module Stripe
 
       page = self
       loop do
-        page.each(&blk)
-        page = page.next_page
+        # Backward iterating activates if we have an `ending_before` constraint
+        # and _just_ an `ending_before` constraint. If `starting_after` was
+        # also used, we iterate forwards normally.
+        if filters.include?(:ending_before) &&
+           !filters.include?(:starting_after)
+          page.reverse_each(&blk)
+          page = page.previous_page
+        else
+          page.each(&blk)
+          page = page.next_page
+        end
+
         break if page.empty?
       end
     end
@@ -96,6 +116,8 @@ module Stripe
     # This method will try to respect the limit of the current page. If none
     # was given, the default limit will be fetched again.
     def previous_page(params = {}, opts = {})
+      return self.class.empty_list(opts) unless has_more
+
       first_id = data.first.id
 
       params = filters.merge(ending_before: first_id).merge(params)
@@ -107,5 +129,11 @@ module Stripe
       url ||
         raise(ArgumentError, "List object does not contain a 'url' field.")
     end
+
+    # Iterates through each resource in the page represented by the current
+    # `ListObject` in reverse.
+    def reverse_each(&blk)
+      data.reverse_each(&blk)
+    end
   end
 end

data/lib/stripe/stripe_client.rb

@@ -81,17 +81,17 @@ module Stripe
     def self.should_retry?(error, method:, num_retries:)
       return false if num_retries >= Stripe.max_network_retries
 
-      # Retry on timeout-related problems (either on open or read).
-      return true if error.is_a?(Net::OpenTimeout)
-      return true if error.is_a?(Net::ReadTimeout)
-
-      # Destination refused the connection, the connection was reset, or a
-      # variety of other connection failures. This could occur from a single
-      # saturated server, so retry in case it's intermittent.
-      return true if error.is_a?(Errno::ECONNREFUSED)
-      return true if error.is_a?(SocketError)
-
-      if error.is_a?(Stripe::StripeError)
+      case error
+      when Net::OpenTimeout, Net::ReadTimeout
+        # Retry on timeout-related problems (either on open or read).
+        true
+      when EOFError, Errno::ECONNREFUSED, Errno::ECONNRESET,
+            Errno::EHOSTUNREACH, Errno::ETIMEDOUT, SocketError
+        # Destination refused the connection, the connection was reset, or a
+        # variety of other connection failures. This could occur from a single
+        # saturated server, so retry in case it's intermittent.
+        true
+      when Stripe::StripeError
         # The API may ask us not to retry (e.g. if doing so would be a no-op),
         # or advise us to retry (e.g. in cases of lock timeouts). Defer to
         # those instructions if given.
@@ -119,10 +119,10 @@ module Stripe
         return true if error.http_status == 500 && method != :post
 
         # 503 Service Unavailable
-        return true if error.http_status == 503
+        error.http_status == 503
+      else
+        false
       end
-
-      false
     end
 
     def self.sleep_time(num_retries)
@@ -296,7 +296,11 @@ module Stripe
     # The original error message is also appended onto the final exception for
     # full transparency.
     NETWORK_ERROR_MESSAGES_MAP = {
+      EOFError => ERROR_MESSAGE_CONNECTION,
       Errno::ECONNREFUSED => ERROR_MESSAGE_CONNECTION,
+      Errno::ECONNRESET => ERROR_MESSAGE_CONNECTION,
+      Errno::EHOSTUNREACH => ERROR_MESSAGE_CONNECTION,
+      Errno::ETIMEDOUT => ERROR_MESSAGE_TIMEOUT_CONNECT,
       SocketError => ERROR_MESSAGE_CONNECTION,
 
       Net::OpenTimeout => ERROR_MESSAGE_TIMEOUT_CONNECT,

data/lib/stripe/util.rb

@@ -178,9 +178,8 @@ module Stripe
     # to calculate an elapsed duration.
     #
     # Shortcut for getting monotonic time, mostly for purposes of line length
-    # and stubbing (Timecop doesn't freeze the monotonic clock). Returns time
-    # in seconds since the event used for monotonic reference purposes by the
-    # platform (e.g. system boot time).
+    # and test stubbing. Returns time in seconds since the event used for
+    # monotonic reference purposes by the platform (e.g. system boot time).
     def self.monotonic_time
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.4.0"
+  VERSION = "5.7.1"
 end

data/test/stripe/api_resource_test.rb

@@ -227,6 +227,23 @@ module Stripe
         end
       end
 
+      should "error if a user-specified opt is given a non-nil non-string value" do
+        stub_request(:post, "#{Stripe.api_base}/v1/charges")
+          .to_return(body: JSON.generate(charge_fixture))
+
+        # Works fine if not included or a string.
+        Stripe::Charge.create({ amount: 100, currency: "usd" }, {})
+        Stripe::Charge.create({ amount: 100, currency: "usd" }, idempotency_key: "12345")
+
+        # Errors on a non-string.
+        e = assert_raises(ArgumentError) do
+          Stripe::Charge.create({ amount: 100, currency: "usd" }, idempotency_key: :foo)
+        end
+        assert_equal "request option 'idempotency_key' should be a string value " \
+                       "(was a Symbol)",
+                     e.message
+      end
+
       should "requesting with a unicode ID should result in a request" do
         stub_request(:get, "#{Stripe.api_base}/v1/customers/%E2%98%83")
           .to_return(body: JSON.generate(make_missing_id_error), status: 404)

data/test/stripe/list_object_test.rb

@@ -25,20 +25,80 @@ module Stripe
       assert_equal expected, list.each.to_a
     end
 
-    should "provide #auto_paging_each" do
+    should "provide #reverse_each" do
       arr = [
         { id: 1 },
         { id: 2 },
         { id: 3 },
       ]
+      expected = Util.convert_to_stripe_object(arr.reverse, {})
+      list = Stripe::ListObject.construct_from(data: arr)
+      assert_equal expected, list.reverse_each.to_a
+    end
+
+    should "provide #auto_paging_each that supports forward pagination" do
+      arr = [
+        { id: 1 },
+        { id: 2 },
+        { id: 3 },
+        { id: 4 },
+        { id: 5 },
+        { id: 6 },
+      ]
       expected = Util.convert_to_stripe_object(arr, {})
 
+      # Initial list object to page on. Notably, its last data element will be
+      # used as a cursor to fetch the next page.
       list = TestListObject.construct_from(data: [{ id: 1 }],
                                            has_more: true,
                                            url: "/things")
+      list.filters = { limit: 3 }
+
+      # The test will start with the synthetic list object above, and use it as
+      # a starting point to fetch two more pages. The second page indicates
+      # that there are no more elements by setting `has_more` to `false`, and
+      # iteration stops.
       stub_request(:get, "#{Stripe.api_base}/things")
-        .with(query: { starting_after: "1" })
-        .to_return(body: JSON.generate(data: [{ id: 2 }, { id: 3 }], has_more: false))
+        .with(query: { starting_after: "1", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 2 }, { id: 3 }, { id: 4 }], has_more: true, url: "/things"))
+      stub_request(:get, "#{Stripe.api_base}/things")
+        .with(query: { starting_after: "4", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 5 }, { id: 6 }], has_more: false, url: "/things"))
+
+      assert_equal expected, list.auto_paging_each.to_a
+    end
+
+    should "provide #auto_paging_each that supports backward pagination with `ending_before`" do
+      arr = [
+        { id: 6 },
+        { id: 5 },
+        { id: 4 },
+        { id: 3 },
+        { id: 2 },
+        { id: 1 },
+      ]
+      expected = Util.convert_to_stripe_object(arr, {})
+
+      # Initial list object to page on. Notably, its first data element will be
+      # used as a cursor to fetch the next page.
+      list = TestListObject.construct_from(data: [{ id: 6 }],
+                                           has_more: true,
+                                           url: "/things")
+
+      # We also add an `ending_before` filter on the list to simulate backwards
+      # pagination.
+      list.filters = { ending_before: 7, limit: 3 }
+
+      # The test will start with the synthetic list object above, and use it as
+      # a starting point to fetch two more pages. The second page indicates
+      # that there are no more elements by setting `has_more` to `false`, and
+      # iteration stops.
+      stub_request(:get, "#{Stripe.api_base}/things")
+        .with(query: { ending_before: "6", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 3 }, { id: 4 }, { id: 5 }], has_more: true, url: "/things"))
+      stub_request(:get, "#{Stripe.api_base}/things")
+        .with(query: { ending_before: "3", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 1 }, { id: 2 }], has_more: false, url: "/things"))
 
       assert_equal expected, list.auto_paging_each.to_a
     end
@@ -97,7 +157,7 @@ module Stripe
         .with(query: { "expand[]" => "data.source", "limit" => "3", "starting_after" => "1" })
         .to_return(body: JSON.generate(data: [{ id: 2 }], has_more: false))
       next_list = list.next_page
-      assert_equal({ expand: ["data.source"], limit: 3 }, next_list.filters)
+      assert_equal({ expand: ["data.source"], limit: 3, starting_after: 1 }, next_list.filters)
     end
 
     should "fetch an empty page through #next_page" do
@@ -114,23 +174,25 @@ module Stripe
 
     should "fetch a next page through #previous_page" do
       list = TestListObject.construct_from(data: [{ id: 2 }],
+                                           has_more: true,
                                            url: "/things")
       stub_request(:get, "#{Stripe.api_base}/things")
         .with(query: { ending_before: "2" })
-        .to_return(body: JSON.generate(data: [{ id: 1 }]))
+        .to_return(body: JSON.generate(data: [{ id: 1 }], has_more: false))
       next_list = list.previous_page
       refute next_list.empty?
     end
 
     should "fetch a next page through #previous_page and respect limit" do
       list = TestListObject.construct_from(data: [{ id: 2 }],
+                                           has_more: true,
                                            url: "/things")
       list.filters = { expand: ["data.source"], limit: 3 }
       stub_request(:get, "#{Stripe.api_base}/things")
         .with(query: { "expand[]" => "data.source", "limit" => "3", "ending_before" => "2" })
-        .to_return(body: JSON.generate(data: [{ id: 1 }]))
+        .to_return(body: JSON.generate(data: [{ id: 1 }], has_more: false))
       next_list = list.previous_page
-      assert_equal({ expand: ["data.source"], limit: 3 }, next_list.filters)
+      assert_equal({ ending_before: 2, expand: ["data.source"], limit: 3 }, next_list.filters)
     end
   end
 end

data/test/stripe/stripe_client_test.rb

@@ -172,6 +172,26 @@ module Stripe
                                           method: :post, num_retries: 0)
       end
 
+      should "retry on EOFError" do
+        assert StripeClient.should_retry?(EOFError.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on Errno::ECONNRESET" do
+        assert StripeClient.should_retry?(Errno::ECONNRESET.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on Errno::ETIMEDOUT" do
+        assert StripeClient.should_retry?(Errno::ETIMEDOUT.new,
+                                          method: :post, num_retries: 0)
+      end
+
+      should "retry on Errno::EHOSTUNREACH" do
+        assert StripeClient.should_retry?(Errno::EHOSTUNREACH.new,
+                                          method: :post, num_retries: 0)
+      end
+
       should "retry on Net::OpenTimeout" do
         assert StripeClient.should_retry?(Net::OpenTimeout.new,
                                           method: :post, num_retries: 0)
@@ -316,11 +336,11 @@ module Stripe
 
       context "logging" do
         setup do
-          # Freeze time for the purposes of the `elapsed` parameter that we emit
-          # for responses. Mocha's `anything` parameter can't match inside of a
-          # hash and is therefore not useful for this purpose, and Timecop
-          # doesn't freeze monotonic time. If we switch over to rspec-mocks at
-          # some point, we can probably remove Timecop from the project.
+          # Freeze time for the purposes of the `elapsed` parameter that we
+          # emit for responses. Mocha's `anything` parameter can't match inside
+          # of a hash and is therefore not useful for this purpose. If we
+          # switch over to rspec-mocks at some point, we can probably remove
+          # this.
           Util.stubs(:monotonic_time).returns(0.0)
         end
 

data/test/test_helper.rb

@@ -8,7 +8,6 @@ require "test/unit"
 require "mocha/setup"
 require "stringio"
 require "shoulda/context"
-require "timecop"
 require "webmock/test_unit"
 
 PROJECT_ROOT = ::File.expand_path("../", __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.7.1
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Stripe API