dreamcatcher 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dreamcatcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Willem van Bergen
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,77 @@
+# Dreamcatcher
+
+A simple gem to catch exceptions and send email notifications.
+
+This gem is especially made for monitoring tasks, like rake tasks or background jobs.
+It can also capture messages you send to a logger during the monitored code, and
+include the log snippet in the notification. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dreamcatcher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dreamcatcher
+
+## Usage
+
+Use `Dreamcatcher.monitor` to monitor a block of code for exceptions
+
+    logger = Logger.new($stdout)
+    Dreamcatcher.monitor(logger: logger) do
+      logger.debug "progress"
+      raise 'omg ponies'
+    end
+
+If Dreamcatcher catches an exception, it will send an email, and re-raise the exception. 
+
+You can configure Dreamcatcher using the `configuration` object.
+You can provide a static value or a block that will be dynamically evaluated
+when the value is needed.
+
+    Dreamcatcher.configuration.from = 'willem@example.com'
+    Dreamcatcher.configuration.to   = 'willem+exceptions@example.com'
+    Dreamcatcher.configuration.subject = lambda do |context|
+      "[My app] #{context.exception.class.name}: #{context.exception.message}"
+    end
+
+    # This defines whether the email will actually be delivered.
+    Dreamcatcher.configuration.subject.deliver = lambda { RACK_ENV == 'production' }
+
+    # Dreamcatcher uses the pony gem to send emails: https://github.com/benprew/pony
+    # The following options are copied directly to `Pony.mail`
+
+    Dreamcatcher.configuration.via = :smtp
+    Dreamcatcher.configuration.via_options = { ... }
+
+    # You can specify what templates to use for the emails.
+    # Dreamcatcher ships with basic templates, so you can leave these options blank.
+    # It will look for `#{template_dir}/#{template}.html.erb` for the HTML part
+    # and `#{template_dir}/#{template}.text.erb` for the plain text part of the email.
+    
+    Dreamcatcher.configuration.template_dir = "./email_templates"
+    Dreamcatcher.configuration.template = lambda do |context|
+      # Use a custom template for a particular exception
+      if context.exception.class == MyAwesomeException
+        'my_awesome_exception'
+      else
+        'generic_exception'
+      end
+    end
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature -u`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/dreamcatcher.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dreamcatcher/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dreamcatcher"
+  gem.version       = Dreamcatcher::VERSION
+  gem.authors       = ["Willem van Bergen"]
+  gem.email         = ["willem@railsdoctors.com"]
+  gem.description   = %q{Catch exceptions and send email notifications with context.}
+  gem.summary       = %q{Catch exceptions and send email notifications with context.}
+  gem.homepage      = "https://github.com/wvanbergen/dreamcatcher"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency("pony")
+end

data/lib/dreamcatcher.rb

@@ -0,0 +1,20 @@
+module Dreamcatcher
+  extend self
+  
+  def monitor(options = {}, &block)
+    Dreamcatcher::Monitor.new(configuration).monitor(options, &block)
+  end
+
+  def configuration
+    @configuration ||= Dreamcatcher::Configuration.new
+  end
+
+  TEMPLATE_DIR = File.expand_path('../dreamcatcher/templates', __FILE__)
+end
+
+require "dreamcatcher/version"
+require "dreamcatcher/configuration"
+require "dreamcatcher/monitor"
+require "dreamcatcher/exception_context"
+require "dreamcatcher/logger_proxy"
+require "dreamcatcher/mailer"

data/lib/dreamcatcher/configuration.rb

@@ -0,0 +1,27 @@
+class Dreamcatcher::Configuration
+
+  attr_accessor :exception_class, 
+                :to, :from, :subject, 
+                :deliver, :via, :via_options, 
+                :template, :template_dir
+
+  def initialize
+    @exception_class = StandardError
+    @from = 'exceptions@example.com'
+    @subject = lambda do |context|
+      "Exception #{context.exception.class.name}: #{context.exception.message}"
+    end
+
+    @template_dir = Dreamcatcher::TEMPLATE_DIR
+    @template     = 'generic_exception'
+    
+    @via          = :sendmail
+    @via_options  = nil
+    @deliver      = false
+  end
+
+  def evaluate(symbol, *args)
+    value = self.send(symbol)
+    value.respond_to?(:call) ? value.call(*args) : value
+  end
+end

data/lib/dreamcatcher/exception_context.rb

@@ -0,0 +1,9 @@
+class Dreamcatcher::ExceptionContext
+
+  attr_reader :exception, :log_entries, :other, :timestamp
+
+  def initialize(exception, log_entries, other = {})
+    @exception, @log_entries, @other = exception, log_entries, other
+    @timestamp = Time.now
+  end
+end

data/lib/dreamcatcher/logger_proxy.rb

@@ -0,0 +1,79 @@
+require 'logger'
+
+class Dreamcatcher::LoggerProxy
+
+  attr_reader :original_logger, :log_entries
+
+  def initialize(logger)
+    @original_logger = logger
+    @log_entries = []
+  end
+
+  def capture(&block)
+    register_logger_monkeypatch unless @original_logger.nil?
+    yield if block_given?
+    return self
+  ensure
+    deregister_logger_monkeypatch unless @original_logger.nil?
+  end
+
+  def self.capture(logger, &block)
+    Dreamcatcher::LoggerProxy.new(logger).capture(&block)
+  end
+
+  protected
+
+  def register_logger_monkeypatch
+    @original_logger.instance_variable_set(:"@_captured_entries", @log_entries)
+    class << @original_logger
+      def add_with_capture(severity, prog, message = nil, &block)
+        message = yield if message.nil? && block_given?
+        @_captured_entries << LogEntry.new(severity, prog, message)
+        add_without_capture(severity, prog, message)
+      end
+      alias_method :add_without_capture, :add
+      alias_method :add, :add_with_capture
+    end
+  end
+
+  def deregister_logger_monkeypatch
+    class << @original_logger
+      alias_method :add, :add_without_capture
+      undef_method :add_without_capture
+      undef_method :add_with_capture
+    end
+    @original_logger.send :remove_instance_variable, :"@_captured_entries"
+  end  
+
+  class LogEntry
+    attr_reader :severity, :message, :timestamp
+
+    def initialize(severity, prog, message, timestamp = nil)
+      @severity  = severity
+      @prog      = prog
+      @message   = message
+      @timestamp = timestamp || Time.now
+    end
+
+    def to_s(format = '%t [%s] %m')
+      format.
+        sub('%s', format_severity).
+        sub('%m', @message || '').
+        sub('%p', @prog || '').
+        sub('%t', format_timestamp)
+    end
+
+    protected
+
+    # Severity label for logging (max 5 chars).
+    SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY)
+
+    def format_severity
+      SEV_LABEL[severity] || 'ANY'
+    end
+
+    def format_timestamp
+      timestamp.strftime('%F %T %Z')
+    end
+  end
+end

data/lib/dreamcatcher/mailer.rb

@@ -0,0 +1,101 @@
+require "delegate"
+require "pony"
+require "erb"
+
+class Dreamcatcher::Mailer
+
+  attr_reader :configuration
+
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def handle_exception(context)
+    email_options = build_email_options(context)
+    if configuration.evaluate(:deliver, context)
+      Pony.mail(email_options)
+    else
+      # TODO: print / log email somewhere
+    end
+  end
+
+  def build_email_options(context)
+
+    options = {
+      :to          => configuration.evaluate(:to, context),
+      :from        => configuration.evaluate(:from, context),
+      :subject     => configuration.evaluate(:subject, context),
+      :via         => configuration.evaluate(:via, context),
+      :via_options => configuration.evaluate(:via_options, context)
+    }
+
+    options[:body]      = render_body(:text, context, options)
+    options[:html_body] = render_body(:html, context, options)
+
+    options.delete_if { |k, v| v.nil? }
+    raise "E-mail has no to recipient!" unless options[:to]
+    raise "E-mail has no body!" unless options[:body] || options[:html_body]
+
+    options
+  end
+
+  def render_body(type, context, options)
+    template_dir  = configuration.evaluate(:template_dir, context)
+    template      = configuration.evaluate(:template, context)
+    template_file = erb_template_file(template_dir, template, type)
+    email_context = EmailContext.new(context, options)
+
+    if File.exists?(template_file)
+      layout_file = erb_template_file(template_dir, 'layout', type)
+      if File.exists?(layout_file)
+        render_erb_template(layout_file, email_context) do
+          render_erb_template(template_file, email_context) 
+        end
+      else
+        render_erb_template(template_file, email_context) 
+      end
+    else
+      nil
+    end
+  end
+
+  def render_erb_template(template_file, context, &block)
+    ERB.new(File.read(template_file), nil, '<>').result(context.get_binding(&block))
+  end
+
+  def erb_template_file(dir, name, type)
+    File.join(dir, "#{name}.#{type}.erb")
+  end
+
+
+  class EmailContext < SimpleDelegator
+    def initialize(context, options)
+      super(context)
+      @context, @options = context, options
+    end
+
+    def subject
+      @options[:subject]
+    end
+
+    def to
+      @options[:to]
+    end
+
+    def cc
+      @options[:cc]
+    end
+
+    def bcc
+      @options[:bcc]
+    end
+
+    def from
+      @options[:from]
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/dreamcatcher/monitor.rb

@@ -0,0 +1,27 @@
+class Dreamcatcher::Monitor
+
+  attr_reader :configuration, :handlers
+
+  def initialize(configuration)
+    @configuration = configuration
+    @handlers = build_handlers
+  end
+
+  def monitor(options = {}, &block)
+    @context = options[:context] || {}
+    logger_proxy = Dreamcatcher::LoggerProxy.new(options[:logger])
+    logger_proxy.capture { block.call }
+      
+  rescue @configuration.exception_class => exception
+    context = Dreamcatcher::ExceptionContext.new(exception, logger_proxy.log_entries)
+    handlers.each { |handler| handler.handle_exception(context) }
+    raise 
+  end
+
+  protected 
+
+  def build_handlers
+    mailer = Dreamcatcher::Mailer.new(configuration)
+    [mailer]
+  end
+end

data/lib/dreamcatcher/rake.rb

@@ -0,0 +1 @@
+require 'rake'

data/lib/dreamcatcher/templates/generic_exception.html.erb

@@ -0,0 +1,38 @@
+<h3> Exception: <%=exception.class.name %> </h3>
+<table>
+  <tr>
+    <th style="text-align: left;"> Exception </th>
+    <td> <code><%=exception.class.name %></code> </td>
+  </tr>
+
+  <tr>
+    <th style="text-align: left;"> Timestamp </th>
+    <td> <%= timestamp %> </td>
+  </tr>
+
+  <% if !exception.message.nil? && exception.message != '' %>
+  <tr>
+    <th style="text-align: left;"> Message </th>
+    <td> <%= exception.message %> </td>
+  </tr>  
+  <% end %>
+</table>
+
+<% if exception.backtrace %>
+<h3> Backtrace </h3>
+<pre style="font-family:monospace;">
+<% exception.backtrace.each do |line| %>
+<%= line %>
+<% end %>
+</pre>
+<% end %>
+
+
+<% if log_entries.any? %>
+<h3> Log </h3>
+<pre style="font-family:monospace;">
+<% log_entries.each do |entry| %>
+<%= entry.to_s %>
+<% end %>
+</pre>
+<% end %>

data/lib/dreamcatcher/templates/generic_exception.text.erb

@@ -0,0 +1,25 @@
+# Exception: <%=exception.class.name %>
+
+Exception: <%=exception.class.name %>
+Timestamp: <%= timestamp %>
+<% if !exception.message.nil? && exception.message != '' %>
+Message:   <%= exception.message %>
+<% end %>
+
+
+<% if exception.backtrace %>
+## Backtrace
+
+<% exception.backtrace.each do |line| %>
+<%= line %>
+<% end %>
+<% end %>
+
+
+<% if log_entries.any? %>
+## Log
+
+<% log_entries.each do |entry| %>
+<%= entry.to_s %>
+<% end %>
+<% end %>

data/lib/dreamcatcher/templates/layout.html.erb

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/dreamcatcher/version.rb

@@ -0,0 +1,3 @@
+module Dreamcatcher
+  VERSION = "0.0.1"
+end

data/test/dreamcatcher_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+require 'logger'
+
+Dreamcatcher.configuration.to = 'example@example.com'
+Dreamcatcher.configuration.deliver = false
+
+class DreamcatcherTest < Test::Unit::TestCase
+
+  def test_monitor_should_reraise_exception
+    assert_raises(RuntimeError) do
+      Dreamcatcher.monitor do
+        raise "error"
+      end
+    end
+  end
+end

data/test/logger_proxy_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+require 'logger'
+
+class LoggerProxyTest < Test::Unit::TestCase
+
+  def test_logger_capture
+    logger = Logger.new("/dev/null")
+    proxy = Dreamcatcher::LoggerProxy.capture(logger) do
+      logger.info "hello world"
+    end
+    logger.info "goodbye world"
+
+    assert_equal proxy.log_entries.size, 1
+    assert_equal proxy.log_entries.first.message, "hello world"
+  end
+
+  def test_capture_without_logger
+    logger = Logger.new("/dev/null")
+    proxy = Dreamcatcher::LoggerProxy.capture(nil) do
+      logger.info "hello world"
+    end
+    assert_equal proxy.log_entries.size, 0
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'test/unit'
+require 'dreamcatcher'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: dreamcatcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: &70145515587540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70145515587540
+description: Catch exceptions and send email notifications with context.
+email:
+- willem@railsdoctors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dreamcatcher.gemspec
+- lib/dreamcatcher.rb
+- lib/dreamcatcher/configuration.rb
+- lib/dreamcatcher/exception_context.rb
+- lib/dreamcatcher/logger_proxy.rb
+- lib/dreamcatcher/mailer.rb
+- lib/dreamcatcher/monitor.rb
+- lib/dreamcatcher/rake.rb
+- lib/dreamcatcher/templates/generic_exception.html.erb
+- lib/dreamcatcher/templates/generic_exception.text.erb
+- lib/dreamcatcher/templates/layout.html.erb
+- lib/dreamcatcher/version.rb
+- test/dreamcatcher_test.rb
+- test/logger_proxy_test.rb
+- test/test_helper.rb
+homepage: https://github.com/wvanbergen/dreamcatcher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Catch exceptions and send email notifications with context.
+test_files:
+- test/dreamcatcher_test.rb
+- test/logger_proxy_test.rb
+- test/test_helper.rb