faraday-detailed_logger 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a686fbdcac03dc9553636285c80a55e6ecdf61215071e97c414a3f895f384bbc
-  data.tar.gz: 7a6651d0800697f224c3f9332a21e35f2c0736611a9508b99593b0284e9f88cd
+  metadata.gz: 743670ebe4c7a46ecd82eaa2adc20d41ebc5dae3adb4786402105d9fcf92ce4e
+  data.tar.gz: 986b9fcef32c461f74a85a2e70b6989ebe265d58aed99b6b1acfb100c6ab8b27
 SHA512:
-  metadata.gz: 0babd0756cefda4d3225a942841b2f98d3cdb45cc5ef01374807379462e8b0920d7bfa517023e0fe5f759d628304d015d9996f161a53ef6288aec5edfc080d19
-  data.tar.gz: 81c824acc1708a8fb4229da7830bd17c13b1badd586e2f6ffe1382aa34456983515a21fc63fb6eef94cc6d7c66acc98f1389be28a5da60ce130888f05d72dec5
+  metadata.gz: 036174605b88b0cb52f138e94b239a2c62ecd577ca91dc19f9e729bd674fe0eb73f4a92d0f32b992a677a7ef83021deaf359522072898b5c501381252591a473
+  data.tar.gz: ccd1cde9ad73aadb412d357bc52e24ad41c20dc091954f91364ad8610cf3919c20e685bce8f82bc8a2963e9326c8e031f7fc6826277f7a2aa88192f5a5590b46

data/Appraisals

@@ -12,6 +12,10 @@ appraise 'faraday-1.x' do
   gem 'faraday', '~> 1.0'
 end
 
+appraise 'faraday-2.x' do
+  gem 'faraday', '~> 2.0'
+end
+
 appraise 'faraday-latest' do
   gem 'faraday'
 end

data/CHANGELOG.md

@@ -7,6 +7,11 @@
 
 * No significant changes.
 
+## [2.5.0][] / 2022-01-23
+
+* Add faraday 2 support.
+* Extract an initial internal cURL formatter
+
 ## [2.4.2][] / 2021-11-09
 
 * Revert zeitwerk autoloading changes.
@@ -85,4 +90,5 @@
 [2.4.0]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.3.0...v2.4.0
 [2.4.1]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.4.0...v2.4.1
 [2.4.2]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.4.1...v2.4.2
-[HEAD]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.4.2...main
+[2.5.0]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.4.2...v2.5.0
+[HEAD]: https://github.com/envylabs/faraday-detailed_logger/compare/v2.5.0...main

data/faraday-detailed_logger.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '>= 0.16', '< 2'
+  spec.add_runtime_dependency 'faraday', '>= 0.16', '< 3'
 
   spec.add_development_dependency 'appraisal', '~> 2.0'
   spec.add_development_dependency 'bundler', '~> 2.0'

data/lib/faraday/detailed_logger/curl_formatter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Faraday
+  module DetailedLogger
+    module CurlFormatter
+      def self.request(env)
+        "#{env[:method].upcase} #{env[:url]}"
+      end
+
+      def self.request_body(env)
+        curl_output(env[:request_headers], env[:body]).inspect
+      end
+
+      def self.response(env)
+        "HTTP #{env[:status]}"
+      end
+
+      def self.response_body(env)
+        curl_output(env[:response_headers], env[:body]).inspect
+      end
+
+      private
+
+      def self.curl_output(headers, body)
+        string = headers.to_a.sort_by(&:first).map { |k, v| "#{k}: #{v}" }.join("\n")
+        string + "\n\n#{body}"
+      end
+    end
+  end
+end

data/lib/faraday/detailed_logger/middleware/current.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Faraday
+  module DetailedLogger
+    # A Faraday middleware used for providing debug-level logging information.
+    # The request and response logs follow very closely with cURL output for
+    # ease of understanding.
+    #
+    # Be careful about your log level settings when using this middleware,
+    # especially in a production environment. With a DEBUG level log enabled,
+    # there will be potential information security concerns, because the
+    # request and response headers and bodies will be logged out. At an INFO or
+    # greater level, this is not a concern.
+    #
+    class Middleware < Faraday::Middleware
+      attr_reader :logger
+      attr_reader :tags
+
+      # Internal: Used as the Middleware's logger in the case that an explicit
+      # logger is not provided.
+      #
+      # Returns a Logger instance.
+      #
+      def self.default_logger
+        require 'logger'
+        ::Logger.new($stdout)
+      end
+
+      # Public: Initialize a new Logger middleware.
+      #
+      # app - A Faraday-compatible middleware stack or application.
+      # logger - A Logger-compatible object to which the log information will
+      #          be recorded.
+      # tags - An optional array of tags to apply to the log output.
+      #
+      # Returns a Logger instance.
+      #
+      def initialize(app, logger = nil, *tags)
+        super(app)
+        @formatter = CurlFormatter
+        @logger = TaggedLogging.new(logger || self.class.default_logger)
+        @tags = tags
+      end
+
+      # Public: Used by Faraday to execute the middleware during the
+      # request/response cycle.
+      #
+      # env - A Faraday-compatible request environment.
+      #
+      # Returns the result of the parent application execution.
+      #
+      def call(env)
+        super
+      rescue
+        logger.error do
+          "#{$!.class.name} - #{$!.message} (#{$!.backtrace.first})"
+        end
+        raise
+      end
+
+      # Internal: Used by Faraday as a callback hook to process a network
+      # response after it has completed.
+      #
+      # env - A Faraday-compatible response environment.
+      #
+      # Returns nothing.
+      #
+      def on_complete(env)
+        status = env[:status]
+
+        logger.tagged(*tags) do
+          log_response_status(status) { formatter.response(env) }
+          logger.debug { formatter.response_body(env) }
+        end
+      end
+
+      # Public: Used by Faraday as a callback hook to process a network request
+      # before it has been made.
+      #
+      # env - A Faraday-compatible request environment.
+      #
+      # Returns nothing.
+      #
+      def on_request(env)
+        logger.tagged(*tags) do
+          logger.info { formatter.request(env) }
+          logger.debug { formatter.request_body(env) }
+        end
+      end
+
+      private
+
+      attr_reader :formatter
+
+      def log_response_status(status, &block)
+        case status
+        when 200..399
+          logger.info(&block)
+        else
+          logger.warn(&block)
+        end
+      end
+    end
+  end
+end

