rusen 0.0.1

data/lib/rusen.rb

@@ -0,0 +1,18 @@
+require 'rusen/settings'
+require 'rusen/notifier'
+#require 'rusen/notification'
+
+module Rusen
+
+  @settings = Settings.new
+  @notifier = Notifier.new(@settings)
+
+  def self.settings
+    @settings
+  end
+
+  def self.notify(exception, request = nil, environment = nil, session = nil)
+    @notifier.notify(exception, request, environment, session)
+  end
+
+end

data/lib/rusen/middleware/rusen_rack.rb

@@ -0,0 +1,38 @@
+require 'rusen/settings'
+require 'rusen/notifier'
+require 'rusen/notification'
+
+module Rusen
+  module Middleware
+
+    class RusenRack
+      def initialize(app, settings = {})
+        @app = app
+
+        @rusen_settings = Settings.new
+
+        @rusen_settings.outputs = settings[:outputs]
+        @rusen_settings.sections = settings[:sections]
+        @rusen_settings.email_prefix = settings[:email_prefix]
+        @rusen_settings.sender_address = settings[:sender_address]
+        @rusen_settings.exception_recipients = settings[:exception_recipients]
+        @rusen_settings.smtp_settings = settings[:smtp_settings]
+
+        @notifier = Notifier.new(@rusen_settings)
+      end
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Exception => error
+          request = Rack::Request.new(env)
+
+          @notifier.notify(error, request.GET.merge(request.POST), env, request.session)
+
+          raise
+        end
+      end
+    end
+
+  end
+end

data/lib/rusen/notification.rb

@@ -0,0 +1,16 @@
+module Rusen
+
+  class Notification
+
+    attr_reader :exception, :request, :environment, :session
+
+    def initialize(exception, request = nil, environment = nil, session = nil)
+      @exception = exception
+      @request = request || {}
+      @environment = environment  || {}
+      @session = session || {}
+    end
+
+  end
+
+end

data/lib/rusen/notifier.rb

@@ -0,0 +1,41 @@
+require 'rusen/notification'
+require 'rusen/notifiers/io_notifier'
+require 'rusen/notifiers/email_notifier'
+
+module Rusen
+
+  class Notifier
+
+    def initialize(settings)
+      @settings = settings
+
+      @notifiers = []
+      Notifiers.constants.each do |constant|
+        klass = Notifiers.const_get(constant)
+        if  @settings.outputs.include?(klass.identification_symbol)
+          register(klass)
+        end
+      end
+    end
+
+    def register(notifier_class)
+      @notifiers << notifier_class.new(@settings)
+    end
+
+    def notify(exception, request = nil, environment = nil, session = nil)
+      begin
+        notification = Notification.new(exception, request, environment, session)
+
+        @notifiers.each do |notifier|
+          notifier.notify(notification)
+        end
+
+      # 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.")
+      end
+    end
+
+  end
+
+end

data/lib/rusen/notifiers/email_notifier.rb

@@ -0,0 +1,58 @@
+require 'pony'
+require 'erb'
+
+module Rusen
+  module Notifiers
+
+    class EmailNotifier
+
+      def self.identification_symbol
+        :email
+      end
+
+      def initialize(settings)
+        @settings = settings
+      end
+
+      def notify(notification)
+        begin
+          @notification = notification
+
+          Pony.mail(email_options.merge({:body => build_body}))
+
+        # 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.")
+        end
+      end
+
+      private
+
+      def email_options
+        {
+          :to => @settings.exception_recipients,
+          :via => :smtp,
+          :charset => 'utf-8',
+          :from => @settings.sender_address,
+          :headers => { 'Content-Type' => 'text/html' },
+          :via_options =>  @settings.smtp_settings,
+          :subject => email_subject.force_encoding('UTF-8')
+        }
+      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)
+        rhtml.result(binding)
+      end
+
+    end
+
+  end
+end

data/lib/rusen/notifiers/io_notifier.rb

@@ -0,0 +1,67 @@
+module Rusen
+  module Notifiers
+
+    class IONotifier
+
+      STDOUT = $stdout
+
+      def self.identification_symbol
+        :io
+      end
+
+      def initialize(settings, output = STDOUT)
+        @settings = 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
+
+        # 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.")
+        end
+      end
+
+      private
+
+      def print_title(title)
+        @output.puts '-------------------------------'
+        @output.puts "#{title}:"
+        @output.puts '-------------------------------'
+      end
+
+      def print_hash(hash)
+        hash.each.each do |k, v|
+          @output.puts "#{k}\t\t\t#{v}"
+        end
+      end
+    end
+
+  end
+end

data/lib/rusen/settings.rb

@@ -0,0 +1,38 @@
+module Rusen
+
+  class Settings
+
+    attr_writer :outputs
+    attr_writer :email_prefix
+    attr_writer :sender_address
+    attr_writer :exception_recipients
+    attr_writer :sections
+    attr_writer :smtp_settings
+
+    def outputs
+      @outputs || [:io, :email]
+    end
+
+    def email_prefix
+      @email_prefix || '[Exception] '
+    end
+
+    def sender_address
+      @sender_address || ''
+    end
+
+    def exception_recipients
+      @exception_recipients || []
+    end
+
+    def sections
+      @sections || [:backtrace, :request, :session, :environment]
+    end
+
+    def smtp_settings
+      @smtp_settings || {}
+    end
+
+  end
+
+end

data/lib/rusen/templates/email_template.html.erb

@@ -0,0 +1,77 @@
+<%= @notification.exception.class %>: <%= @notification.exception.message %>
+
+<% if @settings.sections.include?(:backtrace) %>
+<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
+  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
+  <tr>
+    <td><h4>Backtrace:</h4></td>
+    <td></td>
+  </tr>
+  </thead>
+  <tbody style="font-size: 11pt;">
+  <%  @notification.exception.backtrace.each do |backtrace_step| %>
+    <tr>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= backtrace_step %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<% end %>
+
+<% if @settings.sections.include?(:request) %>
+<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
+  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
+  <tr>
+    <td><h4>Request:</h4></td>
+    <td></td>
+  </tr>
+  </thead>
+  <tbody style="font-size: 11pt;">
+  <% @notification.request.each do |k, v| %>
+    <tr>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= k %></td>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= v %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<% end %>
+
+<% if @settings.sections.include?(:session) %>
+<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
+  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
+  <tr>
+    <td><h4>Session:</h4></td>
+    <td></td>
+  </tr>
+  </thead>
+  <tbody style="font-size: 11pt;">
+  <% @notification.session.each do |k, v| %>
+    <tr>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= k %></td>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= v %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<% end %>
+
+
+<% if @settings.sections.include?(:environment) %>
+<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
+  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
+  <tr>
+    <td><h4>Environment:</h4></td>
+    <td></td>
+  </tr>
+  </thead>
+  <tbody style="font-size: 11pt;">
+  <% @notification.environment.each do |k, v| %>
+    <tr>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= k %></td>
+      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= v %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<% end %>

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rusen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adrian Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "RUby Simple Exception Notification (a.k.a. rusen) as it names indicates
+  is a\n                       simple exception notification for ruby."
+email: adri4n.gomez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rusen.rb
+- lib/rusen/templates/email_template.html.erb
+- lib/rusen/notifier.rb
+- lib/rusen/settings.rb
+- lib/rusen/notifiers/io_notifier.rb
+- lib/rusen/notifiers/email_notifier.rb
+- lib/rusen/notification.rb
+- lib/rusen/middleware/rusen_rack.rb
+homepage: https://github.com/Moove-it/rusen
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RUby Simple Exception Notification
+test_files: []