rusen 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8007268459cd1078eff76f223cfe229d339bf192
-  data.tar.gz: fffeb7697f8d8c3cb435ba305212717b653d2542
+  metadata.gz: d18a8ccbea67e8e8184a57efb47503278bf4879c
+  data.tar.gz: e8d36b8b4b9ab007e9680706adfdfcf806a5506e
 SHA512:
-  metadata.gz: f948a54c1cfa25060dd16e7ce9946caa3e63e3b93ad97287bc2fb812bcd343faaa6d87c6ce1c970829cccc185fb3c9ce7abb5ebb42a04268ea327ffbf6a956f0
-  data.tar.gz: 06c641e4bcdecc748e3ff5a2a3f92fc23deefc8ffab8415aeb0cc3f0d23ea5d0fe1972d1a47b84cb5ab36c16bf15894c5d132e261efccfec61b82b0ce24a36cc
+  metadata.gz: fadc00a89b991a47da2460a9dacb3a360b47ca0549d03c9a7f0636e7aaa82e0ba4f4ce07e59100eecaee2f53c94a5d790f02188a9c22ef6e9a49887ec6b34b2e
+  data.tar.gz: ab9c7a8bf899b43dcd09cdb2a26e2651578c1c200d7b8475d1629f7a425372119088ccd58d9fa8e4040f23e6dbb3d0dad0fd139c51e65d2fc8d362fea25036cc

data/CHANGELOG.md

