better-faraday 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4091f67de65133fa096eef795198cf51895c03ada658fb72e84fbfae2c14522
-  data.tar.gz: c79c87d6051648a39a58e91259bb78309e78368d9874ca4605d09152388b908f
+  metadata.gz: a8c5cfa773e01c53223151db865f52ad18b5ab411ad0df1d67415a5bd4ef1e73
+  data.tar.gz: dde3e3df19d758f85d156ae357d96cb017e0a2746d7de2d14533a860d0dacd9c
 SHA512:
-  metadata.gz: 80c822fc52bc8bf778d37b769bbce32e2e7c75e3c94fb9a2098659f8b4d66e37df8c6e02c8c34b9f9bedc9f3fcaa7c64fa30de7c491a5f86f00fda575d1c3d65
-  data.tar.gz: bdca3821190b987e8de4f334c712c3380985b4c60f4703a261a821aceba6e4bb8cb7fef5b742153d65230f23d418ca87d77da0c4369957df56e67e002e2422c1
+  metadata.gz: e9affc8fce7fe302214440777db7778ecc429d9ca188385ae42b58297a76d4a9db5c6e051313b5bc2f211af287c729bdcf39226652c132ff40b2570ef2ee2ea3
+  data.tar.gz: c0baba390fcef6d87131569c948cf3492233e99cb317900a79b459dddb0fc7653b05811b279bf71bc7339384f7f2b581a34c69004af8e847718bf10fd2918ce6

data/better-faraday.gemspec

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

data/lib/better-faraday.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "net/http"
 require "faraday"
 require "faraday/error"
 require "faraday/options"
@@ -9,50 +10,83 @@ require "faraday/response"
 require "active_support/core_ext/object/deep_dup"
 require "active_support/core_ext/string/filters"
 require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/object/inclusion"
 
 Module.new do
-  def call(env)
-    env.instance_variable_set(:@request_sent_at, Time.now.utc)
+  def call(environment)
+    environment.instance_variable_set(:@bf_request_sent_at, Time.now.utc)
     super
   end
 
-  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)
+  def save_response(environment, *)
+    environment.instance_variable_set \
+      :@bf_response_received_at,
+      Time.now.utc
+
+    body = environment.body
+    value = body.respond_to?(:read) ? body.read : body
+    value = value.to_s unless String === value
+
+    environment.instance_variable_set \
+      :@bf_request_body,
+      value
+
     super
   end
-end.tap { |m| Faraday::Adapter.send(:prepend, m) }
+end.tap { |m| Faraday::Adapter.prepend(m) }
 
-module Faraday
-  class Env
-    attr_reader :request_body, :request_sent_at, :response_received_at
+Module.new do
+  def end_transport(request, response)
+    headers = request.to_hash
+    headers.keys.each { |k| headers[k] = headers[k].join(", ") }
+    response.instance_variable_set :@bf_request_headers, headers
+    super
   end
+end.tap { |m| Net::HTTP.prepend(m) }
 
-  class Error
-    attr_reader :response
-
-    def inspect
-      super.gsub(/\s*\(\s*\)\s*\z/, "")
+Module.new do
+  def perform_request(connection, environment)
+    super(connection, environment).tap do |response|
+      environment.instance_variable_set \
+        :@bf_request_headers,
+        response.instance_variable_get(:@bf_request_headers)
     end
   end
+end.tap { |m| Faraday::Adapter::NetHttp.prepend(m) }
+
+module Faraday
+  class Env
+    attr_reader :bf_request_headers, :bf_request_body, :bf_request_sent_at, :bf_response_received_at
+  end
 
   class Response
-    def assert_2xx!
-      return self if status_2xx?
+    def assert_status!(code_or_range)
+      within_range = if Range === code_or_range
+        status.in?(code_or_range)
+      else
+        status == code_or_range
+      end
+
+      return self if within_range
 
       klass = if status_4xx?
