better-faraday 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f0c2729ee0008d378633405c1b5b7ce2487d2ff16c78bce61973a4bc524a2f
-  data.tar.gz: 3e5dc920399d735b9de37efd781430fa1f19ee51a2fc0d11d88cf3b0fe5771c8
+  metadata.gz: b4091f67de65133fa096eef795198cf51895c03ada658fb72e84fbfae2c14522
+  data.tar.gz: c79c87d6051648a39a58e91259bb78309e78368d9874ca4605d09152388b908f
 SHA512:
-  metadata.gz: 72017939d4eaddce9514bb76d329ae2fba24e9bce2ed4d9bbbc51341f7b21adb68d6a5fa81222abff6d47faae49fb56e0ef1bf648cbc66a69a5553e419529782
-  data.tar.gz: 426bab6ab085ca927e4e7999903286371308b00ce551ef60525555043e8807b2ea0e87f2392a12d8f1b8715474399be40261b490dd84e9eca6574c11f163cdb0
+  metadata.gz: 80c822fc52bc8bf778d37b769bbce32e2e7c75e3c94fb9a2098659f8b4d66e37df8c6e02c8c34b9f9bedc9f3fcaa7c64fa30de7c491a5f86f00fda575d1c3d65
+  data.tar.gz: bdca3821190b987e8de4f334c712c3380985b4c60f4703a261a821aceba6e4bb8cb7fef5b742153d65230f23d418ca87d77da0c4369957df56e67e002e2422c1

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.7.3

data/better-faraday.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name                  = "better-faraday"
-  s.version               = "1.1.0"
+  s.version               = "1.2.0"
   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", ">= 1.0", "< 2.0"
+  s.add_dependency "activesupport", ">= 4.0", "< 7.0"
 end

data/lib/better-faraday.rb

@@ -71,10 +71,19 @@ 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
 
       lines = [
         "",
@@ -89,17 +98,43 @@ module Faraday
         "-- Request headers --",
         ::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(2048, 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(2048, omission: "... (truncated, full length: #{t.length})") }
+        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
@@ -113,9 +148,11 @@ module Faraday
         ]
       end
 
-      lines.join("\n")
+      lines.join("\n") + "\n"
     end
 
+    alias inspect describe
+
   private
 
     def __parse_json(json)
@@ -130,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::Inspection.secrets.any? { |s| k.match?(s) } }
           "SECRET"
         else
           __protect_data(value)
@@ -147,9 +184,21 @@ module Faraday
   class HTTP422 < HTTP4xx; end
   class HTTP429 < HTTP4xx; end
 
-  class << self
-    attr_accessor :secrets
+  module Inspection
+    class << self
+      attr_accessor :secrets
+    end
+
+    self.secrets = [/\bpass(?:word|phrase)\b/i, /\bauthorization\b/i, /\bsecret\b/i, /\b(:?access)?token\b/i]
   end
 
-  self.secrets = [/\bpass(?:word|phrase)\b/i, /\bauthorization\b/i, /\bsecret\b/i, /\b(:?access?)token\b/i]
+  class << self
+    def secrets
+      Inspection.secrets
+    end
+
+    def secrets=(value)
+      Inspection.secrets = value
+    end
+  end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: better-faraday
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yaroslav Konoplov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2021-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
       - !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: '1.0'
+    - - "<"
       - !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.6
 signing_key: 
 specification_version: 4
 summary: Extends Faraday with useful features.