httplog 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5332ba82035e300b5010a5cbcb125d9c90e083a405c43d1be8df1d626fc40fe1
-  data.tar.gz: 9692d53da3306a12bb14128f8365a9d7524fe6d443474c3dbdc11c21a8f3f6e9
+  metadata.gz: 9ce910d7c04847c28f836de26906c0c50aa4642b553b298d15067bf6ee25db56
+  data.tar.gz: 8600e756f28e033b6e39ac91235f69bf772fe467b05040d88c02ce54e982ef0b
 SHA512:
-  metadata.gz: 7829d7f38262b59ac69ae08e638aad00315322025fed502abf50e4ca468ea4286473c54984277ec98d436ff04fc86157ff38e5e529ec6ee8a9bef5a362f80e48
-  data.tar.gz: 4d0ccb0d024d21de6dcc9d116353810cf2e8adbc936c9b9ecbd38887931851555c19eb2756b7f43f298b9f7d6cc855322d75f4c473d813c35cc574c63cdb9ae0
+  metadata.gz: 6a76055079c7bfa4a229fda0861f90276c94cb64859ae7ce3c269e86656f3ad69fb3d5e8ed7eb2b82e9fe1facb0a73619951f099aafbbac7b0b503a52eb21046
+  data.tar.gz: f541eec119d175cc50563bc2673d60dae6246a43bcf570f9fe4db9a6295697ea94f7ffddb709aa8c9d0264f274f48c42bca3322d3364c1edd47298a984421363

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.4.3 - 2020-06-10
+
+* Masking `password` parameter by default... doh.
+
+## 1.4.2 - 2020-02-09
+
+* Rollback of the previous two releases due to bugs introduced there.
+
 ## 1.4.1 - 2020-02-08 - YANKED
 
 * [#91](https://github.com/trusche/httplog/pull/91) Fixed bug returning empty response with HTTP gem

data/README.md

@@ -1,13 +1,14 @@
 ## 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. Sorry about that...
+**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)
 [![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.4.
+Requires ruby >= 2.5
 
 This gem works with the following ruby modules and libraries:
 
@@ -31,6 +32,10 @@ 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
@@ -78,9 +83,6 @@ HttpLog.configure do |config|
   # You can also log in JSON format
   config.json_log = false
 
-  # For Graylog you can set this to `true`
-  config.graylog = false
-
   # Prettify the output - see below
   config.color = false
 
@@ -96,6 +98,9 @@ HttpLog.configure do |config|
   # to parse JSON responses
   config.json_parser = JSON
 
+  # When using graylog, you can supply a formatter here - see below for details
+  config.graylog_formatter = nil
+
   # Mask the values of sensitive request parameters
   config.filter_parameters = %w[password]
 end
@@ -131,19 +136,38 @@ HttpLog.configure do |config|
 end
 ```
 
+For more color options please refer to the [rainbow documentation](https://github.com/sickill/rainbow)
+
+### Graylog logging
+
 If you use Graylog and want to use its search features such as "benchmark:>1 AND method:PUT",
 you can use this configuration:
 
 ```ruby
+FORMATTER = Lograge::Formatters::KeyValue.new
+
 HttpLog.configure do |config|
-  config.logger        = <your GELF::Logger>
-  config.logger_method = :add
-  config.severity      = GELF::Levels::DEBUG
-  config.graylog       = true
+  config.logger            = <your GELF::Logger>
+  config.logger_method     = :add
+  config.severity          = GELF::Levels::DEBUG
+  config.graylog_formatter = FORMATTER
 end
 ```
 
-For more color options please refer to the [rainbow documentation](https://github.com/sickill/rainbow)
+You also can use GELF Graylog format this way:
+
+```ruby
+class Lograge::Formatters::Graylog2HttpLog < Lograge::Formatters::Graylog2
+  def short_message data
+    data[:response_body] = data[:response_body].to_s.byteslice(0, 32_766) unless data[:response_body].blank?
+    "[httplog] [#{data[:response_code]}] #{data[:method]} #{data[:url]}"
+  end
+end
+
+FORMATTER = Lograge::Formatters::Graylog2HttpLog.new
+```
+
+Or define your own class that implements the `call` method
 
 ### Compact logging
 

data/lib/httplog/configuration.rb

@@ -5,7 +5,7 @@ module HttpLog
     attr_accessor :enabled,
                   :compact_log,
                   :json_log,
-                  :graylog,
+                  :graylog_formatter,
                   :logger,
                   :logger_method,
                   :severity,
@@ -31,7 +31,7 @@ module HttpLog
       @enabled                 = true
       @compact_log             = false
       @json_log                = false
-      @graylog                 = false
+      @graylog_formatter       = nil
       @logger                  = Logger.new($stdout)
       @logger_method           = :log
       @severity                = Logger::Severity::DEBUG
@@ -51,7 +51,7 @@ module HttpLog
       @prefix_response_lines   = false
       @prefix_line_numbers     = false
       @json_parser             = JSON
-      @filter_parameters       = []
+      @filter_parameters       = %w[password]
     end
   end
 end

data/lib/httplog/http_log.rb

@@ -32,7 +32,7 @@ module HttpLog
       parse_request(options)
       if config.json_log
         log_json(options)
-      elsif config.graylog
+      elsif config.graylog_formatter
         log_graylog(options)
       elsif config.compact_log
         log_compact(options[:method], options[:url], options[:response_code], options[:benchmark])
@@ -207,8 +207,6 @@ module HttpLog
 
     def log_graylog(data)
       result = json_payload(data)
-
-      result[:short_message] = result.delete(:url)
       begin
         send_to_graylog result
       rescue
@@ -219,7 +217,8 @@ module HttpLog
     end
 
     def send_to_graylog data
-      config.logger.public_send(config.logger_method, config.severity, data)
+      data.compact!
+      config.logger.public_send(config.logger_method, config.severity, config.graylog_formatter.call(data))
     end
 
     def json_payload(data = {})
@@ -264,7 +263,8 @@ module HttpLog
       case msg
       when *string_classes
         config.filter_parameters.reduce(msg) do |m,key|
-          m.to_s.gsub(/(#{key})=[^&]+/i, "#{key}=#{PARAM_MASK}")
+          scrubbed = m.to_s.encode('UTF-8', invalid: :replace, undef: :replace)
+          scrubbed.gsub(/(#{key})=[^&]+/i, "#{key}=#{PARAM_MASK}")
         end
       # ...and recurse over hashes
       when *hash_classes

data/lib/httplog/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httplog
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Thilo Rusche
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Log outgoing HTTP requests.