-        "Faraday::HTTP#{status}".safe_constantize || Faraday::HTTP4xx
+        "BetterFaraday::HTTP#{status}".safe_constantize || BetterFaraday::HTTP4xx
+      elsif status_5xx?
+        "BetterFaraday::HTTP#{status}".safe_constantize || BetterFaraday::HTTP5xx
       else
-        Faraday::Error
+        BetterFaraday::HTTPError
       end
 
-      error = klass.new("\n#{describe}")
-      error.instance_variable_set(:@response, self)
-      raise error
+      raise klass.new(self)
+    end
+
+    def assert_2xx!
+      assert_status!(200..299)
     end
 
-    alias ok! assert_2xx! # Short name.
-    alias assert_success! assert_2xx! # Compatibility.
+    def assert_200!
+      assert_status! 200
+    end
 
     def status_2xx?
       status >= 200 && status <= 299
@@ -70,92 +104,91 @@ module Faraday
       status >= 500 && status <= 599
     end
 
-    def describe
-      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
+    def inspect
+      @inspection_text ||= begin
+        request_headers = bf_protect_data(env.bf_request_headers.dup)
+        request_body = env.bf_request_body.yield_self { |body| String === body ? body : body.to_s }
+        request_body_bytes_count = env.bf_request_body.bytesize
+        response_body = env.body.yield_self { |body| String === body ? body : body.to_s }
+        response_body_bytes_count = response_body.bytesize
+
+        if env.bf_request_headers["content-type"].to_s.match?(/\bapplication\/json\b/i)
+          request_json = bf_json_dump(bf_protect_data(bf_json_parse(request_body)))
+        end
 
-      if env.response_headers
-        response_headers = __protect_data(env.response_headers.deep_dup)
-      end
+        if env.response_headers
+          response_headers = bf_protect_data(env.response_headers.to_hash)
+        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
+        if env.response_headers && env.response_headers["content-type"].to_s.match?(/\bapplication\/json\b/i)
+          response_json = bf_json_dump(bf_protect_data(bf_json_parse(response_body)))
+        end
 
