stripe 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0d93e7805ba65b7f5dcfe753298a8be427fc1d
-  data.tar.gz: 3a59dcb60834e656c55f37368c8f957bb9d23486
+  metadata.gz: cc6007a4a7e4fe882d757b6d98c32a8c4ebe5cd0
+  data.tar.gz: 11fd5cc602368b14af8e2026d7e4443b1ea5e8be
 SHA512:
-  metadata.gz: 5a769766ed97097ae745300710ad092bc6646ec85d98f70686ffe71758159667e67f7758c6550a00ac74269978562a2dcf44162bc681960fb59c67ffbc04a525
-  data.tar.gz: 2c6782650e0069887f14fa28be69e135f2e4ccaeec68ce69422972cde7e8fc28e2310de86c903c88ade3017998cb9a11a68c5ffc921bf6098deb7877de5bd85e
+  metadata.gz: '0499ecd568b1dc51b3dba91ca087640d68201858de6d836cd0fbaf4ef8762e7264144ac45cd4e4e5c1c4795aa58bbc81f3b4b9d125006540549e08fe7c16fafb'
+  data.tar.gz: 59c86405800248611f69e91a55bbf32d3885beb90ee06cd36e89bad93ee84bf0927624f292b694e99c94e286164136aff9da6eb64a33a5f9bfd47fca417444ec

data/History.txt

@@ -1,3 +1,7 @@
+=== 3.2.0 2017-08-03
+
+* Add logging for request retry account and `Stripe-Account` header
+
 === 3.1.0 2017-08-03
 
 * Implement request logging with `Stripe.log_level` and `STRIPE_LOG`

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.2.0

data/lib/stripe/stripe_client.rb

@@ -56,8 +56,8 @@ module Stripe
     # Checks if an error is a problem that we should retry on. This includes both
     # socket errors that may represent an intermittent problem and some special
     # HTTP statuses.
-    def self.should_retry?(e, retry_count)
-      return false if retry_count >= Stripe.max_network_retries
+    def self.should_retry?(e, num_retries)
+      return false if num_retries >= Stripe.max_network_retries
 
       # Retry on timeout-related problems (either on open or read).
       return true if e.is_a?(Faraday::TimeoutError)
@@ -75,11 +75,11 @@ module Stripe
       false
     end
 
-    def self.sleep_time(retry_count)
+    def self.sleep_time(num_retries)
       # Apply exponential backoff with initial_network_retry_delay on the
-      # number of attempts so far as inputs. Do not allow the number to exceed
+      # number of num_retries so far as inputs. Do not allow the number to exceed
       # max_network_retry_delay.
-      sleep_seconds = [Stripe.initial_network_retry_delay * (2 ** (retry_count - 1)), Stripe.max_network_retry_delay].min
+      sleep_seconds = [Stripe.initial_network_retry_delay * (2 ** (num_retries - 1)), Stripe.max_network_retry_delay].min
 
       # Apply some jitter by randomizing the value in the range of (sleep_seconds
       # / 2) to (sleep_seconds).
@@ -139,8 +139,9 @@ module Stripe
       # stores information on the request we're about to make so that we don't
       # have to pass as many parameters around for logging.
       context = RequestLogContext.new(
+        account: headers["Stripe-Account"],
         api_key: api_key,
-        api_version: headers["Stripe-Version"] || Stripe.api_version,
+        api_version: headers["Stripe-Version"],
         idempotency_key: headers["Idempotency-Key"],
         method: method,
         path: path,
@@ -189,10 +190,10 @@ module Stripe
     end
 
     def execute_request_with_rescues(api_base, context, &block)
-      retry_count = 0
+      num_retries = 0
       begin
         request_start = Time.now
-        log_request(context)
+        log_request(context, num_retries)
         resp = block.call
         context = context.dup_from_response(resp)
         log_response(context, request_start, resp.status, resp.body)
@@ -213,9 +214,9 @@ module Stripe
           log_response_error(error_context, request_start, e)
         end
 
-        if self.class.should_retry?(e, retry_count)
-          retry_count = retry_count + 1
-          sleep self.class.sleep_time(retry_count)
+        if self.class.should_retry?(e, num_retries)
+          num_retries += 1
+          sleep self.class.sleep_time(num_retries)
           retry
         end
 
@@ -224,7 +225,7 @@ module Stripe
           if e.response
             handle_error_response(e.response, error_context)
           else
-            handle_network_error(e, error_context, retry_count, api_base)
+            handle_network_error(e, error_context, num_retries, api_base)
           end
 
         # Only handle errors when we know we can do so, and re-raise otherwise.
@@ -362,7 +363,7 @@ module Stripe
       end
     end
 
-    def handle_network_error(e, context, retry_count, api_base=nil)
+    def handle_network_error(e, context, num_retries, api_base=nil)
       Util.log_info('Stripe OAuth error',
         error_message: e.message,
         idempotency_key: context.idempotency_key,
@@ -394,8 +395,8 @@ module Stripe
 
       end
 
-      if retry_count > 0
-        message += " Request was retried #{retry_count} times."
+      if num_retries > 0
+        message += " Request was retried #{num_retries} times."
       end
 
       raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
@@ -437,11 +438,13 @@ module Stripe
       headers
     end
 
-    def log_request(context)
+    def log_request(context, num_retries)
       Util.log_info("Request to Stripe API",
+        account: context.account,
         api_version: context.api_version,
         idempotency_key: context.idempotency_key,
         method: context.method,
+        num_retries: num_retries,
         path: context.path
       )
       Util.log_debug("Request details",
@@ -453,6 +456,7 @@ module Stripe
 
     def log_response(context, request_start, status, body)
       Util.log_info("Response from Stripe API",
+        account: context.account,
         api_version: context.api_version,
         elapsed: Time.now - request_start,
         idempotency_key: context.idempotency_key,
@@ -491,6 +495,7 @@ module Stripe
     # that we can log certain information. It's useful because it means that we
     # don't have to pass around as many parameters.
     class RequestLogContext
+      attr_accessor :account
       attr_accessor :api_key
       attr_accessor :api_version
       attr_accessor :idempotency_key
@@ -499,8 +504,9 @@ module Stripe
       attr_accessor :payload
       attr_accessor :request_id
 
-      def initialize(api_key: nil, api_version: nil, idempotency_key: nil,
-          method: nil, path: nil, payload: nil)
+      def initialize(account: nil, api_key: nil, api_version: nil,
+          idempotency_key: nil, method: nil, path: nil, payload: nil)
+        self.account = account
         self.api_key = api_key
         self.api_version = api_version
         self.idempotency_key = idempotency_key
@@ -528,6 +534,7 @@ module Stripe
         end
 
         context = self.dup
+        context.account = headers["Stripe-Account"]
         context.api_version = headers["Stripe-Version"]
         context.idempotency_key = headers["Idempotency-Key"]
         context.request_id = headers["Request-Id"]

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/test/stripe/stripe_client_test.rb

@@ -160,9 +160,11 @@ module Stripe
           body = JSON.generate({ object: "account" })
 
           Util.expects(:log_info).with("Request to Stripe API",
+            account: "acct_123",
             api_version: '2010-11-12',
             idempotency_key: "abc",
             method: :post,
+            num_retries: 0,
             path: "/v1/account"
           )
           Util.expects(:log_debug).with("Request details",
@@ -171,6 +173,7 @@ module Stripe
           )
 
           Util.expects(:log_info).with("Response from Stripe API",
+            account: "acct_123",
             api_version: '2010-11-12',
             elapsed: 0.0,
             idempotency_key: "abc",
@@ -196,6 +199,7 @@ module Stripe
               headers: {
                 "Idempotency-Key" => "abc",
                 "Request-Id" => "req_123",
+                "Stripe-Account" => "acct_123",
                 "Stripe-Version" => "2010-11-12"
               }
             )
@@ -204,6 +208,7 @@ module Stripe
           client.execute_request(:post, '/v1/account',
             headers: {
               "Idempotency-Key" => "abc",
+              "Stripe-Account" => "acct_123",
               "Stripe-Version" => "2010-11-12"
             }
           )
@@ -211,12 +216,15 @@ module Stripe
 
         should "produce logging on API error" do
           Util.expects(:log_info).with("Request to Stripe API",
+            account: nil,
             api_version: nil,
             idempotency_key: nil,
             method: :post,
+            num_retries: 0,
             path: "/v1/account"
           )
           Util.expects(:log_info).with("Response from Stripe API",
+            account: nil,
             api_version: nil,
             elapsed: 0.0,
             idempotency_key: nil,
@@ -256,12 +264,15 @@ module Stripe
 
         should "produce logging on OAuth error" do
           Util.expects(:log_info).with("Request to Stripe API",
+            account: nil,
             api_version: nil,
             idempotency_key: nil,
             method: :post,
+            num_retries: 0,
             path: "/oauth/token"
           )
           Util.expects(:log_info).with("Response from Stripe API",
+            account: nil,
             api_version: nil,
             elapsed: 0.0,
             idempotency_key: nil,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Stripe