bullhorn 0.0.6 → 0.1.0

data/README.rdoc

@@ -2,72 +2,10 @@
 
 The Rack middleware drop-in for the bullhorn exception notification application.
 
-See http://bullhorn.it and signup for a free account!
+See http://www.bullhorn.it and signup for a free account!
 
-== Sinatra Example
-
-    require 'rubygems'
-    require 'sinatra'
-
-    # this must be enabled for errors to propagate
-    set :raise_errors, true
-
-    # of course the best way to do that is:
-    set :raise_errors, production?
-  
-    # Let's say we have an error we don't want to be notified about
-    MyOwnError = Class.new(StandardError)
-
-    use Bullhorn, :api_key => "__your key here__",
-      :filters => %w(password password_confirmation),
-      :ignore_exceptions => [MyOwnError]
-
-    get "/hello" do
-      "Hello world"
-    end
-
-    get "/fail" do
-      raise "Failure from the app"
-    end
-
-
-== Rails 3 Example
-
-    Whatever::Application.config.middleware.use Bullhorn,
-      :api_key => "_your api key here_",
-      :filters => %w(password password_confirmation credit_card)
-    
-    # by default, ActiveRecord::RecordNotFound, 
-    # AbstractController::ActionNotFound and ActionController::RoutingError
-    # are ignored in a Rails 3 context.
-
-== Rails 2.3.5 backward compatibility
-
-    # in config/environment.rb
-
-    config.gem 'bullhorn'
-
-    # in config/initializers/bullhorn.rb
-    Bullhorn::Plugin.options = {
-      :api_key => "_api key here_",
-      :filters => %w(password password_confirmation credit_card)
-    }
-
-    # in your application controller
-    class ApplicationController < ActionController::Base
-      include Bullhorn::Plugin
-    end
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+Installing instructions: http://www.bullhorn.it/page/installation
 
 == Copyright
 
-Copyright (c) 2010 Cyril David. See LICENSE for details.
+Copyright (c) 2010 Cyril David, Rico Sta. Cruz and Sinefunc, Inc. Released under the MIT license.

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

data/bullhorn.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullhorn}
-  s.version = "0.0.6"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
-  s.date = %q{2010-08-16}
+  s.date = %q{2010-10-18}
   s.description = %q{drop in rack middleware for bullhorn.it}
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [
@@ -78,6 +78,7 @@ Gem::Specification.new do |s|
      "examples/foobar/test/unit/helpers/raiser_helper_test.rb",
      "examples/sinatra.rb",
      "lib/bullhorn.rb",
+     "lib/bullhorn/backtrace.rb",
      "lib/bullhorn/plugin.rb",
      "lib/bullhorn/sender.rb",
      "test/helper.rb",
@@ -88,7 +89,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/sinefunc/bullhorn}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{rack middleware client for bullhorn.it}
   s.test_files = [
     "test/helper.rb",
@@ -123,7 +124,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<contest>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])

data/lib/bullhorn.rb

@@ -8,7 +8,10 @@ require 'digest/sha1'
 class Bullhorn
   autoload :Plugin, "bullhorn/plugin"
   autoload :Sender, "bullhorn/sender"
+  autoload :Backtrace, "bullhorn/backtrace"
 
+  LANGUAGE    = "ruby"
+  CLIENT_NAME = "bullhorn-ruby"
   VERSION = "0.0.5"
 
   URL = "http://www.bullhorn.it/api/v1/exception"
@@ -19,6 +22,7 @@ class Bullhorn
   attr :api_key
   attr :url
   attr :ignore_exceptions
+  attr :show_code_context
 
   include Sender
 
@@ -28,6 +32,7 @@ class Bullhorn
     @filters           = Array(options[:filters])
     @url               = options[:url] || URL
     @ignore_exceptions = Array(options[:ignore_exceptions] || default_ignore_exceptions)
+    @show_code_context = (options[:show_code_context].nil? ? true : options[:show_code_context])
   end
 
   def call(env)

data/lib/bullhorn/backtrace.rb