-      lines = [
-        "",
-        "-- #{status} #{reason_phrase} --".upcase,
-        "",
-        "-- Request URL --",
-        env.url.to_s,
-        "",
-        "-- Request method --",
-        env.method.to_s.upcase,
-        "",
-        "-- Request headers --",
-        ::JSON.generate(request_headers).yield_self { |t| t.truncate(2048, omission: "... (truncated, full length: #{t.length})") },
-        "",
-
-        "-- Request body --",
-        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 --",
-        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})") },
-        "",
+        lines = [
+          "-- #{status} #{reason_phrase} --".upcase,
+          "",
+          "-- Request URL --",
+          env.url.to_s,
+          "",
+          "-- Request Method --",
+          env.method.to_s.upcase,
+          "",
+          "-- Request Headers --",
+          bf_json_dump(request_headers).truncate(2048, omission: "... (truncated)"),
+          "",
 
-        "-- Response body --",
-        if response_json
-          ::JSON.generate(response_json)
-        else
-          body = env.body.to_s.dup
-          if body.encoding.name == "ASCII-8BIT"
-            "Binary (#{body.size} bytes)"
+          %[-- Request Body (#{request_body_bytes_count} #{"byte".pluralize(request_body_bytes_count)}) --],
+          if request_json
+            request_json
           else
-            body
-          end
-        end.yield_self { |t| t.truncate(2048, omission: "... (truncated, full length: #{t.length})") }
-      ]
+            # String#inspect returns \x{XXXX} for the encoding other than Unicode.
+            # [1..-2] removed leading and trailing " added by String#inspect.
+            # gsub(/\\"/, "\"") unescapes ".
+            request_body.inspect.gsub(/\\"/, "\"")[1..-2]
+          end.truncate(2048, omission: "... (truncated)"),
+          "",
 
-      if env.response_received_at
-        lines.concat [
+          "-- Request Sent At --",
+          env.bf_request_sent_at.strftime("%Y-%m-%d %H:%M:%S.%3N") + " UTC",
           "",
-          "-- Response received at --",
-          env.response_received_at.strftime("%Y-%m-%d %H:%M:%S.%2N") + " UTC",
+
+          "-- Response Headers --",
+          if response_headers
+            bf_json_dump(response_headers)
+          else
+            env.response_headers.to_s.inspect.gsub(/\\"/, "\"")[1..-2]
+          end.truncate(2048, omission: "... (truncated)"),
           "",
-          "-- Response received in --",
-          "#{((env.response_received_at.to_f - env.request_sent_at.to_f) * 1000.0).round(2)}ms"
+
+          %[-- Response Body (#{response_body_bytes_count} #{"byte".pluralize(response_body_bytes_count)}) --],
+          if response_json
+            response_json
+          else
+            response_body.inspect.gsub(/\\"/, "\"")[1..-2]
+          end.truncate(2048, omission: "... (truncated)"),
+          ""
         ]
+
+        if env.bf_response_received_at
+          lines.concat [
+            "-- Response Received At --",
+            env.bf_response_received_at.strftime("%Y-%m-%d %H:%M:%S.%3N") + " UTC",
+            "",
+            "-- Response Received In --",
+            "#{((env.bf_response_received_at.to_f - env.bf_request_sent_at.to_f) * 1000.0).ceil(3)}ms",
+            ""
+          ]
+        end
+
+        lines.join("\n").freeze
       end
 
-      lines.join("\n") + "\n"
+      @inspection_text.dup
     end
 
-    alias inspect describe
-
   private
 
-    def __parse_json(json)
+    def bf_json_parse(json)
       return nil unless ::String === json
       data = ::JSON.parse(json)
       data if ::Hash === data || ::Array === data
@@ -163,42 +196,58 @@ module Faraday
       nil
     end
 
-    def __protect_data(data)
-      return data.map(&method(:__protect_data)) if ::Array === data
+    def bf_json_dump(data)
+      ::JSON.generate(data, space: " ", object_nl: " ", array_nl: " ")
+    end
+
+    def bf_protect_data(data)
+      return data.map(&method(:bf_protect_data)) if ::Array === data
       return data unless ::Hash === data
+
+      signs = BetterFaraday.sensitive_data_signs
+
       data.each_with_object({}) do |(key, value), memo|
-        memo[key] = if key.to_s.underscore.tr("_", " ").yield_self { |k| Faraday::Inspection.secrets.any? { |s| k.match?(s) } }
+        memo[key] = if key.to_s.underscore.tr("_", " ").yield_self { |k| signs.any? { |r| k.match?(r) } }
           "SECRET"
         else
-          __protect_data(value)
+          bf_protect_data(value)
         end
       end
     end
   end
+end
+
+module BetterFaraday
+  class HTTPError < Faraday::Error
+    def initialize(response)
+      super(response.inspect, response)
+    end
+
+    def inspect
+      %[#{self.class}\n\n#{response.inspect}]
+    end
+  end
 
-  class HTTP4xx < Error; end
+  class HTTP4xx < HTTPError; end
   class HTTP400 < HTTP4xx; end
   class HTTP401 < HTTP4xx; end
   class HTTP403 < HTTP4xx; end
   class HTTP404 < HTTP4xx; end
   class HTTP422 < HTTP4xx; end
   class HTTP429 < HTTP4xx; end
-
-  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
+  class HTTP5xx < HTTPError; end
+  class HTTP500 < HTTP5xx; end
+  class HTTP502 < HTTP5xx; end
+  class HTTP503 < HTTP5xx; end
 
   class << self
-    def secrets
-      Inspection.secrets
-    end
-
-    def secrets=(value)
-      Inspection.secrets = value
-    end
+    attr_accessor :sensitive_data_signs
   end
+
+  self.sensitive_data_signs = [
+    /\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.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Yaroslav Konoplov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement