bugsnag 1.0.10 → 1.1.0

data/Gemfile.lock

@@ -1,18 +1,23 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    crack (0.1.8)
     git (1.2.5)
-    httparty (0.7.8)
-      crack (= 0.1.8)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    multi_json (1.1.0)
-    rake (0.9.2)
-    rcov (0.9.11)
-    shoulda (2.11.3)
+    multi_json (1.3.2)
+    multi_xml (0.4.4)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -0,0 +1,230 @@
+Official Bugsnag Notifier for Ruby
+==================================
+
+The Bugsnag Notifier for Ruby gives you instant notification of exceptions
+thrown from your **Rails**, **Sinatra**, **Rack** or **plain Ruby** app.
+Any uncaught exceptions will trigger a notification to be sent to your 
+Bugsnag project.
+
+
+What is Bugsnag?
+----------------
+
+[Bugsnag](http://bugsnag.com) captures errors in real-time from your web, 
+mobile and desktop applications, helping you to understand and resolve them 
+as fast as possible. [Create a free account](http://bugsnag.com).
+
+
+How to Install (Rails)
+----------------------
+
+1.  Add the `bugsnag` gem to your `Gemfile`
+
+    ```ruby
+    gem "bugsnag"
+    ```
+
+2.  Install the gem
+
+    ```shell
+    bundle install
+    ```
+
+3.  Copy the following code to a new file at `config/initializers/bugsnag.rb`
+
+    ```ruby
+    Bugsnag.configure do |config|
+      config.api_key = "YOUR_API_KEY_HERE"
+    end
+    ```
+
+How to Install (Sinatra)
+------------------------
+
+```ruby
+require "bugsnag"
+
+Bugsnag.configure do |config|
+  config.api_key = "YOUR_API_KEY_HERE"
+end
+
+use Bugsnag::Rack
+```
+
+
+Send Non-Fatal Exceptions to Bugsnag
+------------------------------------
+
+If you would like to send non-fatal exceptions to Bugsnag, there are two 
+ways of doing so. From a rails controller, you can call `notify_bugsnag`:
+
+```ruby
+notify_bugsnag(RuntimeError.new("Something broke"))
+```
+
+You can also send additional meta-data with your exception:
+
+```ruby
+notify_bugsnag(RuntimeError.new("Something broke"), {
+  :username => "bob-hoskins",
+  :registered_user => true
+})
+```
+
+Anywhere else in your ruby code, you can call `Bugsnag.notify`:
+
+```ruby
+Bugsnag.notify(RuntimeError.new("Something broke"));
+```
+
+
+Configuration
+-------------
+
+To configure additional Bugsnag settings, use the block syntax and set any
+settings you need on the `config` block variable. For example:
+
+```ruby
+Bugsnag.configure do |config|
+  config.api_key = "your-api-key-here"
+  config.use_ssl = true
+  config.notify_release_stages = ["production", "development"]
+end
+```
+
+###api_key
+
+Your Bugsnag API key (required).
+
+```ruby
+config.api_key = "your-api-key-here"
+```
+
+###release_stage
+
+If you would like to distinguish between errors that happen in different
+stages of the application release process (development, production, etc)
+you can set the `release_stage` that is reported to Bugsnag.
+
+```ruby
+config.release_stage = "development"
+```
+    
+In rails apps this value is automatically set from `RAILS_ENV`, and in rack
+apps it is automatically set to `RACK_ENV`. Otherwise the default is 
+"production".
+
+###notify_release_stages
+
+By default, we will only notify Bugsnag of exceptions that happen when 
+your `release_stage` is set to be "production". If you would like to 
+change which release stages notify Bugsnag of exceptions you can
+set `notify_release_stages`:
+    
+```ruby
+config.notify_release_stages = ["production", "development"]
+```
+
+###auto_notify
+
+By default, we will automatically notify Bugsnag of any fatal exceptions
+in your application. If you want to stop this from happening, you can set
+`auto_notify`:
+    
+```ruby
+config.auto_notify = false
+```
+
+###use_ssl
+
+Enforces all communication with bugsnag.com be made via ssl.
+
+```ruby
+config.use_ssl = true
+```
+
+By default, `use_ssl` is set to false.
+
+###project_root
+
+We mark stacktrace lines as `inProject` if they come from files inside your
+`project_root`. In rails apps this value is automatically set to `RAILS_ROOT`,
+otherwise you should set it manually:
+
+```ruby
+config.project_root = "/var/www/myproject"
+```
+
+###app_version
+
+If you want to track which versions of your application each exception 
+happens in, you can set `app_version`. This is set to `nil` by default.
+
+```ruby
+config.app_version = "2.5.1"
+```
+
+###params_filters
+
+Sets the strings to filter out from the `params` hashes before sending
+them to Bugsnag. Use this if you want to ensure you don't send 
+sensitive data such as passwords, and credit card numbers to our 
+servers. Any keys which contain these strings will be filtered.
+
+```ruby
+config.params_filters << "credit_card_number"
+```
+
+By default, `params_filters` is set to `["password", "password_confirmation"]`
+
+###ignore_classes
+
+Sets for which exception classes we should not send exceptions to bugsnag.com.
+
+```ruby
+config.ignore_classes << "ActiveRecord::StatementInvalid"
+```
+
+By default, `ignore_classes` contains the following classes:
+
+```ruby
+[
+  "ActiveRecord::RecordNotFound",
+  "ActionController::RoutingError",
+  "ActionController::InvalidAuthenticityToken",
+  "CGI::Session::CookieStore::TamperedWithCookie",
+  "ActionController::UnknownAction",
+  "AbstractController::ActionNotFound"
+]
+```
+
+
+Reporting Bugs or Feature Requests
+----------------------------------
+
+Please report any bugs or feature requests on the github issues page for this
+project here:
+
+<https://github.com/bugsnag/bugsnag-ruby/issues>
+
+
+Contributing
+------------
+ 
+-   Check out the latest master to make sure the feature hasn't been 
+    implemented or the bug hasn't been fixed yet
+-   Check out the issue tracker to make sure someone already hasn't requested
+    it and/or contributed it
+-   Fork the project
+-   Start a feature/bugfix branch
+-   Commit and push until you are happy with your contribution
+-   Thanks!
+
+
+License
+-------
+
+The Bugsnag ruby notifier is released under the
+Apache License, Version 2.0. Read the full license here:
+
+<http://www.apache.org/licenses/LICENSE-2.0>

data/VERSION

@@ -1 +1 @@
-1.0.10
+1.1.0

data/bugsnag.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = "bugsnag"
-  s.version = "1.0.10"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Smith"]
-  s.date = "2012-02-27"
+  s.date = "2012-06-18"
   s.description = "Ruby notifier for bugsnag.com"
   s.email = "james@bugsnag.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bugsnag.gemspec",
@@ -35,8 +35,8 @@ Gem::Specification.new do |s|
     "lib/bugsnag/rails/action_controller_rescue.rb",
     "lib/bugsnag/rails/controller_methods.rb",
     "lib/bugsnag/railtie.rb",
-    "lib/bugsnag/resque.rb",
     "lib/bugsnag/version.rb",
+    "lib/resque/failure/bugsnag.rb",
     "rails/init.rb",
     "test/helper.rb",
     "test/test_bugsnag.rb"

data/lib/bugsnag.rb

@@ -7,7 +7,8 @@ require "bugsnag/helpers"
 
 require "bugsnag/rack"
 require "bugsnag/railtie" if defined?(Rails::Railtie)
-require "bugsnag/resque" if defined?(Resque)
+
+require "resque/failure/bugsnag" if defined?(Resque)
 
 module Bugsnag
   LOG_PREFIX = "** [Bugsnag] "
@@ -42,7 +43,7 @@ module Bugsnag
     # rescuers, unless auto notification is disabled, or we should ignore this
     # error class
     def auto_notify(exception, session_data={})
-      notify_or_ignore(exception, session_data) unless configuration.disable_auto_notification
+      notify_or_ignore(exception, session_data) if configuration.auto_notify
     end
 
     # Log wrapper

data/lib/bugsnag/configuration.rb

@@ -1,9 +1,13 @@
 module Bugsnag
   class Configuration
+    # TODO:JS enforce notify_release_stages
     OPTIONS = [
-      :api_key, :release_stage, :use_ssl, :project_root, :app_version,
-      :framework, :endpoint, :logger, :disable_auto_notification,
-      :params_filters, :stacktrace_filters, :ignore_classes,
+      :api_key, :release_stage, :notify_release_stages, :auto_notify,
+      :use_ssl, :project_root, :app_version,
+      :params_filters, :ignore_classes,
+      
+      :stacktrace_filters,
+      :framework, :endpoint, :logger,
       :delay_with_resque
     ]
     OPTIONS.each {|o| attr_accessor o }
@@ -43,6 +47,9 @@ module Bugsnag
       @params_filters = DEFAULT_PARAMS_FILTERS.dup
       @stacktrace_filters = DEFAULT_STACKTRACE_FILTERS.dup
       @ignore_classes = DEFAULT_IGNORE_CLASSES.dup
+      @auto_notify = true
+      @release_stage = "production"
+      @notify_release_stages = ["production"]
     end
     
     def to_hash

data/lib/bugsnag/notification.rb

@@ -9,22 +9,22 @@ module Bugsnag
     NOTIFIER_VERSION = Bugsnag::VERSION
     NOTIFIER_URL = "http://www.bugsnag.com"
 
-    DEFAULT_ENDPOINT = "api.bugsnag.com/notify"
+    DEFAULT_ENDPOINT = "notify.bugsnag.com"
 
     # HTTParty settings
     headers  "Content-Type" => "application/json"
     default_timeout 5
 
     # Basic notification attributes
-    attr_accessor :exception
+    attr_accessor :exceptions
 
     # Attributes from session
     attr_accessor :user_id, :context, :meta_data
 
     # Attributes from configuration
     attr_accessor :api_key, :params_filters, :stacktrace_filters, 
-                  :ignore_classes, :endpoint, :app_version, :release_stage, 
-                  :project_root, :use_ssl
+                  :ignore_classes, :endpoint, :app_version, :release_stage,
+                  :notify_release_stages, :project_root, :use_ssl
 
 
     def self.deliver_exception_payload(endpoint, payload_string)
@@ -36,19 +36,31 @@ module Bugsnag
     end
 
     def initialize(exception, opts={})
-      self.exception = exception
+      self.exceptions = []
+      ex = exception
+      while ex != nil
+        self.exceptions << ex
+
+        if ex.respond_to?(:continued_exception) && ex.continued_exception
+          ex = ex.continued_exception
+        elsif ex.respond_to?(:original_exception) && ex.original_exception
+          ex = ex.original_exception
+        else
+          ex = nil
+        end
+      end
+
       opts.reject! {|k,v| v.nil?}.each do |k,v|
         self.send("#{k}=", v) if self.respond_to?("#{k}=")
       end
     end
 
     def deliver
-      # Unless we are using a custom endpoint, use api.bugsnag.com, and work out protocol
-      unless self.endpoint
-        self.endpoint = (self.use_ssl ? "https://" : "http://") + DEFAULT_ENDPOINT
-      end
+      return unless self.notify_release_stages.include?(self.release_stage)
+      
+      endpoint = (self.use_ssl ? "https://" : "http://") + (self.endpoint || DEFAULT_ENDPOINT)
 
-      Bugsnag.log("Notifying #{self.endpoint} of exception")
+      Bugsnag.log("Notifying #{endpoint} of exception")
 
       payload = {
         :apiKey => self.api_key,
@@ -58,16 +70,16 @@ module Bugsnag
           :appVersion => self.app_version,
           :releaseStage => self.release_stage,
           :context => self.context,
-          :exceptions => [exception_hash],
+          :exceptions => exception_list,
           :metaData => self.meta_data
         }.reject {|k,v| v.nil? }]
       }
 
