rusen 0.0.2 → 0.0.3

data/lib/rusen/notification.rb

@@ -5,13 +5,21 @@ module Rusen
 
     attr_reader :exception, :request, :environment, :session
 
-    def initialize(exception, request = nil, environment = nil, session = nil)
-      @exception = exception
-      @request = request || {}
-      @environment = environment  || {}
-      @session = session || {}
+    def initialize(exception, request = {} , environment = {}, session = {})
+      @exception   = exception
+      @request     = request
+      @environment = environment
+      @session     = session
+    end
+
+    def session
+      if @session.respond_to?(:each)
+        @session
+      else
+        @session.to_hash
+      end
     end
 
   end
 
-end
+end

data/lib/rusen/notifier.rb

@@ -1,6 +1,5 @@
+require 'rusen/notifiers'
 require 'rusen/notification'
-require 'rusen/notifiers/io_notifier'
-require 'rusen/notifiers/email_notifier'
 
 module Rusen
 
@@ -10,11 +9,20 @@ module Rusen
       @settings = settings
 
       @notifiers = []
-      Notifiers.constants.each do |constant|
-        klass = Notifiers.const_get(constant)
-        if  @settings.outputs.include?(klass.identification_symbol)
-          register(klass)
+      @settings.outputs.each do |ident|
+        ident = Notifiers.check_deprecation(ident)
+        # For notifiers bundled in this gem
+        klass = Notifiers.load_klass(ident)
+        if klass.nil?
+          Notifiers.constants.each do |constant|
+            klass = Notifiers.const_get(constant)
+            next unless klass.is_a?(Class)
+            break if ident == klass.identification_symbol
+            klass = nil
+          end
         end
+        raise "Unable to load Output Notifier identified by: #{ident}" if klass.nil? || !klass.is_a?(Class)
+        register(klass)
       end
     end
 
@@ -28,7 +36,7 @@ module Rusen
     # @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)
+    def notify(exception, request = {}, environment = {}, session = {})
       begin
         notification = Notification.new(exception, request, environment, session)
 

data/lib/rusen/notifiers.rb

@@ -0,0 +1,29 @@
+module Rusen
+  module Notifiers
+
+    NOTIFIERS = {
+      :pony =>  :PonyNotifier,
+      :mail =>  :MailNotifier,
+      :io =>    :IONotifier,
+      :log4r => :Log4rNotifier,
+    }
+
+    def self.load_klass(ident, klass_sym = nil)
+      klass_sym ||= NOTIFIERS[ident]
+      if klass_sym
+        require "rusen/notifiers/#{ident}_notifier" unless Notifiers.constants.include?(klass_sym)
+        Notifiers.const_get(klass_sym)
+      else
+        return nil
+      end
+    end
+
+    def self.check_deprecation(ident)
+      if ident == :email
+        warn ':email is a deprecated output type. :pony replaces :email.  A new alternative is :mail (mail gem).'
+        return :pony
+      end
+      return ident
+    end
+  end
+end

data/lib/rusen/notifiers/base_notifier.rb

@@ -0,0 +1,53 @@
+require 'erb'
+require_relative '../utils/parameter_filter'
+
+module Rusen
+  module Notifiers
+
+    class BaseNotifier
+
+      def self.identification_symbol
+        :base_notifier
+      end
+
+      def initialize(settings)
+        @settings = settings.dup
+      end
+
+      def get_sessions(notification)
+        result = {}
+
+        include_session(result, notification.exception.backtrace, :backtrace)
+        include_session(result, notification.request,             :request)
+        include_session(result, notification.session,             :session)
+        include_session(result, notification.environment,         :environment)
+
+        result
+      end
+
+      def handle_notification_exception(exception)
+        name = self.class.identification_symbol.to_s
+
+        warn("Rusen: #{exception.message} prevented the #{name} notifier from login the error.")
+      end
+
+      private
+
+      def include_session(sessions, session, session_key)
+        @settings.sections
+
+        if @settings.sections.include?(session_key) && session
+          session = parameter_filter.filter(session) if session_key != :backtrace
+
+          sessions[session_key.to_s.capitalize] = session
+        end
+      end
+
+      def parameter_filter
+        @parameter_filter ||= ParameterFilter.new(@settings.filter_parameters)
+      end
+
+    end
+
+  end
+end

data/lib/rusen/notifiers/io_notifier.rb

@@ -1,7 +1,9 @@
+require_relative 'base_notifier'
+
 module Rusen
   module Notifiers
 
-    class IONotifier
+    class IONotifier < BaseNotifier
 
       STDOUT = $stdout
 
@@ -10,58 +12,31 @@ module Rusen
       end
 
       def initialize(settings, output = STDOUT)
-        @settings = settings
-        @output = output
+        super(settings)
+        @output   = output
       end
 
       def notify(notification)
-        begin
-          if @settings.sections.include?(:backtrace)
-
-            print_title('Backtrace')
-
-            @output.puts notification.exception.message
-            @output.puts notification.exception.backtrace
-          end
-
-          if @settings.sections.include?(:request)
-            print_title('Request')
-
-            print_hash(notification.request)
-          end
-
-          if @settings.sections.include?(:session)
-            print_title('Session')
-
-            print_hash(notification.session)
-          end
-
-          if @settings.sections.include?(:environment)
-            print_title('Environment')
-
-            print_hash(notification.environment)
-          end
+        @notification = notification
+        @sessions     = get_sessions(@notification)
 
         # We need to ignore all the exceptions thrown by IONotifier#notify.
-        rescue Exception => e
-          warn("Rusen: #{e.message} prevented the io notifier from login the error.")
-        end
+        @output.puts build_content
+      rescue Exception => exception
+        handle_notification_exception(exception)
       end
 
       private
 
-      def print_title(title)
-        @output.puts '-------------------------------'
-        @output.puts "#{title}:"
-        @output.puts '-------------------------------'
-      end
+      def build_content
+        template_path = File.expand_path('../../templates/io_template.txt.erb', __FILE__)
 
-      def print_hash(hash)
-        hash.each.each do |k, v|
-          @output.puts "#{k}\t\t\t#{v}"
-        end
+        template = File.open(template_path).read
+        rhtml = ERB.new(template, nil, '-')
+        rhtml.result(binding)
       end
+
     end
 
   end
-end
+end

data/lib/rusen/notifiers/log4r_notifier.rb

@@ -0,0 +1,70 @@
+require_relative 'base_notifier'
+
+begin
+  require 'log4r'
+  require 'log4r/yamlconfigurator'
+rescue LoadError
+  puts <<-MESSAGE
+  [Rusen Error] To use log4r notifier add this to your Gemfile:
+    gem 'log4r'
+  MESSAGE
+  raise
+end
+
+module Rusen
+  module Notifiers
+
+    class Log4rNotifier < BaseNotifier
+
+      def self.identification_symbol
+        :log4r
+      end
+
+      def initialize(settings)
+        super(settings)
+
+        load_config(@settings.log4r_config_file)
+
+        @logger = logger_instance(@settings.logger_name)
+      end
+
+      def notify(notification)
+        @notification = notification
+        @sessions     = get_sessions(@notification)
+
+        # We need to ignore all the exceptions thrown by Log4rNotifier#notify.
+        @logger.error { build_content }
+      rescue Exception => exception
+        handle_notification_exception(exception)
+      end
+
+      private
+
+      def build_content
+        template_path = File.expand_path('../../templates/log4r_template.txt.erb', __FILE__)
+
+        template = File.open(template_path).read
+        rhtml = ERB.new(template, nil, '-')
+        rhtml.result(binding)
+      end
+
+      def logger_instance(name = nil)
+        if name
+          Log4r::Logger[name]
+        else
+          Log4r::Logger.root
+        end
+      end
+
+      # Loads the given config file.
+      #
+      # @param [String] config_yml Configuration file path.
+      def load_config(config_yml)
+        if config_yml
+          Log4r::YamlConfigurator.load_yaml_file(config_yml)
+        end
+      end
+    end
+
+  end
+end

data/lib/rusen/notifiers/mail_notifier.rb