@@ -1,23 +1,35 @@
-## HEAD
-- Moved presentation to templates by Adrian Gomez
-- Improve specs by Adrian Gomez
-- Fix default params by Adrian Gomez
-- Add log4r support by Adrian Gomez
-- Fix gemspec by Peter Boling
-- Add LICENSE (MIT) by Peter Boling
-- Make VERSION accessible from Ruby (compatible with gem-release) by Peter Boling
-- Added Trvis-CI and Coveralls integration by Peter Boling
-- Added Rakefile by Peter Boling
-- Test against RUby 1.8.7, 1.9.2, 1.9.3, 2.0.0, and jRuby19 by Peter Boling
-- Added MailNotifier (for Mail gem) by Peter Boling
-- Made mail and pony gems not explicit dependencies; notifiers are loaded dynamically by Peter Boling
-- Settings.outputs needs to default to [] in order for the gem to have no default dependencies by Peter Boling
-
-## 0.0.2 (2013-01-28)
-- Fix when a notificator can't notify by Adrian Gomez
-- Added documentation by Adrian Gomez
-- Added possibility to skip notification of certain errors by Adrian Gomez
-
-## 0.0.1 (2013-01-28)
-
-First release by Adrian Gomez
+# Change Log
+
+## [Unreleased](https://github.com/moove-it/rusen/tree/HEAD)
+
+[Full Changelog](https://github.com/moove-it/rusen/compare/v0.0.2...HEAD)
+
+**Closed issues:**
+
+- Allow sendmail [\#9](https://github.com/moove-it/rusen/issues/9)
+
+**Merged pull requests:**
+
+- Adding a png logo to use on the README.md [\#17](https://github.com/moove-it/rusen/pull/17) ([elpic](https://github.com/elpic))
+- Update CI settings [\#16](https://github.com/moove-it/rusen/pull/16) ([adrian-gomez](https://github.com/adrian-gomez))
+- New Rusen page [\#15](https://github.com/moove-it/rusen/pull/15) ([imNicoSuarez](https://github.com/imNicoSuarez))
+- Allow to omit the optional arguments without errors in Rusen.notify [\#14](https://github.com/moove-it/rusen/pull/14) ([shhavel](https://github.com/shhavel))
+- Change RusenRack to take into account :filter\_parameters option. [\#13](https://github.com/moove-it/rusen/pull/13) ([snmgian](https://github.com/snmgian))
+- Not sending sensitive data on notifications [\#12](https://github.com/moove-it/rusen/pull/12) ([elpic](https://github.com/elpic))
+- Add support for sidekiq. [\#11](https://github.com/moove-it/rusen/pull/11) ([adrian-gomez](https://github.com/adrian-gomez))
+- Add email\_via setting. [\#10](https://github.com/moove-it/rusen/pull/10) ([adrian-gomez](https://github.com/adrian-gomez))
+- Allow sending an instance of Rusen::Settings to the middleware [\#7](https://github.com/moove-it/rusen/pull/7) ([elpic](https://github.com/elpic))
+- Mail notifier [\#6](https://github.com/moove-it/rusen/pull/6) ([pboling](https://github.com/pboling))
+- Just housekeeping. [\#5](https://github.com/moove-it/rusen/pull/5) ([pboling](https://github.com/pboling))
+- Add log4r support. [\#4](https://github.com/moove-it/rusen/pull/4) ([snmgian](https://github.com/snmgian))
+- Fix Rusen::Notifier\#notifty default params. [\#3](https://github.com/moove-it/rusen/pull/3) ([snmgian](https://github.com/snmgian))
+- Fix tests, minor refactoring. [\#2](https://github.com/moove-it/rusen/pull/2) ([snmgian](https://github.com/snmgian))
+- improve some sintax and wording for README [\#1](https://github.com/moove-it/rusen/pull/1) ([ssuttner](https://github.com/ssuttner))
+
+## [v0.0.2](https://github.com/moove-it/rusen/tree/v0.0.2) (2013-01-28)
+[Full Changelog](https://github.com/moove-it/rusen/compare/v0.0.1...v0.0.2)
+
+## [v0.0.1](https://github.com/moove-it/rusen/tree/v0.0.1) (2013-01-28)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -1,23 +1,33 @@
-[RU]by [S]imple [E]xception [N]otification
-====
-
-The Ruby Simple Exception Notification (a.k.a Rusen) gem provides a simple way for logging and sending errors in any ruby application.
-
-The notification includes information about the current request, session, environment and also gives a backtrace of the exception.
-
-| Project                 |  Rusen   |
-|------------------------ | ----------------- |
-| gem name                |  rusen   |
-| license                 |  MIT              |
-| moldiness               |  [![Maintainer Status](http://stillmaintained.com/Moove-it/rusen.png)](http://stillmaintained.com/Moove-it/rusen) |
-| version                 |  [![Gem Version](https://badge.fury.io/rb/rusen.png)](http://badge.fury.io/rb/rusen) |
-| dependencies            |  [![Dependency Status](https://gemnasium.com/Moove-it/rusen.png)](https://gemnasium.com/Moove-it/rusen) |
-| code quality            |  [![Code Climate](https://codeclimate.com/github/Moove-it/rusen.png)](https://codeclimate.com/github/Moove-it/rusen) |
-| continuous integration  |  [![Build Status](https://secure.travis-ci.org/Moove-it/rusen.png?branch=master)](https://travis-ci.org/Moove-it/rusen) |
-| test coverage           |  [![Coverage Status](https://coveralls.io/repos/Moove-it/rusen/badge.png)](https://coveralls.io/r/Moove-it/rusen) |
-| homepage                |  [https://github.com/Moove-it/rusen][homepage] |
-| documentation           |  [http://rdoc.info/github/Moove-it/rusen/frames][documentation] |
-| author                  |  [Adrian Gomez](https://coderbits.com/Moove-it) |
+<p align="center">
+  <a href="http://moove-it.github.io/rusen/">
+    <img src="https://moove-it.github.io/rusen/images/logo.png" alt="Rusen" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://badge.fury.io/rb/rusen">
+    <img src="https://badge.fury.io/rb/rusen.png" alt="Gem Version">
+  </a>
+  <a href="https://codeclimate.com/github/Moove-it/rusen">
+    <img src="https://codeclimate.com/github/Moove-it/rusen.png" alt="Code Climate">
+  </a>
+  <a href="https://travis-ci.org/moove-it/rusen">
+    <img src="https://secure.travis-ci.org/moove-it/rusen.png?branch=master" alt="Build Status">
+  </a>
+  <a href="https://coveralls.io/github/moove-it/rusen?branch=master">
+    <img src="https://coveralls.io/repos/moove-it/rusen/badge.svg?branch=master&service=github" alt="Coverage Status">
+  </a>
+  <a href="https://inch-ci.org/github/moove-it/rusen">
+    <img src="https://inch-ci.org/github/moove-it/rusen.svg?branch=master" alt="Documentation Coverage">
+  </a>
+  <a href="http://www.rubydoc.info/github/moove-it/rusen">
+    <img src="https://img.shields.io/badge/yard-docs-blue.svg" alt="Documentation">
+  </a>
+</p>
+
+The Ruby Simple Exception Notification (a.k.a Rusen) gem provides a simple way for logging and sending errors in any Ruby application.
+
+Notifications include information about the current request, session, environment. They also provide a backtrace of the exception.
 
 Installation
 ---
@@ -36,25 +46,25 @@ Usage
 The easiest way to use it is with global configuration.
 
 First you configure Rusen
+
 ```ruby
 require 'rusen'
 
-Rusen.settings.outputs = [:io, :email]
-Rusen.settings.sections = [:backtrace, :request, :session, :environment]
-Rusen.settings.email_prefix = '[ERROR] '
-Rusen.settings.sender_address = 'some_email@example.com'
-Rusen.settings.exception_recipients = %w(dev_team@example.com test_team@example.com)
+Rusen.settings.sender_address = 'oops@example.org'
+Rusen.settings.exception_recipients = %w(dev_team@example.org)
 Rusen.settings.smtp_settings = {
   :address              => 'smtp.gmail.com',
   :port                 => 587,
   :domain               => 'example.org',
   :authentication       => :plain,
-  :user_name            => 'dev_team@moove-it.com',
+  :user_name            => 'dev_team@example.org',
   :password             => 'xxxxxxx',
   :enable_starttls_auto => true
 }
 ```
-And the you can start sending notifications:
+
+And then you can start sending notifications:
+
 ```ruby
 begin
   method.call
@@ -62,54 +72,42 @@ rescue Exception => exception
   Rusen.notify(exception)
 end
 ```
-This way, if you modify the notifications settings at runtime, every notification sent afterwards will use the new settings.
+
+This way, if you modify the notifications settings at runtime, every notification sent afterwards will use the new 
+settings.
 
 ### With local configuration
 
-This method lets you have more control when notifying. You may want for example to send an email when a particular exception occurs and just print to stdout otherwise.
+This method lets you have more control when notifying. You may want for example to send an email when a particular 
+exception occurs and just print to stdout otherwise.
 To achieve this you can do the following:
+
 ```ruby
-@email_settings = Settings.new
-@email_settings.outputs = settings[:email]
-Rusen.settings.sections = [:backtrace, :request, :session]
-@email_settings.email_prefix = '[ERROR] '
-@email_settings.sender_address = 'some_email@example.com'
-@email_settings.exception_recipients = %w(dev_team@example.com test_team@example.com)
-@email_settings.smtp_settings = {
-                                  :address              => 'smtp.gmail.com',
-                                  :port                 => 587,
-                                  :domain               => 'example.org',
-                                  :authentication       => :plain,
-                                  :user_name            => 'dev_team@moove-it.com',
-                                  :password             => 'xxxxxxx',
-                                  :enable_starttls_auto => true
-                                }
-
-@email_notifier = Notifier.new(@email_settings)
-
-@stdout_settings = Settings.new
-@stdout_settings.outputs = settings[:io]
-Rusen.settings.sections = [:backtrace]
-
-@stdout_notifier = Notifier.new(@stdout_settings)
+@email_notifier = Rusen::Notifier.new(@email_settings)
+
+@stdout_settings = Rusen::Settings.new
+@stdout_settings.outputs = [:backtrace]
+
+@stdout_notifier = Rusen::Notifier.new(@stdout_settings)
 ```
+
 and then:
 ```ruby
 begin
   method.call
 rescue SmallException => exception
   @stdout_notifier.notify(exception)
-rescue BigException => exception
-  @email_notifier.notify(exception)
 end
 ```
 
 Middleware
 ---
-Rusen comes with a rack and rails special (soon to come) middleware for easy usage.
+Rusen comes with a Rack and rails special (soon to come) middleware for easy usage.
 
 ### Rack
-To use Rusen in any rack application you just have to add the following code somewhere in your app (ex: config/initializers/rusen.rb):
+To use Rusen in any Rack application you just have to add the following code somewhere in your app 
+(ex: config/initializers/rusen.rb):
+
 ```ruby
 require 'rusen/middleware/rusen_rack'
 
@@ -117,56 +115,71 @@ use Rusen::Middleware::RusenRack,
     :outputs => [:io, :email],
     :sections => [:backtrace, :request, :session, :environment],
     :email_prefix => '[ERROR] ',
-    :sender_address => 'some_email@example.com',
-    :exception_recipients => %w(dev_team@example.com test_team@example.com),
+    :sender_address => 'oops@example.org',
+    :exception_recipients => %w(dev_team@example.org),
     :smtp_settings => {
-                        :address              => 'smtp.gmail.com',
-                        :port                 => 587,
-                        :domain               => 'example.org',
-                        :authentication       => :plain,
-                        :user_name            => 'dev_team@moove-it.com',
-                        :password             => 'xxxxxxx',
-                        :enable_starttls_auto => true
-                      }
+      :address              => 'smtp.gmail.com',
+      :port                 => 587,
+      :domain               => 'example.org',
+      :authentication       => :plain,
+      :user_name            => 'dev_team@example.org',
+      :password             => 'xxxxxxx',
+      :enable_starttls_auto => true
+    }
 ```
+
 This will capture any unhandled exception, send an email and write a trace in stdout.
 
 Settings
 ---
+
 ### Outputs
-Currently supported outputs are :io, :lo4r, :pony and :mail. More outputs are easy to add so you can customize Rusen to your needs.
 
-Note: :io will only print to stdout for the time being, but there are plans to extend it to anything that Ruby::IO supports.
+Currently supported outputs are :io, :lo4r, :pony and :mail. More outputs are easy to add so you can customize Rusen to 
+your needs.
+
+Note: :io will only print to stdout for the time being, but there are plans to extend it to anything that Ruby::IO 
+supports.
 
 Pony, lo4r and Mail outputs require additional gems to work.
 
-To use pony add this to your Gemfile:
+To use Pony add this to your Gemfile:
+
 ```ruby
   gem 'pony'
 ```
 
-To use mail add this to your Gemfile:
+To use mail, add this to your Gemfile:
+
 ```ruby
   gem 'mail'
 ```
 
-To use log4r add this to your Gemfile:
+To use log4r, add this to your Gemfile:
+
 ```ruby
   gem 'log4r'
 ```
 
 ### Sections
+
 You can choose the output sections simply by setting the appropriate values in the configuration.
 
 ### Exclude if
+
 Here you can pass a block that will receive the error. If the block returns false, then the error will be notified.
 
 ### Email settings
-All the email settings are self explanatory, but you can contact me if any of them needs clarification.
+
+All the email settings are self explanatory, but you can contact hello+rusen@moove-it.com if any of them needs clarification.
+
+If you are running Rusen inside **Rails** and you have configured smtp_settings for your app 
+Rusen will use that settings by default.
 
 ### Log4r settings
+
 * logger_name _(required)_: Logger used for logging errors.
-* log4r_config_file _(optional)_: YAML file that contains Log4r configuration. Rusen will load that file when given.
+* log4r_config_file _(optional)_: YAML file that contains Log4r configuration. 
 
 Sample of Log4r configuration file contents:
 
@@ -191,22 +204,26 @@ log4r_config:
 
 Sidekiq
 ---
+
 Rusen comes with sidekiq integration builtin to use just add this to your sidekiq initializer:
+
 ```ruby
 require 'rusen/sidekiq'
 ```
-You can configure it with the global rusen configuration, ex:
+
+You can configure it with the global Rusen configuration, ex:
+
 ```ruby
 require 'rusen/sidekiq'
 
-Rusen.settings.sender_address = 'some_email@example.com'
-Rusen.settings.exception_recipients = %w(dev_team@example.com test_team@example.com)
+Rusen.settings.sender_address = 'oops@example.org'
+Rusen.settings.exception_recipients = %w(dev_team@example.org)
 Rusen.settings.smtp_settings = {
   :address              => 'smtp.gmail.com',
   :port                 => 587,
   :domain               => 'example.org',
   :authentication       => :plain,
-  :user_name            => 'dev_team@moove-it.com',
+  :user_name            => 'dev_team@example.org',
   :password             => 'xxxxxxx',
   :enable_starttls_auto => true
 }
@@ -214,17 +231,9 @@ Rusen.settings.smtp_settings = {
 
 Rusen supports versions ~> 2 and ~> 3 of sidekiq.
 
-Extending to more outputs
----
-Soon to come!
-
-## Authors
-
-Adrian Gomez is the author of the code, and current maintainer.
-
 ## Contributors
 
-See the [Network View](https://github.com/Moove-it/rusen/network) and the [CHANGELOG](https://github.com/Moove-it/rusen/blob/master/CHANGELOG.md)
+See the [Network View](https://github.com/moove-it/rusen/network) and the [CHANGELOG](https://github.com/moove-it/rusen/blob/master/CHANGELOG.md)
 
 ## Contributing
 
@@ -232,31 +241,12 @@ See the [Network View](https://github.com/Moove-it/rusen/network) and the [CHANG
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-6. Create new Pull Request
-
-## Versioning
-
-This library aims to adhere to [Semantic Versioning 2.0.0][semver].
-Violations of this scheme should be reported as bugs. Specifically,
-if a minor or patch version is released that breaks backward
-compatibility, a new version should be immediately released that
-restores compatibility. Breaking changes to the public API will
-only be introduced with new major versions.
-
-As a result of this policy, you can (and should) specify a
-dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
-
-For example:
-
-    spec.add_dependency 'rusen', '~> 0.0.2'
+5. Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+6. Create a new Pull Request
 
 ## Legal
 
-* MIT License - See LICENSE file in this project
-* Copyright (c) 2013 Adrian Gomez
+Rusen is released under the [MIT License](http://opensource.org/licenses/MIT).
 
-[semver]: http://semver.org/
-[pvc]: http://docs.rubygems.org/read/chapter/16#page74
-[documentation]: http://rdoc.info/github/Moove-it/rusen/frames
-[homepage]: https://github.com/Moove-it/rusen
+[documentation]: http://http://www.rubydoc.info/github/moove-it/rusen
+[homepage]: http://moove-it.github.io/rusen/

data/Rakefile

@@ -51,15 +51,4 @@ namespace :test do
   end
 end
 
-#require File.expand_path('../lib/rusen/version', __FILE__)
-#require 'rdoc'
-#require 'rdoc/task'
-#RDoc::Task.new do |rdoc|
-#  rdoc.rdoc_dir = 'rdoc'
-#  rdoc.title    = "Rusen #{Rusen::VERSION}"
-#  rdoc.options << '--line-numbers'
-#  rdoc.rdoc_files.include('README*')
-#  rdoc.rdoc_files.include('lib/**/*.rb')
-#end
-
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks

data/lib/rusen.rb

@@ -2,6 +2,10 @@ require 'rusen/version'
 require 'rusen/settings'
 require 'rusen/notifier'
 
+# Rusen is a util to help you with the tracking on the
+#   application exceptions, this could be used on any
+#   ruby project. The exceptions can be sent to different
+#   outputs depending on your apps requirements.
 module Rusen
 
   @settings = Settings.new
@@ -16,7 +20,7 @@ module Rusen
   end
 
   # (see Rusen::Notifier#notify)
-  def self.notify(exception, request = nil, environment = nil, session = nil)
+  def self.notify(exception, request = {}, environment = {}, session = {})
     notifier.notify(exception, request, environment, session)
   end
 
@@ -24,4 +28,4 @@ module Rusen
     @notifier || Notifier.new(@settings)
   end
 
-end
+end

data/lib/rusen/middleware/rusen_rack.rb

@@ -11,28 +11,22 @@ module Rusen
         @app = app
 
         if settings.is_a?(::Rusen::Settings)
-          @rusen_settings = settings
-        else
-          @rusen_settings = Settings.new
-
-          @rusen_settings.outputs = settings[:outputs]
-          @rusen_settings.sections = settings[:sections]
-          @rusen_settings.filter_parameters = settings[:filter_parameters]
-          @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]
-          @rusen_settings.exclude_if = settings[:exclude_if]
+          @settings = settings
+        elsif settings.is_a?(Hash)
+          @settings = ::Rusen::Settings.new(settings)
         end
 
-        @notifier = Notifier.new(@rusen_settings)
+        @notifier = ::Rusen::Notifier.new(@settings) if @settings
       end
 
       def call(env)
         begin
           @app.call(env)
         rescue Exception => error
-          unless @rusen_settings.exclude_if.call(error)
+          @notifier ||= Rusen.notifier
+          @settings ||= Rusen.settings
+
+          if @settings && !@settings.exclude_if.call(error)
             request = Rack::Request.new(env)
             @notifier.notify(error, request.GET.merge(request.POST), env, request.session)
           end

data/lib/rusen/middleware/rusen_sidekiq.rb

@@ -3,10 +3,23 @@ require 'sidekiq'
 
 module Rusen
   module Middleware
+
+    # Intersect exceptions that happens on inside
+    #   sidekiq workers. If an exception occurred
+    #   on a worker Rusen will notify about that
+    #   exception and will raised up.
     class RusenSidekiq
       include Sidekiq::Util
 
-      def call(worker, msg, queue, &block)
+      # Just yield the block and rescue from any
+      #   exception that occurred on the call to
+      #   the worker, and notify about that
+      #   exception.
+      #
+      # @raise [Exception] if an exception occurred
+      #   that exception was notified and raised
+      #   again to allow the retry to happen.
+      def call(_, _, _, &block)
         yield
       rescue => error
         Rusen.notify(error)
@@ -16,4 +29,4 @@ module Rusen
 
     end
   end
-end
+end

data/lib/rusen/notifier.rb

@@ -46,10 +46,10 @@ module Rusen
 
       # We need to ignore all the exceptions thrown by the notifiers.
       rescue Exception
-        warn("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
 
   end
 
-end
+end

data/lib/rusen/notifiers.rb

@@ -8,22 +8,27 @@ module Rusen
       :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
+    class << self
+
+      def 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
-    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
+      def 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
-      return ident
+
     end
+
   end
 end

data/lib/rusen/notifiers/base_notifier.rb

@@ -4,16 +4,41 @@ require_relative '../utils/parameter_filter'
 module Rusen
   module Notifiers
 
+    # This class define all the base behaviour of all notifiers,
+    #   for creating new notifiers this class should be
+    #   extended.
     class BaseNotifier
 
-      def self.identification_symbol
-        :base_notifier
+      class << self
+
+        # Symbol that represent the notifier, all subclasses must
+        #   override this method to be correctly identified.
+        #
+        # @return [Symbol]
+        def identification_symbol
+          :base_notifier
+        end
+
       end
 
+      # Create a new instance of a Notifier.
+      #
+      # @param [Rusen::Setting] settings the settings that will be
+      #   used to notify, depending on this configuration is where
+      #   the exception will be notified.
+      #
+      # @return [Rusen::Notifier::BaseNotifier]
       def initialize(settings)
         @settings = settings.dup
       end
 
+      # Given the exception returns all the sessions that will be
+      #   included on the notification.
+      #
+      # @param [Rusen::Notification] notification information that
+      #   will be notified.
+      #
+      # @return [Hash<String, Object>]
       def get_sessions(notification)
         result = {}
 
@@ -25,6 +50,12 @@ module Rusen
         result
       end
 
+      # Some times when we try to notify exceptions an error could
+      #   happen, for example if someone forgot to config the smtp
+      #   settings, if that happens and an exception is raised then
+      #   a warn is logged on the console saying the problem.
+      #
+      # @param [Exception] exception the error that was raised.
       def handle_notification_exception(exception)
         name = self.class.identification_symbol.to_s
 
@@ -33,6 +64,7 @@ module Rusen
 
       private
 
+      # @private
       def include_session(sessions, session, session_key)
         @settings.sections
 
@@ -43,6 +75,7 @@ module Rusen
         end
       end
 
+      # @private
       def parameter_filter
         @parameter_filter ||= ParameterFilter.new(@settings.filter_parameters)
       end
@@ -50,4 +83,4 @@ module Rusen
     end
 
   end
-end
+end

data/lib/rusen/settings.rb

@@ -16,13 +16,26 @@ module Rusen
     attr_accessor :logger_name
     attr_accessor :log4r_config_file
 
+    # Create a new Settings object using the given
+    #   attributes.
+    #
+    # @param [Hash<String, Object>] attrs a hash with the
+    #   options used to create a setting object.
+    def initialize(attrs = {})
+      (attrs || {}).each do |attr_name, value|
+        method_name = "#{attr_name}=".to_sym
+
+        self.send(method_name, value) if self.respond_to?(method_name)
+      end
+    end
+
     # Returns the configured outputs.
     #
-    # Default: []
+    # Default: [:mail]
     #
     # @return [Array<Symbol>]
     def outputs
-      @outputs || []
+      @outputs || [:mail]
     end
 
     # Returns the notification email prefix.
@@ -70,13 +83,17 @@ module Rusen
       @sections || [:backtrace, :request, :session, :environment]
     end
 
-    # Returns the email smtp settings.
-    #
-    # Default: {}
+    # Returns the email smtp settings, if Rusen is included on a Rails
+    #   application the smtp settings for the application is returned,
+    #   otherwise an empty has is returned.
     #
     # @return [Hash<Symbol, Object>]
     def smtp_settings
-      @smtp_settings || {}
+      if @smtp_settings
+        @smtp_settings
+      else
+        (defined?(Rails) && Rails.configuration.action_mailer.smtp_settings) || {}
+      end
     end
 
     # Returns whether to send or not the notification for a exception.
@@ -102,7 +119,7 @@ module Rusen
       if @filter_parameters
         @filter_parameters || []
       else
-        defined?(Rails) && Rails.application.config.filter_parameters
+        defined?(Rails) && Rails.configuration.filter_parameters
       end
     end
 

data/lib/rusen/version.rb

@@ -1,3 +1,3 @@
 module Rusen
-  VERSION='0.0.4'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rusen
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Adrian Gomez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: RUby Simple Exception Notification