logstop 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25fa65a53db09bbdaf79bc3328b362ba4916a6c053a6509d09c0954bad16630f
-  data.tar.gz: 63a35fc75f233f0111c74283aa26e97cfe9e3788d29cb07a896fa87819dd923b
+  metadata.gz: d1045e35e2d837c1e66abd3916e08357b9cf98bfe4b37e5d0c4b8427901c6bb4
+  data.tar.gz: 61aecefd1d8b68f4bb48f1819eb9c0aea22b3440a4ebc9958ec2877c2be00d1a
 SHA512:
-  metadata.gz: 124774d6a4f51314d3104712cb8096d4a16cdb1996bda58bd2de38d253ebb0811293e4513b010cb92ca275d13f73471e1ba0542b6f14b7b455fa7119870b399b
-  data.tar.gz: da752afaef25ad882edbd5a8ea081c04470d11783ed6e4023498c63dc1308fb59164f79b766e39d690bf92dd7ceb5a2e83426ec22b7d417065cb53fc89a10ef6
+  metadata.gz: 610269d02743729383a41c45832f8849988928d998969569dc5013b9dbffde9428a914ec9411a96c883a7ca31aa2866d6534d1a6ef75b038fbb81e064a2fe12e
+  data.tar.gz: 60eacadc8d8027cc88b88558d05e216dad0f053f1f83c5c0198f934f888f15c01f34335925b13b5b4a0e1714ef8a82c0bb38c3b6bf3021aaadf50d932524a3b6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.1
+
+- Fix for log broadcaster in Rails console
+- Fix for url password filtering
+
 ## 0.2.0
 
 - Less aggressive filtering on numbers

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Andrew
+Copyright (c) 2018 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -37,6 +37,16 @@ And add it to your logger:
 logger.formatter = Logstop::Formatter.new(logger.formatter)
 ```
 
+### Rails
+
+Create `config/initializers/logstop.rb` with:
+
+```ruby
+Rails.logger.formatter = Logstop::Formatter.new(Rails.logger.formatter)
+```
+
+**Note:** In the Rails console with the default logger, logs show up unfiltered in STDOUT, but filtered in the log file. This is fixed on master.
+
 ## Options
 
 To scrub IP addresses, use:
@@ -57,6 +67,8 @@ This should be used in addition to `config.filtered_parameters`, not as a replac
 
 To scrub existing log files, check out [scrubadub](https://github.com/datascopeanalytics/scrubadub).
 
+To anonymize IP addresses, check out [IP Anonymizer](https://github.com/ankane/ip_anonymizer).
+
 ## Resources
 
 - [List of PII, as defined by NIST](https://en.wikipedia.org/wiki/Personally_identifiable_information#NIST_definition)

data/lib/logstop.rb

@@ -1,4 +1,5 @@
 require "logstop/formatter"
+require "logstop/railtie" if defined?(Rails)
 require "logstop/version"
 
 module Logstop
@@ -8,8 +9,8 @@ module Logstop
   CREDIT_CARD_REGEX = /\b\d{4}[\s-]?\d{4}[\s-]?\d{4}[\s-]?\d{4}\b/
   EMAIL_REGEX = /\b[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\b/i
   IP_REGEX = /\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/
-  PHONE_REGEX = /\b(\+\d{1,2}\s)?\(?\d{3}\)?[\s.-]\d{3}[\s.-]\d{4}\b/i
-  SSN_REGEX = /\b\d{3}[\s-]\d{2}[\s-]\d{4}\b/i
+  PHONE_REGEX = /\b(\+\d{1,2}\s)?\(?\d{3}\)?[\s.-]\d{3}[\s.-]\d{4}\b/
+  SSN_REGEX = /\b\d{3}[\s-]\d{2}[\s-]\d{4}\b/
   URL_PASSWORD_REGEX = /(\/\/\S+:)\S+@/
 
   def self.scrub(msg, ip: false)
@@ -22,7 +23,7 @@ module Logstop
       .gsub(CREDIT_CARD_REGEX, FILTERED_STR)
       .gsub(PHONE_REGEX, FILTERED_STR)
       .gsub(SSN_REGEX, FILTERED_STR)
-      .gsub(EMAIL_REGEX, FILTERED_STR)
       .gsub(URL_PASSWORD_REGEX, FILTERED_URL_STR)
+      .gsub(EMAIL_REGEX, FILTERED_STR)
   end
 end

data/lib/logstop/railtie.rb

@@ -0,0 +1,11 @@
+module Logstop
+  class Railtie < Rails::Railtie
+    console do
+      # make broadcaster inherit formatter
+      if Rails.logger && Rails.logger.formatter.is_a?(Logstop::Formatter)
+        # yes, these are the same, but it works
+        Rails.logger.formatter = Rails.logger.formatter
+      end
+    end
+  end
+end

data/lib/logstop/version.rb

@@ -1,3 +1,3 @@
 module Logstop
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -82,6 +82,7 @@ files:
 - Rakefile
 - lib/logstop.rb
 - lib/logstop/formatter.rb
+- lib/logstop/railtie.rb
 - lib/logstop/version.rb
 - logstop.gemspec
 homepage: https://github.com/ankane/logstop