@@ -0,0 +1,47 @@
+class Bullhorn
+  class Backtrace
+    def initialize(exception, options = {})
+      @exception = exception
+      @raw       = exception.backtrace # Array
+      @options   = { :context => true }
+
+      @options.merge!(options)
+      
+      # Sample:
+      # [ "(irb):3:in `irb_binding'",
+      #   "/Users/rsc/.rvm/rubies/ruby-1.9.2-p0/lib/ruby/1.9.1/irb/workspace.rb:80:in `eval'",
+      #   "/Users/rsc/.rvm/rubies/ruby-1.9.2-p0/lib/ruby/1.9.1/irb.rb:159:in `block (2 levels) in eval_input'",
+    end
+
+    # Returns nil or an array.
+    def get_context(fname, line, size = 2)
+      begin
+        line = line.to_i
+        from = [0, (line-size-1)].max
+        lines = File.open(fname, 'r') { |file| file.lines.to_a[from...(line+size)] }
+
+        i = [line - size, 0].max
+        lines.map { |hash| i += 1; { (i-1) => hash } }
+      rescue
+        nil
+      end
+    end
+
+    def to_a
+      @raw.inject([]) do |arr, line|
+        m = line.match(/^(?<file>[^:]+):(?<line>[0-9]+):in `(?<function>.*)'$/)
+
+        arr << { :function => m[:function],
+          :file     => m[:file],
+          :line     => m[:line],
+          :context  => (@options[:context] ? get_context(m[:file], m[:line]) : nil)
+        }
+        arr
+      end
+    end
+
+    def to_json
+      to_a.send(:to_json)
+    end
+  end
+end

data/lib/bullhorn/sender.rb

@@ -7,17 +7,33 @@ class Bullhorn
     end
 
     def notify(exception, env)
+      bt = Backtrace.new(exception, :context => @show_code_context)
+
       Net::HTTP.post_form(URI(url), {
         :api_key      => api_key,
         :message      => exception.message,
-        :backtrace    => serialize(exception.backtrace),
+        :backtrace    => serialize(bt.to_a),
         :env          => serialize(whitelist(env)),
         :request_body => serialize(whitelist(request_body(env))),
-        :sha1         => sha1(exception)
+        :sha1         => sha1(exception),
+        # APIv2
+        :language       => Bullhorn::LANGUAGE,
+        :client_name    => Bullhorn::CLIENT_NAME,
+        :client_version => Bullhorn::VERSION,
+        :url            => [ "http://", env['HTTP_HOST'], env['REQUEST_URI'] ].join(''),
+        :class          => exception.class.to_s
       })
     end
 
   protected
+    def sha1(exception)
+      # Treat 2 exceptions as the same if they match the same exception class
+      # and same origin.
+      salt = '#bh#' + Bullhorn::CLIENT_NAME
+      str  = [ salt, exception.class.to_s, exception.backtrace.first ].join('|')
+      Digest::SHA1.hexdigest(str)
+    end
+
     def request_body(env)
       if io = env['rack.input']
         io.rewind if io.respond_to?(:rewind)
@@ -55,9 +71,5 @@ class Bullhorn
         end
       end
     end
-
-    def sha1(exception)
-      Digest::SHA1.hexdigest(exception.message + exception.backtrace.inspect)
-    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Cyril David
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-16 00:00:00 +08:00
+date: 2010-10-18 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: contest
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -33,6 +34,7 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -45,6 +47,7 @@ dependencies:
   name: rack-test
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -57,6 +60,7 @@ dependencies:
   name: fakeweb
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -136,6 +140,7 @@ files:
 - examples/foobar/test/unit/helpers/raiser_helper_test.rb
 - examples/sinatra.rb
 - lib/bullhorn.rb
+- lib/bullhorn/backtrace.rb
 - lib/bullhorn/plugin.rb
 - lib/bullhorn/sender.rb
 - test/helper.rb
@@ -152,6 +157,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -159,6 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -168,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: rack middleware client for bullhorn.it