bullhorn 0.0.1

data/examples/foobar/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/examples/foobar/script/about

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
+require 'commands/about'

data/examples/foobar/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/console'

data/examples/foobar/script/dbconsole

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/dbconsole'

data/examples/foobar/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/destroy'

data/examples/foobar/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/generate'

data/examples/foobar/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../../config/boot',  __FILE__)
+require 'commands/performance/benchmarker'

data/examples/foobar/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../../config/boot',  __FILE__)
+require 'commands/performance/profiler'

data/examples/foobar/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/plugin'

data/examples/foobar/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/runner'

data/examples/foobar/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/server'

data/examples/foobar/test/functional/raiser_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class RaiserControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/examples/foobar/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/examples/foobar/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/examples/foobar/test/unit/helpers/raiser_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class RaiserHelperTest < ActionView::TestCase
+end

data/lib/bullhorn.rb

@@ -0,0 +1,41 @@
+require 'net/http'
+require 'uri'
+require 'base64'
+require 'json'
+require 'cgi'
+
+class Bullhorn
+  autoload :Plugin, "bullhorn/plugin"
+  autoload :Sender, "bullhorn/sender"
+
+  VERSION = "0.0.1"
+
+  URL = "http://bullhorn.it/api/v1/exception"
+
+  FILTERING = %(['"]?\[?%s\]?['"]?=>?([^&\s]*))
+
+  attr :filters
+  attr :api_key
+  attr :url
+
+  include Sender
+
+  def initialize(app, options = {})
+    @app     = app
+    @api_key = options[:api_key] || raise(ArgumentError, ":api_key is required")
+    @filters = Array(options[:filters])
+    @url     = options[:url] || URL
+  end
+
+  def call(env)
+    status, headers, body =
+      begin
+        @app.call(env)
+      rescue Exception => ex
+        notify ex, env
+        raise ex
+      end
+
+    [status, headers, body]
+  end
+end

data/lib/bullhorn/plugin.rb

@@ -0,0 +1,34 @@
+class Bullhorn
+  module Plugin
+    class << self
+      attr_accessor :options
+
+      attr :ignored_exceptions
+    end
+
+    def self.ignored_exceptions
+      [].tap do |ex|
+        ex << ActiveRecord::RecordNotFound if defined? ActiveRecord
+        if defined? ActionController
+          ex << ActionController::UnknownController
+          ex << ActionController::UnknownAction
+          ex << ActionController::RoutingError if ActionController.const_defined?(:RoutingError)
+        end
+      end
+    end
+
+  protected
+    def rescue_action_in_public(exception)
+      notify_with_bullhorn!(exception)
+
+      super
+    end
+
+    def notify_with_bullhorn!(exception)
+      unless Bullhorn::Plugin.ignored_exceptions.include?(exception)
+        bullhorn = Bullhorn.new(self, Bullhorn::Plugin.options)
+        bullhorn.notify(exception, request.env)
+      end
+    end
+  end
+end

data/lib/bullhorn/sender.rb

@@ -0,0 +1,57 @@
+class Bullhorn
+  module Sender
+    extend self
+
+    def serialize(str)
+      str # CGI.escape(Base64.encode64(str.to_json).strip)
+    end
+
+    def notify(exception, env)
+      Net::HTTP.post_form(URI(url), {
+        :api_key      => api_key,
+        :message      => exception.message,
+        :backtrace    => serialize(exception.backtrace),
+        :env          => serialize(whitelist(env)),
+        :request_body => serialize(whitelist(request_body(env)))
+      })
+    end
+
+  protected
+    def request_body(env)
+      if io = env['rack.input']
+        io.rewind if io.respond_to?(:rewind)
+        io.read
+      end
+    rescue
+      ""
+    end
+
+    def whitelist(str_or_hash)
+      case str_or_hash
+      when Hash
+        str_or_hash.dup.tap do |h|
+          h.keys.each do |key|
+            if h[key].respond_to?(:gsub)
+              h[key] = sanitize(h[key])
+            else
+              h[key] = h[key].inspect
+            end
+          end
+        end
+
+      when String
+        sanitize(str_or_hash)
+      end
+    end
+
+    def sanitize(str)
+      str.dup.tap do |ret|
+        @filters.each do |filter|
+          ret.gsub!(Regexp.new(FILTERING % filter)) { |m|
+            m.gsub($1, '[FILTERED]')
+          }
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'contest'
+require 'mocha'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bullhorn'
+
+class Test::Unit::TestCase
+end

data/test/test_bullhorn.rb

@@ -0,0 +1,104 @@
+require 'helper'
+
+class TestBullhorn < Test::Unit::TestCase
+  setup do
+    @app = lambda { |env| [200, { "Content-Type" => "text/plain" }, ["Hello"]] }
+  end
+
+  test "raises when no api_key" do
+    assert_raise ArgumentError do
+      Bullhorn.new(@app)
+    end
+  end
+
+  test "accepts a filter of string arrays" do
+    bullhorn = Bullhorn.new(@app, :api_key => "key", :filters => ['a', 'b'])
+    assert_equal ['a', 'b'], bullhorn.filters
+  end
+
+  test "accepts a filter as a single string" do
+    bullhorn = Bullhorn.new(@app, :api_key => "key", :filters => "password")
+    assert_equal ['password'], bullhorn.filters
+  end
+
+  context "on raise" do
+    Fail = Class.new(StandardError)
+
+    setup do
+      @fail = Fail.new("Fail!!!")
+      @fail.stubs(:backtrace).returns(["line1", "line2"])
+      @app = lambda { |env| raise @fail }
+
+      @bullhorn = Bullhorn.new(@app, :api_key => "_key_",
+                                     :url => "http://test.host/api/v1")
+    end
+
+    should "send a notification and raise the failure" do
+      @bullhorn.expects(:notify)
+
+      assert_raise Fail do
+        @bullhorn.call({})
+      end
+    end
+
+    should "send the proper request parameters" do
+      uri = URI("http://test.host/api/v1")
+      io  = stub("IO", :read => "FooBar")
+
+      expected = {
+        :api_key => '_key_',
+        :message => 'Fail!!!',
+        :backtrace => Bullhorn::Sender.serialize(['line1', 'line2']),
+        :env => Bullhorn::Sender.serialize("params" => "a&b", "rack.input" => io.inspect),
+        :request_body => Bullhorn::Sender.serialize("FooBar")
+      }
+
+      Net::HTTP.expects(:post_form).with() { |u, hash|
+        u == uri && hash == expected
+      }
+
+      begin
+        @bullhorn.call({ "params" => "a&b", "rack.input" =>  io })
+      rescue Fail
+      end
+    end
+  end
+
+  context "given filtering password / password_confirmation" do
+    Fail = Class.new(StandardError)
+
+    setup do
+      @fail = Fail.new("Fail!!!")
+      @fail.stubs(:backtrace).returns(["line1", "line2"])
+      @app = lambda { |env| raise @fail }
+
+      @bullhorn = Bullhorn.new(@app, :api_key => "_key_",
+                                     :url => "http://test.host/api/v1",
+                                     :filters => ["password"])
+    end
+
+    should "remove all traces of password param value in the env" do
+      uri = URI("http://test.host/api/v1")
+      io  = stub("IO", :read => "password=test&user[password]=test")
+
+      expected = {
+        :api_key => '_key_',
+        :message => 'Fail!!!',
+        :backtrace => Bullhorn::Sender.serialize(['line1', 'line2']),
+        :env => Bullhorn::Sender.serialize("params" => "password=[FILTERED]&user[password]=[FILTERED]",
+                                           "rack.input" => io.inspect),
+        :request_body => Bullhorn::Sender.serialize("password=[FILTERED]&user[password]=[FILTERED]")
+      }
+
+      Net::HTTP.expects(:post_form).with() { |u, hash|
+        u == uri && hash == expected
+      }
+
+      begin
+        @bullhorn.call("params" => "password=test&user[password]=test",
+                       "rack.input" =>  io)
+      rescue Fail
+      end
+    end
+  end
+end

data/test/test_bullhorn_plugin.rb

@@ -0,0 +1,61 @@
+require "helper"
+require "rack/test"
+
+Bullhorn::Plugin.options = {
+  :api_key => '_key_',
+  :filters => 'password'
+}
+
+class RescueAction
+
+protected
+  def rescue_action_in_public(ex)
+    raise ex
+  end
+end
+
+class FakeRailsController < RescueAction
+  Fail = Class.new(StandardError)
+
+  include Bullhorn::Plugin
+
+  attr :request
+
+  def initialize(request, response)
+    @request, @response = request, response
+  end
+
+  def index
+    raise Fail, "Failure"
+  rescue => ex
+    rescue_action_in_public(ex)
+  end
+end
+
+class TestBullhornPlugin < Test::Unit::TestCase
+  def app
+    @request = Rack::Request.new({})
+    @app = FakeRailsController.new(@request, @response)
+  end
+
+  setup do
+    FakeWeb.allow_net_connect = false
+  end
+
+  test "notifies on error" do
+    FakeWeb.register_uri(:post, "http://bullhorn.it/api/v1/exception", :body => "OK")
+
+    begin
+      app.index
+    rescue
+    end
+  end
+
+  test "still raises original error" do
+    FakeWeb.register_uri(:post, "http://bullhorn.it/api/v1/exception", :body => "OK")
+
+    assert_raise FakeRailsController::Fail do
+      app.index
+    end
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification 
+name: bullhorn
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-16 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: drop in rack middleware for bullhorn.it
+email: cyx.ucron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/foobar/README
+- examples/foobar/Rakefile
+- examples/foobar/app/controllers/application_controller.rb
+- examples/foobar/app/controllers/raiser_controller.rb
+- examples/foobar/app/helpers/application_helper.rb
+- examples/foobar/app/helpers/raiser_helper.rb
+- examples/foobar/config/boot.rb
+- examples/foobar/config/database.yml
+- examples/foobar/config/environment.rb
+- examples/foobar/config/environments/development.rb
+- examples/foobar/config/environments/production.rb
+- examples/foobar/config/environments/test.rb
+- examples/foobar/config/initializers/backtrace_silencers.rb
+- examples/foobar/config/initializers/bullhorn.rb
+- examples/foobar/config/initializers/inflections.rb
+- examples/foobar/config/initializers/mime_types.rb
+- examples/foobar/config/initializers/new_rails_defaults.rb
+- examples/foobar/config/initializers/session_store.rb
+- examples/foobar/config/locales/en.yml
+- examples/foobar/config/routes.rb
+- examples/foobar/db/seeds.rb
+- examples/foobar/doc/README_FOR_APP
+- examples/foobar/log/development.log
+- examples/foobar/log/production.log
+- examples/foobar/log/server.log
+- examples/foobar/log/test.log
+- examples/foobar/public/404.html
+- examples/foobar/public/422.html
+- examples/foobar/public/500.html
+- examples/foobar/public/favicon.ico
+- examples/foobar/public/images/rails.png
+- examples/foobar/public/index.html
+- examples/foobar/public/javascripts/application.js
+- examples/foobar/public/javascripts/controls.js
+- examples/foobar/public/javascripts/dragdrop.js
+- examples/foobar/public/javascripts/effects.js
+- examples/foobar/public/javascripts/prototype.js
+- examples/foobar/public/robots.txt
+- examples/foobar/script/about
+- examples/foobar/script/console
+- examples/foobar/script/dbconsole
+- examples/foobar/script/destroy
+- examples/foobar/script/generate
+- examples/foobar/script/performance/benchmarker
+- examples/foobar/script/performance/profiler
+- examples/foobar/script/plugin
+- examples/foobar/script/runner
+- examples/foobar/script/server
+- examples/foobar/test/functional/raiser_controller_test.rb
+- examples/foobar/test/performance/browsing_test.rb
+- examples/foobar/test/test_helper.rb
+- examples/foobar/test/unit/helpers/raiser_helper_test.rb
+- lib/bullhorn.rb
+- lib/bullhorn/plugin.rb
+- lib/bullhorn/sender.rb
+- test/helper.rb
+- test/test_bullhorn.rb
+- test/test_bullhorn_plugin.rb
+has_rdoc: true
+homepage: http://github.com/sinefunc/bullhorn
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: rack middleware client for bullhorn.it
+test_files: 
+- test/helper.rb
+- test/test_bullhorn.rb
+- test/test_bullhorn_plugin.rb
+- examples/foobar/app/controllers/application_controller.rb
+- examples/foobar/app/controllers/raiser_controller.rb
+- examples/foobar/app/helpers/application_helper.rb
+- examples/foobar/app/helpers/raiser_helper.rb
+- examples/foobar/config/boot.rb
+- examples/foobar/config/environment.rb
+- examples/foobar/config/environments/development.rb
+- examples/foobar/config/environments/production.rb
+- examples/foobar/config/environments/test.rb
+- examples/foobar/config/initializers/backtrace_silencers.rb
+- examples/foobar/config/initializers/bullhorn.rb
+- examples/foobar/config/initializers/inflections.rb
+- examples/foobar/config/initializers/mime_types.rb
+- examples/foobar/config/initializers/new_rails_defaults.rb
+- examples/foobar/config/initializers/session_store.rb
+- examples/foobar/config/routes.rb
+- examples/foobar/db/seeds.rb
+- examples/foobar/test/functional/raiser_controller_test.rb
+- examples/foobar/test/performance/browsing_test.rb
+- examples/foobar/test/test_helper.rb
+- examples/foobar/test/unit/helpers/raiser_helper_test.rb