better-faraday 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 520161498209165aa279351373198c4f82936380767f5bbffa6bd02e9698527f
-  data.tar.gz: aadd3384613e59c8855b8432895c5ac6ef2a2afbbeddd82d689ddd05022be2be
+  metadata.gz: e2c396050eb803fc44370487683e12b77b07b808d563264aa372c847cd5be21c
+  data.tar.gz: e8a5f25e26e98d39adf5cb87653fa99b25f2a365382b8996434f68c0c8215a4d
 SHA512:
-  metadata.gz: be5bd473d0551db70328a71d4b1ae0a880de59ee0b60fc8826d2899583f771b66300d59c71c9e48ac833c16854c964cda23b6e25bad4a0811a221721b9bcb3c6
-  data.tar.gz: e329ceb0a76522e17d52502ec5e13a2bad7d14c9b2c5b887e7a1d042e6dfb59e80ecc7b0fdd27eae50d347733c20a66d2fb255d748eee1955f294ba0a70a21c4
+  metadata.gz: d68b1aec17fdbc160393fad93a9afdfa5650cdab9413226830054f84568efca1315ef1a34de2b3b44075b5a843627cfb75bb8b451d03fea405c02fae634aa097
+  data.tar.gz: 5dfb59a2f91082cf3e305db4d965a8f7c41d7617f7642adb1f7505fac1673bcedce22124465053a950ab2434878e434a34a835d39cefaec36c343975b9d099e3

data/better-faraday.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name                  = "better-faraday"
-  s.version               = "1.0.2"
+  s.version               = "1.0.3"
   s.author                = "Yaroslav Konoplov"
   s.email                 = "eahome00@gmail.com"
   s.summary               = "Extends Faraday with useful features."
@@ -14,4 +14,5 @@ Gem::Specification.new do |s|
   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"
 end

data/lib/better-faraday.rb

@@ -6,6 +6,7 @@ require "faraday"
 require "faraday/error"
 require "faraday/options"
 require "faraday/response"
+require "active_support/core_ext/object/deep_dup"
 
 Module.new do
   def run_request(method, url, body, headers, &block)
@@ -41,6 +42,12 @@ module Faraday
     alias assert_success! assert_2xx! # Compatibility.
 
     def describe
+      request_headers  = env.request_headers.deep_dup
+      request_json     = parse_json(env.request_body)
+      response_headers = ::Hash === env.response_headers ? env.response_headers.deep_dup : {}
+      response_json    = parse_json(env.body)
+      [request_headers, request_json, response_headers, response_json].compact.each { |hash| sanitize(hash) }
+
       [ "",
         "-- #{status} #{reason_phrase} --",
         "",
@@ -51,19 +58,34 @@ module Faraday
         env.method.to_s.upcase,
         "",
         "-- Request headers --",
-        ::JSON.generate(env.request_headers.tap { |x| x["Authorization"] = "SECRET" if x.key?("Authorization") }),
+        ::JSON.generate(request_headers),
         "",
         "-- Request body --",
-        env.request_body.to_s,
+        request_json ? ::JSON.generate(request_json) : env.request_body.to_s,
         "",
         "-- Response headers --",
-        ::Hash === env.response_headers ? ::JSON.generate(env.response_headers) : "",
+        response_headers ? ::JSON.generate(response_headers) : env.response_headers.to_s,
         "",
         "-- Response body --",
-        env.body.to_s,
+        response_json ? ::JSON.generate(response_json) : env.body.to_s,
         ""
       ].join("\n")
     end
+
+  private
+
+    def parse_json(json)
+      ::JSON.parse(::String === json ? json : json.to_s, quirks_mode: false)
+    rescue ::JSON::ParserError
+      nil
+    end
+
+    def sanitize(h)
+      h.keys.map(&:to_s).each do |k|
+        h[k] = "SECRET" if k.respond_to?(:=~) && Faraday.secrets.any? { |s| k =~ s }
+        sanitize(h[k]) if ::Hash === h[k]
+      end
+    end
   end
 
   class HTTP4xx < Error
@@ -73,4 +95,10 @@ module Faraday
   class HTTP422 < HTTP4xx
 
   end
+
+  class << self
+    attr_accessor :secrets
+  end
+
+  self.secrets = [/pass(?:word|phrase)/i, /authorization/i, /secret/i]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better-faraday
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Yaroslav Konoplov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: A gem extending Faraday (popular Ruby HTTP client) with useful features
   without breaking anything.
 email: eahome00@gmail.com