Lipsiasoft-exception_notifier 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,57 @@
+ExceptionNotifier
+=================
+
+This plugin are raised when an exception fire up in controllers.
+Now you can personalize exception and simplify the layout using templates
+in app/views/exception
+when an exception is raised it try to send an email, and for send an email 
+you need to configure in enviroment.
+
+For test layouts and mailing do this:
+
+Edit enviroments/development.rb
+
+config.action_controller.consider_all_requests_local = false
+
+Then in your browser open 192.168.1.3 where 192.168.1.3 is your lan ip.
+
+Remember that if you use 127.0.0.1 Rails don't raise "production" errors.
+
+Installation
+============
+
+Rails::Initializer.run do |config|
+  config.gem 'mislav-will_paginate', :version => '~> 2.2.3', :lib => 'will_paginate', 
+    :source => 'http://gems.github.com'
+end
+
+Example
+=======
+
+script/generate exception_notifier [--haml-template]
+
+Personalize yours app/views/exceptions/ templates
+
+Remember that they use the layout of the controller where the exception is raised
+
+Then in /config/initializers/exception_notifier.rb 
+
+Lipsiadmin::Mailer::ExceptionNotifier.sender_address       = %("Exception Notifier" <server1@lipsiasoft.com>)
+Lipsiadmin::Mailer::ExceptionNotifier.recipients_addresses = %(info@lipsiasoft.com)
+Lipsiadmin::Mailer::ExceptionNotifier.email_prefix         = "[Your Progect]"
+
+
+Redmine
+=======
+
+This plugins is useful for redmine, if you have set the mail handler
+http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
+
+you need to set the inizializers/exception_notifier.rb like this
+
+Lipsiadmin::Mailer::ExceptionNotifier.sender_address       = %("Exception Notifier" <server1@lipsiasoft.com>)
+Lipsiadmin::Mailer::ExceptionNotifier.recipients_addresses = %(info@lipsiasoft.com)
+Lipsiadmin::Mailer::ExceptionNotifier.email_prefix         = "[Your Project]"
+Lipsiadmin::Mailer::ExceptionNotifier.extra_options        = { :project => "your-project-in-redmine", :tracker => "Bug", :priority => "Urgent" }
+
+Copyright (c) 2009 Lipsiasoft s.r.l., released under the MIT license

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+PKG_NAME      = 'exception_notifier'
+PKG_VERSION   = "1.0"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+
+desc 'Default: install the gem.'
+task :default => [:install]
+
+desc 'Generate documentation for the paperclip plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Lipsiadmin Exception Notifier'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Clean up files.'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "tmp"
+  FileUtils.rm_rf "pkg"
+end
+
+spec = Gem::Specification.new do |s| 
+  s.name              = PKG_NAME
+  s.version           = PKG_VERSION
+  s.author            = "Davide D'Agostino"
+  s.email             = "d.dagostino@lipsiasoft.com"
+  s.homepage          = "http://groups.google.com/group/lipsiadmin"
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = "Extracted exception notifier of Lipsiadmin"
+  s.files             = FileList["README", "MIT-LICENSE", "Rakefile", "init.rb", "{generators,lib,test}/**/*"].to_a
+  s.has_rdoc          = true
+  s.requirements     << 'none'
+  s.require_path      = 'lib'
+  s.autorequire       = 'exception_notifier'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc "Install the gem locally"
+task :install => [:repackage] do
+  sh %{sudo gem install pkg/#{PKG_FILE_NAME}.gem}
+end
+ 
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/generators/exception_notifier/REMEMBER

@@ -0,0 +1,9 @@
+
+================================================================
+
+Please remember to:
+
+  - Edit app/views/exceptions
+  - Edit config/initializers/exception_notifier.rb
+  
+================================================================

data/generators/exception_notifier/exception_notifier_generator.rb

@@ -0,0 +1,37 @@
+class ExceptionNotifierGenerator < Rails::Generator::NamedBase
+  default_options :haml_templates => false
+  
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args = ["none"].concat(runtime_args) # Skip usage
+    super
+  end
+  
+  def manifest
+    template = options[:haml_templates] ? "haml" : "erb"
+    
+    record do |m|
+      m.directory File.join('app/views', 'exceptions')
+      m.directory File.join('config', 'initializers')
+      
+      m.template('exception_notifier.rb', 'config/initializers/exception_notifier.rb')
+      
+      %w(404 422 500).each do |page|
+        m.template("views/#{page}.html.#{template}", "app/views/exceptions/#{page}.html.#{template}")
+      end
+      
+      m.readme "../REMEMBER"      
+    end
+  end
+  
+  protected
+    def banner
+      "Usage: #{$0} exception_notifier [--template]"
+    end
+    
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("-t", "--haml-templates",
+             "Generate exception templates using haml template") { |v| options[:haml_templates] = v; puts v }
+    end  
+end

data/generators/exception_notifier/templates/exception_notifier.rb

@@ -0,0 +1,6 @@
+Lipsiadmin::Mailer::ExceptionNotifier.sender_address       = %("Exception Notifier" <exceptions@lipsiasoft.com>)
+Lipsiadmin::Mailer::ExceptionNotifier.recipients_addresses = %(helpdesk@lipsiasoft.com)
+Lipsiadmin::Mailer::ExceptionNotifier.email_prefix         = "[Project Name]"
+
+# Uncomment this if this mail is for redmine handler
+# Lipsiadmin::Mailer::ExceptionNotifier.extra_options        = { :project => "lipsiabug", :tracker => "Bug", :priority => "Immediata" }

data/generators/exception_notifier/templates/views/404.html.erb

@@ -0,0 +1,4 @@
+<div class="exception">
+  <h1>The page you were looking for doesn't exist.</h1>
+  <p>You may have mistyped the address or the page may have moved.</p>
+</div>

data/generators/exception_notifier/templates/views/404.html.haml

@@ -0,0 +1,5 @@
+.exception
+  %h1 The page you were looking for doesn't exist.
+  %p You may have mistyped the address or the page may have moved. 
+    
+    

data/generators/exception_notifier/templates/views/422.html.erb

@@ -0,0 +1,4 @@
+<div class="exception">
+  <h1>The change you wanted was rejected.</h1>
+  <p>Maybe you tried to change something you didn't have access to.</p>
+</div>

data/generators/exception_notifier/templates/views/422.html.haml

@@ -0,0 +1,3 @@
+.exception
+  %h1 The change you wanted was rejected.
+  %p Maybe you tried to change something you didn't have access to.

data/generators/exception_notifier/templates/views/500.html.erb

@@ -0,0 +1,7 @@
+<div class="exception">
+  <h1>We're sorry, but something went wrong.</h1>
+  <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  <p><small>(If you're the administrator of this website, then please read
+  the log file "<%=h RAILS_ENV %>.log"
+  to find out what went wrong.)</small></p>
+</div>

data/generators/exception_notifier/templates/views/500.html.haml

@@ -0,0 +1,8 @@
+.exception
+  %h1 We're sorry, but something went wrong.
+  %p We've been notified about this issue and we'll take a look at it shortly.
+  %p 
+    %small
+      (If you're the administrator of this website, then please read the log file 
+      =h "#{RAILS_ENV}.log"
+      to find out what went wrong.)

data/init.rb

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

data/lib/controller/rescue.rb

@@ -0,0 +1,41 @@
+module Lipsiadmin
+  module Controller
+    # This module are raised when an exception fire up in controllers.
+    # Now you can personalize exception and simplify the layout using templates
+    # in app/views/exception
+    # when an exception is raised it try to send an email, and for send an email 
+    # you need to configure in enviroment or in an initializer some like this:
+    #
+    #   Examples:
+    #     
+    #     Lipsiadmin::Mailer::ExceptionNotifier.sender_address       = %("Exception Notifier" <server1@lipsiasoft.com>)
+    #     Lipsiadmin::Mailer::ExceptionNotifier.recipients_addresses = %(info@lipsiasoft.com)
+    #     Lipsiadmin::Mailer::ExceptionNotifier.email_prefix         = "[Your Project]"
+    # 
+    module Rescue
+      
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :rescue_action_in_public, :notifier
+        end
+      end
+
+      # Overwrite to implement public exception handling (for requests answering false to <tt>local_request?</tt>).  By
+      # default will call render_optional_error_file.  Override this method to provide more user friendly error messages.
+      def rescue_action_in_public_with_notifier(exception) #:doc:
+        response_code = response_code_for_rescue(exception)
+        status        = interpret_status(response_code)[0,3]
+        render :template => "/exceptions/#{status}", :status => status
+        if response_code != :not_found
+          Lipsiadmin::Mailer::ExceptionNotifier.deliver_exception(exception, self, request)
+        end
+      rescue Exception => e
+        logger.error e.message
+        erase_results
+        rescue_action_in_public_without_notifier(exception)
+      end
+      
+    end
+
+  end
+end

data/lib/exception_notifier.rb

@@ -0,0 +1,6 @@
+require 'mailer/exception_notifier'
+require 'controller/rescue'
+
+ActionController::Base.class_eval do
+  include Lipsiadmin::Controller::Rescue
+end

data/lib/mailer/exception/exception.html.erb

@@ -0,0 +1,11 @@
+A <%= @exception.class %> occurred in <%= @controller.controller_name %>#<%= @controller.action_name %>:
+
+  <%= @exception.message %>
+  <%= @backtrace.join("\n") %>
+  
+* URL       : <%= @request.protocol %><%= @host %><%= @request.request_uri %>
+* IP address: <%= @request.env["HTTP_X_FORWARDED_FOR"] || @request.env["REMOTE_ADDR"] %>
+* Parameters: <%= @request.parameters.inspect %>
+* Rails root: <%= RAILS_ROOT %>
+
+<%= @extra_options.collect { |k,v| "#{k.to_s.capitalize}: #{v}" }.join("\n") %>

data/lib/mailer/exception_notifier.rb

@@ -0,0 +1,38 @@
+module Lipsiadmin
+  module Mailer
+    class ExceptionNotifier < ActionMailer::Base
+
+      @@sender_address = %("Exception Notifier" <exception.notifier@default.com>)
+      cattr_accessor :sender_address
+
+      @@recipients_addresses = []
+      cattr_accessor :recipients_addresses
+
+      @@extra_options = {}
+      cattr_accessor :extra_options
+
+      @@email_prefix = "[ERROR] "
+      cattr_accessor :email_prefix
+      
+      self.mailer_name = "exception"
+      self.template_root = "#{File.dirname(__FILE__)}"
+
+      def self.reloadable?() false end
+
+      def exception(exception, controller, request)
+        content_type "text/plain"
+
+        subject    "#{email_prefix} #{exception.message.inspect}"
+
+        recipients recipients_addresses
+        from       sender_address
+
+        body       :controller => controller, :request => request,
+                   :exception => exception, :host => (request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"]),
+                   :backtrace => exception.backtrace, :extra_options => extra_options
+      end
+
+    end
+    
+  end
+end

data/test/exception_notifier_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ExceptionNotifierTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: Lipsiasoft-exception_notifier
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Davide D'Agostino
+autorequire: exception_notifier
+bindir: bin
+cert_chain: []
+
+date: 2009-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: d.dagostino@lipsiasoft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- MIT-LICENSE
+- Rakefile
+- init.rb
+- generators/exception_notifier
+- generators/exception_notifier/exception_notifier_generator.rb
+- generators/exception_notifier/REMEMBER
+- generators/exception_notifier/templates
+- generators/exception_notifier/templates/exception_notifier.rb
+- generators/exception_notifier/templates/views
+- generators/exception_notifier/templates/views/404.html.erb
+- generators/exception_notifier/templates/views/404.html.haml
+- generators/exception_notifier/templates/views/422.html.erb
+- generators/exception_notifier/templates/views/422.html.haml
+- generators/exception_notifier/templates/views/500.html.erb
+- generators/exception_notifier/templates/views/500.html.haml
+- lib/controller
+- lib/controller/rescue.rb
+- lib/exception_notifier.rb
+- lib/mailer
+- lib/mailer/exception
+- lib/mailer/exception/exception.html.erb
+- lib/mailer/exception_notifier.rb
+- test/exception_notifier_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://groups.google.com/group/lipsiadmin
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Extracted exception notifier of Lipsiadmin
+test_files: []
+