stripe 3.30.0 → 3.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d25c4b43b8450a6e3cd10eaf3ceace0da2068f58c0820640fdd89a6d4a926a4f
-  data.tar.gz: c61b1f9772ec914cffb1dd86232ea95e77c8ecdb74c9806aa7d0db3af0ca9060
+SHA1:
+  metadata.gz: 52baaa63153c557126fa6561e14c544fc5fbbb40
+  data.tar.gz: 89e88d7e7730d54188f73270e354b4027ff3ca2e
 SHA512:
-  metadata.gz: eebf86824a520894c505579ff7aba5d07767aec03bdca7ffe6c8e5ade709539af8c82e9c146cfe33a1814a426c294bec10666d6923b1248d4d6de20e2f12315e
-  data.tar.gz: 52249b7edcb8e9a336819a0281ed38f7015162fa5062b6f5b2eb791e5936105baceb05e91f89780ea32d716ea12df92ed0e96ca336324c943024ab3747ee756a
+  metadata.gz: db6c1475916245fe94df52771b1a954a25653278e3af489310bbbdf598bf49f4b97db0f7a3dfd0665bc24979c006388c70490e6909678e0e3388a9c54172127a
+  data.tar.gz: 58930d60e01262bc61a80953784a6f6b8bab7224f97af80fc550a39982cd663b76b6cf4e99896915f74d1f68b561cb8b84e4ed0db264626e63d89d5f25a24215

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 tags
 /.bundle/
 coverage/
+.idea/

data/.rubocop_todo.yml

@@ -18,7 +18,7 @@ Metrics/BlockLength:
 # Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 626
+  Max: 659
 
 # Offense count: 11
 Metrics/CyclomaticComplexity:

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.31.0 - 2018-11-12
+* [#696](https://github.com/stripe/stripe-ruby/pull/696) Add configurable telemetry to gather information on client-side request latency
+
 ## 3.30.0 - 2018-11-08
 * [#693](https://github.com/stripe/stripe-ruby/pull/693) Add new API endpoints for the `Invoice` resource.
 

data/VERSION

@@ -1 +1 @@
-3.30.0
+3.31.0

data/lib/stripe.rb

@@ -124,6 +124,8 @@ module Stripe
   @open_timeout = 30
   @read_timeout = 80
 
+  @enable_telemetry = false
+
   class << self
     attr_accessor :stripe_account, :api_key, :api_base, :verify_ssl_certs, :api_version, :client_id, :connect_base, :uploads_base,
                   :open_timeout, :read_timeout
@@ -225,6 +227,14 @@ module Stripe
     @max_network_retries = val.to_i
   end
 
+  def self.enable_telemetry?
+    @enable_telemetry
+  end
+
+  def self.enable_telemetry=(val)
+    @enable_telemetry = val
+  end
+
   # Sets some basic information about the running application that's sent along
   # with API requests. Useful for plugin authors to identify their plugin when
   # communicating with Stripe.

data/lib/stripe/stripe_client.rb

@@ -12,6 +12,7 @@ module Stripe
     def initialize(conn = nil)
       self.conn = conn || self.class.default_conn
       @system_profiler = SystemProfiler.new
+      @last_request_metrics = nil
     end
 
     def self.active_client
@@ -113,7 +114,6 @@ module Stripe
 
     def execute_request(method, path,
                         api_base: nil, api_key: nil, headers: {}, params: {})
-
       api_base ||= Stripe.api_base
       api_key ||= Stripe.api_key
 
@@ -218,6 +218,9 @@ module Stripe
         resp = yield
         context = context.dup_from_response(resp)
         log_response(context, request_start, resp.status, resp.body)
+        if Stripe.enable_telemetry?
+          @last_request_metrics = StripeRequestMetrics.new(context.request_id, Time.now - request_start)
+        end
 
       # We rescue all exceptions from a request so that we have an easy spot to
       # implement our retry logic across the board. We'll re-raise if it's a type
@@ -425,6 +428,10 @@ module Stripe
         "Content-Type" => "application/x-www-form-urlencoded",
       }
 
+      if Stripe.enable_telemetry? && !@last_request_metrics.nil?
+        headers["X-Stripe-Client-Telemetry"] = JSON.generate(last_request_metrics: @last_request_metrics.payload)
+      end
+
       # It is only safe to retry network failures on post and delete
       # requests if we add an Idempotency-Key header
       if %i[post delete].include?(method) && Stripe.max_network_retries > 0
@@ -594,5 +601,23 @@ module Stripe
         }.delete_if { |_k, v| v.nil? }
       end
     end
+
+    # StripeRequestMetrics tracks metadata to be reported to stripe for metrics collection
+    class StripeRequestMetrics
+      # The Stripe request ID of the response.
+      attr_accessor :request_id
+
+      # Request duration
+      attr_accessor :request_duration
+
+      def initialize(request_id, request_duration)
+        self.request_id       = request_id
+        self.request_duration = request_duration
+      end
+
+      def payload
+        { request_id: request_id, request_duration: request_duration }
+      end
+    end
   end
 end

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "3.30.0".freeze
+  VERSION = "3.31.0".freeze
 end

data/test/stripe/stripe_client_test.rb

@@ -749,6 +749,51 @@ module Stripe
         end
       end
     end
+
+    context "#telemetry" do
+      teardown do
+        # make sure to always set telemetry back to false
+        # to not mutate global state
+        Stripe.enable_telemetry = false
+      end
+
+      should "not send metrics if enable trace flag is not set" do
+        Stripe.enable_telemetry = false
+
+        trace_metrics_header = nil
+        stub_request(:get, "#{Stripe.api_base}/v1/charges")
+          .with do |req|
+          trace_metrics_header = req.headers["X-Stripe-Client-Telemetry"]
+          false
+        end.to_return(body: JSON.generate(object: "charge"))
+
+        Stripe::Charge.list
+        assert(trace_metrics_header.nil?)
+
+        Stripe::Charge.list
+        assert(trace_metrics_header.nil?)
+      end
+
+      should "send metrics if enabled telemetry is true" do
+        Stripe.enable_telemetry = true
+
+        trace_metrics_header = nil
+        stub_request(:get, "#{Stripe.api_base}/v1/charges")
+          .with do |req|
+          trace_metrics_header = req.headers["X-Stripe-Client-Telemetry"]
+          false
+        end.to_return(body: JSON.generate(object: "charge"))
+
+        Stripe::Charge.list
+        Stripe::Charge.list
+
+        assert(!trace_metrics_header.nil?)
+
+        trace_payload = JSON.parse(trace_metrics_header)
+        assert(trace_payload["last_request_metrics"]["request_id"] == "req_123")
+        assert(!trace_payload["last_request_metrics"]["request_duration"].nil?)
+      end
+    end
   end
 
   class SystemProfilerTest < Test::Unit::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 3.30.0
+  version: 3.31.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Stripe API