bugsnag 1.0.0 → 1.0.1

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/bugsnag.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "bugsnag"
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Smith"]
+  s.date = "2012-01-15"
+  s.description = "Ruby notifier for bugsnag.com"
+  s.email = "james@bugsnag.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bugsnag.gemspec",
+    "lib/bugsnag.rb",
+    "lib/bugsnag/configuration.rb",
+    "lib/bugsnag/helpers.rb",
+    "lib/bugsnag/notification.rb",
+    "lib/bugsnag/rack.rb",
+    "lib/bugsnag/rails.rb",
+    "lib/bugsnag/rails/action_controller_rescue.rb",
+    "lib/bugsnag/rails/controller_methods.rb",
+    "lib/bugsnag/railtie.rb",
+    "lib/bugsnag/version.rb",
+    "rails/init.rb",
+    "test/helper.rb",
+    "test/test_bugsnag.rb"
+  ]
+  s.homepage = "http://github.com/bugsnag/bugsnag-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby notifier for bugsnag.com"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<multi_json>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<multi_json>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<multi_json>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<multi_json>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end
+

data/lib/bugsnag.rb

@@ -1,17 +1,9 @@
 require "rubygems"
 
-# begin
-#   require "active_support"
-#   require "active_support/core_ext"
-# rescue LoadError
-#   require "activesupport"
-#   require "activesupport/core_ext"
-# end
-
-require "bugsnag/configuration"
-require "bugsnag/event"
-require "bugsnag/notifier"
 require "bugsnag/version"
+require "bugsnag/configuration"
+require "bugsnag/notification"
+require "bugsnag/helpers"
 
 require "bugsnag/rack"
 require "bugsnag/railtie" if defined?(Rails::Railtie)
@@ -20,30 +12,29 @@ module Bugsnag
   LOG_PREFIX = "** [Bugsnag] "
 
   class << self
-    attr_accessor :notifier
-
     def configure
-      yield(configuration)
-      self.notifier = Notifier.new(configuration)
-      
-      log "Bugsnag exception handler #{VERSION} ready, #{configuration.to_hash.inspect}"
+      yield(configuration)      
+      log "Bugsnag exception handler #{VERSION} ready, api_key=#{configuration.api_key}" if configuration.api_key
     end
 
-    def notify(exception)
-      notifier.notify(exception)
+    def notify(exception, session_data={})
+      opts = {
+        :releaseStage => configuration.release_stage,
+        :projectRoot => configuration.project_root.to_s,
+        :appVersion => configuration.app_version
+      }.merge(session_data)
+
+      # Send the notification
+      notification = Notification.new(configuration.api_key, exception, opts)
+      notification.deliver
     end
 
     def log(message)
-      logger.info(LOG_PREFIX + message) if logger
+      configuration.logger.info(LOG_PREFIX + message) if configuration.logger
     end
 
-    private
     def configuration
       @configuration ||= Bugsnag::Configuration.new
     end
-    
-    def logger
-      configuration.logger
-    end
   end
 end

data/lib/bugsnag/configuration.rb

@@ -1,18 +1,5 @@
 module Bugsnag
   class Configuration
-    @@options = :api_key, :release_stage, :endpoint, :project_root, :logger
-    @@options.each do |attribute|
-      attr_accessor attribute
-    end
-
-    def initialize
-      @endpoint = "http://api.bugsnag.com/notify"
-    end
-
-    def to_hash
-      @@options.inject({}) do |hash, option|
-        hash.merge(option.to_sym => send(option))
-      end
-    end
+    attr_accessor :api_key, :release_stage, :project_root, :app_version, :framework, :endpoint, :logger, :disable_auto_notification
   end
 end

data/lib/bugsnag/helpers.rb

