rusen 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85f19290071430461d1bee9c0253d1d7031a60d7
+  data.tar.gz: 0b485c11d07d898a8c897db28e515964c23c3bec
+SHA512:
+  metadata.gz: 32cd6604c8f416c84734eb675e4efed7d8fbe9755f1011ce896020f06fc6530ada42374ccb7a1fbc6e190a151160c882b152a5e5002dc64c5029d1a10f9d3bdd
+  data.tar.gz: 1134462504991f8f3ab70b9fd7ee7ee325521b699ad62cba46b35801cee5b1489eef4ed1f344648ead86ded2d096b4b73509fd3358defba71ed2207ce1ca5f90

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## 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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adrian Gomez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,262 @@
+[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) |
+
+Installation
+---
+
+Just add the following line in your Gemfile
+
+```ruby
+gem 'rusen'
+```
+
+Usage
+---
+
+### With global configuration
+
+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.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
+}
+```
+And the you can start sending notifications:
+```ruby
+begin
+  method.call
+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.
+
+### 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.
+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)
+```
+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.
+
+### 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):
+```ruby
+require 'rusen/middleware/rusen_rack'
+
+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),
+    :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
+                      }
+```
+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.
+
+Pony, lo4r and Mail outputs require additional gems to work.
+
+To use pony add this to your Gemfile:
+```ruby
+  gem 'pony'
+```
+
+To use mail add this to your Gemfile:
+```ruby
+  gem 'mail'
+```
+
+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.
+
+### 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.
+
+Sample of Log4r configuration file contents:
+
+```
+log4r_config:
+  loggers:
+    - name: error_notifications
+      level: ERROR
+      trace: false
+      outputters:
+        - logfile
+        - stdoout
+
+  outputters:
+    - type: FileOutputter
+      name: logfile
+      filename: 'log/service.log'
+
+    - type: StdoutOutputter
+      name: stdout
+```
+
+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:
+```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.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
+}
+```
+
+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)
+
+## Contributing
+
+1. Fork it
+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'
+
+## Legal
+
+* MIT License - See LICENSE file in this project
+* Copyright (c) 2013 Adrian Gomez
+
+[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

data/Rakefile

@@ -0,0 +1,65 @@
+# encoding: utf-8
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
+
+namespace :test do
+  desc 'Test against all supported Rails versions'
+  task :all do
+    if RUBY_VERSION == '1.8.7'
+      %w( 2.2.x 2.3.x 3.1.x 3.2.x ).each do |rails_version|
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle --quiet"
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle exec rspec spec"
+      end
+    elsif RUBY_VERSION == '1.9.2'
+      %w( 2.3.x 3.1.x 3.2.x ).each do |rails_version|
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle --quiet"
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle exec rspec spec"
+      end
+    elsif RUBY_VERSION == '1.9.3'
+      %w( 3.1.x 3.2.x 4.0.x ).each do |rails_version|
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle --quiet"
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle exec rspec spec"
+      end
+    elsif RUBY_VERSION == '2.0.0'
+      %w( 3.1.x 3.2.x 4.0.x ).each do |rails_version|
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle --quiet"
+        sh "BUNDLE_GEMFILE='gemfiles/Gemfile.rails-#{rails_version}' bundle exec rspec spec"
+      end
+    end
+  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

data/lib/rusen.rb

@@ -1,10 +1,10 @@
+require 'rusen/version'
 require 'rusen/settings'
 require 'rusen/notifier'
 
 module Rusen
 
   @settings = Settings.new
-  @notifier = Notifier.new(@settings)
 
   # Returns the global settings for rusen.
   #
@@ -17,7 +17,11 @@ module Rusen
 
   # (see Rusen::Notifier#notify)
   def self.notify(exception, request = nil, environment = nil, session = nil)
-    @notifier.notify(exception, request, environment, session)
+    notifier.notify(exception, request, environment, session)
+  end
+
+  def self.notifier
+    @notifier || Notifier.new(@settings)
   end
 
 end

data/lib/rusen/middleware/rusen_rack.rb

@@ -10,15 +10,19 @@ module Rusen
       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]
-        @rusen_settings.exclude_if = settings[:exclude_if]
+        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.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]
+        end
 
         @notifier = Notifier.new(@rusen_settings)
       end

data/lib/rusen/middleware/rusen_sidekiq.rb

@@ -0,0 +1,19 @@
+require 'rusen'
+require 'sidekiq'
+
+module Rusen
+  module Middleware
+    class RusenSidekiq
+      include Sidekiq::Util
+
+      def call(worker, msg, queue, &block)
+        yield
+      rescue => error
+        Rusen.notify(error)
+
+        raise
+      end
+
+    end
+  end
+end