@@ -0,0 +1,86 @@
+require_relative 'base_notifier'
+
+begin
+  require 'mail'
+rescue LoadError
+  puts <<-MESSAGE
+  [Rusen Error] To use Mail notifier add this to your Gemfile:
+    gem 'mail'
+  MESSAGE
+  raise
+end
+
+module Rusen
+  module Notifiers
+
+    class MailNotifier < BaseNotifier
+
+      def self.identification_symbol
+        :mail
+      end
+
+      def initialize(settings)
+        super(settings)
+
+        if @settings && @settings.smtp_settings.any?
+          smtp_settings = @settings.smtp_settings
+
+          Mail.defaults do
+            delivery_method :smtp, smtp_settings
+          end
+        end
+      end
+
+      def notify(notification)
+        @notification = notification
+        @sessions     = get_sessions(@notification)
+
+        options = email_options.dup
+        options.merge!({:body => build_body})
+        mail = Mail.new do
+          from      options[:from]
+          to        options[:to]
+          reply_to  options[:reply_to]
+          cc        options[:cc]
+          bcc       options[:bcc]
+          subject   options[:subject]
+          html_part do
+            content_type "text/html; charset=#{options[:charset]}"
+            body    options[:body]
+          end
+        end
+
+        # We need to ignore all the exceptions thrown by MailNotifier#notify.
+        mail.deliver!
+      rescue Exception => exception
+        handle_notification_exception(exception)
+      end
+
+      private
+
+      def email_options
+        {
+          :to => @settings.exception_recipients,
+          :charset => 'UTF-8',
+          :from => @settings.sender_address,
+          :subject => email_subject
+        }
+      end
+
+      def email_subject
+        @settings.email_prefix + "#{@notification.exception.class}: #{@notification.exception.message}"
+      end
+
+      def build_body
+        template_path = File.expand_path('../../templates/email_template.html.erb', __FILE__)
+
+        template = File.open(template_path).read
+        rhtml = ERB.new(template, nil, '-')
+        rhtml.result(binding)
+      end
+
+    end
+
+  end
+
+end

data/lib/rusen/notifiers/{email_notifier.rb → pony_notifier.rb}

@@ -1,30 +1,32 @@
-require 'pony'
-require 'erb'
+require_relative 'base_notifier'
+
+begin
+  require 'pony'
+rescue LoadError
+  puts <<-MESSAGE
+  [Rusen Error] To use Pony notifier add this to your Gemfile:
+    gem 'pony'
+  MESSAGE
+  raise
+end
 
 module Rusen
   module Notifiers
 
-    class EmailNotifier
+    class PonyNotifier < BaseNotifier
 
       def self.identification_symbol
-        :email
-      end
-
-      def initialize(settings)
-        @settings = settings
+        :pony
       end
 
       def notify(notification)
-        begin
-          @notification = notification
+        @notification = notification
+        @sessions     = get_sessions(@notification)
 
-          Pony.mail(email_options.merge({:body => build_body}))
-
-        # We need to ignore all the exceptions thrown by EmailNotifier#notify.
-        rescue Exception => e
-          warn("Rusen: #{e.class}: #{e.message} prevented the notification email from being sent.")
-          puts e.backtrace
-        end
+        # We need to ignore all the exceptions thrown by PonyNotifier#notify.
+        Pony.mail(email_options.merge({:body => build_body}))
+      rescue Exception => exception
+        handle_notification_exception(exception)
       end
 
       private
@@ -32,7 +34,7 @@ module Rusen
       def email_options
         {
           :to => @settings.exception_recipients,
-          :via => :smtp,
+          :via => @settings.email_via,
           :charset => 'utf-8',
           :from => @settings.sender_address,
           :headers => { 'Content-Type' => 'text/html' },
@@ -49,11 +51,12 @@ module Rusen
         template_path = File.expand_path('../../templates/email_template.html.erb', __FILE__)
 
         template = File.open(template_path).read
-        rhtml = ERB.new(template)
+        rhtml = ERB.new(template, nil, '-')
         rhtml.result(binding)
       end
 
     end
 
   end
+
 end