-      self.class.deliver_exception_payload(self.endpoint, MultiJson.encode(payload))
+      self.class.deliver_exception_payload(endpoint, MultiJson.encode(payload))
     end
 
     def ignore?
-      self.ignore_classes.include?(error_class(self.exception))
+      self.ignore_classes.include?(error_class(self.exceptions.last))
     end
 
 
@@ -84,15 +96,30 @@ module Bugsnag
       @notifier
     end
 
-    def stacktrace_hash
-      stacktrace = self.exception.backtrace || caller
-      stacktrace.map do |trace|
+    def exception_list
+      self.exceptions.map do |exception|
+        {
+          :errorClass => error_class(exception),
+          :message => exception.message,
+          :stacktrace => stacktrace(exception)
+        }
+      end
+    end
+    
+    def error_class(exception)
+      # The "Class" check is for some strange exceptions like Timeout::Error 
+      # which throw the error class instead of an instance
+      (exception.is_a? Class) ? exception.name : exception.class.name
+    end
+
+    def stacktrace(exception)
+      (exception.backtrace || caller).map do |trace|
         method = nil
         file, line_str, method_str = trace.split(":")
 
         # Generate the stacktrace line hash
         trace_hash = {}
-        trace_hash[:inProject] = true if self.project_root && file.match(/^#{self.project_root}/)
+        trace_hash[:inProject] = true if self.project_root && file.match(/^#{self.project_root}/) && !file.match(/vendor\//)
         trace_hash[:file] = self.stacktrace_filters.inject(file) {|file, proc| proc.call(file) }
         trace_hash[:lineNumber] = line_str.to_i
 
@@ -110,19 +137,5 @@ module Bugsnag
         end
       end.compact
     end
-
-    def exception_hash
-      {
-        :errorClass => error_class(self.exception),
-        :message => self.exception.message,
-        :stacktrace => stacktrace_hash
-      }
-    end
-    
-    def error_class(exception)
-      # The "Class" check is for some strange exceptions like Timeout::Error 
-      # which throw the error class instead of an instance
-      (exception.is_a? Class) ? exception.name : exception.class.name
-    end
   end
 end

data/lib/bugsnag/railtie.rb

@@ -15,10 +15,11 @@ module Bugsnag
 
     config.after_initialize do
       Bugsnag.configure do |config|
-        config.logger ||= Rails.logger
-        config.release_stage ||= Rails.env
-        config.project_root ||= Rails.root
+        config.release_stage = Rails.env
+        config.project_root = Rails.root
         config.framework = "Rails: #{::Rails::VERSION::STRING}"
+
+        config.logger ||= Rails.logger
       end
 
       if defined?(::ActionController::Base)

data/lib/resque/failure/bugsnag.rb

@@ -0,0 +1,47 @@
+# Resque support
+
+# How to use:
+#   Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Bugsnag]
+#   Resque::Failure.backend = Resque::Failure::Multiple
+#
+
+begin
+  require "bugsnag"
+rescue LoadError
+  raise "Can't find 'bugsnag' gem. Please add it to your Gemfile or install it."
+end
+
+require "resque/failure/base"
+
+module Resque
+  module Failure
+    class Bugsnag < Base
+      def self.configure(&block)
+        unless ::Resque::Failure.backend < ::Resque::Failure::Multiple
+          original_backend = ::Resque::Failure.backend
+          ::Resque::Failure.backend = ::Resque::Failure::Multiple
+          ::Resque::Failure.backend.classes ||= []
+          ::Resque::Failure.backend.classes << original_backend
+        end
+
+        ::Resque::Failure.backend.classes << self
+        ::Bugsnag.configure(&block)
+      end
+
+      def save
+        ::Bugsnag.auto_notify(exception, bugsnag_job_data)
+      end
+    
+      private
+      def bugsnag_job_data
+        {
+          :user_id => nil, # TODO: How to infer a user id in resque?
+          :context => "resque: #{queue}",
+          :meta_data => {
+            :payload => payload
+          }
+        }
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bugsnag
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 10
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Smith
@@ -15,9 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-27 00:00:00 Z
+date: 2012-06-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,9 +30,9 @@ dependencies:
         version: "0"
   requirement: *id001
   type: :runtime
-  prerelease: false
   name: multi_json
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -43,9 +44,9 @@ dependencies:
         version: "0"
   requirement: *id002
   type: :runtime
-  prerelease: false
   name: httparty
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,9 +58,9 @@ dependencies:
         version: "0"
   requirement: *id003
   type: :development
-  prerelease: false
   name: shoulda
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -73,9 +74,9 @@ dependencies:
         version: 1.0.0
   requirement: *id004
   type: :development
-  prerelease: false
   name: bundler
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -89,9 +90,9 @@ dependencies:
         version: 1.6.4
   requirement: *id005
   type: :development
-  prerelease: false
   name: jeweler
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -103,7 +104,6 @@ dependencies:
         version: "0"
   requirement: *id006
   type: :development
-  prerelease: false
   name: rcov
 description: Ruby notifier for bugsnag.com
 email: james@bugsnag.com
@@ -113,13 +113,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bugsnag.gemspec
@@ -133,8 +133,8 @@ files:
 - lib/bugsnag/rails/action_controller_rescue.rb
 - lib/bugsnag/rails/controller_methods.rb
 - lib/bugsnag/railtie.rb
-- lib/bugsnag/resque.rb
 - lib/bugsnag/version.rb
+- lib/resque/failure/bugsnag.rb
 - rails/init.rb
 - test/helper.rb
 - test/test_bugsnag.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= bugsnag
-
-Description goes here.
-
-== Contributing to bugsnag
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 James Smith. See LICENSE.txt for
-further details.
-

data/lib/bugsnag/resque.rb

@@ -1,36 +0,0 @@
-# Resque support
-
-# How to use:
-#   Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Bugsnag::Resque]
-#   Resque::Failure.backend = Resque::Failure::Multiple
-#
-module Bugsnag
-  class Resque < ::Resque::Failure::Base
-    def self.configure(&block)
-      unless ::Resque::Failure.backend < ::Resque::Failure::Multiple
-        original_backend = ::Resque::Failure.backend
-        ::Resque::Failure.backend = ::Resque::Failure::Multiple
-        ::Resque::Failure.backend.classes ||= []
-        ::Resque::Failure.backend.classes << original_backend
-      end
-
-      ::Resque::Failure.backend.classes << self
-      ::Bugsnag.configure(&block)
-    end
-
-    def save
-      Bugsnag.auto_notify(exception, bugsnag_job_data)
-    end
-    
-    private
-    def bugsnag_job_data
-      {
-        :user_id => nil, # TODO: How to infer a user id in resque?
-        :context => "resque: #{queue}",
-        :meta_data => {
-          :payload => payload
-        }
-      }
-    end
-  end
-end