tag_logger 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89dc1838150d202e25c6c788f56c98f2b295d1978921681e7ebeba740263f6c7
-  data.tar.gz: 3529f3aa838f689f9cf1c1960e790b919b40f6dc37ea5eff8036f137d0f15715
+  metadata.gz: 215dfe2e22d3d59cdcd85d9b30c666e32c0e10af3846050082a634645f2b6102
+  data.tar.gz: 34604939dd5fd617211ed6d5cc539a9e2e3df8bc3dedafcb2ab3d182a4ade84b
 SHA512:
-  metadata.gz: 7f59e32e1c8fa629e1bd66f7dbf4577f51c13fa24a16cac081db9eb55631d81e68327c53f569610c94f48309b824c961cee1148f728228edefa7142992d125c8
-  data.tar.gz: a1cb01532e4d6c2ff3c71f13b8f989a145f0fd8ee841e8af489965712ae595b7c2837f9f9041562cef07c18aebc72261781a6c18ddc160fc95cc5f838466b6d6
+  metadata.gz: fe407b802ddb976326afd1d338127ce39967b3368e9673188c02dd9e3fffdef13e036f56879223118f89ac1f2ee0c71bf725680c98513bba7a45767bdc5ee330
+  data.tar.gz: 4620345336eedaa3b1cd4d8aa60794d7a8b5117955c8112113ca3d74c3e6ce43de9c77be5a74bd7a2a66c7a4545fbee1e9e88a5cccc4af1bfdb503dda02b9da2

data/README.md

@@ -11,7 +11,7 @@ gem 'tag_logger'
 
 Or install it yourself as:
 ```bash
-$ gem install sample_filter
+$ gem install tag_logger
 ```
 
 ## Usage
@@ -19,6 +19,7 @@ First need to add configuration:
 ```ruby
 TagLogger.configure do |config|
   config.output_path = 'log/tag_logger.log'
+  config.filter_parameters = [:password]
 end
 ```
 
@@ -33,6 +34,11 @@ class MyClass
 
     # then log with levels: [:warn, :info, :debug, :fatal, :error]
     log :info, 'Log information'
+
+    # if data has sensitive information, it must be sanitized
+    # INFO -- : [tag_name] Log information {:email=>"test@email.com", :password=>"[FILTERED]"}
+    data = {email: 'test@email.com', password: '123456'}
+    log :info, "Log information #{sanitize_log(data)}"
   end
 end
 ```

data/lib/tag_logger.rb

@@ -2,6 +2,8 @@ require 'tag_logger/helper_logger'
 require 'tag_logger/configuration'
 
 module TagLogger
+  FILTERED_TEXT = '[FILTERED]'.freeze
+
   def tag_logger(*tags)
     @tag_logger ||= HelperLogger.new(tags)
   end
@@ -13,4 +15,16 @@ module TagLogger
       @tag_logger.write_log(type, text)
     end
   end
+
+  def sanitize_log(data)
+    data = data.to_hash.transform_keys(&:to_sym)
+
+    filter_parameters = TagLogger.configuration.filter_parameters
+    filter_parameters.each do |key|
+      next if data[key.to_sym].nil?
+      data[key.to_sym] = FILTERED_TEXT
+    end
+
+    data
+  end
 end

data/lib/tag_logger/configuration.rb

@@ -9,6 +9,10 @@ module TagLogger
   end
 
   class Configuration
-    attr_accessor :output_path
+    attr_accessor :output_path, :filter_parameters
+
+    def initialize
+      @filter_parameters = Array.new
+    end
   end
 end

data/lib/tag_logger/helper_logger.rb

@@ -3,16 +3,19 @@ module TagLogger
     attr_reader :tags, :logger
 
     def initialize(tags)
+      raise 'TagLogger configuration is nil!' if TagLogger.configuration.nil?
+
       if tags.empty?
         raise 'Tags for `tag_logger` are empty!'
       else
         @tags = tags
       end
 
-      if TagLogger.configuration&.output_path.blank?
+      output_path = TagLogger.configuration.output_path
+      if output_path.nil? || output_path.empty?
         raise 'TagLogger configuration `output_path` is blank!'
       else
-        @logger ||= Logger.new(TagLogger.configuration.output_path)
+        @logger ||= Logger.new(output_path)
       end
     end
 

data/lib/tag_logger/version.rb

@@ -1,3 +1,3 @@
 module TagLogger
-  VERSION = '1.0.1'
+  VERSION = '1.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tag_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - iliakg