diff options
Diffstat (limited to 'vendor/plugins/exception_notification')
17 files changed, 0 insertions, 516 deletions
diff --git a/vendor/plugins/exception_notification/README b/vendor/plugins/exception_notification/README deleted file mode 100644 index d5e343630..000000000 --- a/vendor/plugins/exception_notification/README +++ /dev/null @@ -1,144 +0,0 @@ -= Exception Notifier Plugin for Rails - -The Exception Notifier plugin provides a mailer object and a default set of -templates for sending email notifications when errors occur in a Rails -application. The plugin is configurable, allowing programmers to specify: - -* the sender address of the email -* the recipient addresses -* the text used to prefix the subject line - -The email includes information about the current request, session, and -environment, and also gives a backtrace of the exception. - -== Usage - -First, include the ExceptionNotifiable mixin in whichever controller you want -to generate error emails (typically ApplicationController): - - class ApplicationController < ActionController::Base - include ExceptionNotification::Notifiable - ... - end - -Then, specify the email recipients in your environment: - - ExceptionNotification::Notifier.exception_recipients = %w(joe@schmoe.com bill@schmoe.com) - -And that's it! The defaults take care of the rest. - -== Configuration - -You can tweak other values to your liking, as well. In your environment file, -just set any or all of the following values: - - # defaults to exception.notifier@default.com - ExceptionNotification::Notifier.sender_address = - %("Application Error" <app.error@myapp.com>) - - # defaults to "[ERROR] " - ExceptionNotification::Notifier.email_prefix = "[APP] " - -Even if you have mixed into ApplicationController you can skip notification in -some controllers by - - class MyController < ApplicationController - skip_exception_notifications - end - -== Deprecated local_request? overriding - -Email notifications will only occur when the IP address is determined not to -be local. You can specify certain addresses to always be local so that you'll -get a detailed error instead of the generic error page. You do this in your -controller (or even per-controller): - - consider_local "64.72.18.143", "14.17.21.25" - -You can specify subnet masks as well, so that all matching addresses are -considered local: - - consider_local "64.72.18.143/24" - -The address "127.0.0.1" is always considered local. If you want to completely -reset the list of all addresses (for instance, if you wanted "127.0.0.1" to -NOT be considered local), you can simply do, somewhere in your controller: - - local_addresses.clear - -NOTE: The above functionality has has been pulled out to consider_local.rb, -as interfering with rails local determination is orthogonal to notification, -unnecessarily clutters backtraces, and even occasionally errs on odd ip or -requests bugs. To return original functionality add an initializer with: - - ActionController::Base.send :include, ConsiderLocal - -or just include it per controller that wants it - - class MyController < ApplicationController - include ExceptionNotification::ConsiderLocal - end - -== Customization - -By default, the notification email includes four parts: request, session, -environment, and backtrace (in that order). You can customize how each of those -sections are rendered by placing a partial named for that part in your -app/views/exception_notifier directory (e.g., _session.rhtml). Each partial has -access to the following variables: - -* @controller: the controller that caused the error -* @request: the current request object -* @exception: the exception that was raised -* @host: the name of the host that made the request -* @backtrace: a sanitized version of the exception's backtrace -* @rails_root: a sanitized version of RAILS_ROOT -* @data: a hash of optional data values that were passed to the notifier -* @sections: the array of sections to include in the email - -You can reorder the sections, or exclude sections completely, by altering the -ExceptionNotification::Notifier.sections variable. You can even add new sections that -describe application-specific data--just add the section's name to the list -(whereever you'd like), and define the corresponding partial. Then, if your -new section requires information that isn't available by default, make sure -it is made available to the email using the exception_data macro: - - class ApplicationController < ActionController::Base - ... - protected - exception_data :additional_data - - def additional_data - { :document => @document, - :person => @person } - end - ... - end - -In the above case, @document and @person would be made available to the email -renderer, allowing your new section(s) to access and display them. See the -existing sections defined by the plugin for examples of how to write your own. - -== 404s errors - -Notification is skipped if you return a 404 status, which happens by default -for an ActiveRecord::RecordNotFound or ActionController::UnknownAction error. - -== Manually notifying of error in a rescue block - -If your controller action manually handles an error, the notifier will never be -run. To manually notify of an error call notify_about_exception from within the -rescue block - - def index - #risky operation here - rescue StandardError => error - #custom error handling here - notify_about_exception(error) - end - -== Support and tickets - -https://rails.lighthouseapp.com/projects/8995-rails-plugins - -Copyright (c) 2005 Jamis Buck, released under the MIT license
\ No newline at end of file diff --git a/vendor/plugins/exception_notification/exception_notification.gemspec b/vendor/plugins/exception_notification/exception_notification.gemspec deleted file mode 100644 index b3ff82322..000000000 --- a/vendor/plugins/exception_notification/exception_notification.gemspec +++ /dev/null @@ -1,11 +0,0 @@ -Gem::Specification.new do |s| - s.name = 'exception_notification' - s.version = '2.3.3.0' - s.authors = ["Jamis Buck", "Josh Peek", "Tim Connor"] - s.date = %q{2010-03-13} - s.summary = "Exception notification by email for Rails apps - 2.3-stable compatible version" - s.email = "timocratic@gmail.com" - - s.files = ['README'] + Dir['lib/**/*'] + Dir['views/**/*'] - s.require_path = 'lib' -end diff --git a/vendor/plugins/exception_notification/init.rb b/vendor/plugins/exception_notification/init.rb deleted file mode 100644 index ef215f809..000000000 --- a/vendor/plugins/exception_notification/init.rb +++ /dev/null @@ -1 +0,0 @@ -require "exception_notification" diff --git a/vendor/plugins/exception_notification/lib/exception_notification.rb b/vendor/plugins/exception_notification/lib/exception_notification.rb deleted file mode 100644 index bf5975201..000000000 --- a/vendor/plugins/exception_notification/lib/exception_notification.rb +++ /dev/null @@ -1,7 +0,0 @@ -require "action_mailer" -module ExceptionNotification - autoload :Notifiable, 'exception_notification/notifiable' - autoload :Notifier, 'exception_notification/notifier' - #autoload :NotifierHelper, 'exception_notification/notifier_helper' - autoload :ConsiderLocal, 'exception_notification/consider_local' -end
\ No newline at end of file diff --git a/vendor/plugins/exception_notification/lib/exception_notification/consider_local.rb b/vendor/plugins/exception_notification/lib/exception_notification/consider_local.rb deleted file mode 100644 index 6b9e236f7..000000000 --- a/vendor/plugins/exception_notification/lib/exception_notification/consider_local.rb +++ /dev/null @@ -1,31 +0,0 @@ -#This didn't belong on ExceptionNotifier and made backtraces worse. To keep original functionality in place -#'ActionController::Base.send :include, ExceptionNotification::ConsiderLocal' or just include in your controller -module ExceptionNotification::ConsiderLocal - def self.included(target) - require 'ipaddr' - target.extend(ClassMethods) - end - - module ClassMethods - def consider_local(*args) - local_addresses.concat(args.flatten.map { |a| IPAddr.new(a) }) - end - - def local_addresses - addresses = read_inheritable_attribute(:local_addresses) - unless addresses - addresses = [IPAddr.new("127.0.0.1")] - write_inheritable_attribute(:local_addresses, addresses) - end - addresses - end - end - -private - - def local_request? - remote = IPAddr.new(request.remote_ip) - !self.class.local_addresses.detect { |addr| addr.include?(remote) }.nil? - end - -end diff --git a/vendor/plugins/exception_notification/lib/exception_notification/notifiable.rb b/vendor/plugins/exception_notification/lib/exception_notification/notifiable.rb deleted file mode 100644 index 19895e8db..000000000 --- a/vendor/plugins/exception_notification/lib/exception_notification/notifiable.rb +++ /dev/null @@ -1,66 +0,0 @@ -# Copyright (c) 2005 Jamis Buck -# -# Permission is hereby granted, free of charge, to any person obtaining -# a copy of this software and associated documentation files (the -# "Software"), to deal in the Software without restriction, including -# without limitation the rights to use, copy, modify, merge, publish, -# distribute, sublicense, and/or sell copies of the Software, and to -# permit persons to whom the Software is furnished to do so, subject to -# the following conditions: -# -# The above copyright notice and this permission notice shall be -# included in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -module ExceptionNotification::Notifiable - def self.included(target) - target.extend(ClassMethods) - target.skip_exception_notifications false - end - - module ClassMethods - def exception_data(deliverer=self) - if deliverer == self - read_inheritable_attribute(:exception_data) - else - write_inheritable_attribute(:exception_data, deliverer) - end - end - - def skip_exception_notifications(boolean=true) - write_inheritable_attribute(:skip_exception_notifications, boolean) - end - - def skip_exception_notifications? - read_inheritable_attribute(:skip_exception_notifications) - end - end - -private - - def rescue_action_in_public(exception) - super - notify_about_exception(exception) if deliver_exception_notification? - end - - def deliver_exception_notification? - !self.class.skip_exception_notifications? && ![404, "404 Not Found"].include?(response.status.to_s) - end - - def notify_about_exception(exception) - deliverer = self.class.exception_data - data = case deliverer - when nil then {} - when Symbol then send(deliverer) - when Proc then deliverer.call(self) - end - - ExceptionNotification::Notifier.deliver_exception_notification(exception, self, request, data) - end -end diff --git a/vendor/plugins/exception_notification/lib/exception_notification/notifier.rb b/vendor/plugins/exception_notification/lib/exception_notification/notifier.rb deleted file mode 100644 index 2cab3f963..000000000 --- a/vendor/plugins/exception_notification/lib/exception_notification/notifier.rb +++ /dev/null @@ -1,80 +0,0 @@ -require 'pathname' - -# Copyright (c) 2005 Jamis Buck -# -# Permission is hereby granted, free of charge, to any person obtaining -# a copy of this software and associated documentation files (the -# "Software"), to deal in the Software without restriction, including -# without limitation the rights to use, copy, modify, merge, publish, -# distribute, sublicense, and/or sell copies of the Software, and to -# permit persons to whom the Software is furnished to do so, subject to -# the following conditions: -# -# The above copyright notice and this permission notice shall be -# included in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -class ExceptionNotification::Notifier < ActionMailer::Base - self.mailer_name = 'exception_notifier' - self.view_paths << "#{File.dirname(__FILE__)}/../../views" - - # next line is a hack to fix - # undefined method `find_template' for #<Array:0x000001009cd230> - # after Rails 2.3.8 -> 2.3.11 upgrade - self.view_paths = ActionView::PathSet.new(self.view_paths) unless self.view_paths.respond_to?(:find_template) - - @@sender_address = %("Exception Notifier" <exception.notifier@default.com>) - cattr_accessor :sender_address - - @@exception_recipients = [] - cattr_accessor :exception_recipients - - @@email_prefix = "[ERROR] " - cattr_accessor :email_prefix - - @@sections = %w(request session environment backtrace) - cattr_accessor :sections - - def self.reloadable?() false end - - def exception_notification(exception, controller, request, data={}) - source = self.class.exception_source(controller) - content_type "text/plain" - - subject "#{email_prefix}#{source} (#{exception.class}) #{exception.message.inspect}" - - recipients exception_recipients - from sender_address - - body data.merge({ :controller => controller, :request => request, - :exception => exception, :exception_source => source, :host => (request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"]), - :backtrace => sanitize_backtrace(exception.backtrace), - :rails_root => rails_root, :data => data, - :sections => sections }) - end - - def self.exception_source(controller) - if controller.respond_to?(:controller_name) - "in #{controller.controller_name}##{controller.action_name}" - else - "outside of a controller" - end - end - -private - - def sanitize_backtrace(trace) - re = Regexp.new(/^#{Regexp.escape(rails_root)}/) - trace.map { |line| Pathname.new(line.gsub(re, "[RAILS_ROOT]")).cleanpath.to_s } - end - - def rails_root - @rails_root ||= Pathname.new(RAILS_ROOT).cleanpath.to_s - end -end diff --git a/vendor/plugins/exception_notification/lib/exception_notification/notifier_helper.rb b/vendor/plugins/exception_notification/lib/exception_notification/notifier_helper.rb deleted file mode 100644 index 942e1c527..000000000 --- a/vendor/plugins/exception_notification/lib/exception_notification/notifier_helper.rb +++ /dev/null @@ -1,67 +0,0 @@ -require 'pp' - -# Copyright (c) 2005 Jamis Buck -# -# Permission is hereby granted, free of charge, to any person obtaining -# a copy of this software and associated documentation files (the -# "Software"), to deal in the Software without restriction, including -# without limitation the rights to use, copy, modify, merge, publish, -# distribute, sublicense, and/or sell copies of the Software, and to -# permit persons to whom the Software is furnished to do so, subject to -# the following conditions: -# -# The above copyright notice and this permission notice shall be -# included in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -module ExceptionNotification::NotifierHelper - PARAM_FILTER_REPLACEMENT = "[FILTERED]" - - def render_section(section) - RAILS_DEFAULT_LOGGER.info("rendering section #{section.inspect}") - summary = render("exception_notifier/#{section}").strip - unless summary.blank? - title = render("exception_notifier/title", :locals => { :title => section }).strip - "#{title}\n\n#{summary.gsub(/^/, " ")}\n\n" - end - end - - def inspect_model_object(model, locals={}) - render('exception_notifier/inspect_model', - :locals => { :inspect_model => model, - :show_instance_variables => true, - :show_attributes => true }.merge(locals)) - end - - def inspect_value(value) - len = 512 - result = object_to_yaml(value).gsub(/\n/, "\n ").strip - result = result[0,len] + "... (#{result.length-len} bytes more)" if result.length > len+20 - result - end - - def object_to_yaml(object) - object.to_yaml.sub(/^---\s*/m, "") - end - - def exclude_raw_post_parameters? - @controller && @controller.respond_to?(:filter_parameters) - end - - def filter_sensitive_post_data_parameters(parameters) - exclude_raw_post_parameters? ? @controller.__send__(:filter_parameters, parameters) : parameters - end - - def filter_sensitive_post_data_from_env(env_key, env_value) - return env_value unless exclude_raw_post_parameters? - return PARAM_FILTER_REPLACEMENT if (env_key =~ /RAW_POST_DATA/i) - return @controller.__send__(:filter_parameters, {env_key => env_value}).values[0] - end - -end diff --git a/vendor/plugins/exception_notification/test/exception_notifier_helper_test.rb b/vendor/plugins/exception_notification/test/exception_notifier_helper_test.rb deleted file mode 100644 index e077f405b..000000000 --- a/vendor/plugins/exception_notification/test/exception_notifier_helper_test.rb +++ /dev/null @@ -1,62 +0,0 @@ -require 'test_helper' -require 'exception_notification/notifier_helper' - -class ExceptionNotifierHelperTest < Test::Unit::TestCase - - class ExceptionNotifierHelperIncludeTarget - include ExceptionNotification::NotifierHelper - end - - def setup - @helper = ExceptionNotifierHelperIncludeTarget.new - end - - # No controller - - def test_should_not_exclude_raw_post_parameters_if_no_controller - assert !@helper.exclude_raw_post_parameters? - end - - # Controller, no filtering - - class ControllerWithoutFilterParameters; end - - def test_should_not_filter_env_values_for_raw_post_data_keys_if_controller_can_not_filter_parameters - stub_controller(ControllerWithoutFilterParameters.new) - assert @helper.filter_sensitive_post_data_from_env("RAW_POST_DATA", "secret").include?("secret") - end - def test_should_not_exclude_raw_post_parameters_if_controller_can_not_filter_parameters - stub_controller(ControllerWithoutFilterParameters.new) - assert !@helper.exclude_raw_post_parameters? - end - def test_should_return_params_if_controller_can_not_filter_parameters - stub_controller(ControllerWithoutFilterParameters.new) - assert_equal :params, @helper.filter_sensitive_post_data_parameters(:params) - end - - # Controller with filtering - - class ControllerWithFilterParameters - def filter_parameters(params) - { "PARAM" => ExceptionNotification::NotifierHelper::PARAM_FILTER_REPLACEMENT } - end - end - - def test_should_filter_env_values_for_raw_post_data_keys_if_controller_can_filter_parameters - stub_controller(ControllerWithFilterParameters.new) - assert !@helper.filter_sensitive_post_data_from_env("RAW_POST_DATA", "secret").include?("secret") - end - def test_should_exclude_raw_post_parameters_if_controller_can_filter_parameters - stub_controller(ControllerWithFilterParameters.new) - assert @helper.exclude_raw_post_parameters? - end - def test_should_delegate_param_filtering_to_controller_if_controller_can_filter_parameters - stub_controller(ControllerWithFilterParameters.new) - assert_equal({"PARAM" => "[FILTERED]" }, @helper.filter_sensitive_post_data_parameters({"PARAM" => 'secret'})) - end - - private - def stub_controller(controller) - @helper.instance_variable_set(:@controller, controller) - end -end
\ No newline at end of file diff --git a/vendor/plugins/exception_notification/test/test_helper.rb b/vendor/plugins/exception_notification/test/test_helper.rb deleted file mode 100644 index 5831a1784..000000000 --- a/vendor/plugins/exception_notification/test/test_helper.rb +++ /dev/null @@ -1,8 +0,0 @@ -require 'test/unit' -require 'rubygems' -require 'active_support' - -RAILS_ROOT = '.' unless defined?(RAILS_ROOT) - -$:.unshift File.join(File.dirname(__FILE__), '../lib') -require 'exception_notification'
\ No newline at end of file diff --git a/vendor/plugins/exception_notification/views/exception_notifier/_backtrace.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/_backtrace.rhtml deleted file mode 100644 index 7d13ba007..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/_backtrace.rhtml +++ /dev/null @@ -1 +0,0 @@ -<%= @backtrace.join "\n" %> diff --git a/vendor/plugins/exception_notification/views/exception_notifier/_environment.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/_environment.rhtml deleted file mode 100644 index 42dd803f1..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/_environment.rhtml +++ /dev/null @@ -1,7 +0,0 @@ -<% max = @request.env.keys.max { |a,b| a.length <=> b.length } -%> -<% @request.env.keys.sort.each do |key| -%> -* <%= "%-*s: %s" % [max.length, key, filter_sensitive_post_data_from_env(key, @request.env[key].to_s.strip)] %> -<% end -%> - -* Process: <%= $$ %> -* Server : <%= `hostname -s`.chomp %> diff --git a/vendor/plugins/exception_notification/views/exception_notifier/_inspect_model.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/_inspect_model.rhtml deleted file mode 100644 index e817847e4..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/_inspect_model.rhtml +++ /dev/null @@ -1,16 +0,0 @@ -<% if show_attributes -%> -[attributes] -<% attrs = inspect_model.attributes -%> -<% max = attrs.keys.max { |a,b| a.length <=> b.length } -%> -<% attrs.keys.sort.each do |attr| -%> -* <%= "%*-s: %s" % [max.length, attr, object_to_yaml(attrs[attr]).gsub(/\n/, "\n ").strip] %> -<% end -%> -<% end -%> - -<% if show_instance_variables -%> -[instance variables] -<% inspect_model.instance_variables.sort.each do |variable| -%> -<%- next if variable == "@attributes" -%> -* <%= variable %>: <%= inspect_value(inspect_model.instance_variable_get(variable)) %> -<% end -%> -<% end -%> diff --git a/vendor/plugins/exception_notification/views/exception_notifier/_request.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/_request.rhtml deleted file mode 100644 index 25423093f..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/_request.rhtml +++ /dev/null @@ -1,4 +0,0 @@ -* URL : <%= @request.protocol %><%= @host %><%= @request.request_uri %> -* IP address: <%= @request.env["HTTP_X_FORWARDED_FOR"] || @request.env["REMOTE_ADDR"] %> -* Parameters: <%= filter_sensitive_post_data_parameters(@request.parameters).inspect %> -* Rails root: <%= @rails_root %> diff --git a/vendor/plugins/exception_notification/views/exception_notifier/_session.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/_session.rhtml deleted file mode 100644 index 308684885..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/_session.rhtml +++ /dev/null @@ -1,2 +0,0 @@ -* session id: <%= @request.session_options[:id] %> -* data: <%= @request.session.inspect %>
\ No newline at end of file diff --git a/vendor/plugins/exception_notification/views/exception_notifier/_title.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/_title.rhtml deleted file mode 100644 index 1ed5a3f2b..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/_title.rhtml +++ /dev/null @@ -1,3 +0,0 @@ -------------------------------- -<%= title.to_s.humanize %>: -------------------------------- diff --git a/vendor/plugins/exception_notification/views/exception_notifier/exception_notification.rhtml b/vendor/plugins/exception_notification/views/exception_notifier/exception_notification.rhtml deleted file mode 100644 index 715c105bf..000000000 --- a/vendor/plugins/exception_notification/views/exception_notifier/exception_notification.rhtml +++ /dev/null @@ -1,6 +0,0 @@ -A <%= @exception.class %> occurred <%= @exception_source %>: - - <%= @exception.message %> - <%= @backtrace.first %> - -<%= @sections.map { |section| render_section(section) }.join %> |