Added redmine exception handler.

Author: phillmv

COPYRIGHT.txt

@@ -0,0 +1,18 @@
+Redmine Exception Handler plugin will allow Redmine to send emails when an
+exception or error occurs.
+
+Copyright (C) 2008 Little Stream Software
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

CREDITS.rdoc

@@ -0,0 +1,4 @@
+Thanks go to the following people for patches and contributions:
+
+* Eric Davis of Little Stream Software - Project Maintainer
+* Jamis Buck - Creater of the Exception Notifier Plugin for Rails

GPL.txt

@@ -0,0 +1,3 @@
+gem 'tinder', '1.9.1'
+gem 'actionmailer', '>= 3.0.4'
+gem 'exception_notification', '3.0.1'

Gemfile

@@ -0,0 +1,25 @@
+= Redmine Exception Handler plugin
+
+The Redmine Exception Handler plugin will allow Redmine to send emails when an exception or error occurs.
+
+== Features
+
+* Allows configuration of recipients, sender address, and subject line without restarting the web server
+* Email contains a stack trace and full environment dump that can be used to reproduce the issue
+* Test controller to test the system settings
+
+== Install
+
+1. Follow the Redmine plugin installation steps at: http://www.redmine.org/wiki/redmine/Plugins Make sure the plugin is installed to +plugins/redmine_exception_handler+
+2. Run bundle install
+3. Login to Redmine as an Administrator
+4. Setup your mail settings in the Plugin settings panel
+5. Test your settings using the "Test settings" link
+
+== License
+
+This plugin is licensed under the GNU GPL v2.  See COPYRIGHT.txt and GPL.txt for details.
+
+== Help
+
+If you need help you can contact the maintainer at his email address (See CREDITS) or create an issue in the {Bug Tracker}:[https://projects.littlestreamsoftware.com/projects/show/redmine-exception]

README.rdoc

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+Dir[File.expand_path(File.dirname(__FILE__)) + "/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
+
+# Modifided from the RSpec on Rails plugins
+PLUGIN_ROOT = File.expand_path(File.dirname(__FILE__))
+REDMINE_APP = File.expand_path(File.dirname(__FILE__) + '/../../../app')
+REDMINE_LIB = File.expand_path(File.dirname(__FILE__) + '/../../../lib')
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+rspec_base = File.expand_path(File.dirname(__FILE__) + '/../rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+
+PROJECT_NAME = 'redmine_exception_handler_plugin'
+REDMINE_PROJECT_NAME = 'redmine-exception'
+CLEAN.include('**/semantic.cache', "**/#{PROJECT_NAME}.zip", "**/#{PROJECT_NAME}.tar.gz")
+
+# No Database needed
+spec_prereq = :noop
+task :noop do
+end
+
+task :default => :spec
+
+desc 'Generate documentation for the plugin.'
+Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = PROJECT_NAME
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end
+
+
+namespace :release do
+  desc "Create a zip archive"
+  task :zip => [:clean] do
+    sh "git archive --format=zip --prefix=#{PROJECT_NAME}/ HEAD > #{PROJECT_NAME}.zip"
+  end
+
+  desc "Create a tarball archive"
+  task :tarball => [:clean] do
+    sh "git archive --format=tar --prefix=#{PROJECT_NAME}/ HEAD | gzip > #{PROJECT_NAME}.tar.gz"
+  end
+
+  desc 'Uploads project documentation'
+  task :upload_doc => ['spec:rcov', :doc, 'spec:htmldoc'] do |t|
+    # TODO: Get rdoc working without frames
+    `scp -r doc/ dev.littlestreamsoftware.com:/home/websites/projects.littlestreamsoftware.com/shared/embedded_docs/#{REDMINE_PROJECT_NAME}/doc`
+    `scp -r coverage/ dev.littlestreamsoftware.com:/home/websites/projects.littlestreamsoftware.com/shared/embedded_docs/#{REDMINE_PROJECT_NAME}/coverage`
+  end
+end

Rakefile

@@ -0,0 +1,7 @@
+class ExampleExceptionController < ApplicationController
+  unloadable
+  
+  def index
+    raise Exception, 'Example exception'
+  end
+end

app/controllers/example_exception_controller.rb

@@ -0,0 +1,19 @@
+<p>
+  <label><%= l(:exception_handler_label_email_recipients) %></label><br /><label><small><%= l(:exception_handler_label_separate_multiple_emails_with_commas) %></small></label><%= text_area_tag 'settings[exception_handler_recipients]', @settings['exception_handler_recipients'], :rows => 5, :cols => 60 %>
+</p>
+
+<p>
+  <label><%= l(:exception_handler_label_sender_address)%></label><%= text_field_tag 'settings[exception_handler_sender_address]', @settings['exception_handler_sender_address'], :size => 60 %>
+</p>
+
+<p>
+  <label><%= l(:exception_handler_label_subject_prefix)%></label><%= text_field_tag 'settings[exception_handler_prefix]', @settings['exception_handler_prefix'], :size => 15 %>
+</p>
+
+<p>
+  <label><%= l(:exception_handler_label_email_format)%></label><%= select_tag 'settings[exception_handler_email_format]', options_for_select(['text', 'html'], @settings['exception_handler_email_format']) %>
+</p>
+
+<p>
+  <%= link_to l(:exception_handler_label_test_settings), { :controller => 'example_exception'}, :target => '_blank' %> <%= l(:exception_handler_label_will_open_in_a_new_window) %>
+</p>

app/views/settings/_exception_handler_settings.html.erb

@@ -0,0 +1,8 @@
+en:
+  exception_handler_label_email_recipients: "Email recipients"
+  exception_handler_label_separate_multiple_emails_with_commas: "Separate multiple email addresses with commas"
+  exception_handler_label_sender_address: "Sender address"
+  exception_handler_label_subject_prefix: "Subject prefix"
+  exception_handler_label_email_format: "Email format"
+  exception_handler_label_test_settings: "Test Settings by triggering a fake exception"
+  exception_handler_label_will_open_in_a_new_window: "(will open in a new window)"

config/locales/en.yml

@@ -0,0 +1,8 @@
+ru:
+  exception_handler_label_email_recipients: "Получатели письма"
+  exception_handler_label_separate_multiple_emails_with_commas: "Разделяйте e-mail'ы запятой"
+  exception_handler_label_sender_address: "Адрес отправителя"
+  exception_handler_label_subject_prefix: "Префикс темы письма"
+  exception_handler_label_email_format: "E-mail формате"
+  exception_handler_label_test_settings: "Проверить настройки вызовом тестовой ошибки"
+  exception_handler_label_will_open_in_a_new_window: "(откроется в новом окне)"

config/locales/ru.yml

@@ -0,0 +1,3 @@
+RedmineApp::Application.routes.draw do
+  get '/example_exception' => 'example_exception#index'
+end

config/routes.rb

@@ -0,0 +1,28 @@
+require 'redmine'
+
+# Dir[File.join(Redmine::Plugin.directory,'redmine_exception_handler','vendor','plugins','*')].each do |dir|
+#   path = File.join(dir, 'lib')
+#   $LOAD_PATH << path
+#   ActiveSupport::Dependencies.autoload_paths << path
+# end
+
+Redmine::Plugin.register :redmine_exception_handler do
+  name 'Redmine Exception Handler plugin'
+  author 'Eric Davis'
+  description 'Send emails when exceptions occur in Redmine.'
+  version '1.0.0'
+  requires_redmine :version_or_higher => '2.0.0'
+  
+  settings :default => {
+    'exception_handler_recipients' => '[email protected]',
+    'exception_handler_sender_address' => 'RDQ3 Exception <[email protected]>',
+    'exception_handler_prefix' => "[RDQ3 #{Rails.env}]",
+    'exception_handler_email_format' => 'text'
+  }, :partial => 'settings/exception_handler_settings'
+  
+end
+
+require_dependency 'exception_notification'
+ExceptionNotifier::Notifier.send(:include, ExceptionHandler::RedmineNotifierPatch)
+
+RedmineApp::Application.config.middleware.use ExceptionNotifier

init.rb

@@ -0,0 +1,21 @@
+module ExceptionHandler
+  module RedmineNotifierPatch
+    def self.included(target)
+      target.send(:include, InstanceMethods)
+      target.send(:alias_method_chain, :exception_notification, :database)
+    end
+  
+    module InstanceMethods
+      def exception_notification_with_database(env, exception, options = {})
+        settings = Setting.plugin_redmine_exception_handler
+        options[:exception_recipients] = settings['exception_handler_recipients'].split(',').map(&:strip)
+        options[:sender_address] = settings['exception_handler_sender_address']
+        options[:email_prefix] = settings['exception_handler_prefix']
+        options[:email_format] = (settings['exception_handler_email_format'] || 'text').to_sym
+        exception_notification_without_database(env, exception, options)
+      end
+  
+    end
+    
+  end
+end

lib/exception_handler/redmine_notifier_patch.rb

@@ -0,0 +1,5 @@
+# Load the normal Rails helper
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test/test_helper')
+
+# Ensure that we are using the temporary fixture path
+Engines::Testing.set_fixture_path

test/test_helper.rb

@@ -0,0 +1,57 @@
+== 3.0.0
+
+* enhancements
+  * Campfire integration
+  * Support fot HTML notifications (by @Xenofex)
+  * Be able to override SMTP settings (by @piglop and @Macint)
+
+* bug fixes
+  * Fix encoding issues
+  * Allow default sections to be overridden (by @jfarmer)
+  * Don't automatically deliver background notifications
+
+== 2.6.1
+
+* bug fixes
+  * Fix finding custom sections on Background notifications. Fixes [#68]
+
+== 2.6.0
+
+* enhancements
+  * Avoid raising exception on dev mode
+  * Add ignore_if option to avoid sending certain notifications.
+  * Add normalize_subject option to remove numbers from email so that they thread (by @jjb)
+  * Allow the user to provide a custom message and hash of data (by @jjb)
+  * Add support for configurable background sections and a data partial (by @jeffrafter)
+  * Include timestamp of exception in notification body	
+  * Add support for rack based session management (by @phoet)
+  * Add ignore_crawlers option to ignore exceptions generated by crawlers
+  * Add verbode_subject option to exclude exception message from subject (by @amishyn)
+
+* bug fixes
+  * Correctly set view path at the right time so that new sections are properly available (by @scrozier)
+  * Fix handling exceptions with no backtrace
+  * Fix issue on Solaris with hostname (by @bluescripts)
+  * Ensure exceptions in view templates doesn't cause problems, allowing the notification to be sent anyway (by @sce)
+
+== 2.5.1
+
+* bug fixes
+  * Fix lib references on gemspec
+
+== 2.5.0
+
+* enhancements
+  * Add Background Notifications
+
+* bug fixes
+  * Filter session_id on secure requests
+
+== 2.4.1
+
+* enhancements
+  * Use values set for the middleware as defaults
+
+* bug fixes
+  * Avoid sending emails with large subjects
+  * Avoid having to add 'require' option on gem configuration

vendor/plugins/exception_notification/.gemtest

@@ -0,0 +1,33 @@
+# How to contribute
+
+We love your contribution, for it's essential for making ExceptionNotification greater every day.
+In order to keep it as easy as possible to contribute changes, here are a few guidelines that we
+need contributors to follow:
+
+## First of all
+
+* Check if the issue you're going to submit isn't already submitted in
+  the [Issues](https://github.com/smartinez87/exception_notification/issues) page.
+
+## Issues
+
+* Submit a ticket for your issue, assuming one does not already exist.
+* The issue must:
+  * Clearly describe the problem including steps to reproduce when it is a bug.
+  * Also include all the information you can to make it easier for us to reproduce it,
+    like OS version, gem versions, etc...
+  * Even better, provide a failing test case for it.
+
+## Pull Requests
+
+If you've gone the extra mile and have a patch that fixes the issue, you
+should submit a Pull Request!
+
+* Fork the repo on Github.
+* Create a topic branch from where you want to base your work.
+* Add a test for your change. Only refactoring and documentation changes
+  require no new tests. If you are adding functionality or fixing a bug,
+  we need a test!
+* Run _all_ the tests to assure nothine else was broken. We only take pull requests with passing tests.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Push to your fork and submit a pull request.

vendor/plugins/exception_notification/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec