ridley 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1502e3edb782cbe22be2729744d1272bb81c9863
-  data.tar.gz: 26860b2a9731e88a3077d58ae1b46257c6055157
+  metadata.gz: 3440ef439aff4fca73a0bb7943c5883b73d4ee6a
+  data.tar.gz: d1f414b2cb9a4f5210f59068bcde449f369013b9
 SHA512:
-  metadata.gz: 13bae8f8d79d3baeea469c9cb082f143a6a6bbaf976cd61b8c936e51fc5603ae59dcc09fa17dbe696f894c3ca384fe3a064cdb57997ca4061f3ec6a043864b79
-  data.tar.gz: f536df4f30fd045955a06108adc8df2284fb4b6425d4fabc054bf262e2e8f8d06f5b9025cc8e1b25278bfe0daa199dc41fe2b3459d05503b5a8cb340d62d9f57
+  metadata.gz: fe0cdd7ea95cd9a6d6357c9242d1d73300de0777291499f9f61ce254fe1fa914c506a1be30065e8738a52bc8209bc6e5859975fdcf3c59ea0411642263f4dc0f
+  data.tar.gz: a67ccd75c7ff3006a70acd1d93154aab3de632c9a01464749a19d973ade48f2292704f481c08de7e93d603b23aa2c7e912afa083e99762f767bfa9399fa383b7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.1.0
+
+* [#228](https://github.com/RiotGames/ridley/pull/228) Add a new API for filtering log output. Useful for output you might not want to display because it is sensitive.
+
 # 2.0.0
 
 * [#227](https://github.com/RiotGames/ridley/pull/227) HostCommander and HostConnector code has been moved into its own gem - [found here](https://github.com/RiotGames/ridley-connectors)

data/lib/ridley.rb

@@ -64,6 +64,7 @@ module Ridley
 
   require_relative 'ridley/mixin'
   require_relative 'ridley/logging'
+  require_relative 'ridley/logger'
   require_relative 'ridley/bootstrap_context'
   require_relative 'ridley/command_context'
   require_relative 'ridley/chef_object'

data/lib/ridley/logger.rb

@@ -0,0 +1,66 @@
+module Ridley
+  module Logging
+    class Logger < Logger
+      def initialize(device = STDOUT)
+        super
+        self.level = Logger::WARN
+        @filter_params = Array.new
+      end
+
+      # Reimplements Logger#add adding message filtering. The info,
+      # warn, debug, error, and fatal methods all call add.
+      #
+      # @param [Fixnum] severity
+      #   an integer measuing the severity - Logger::INFO, etc.
+      # @param [String] message = nil
+      #   the message to log
+      # @param [String] progname = nil
+      #   the program name performing the logging
+      # @param  &block
+      #  a block that will be evaluated (for complicated logging)
+      #
+      # @example
+      #   log.filter_param("hello")
+      #   log.info("hello world!") => "FILTERED world!"
+      #
+      # @return [Boolean]
+      def add(severity, message = nil, progname = nil, &block)
+        severity ||= Logger::UNKNOWN
+        if @logdev.nil? or severity < @level
+          return true
+        end
+        progname ||= @progname
+        if message.nil?
+          if block_given?
+            message = yield
+          else
+            message = progname
+            progname = @progname
+          end
+        end
+        @logdev.write(
+          format_message(format_severity(severity), Time.now, progname, filter(message)))
+        true
+      end
+
+      def filter_params
+        @filter_params.dup
+      end
+
+      def filter_param(param)
+        @filter_params << param unless filter_params.include?(param)
+      end
+
+      def clear_filter_params
+        @filter_params.clear
+      end
+
+      def filter(message)
+        filter_params.each do |param|
+          message.gsub!(param.to_s, 'FILTERED')
+        end
+        message
+      end
+    end
+  end
+end

data/lib/ridley/logging.rb

@@ -3,12 +3,11 @@ require 'logger'
 module Ridley
   module Logging
     class << self
+
       # @return [Logger]
       def logger
         @logger ||= begin
-          log = Logger.new(STDOUT)
-          log.level = Logger::WARN
-          log
+          Ridley::Logging::Logger.new
         end
       end
 

data/lib/ridley/version.rb

@@ -1,3 +1,3 @@
 module Ridley
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/spec/unit/ridley/logger_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Ridley::Logging::Logger do
+  subject { described_class.new("/dev/null") }
+  let(:message) { "my message" }
+  let(:filtered_param) { "message" }
+
+  describe "::initialize" do
+    it "defaults to info" do
+      expect(subject.level).to eq(Logger::WARN)
+    end
+  end
+
+  describe "#info" do
+
+    before do
+      subject.level = Logger::INFO
+      subject.filter_param filtered_param
+    end
+
+    it "supports filtering" do
+      expect(subject).to receive(:filter).with("my message").and_return("my FILTERED")
+      subject.info message
+    end
+  end
+
+  describe "#filter_params" do
+    it "returns an array" do
+      expect(subject.filter_params).to be_a(Array)
+    end
+  end
+
+  describe "#filter_param" do
+    let(:param) { "hello" }
+
+    before do
+      subject.clear_filter_params
+    end
+
+    it "adds an element to the array" do
+      subject.filter_param(param)
+      expect(subject.filter_params).to include(param)
+      expect(subject.filter_params.size).to eq(1)
+    end
+
+    context "when the element is already in the array" do
+
+      before do
+        subject.filter_param(param)
+      end
+      it "does not duplicate the element" do
+        subject.filter_param(param)
+        expect(subject.filter_params.size).to eq(1)
+      end
+    end
+  end
+
+  describe "#filter" do
+
+    before do
+      subject.filter_param(filtered_param)
+    end
+
+    it "replaces entries in filter_params" do
+      expect(subject.filter(message)).to eq("my FILTERED")
+    end
+
+    context "when there are multiple filter_params" do
+      before do
+        subject.filter_param("fake param")
+        subject.filter_param(filtered_param) 
+      end
+
+      it "replaces only matching filter_params" do
+        expect(subject.filter(message)).to eq("my FILTERED")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridley
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jamie Winsor
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -295,6 +295,7 @@ files:
 - lib/ridley/command_context/windows_uninstall.rb
 - lib/ridley/connection.rb
 - lib/ridley/errors.rb
+- lib/ridley/logger.rb
 - lib/ridley/logging.rb
 - lib/ridley/middleware.rb
 - lib/ridley/middleware/chef_auth.rb
@@ -378,6 +379,7 @@ files:
 - spec/unit/ridley/client_spec.rb
 - spec/unit/ridley/connection_spec.rb
 - spec/unit/ridley/errors_spec.rb
+- spec/unit/ridley/logger_spec.rb
 - spec/unit/ridley/middleware/chef_auth_spec.rb
 - spec/unit/ridley/middleware/chef_response_spec.rb
 - spec/unit/ridley/middleware/gzip_spec.rb
@@ -474,6 +476,7 @@ test_files:
 - spec/unit/ridley/client_spec.rb
 - spec/unit/ridley/connection_spec.rb
 - spec/unit/ridley/errors_spec.rb
+- spec/unit/ridley/logger_spec.rb
 - spec/unit/ridley/middleware/chef_auth_spec.rb
 - spec/unit/ridley/middleware/chef_response_spec.rb
 - spec/unit/ridley/middleware/gzip_spec.rb