data/lib/faraday/detailed_logger/middleware/legacy.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Faraday
+  module DetailedLogger
+    # A Faraday middleware used for providing debug-level logging information.
+    # The request and response logs follow very closely with cURL output for
+    # ease of understanding.
+    #
+    # Be careful about your log level settings when using this middleware,
+    # especially in a production environment. With a DEBUG level log enabled,
+    # there will be potential information security concerns, because the
+    # request and response headers and bodies will be logged out. At an INFO or
+    # greater level, this is not a concern.
+    #
+    class Middleware < Faraday::Response::Middleware
+      attr_reader :logger
+      attr_reader :tags
+
+      # Internal: Used as the Middleware's logger in the case that an explicit
+      # logger is not provided.
+      #
+      # Returns a Logger instance.
+      #
+      def self.default_logger
+        require 'logger'
+        ::Logger.new($stdout)
+      end
+
+      # Public: Initialize a new Logger middleware.
+      #
+      # app - A Faraday-compatible middleware stack or application.
+      # logger - A Logger-compatible object to which the log information will
+      #          be recorded.
+      # tags - An optional array of tags to apply to the log output.
+      #
+      # Returns a Logger instance.
+      #
+      def initialize(app, logger = nil, *tags)
+        super(app)
+        @formatter = CurlFormatter
+        @logger = TaggedLogging.new(logger || self.class.default_logger)
+        @tags = tags
+      end
+
+      # Public: Used by Faraday to execute the middleware during the
+      # request/response cycle.
+      #
+      # env - A Faraday-compatible request environment.
+      #
+      # Returns the result of the parent application execution.
+      #
+      def call(env)
+        logger.tagged(*tags) do
+          logger.info { formatter.request(env) }
+          logger.debug { formatter.request_body(env) }
+        end
+        super
+      rescue
+        logger.error do
+          "#{$!.class.name} - #{$!.message} (#{$!.backtrace.first})"
+        end
+        raise
+      end
+
+      # Internal: Used by Faraday as a callback hook to process a network
+      # response after it has completed.
+      #
+      # env - A Faraday-compatible response environment.
+      #
+      # Returns nothing.
+      #
+      def on_complete(env)
+        status = env[:status]
+
+        logger.tagged(*tags) do
+          log_response_status(status) { formatter.response(env) }
+          logger.debug { formatter.response_body(env) }
+        end
+      end
+
+      private
+
+      attr_reader :formatter
+
+      def log_response_status(status, &block)
+        case status
+        when 200..399
+          logger.info(&block)
+        else
+          logger.warn(&block)
+        end
+      end
+    end
+  end
+end

data/lib/faraday/detailed_logger/middleware.rb

@@ -1,108 +1,12 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday/detailed_logger/curl_formatter'
 require 'faraday/detailed_logger/tagged_logging'
 
-module Faraday
-  module DetailedLogger
-    # A Faraday middleware used for providing debug-level logging information.
-    # The request and response logs follow very closely with cURL output for
-    # ease of understanding.
-    #
-    # Be careful about your log level settings when using this middleware,
-    # especially in a production environment. With a DEBUG level log enabled,
-    # there will be potential information security concerns, because the
-    # request and response headers and bodies will be logged out. At an INFO or
-    # greater level, this is not a concern.
-    #
-    class Middleware < Faraday::Response::Middleware
-      attr_reader :logger
-      attr_reader :tags
-
-      # Internal: Used as the Middleware's logger in the case that an explicit
-      # logger is not provided.
-      #
-      # Returns a Logger instance.
-      #
-      def self.default_logger
-        require 'logger'
-        ::Logger.new($stdout)
-      end
-
-      # Public: Initialize a new Logger middleware.
-      #
-      # app - A Faraday-compatible middleware stack or application.
-      # logger - A Logger-compatible object to which the log information will
-      #          be recorded.
-      # tags - An optional array of tags to apply to the log output.
-      #
-      # Returns a Logger instance.
-      #
-      def initialize(app, logger = nil, *tags)
-        super(app)
-        @logger = TaggedLogging.new(logger || self.class.default_logger)
-        @tags = tags
-      end
-
-      # Public: Used by Faraday to execute the middleware during the
-      # request/response cycle.
-      #
-      # env - A Faraday-compatible request environment.
-      #
-      # Returns the result of the parent application execution.
-      #
-      def call(env)
-        logger.tagged(*tags) do
-          logger.info { "#{env[:method].upcase} #{env[:url]}" }
-          logger.debug { curl_request_output(env) }
-        end
-        super
-      rescue
-        logger.error do
-          "#{$!.class.name} - #{$!.message} (#{$!.backtrace.first})"
-        end
-        raise
-      end
-
-      # Internal: Used by Faraday as a callback hook to process a network
-      # response after it has completed.
-      #
-      # env - A Faraday-compatible response environment.
-      #
-      # Returns nothing.
-      #
-      def on_complete(env)
-        status = env[:status]
-
-        logger.tagged(*tags) do
-          log_response_status(status) { "HTTP #{status}" }
-          logger.debug { curl_response_output(env) }
-        end
-      end
-
-      private
-
-      def curl_request_output(env)
-        curl_output(env[:request_headers], env[:body]).inspect
-      end
-
-      def curl_response_output(env)
-        curl_output(env[:response_headers], env[:body]).inspect
-      end
-
-      def curl_output(headers, body)
-        string = headers.to_a.sort_by(&:first).map { |k, v| "#{k}: #{v}" }.join("\n")
-        string + "\n\n#{body}"
-      end
-
-      def log_response_status(status, &block)
-        case status
-        when 200..399
-          logger.info(&block)
-        else
-          logger.warn(&block)
-        end
-      end
-    end
-  end
+case
+when Gem::Dependency.new('', '> 2.0.0.alpha.pre.1').match?('', Faraday::VERSION)
+  require_relative 'middleware/current'
+else
+  require_relative 'middleware/legacy'
 end

data/lib/faraday/detailed_logger/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module DetailedLogger
-    VERSION = '2.4.2'
+    VERSION = '2.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-detailed_logger
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Envy Labs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: '0.16'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '0.16'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -127,13 +127,15 @@ files:
 - Appraisals
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - faraday-detailed_logger.gemspec
 - lib/faraday/detailed_logger.rb
+- lib/faraday/detailed_logger/curl_formatter.rb
 - lib/faraday/detailed_logger/middleware.rb
+- lib/faraday/detailed_logger/middleware/current.rb
+- lib/faraday/detailed_logger/middleware/legacy.rb
 - lib/faraday/detailed_logger/tagged_logging.rb
 - lib/faraday/detailed_logger/version.rb
 homepage: https://github.com/envylabs/faraday-detailed_logger
@@ -158,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: A detailed request and response logger for Faraday.

data/Gemfile.lock

@@ -1,168 +0,0 @@
-PATH
-  remote: .
-  specs:
-    faraday-detailed_logger (2.4.2)
-      faraday (>= 0.16, < 2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      rack (~> 2.0, >= 2.0.9)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.4.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    appraisal (2.4.1)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    concurrent-ruby (1.1.9)
-    crass (1.0.6)
-    diff-lcs (1.4.4)
-    erubi (1.10.0)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    i18n (1.8.11)
-      concurrent-ruby (~> 1.0)
-    license_finder (6.14.2)
-      bundler
-      rubyzip (>= 1, < 3)
-      thor (~> 1.0.1)
-      tomlrb (>= 1.3, < 2.1)
-      with_env (= 1.1.0)
-      xml-simple (~> 1.1.5)
-    loofah (2.12.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    multipart-post (2.1.1)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      method_source
-      rake (>= 0.13)
-      thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.22.3)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    rubocop-minitest (0.15.2)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-packaging (0.5.1)
-      rubocop (>= 0.89, < 2.0)
-    rubocop-performance (1.12.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.12.4)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    rubocop-rails_config (1.7.4)
-      railties (>= 5.0)
-      rubocop (>= 1.19)
-      rubocop-ast (>= 1.0.1)
-      rubocop-minitest (~> 0.15)
-      rubocop-packaging (~> 0.5)
-      rubocop-performance (~> 1.11)
-      rubocop-rails (~> 2.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    rubyzip (2.3.2)
-    thor (1.0.1)
-    tomlrb (2.0.1)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    with_env (1.1.0)
-    xml-simple (1.1.9)
-      rexml
-    zeitwerk (2.5.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal (~> 2.0)
-  bundler (~> 2.0)
-  faraday-detailed_logger!
-  license_finder (~> 6.0)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop-rails_config (~> 1.3)
-
-BUNDLED WITH
-   2.2.30