Module: Roda::RodaPlugins::ErrorEmail

Defined in:
lib/roda/plugins/error_email.rb

Overview

The error_email plugin adds an error_email instance method that send an email related to the exception. This is most useful if you are also using the error_handler plugin:

plugin :error_email, :to=>'[email protected]', :from=>'[email protected]'
plugin :error_handler do |e|
  error_email(e)
  'Internal Server Error'
end

Options:

:from

The From address to use in the email (required)

:headers

A hash of additional headers to use in the email (default: empty hash)

:host

The SMTP server to use to send the email (default: localhost)

:prefix

A prefix to use in the email’s subject line (default: no prefix)

:to

The To address to use in the email (required)

The subject of the error email shows the exception class and message. The body of the error email shows the backtrace of the error and the request environment, as well the request params and session variables (if any).

Note that emailing on every error as shown above is only appropriate for low traffic web applications. For high traffic web applications, use an error reporting service instead of this plugin.

Defined Under Namespace

Modules: InstanceMethods

Constant Summary collapse

OPTS = 
{}.freeze
DEFAULTS = 
{
  :headers=>{},
  :host=>'localhost',
  # :nocov:
  :emailer=>lambda{|h| Net::SMTP.start(h[:host]){|s| s.send_message(h[:message], h[:from], h[:to])}},
  # :nocov:
  :default_headers=>lambda do |h, e|
    {'From'=>h[:from], 'To'=>h[:to], 'Subject'=>"#{h[:prefix]}#{e.class}: #{e.message}"}
  end,
  :body=>lambda do |s, e|
    format = lambda{|h| h.map{|k, v| "#{k.inspect} => #{v.inspect}"}.sort.join("\n")}

    message = String.new
    message << <<END
Path: #{s.request.path}

Backtrace:

#{e.backtrace.join("\n")}

ENV:

#{format[s.env]}
END
    unless s.request.params.empty?
      message << <<END

Params:

#{format[s.request.params]}
END
    end

    if s.env['rack.session']
      message << <<END

Session:

#{format[s.session]}
END
    end

    message
  end
}

Class Method Summary collapse

Class Method Details

.configure(app, opts = OPTS) ⇒ Object

Set default opts for plugin. See ErrorEmail module RDoc for options.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/roda/plugins/error_email.rb', line 81

def self.configure(app, opts=OPTS)
  email_opts = app.opts[:error_email] ||= DEFAULTS
  email_opts = email_opts.merge(opts)
  email_opts[:headers] = email_opts[:headers].dup
  unless email_opts[:to] && email_opts[:from]
    raise RodaError, "must provide :to and :from options to error_email plugin"
  end
  app.opts[:error_email] = email_opts
  app.opts[:error_email][:headers].freeze
  app.opts[:error_email].freeze
end