me_exceptional 0.0.2 → 0.1.0

data/README.rdoc

@@ -51,6 +51,31 @@ In case you also want to customize the mailer, invoke the mailer generator:
 This creates the directory "/app/mailers/me_exceptional" with the mailer contained.
 
 
+== Usage outside of ActionController
+
+To use MeExceptional outside ActionController, i.e. in delayed jobs, you must include
+the BasicExtension and specifiy the methods you want to catch exceptions from in the
+class definition.
+
+
+    class Dummy
+       include MeExceptional::BasicExtension
+
+       def some_error
+         raise "some error"
+       end
+
+       def another_error
+         raise "some error"
+       end
+
+        rescue_mail_from_methods :some_error, :another_error
+     end
+
+Remember to put the call to rescue_mail_from_methods after the method definitions because
+the methods will be aliased.
+
+
 == Outlook
 
 * more gem side configuration options

data/app/mailers/me_exceptional/mailer.rb

@@ -7,6 +7,12 @@ class MeExceptional::Mailer < ::ActionMailer::Base
     mail(:from => MeExceptional.mailer_from, :to => MeExceptional.mailer_to, :subject => message)
   end
 
+  def error_mail(message, params)
+    @message, @params = message, params
+    subject = "Exception! #{message}"
+    mail(:from => MeExceptional.mailer_from, :to => MeExceptional.mailer_to, :subject => subject)
+  end
+
   private
 
   def get_hostname(ip)

data/app/views/me_exceptional/mailer/error_mail.html.erb

@@ -0,0 +1,17 @@
+
+<p style="font-size:12px"><b>Message</b></p>
+<p style="font-size:11px;font-family:Monaco,'Andale Mono',Consolas,'Courier New',monospace">
+<%= @message %>
+</p>
+
+<p style="font-size:12px"><b>Time</b></p>
+<p style="font-size:11px;font-family:Monaco,'Andale Mono',Consolas,'Courier New',monospace">
+<%= @params[:timestamp] %>
+</p>
+
+<p style="font-size:12px"><b>Complete Backtrace</b></p>
+<p style="font-size:11px;font-family:Monaco,'Andale Mono',Consolas,'Courier New',monospace">
+<%= @params[:backtrace] %>
+</p>
+
+

data/lib/me_exceptional/action_controller_extension.rb

@@ -9,14 +9,15 @@ module ActionController
     def exception_catcher(e)
        if Rails.env == 'production' 
         # blocking to be sure this gets send!
-        Emailer.exceptional(e.message,
+        MeExceptional::Mailer.exceptional(e.message,
                             :backtrace => e.backtrace.join("\n"),
                             :timestamp => Time.zone.now,
                             :method => request.method,
                             :url => request.url,
                             :params => params.inspect.to_s,
                             :user_agent => request.user_agent,
-                            :client_ip => request.remote_ip,
+                            #:client_ip => request.remote_ip,
+                            :client_ip => request.env["HTTP_X_FORWARDED_FOR"].split(',').first,
                             :request_env => request.env.inspect.to_s).deliver
 
       end

data/lib/me_exceptional/engine.rb

@@ -5,6 +5,13 @@ require 'action_controller'
 module MeExceptional
   class Engine < ::Rails::Engine
     engine_name :me_exceptional
+
+    #initialize "me_exceptional.load_app_instance_data" do |app|
+    #  MeExceptional.setup do |config|
+    #    config.app_root = app.root
+    #  end
+    #end
+
   end
 end
 

data/lib/me_exceptional/extension.rb

@@ -0,0 +1,51 @@
+require 'me_exceptional/engine'
+
+module MeExceptional
+  module BasicExtension
+
+    def exception_catcher(e)
+      if Rails.env == 'production' 
+
+        m = MeExceptional::Mailer.error_mail(e.message,
+                                             :backtrace => e.backtrace.join("\n"),
+                                             :timestamp => Time.zone.now)
+
+        # blocking on purpose to be sure this gets sent!
+        m.deliver
+
+      end
+      raise e
+    end
+
+    module ClassMethods
+      def rescue_mail_from_methods(*methods)
+
+        methods.each do |method|
+          class_eval <<-EOF
+            def #{method}_rescuable
+              method
+            rescue Exception => e
+              rescue_with_handler(e)
+            end
+            alias_method :#{method}, :#{method}_rescuable
+          EOF
+        end
+
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.instance_eval <<-EOF
+        include ActiveSupport::Rescuable
+        rescue_from Exception, :with => :exception_catcher
+      EOF
+
+    end
+
+  end
+
+end
+
+

data/lib/me_exceptional/version.rb

@@ -1,3 +1,3 @@
 module MeExceptional
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/me_exceptional.rb

@@ -1,4 +1,5 @@
 require 'rails'
+require 'active_support'
 
 module MeExceptional
 
@@ -8,6 +9,7 @@ module MeExceptional
   mattr_accessor :mailer_to
   @@mailer_to = nil
 
+  mattr_accessor :app_root
 
   def self.setup
     yield self
@@ -15,9 +17,9 @@ module MeExceptional
 
 end
 
+require 'me_exceptional/extension'
 require 'me_exceptional/action_controller_extension'
 require 'me_exceptional/engine'
 
 
 
-

data/me_exceptional.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency('activesupport')
   s.add_dependency('rails')
   s.add_dependency('geokit')
 

metadata

@@ -2,12 +2,12 @@
 name: me_exceptional
 version: !ruby/object:Gem::Version 
   hash: 27
-  prerelease: false
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kai Rubarth
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-17 00:00:00 +02:00
-default_executable: 
+date: 2012-01-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -33,7 +32,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: geokit
+  name: rails
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,6 +45,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: geokit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: The gem catches exceptions and creates and sends emails with backtrace and other informations.
 email: 
 - kai@doxter.de
@@ -61,6 +74,7 @@ files:
 - README.rdoc
 - Rakefile
 - app/mailers/me_exceptional/mailer.rb
+- app/views/me_exceptional/mailer/error_mail.html.erb
 - app/views/me_exceptional/mailer/exceptional.html.erb
 - lib/generators/me_exceptional/install_generator.rb
 - lib/generators/me_exceptional/mailers_generator.rb
@@ -70,9 +84,9 @@ files:
 - lib/me_exceptional.rb
 - lib/me_exceptional/action_controller_extension.rb
 - lib/me_exceptional/engine.rb
+- lib/me_exceptional/extension.rb
 - lib/me_exceptional/version.rb
 - me_exceptional.gemspec
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -102,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: me_exceptional
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: notifies you of exceptions by email