@@ -0,0 +1,26 @@
+module Bugsnag
+  module Helpers
+    def self.cleanup_hash(hash)
+      hash.inject({}) do |h, (k, v)|
+        h[k.gsub(/\./, "-")] = v.to_s
+        h
+      end
+    end
+    
+    def self.apply_filters(hash, filters)
+      if filters
+        hash.each do |k, v|
+          if filters.any? {|f| k.to_s.include?(f.to_s) }
+            hash[k] = "[FILTERED]"
+          elsif v.respond_to?(:to_hash)
+            apply_filters(hash[k])
+          end
+        end
+      end
+    end
+    
+    def self.param_context(params)
+      "#{params[:controller]}##{params[:action]}"
+    end
+  end
+end

data/lib/bugsnag/notification.rb

@@ -0,0 +1,97 @@
+require "httparty"
+require "multi_json"
+
+module Bugsnag
+  class Notification
+    DEFAULT_ENDPOINT = "http://api.bugsnag.com/notify"
+
+    NOTIFIER_NAME = "Ruby Bugsnag Notifier"
+    NOTIFIER_VERSION = Bugsnag::VERSION
+    NOTIFIER_URL = "http://www.bugsnag.com"
+    
+    include HTTParty
+    headers  "Content-Type" => "application/json"
+
+    attr_accessor :apiKey, :exception, :endpoint,
+                  :appVersion, :releaseStage, :projectRoot,
+                  :userId, :context, :metaData
+
+    def initialize(api_key, exception, opts={})
+      self.apiKey = api_key
+      self.exception = exception
+      self.endpoint = DEFAULT_ENDPOINT
+
+      opts.reject! {|k,v| v.nil?}.each {|k,v| self.send("#{k}=", v)}
+    end
+
+    def deliver
+      Bugsnag.log("Notifying #{self.endpoint} of exception")
+
+      payload = {
+        :apiKey => self.apiKey,
+        :notifier => notifier_identification,
+        :errors => [{
+          :userId => self.userId,
+          :appVersion => self.appVersion,
+          :releaseStage => self.releaseStage,
+          :context => self.context,
+          :exceptions => [exception_hash],
+          :metaData => self.metaData
+        }.reject {|k,v| v.nil? }]
+      }
+
+      begin
+        response = self.class.post(self.endpoint, {:body => MultiJson.encode(payload)})
+      rescue Exception => e
+        Bugsnag.log("Notification to #{self.endpoint} failed, #{e.inspect}")
+      end
+      
+      return response
+    end
+
+
+    private
+    def notifier_identification
+      unless @notifier
+        @notifier = {
+          :name => NOTIFIER_NAME,
+          :version => NOTIFIER_VERSION,
+          :url => NOTIFIER_URL
+        }
+      end
+
+      @notifier
+    end
+
+    def stacktrace_hash
+      return [] unless self.exception.backtrace
+      self.exception.backtrace.map do |trace|
+        method = nil
+        file, line_str, method_str = trace.split(":")
+
+        trace_hash = {
+          :file => file,
+          :lineNumber => line_str.to_i
+        }
+
+        if method_str
+          method_match = /in `([^']+)'/.match(method_str)
+          method = method_match.captures.first if method_match
+        end
+
+        trace_hash[:method] = method if method
+        trace_hash[:inProject] = true if self.projectRoot && file.match(/^#{self.projectRoot}/)
+
+        trace_hash
+      end
+    end
+
+    def exception_hash
+      {
+        :errorClass => self.exception.class.to_s,
+        :message => self.exception.message,
+        :stacktrace => stacktrace_hash
+      }
+    end
+  end
+end

data/lib/bugsnag/rack.rb

@@ -8,15 +8,43 @@ module Bugsnag
       begin
         response = @app.call(env)
       rescue Exception => raised
-        Bugsnag.notify(raised)
+        error_id = Bugsnag.notify(raised, bugsnag_request_data(env))
         raise
       end
 
-      if env["rack.exception"]
-        Bugsnag.notify(env["rack.exception"])
+      if env['rack.exception']
+        error_id = Bugsnag.notify(env['rack.exception'], bugsnag_request_data(env))
       end
 
       response
     end
+    
+    private
+    def bugsnag_request_data(env)
+      request = ::Rack::Request.new(env)
+
+      session = env['rack.session'] || {}
+      params = env['action_dispatch.request.parameters'] || request.params || {}
+
+      {
+        :userId => session[:session_id] || session["session_id"],
+        :context => Bugsnag::Helpers.param_context(params),
+        :metaData => {
+          :request => {
+            :url => request.url,
+            :controller => params[:controller],
+            :action => params[:action],
+            :params => bugsnag_filter_if_filtering(env, Bugsnag::Helpers.cleanup_hash(params.to_hash)),
+          },
+          :session => bugsnag_filter_if_filtering(env, Bugsnag::Helpers.cleanup_hash(session)),
+          :environment => bugsnag_filter_if_filtering(env, Bugsnag::Helpers.cleanup_hash(env))
+        }
+      }
+    end
+
+    def bugsnag_filter_if_filtering(env, hash)
+      @params_filters ||= env["action_dispatch.parameter_filter"]
+      Bugsnag::Helpers.apply_filters(hash, @params_filters)
+    end
   end
-end
+end

data/lib/bugsnag/rails.rb

@@ -1,4 +1,7 @@
+# Rails 2.x support
+
 require "bugsnag"
+require "bugsnag/rails/controller_methods"
 require "bugsnag/rails/action_controller_rescue"
 
 module Bugsnag
@@ -6,12 +9,22 @@ module Bugsnag
     def self.initialize
       if defined?(ActionController::Base)
         ActionController::Base.send(:include, Bugsnag::Rails::ActionControllerRescue)
+        ActionController::Base.send(:include, Bugsnag::Rails::ControllerMethods)
+      end
+
+      # Try to find where to log to
+      rails_logger = nil
+      if defined?(::Rails.logger)
+        rails_logger = ::Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        rails_logger = RAILS_DEFAULT_LOGGER
       end
 
-      Bugsnag.configure(true) do |config|
+      Bugsnag.configure do |config|
         config.logger = rails_logger
-        config.environment_name = RAILS_ENV  if defined?(RAILS_ENV)
+        config.release_stage = RAILS_ENV  if defined?(RAILS_ENV)
         config.project_root = RAILS_ROOT if defined?(RAILS_ROOT)
+        config.framework = "Rails: #{::Rails::VERSION::STRING}" if defined?(::Rails::VERSION)
       end
     end
   end

data/lib/bugsnag/rails/action_controller_rescue.rb

@@ -4,12 +4,24 @@ module Bugsnag
       def self.included(base)
         base.send(:alias_method, :rescue_action_in_public_without_bugsnag, :rescue_action_in_public)
         base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_bugsnag)
+
+        base.send(:alias_method, :rescue_action_locally_without_bugsnag, :rescue_action_locally)
+        base.send(:alias_method, :rescue_action_locally, :rescue_action_locally_with_bugsnag)
       end
 
       private
       def rescue_action_in_public_with_bugsnag(exception)
-        Bugsnag.notify(exception)
-        rescue_action_in_public_without_scepter(exception)
+        auto_notify(exception) unless Bugsnag.configuration.disable_auto_notification
+        rescue_action_in_public_without_bugsnag(exception)
+      end
+      
+      def rescue_action_locally_with_bugsnag(exception)
+        auto_notify(exception) unless Bugsnag.configuration.disable_auto_notification
+        rescue_action_locally_without_bugsnag(exception)
+      end
+      
+      def auto_notify(exception)
+        notify_bugsnag(exception)
       end
     end
   end

data/lib/bugsnag/rails/controller_methods.rb

@@ -1,7 +1,78 @@
 module Bugsnag
   module Rails
     module ControllerMethods
-      # TODO
+      private
+      def notify_bugsnag(exception, custom_data=nil)
+        unless bugsnag_local_request?
+          request_data = bugsnag_request_data
+          request_data[:metaData][:custom] = custom_data if custom_data
+          Bugsnag.notify(exception, request_data)
+        end
+      end
+
+      def bugsnag_request_data
+        {
+          :userId => bugsnag_session_id,
+          :context => Bugsnag::Helpers.param_context(params),
+          :metaData => {
+            :request => {
+              :url => bugsnag_request_url,
+              :controller => params[:controller],
+              :action => params[:action],
+              :params => bugsnag_filter_if_filtering(params.to_hash),
+            },
+            :session => bugsnag_filter_if_filtering(bugsnag_session_data),
+            :environment => bugsnag_filter_if_filtering(Bugsnag::Helpers.cleanup_hash(request.env))
+          }
+        }
+      end
+
+      def bugsnag_local_request?
+        if defined?(::Rails.application.config)
+          ::Rails.application.config.consider_all_requests_local || request.local?
+        else
+          consider_all_requests_local || local_request?
+        end
+      end
+
+      def bugsnag_session_id
+        session = bugsnag_session_data
+        session[:session_id] || session["session_id"]
+      end
+      
+      def bugsnag_context
+        "#{params[:controller]}##{params[:action]}"
+      end
+
+      def bugsnag_request_url
+        url = "#{request.protocol}#{request.host}"
+
+        unless [80, 443].include?(request.port)
+          url << ":#{request.port}"
+        end
+
+        url << request.fullpath
+        url
+      end
+
+      def bugsnag_session_data
+        if session.respond_to?(:to_hash)
+          session.to_hash
+        else
+          session.data
+        end
+      end
+    
+      def bugsnag_filter_if_filtering(hash)
+        return hash if ! hash.is_a?(Hash)
+
+        if respond_to?(:filter_parameters)
+          filter_parameters(hash) rescue hash
+        else
+          hash
+        end
+      end
+
     end
   end
 end

data/lib/bugsnag/railtie.rb

@@ -1,3 +1,5 @@
+# Rails 3.x support
+
 require "bugsnag"
 require "rails"
 
@@ -13,9 +15,10 @@ module Bugsnag
 
     config.after_initialize do
       Bugsnag.configure do |config|
-        config.logger        ||= Rails.logger
+        config.logger ||= Rails.logger
         config.release_stage ||= Rails.env
-        config.project_root  ||= Rails.root
+        config.project_root ||= Rails.root
+        config.framework = "Rails: #{::Rails::VERSION::STRING}"
       end
 
       if defined?(::ActionController::Base)

data/rails/init.rb

@@ -1 +1,3 @@
+# On Rails 2.x GEM_ROOT/rails/init.rb is auto loaded for all gems
+# so this is the place to initialize Rails 2.x plugin support
 require "bugsnag/rails"

data/test/test_bugsnag.rb

@@ -1,29 +1,22 @@
 require 'helper'
 
+class BugsnagTestException < RuntimeError; end
+
 class TestBugsnag < Test::Unit::TestCase
-  should "get a 200 response from bugsnag.com for basic exceptions" do
-    flunk "oh my" if lets.code != 200
-  end
-  
-  private
-  def lets
+  should "get a 200 response from bugsnag for exceptions" do
+    Bugsnag.configure do |config|
+      config.api_key = "a799e9c27c3fb3017e4a556fd815317e"
+      config.endpoint = "http://localhost:8000/notify"
+      config.release_stage = "production"
+      config.project_root = File.dirname(__FILE__)
+      config.user_id = "static_user_id"
+    end
+    
     begin
-      go
+      raise BugsnagTestException.new("Exception test from bugsnag gem")
     rescue Exception => e
-      event = Bugsnag::Event.new(e, "12345", {:app_environment => {:releaseStage => "production"}})
-
-      # Bugsnag::Notifier.set_endpoint("http://localhost:8000")
-      # Bugsnag::Notifier.notify("145260904aa22d52bf2a82076d157c38", event)
-
-      return Bugsnag::Notifier.notify("d6db01214d22ac808ce6afdfa4c3f148", event)
+      response = Bugsnag.notify(e)
+      flunk "oh my" if response.code != 200
     end
   end
-
-  def go
-    deep
-  end
-
-  def deep
-    raise RuntimeError.new("Stuff happens")
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bugsnag
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - James Smith
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-10 00:00:00 Z
+date: 2012-01-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -150,10 +150,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bugsnag.gemspec
 - lib/bugsnag.rb
 - lib/bugsnag/configuration.rb
-- lib/bugsnag/event.rb
-- lib/bugsnag/notifier.rb
+- lib/bugsnag/helpers.rb
+- lib/bugsnag/notification.rb
 - lib/bugsnag/rack.rb
 - lib/bugsnag/rails.rb
 - lib/bugsnag/rails/action_controller_rescue.rb

data/lib/bugsnag/event.rb

@@ -1,71 +0,0 @@
-require "multi_json"
-
-module Bugsnag
-  class Event
-    attr_accessor :exception, :user_id, :app_environment, :web_environment, :meta_data
-    
-    def initialize(exception, user_id, env={})
-      self.exception = exception
-      self.user_id = user_id
-      self.app_environment = env[:app_environment]
-      self.web_environment = env[:web_environment]
-      self.meta_data = env[:meta_data]
-    end
-
-    def error_class
-      exception.class.to_s
-    end
-    
-    def message
-      exception.message
-    end
-
-    def stacktrace(project_path=nil)
-      return @stacktrace if @stacktrace
-
-      if exception.backtrace
-        @stacktrace = exception.backtrace.map do |trace|
-          method = nil
-          file, line, method_str = trace.split(":")
-        
-          trace_hash = {
-            :file => file,
-            :lineNumber => line
-          }
-        
-          if method_str
-            method_match = /in `([^']+)'/.match(method_str)
-            method = method_match.captures.first if method_match
-          end
-
-          trace_hash[:method] = method if method
-          trace_hash[:inProject] = true if project_path && file.match(/^#{project_path}/)
-        
-          trace_hash
-        end
-      else
-        @stacktrace = []
-      end
-      
-      @stacktrace
-    end
-
-    def as_hash
-      {
-        :userId => user_id,
-        :causes => [{
-          :errorClass => error_class,
-          :message => message,
-          :stacktrace => stacktrace
-        }],
-        :appEnvironment => app_environment,
-        :webEnvironment => web_environment,
-        :metaData => meta_data
-      }
-    end
-
-    def as_json
-      MultiJson.encode(as_hash)
-    end
-  end
-end

data/lib/bugsnag/notifier.rb

@@ -1,55 +0,0 @@
-require "httparty"
-require "multi_json"
-
-module Bugsnag
-  class Notifier
-    include HTTParty
-
-    headers  "Content-Type" => "application/json"
-    
-    NOTIFIER_NAME = "Ruby Bugsnag Notifier"
-    NOTIFIER_VERSION = "1.0.0"
-    NOTIFIER_URL = "http://www.bugsnag.com"
-
-    def initialize(configuration)
-      @configuration = configuration
-    end
-
-    def notify(exception, meta_data={})
-      event = Bugsnag::Event.new(exception, "TODO USER ID", {
-        :app_environment => build_app_environment,
-        :web_environment => build_web_environment,
-        :meta_data => meta_data
-      })
-      
-      payload = {
-        :apiKey => @configuration.api_key,
-        :notifier => {
-          :name => NOTIFIER_NAME,
-          :version => NOTIFIER_VERSION,
-          :url => NOTIFIER_URL
-        },
-        :errors => [event.as_hash]
-      }
-
-      self.class.post(@configuration.endpoint, {:body => MultiJson.encode(payload)})
-      
-      Bugsnag.log("Notified bugsnag.com of exception")
-    end
-    
-    private
-    def build_app_environment
-      {
-        :releaseStage => @configuration.release_stage,
-        :projectRoot => @configuration.project_root.to_s
-        # TODO: Add in environmental variables
-      }
-    end
-    
-    def build_web_environment
-      {
-        
-      }
-    end
-  end
-end