tag_logger 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1383db345a0b72da2a66bb213a7b66c3222d513b25b2c45077e3a1b28f3a8427
-  data.tar.gz: 18f14e9667504e9862abffb897d356e76b5ed0384e2629c2a135743c309e6b1f
+  metadata.gz: 01f47f454ecf52b39c5cf37c481e1c183802685c144ffd1c1a756a2cdce8eb4a
+  data.tar.gz: 1d94cc8ec85cd64685b7e690659a11182d0808feaf7e6403458e1dc213838514
 SHA512:
-  metadata.gz: a4a0d4410c1086f3a24e6b1bc948b8f214915823fb92f17504cc23e5f025093e4f6067df6db237fd1e7d9544d835a795fe592e59b4d476ecbc1ef8bec103def3
-  data.tar.gz: 41a821b4c21315e5c4266ef73899b6ad4cddf3633a8e75771b3a815b0603d634d0bedec046efbcd8e8cd608d393de0ba6b85dc455bb74b5c21d2423928c0313f
+  metadata.gz: 8ebba40d43445388a7540c9446734f564522e9583f4fb1a4cad8ac59574e30b2dc0d7787c94108ff6f2704737e91812e80c32138470f247c4f9c068a122a51e0
+  data.tar.gz: 63faae4fd1200ff11d382ff911236bfcecd9ea74203ff6b8c21827f5c8129368dd5dc8af79a98896a16a02c64bd3bbebb99d76844e0dfadec8863ef56d28f256

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ilia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -11,14 +11,15 @@ gem 'tag_logger'
 
 Or install it yourself as:
 ```bash
-$ gem install sample_filter
+$ gem install tag_logger
 ```
 
 ## Usage
 First need to add configuration:
 ```ruby
 TagLogger.configure do |config|
-  config.output_path = "log/tag_logger.log"
+  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)
-      if tags.blank?
+      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.0'
-end
+  VERSION = '1.0.5'
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: tag_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
-- ilia_kg
+- iliakg
 autorequire:
 bindir: bin
 cert_chain: []
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/tag_logger.rb
 - lib/tag_logger/configuration.rb