logify 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f397195c1a3f20f14adfa54eaa76ad742ee0b624
-  data.tar.gz: 0643d3a0c5570f0fa8da7a2c9ce577f17e921929
+  metadata.gz: 1bcc3e3495cbe4217d1198e098fdc99ae1165688
+  data.tar.gz: 4f9a07b1d502d5a7879dcbfe97b2a25833f64757
 SHA512:
-  metadata.gz: 3030a68c9296d02af53bb1f30236e4e182c1267da0582f011012da79f1549ad92dc6c71d9123beeeee7a0beb7c5c3691068e4b2da7625a0771f5ce4aadf743ff
-  data.tar.gz: 9a6041c145949efa74ed05aee71d50ad1df890c556834169603bbad70f0081729ddf6f67dec4df69c92206bcf3a736e2f2f590c56b4be980d3350402ecd2001d
+  metadata.gz: 44623445e580503c358470ea0316e4b00e3aae92f7ec1b143c6fca84c05f77411f030221c423894e0172273a4d27b9b6d9be9d4adea61fbe063a81cbe46f593f
+  data.tar.gz: ef691f792b07183e5a2892b1be1088f399f8cc56e9e4e5002dcc18f41590a0c478fcfc600b534bc1224da62ef8222436ad267eccc4ae88758cca4c1af18c43c4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+Logify Changelog
+================
+
+v0.2.0
+------
+- Document manual logger creation
+- Add filter parameters
+- `log` methods now return the yielded string
+
+v0.1.0
+------
+- Initial public release

data/README.md

@@ -76,6 +76,26 @@ WARN  #=> "W"
 INFO  #=> "I"
 ```
 
+If you are anti-modules (or if you want to use `log` for something else), you can manually create your Logger object in an initializer:
+
+```ruby
+require 'logify'
+
+class MyClass
+  def initialize
+    @logger = Logify.logger_for(self.class.name) # Or any custom name
+  end
+end
+```
+
+And then use `@logger` to call your log methods:
+
+```ruby
+def other_method
+  @logger.info 'Running other_method'
+end
+```
+
 Configuring
 -----------
 Logify is configurable via the top-level `Logify` module.
@@ -125,6 +145,12 @@ Or set the `log_level` to `:none`:
 Logify.level = :none
 ```
 
+If you are logging sensitive information (such as passwords and API keys), you can add that information as a filter to Logify. Logify will replace those values with "`[FILTERED]`" in logging output.
+
+```ruby
+Logify.filter('P@s$w0r)')
+```
+
 
 Installation
 ------------

data/lib/logify.rb

@@ -90,6 +90,28 @@ module Logify
       Thread.current[IO_ID] = io
     end
 
+    #
+    # Add a filter parameter to Logify.
+    #
+    # @example Filter a password in the logger
+    #   Logify.filter('P@s$w0r)')
+    #   log.debug "This is the P@s$w0r)" #=> "This is the [FILTERED]"
+    #
+    # @return [void]
+    #
+    def filter(param)
+      filters[param] = nil
+    end
+
+    #
+    # The list of filters for Logify.
+    #
+    # @return [Hash]
+    #
+    def filters
+      @filters ||= {}
+    end
+
     private
 
     # @private

data/lib/logify/logger.rb

@@ -21,7 +21,8 @@ module Logify
       #     @param [Proc] block
       #       the block to call that returns a string to write
       #
-      #     @return [true]
+      #     @return [String]
+      #       the compiled log message
       #
       def level(name)
         constant = name.to_s.upcase
@@ -39,13 +40,13 @@ module Logify
                 buffer << PREFIX_#{constant}
               end
 
-              buffer << message if message
-              buffer << yield   if block_given?
+              buffer << filter(message) if message
+              buffer << filter(yield)   if block_given?
               buffer << "#{NEWLINE}"
 
               MONITOR.synchronize { Logify.io.write(buffer) }
 
-              true
+              buffer
             end
           end
         EOH
@@ -53,6 +54,7 @@ module Logify
     end
 
     ANONYMOUS  = '(Anonymous)'
+    FILTERED   = '[FILTERED]'
     MAX_LENGTH = 32
     NEWLINE    = "\n"
     SEPARATOR  = ' | '
@@ -106,7 +108,14 @@ module Logify
 
     private
 
+    #
     # @private
+    #
+    # The truncated id (for debug only).
+    #
+    # @return [String]
+    #   the formatted id
+    #
     def formatted_id
       return @formatted_id if @formatted_id
 
@@ -131,5 +140,26 @@ module Logify
         @formatted_id = temp.rjust(MAX_LENGTH)
       end
     end
+
+    #
+    # @private
+    #
+    # Filter the given string of any filtered parameters.
+    #
+    # @see Logify.filter
+    #
+    # @param [String]
+    #   the string to filter
+    #
+    # @return [String]
+    #   the filtered string
+    #
+    def filter(string)
+      string.dup.tap do |copy|
+        Logify.filters.each do |param, _|
+          copy.gsub!(param, FILTERED)
+        end
+      end
+    end
   end
 end

data/lib/logify/version.rb

@@ -4,5 +4,5 @@ module Logify
   #
   # @return [String]
   #
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/logify.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']

data/spec/unit/logify/logger_spec.rb

@@ -240,5 +240,14 @@ module Logify
         expect(stdout).to_not include('This is a fatal')
       end
     end
+
+    context 'with filter params' do
+      before { Logify.filter('bacon') }
+
+      it 'filters the parameter' do
+        log.info 'The password is bacon'
+        expect(stdout).to include('The password is [FILTERED]')
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -77,6 +77,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md