better-faraday 1.0.7 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 566a4665f7f21fbc42e2ab20190caf5d87d3d49d775ac376135c273728132334
-  data.tar.gz: 4ab4177eb90929e0c3f1f89aa8418c74af97120770c68595cf6ba630e9d8894c
+  metadata.gz: 5df15bce61cd943bd8736051604de939682c563cb2836144049661e80dca4e50
+  data.tar.gz: 6fd2d60429e1684e85d474abacda0343260ecac1cf2cad5fbc9e964dd4087a20
 SHA512:
-  metadata.gz: 0c459e43aed401c92e6e57957c057bfef94a4194dfb77bb789e3d5466cd99153f17a43b883a9a5896c3c0c5a074ab42f39ddda0ae749bc33744c40aebeb34054
-  data.tar.gz: ceddc5b83c55fc7546b0dd2c6edb88a9711f8308c7c9363f1868b32b67e419b9b44ad41b0a6a3c8a114c34b2497a6db11b79d924a45a64c0ec128c56340f95db
+  metadata.gz: 2a002c9f4cdf85b2f1cdc91c1899d8b6766b18cacfa7e7946cabcdf945e261148bfeeeb2981022179d22ba85509296c3fda9ae5f15991f2d6b8ece3513a9bf73
+  data.tar.gz: 444c4694d034eb482b7b161dad15c56467e24a56755715d001cecb68626f32db9c495d6745dc50edf9f54211ad8b27f9cb554b3cb28e7ca6fb1c4a7fb406b669

data/better-faraday.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name                  = "better-faraday"
-  s.version               = "1.0.7"
+  s.version               = "1.1.3"
   s.author                = "Yaroslav Konoplov"
   s.email                 = "eahome00@gmail.com"
   s.summary               = "Extends Faraday with useful features."

data/lib/better-faraday.rb

@@ -11,14 +11,21 @@ require "active_support/core_ext/string/filters"
 require "active_support/core_ext/string/inflections"
 
 Module.new do
-  def run_request(method, url, body, headers, &block)
-    super.tap { |response| response.env.instance_variable_set(:@request_body, body) }
+  def call(env)
+    env.instance_variable_set(:@request_sent_at, Time.now.utc)
+    super
   end
-end.tap { |m| Faraday::Connection.send(:prepend, m) }
+
+  def save_response(env, status, body, headers = nil, reason_phrase = nil)
+    env.instance_variable_set(:@response_received_at, Time.now.utc)
+    env.instance_variable_set(:@request_body, env.body.respond_to?(:read) ? env.body.read : env.body)
+    super
+  end
+end.tap { |m| Faraday::Adapter.send(:prepend, m) }
 
 module Faraday
   class Env
-    attr_reader :request_body
+    attr_reader :request_body, :request_sent_at, :response_received_at
   end
 
   class Error
@@ -39,7 +46,7 @@ module Faraday
         Faraday::Error
       end
 
-      error = klass.new(describe)
+      error = klass.new("\n#{describe}")
       error.instance_variable_set(:@response, self)
       raise error
     end
@@ -64,13 +71,23 @@ module Faraday
     end
 
     def describe
-      request_headers  = __protect_data(env.request_headers.deep_dup)
-      request_json     = __protect_data(parse_json(env.request_body))
-      response_headers = __protect_data(::Hash === env.response_headers ? env.response_headers.deep_dup : {})
-      response_json    = __protect_data(__parse_json(env.body))
+      request_headers = __protect_data(env.request_headers.deep_dup)
+
+      if env.request_headers["Content-Type"].to_s.match?(/\bapplication\/json\b/)
+        request_json = __protect_data(__parse_json(env.request_body.dup))
+      end
+
+      if env.response_headers
+        response_headers = __protect_data(env.response_headers.deep_dup)
+      end
+
+      if env.response_headers && env.response_headers["Content-Type"].to_s.match?(/\bapplication\/json\b/)
+        response_json = __protect_data(__parse_json(env.body.dup))
+      end
 
-      [ "",
-        "-- #{status} #{reason_phrase} --",
+      lines = [
+        "",
+        "-- #{status} #{reason_phrase} --".upcase,
         "",
         "-- Request URL --",
         env.url.to_s,
@@ -79,20 +96,63 @@ module Faraday
         env.method.to_s.upcase,
         "",
         "-- Request headers --",
-        ::JSON.generate(request_headers).yield_self { |t| t.truncate(1024, omission: "... (truncated, full length: #{t.length})") },
+        ::JSON.generate(request_headers).yield_self { |t| t.truncate(2048, omission: "... (truncated, full length: #{t.length})") },
         "",
+
         "-- Request body --",
-        (request_json ? ::JSON.generate(request_json) : env.request_body.to_s).yield_self { |t| t.truncate(1024, omission: "... (truncated, full length: #{t.length})") },
+        if request_json
+          ::JSON.generate(request_json)
+        else
+          body = env.request_body.to_s.dup
+          if body.encoding.name == "ASCII-8BIT"
+            "Binary (#{body.size} bytes)"
+          else
+            body
+          end
+        end.yield_self { |t| t.truncate(1024, omission: "... (truncated, full length: #{t.length})") },
+        "",
+
+        "-- Request sent at --",
+        env.request_sent_at.strftime("%Y-%m-%d %H:%M:%S.%2N") + " UTC",
         "",
+
         "-- Response headers --",
-        (response_headers ? ::JSON.generate(response_headers) : env.response_headers.to_s).yield_self { |t| t.truncate(1024, omission: "... (truncated, full length: #{t.length})") },
+        if response_headers
+          ::JSON.generate(response_headers)
+        else
+          env.response_headers.to_s
+        end.yield_self { |t| t.truncate(2048, omission: "... (truncated, full length: #{t.length})") },
         "",
+
         "-- Response body --",
-        (response_json ? ::JSON.generate(response_json) : env.body.to_s).yield_self { |t| t.truncate(1024, omission: "... (truncated, full length: #{t.length})") },
-        ""
-      ].join("\n")
+        if response_json
+          ::JSON.generate(response_json)
+        else
+          body = env.body.to_s.dup
+          if body.encoding.name == "ASCII-8BIT"
+            "Binary (#{body.size} bytes)"
+          else
+            body
+          end
+        end.yield_self { |t| t.truncate(2048, omission: "... (truncated, full length: #{t.length})") }
+      ]
+
+      if env.response_received_at
+        lines.concat [
+          "",
+          "-- Response received at --",
+          env.response_received_at.strftime("%Y-%m-%d %H:%M:%S.%2N") + " UTC",
+          "",
+          "-- Response received in --",
+          "#{((env.response_received_at.to_f - env.request_sent_at.to_f) * 1000.0).round(2)}ms"
+        ]
+      end
+
+      lines.join("\n") + "\n"
     end
 
+    alias inspect describe
+
   private
 
     def __parse_json(json)
@@ -107,7 +167,7 @@ module Faraday
       return data.map(&method(:__protect_data)) if ::Array === data
       return data unless ::Hash === data
       data.each_with_object({}) do |(key, value), memo|
-        memo[key] = if key.respond_to?(:=~) && Faraday.secrets.any? { |s| key =~ s }
+        memo[key] = if key.to_s.underscore.tr("_", " ").yield_self { |k| Faraday.secrets.any? { |s| k.match?(s) } }
           "SECRET"
         else
           __protect_data(value)
@@ -128,5 +188,5 @@ module Faraday
     attr_accessor :secrets
   end
 
-  self.secrets = [/\bpass(?:word|phrase)\b/i, /\bauthorization\b/i, /\bsecret\b/i, /\b(:?access?)token\b/i]
+  self.secrets = [/\bpass(?:word|phrase)\b/i, /\bauthorization\b/i, /\bsecret\b/i, /\b(:?access)?token\b/i]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better-faraday
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.3
 platform: ruby
 authors:
 - Yaroslav Konoplov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday