failbot_rails 0.3.1

data/README.md

@@ -0,0 +1,65 @@
+# failbot_rails
+
+Configures a Rails application to report exceptions to [Haystack][] using the
+[Failbot][] library.
+
+[Haystack]: https://haystack.githubapp.com
+[Failbot]: https://github.com/github/failbot
+
+## Installation
+
+Add it to the app's Gemfile manifest. The gem is publicly available but **keep
+this repository private.**
+
+```ruby
+gem "failbot_rails", "~>0.2"
+```
+
+## Usage
+
+Require `failbot_rails` at the very top of `config/application.rb` right after
+loading `boot.rb`:
+
+```ruby
+require File.expand_path('../boot', __FILE__)
+
+# report exceptions to Haystack using Failbot
+require "failbot_rails"
+FailbotRails.setup("my_app")
+```
+
+Every library, script or unicorn that loads the Rails environment are now setup
+to automatically report all exceptions to Haystack.
+
+### `failbot_context`
+
+The exception context is automatically populated with request metadata including
+the URL, method, params, etc. It can be augmented by defining a` failbot_context`
+method on `ApplicationController`:
+
+```ruby
+def failbot_context
+  {:repo => current_repository.name_with_owner}
+end
+```
+
+### `failbot(exception, context={})`
+
+Use the `failbot` helper anywhere in controllers, views or helpers to manually
+rescue and report an exception. Often used in "graceful degradation" situations.
+**Often risky and error prone but sometimes worth it. Consider carefully before
+using.**
+
+```ruby
+def load_tree
+  current_repository.tree(params[:tree])
+rescue TreeCorruptError
+  failbot($!)
+  nil
+end
+```
+
+## Contributing
+
+The failbot_rails project follows the open source contribution model and is
+maintained by @sr. Open a pull request and wait for a :+1:

data/failbot_rails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "failbot_rails"
+  s.version     = "0.3.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = %w[@sr]
+  s.email       = ["sr@github.com"]
+  s.homepage    = "https://github.com/github/failbot_rails#readme"
+  s.summary     = "Glue code for using Failbot in a Rails app"
+  s.description = s.summary
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_runtime_dependency "failbot", "~>0.9.0"
+
+  s.files         = `git ls-files`.split("\n") - %w[Gemfile Gemfile.lock]
+  s.test_files    = `git ls-files -- test`.split("\n").select { |f| f =~ /_test.rb$/ }
+  s.executables   = `git ls-files -- bin`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = %w[lib]
+end

data/lib/failbot_rails.rb

@@ -0,0 +1,146 @@
+require "failbot"
+require "failbot/middleware"
+
+require "rails"
+require "rails/railtie"
+require "active_support/concern"
+
+module FailbotRails
+  def self.setup(app_name)
+    if _setup
+      fail "FailbotRails already setup"
+    end
+
+    if !app_name.respond_to?(:to_str) || app_name.to_str.empty?
+      raise ArgumentError, "app_name argument is required"
+    end
+
+    settings = ENV.to_hash
+
+    # sensible defaults
+    if Rails.env.development? || Rails.env.test?
+      settings["FAILBOT_BACKEND"] ||= "memory"
+
+      if !settings.key?("FAILBOT_RAISE")
+        settings["FAILBOT_RAISE"] = "1"
+      end
+    end
+
+    Failbot.setup(settings, {:app => app_name.to_str})
+    Failbot.install_unhandled_exception_hook!
+
+    @_setup = true
+  end
+
+  class << self
+    attr_reader :_setup
+  end
+
+  class Engine < Rails::Railtie
+    initializer "failbot_rails.assert_setup" do |app|
+      app.config.before_initialize do
+        if !::FailbotRails._setup
+          fail "FailbotRails must be setup like so: FailbotRails.setup(\"my_app\")"
+        end
+      end
+    end
+
+    initializer "failbot_rails.install_middleware" do |app|
+      app.middleware.insert_after \
+        ::ActionDispatch::DebugExceptions,
+        ::FailbotRails::Middleware
+    end
+
+    initializer "failbot_rails.install_action_controller_utilities" do |app|
+      app.config.to_prepare do
+        ActiveSupport.on_load(:action_controller) do
+          include ::FailbotRails::ActionControllerUtilities
+        end
+      end
+    end
+  end
+
+  class Middleware < ::Failbot::Rescuer
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      @app.call(env)
+    rescue Exception
+      context = {
+        :method       => request.request_method,
+        :url          => request.url,
+        :user_agent   => request.env["HTTP_USER_AGENT"],
+        :params       => request.params,
+        :session      => (request.session.to_hash rescue nil),
+        :referrer     => request.referrer,
+        :remote_ip    => request.ip,
+      }
+      Failbot.report($!, ::FailbotRails._failbot_safe_context(context))
+      raise
+    end
+  end
+
+  def self._failbot_safe_context(context)
+    new_context = {}.merge(context)
+    filters = Rails.application.config.filter_parameters
+    filter = ActionDispatch::Http::ParameterFilter.new(filters)
+
+    if new_context.key?(:params)
+      new_context[:params] = filter.filter(new_context[:params])
+    end
+
+    new_context
+  end
+
+  module ActionControllerUtilities
+    extend ActiveSupport::Concern
+
+    included do
+      # reset context before populating it with rails-specific info
+      before_filter :_failbot_rails
+
+      helper_method :failbot
+    end
+
+    private
+
+    def failbot(e, context={})
+      if e.kind_of?(ActionView::TemplateError) && e.respond_to?(:original_exception)
+        # exceptions raised from views are wrapped in TemplateError. This is the
+        # most annoying thing ever.
+        e = e.original_exception
+      end
+
+      if e.respond_to?(:info) && e.info.is_a?(Hash)
+        context = e.info.merge(context || {})
+      end
+
+      Failbot.report(e, ::FailbotRails._failbot_safe_context(context))
+    end
+
+    def _failbot_rails
+      # clear context before every request
+      Failbot.reset!
+
+      context = {
+        :controller => params[:controller],
+        :action => params[:action],
+        :user => lambda {
+          respond_to?(:current_user) &&
+            current_user.respond_to?(:login) &&
+            current_user.login
+        },
+      }
+
+      # allow overriding context by defining ApplicationController#failbot_context
+      if respond_to?(:failbot_context) && failbot_context.respond_to?(:to_hash)
+        context.merge!(failbot_context.to_hash)
+      end
+
+      Failbot.push(::FailbotRails._failbot_safe_context(context))
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: failbot_rails
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- ! '@sr'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: failbot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Glue code for using Failbot in a Rails app
+email:
+- sr@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- failbot_rails.gemspec
+- lib/failbot_rails.rb
+homepage: https://github.com/github/failbot_rails#readme
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Glue code for using Failbot in a Rails app
+test_files: []