failsafe 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rspec
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - ree
+  - ruby-head
+  - rbx

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec
+gem 'rake'
+
+group :test do
+  gem 'rspec', ">= 2.7"
+  gem 'mocha'
+end

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Alex Sharp
+
+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,64 @@
+[![Build Status](https://secure.travis-ci.org/zaarly/failsafe.png?branch=master)](http://travis-ci.org/zaarly/failsafe)
+
+## What
+
+Failsafe is a tiny library that makes it easy to make sure non-critical exceptions
+don't interrupt program flow. It uses a failure handling system heavily inspired
+by that of [Resque](http://github.com/defunkt/resque). 
+
+You can use failsafe to suppress exceptions from your users, but continue to deliver
+them to your errors backends (log files, airbrake, etc).
+
+## Usage
+
+```ruby
+Failsafe.error_backends << Failsafe::Backends::Stderr
+
+class MyApp < Sinatra::Base
+  get '/' do
+    Failsafe.failsafe { track_some_metrics; raise("boom!") }
+    status(200)
+  end
+end
+```
+
+## Disabling Failsafe
+
+In production, you want your app to keep ticking along when certain exceptions
+occur without missing a beat. However, in development and test environments,
+you probably want to know that exceptions are occurring.
+Use the `disabled` property for that:
+
+```ruby
+if Rails.env.test?
+  Failsafe.disabled = true
+else
+  # not necessary, this is the default setting
+  Failsafe.disabled = false 
+end
+```
+
+## Configuration
+
+Failsafe comes with 3 error backends by default: Airbrake, File, and Stderr.
+You must add them to the failsafe configuration in order to log exceptions
+to them:
+
+```ruby
+Failsafe.error_backends << Failsafe::Backends::Airbrake
+Failsafe.error_backends << Failsafe::Backends::Stderr
+```
+
+## Backends
+
+"Backends" are what your exceptions get handled by instead of letting them
+bubble up to the user. When an exception occurs within a piece of code wrapped
+by failsafe, the exception object is handed to each error backend.
+
+Failsafe ships with three error backends by default:
+
+* Airbrake - Send errors to airbrake
+* Stderr - Send errors to stderr
+* File - Send errors to a log file
+
+Note: The File backend logs to a log file in the log directory called failsafe_errors.log.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+task :default => :spec

data/failsafe.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "failsafe/version"
+
+Gem::Specification.new do |s|
+  s.name        = "failsafe"
+  s.version     = Failsafe::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alex Sharp"]
+  s.email       = ["ajsharp@gmail.com"]
+  s.homepage    = "https://github.com/zaarly/failsafe"
+  s.summary     = %q{Tiny little library for silently handling errors so they don't interrupt program flow.}
+  s.description = %q{}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/failsafe.rb

@@ -0,0 +1,47 @@
+require 'logger'
+
+require 'failsafe/failure'
+
+module Failsafe
+
+  # Attach error backends to be fire when errors occur.
+  #
+  # @example Adding multiple backends
+  #   Failsafe::Config.error_backends << Failsafe::Backends::Airbrake
+  #   Failsafe::Config.error_backends << Failsafe::Backends::Stderr
+  def self.error_backends
+    @backends ||= []
+  end
+
+  @@disabled = false
+
+  # Determines if failsafe should rescue errors or let them bubble up.
+  #
+  # @default false
+  # @return [Boolean]
+  def self.disabled; @@disabled; end
+  def self.disabled?; disabled; end
+
+  def self.disabled=(val)
+    @@disabled = val
+  end
+
+  # Wraps code in a begin..rescue and delivers exceptions
+  # to the configured error backends.
+  #
+  # @todo make this threadsafe
+  def self.failsafe
+    # Let errors bubble up if failsafe has been disabled
+    if disabled?
+      return yield
+    end
+
+    begin
+      yield
+    rescue => e
+      error_backends.each do |backend|
+        backend.new(e).save
+      end
+    end
+  end
+end

data/lib/failsafe/backends/airbrake.rb

@@ -0,0 +1,11 @@
+module Failsafe
+  module Backends
+
+    # Failure backend to send errors to Airbrake
+    class Airbrake < Base
+      def save
+        ::Airbrake.notify_or_ignore(exception)
+      end
+    end
+  end
+end

data/lib/failsafe/backends/base.rb

@@ -0,0 +1,15 @@
+module Failsafe
+  module Backends
+    class Base
+      attr_accessor :exception
+
+      def initialize(exception)
+        @exception = exception
+      end
+
+      # Implement in subclasses
+      def save
+      end
+    end
+  end
+end

data/lib/failsafe/backends/file.rb

@@ -0,0 +1,18 @@
+module Failsafe
+  module Backends
+
+    # File failure backend. Writes exception backtraces to a logfile.
+    class File < Base
+      def self.logger
+        @logger ||= ::Logger.new(::File.join(Rails.root, 'log', 'failsafe_errors.log')).tap { |l| l.formatter = Logger::Formatter.new }
+      end
+
+      def save
+        msg = []
+        msg << exception.message
+        msg << exception.backtrace.join("\n")
+        self.class.logger.error(msg.join)
+      end
+    end
+  end
+end

data/lib/failsafe/backends/stderr.rb

@@ -0,0 +1,19 @@
+
+module Failsafe
+  module Backends
+
+    # Failure backend to log errors to stderr
+    class Stderr < Base
+      def self.logger
+        @logger ||= ::Logger.new($stderr).tap { |l| l.formatter = Logger::Formatter.new }
+      end
+
+      def save
+        msg = []
+        msg << exception.message
+        msg << exception.backtrace.join("\n")
+        self.class.logger.error(msg.join)
+      end
+    end
+  end
+end

data/lib/failsafe/failure.rb

@@ -0,0 +1,8 @@
+module Failsafe
+  module Backends
+    autoload :Base,     'failsafe/backends/base'
+
+    autoload :Airbrake, 'failsafe/backends/airbrake'
+    autoload :Stderr,   'failsafe/backends/stderr'
+  end
+end

data/lib/failsafe/version.rb

@@ -0,0 +1,4 @@
+
+module Failsafe
+  VERSION = '0.1.0'
+end

data/spec/failsafe/backends/base_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Failsafe::Backends::Base do
+  subject { Failsafe::Backends::Base.new(Exception.new) }
+
+  it { should respond_to :save }
+end

data/spec/failsafe/backends/stderr_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Failsafe::Backends::Stderr do
+  let!(:stderr_bucket) { $stderr }
+  let(:exception)      { RuntimeError.new("Oh noez!") }
+
+  subject { Failsafe::Backends::Stderr.new(exception) }
+
+  before do
+    $stderr = StringIO.new
+    Failsafe::Backends::Stderr.stubs(:logger => ::Logger.new($stderr))
+    exception.set_backtrace(["#{__FILE__}:6"])
+    subject.save
+    $stderr.rewind
+  end
+
+  after  { $stderr = stderr_bucket }
+
+  it "logs something to stderr when a exception is raised" do
+    $stderr.read.should =~ /Oh noez!/
+  end
+
+  it "logs the backtrace" do
+    $stderr.read.should include "stderr_spec.rb:6"
+  end
+end
+

data/spec/failsafe_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe "configuring error backends" do
+  it "adds the error backend class to the config" do
+    some_backend_class = Struct.new(:save)
+    Failsafe.error_backends << some_backend_class
+    Failsafe.error_backends.should include some_backend_class
+  end
+end
+
+describe Failsafe, ".failsafe" do
+  class DangerousClass
+    def boom_boom
+      raise RuntimeError.new "room!"
+    end
+  end
+
+  before { Failsafe.error_backends << MockFailureBackend }
+  let(:danger) { DangerousClass.new }
+
+  subject { Failsafe.failsafe { danger.boom_boom } }
+
+  it "does not raise an error when wrapped with failsafe" do
+    expect {
+      subject
+    }.not_to raise_error
+  end
+
+  it "notifies backends of the exception" do
+    MockFailureBackend.any_instance.expects(:save)
+    subject
+  end
+end
+
+describe "disabling failsafe" do
+  it "is not disabled by default" do
+    Failsafe.should_not be_disabled
+  end
+
+  context "when false" do
+    before { Failsafe.disabled = false }
+
+    it "allows exception to bubble up" do
+      expect {
+        Failsafe.failsafe { raise 'boom' }
+      }.not_to raise_error
+    end
+  end
+
+  context "when true" do
+    before { Failsafe.disabled = true }
+
+    it "allows errors to bubble up" do
+      expect {
+        Failsafe.failsafe { raise 'boom' }
+      }.to raise_error
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$:.push(File.expand_path(File.dirname(__FILE__)))
+$:.push(File.expand_path(File.dirname(__FILE__)) + '/../lib')
+
+require 'failsafe'
+
+class MockFailureBackend < Failsafe::Backends::Base
+end
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.after { Failsafe.error_backends.clear }
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: failsafe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-16 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email:
+- ajsharp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- failsafe.gemspec
+- lib/failsafe.rb
+- lib/failsafe/backends/airbrake.rb
+- lib/failsafe/backends/base.rb
+- lib/failsafe/backends/file.rb
+- lib/failsafe/backends/stderr.rb
+- lib/failsafe/failure.rb
+- lib/failsafe/version.rb
+- spec/failsafe/backends/base_spec.rb
+- spec/failsafe/backends/stderr_spec.rb
+- spec/failsafe_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zaarly/failsafe
+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.15
+signing_key: 
+specification_version: 3
+summary: Tiny little library for silently handling errors so they don't interrupt
+  program flow.
+test_files:
+- spec/failsafe/backends/base_spec.rb
+- spec/failsafe/backends/stderr_spec.rb
+- spec/failsafe_spec.rb
+- spec/spec_helper.rb