tripwire_notifier 0.2.3 → 0.2.4

data/lib/tripwire_notifier/configuration.rb

@@ -1,18 +1,33 @@
 module TripwireNotifier
   class Configuration
-    attr_reader :notifier_version
     attr_accessor :api_key
+
+    # The set of environments that should be monitored for validation errors (defaults to
+    # only the production environment).
     attr_accessor :monitored_environments
+
+    # Number of seconds after which submission to Tripwire should timeout (defaults to 5).
     attr_accessor :timeout_in_seconds
-    attr_accessor :secure
 
+    # +true+ for https connections, +false+ for http connections.
+    attr_accessor :secure
     alias_method :secure?, :secure
 
+    # A +call+able object, such as a Proc, to be invoked if an exception occurs when
+    # logging to Tripwire (defaults to nil). For example, to notify Hoptoad:
+    #
+    #   config.on_exception = proc { |e| notify_hoptoad(e) }
+    attr_accessor :on_exception
+
+    # The version of the notifier (defaults to the version of this gem).
+    attr_reader :notifier_version
+
     def initialize
       @notifier_version = VERSION
       @timeout_in_seconds = 5
       @monitored_environments = ['production']
       @secure = false
+      @on_exception = nil
     end
   end
 end

data/lib/tripwire_notifier/rails/action_controller_monitor.rb

@@ -13,6 +13,11 @@ module TripwireNotifier
         if should_log_failures_to_tripwire? && records_with_errors.present?
           TripwireNotifier.notify(tripwire_params)
         end
+      rescue Exception => e
+        ::Rails.logger.error("Failed to log validation failure to Tripwire")
+
+        handler = TripwireNotifier.configuration.on_exception
+        handler.call(e) if !handler.nil? && handler.respond_to?(:call)
       end
 
       def should_log_failures_to_tripwire?
@@ -81,7 +86,7 @@ module TripwireNotifier
       end
 
       def filtered_params
-        if respond_to?(:filter_parameters)
+        p = if respond_to?(:filter_parameters)
           # pre-Rails 3
           filter_parameters(params)
         elsif request.respond_to?(:filtered_parameters)
@@ -90,6 +95,17 @@ module TripwireNotifier
         else
           params
         end
+        filter_files_from_params(p)
+      end
+
+      def filter_files_from_params(params)
+        params.each do |k,v|
+          if v.is_a?(Hash)
+            filter_files_from_params(v)
+          elsif v.is_a?(Tempfile)
+            params[k] = '[FILTERED]'
+          end
+        end
       end
     end
   end

data/lib/tripwire_notifier/version.rb

@@ -1,3 +1,3 @@
 module TripwireNotifier
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/test/helper.rb

@@ -6,6 +6,7 @@ require 'shoulda'
 require 'action_controller'
 require 'fakeweb'
 require 'mocha'
+require 'tempfile'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/tripwire_test.rb

@@ -106,11 +106,41 @@ class TestTripwire < Test::Unit::TestCase
     assert_equal @foo_controller.params.merge('password' => "[FILTERED]", 'password_confirmation' => '[FILTERED]'), JSON.parse(@foo_controller.send(:tripwire_params)[:data])['params']
   end
 
+  should "filter tempfiles" do
+    Tempfile.open('foo') do |tempfile|
+      tempfile.write('test data')
+      tempfile.rewind
+
+      @foo_controller.params.merge!('value' => 'abc', 'photo' => tempfile, 'nested' => { 'nested_value' => 1, 'nested_photo' => tempfile })
+      params = JSON.parse(@foo_controller.send(:tripwire_params)[:data])['params']
+      assert_equal @foo_controller.params.merge('value' => 'abc', 'photo' => '[FILTERED]', 'nested' => { 'nested_value' => 1, 'nested_photo' => '[FILTERED]' }), params
+    end
+  end
+
   should "log current user's id if the method is exposed" do
     assert_equal nil, JSON.parse(@foo_controller.send(:tripwire_params)[:data])['current_user']
     assert_equal 53077, JSON.parse(fake_controller(BarController).send(:tripwire_params)[:data])['current_user']
   end
 
+  should "handle exceptions" do
+    logger = mock()
+    logger.expects(:error)
+    Rails.stubs(:logger => logger)
+
+    @foo_controller.stubs(:tripwire_params).raises(StandardError)
+    @foo_controller.send(:log_validation_failures_to_tripwire)
+
+    # with a custom exception handler
+    list = []
+    TripwireNotifier.configure { |c| c.on_exception = proc { |e| list << e } }
+
+    logger.expects(:error)
+    @foo_controller.send(:log_validation_failures_to_tripwire)
+
+    assert_equal 1, list.size
+    assert_kind_of StandardError, list.first
+  end
+
   [:cookies, :session, :user_agent].each do |kind|
     should "log #{kind}" do
       assert @foo_controller.request.send(kind).present?

data/tripwire_notifier.gemspec

@@ -1,46 +1,44 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{tripwire_notifier}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeffrey Chupp", "Jeremy Weiskotten"]
-  s.date = %q{2010-11-12}
+  s.date = %q{2011-02-23}
   s.description = %q{Tripwire captures validation errors from your Ruby on Rails application to help you identify and fix user experience issues. The TripwireNotifier gem makes it easy to hook up your app to the Tripwire web service.}
   s.email = %q{support@tripwireapp.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "lib/tripwire_notifier.rb",
-     "lib/tripwire_notifier/configuration.rb",
-     "lib/tripwire_notifier/rails/action_controller_monitor.rb",
-     "lib/tripwire_notifier/sender.rb",
-     "lib/tripwire_notifier/version.rb",
-     "test/helper.rb",
-     "test/sender_test.rb",
-     "test/tripwire_test.rb",
-     "tripwire_notifier.gemspec"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "lib/tripwire_notifier.rb",
+    "lib/tripwire_notifier/configuration.rb",
+    "lib/tripwire_notifier/rails/action_controller_monitor.rb",
+    "lib/tripwire_notifier/sender.rb",
+    "lib/tripwire_notifier/version.rb",
+    "test/helper.rb",
+    "test/sender_test.rb",
+    "test/tripwire_test.rb",
+    "tripwire_notifier.gemspec"
   ]
   s.homepage = %q{http://github.com/jeremyw/tripwire_notifier}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Tripwire (http://tripwireapp.com) captures validation errors from your Ruby on Rails application.}
   s.test_files = [
     "test/helper.rb",
-     "test/sender_test.rb",
-     "test/tripwire_test.rb"
+    "test/sender_test.rb",
+    "test/tripwire_test.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tripwire_notifier
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Jeffrey Chupp
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 -05:00
+date: 2011-02-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,7 +44,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -62,8 +61,8 @@ homepage: http://github.com/jeremyw/tripwire_notifier
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC