rusen 0.0.1 → 0.0.2

data/lib/rusen.rb

@@ -1,16 +1,21 @@
 require 'rusen/settings'
 require 'rusen/notifier'
-#require 'rusen/notification'
 
 module Rusen
 
   @settings = Settings.new
   @notifier = Notifier.new(@settings)
 
+  # Returns the global settings for rusen.
+  #
+  # This settings apply to the notifications sent with Rusen.notify
+  #
+  # @return [Rusen::Settings] rusen global settings.
   def self.settings
     @settings
   end
 
+  # (see Rusen::Notifier#notify)
   def self.notify(exception, request = nil, environment = nil, session = nil)
     @notifier.notify(exception, request, environment, session)
   end

data/lib/rusen/middleware/rusen_rack.rb

@@ -6,6 +6,7 @@ module Rusen
   module Middleware
 
     class RusenRack
+
       def initialize(app, settings = {})
         @app = app
 
@@ -17,6 +18,7 @@ module Rusen
         @rusen_settings.sender_address = settings[:sender_address]
         @rusen_settings.exception_recipients = settings[:exception_recipients]
         @rusen_settings.smtp_settings = settings[:smtp_settings]
+        @rusen_settings.exclude_if = settings[:exclude_if]
 
         @notifier = Notifier.new(@rusen_settings)
       end
@@ -25,13 +27,15 @@ module Rusen
         begin
           @app.call(env)
         rescue Exception => error
-          request = Rack::Request.new(env)
-
-          @notifier.notify(error, request.GET.merge(request.POST), env, request.session)
+          unless @rusen_settings.exclude_if.call(error)
+            request = Rack::Request.new(env)
+            @notifier.notify(error, request.GET.merge(request.POST), env, request.session)
+          end
 
           raise
         end
       end
+
     end
 
   end

data/lib/rusen/notification.rb

@@ -1,5 +1,6 @@
 module Rusen
 
+  # Class for holding all the information that can be sent in a notification.
   class Notification
 
     attr_reader :exception, :request, :environment, :session

data/lib/rusen/notifier.rb

@@ -22,6 +22,12 @@ module Rusen
       @notifiers << notifier_class.new(@settings)
     end
 
+    # Sends a notification to the configured outputs.
+    #
+    # @param [Exception] exception The error.
+    # @param [Hash<Object, Object>] request The request params
+    # @param [Hash<Object, Object>] environment The environment status.
+    # @param [Hash<Object, Object>] session The session status.
     def notify(exception, request = nil, environment = nil, session = nil)
       begin
         notification = Notification.new(exception, request, environment, session)
@@ -32,7 +38,7 @@ module Rusen
 
       # We need to ignore all the exceptions thrown by the notifiers.
       rescue Exception
-        ERROR("Rusen: Some or all the notifiers failed to sent the notification.")
+        warn("Rusen: Some or all the notifiers failed to sent the notification.")
       end
     end
 

data/lib/rusen/notifiers/email_notifier.rb

@@ -20,9 +20,10 @@ module Rusen
 
           Pony.mail(email_options.merge({:body => build_body}))
 
-        # We need to ignore all the exceptions thrown by EmailNotifier.notify.
+        # We need to ignore all the exceptions thrown by EmailNotifier#notify.
         rescue Exception => e
-          ERROR("Rusen: #{e.message} prevented the notification email from being sent.")
+          warn("Rusen: #{e.class}: #{e.message} prevented the notification email from being sent.")
+          puts e.backtrace
         end
       end
 

data/lib/rusen/notifiers/io_notifier.rb

@@ -42,9 +42,9 @@ module Rusen
             print_hash(notification.environment)
           end
 
-        # We need to ignore all the exceptions thrown by IONotifier.notify.
+        # We need to ignore all the exceptions thrown by IONotifier#notify.
         rescue Exception => e
-          ERROR("Rusen: #{e.message} prevented the io notifier from login the error.")
+          warn("Rusen: #{e.message} prevented the io notifier from login the error.")
         end
       end
 

data/lib/rusen/settings.rb

@@ -8,31 +8,71 @@ module Rusen
     attr_writer :exception_recipients
     attr_writer :sections
     attr_writer :smtp_settings
+    attr_writer :exclude_if
 
+    # Returns the configured outputs.
+    #
+    # Default: [:io, :email]
+    #
+    # @return [Array<Symbol>]
     def outputs
       @outputs || [:io, :email]
     end
 
+    # Returns the notification email prefix.
+    #
+    # Default: '[Exception] '
+    #
+    # @return [String]
     def email_prefix
       @email_prefix || '[Exception] '
     end
 
+    # Returns the notification email sender.
+    #
+    # Default: ''
+    #
+    # @return [String]
     def sender_address
       @sender_address || ''
     end
 
+    # Returns the notification email recipients.
+    #
+    # Default: []
+    #
+    # @return [Array<String>]
     def exception_recipients
       @exception_recipients || []
     end
 
+    # Returns the configured sections.
+    #
+    # Default: [:backtrace, :request, :session, :environment]
+    #
+    # @return [Array<Symbol>]
     def sections
       @sections || [:backtrace, :request, :session, :environment]
     end
 
+    # Returns the email smtp settings.
+    #
+    # Default: {}
+    #
+    # @return [Hash<Symbol, Object>]
     def smtp_settings
       @smtp_settings || {}
     end
 
+    # Returns whether to send or not the notification for a exception.
+    #
+    # Default: lambda { |exception| false }
+    #
+    # @return [Block]
+    def exclude_if
+      @exclude_if || lambda { |exception| false }
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rusen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: