httplog 1.4.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce910d7c04847c28f836de26906c0c50aa4642b553b298d15067bf6ee25db56
-  data.tar.gz: 8600e756f28e033b6e39ac91235f69bf772fe467b05040d88c02ce54e982ef0b
+  metadata.gz: b45410a66dcec431137326ea3402d5f7aa46aec70ad5bd826dc3fe24021c4dfe
+  data.tar.gz: a7fb94896bd9456ca53f83c78a9b0ed025e9dffd537bf531b56350488334ee1f
 SHA512:
-  metadata.gz: 6a76055079c7bfa4a229fda0861f90276c94cb64859ae7ce3c269e86656f3ad69fb3d5e8ed7eb2b82e9fe1facb0a73619951f099aafbbac7b0b503a52eb21046
-  data.tar.gz: f541eec119d175cc50563bc2673d60dae6246a43bcf570f9fe4db9a6295697ea94f7ffddb709aa8c9d0264f274f48c42bca3322d3364c1edd47298a984421363
+  metadata.gz: 4abf19d31bcf87d0f4f5cdf4eab1eee36f1974581310077be364a3a89d9f5dae956b7cd5fa021b2711606ac6657ce904a293119a3da8738d95e45d52fc98d50b
+  data.tar.gz: 567406b24ed46bf14bec3960ad246c8ca866f9f96160fcb3578c99969548d2720a5dde179eb69ac129c787cd9121839560914900bd9eef7f68986cd545c93438

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.5.0 - 2021-05-20
+
+* Support for Ruby 2.7 and frozen strings
+* Development dependency updates
+* Dropped support for net/http v3
+* Performance tweaks
+* Fix for RestClient body read issue (WARNING: this may be reverted, see [#105](https://github.com/trusche/httplog/issues/105))
+
 ## 1.4.3 - 2020-06-10
 
 * Masking `password` parameter by default... doh.

data/README.md

@@ -1,18 +1,15 @@
 ## httplog
 
-**VERSION 1.4.0 and 1.4.1 HAVE BEEN YANKED** from rubygems.org due to [this issue](https://github.com/trusche/httplog/issues/89), please update to version 1.4.2 or higher. Sorry about that...
-
-[![Gem Version](https://badge.fury.io/rb/httplog.svg)](http://badge.fury.io/rb/httplog) [![Build Status](https://travis-ci.org/trusche/httplog.svg?branch=master)](https://travis-ci.org/trusche/httplog) [![Code Climate](https://codeclimate.com/github/trusche/httplog.svg)](https://codeclimate.com/github/trusche/httplog)
+[![Gem Version](https://badge.fury.io/rb/httplog.svg)](http://badge.fury.io/rb/httplog) [![Build Status](https://travis-ci.com/trusche/httplog.svg?branch=master)](https://travis-ci.org/trusche/httplog) [![Code Climate](https://codeclimate.com/github/trusche/httplog.svg)](https://codeclimate.com/github/trusche/httplog)
 [![Release Version](https://img.shields.io/github/release/trusche/httplog.svg)](https://img.shields.io/github/release/trusche/httplog.svg)
-<a href="https://www.bearer.sh?ref=httplog"><img src="/bearer-badge.png" height="20px"/></a>
 
 Log outgoing HTTP requests made from your application. Helps with debugging pesky API error responses, or just generally understanding what's going on under the hood.
 
-Requires ruby >= 2.5
+Requires ruby >= 2.6
 
 This gem works with the following ruby modules and libraries:
 
-* [Net::HTTP](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/index.html)
+* [Net::HTTP](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/http/rdoc/index.html) v4+
 * [Ethon](https://github.com/typhoeus/ethon)
 * [Excon](https://github.com/geemus/excon)
 * [OpenURI](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/open-uri/rdoc/index.html)
@@ -32,10 +29,6 @@ This is very much a development and debugging tool; it is **not recommended** to
 use this in a production environment as it is monkey-patching the respective HTTP implementations.
 You have been warned - use at your own risk.
 
-Httplog is kindly sponsored by <a href="https://www.bearer.sh?ref=httplog">Bearer.sh</a> - go check them out please!
-
-<a href="https://www.bearer.sh?ref=httplog"><img src="/bearer-sponsor.png" height="72px" /></a>
-
 ### Installation
 
     gem install httplog
@@ -103,6 +96,9 @@ HttpLog.configure do |config|
 
   # Mask the values of sensitive request parameters
   config.filter_parameters = %w[password]
+  
+  # Customize the prefix with a proc or lambda
+  config.prefix = ->{ "[httplog] #{Time.now} " }
 end
 ```
 
@@ -267,9 +263,6 @@ a suggestion for a fix, please open an issue or, even better, submit a pull requ
 
 * Benchmarking only covers the time between starting the HTTP request and receiving the response. It does *not* cover the time it takes to establish the TCP connection.
 
-* When using [REST Client](https://github.com/rest-client/rest-client), POST requests might be missing the requests
-  data. See #54 for details.
-
 ### Running the specs
 
 Make sure you have the necessary dependencies installed by running `bundle install`.

data/httplog.gemspec

@@ -22,23 +22,25 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- test/*`.split("\n")
   gem.require_paths = ['lib']
 
-  gem.required_ruby_version = '>= 2.2'
+  gem.required_ruby_version = '>= 2.6'
 
   gem.add_development_dependency 'ethon', ['~> 0.11']
   gem.add_development_dependency 'excon', ['~> 0.60']
-  gem.add_development_dependency 'faraday', ['~> 0.14']
+  gem.add_development_dependency 'faraday', ['~> 1.3']
   gem.add_development_dependency 'guard-rspec', ['~> 4.7']
   gem.add_development_dependency 'http', ['~> 4.0']
   gem.add_development_dependency 'httparty', ['~> 0.16']
   gem.add_development_dependency 'httpclient', ['~> 2.8']
+  gem.add_development_dependency 'rest-client', ['~> 2.0']
+  gem.add_development_dependency 'typhoeus', ['~> 1.4']
   gem.add_development_dependency 'listen', ['~> 3.0']
   gem.add_development_dependency 'patron', ['~> 0.12']
-  gem.add_development_dependency 'rake', ['~> 12.3']
+  gem.add_development_dependency 'rake', ['~> 13.0']
   gem.add_development_dependency 'rspec', ['~> 3.7']
   gem.add_development_dependency 'simplecov', ['~> 0.15']
   gem.add_development_dependency 'thin', ['~> 1.7']
   gem.add_development_dependency 'oj', ['>= 3.9.2']
 
-  gem.add_dependency 'rack', ['>= 1.0']
+  gem.add_dependency 'rack', ['>= 2.0']
   gem.add_dependency 'rainbow', ['>= 2.0.0']
 end

data/lib/httplog/adapters/ethon.rb

@@ -8,7 +8,7 @@ if defined?(Ethon)
       module Http
         alias orig_http_request http_request
         def http_request(url, action_name, options = {})
-          @http_log = options.merge(method: action_name) # remember this for compact logging
+          @http_log = options.merge(method: action_name, url: url) # remember this for compact logging
           orig_http_request(url, action_name, options)
         end
       end
@@ -18,32 +18,50 @@ if defined?(Ethon)
         def perform
           return orig_perform unless HttpLog.url_approved?(url)
 
-          bm = Benchmark.realtime { orig_perform }
+          httplog_add_callback
 
-          # Not sure where the actual status code is stored - so let's
-          # extract it from the response header.
-          encoding = response_headers.scan(/Content-Encoding: (\S+)/).flatten.first
-          content_type = response_headers.scan(/Content-Type: (\S+(; charset=\S+)?)/).flatten.first
+          bm = Benchmark.realtime { orig_perform }
 
-          # Hard to believe that Ethon wouldn't parse out the headers into
-          # an array; probably overlooked it. Anyway, let's do it ourselves:
-          headers = response_headers.split(/\r?\n/).drop(1)
+          url = @http_log[:url]
+          url = "#{url}?#{@http_log[:params]}" if @http_log[:params]
 
           HttpLog.call(
             method: @http_log[:method],
-            url: @url,
+            url: url,
             request_body: @http_log[:body],
             request_headers: @http_log[:headers],
             response_code: @return_code,
-            response_body: response_body,
-            response_headers: headers.map { |header| header.split(/:\s/) }.to_h,
+            response_body: @http_log[:response_body],
+            response_headers: @http_log[:response_headers].map { |header| header.split(/:\s/) }.to_h,
             benchmark: bm,
-            encoding: encoding,
-            content_type: content_type,
-            mask_body: HttpLog.masked_body_url?(url)
+            encoding: @http_log[:encoding],
+            content_type: @http_log[:content_type],
+            mask_body: HttpLog.masked_body_url?(@http_log[:url])
           )
           return_code
         end
+
+        def httplog_add_callback
+          # Hack to perform this callback before the cleanup
+          @on_complete ||= []
+          @on_complete.unshift -> (*) do
+            # Not sure where the actual status code is stored - so let's
+            # extract it from the response header.
+            encoding = response_headers.scan(/Content-Encoding: (\S+)/).flatten.first
+            content_type = response_headers.scan(/Content-Type: (\S+(; charset=\S+)?)/).flatten.first
+
+            # Hard to believe that Ethon wouldn't parse out the headers into
+            # an array; probably overlooked it. Anyway, let's do it ourselves:
+            headers = response_headers.split(/\r?\n/).drop(1)
+
+            @http_log.merge!(
+              encoding: encoding,
+              content_type: content_type,
+              response_headers: headers,
+              response_body: response_body
+            )
+          end
+        end
       end
     end
   end

data/lib/httplog/adapters/net_http.rb

@@ -11,12 +11,22 @@ module Net
       bm = Benchmark.realtime do
         @response = orig_request(req, body, &block)
       end
+      body_stream  = req.body_stream
+      request_body = if body_stream
+                       body_stream.to_s # read and rewind for RestClient::Payload::Base
+                       body_stream.rewind if body_stream.respond_to?(:rewind) # RestClient::Payload::Base has no method rewind
+                       body_stream.read
+                     elsif req.body.nil? || req.body.empty?
+                       body
+                     else
+                       req.body
+                     end
 
       if HttpLog.url_approved?(url) && started?
         HttpLog.call(
           method: req.method,
           url: url,
-          request_body: req.body.nil? || req.body.empty? ? body : req.body,
+          request_body: request_body,
           request_headers: req.each_header.collect,
           response_code: @response.code,
           response_body: @response.body,

data/lib/httplog/configuration.rb

@@ -50,7 +50,7 @@ module HttpLog
       @prefix_data_lines       = false
       @prefix_response_lines   = false
       @prefix_line_numbers     = false
-      @json_parser             = JSON
+      @json_parser             = nil
       @filter_parameters       = %w[password]
     end
   end

data/lib/httplog/http_log.rb

@@ -26,6 +26,7 @@ module HttpLog
 
     def configure
       yield(configuration)
+      configuration.json_parser ||= ::JSON if configuration.json_log || configuration.url_masked_body_pattern
     end
 
     def call(options = {})
@@ -121,22 +122,24 @@ module HttpLog
         raise BodyParsingError, '(not available yet)'
       end
 
-      body = body.to_s if defined?(HTTP::Response::Body) && body.is_a?(HTTP::Response::Body)
-      body = body.dup
+      body_copy = body.dup
+      body_copy = body.to_s if defined?(HTTP::Response::Body) && body.is_a?(HTTP::Response::Body)
+      return nil if body_copy.nil? || body_copy.empty?
 
-      if encoding =~ /gzip/ && body && !body.empty?
+
+      if encoding =~ /gzip/
         begin
-          sio = StringIO.new(body.to_s)
+          sio = StringIO.new(body_copy.to_s)
           gz = Zlib::GzipReader.new(sio)
-          body = gz.read
+          body_copy = gz.read
         rescue Zlib::GzipFile::Error
           log("(gzip decompression failed)")
         end
       end
 
-      result = utf_encoded(body.to_s, content_type)
+      result = utf_encoded(body_copy.to_s, content_type)
 
-      if mask_body && body && !body.empty?
+      if mask_body
         if content_type =~ /json/
           result = begin
                      masked_data config.json_parser.load(result)
@@ -259,12 +262,14 @@ module HttpLog
       # in its entirety.
       return (config.filter_parameters.include?(key.downcase) ? PARAM_MASK : msg) if key
 
-      # Otherwise, we'll parse Strings for key=valye pairs...
+      # Otherwise, we'll parse Strings for key=value pairs,
+      # for name="key"\n value...
       case msg
       when *string_classes
         config.filter_parameters.reduce(msg) do |m,key|
           scrubbed = m.to_s.encode('UTF-8', invalid: :replace, undef: :replace)
-          scrubbed.gsub(/(#{key})=[^&]+/i, "#{key}=#{PARAM_MASK}")
+          scrubbed.to_s.gsub(/(#{key})=[^&]+/i, "#{key}=#{PARAM_MASK}")
+            .gsub(/name="#{key}"\s+\K[\s\w]+/, "#{PARAM_MASK}\r\n") # multi-part Faraday
         end
       # ...and recurse over hashes
       when *hash_classes
@@ -345,7 +350,7 @@ module HttpLog
     end
 
     def log_data_lines(data)
-      data.each_line.with_index do |line, row|
+      data.to_s.each_line.with_index do |line, row|
         if config.prefix_line_numbers
           log("#{row + 1}: #{line.chomp}")
         else

data/lib/httplog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HttpLog
-  VERSION = '1.4.3'.freeze
+  VERSION = '1.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +240,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -267,14 +295,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Log outgoing HTTP requests.