stripe 4.7.1 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c8260e6865f7cede359b5b5ed870afa289df71b22ec9cb54ee2fd4d2ad7180f
-  data.tar.gz: 7e34b13f458beb6da7efe8860733163e097cb7a0b186ef18aacdf558ec25993d
+  metadata.gz: 2f7c24b1f5de9f966aeec73391ac6153cb4c3b44f720c89839b163b3a2d46c4e
+  data.tar.gz: 79ec62aece03a2a98858749d1aaff4fc198b130dbd409a18fd7ba2903322d7c8
 SHA512:
-  metadata.gz: 23733735e3c7835e743208ee72aff1c0c71bc9c424feace8995d3691f86efb9ce61773adb349b18060bfdb32893dd157c37bffdf7f83785cbec920d9f1520453
-  data.tar.gz: e63472b1c8a9a16a0c6974c65fae0d5c664a9c7e9ef53c99285641bd95532b5da0de8007946b0490d96f920fa8af7dbd5707505c3af7611f31b8fbd77b80e97a
+  metadata.gz: 53be26caee7e296440f78b10e83b87d7ab5e7346932a670b35a92be9bcba9e436812f47e32fc098db76edaada9acde75dcfdc8547d51769a2679609578d32ef5
+  data.tar.gz: f1787c95d33004299cf40f469e793ca8af8072b7243ece7addb581056250f15dba338d8f000b2116623075382b031e79c08d4645fb478d7a9d1df342c27683bd

data/.rubocop_todo.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 19
 Metrics/AbcSize:
-  Max: 53.26
+  Max: 54
 
 # Offense count: 27
 # Configuration parameters: CountComments, ExcludedMethods.
@@ -18,7 +18,7 @@ Metrics/BlockLength:
 # Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 659
+  Max: 670
 
 # Offense count: 11
 Metrics/CyclomaticComplexity:

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 4.8.0 - 2019-02-03
+* [#741](https://github.com/stripe/stripe-ruby/pull/741) Use `FaradayStripeEncoder` to encode all parameter styles
+
 ## 4.7.1 - 2019-02-01
 * [#740](https://github.com/stripe/stripe-ruby/pull/740) Fix query encoding for integer-indexed maps
 

data/VERSION

@@ -1 +1 @@
-4.7.1
+4.8.0

data/lib/stripe/stripe_client.rb

@@ -123,24 +123,17 @@ module Stripe
                         api_base: nil, api_key: nil, headers: {}, params: {})
       api_base ||= Stripe.api_base
       api_key ||= Stripe.api_key
+      params = Util.objects_to_ids(params)
 
       check_api_key!(api_key)
 
-      params = Util.objects_to_ids(params)
-      url = api_url(path, api_base)
-
       body = nil
       query_params = nil
-
       case method.to_s.downcase.to_sym
       when :get, :head, :delete
         query_params = params
       else
-        body = if headers[:content_type] && headers[:content_type] == "multipart/form-data"
-                 params
-               else
-                 Util.encode_parameters(params)
-               end
+        body = params
       end
 
       # This works around an edge case where we end up with both query
@@ -162,6 +155,8 @@ module Stripe
 
       headers = request_headers(api_key, method)
                 .update(Util.normalize_headers(headers))
+      params_encoder = FaradayStripeEncoder.new
+      url = api_url(path, api_base)
 
       # stores information on the request we're about to make so that we don't
       # have to pass as many parameters around for logging.
@@ -169,19 +164,19 @@ module Stripe
       context.account         = headers["Stripe-Account"]
       context.api_key         = api_key
       context.api_version     = headers["Stripe-Version"]
-      context.body            = body
+      context.body            = body ? params_encoder.encode(body) : nil
       context.idempotency_key = headers["Idempotency-Key"]
       context.method          = method
       context.path            = path
-      context.query_params    = query_params ? Util.encode_parameters(query_params) : nil
+      context.query_params    = query_params ? params_encoder.encode(query_params) : nil
 
+      # note that both request body and query params will be passed through
+      # `FaradayStripeEncoder`
       http_resp = execute_request_with_rescues(api_base, context) do
         conn.run_request(method, url, body, headers) do |req|
           req.options.open_timeout = Stripe.open_timeout
-          req.options.params_encoder = FaradayStripeEncoder
+          req.options.params_encoder = params_encoder
           req.options.timeout = Stripe.read_timeout
-
-          # note that these will be passed through `FaradayStripeEncoder`
           req.params = query_params unless query_params.nil?
         end
       end
@@ -205,16 +200,53 @@ module Stripe
     # -- in particular when we send our integer-indexed maps (i.e. arrays),
     # Faraday ends up stripping out the integer indexes.
     #
-    # We work around the problem by implementing our own simplified decoder and
+    # We work around the problem by implementing our own simplified encoder and
     # telling Faraday to use that.
+    #
+    # The class also performs simple caching so that we don't have to encode
+    # parameters twice for every request (once to build the request and once
+    # for logging).
+    #
+    # When initialized with `multipart: true`, the encoder just inspects the
+    # hash instead to get a decent representation for logging. In the case of a
+    # multipart request, Faraday won't use the result of this encoder.
     class FaradayStripeEncoder
-      def self.encode(hash)
-        Util.encode_parameters(hash)
+      def initialize
+        @cache = {}
       end
 
-      def self.decode(_str)
+      # This is quite subtle, but for a `multipart/form-data` request Faraday
+      # will throw away the result of this encoder and build its body.
+      def encode(hash)
+        @cache.fetch(hash) do |k|
+          @cache[k] = Util.encode_parameters(replace_faraday_io(hash))
+        end
+      end
+
+      # We should never need to do this so it's not implemented.
+      def decode(_str)
         raise NotImplementedError, "#{self.class.name} does not implement #decode"
       end
+
+      # Replaces instances of `Faraday::UploadIO` with a simple string
+      # representation so that they'll log a little better. Faraday won't use
+      # these parameters, so it's okay that we did this.
+      #
+      # Unfortunately the string representation still doesn't look very nice
+      # because we still URL-encode special symbols in the final value. It's
+      # possible we could stop doing this and just leave it to Faraday to do
+      # the right thing.
+      private def replace_faraday_io(value)
+        if value.is_a?(Array)
+          value.each_with_index { |v, i| value[i] = replace_faraday_io(v) }
+        elsif value.is_a?(Hash)
+          value.each { |k, v| value[k] = replace_faraday_io(v) }
+        elsif value.is_a?(Faraday::UploadIO)
+          "FILE:#{value.original_filename}"
+        else
+          value
+        end
+      end
     end
 
     def api_url(url = "", api_base = nil)

data/lib/stripe/version.rb

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

data/test/stripe/stripe_client_test.rb

@@ -794,6 +794,16 @@ module Stripe
         assert(!trace_payload["last_request_metrics"]["request_duration_ms"].nil?)
       end
     end
+
+    context "FaradayStripeEncoder" do
+      should "replace Faraday::UploadIO instances in parameters" do
+        encoder = StripeClient::FaradayStripeEncoder.new
+        encoded = encoder.encode(foo: [
+          { file: Faraday::UploadIO.new(::File.new(__FILE__), nil) },
+        ])
+        assert_equal "foo[0][file]=FILE%3Astripe_client_test.rb", encoded
+      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: 4.7.1
+  version: 4.8.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday