tag_logger 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca7876f8a33dfbe7a209c3981c80c92013bb064151e0e5bd8c922551d0bc61b4
-  data.tar.gz: f6d858cc3d50e54971ae194985264313886a6ea71b0fd8e0a5627a08b7849db9
+  metadata.gz: 9a7649a198354c1d095fcef0635f1a9b622ca6918a1ae081e7dd2e01349cd0ce
+  data.tar.gz: ae8d092d882bc27d42063ee76828986196aa9fa0c5111850988a8dc215e3f361
 SHA512:
-  metadata.gz: 200a2c7c1f70bc92d8ab308c988365901bd7e410f7cc60db28353570cbea56c0ceb31abf60e647e81c4d286a713e4cd79da08b8f4320d9637daaa955aef0ea2a
-  data.tar.gz: f60823c056fb2aac28fd3bb8cb8bb9266de5c293059ee70e9e980b7e3934679ddd1b7dd7607baf015b83b4f5eb6becd5ff6cd737076092cb59cb3e6f24dae5da
+  metadata.gz: 0fbe43f76a3f87c48857e76f994bd8b5f41c29ca9a2ee851bd3b82ce66f21ba52e23d2f760ae95e233f6dc50584edf24c6e9ba127276de111d4d7fb65c286416
+  data.tar.gz: 89283740080c5eaba1a1cdaf6956b60e3c887468d264804e9d64a8eb12da14d98b0a365c8d8b16de5ba787896f03aed501f4f0d50cbdaa713fb98f1a820e5f8b

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)
+    raise '`sanitize_log` only for Hash' unless data.is_a?(Hash)
+
+    filter_parameters = TagLogger.configuration.filter_parameters
+    filter_parameters.each do |key|
+      next if data[key].nil?
+      data[key] = 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,13 +3,15 @@ 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
 
-      output_path = TagLogger.configuration&.output_path
+      output_path = TagLogger.configuration.output_path
       if output_path.nil? || output_path.empty?
         raise 'TagLogger configuration `output_path` is blank!'
       else

data/lib/tag_logger/version.rb

@@ -1,3 +1,3 @@
 module TagLogger
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

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