vendor/plugins/hoptoad_notifier/lib/hoptoad_tasks.rb vendor/plugins/hoptoad_notifier/recipes/hoptoad.rb vendor/plugins/hoptoad_notifier/test/hoptoad_tasks_test.rb vendor/plugins/hoptoad_notifier/vendor/ginger/.gitignore vendor/plugins/hoptoad_notifier/vendor/ginger/LICENCE vendor/plugins/hoptoad_notifier/vendor/ginger/README.textile vendor/plugins/hoptoad_notifier/vendor/ginger/Rakefile vendor/plugins/hoptoad_notifier/vendor/ginger/bin/ginger vendor/plugins/hoptoad_notifier/vendor/ginger/ginger.gemspec vendor/plugins/hoptoad_notifier/vendor/ginger/lib/ginger.rb vendor/plugins/hoptoad_notifier/vendor/ginger/lib/ginger/configuration.rb vendor/plugins/hoptoad_notifier/vendor/ginger/lib/ginger/kernel.rb vendor/plugins/hoptoad_notifier/vendor/ginger/lib/ginger/scenario.rb vendor/plugins/hoptoad_notifier/vendor/ginger/spec/ginger/configuration_spec.rb vendor/plugins/hoptoad_notifier/vendor/ginger/spec/ginger/kernel_spec.rb vendor/plugins/hoptoad_notifier/vendor/ginger/spec/ginger/scenario_spec.rb vendor/plugins/hoptoad_notifier/vendor/ginger/spec/ginger_spec.rb vendor/plugins/hoptoad_notifier/vendor/ginger/spec/spec_helper.rb @@ -74,6 +74,20 @@ controller, you can do something like this: The #notify_hoptoad call will send the notice over to hoptoad for later analysis. +TRACKING DEPLOYMENTS IN HOPTOAD + +Paying Hoptoad plans support the ability to track deployments of your application in Hoptoad. +By notify Hoptoad of your application deployments, all errors are resolved when a deploy occurs, +so that you'll be notified again about any errors that reoccur after a deployment. + +Additionally, it's possible to review the errors in Hoptoad that occurred before and after a deploy. + +When Hoptoad is installed as a plugin this functionality is loaded automatically (if you have Capistrano version 2.0.0 or greater). + +When Hoptoad installed as a gem, you need to add + require 'hoptoad_notifier/recipes/hoptoad' +to your deploy.rb + GOING BEYOND EXCEPTIONS You can also pass a hash to notify_hoptoad method and store whatever you want, not just an exception. And you can also use it anywhere, not just in controllers: vendor/plugins/hoptoad_notifier/README @@ -20,3 +20,11 @@ Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_files.include('README') rdoc.rdoc_files.include('lib/**/*.rb') end + +desc 'Run ginger tests' +task :ginger do + $LOAD_PATH << File.join(*%w[vendor ginger lib]) + ARGV.clear + ARGV << 'test' + load File.join(*%w[vendor ginger bin ginger]) +end vendor/plugins/hoptoad_notifier/Rakefile @@ -237,7 +237,9 @@ module HoptoadNotifier if self.respond_to? :session data[:session] = { :key => session.instance_variable_get("@session_id"), - :data => session.instance_variable_get("@data") + :data => session.respond_to?(:to_hash) ? + session.to_hash : + session.instance_variable_get("@data") } end @@ -337,7 +339,11 @@ module HoptoadNotifier end def serializable?(value) #:nodoc: - !(value.is_a?(Module) || value.kind_of?(IO)) + value.is_a?(Fixnum) || + value.is_a?(Array) || + value.is_a?(String) || + value.is_a?(Hash) || + value.is_a?(Bignum) end def stringify_keys(hash) #:nodoc: @@ -357,3 +363,4 @@ module HoptoadNotifier include HoptoadNotifier::Catcher end end + vendor/plugins/hoptoad_notifier/lib/hoptoad_notifier.rb @@ -1,4 +1,13 @@ namespace :hoptoad do + desc "Notify Hoptoad of a new deploy." + task :deploy => :environment do + require 'hoptoad_tasks' + HoptoadTasks.deploy(:rails_env => ENV['TO'], + :scm_revision => ENV['REVISION'], + :scm_repository => ENV['REPO'], + :local_username => ENV['USER']) + end + desc "Verify your plugin installation by sending a test exception to the hoptoad service" task :test => :environment do require 'action_controller/test_process' vendor/plugins/hoptoad_notifier/tasks/hoptoad_notifier_tasks.rake @@ -40,8 +40,10 @@ class ConfigurationTest < ActiveSupport::TestCase assert_equal 'secret', HoptoadNotifier.proxy_pass assert_equal 2, HoptoadNotifier.http_open_timeout assert_equal 5, HoptoadNotifier.http_read_timeout - assert_equal (HoptoadNotifier::IGNORE_USER_AGENT_DEFAULT + ['UserAgentString', /UserAgentRegexp/]), HoptoadNotifier.ignore_user_agent - assert_equal (HoptoadNotifier::IGNORE_DEFAULT + [RuntimeError]), HoptoadNotifier.ignore + assert_equal HoptoadNotifier::IGNORE_USER_AGENT_DEFAULT + ['UserAgentString', /UserAgentRegexp/], + HoptoadNotifier.ignore_user_agent + assert_equal HoptoadNotifier::IGNORE_DEFAULT + [RuntimeError], + HoptoadNotifier.ignore end should "set a default host" do @@ -49,15 +51,35 @@ class ConfigurationTest < ActiveSupport::TestCase assert_equal "hoptoadapp.com", HoptoadNotifier.host end + [File.open(__FILE__), Proc.new { puts "boo!" }, Module.new].each do |object| + should "remove #{object.class} when cleaning environment" do + HoptoadNotifier.configure {} + notice = @controller.send(:normalize_notice, {}) + notice[:environment][:strange_object] = object + + assert_nil @controller.send(:clean_non_serializable_data, notice)[:environment][:strange_object] + end + end + + [123, "string", 123_456_789_123_456_789, [:a, :b], {:a => 1}, HashWithIndifferentAccess.new].each do |object| + should "not remove #{object.class} when cleaning environment" do + HoptoadNotifier.configure {} + notice = @controller.send(:normalize_notice, {}) + notice[:environment][:strange_object] = object + + assert_equal object, @controller.send(:clean_non_serializable_data, notice)[:environment][:strange_object] + end + end + should "remove notifier trace when cleaning backtrace" do HoptoadNotifier.configure {} - options = HoptoadNotifier.default_notice_options + notice = @controller.send(:normalize_notice, {}) - options = @controller.send(:normalize_notice, {}) - dirty_backtrace = @controller.send(:clean_hoptoad_backtrace, options[:backtrace]) + assert notice[:backtrace].grep(%r{lib/hoptoad_notifier.rb}).any?, notice[:backtrace].inspect + dirty_backtrace = @controller.send(:clean_hoptoad_backtrace, notice[:backtrace]) dirty_backtrace.each do |line| - assert_no_match /lib\/hoptoad_notifier.rb/, line + assert_no_match %r{lib/hoptoad_notifier.rb}, line end end vendor/plugins/hoptoad_notifier/test/configuration_test.rb @@ -1,5 +1,23 @@ require File.dirname(__FILE__) + '/helper' +def expect_session_data_for(controller) + # NOTE: setting expectations on the controller is not a good idea here, + # because the controller is the unit we're trying to test. However, as all + # exception-related behavior is mixed into the controller itsef, we have + # little choice. Delegating notifier methods from the controller to a + # Sender could make this easier to maintain and test. + + @controller.expects(:send_to_hoptoad).with do |params| + assert params.respond_to?(:to_hash), "The notifier needs a hash" + notice = params[:notice] + assert_not_nil notice, "No notice passed to the notifier" + assert_not_nil notice[:session][:key], "No session key was set" + assert_not_nil notice[:session][:data], "No session data was set" + true + end + @controller.stubs(:rescue_action_in_public_without_hoptoad) +end + def should_notify_normally should "have inserted its methods into the controller" do assert @controller.methods.include?("inform_hoptoad") @@ -79,6 +97,24 @@ def should_notify_normally assert_equal(:serializable_data, @controller.send(:clean_notice, raw_notice)) end + + should "send session data to hoptoad when the session has @data" do + expect_session_data_for(@controller) + @request = ActionController::TestRequest.new + @request.action = 'do_raise' + @request.session.instance_variable_set("@data", { :message => 'Hello' }) + @response = ActionController::TestResponse.new + @controller.process(@request, @response) + end + + should "send session data to hoptoad when the session responds to to_hash" do + expect_session_data_for(@controller) + @request = ActionController::TestRequest.new + @request.action = 'do_raise' + @request.session.stubs(:to_hash).returns(:message => 'Hello') + @response = ActionController::TestResponse.new + @controller.process(@request, @response) + end end def should_auto_include_catcher vendor/plugins/hoptoad_notifier/test/controller_test.rb @@ -3,6 +3,8 @@ require 'rubygems' require 'mocha' gem 'thoughtbot-shoulda', ">= 2.0.0" require 'shoulda' + +$LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. vendor ginger lib]) require 'ginger' require 'action_controller' vendor/plugins/hoptoad_notifier/test/helper.rb e53e0fc40b3ac23ad5e127900961722b94f5bf16 Matt Jankowski mjankowski@thoughtbot.com http://github.com/thoughtbot/suspenders/commit/8ef2a000509219718b6b328ee5a440e727d10864 8ef2a000509219718b6b328ee5a440e727d10864 2009-04-23T06:49:19-07:00 2009-04-23T06:49:10-07:00 update notifier 3b102f400e21cd86694f0f872e83abd23ffe3fdf Matt Jankowski mjankowski@thoughtbot.com