better-faraday 1.0.8 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dffcabe229bcdabe18df3b0404af88381d6cf4ef3e8cebde48d95abc34bf717
-  data.tar.gz: 2ee1d3d4f126fdd52da8e395f5c8cdcc0da7b0f9a1d31708b390989c5f531b8e
+  metadata.gz: 30c3a63862a5faff00055d0f7fa905b8a67bcb85b3197929a0dcc1b7cce84d5c
+  data.tar.gz: 1d21b6f8fc0ce3efa6dcfec7fcec79e490a27a7c8b48b8a5d97e6d27d196ef26
 SHA512:
-  metadata.gz: bfb4e6754efb1c44b6074c1cea214bd203c602415f699fe1bf3da728b7049b79ed2b8dfcef93ad378017f74fa1f5016d397af7fcae55802642550d97e32dacba
-  data.tar.gz: d4e0629efd3ef722c1232c5ca085574d679af1063a8a6ef0e038fcf5de85f2893301dc6a32adacb2deb90cb09e293fe45c38fae58a87da2c67e6161a668887a6
+  metadata.gz: 181d98b5697219d6bc095d275c0335438b148dd0ddf3e0d08d97855c5f4457731d541d83e19d3c8b3b187023171621baffe13d03417a00d4be50a414809a3d0e
+  data.tar.gz: fcaa327eb416c1ec95e8df522e580a92809ff927f043402f9c998a2797e19eda91b666261280edf89ccf08bfb8c58822399211ba6b8d899d9647b8cf28273001

data/better-faraday.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name                  = "better-faraday"
-  s.version               = "1.0.8"
+  s.version               = "1.1.4"
   s.author                = "Yaroslav Konoplov"
   s.email                 = "eahome00@gmail.com"
   s.summary               = "Extends Faraday with useful features."
@@ -13,6 +13,6 @@ Gem::Specification.new do |s|
   s.files                 = `git ls-files -z`.split("\x0")
   s.test_files            = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
   s.require_paths         = ["lib"]
-  s.add_dependency "faraday", "~> 0.12"
-  s.add_dependency "activesupport", ">= 4.0", "< 6.0"
+  s.add_dependency "faraday", ">= 0.17", "< 2.0"
+  s.add_dependency "activesupport", ">= 4.0", "< 7.0"
 end

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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: better-faraday
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.4
 platform: ruby
 authors:
 - Yaroslav Konoplov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +39,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +49,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 description: A gem extending Faraday (popular Ruby HTTP client) with useful features
   without breaking anything.
 email: eahome00@gmail.com
@@ -76,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extends Faraday with useful features.