exceptioner 0.0.2 → 0.0.3

data/README.rdoc

@@ -45,7 +45,7 @@ Then require excptioner and use it like:
     begin 
         # some code which may fail
     rescue VeryFatalError => e
-        Exceptioner::Notifier.dispatch(e)
+        Exceptioner.notify(e)
     end    
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/exceptioner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{exceptioner}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Micha\305\202 \305\201omnicki"]
-  s.date = %q{2010-12-14}
+  s.date = %q{2010-12-16}
   s.description = %q{The most common use is to use Exceptioner as rack middleware and send notifications when an exception occur in you web application. It may be used with Rails, Sinatra or any other rack citizen. 
       Exceptioner may be also used with any ruby code you want. Just configure delivery methods and don't miss any exception.}
   s.email = %q{michal@lomnicki.com.pl}

data/lib/exceptioner/notifier.rb

@@ -2,13 +2,34 @@ module Exceptioner
   class Notifier
 
     def self.dispatch(exception, options = {})
-      available_transports = classify_transports(options[:transports] || transports)
-      available_transports.each do |transport|
-        transport.deliver(exception, options)
+      if dispatch_exception?
+        options = determine_options(exception, options.dup)
+        determine_transports(options) do |transport|
+          transport.deliver(options)
+        end
       end
     end
 
     protected
+    def self.determine_options(exception, options)
+      if exception.is_a?(Hash)
+        options = exception
+        exception = nil
+      else
+        options[:exception]       ||= exception
+        options[:exception_class] ||= exception.class
+        options[:error_message]   ||= exception.message
+        options[:backtrace]       ||= exception.backtrace
+      end
+      return options
+    end
+
+    def self.determine_transports(options)
+      available_transports = classify_transports(options[:transports] || transports)
+      available_transports.each { |transport| yield transport }
+      available_transports
+    end
+
     def self.transports
       Exceptioner.transports
     end
@@ -23,5 +44,14 @@ module Exceptioner
       end
     end
 
+    def self.config
+      Exceptioner
+    end
+
+    def dispatch_exception?
+      ! config.development_environments.include?(config.environment_name)
+    end
+
+
   end
 end

data/lib/exceptioner/railtie.rb

@@ -7,8 +7,9 @@ module Exceptioner
     end
 
     initializer "exceptioner.use_rails_default" do |app|
-      Exceptioner.mail.delivery_method = rails_delivery(app)
-      Exceptioner.mail.delivery_options = rails_delivery_options(app)
+      Exceptioner.environment_name ||= Rails.env
+      Exceptioner.mail.delivery_method ||= rails_delivery(app)
+      Exceptioner.mail.delivery_options ||= rails_delivery_options(app)
     end
 
     protected

data/lib/exceptioner/transport/base.rb

@@ -11,7 +11,7 @@ module Exceptioner::Transport
     class_attribute :subject
 
 
-    def self.deliver(exception, options = {})
+    def self.deliver(options = {})
       raise Exceptioner::ExceptionerError, 'Implement deliver class method in your Exceptioner::Transport::Base subclass'
     end
     
@@ -25,11 +25,11 @@ module Exceptioner::Transport
       }
     end
 
-    def self.prefixed_subject(exception, options)
-      "#{options[:prefix]}#{exception.message}"
+    def self.prefixed_subject(options)
+      "#{options[:prefix]}#{options[:error_message]}"
     end
     
-    def self.render(exception, options = {})
+    def self.render(options = {})
       ERB.new(template, nil, '>').result(binding)
     end
 

data/lib/exceptioner/transport/jabber/jabber.rb

@@ -11,19 +11,20 @@ module Exceptioner::Transport
 
     class_attribute :password
 
-    def self.deliver(exception, options = {})
-      connect
-      messages = prepare_messages(exception, options)
-      messages.each do |message|
-        @client.send(message)
+    def self.deliver(options = {})
+      messages = prepare_messages(options)
+      connect do |client|
+        messages.each do |message|
+          client.send(message)
+        end
       end
     end
 
     protected
-    def self.prepare_messages(exception, message_options)
+    def self.prepare_messages(message_options)
       options = message_options.dup
       options = default_options.merge(options)
-      options[:body] ||= render(exception, message_options)
+      options[:body] ||= render(message_options)
 
       messages = []
       Array(options[:recipients]).each do |recipient|
