exception_details 0.0.4 → 0.1.0

data/README.md

@@ -14,9 +14,9 @@ Features/benefits:
 
 	* A single method for a loggable string (avoid repeating exception log string creation)
 
-	* Get Pry like debug knowledge from cron job errors and running systems from the log, without being there.
+	* Log Pry-like debug info from cron errors and running systems without being there.
 
-	* Pry type information with less overhead/dependencies--binding_of_caller is the only dependency.
+	* Debug information with less overhead/dependencies--binding_of_caller is the only dependency.
 
 
 ## Example Usage
@@ -30,7 +30,6 @@ Features/benefits:
 		puts e.inspect_variables
 	end
 
-
 	e.details ->
 
 		Exception:
@@ -56,6 +55,14 @@ Or access the variables in the binding yourself...
 
 	e.binding_during_exception.eval("puts #{greeting}")
 
+## Filtering
+
+If you need to hide certain variable values, such as passwords, private keys,
+etc., you can configure an array of variable names to be filtered. Symbols
+or strings may be used. The filter settings are global across all exceptions.
+
+	Exception.filter_variables = [:password, :username, :enjoys_php]
+
 ## Installation
 
 Add to your Gemfile:
@@ -71,7 +78,7 @@ Require it:
 	require 'exception_details'
 
 ## Limitations
-- This gem requires [binding\_of\_caller]:https://github.com/banister/binding_of_caller, so it should only work with MRI 1.9.2, 1.9.3, 2.0
+- This gem requires [binding\_of\_caller](https://github.com/banister/binding_of_caller), so it should only work with MRI 1.9.2, 1.9.3, 2.0
 and RBX (Rubinius). Does not work in 1.8.7, but there is a well known (continuation-based)
 hack to get a Binding#of_caller there. There is some mention about binding of caller supporting
 jruby, so feel free to try it out.
@@ -80,7 +87,7 @@ jruby, so feel free to try it out.
 
 - This gem is still new...
 
-- binding of caller is experiencing some segfault issues on some rubies, so this is not
+- binding_of_caller is experiencing some segfault issues on some rubies, so this is not
   ideal for a production stack...  Shame, as how awesome would using this in production be?
 
 ## Contributing

data/lib/exception_details/exception.rb

@@ -5,6 +5,26 @@ class Exception
 	include ExceptionDetails::InspectVariables
 	include ExceptionDetails::LogColorHelpers
 
+
+	 @@filter_variables = []
+
+	 # Configure an array of variable names to obscure during variable inspection.
+	 # variables may be either symbols, or strings.
+	 # This provides a way to make sure your logs don't have usernames,
+	 # passwords, or private keys. Also, beware of hashes containing
+	 # keys you want obscured.
+
+	 # Filtered items will show up with variable values like '**FILTERED**'
+
+	 def self.filter_variables=(variable_names_to_filter)
+	 	variable_names_to_filter = variable_names_to_filter.map {|v| v.to_s}
+	 	@@filter_variables = variable_names_to_filter
+	 end
+
+	 def self.filter_variables
+	 	@@filter_variables
+	 end
+
 	# binding_during_exception lets you actually directly access
 	# the exception-time binding.
 	attr_accessor :binding_during_exception

data/lib/exception_details/inspect_variables.rb

@@ -19,7 +19,11 @@ module ExceptionDetails
 				variable_names = target_binding.eval(variable_scope.to_s)
 				variable_names.each do |vname|
 					value = target_binding.eval(vname.to_s)
-					variable_value_string = "\t" + sprintf("%-35s = %s", "<#{value.class}> #{vname}", value.inspect)
+					if self.class.filter_variables.include?(vname.to_s)
+						value = '**FILTERED**'
+					end
+						variable_value_string = "\t" + sprintf("%-35s = %s", "<#{value.class}> #{vname}", value.inspect)
+
 					unless value == self # don't list the exception itself ...
 						variable_strings << variable_value_string
 					end

data/lib/exception_details/version.rb

@@ -1,3 +1,3 @@
 module ExceptionDetails
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/exception_details_spec.rb

@@ -106,4 +106,52 @@ describe "ExceptionDetails" do
 
   end
 
+  context "variable value filtering" do
+    before :each do
+      Exception.filter_variables = [:hideme]
+    end
+
+    it "should let you configure filter variables on the Exception class" do
+      Exception.respond_to?(:filter_variables).should be_true
+      StandardError.respond_to?(:filter_variables).should be_true
+   end
+
+    it "should convert filter_variable names to strings on assignment" do
+      Exception.filter_variables = [:foo]
+      Exception.filter_variables.should == ['foo']
+    end
+
+    it "should share all assigned filtering across all exception classes" do
+      Exception.filter_variables = [:hello]
+      (Exception.filter_variables == ['hello']).should be_true
+      (Exception.filter_variables == StandardError.filter_variables).should be_true
+    end
+
+    it "should filter selected variable values" do
+      hideme = 'shouldntseeme'
+      showme = 'shouldseeme'
+      begin
+        raise "hell"
+      rescue Exception => e
+        #variable name still shows up
+        e.inspect_variables.include?('hideme').should be_true
+
+        # but not the value
+        e.inspect_variables.include?('shouldntseeme').should be_false
+        e.inspect_variables.include?('**FILTERED**').should be_true
+      end
+    end
+
+    it "should not filter other variables" do
+      hideme = 'shouldntseeme'
+      showme = 'shouldseeme'
+      begin
+        raise "hell"
+      rescue Exception => e
+        e.inspect_variables.include?('shouldseeme').should be_true
+      end
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_details
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler