init.rb lib/hoptoad/catcher.rb @@ -1,3 +1,5 @@ +require 'net/http' + module Hoptoad class Connection attr_reader :logger @@ -19,7 +21,7 @@ module Hoptoad } http.read_timeout = 5 # seconds http.open_timeout = 2 # seconds - # http.use_ssl = HoptoadNotifier.secure + # http.use_ssl = Hoptoad.secure response = begin http.post(@service_uri.path, stringify_keys(data).to_yaml, headers) rescue TimeoutError => e lib/hoptoad/connection.rb @@ -9,12 +9,12 @@ module Hoptoad # :error_message (string) # :backtrace (array) def initialize(params={}) - @params = default_params.merge(params) + @params = default_params.merge(params.delete_if { |k,v| v.nil? }) end def default_params { - :api_key => HoptoadNotifier.api_key, + :api_key => Hoptoad.api_key, :request => {}, :session => {}, :environment => {}, @@ -25,7 +25,7 @@ module Hoptoad def environment_data environment_data = @params[:environment] - if @params[:request].is_a?(ActionController::CgiRequest) + if @params[:request].respond_to?(:env) environment_data.merge!(@params[:request].env.to_hash) end environment_data @@ -64,7 +64,7 @@ module Hoptoad class << self - def build(hash_or_exception, request = nil, session = nil, environment = {}) + def build(hash_or_exception, request = {}, session = {}, environment = {}) error_message = "#{hash_or_exception.class.name}: #{hash_or_exception.message}" new( :error_class => hash_or_exception.class.name, @@ -90,7 +90,7 @@ module Hoptoad end backtrace.to_a.map do |line| - HoptoadNotifier.backtrace_filters.inject(line) do |line, proc| + Hoptoad.backtrace_filters.inject(line) do |line, proc| proc.call(line) end end @@ -98,7 +98,7 @@ module Hoptoad def filtered_parameters(parameters) parameters.each do |k, v| - parameters[k] = "<filtered>" if HoptoadNotifier.params_filters.any? do |filter| + parameters[k] = "<filtered>" if Hoptoad.params_filters.any? do |filter| k.to_s.match(/#{filter}/) end end lib/hoptoad/notice.rb @@ -1,3 +1,6 @@ +require 'hoptoad/connection' +require 'hoptoad/notice' + module Hoptoad class Notifier def initialize(connection) lib/hoptoad/notifier.rb @@ -1,4 +1,2 @@ require File.join(File.dirname(__FILE__), *%w[.. hoptoad_notifier]) -require File.join(File.dirname(__FILE__), *%w[connection]) -require File.join(File.dirname(__FILE__), *%w[notice]) require File.join(File.dirname(__FILE__), *%w[notifier]) lib/hoptoad/standalone.rb @@ -1,12 +1,6 @@ -$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'hoptoad')) -require 'net/http' -require 'connection' -require 'notice' -require 'notifier' - -# Plugin for applications to automatically post errors to the Hoptoad of their choice. -module HoptoadNotifier +require 'hoptoad/catcher' +module Hoptoad IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError', 'ActionController::InvalidAuthenticityToken', @@ -40,7 +34,7 @@ module HoptoadNotifier # Returns the list of errors that are being ignored. The array can be appended to. def ignore - @ignore ||= (HoptoadNotifier::IGNORE_DEFAULT.dup) + @ignore ||= (Hoptoad::IGNORE_DEFAULT.dup) @ignore.flatten! @ignore end @@ -111,64 +105,11 @@ module HoptoadNotifier end end - # Include this module in Controllers in which you want to be notified of errors. - module Catcher - - def self.included(base) #:nodoc: - if base.instance_methods.include? 'rescue_action_in_public' and !base.instance_methods.include? 'rescue_action_in_public_without_hoptoad' - base.alias_method_chain :rescue_action_in_public, :hoptoad - end - end - - # Overrides the rescue_action method in ActionController::Base, but does not inhibit - # any custom processing that is defined with Rails 2's exception helpers. - def rescue_action_in_public_with_hoptoad(exception) - notify_hoptoad(exception) unless ignore?(exception) - rescue_action_in_public_without_hoptoad(exception) - end - - # This method should be used for sending manual notifications while you are still - # inside the controller. Otherwise it works like HoptoadNotifier.notify. - def notify_hoptoad(hash_or_exception) - if public_environment? - hoptoad_notifier.notify(hash_or_exception, rails_request, rails_session, ENV.to_hash) - end - end - alias_method :inform_hoptoad, :notify_hoptoad - - def hoptoad_notifier - @hoptoad_notifier ||= Hoptoad::Notifier.new(hoptoad_connection) - end - - def hoptoad_connection - Hoptoad::Connection.from_config(HoptoadNotifier) - end - - def rails_request - respond_to?(:request) ? request : nil - end - - def rails_session - respond_to?(:session) ? session : nil - end - - private - - def public_environment? #nodoc: - defined?(RAILS_ENV) and !['development', 'test'].include?(RAILS_ENV) - end - - def ignore?(exception) #:nodoc: - ignore_these = HoptoadNotifier.ignore.flatten - ignore_these.include?(exception.class) || ignore_these.include?(exception.class.name) - end - end - # A dummy class for sending notifications manually outside of a controller. class Sender def rescue_action_in_public(exception) end - include HoptoadNotifier::Catcher + include Hoptoad::Catcher end end lib/hoptoad_notifier.rb @@ -6,8 +6,8 @@ class HoptoadConnectionFunctionalTest < Test::Unit::TestCase context "Sending data over the connection" do setup do @logger = stub_everything('Logger') - HoptoadNotifier.stubs(:logger).returns(@logger) - @connection = Hoptoad::Connection.from_config(HoptoadNotifier) + Hoptoad.stubs(:logger).returns(@logger) + @connection = Hoptoad::Connection.from_config(Hoptoad) end should "POST the data as YAML to Hoptoad's server" do test/hoptoad_connection_test.rb @@ -11,7 +11,7 @@ end class HoptoadNoticeFunctionalTest < Test::Unit::TestCase def setup - HoptoadNotifier.stubs(:api_key).returns("000011110000") + Hoptoad.stubs(:api_key).returns("000011110000") end def test_notice_with_all_available_data_returns_the_correct_payload @@ -81,7 +81,7 @@ class HoptoadNoticeFunctionalTest < Test::Unit::TestCase end def test_notice_should_censor_any_filtered_parameters_that_have_been_configured - HoptoadNotifier.params_filters << "top_secret_parameter" + Hoptoad.params_filters << "top_secret_parameter" request = ActionController::TestRequest.new({ 'action' => 'my_action', @@ -96,7 +96,7 @@ class HoptoadNoticeFunctionalTest < Test::Unit::TestCase end def test_should_pass_backtrace_through_any_configured_filters - HoptoadNotifier.filter_backtrace do |line| + Hoptoad.filter_backtrace do |line| line.gsub("/my/private/server/folder", "[PRIVATE_FOLDER]") end test/hoptoad_notice_test.rb @@ -33,7 +33,7 @@ class HoptoadController < ActionController::Base end end -class HoptoadNotifierTest < Test::Unit::TestCase +class HoptoadTest < Test::Unit::TestCase def request(action = nil, method = :get) @request = ActionController::TestRequest.new({ "controller" => "hoptoad", @@ -48,7 +48,7 @@ class HoptoadNotifierTest < Test::Unit::TestCase should "be able to occur even outside Rails controllers" do assert_nothing_raised do class MyHoptoad - include HoptoadNotifier::Catcher + include Hoptoad::Catcher end end my = MyHoptoad.new @@ -56,11 +56,11 @@ class HoptoadNotifierTest < Test::Unit::TestCase end end - context "HoptoadNotifier configuration" do + context "Hoptoad configuration" do setup do @controller = HoptoadController.new class ::HoptoadController - include HoptoadNotifier::Catcher + include Hoptoad::Catcher def rescue_action e rescue_action_in_public e end @@ -69,7 +69,7 @@ class HoptoadNotifierTest < Test::Unit::TestCase end should "be done with a block" do - HoptoadNotifier.configure do |config| + Hoptoad.configure do |config| config.host = "host" config.port = 3333 config.secure = true @@ -77,21 +77,21 @@ class HoptoadNotifierTest < Test::Unit::TestCase config.ignore << [ RuntimeError ] end - assert_equal "host", HoptoadNotifier.host - assert_equal 3333, HoptoadNotifier.port - assert_equal true, HoptoadNotifier.secure - assert_equal "1234567890abcdef", HoptoadNotifier.api_key - assert_equal (HoptoadNotifier::IGNORE_DEFAULT + [RuntimeError]), HoptoadNotifier.ignore + assert_equal "host", Hoptoad.host + assert_equal 3333, Hoptoad.port + assert_equal true, Hoptoad.secure + assert_equal "1234567890abcdef", Hoptoad.api_key + assert_equal (Hoptoad::IGNORE_DEFAULT + [RuntimeError]), Hoptoad.ignore end should "set a default host" do - HoptoadNotifier.instance_variable_set("@host",nil) - assert_equal "hoptoadapp.com", HoptoadNotifier.host + Hoptoad.instance_variable_set("@host",nil) + assert_equal "hoptoadapp.com", Hoptoad.host end should "add filters to the backtrace_filters" do - assert_difference "HoptoadNotifier.backtrace_filters.length" do - HoptoadNotifier.configure do |config| + assert_difference "Hoptoad.backtrace_filters.length" do + Hoptoad.configure do |config| config.filter_backtrace do |line| line = "1234" end @@ -100,19 +100,19 @@ class HoptoadNotifierTest < Test::Unit::TestCase end should "add filters to the params filters" do - assert_difference "HoptoadNotifier.params_filters.length", 2 do - HoptoadNotifier.configure do |config| + assert_difference "Hoptoad.params_filters.length", 2 do + Hoptoad.configure do |config| config.params_filters << "abc" config.params_filters << "def" end end - assert HoptoadNotifier.params_filters.include?( "abc" ) - assert HoptoadNotifier.params_filters.include?( "def" ) + assert Hoptoad.params_filters.include?( "abc" ) + assert Hoptoad.params_filters.include?( "def" ) end should "have at default ignored exceptions" do - assert HoptoadNotifier::IGNORE_DEFAULT.any? + assert Hoptoad::IGNORE_DEFAULT.any? end end @@ -143,12 +143,12 @@ class HoptoadNotifierTest < Test::Unit::TestCase context "with the notifier installed" do setup do class ::HoptoadController - include HoptoadNotifier::Catcher + include Hoptoad::Catcher def rescue_action e rescue_action_in_public e end end - HoptoadNotifier.ignore_only = HoptoadNotifier::IGNORE_DEFAULT + Hoptoad.ignore_only = Hoptoad::IGNORE_DEFAULT @controller.stubs(:public_environment?).returns(true) @connection = mock('Connection') Hoptoad::Connection.stubs(:new).returns(@connection) @@ -218,7 +218,7 @@ class HoptoadNotifierTest < Test::Unit::TestCase context "and configured to ignore additional exceptions" do setup do - HoptoadNotifier.ignore << ActiveRecord::StatementInvalid + Hoptoad.ignore << ActiveRecord::StatementInvalid end should "still ignore default exceptions" do @@ -248,7 +248,7 @@ class HoptoadNotifierTest < Test::Unit::TestCase context "and configured to ignore only certain exceptions" do setup do - HoptoadNotifier.ignore_only = [ActiveRecord::StatementInvalid] + Hoptoad.ignore_only = [ActiveRecord::StatementInvalid] end should "no longer ignore default exceptions" do @@ -281,7 +281,7 @@ class HoptoadNotifierTest < Test::Unit::TestCase context "Sending a notice" do context "with an exception" do setup do - @sender = HoptoadNotifier::Sender.new + @sender = Hoptoad::Sender.new @backtrace = caller @exception = begin raise @@ -290,29 +290,29 @@ class HoptoadNotifierTest < Test::Unit::TestCase end @options = {:error_message => "123", :backtrace => @backtrace} - HoptoadNotifier.instance_variable_set("@backtrace_filters", []) - HoptoadNotifier::Sender.expects(:new).returns(@sender) + Hoptoad.instance_variable_set("@backtrace_filters", []) + Hoptoad::Sender.expects(:new).returns(@sender) @sender.stubs(:public_environment?).returns(true) end should "send as if it were a normally caught exception" do @sender.expects(:notify_hoptoad).with(@exception) - HoptoadNotifier.notify(@exception) + Hoptoad.notify(@exception) end end context "without an exception" do setup do - @sender = HoptoadNotifier::Sender.new + @sender = Hoptoad::Sender.new @backtrace = caller @options = {:error_message => "123", :backtrace => @backtrace} - HoptoadNotifier::Sender.expects(:new).returns(@sender) + Hoptoad::Sender.expects(:new).returns(@sender) end should "send sensible defaults" do @sender.expects(:notify_hoptoad).with(@options) - HoptoadNotifier.notify(:error_message => "123", :backtrace => @backtrace) + Hoptoad.notify(:error_message => "123", :backtrace => @backtrace) end end test/hoptoad_notifier_test.rb d0692cfdd60ae2b3135122059a64a9e36b2f1a36 Luke Redpath contact@lukeredpath.co.uk http://github.com/lukeredpath/hoptoad_notifier/commit/c25d170a51820c65451fdcae64b38b59deaeb46f c25d170a51820c65451fdcae64b38b59deaeb46f 2008-08-15T07:13:29-07:00 2008-08-15T07:13:29-07:00 Having Hoptoad::Notifier and HoptoadNotifier is confusing; the base module can just be called Hoptoad. Also found a bug in Hoptoad::Notice where it would fail if it was passed nil for request/session 8ea02fa5ff903136fa731a7a45396fd70f83a0a1 Luke Redpath contact@lukeredpath.co.uk