@@ -36,9 +37,10 @@ module Exceptioner::Transport
 
     def self.connect
       jid = ::Jabber::JID.new(self.jabber_id)      
-      @client = ::Jabber::Client.new(jid)
-      @client.connect
-      @client.auth(self.password)
+      client = ::Jabber::Client.new(jid)
+      client.connect
+      client.auth(self.password)
+      yield client
     end
 
   end

data/lib/exceptioner/transport/mail/mail.rb

@@ -12,20 +12,11 @@ module Exceptioner::Transport
 
     class_attribute :delivery_options
 
-    def self.deliver(exception, options = {})
-      mail = prepare_mail(exception, options)
+    def self.deliver(options = {})
+      mail = prepare_mail(options)
       mail.deliver
     end
 
-    def self.determine_mail_options(exception, mail_options)
-      options = {}
-      options[:from]    ||= options[:sender]
-      options[:to]      ||= options[:recipients]
-      options[:subject] ||= prefixed_subject(exception, options)
-      options[:body]    ||= render(exception, mail_options)
-      options.merge!(default_options)
-    end
-
     protected
     def self.default_options
       {
@@ -35,11 +26,11 @@ module Exceptioner::Transport
       }.merge!(super)
     end
 
-    def self.prepare_mail(exception, mail_options)
+    def self.prepare_mail(mail_options)
       options = mail_options.dup
       options = default_options.merge(options)
-      options[:subject] ||= prefixed_subject(exception, options)
-      options[:body] ||= render(exception, mail_options)
+      options[:subject] ||= prefixed_subject(options)
+      options[:body]    ||= render(mail_options)
 
       mail = ::Mail.new(
         :from             => options[:sender], 

data/lib/exceptioner/transport/templates/exception.erb

@@ -1,14 +1,29 @@
-Application raised <%= exception.class %>
+<% if options[:exception]%>
+Application raised <%= options[:exception_class].to_s %> <%= options[:error_message] %>
+<% end %>
 <% if options[:controller] %>
  from <%= options[:controller].controller_name %>#<%= options[:controller].action_name %>
 <% end %>.
 
-    Message: <%= exception.message.to_s %>.
-    
+<% if options[:error_message] %>
+<%= Exceptioner::Transport::Helper.title('Error Message') %>
+    <%= options[:error_message] %>
+<% end %>
+
+<% if options[:backtrace] %>
 <%= Exceptioner::Transport::Helper.title('Backtrace') %>
 
-        <%= exception.backtrace.join("\n\t") %>
+        <%= options[:backtrace].join("\n\t") %>
+<% end %>
 
+<% if options[:parameters] %>
+<% options[:parameters].each_pair do |key, value| %>
+<%= Exceptioner::Transport::Helper.title(key.to_s) %>
+    
+    <%= value.inspect %>
+
+<% end %>
+<% end %>
 
 <% if options[:env] %>
 <%= Exceptioner::Transport::Helper.title('Environment') %>

data/lib/exceptioner.rb

@@ -24,6 +24,18 @@ module Exceptioner
   mattr_accessor :dispatch_local_requests
   @@dispatch_local_requests = false
 
+  # Name of current environment.
+  # For rails it would be development, test or production.
+  # It's included in exception notification.
+  # You can also combine it with development_environments to decide
+  # when to handle exceptions by Exceptioner.
+  mattr_accessor :environment_name
+
+  # Define development environment. For these environments exceptions will not
+  # be handled by Exceptioner.
+  mattr_accessor :development_environments
+  @@development_environments = %w[development test cucumber]
+
   def self.setup
     yield self
   end
@@ -36,4 +48,8 @@ module Exceptioner
     Transport::Jabber
   end
 
+  def self.notify(exception, options = {})
+    Notifier.dispatch(exception, options)
+  end
+
 end

data/lib/generators/exceptioner/templates/exceptioner.rb

@@ -4,6 +4,12 @@ Exceptioner.setup do |config|
   # Define how to deliver information about exception
   # Available options are: mail, :jabber
   # config.transports = [:mail]
+  
+  # Environments for which raised exceptions won't be dispatched
+  # config.development_environments = %w[development test cucumber]
+  
+  # Name of current environment. For Rails it gets Rails.env by default
+  # config.environment_name = Rails.env
 
   # ### The section below regards mail transport only ###
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-14 00:00:00 +01:00
+date: 2010-12-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency