bugsnag 2.8.12 → 2.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2f66dcb23eacb6017a6815314dd03cd8d245566
-  data.tar.gz: b46962c2a2cad2007e43fcea706e243aabf38af9
+  metadata.gz: 7d6aa2d47b176056a2296c83ed021e60535d8500
+  data.tar.gz: 993b3197a9a58242cc35f27ee6e89144c0a5bc56
 SHA512:
-  metadata.gz: e04d26556f1ba98779c04754fa2820d2248f2033d5b54348cd5a42237bbd4754913c814ee3b86d804482478b260905a931aa54da063126489a059b4cdcb32d2f
-  data.tar.gz: b637b49697e20df7b3ad6f0b33485a928835f7edd71a9e410a947af18d0e684c6c5c6e7a2c9e481c32b3291089305a981c8e5327255f90a051c13502f86b27a6
+  metadata.gz: 42e61fc1a225f0428fe20357d0af38f022e9fecd835b0c414651f2873e26f00165beee2059920002185db91e082896fa225b68024bad6b74d5d6c20452c2eb46
+  data.tar.gz: 4d55d3468985cc4a7b6b7b2275b26af66ae0b39d200b2063a9db687990e67f927d2fd663034484dfe4db6fb898f3ec66009c2eba1624846d68b590c6ae86fecf

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 Changelog
 =========
 
+2.8.13
+------
+
+### Bug Fixes
+
+* Fix crash during heroku Rake task when an environment variable was empty
+  | [#261](https://github.com/bugsnag/bugsnag-ruby/issues/261)
+
+### Enhancements
+
+* Various warning fixes
+  | [Taylor Fausak](https://github.com/tfausak)
+  | [#254](https://github.com/bugsnag/bugsnag-ruby/pull/254)
+* Make the list of vendor paths configurable
+  | [Jean Boussier](https://github.com/byroot)
+  | [#253](https://github.com/bugsnag/bugsnag-ruby/pull/253)
+
 2.8.12
 ------
 

data/README.md

@@ -1,4 +1,4 @@
-Bugsnag Notifier for Ruby
+Bugsnag Notifier for Ruby <img src="https://travis-ci.org/bugsnag/bugsnag-ruby.svg?branch=master" alt="build status" class="build-status">
 =========================
 
 The Bugsnag Notifier for Ruby gives you instant notification of exceptions
@@ -15,17 +15,31 @@ capturing exceptions from your applications.
 Contents
 --------
 
-- [How to Install](#how-to-install)
-- [Sending Custom Data With Exceptions](#sending-custom-data-with-exceptions)
-- [Sending Handled Exceptions](#sending-handled-exceptions)
-- [Configuration](#configuration)
-- [Bugsnag Middleware](#bugsnag-middleware)
-- [Deploy Tracking](#deploy-tracking)
-- [EventMachine Apps](#eventmachine-apps)
+- [Getting Started](#getting-started)
+	- [Installation](#installation)
+	- [Rake Integration](#rake-integration)
+	- [Sending a Test Notification](#sending-a-test-notification)
+- [Usage](#usage)
+	- [Catching and Reporting Exceptions](#catching-and-reporting-exceptions)
+	- [Sending Non-fatal Exceptions](#sending-non-fatal-exceptions)
+	- [Deploy Tracking](#deploy-tracking)
+	- [Callbacks](#callbacks)
 - [Demo Applications](#demo-applications)
+- [Support](#support)
+- [Contributing](#contributing)
+- [License](#license)
 
-How to Install
---------------
+- [Additional Documentation](https://github.com/bugsnag/bugsnag-ruby/tree/master/docs)
+	- [Configuration](docs/Configuration.md)
+	- [Notification Options](docs/Notification Options.md)
+
+
+
+Getting Started
+---------------
+
+
+### Installation
 
 1.  Add the `bugsnag` gem to your `Gemfile`
 
@@ -58,247 +72,7 @@ How to Install
     The Bugsnag module will read the `BUGSNAG_API_KEY` environment variable if you
     do not configure one automatically.
 
-4.  **Rack/Sinatra apps only**: Activate the Bugsnag Rack middleware
-
-    ```ruby
-    use Bugsnag::Rack
-    ```
-
-    **Sinatra**: Note that `raise_errors` must be enabled. If you are using custom
-    error handlers, then you will need to notify Bugsnag explicitly:
-
-    ```ruby
-    error 500 do
-      Bugsnag.auto_notify($!)
-      erb :"errors/500"
-    end
-    ```
-
-Sending Custom Data With Exceptions
------------------------------------
-
-It is often useful to send additional meta-data about your app, such as
-information about the currently logged in user, along with any
-exceptions, to help debug problems.
-
-### Rails Apps
-
-By default Bugsnag includes some information automatically. For example, we
-send all the HTTP headers for requests. Additionally if you're using Warden or
-Devise, the id, name and email of the current user are sent.
-
-To send additional information, in any rails controller you can define a `before_bugsnag_notify` callback, which allows you to add this additional data by calling `add_tab` on the exception notification object. Please see the [Notification Object](#notification-object) for details on the notification parameter.
-
-```ruby
-class MyController < ApplicationController
-  # Define the filter
-  before_bugsnag_notify :add_user_info_to_bugsnag
-
-  # Your controller code here
-
-  private
-  def add_user_info_to_bugsnag(notif)
-    # Set the user that this bug affected
-    # Email, name and id are searchable on bugsnag.com
-    notif.user = {
-      email: current_user.email,
-      name: current_user.name,
-      id: current_user.id
-    }
-
-    # Add some app-specific data which will be displayed on a custom
-    # "Diagnostics" tab on each error page on bugsnag.com
-    notif.add_tab(:diagnostics, {
-      product: current_product.name
-    })
-  end
-end
-```
-
-### Rails API Apps
-
-If you are building an API using the [rails-api](https://github.com/rails-api/rails-api) gem, your controllers will inherit from `ActionController::API` instead of `ActionController::Base`.
-
-In this case, the `before_bugsnag_notify` filter will not be automatically available in your controllers.  In order to use it, you will need to include the module `Bugsnag::Rails::ControllerMethods`.
-
-```ruby
-class ApplicationController < ActionController::API
-
-  # Include module which defines the before_bugsnag_notify filter
-  include Bugsnag::Rails::ControllerMethods
-
-  # Other code here
-end
-```
-
-### Other Ruby Apps
-
-In other ruby apps, you can provide lambda functions to execute before any `Bugsnag.notify` calls as follows. Don't forget to clear the callbacks at the end of each request or session. In Rack applications like Sinatra, this is automatically done for you.
-
-```ruby
-# Set a before notify callback
-Bugsnag.before_notify_callbacks << lambda {|notif|
-  notif.add_tab(:user_info, {
-    name: current_user.name
-  })
-}
-
-# Your app code here
-
-# Clear the callbacks
-Bugsnag.before_notify_callbacks.clear
-```
-
-### Notification Object
-
-The notification object is passed to all [before bugsnag notify](#sending-custom-data-with-exceptions) callbacks and is used to manipulate the error report before it is transmitted.
-
-#### add_tab
-
-Call add_tab on a notification object to add a tab to the error report so that it would appear on your dashboard.
-
-```ruby
-notif.add_tab(:user_info, {
-  name: current_user.name
-})
-```
-
-The first parameter is the tab name that will appear in the error report and the second is the key, value list that will be displayed in the tab.
-
-#### remove_tab
-
-Removes a tab completely from the error report
-
-```ruby
-notif.remove_tab(:request)
-```
-
-#### ignore!
-
-Calling ignore! on a notification object will cause the notification to not be sent to bugsnag. This means that you can choose dynamically not to send an error depending on application state or the error itself.
-
-```ruby
-notif.ignore! if foo == 'bar'
-```
-
-#### grouping_hash
-
-Sets the grouping hash of the error report. All errors with the same grouping hash are grouped together. This is an advanced usage of the library and mis-using it will cause your errors not to group properly in your dashboard.
-
-```ruby
-notif.grouping_hash = "#{exception.message}#{exception.class}"
-```
-
-#### severity
-
-Set the severity of the error. Severity can be `error`, `warning` or `info`.
-
-```ruby
-notif.severity = "error"
-```
-
-#### context
-
-Set the context of the error report. This is notionally the location of the error and should be populated automatically. Context is displayed in the dashboard prominently.
-
-```ruby
-notif.context = "billing"
-```
-
-#### user
-
-You can set or read the user with the user property of the notification. The user will be a hash of `email`, `id` and `name`.
-
-```ruby
-notif.user = {
-  id: current_user.id,
-  email: current_user.email,
-  name: current_user.name
-}
-```
-
-#### exceptions
-
-Allows you to read the exceptions that will be combined into the report.
-
-```ruby
-puts "#{notif.exceptions.first.message} found!"
-```
-
-#### meta_data
-
-Provides access to the meta_data in the error report.
-
-```ruby
-notif.ignore! if notif.meta_data[:sidekiq][:retry_count] > 2
-```
-
-### Exceptions with Meta Data
-
-If you include the `Bugsnag::MetaData` module into your own exceptions, you can
-associate meta data with a particular exception.
-
-```ruby
-class MyCustomException < Exception
-  include Bugsnag::MetaData
-end
-
-exception = MyCustomException.new("It broke!")
-exception.bugsnag_meta_data = {
-  :user_info => {
-    name: current_user.name
-  }
-}
-
-raise exception
-```
-
-You can read more about how callbacks work in the
-[Bugsnag Middleware](#bugsnag-middleware) documentation below.
-
-
-Sending Handled Exceptions
-----------------------------
-
-If you would like to send non-fatal exceptions to Bugsnag, you can call
-`Bugsnag.notify`:
-
-```ruby
-Bugsnag.notify(RuntimeError.new("Something broke"))
-```
-
-### Custom Data
-
-You can also send additional meta-data with your exception:
-
-```ruby
-Bugsnag.notify(RuntimeError.new("Something broke"), {
-  :user => {
-    :username => "bob-hoskins",
-    :registered_user => true
-  }
-})
-```
-
-### Severity
-
-You can set the severity of an error in Bugsnag by including the severity option when
-notifying bugsnag of the error,
-
-```ruby
-Bugsnag.notify(RuntimeError.new("Something broke"), {
-  :severity => "error",
-})
-```
-
-Valid severities are `error`, `warning` and `info`.
-
-Severity is displayed in the dashboard and can be used to filter the error list.
-By default all crashes (or unhandled exceptions) are set to `error` and all
-`Bugsnag.notify` calls default to `warning`.
-
-Rake Integration
-----------------
+### Rake Integration
 
 Rake integration is automatically enabled in Rails 3/4 apps, so providing you load the environment
 in your Rake tasks you dont need to do anything to get Rake support. If you choose not to load
@@ -322,24 +96,9 @@ YourApp::Application.load_tasks
 > Note: We also configure Bugsnag in the Rakefile, so the tasks that do not load the full
 environment can still notify Bugsnag.
 
-Standard Ruby Scripts
----------------------
-
-If you are running a standard ruby script, you can ensure that all exceptions are sent to Bugsnag by
-adding the following code to your app:
-
-```ruby
-at_exit do
-  if $!
-    Bugsnag.notify($!)
-  end
-end
-```
+### Sending a Test Notification
 
-Testing Integration
--------------------
-
-To test that bugsnag is properly configured, you can use the test_exception rake task like this,
+To test that bugsnag is properly configured, you can use the `test_exception` rake task:
 
 ```bash
 rake bugsnag:test_exception
@@ -347,244 +106,91 @@ rake bugsnag:test_exception
 
 A test exception will be sent to your bugsnag dashboard if everything is configured correctly.
 
-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.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".
+Usage
+-----
 
-###notify_release_stages
+### Catching and Reporting Exceptions
 
-By default, we will notify Bugsnag of exceptions that happen in any
-`release_stage`. 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"]
-```
-
-###endpoint
-
-By default, we'll send crashes to *notify.bugsnag.com* to display them on
-your dashboard. If you are using *Bugsnag Enterprise* you'll need to set
-this to be your *Event Server* endpoint, for example:
-
-```ruby
-config.endpoint = "bugsnag.example.com:49000"
-```
-
-###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. You can turn
-this off if necessary.
-
-```ruby
-config.use_ssl = false
-```
-
-By default, `use_ssl` is set to true.
-
-<!-- Custom anchor for linking from alerts -->
-<div id="set-project-root"></div>
-###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 which keys should be filtered out from `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. You can add both
-strings and regular expressions to this array. When adding strings, keys which
-*contain* the string will be filtered. When adding regular expressions, any
-keys which *match* the regular expression will be filtered.
-
-```ruby
-config.params_filters += ["credit_card_number", /^password$/]
-```
-
-By default, `params_filters` is set to `[/authorization/i, /cookie/i,
-/password/i, /secret/i]`, and for rails apps, imports all values from
-`Rails.configuration.filter_parameters`.
-
-###ignore_classes
-
-Sets for which exception classes we should not send exceptions to bugsnag.com.
-
-```ruby
-config.ignore_classes << "ActiveRecord::StatementInvalid"
-```
-
-You can also provide a lambda function here to ignore by other exception
-attributes or by a regex:
-
-```ruby
-config.ignore_classes << lambda {|ex| ex.message =~ /timeout/}
-```
-
-By default, `ignore_classes` contains the following:
-
-```ruby
-[
-  "ActiveRecord::RecordNotFound",
-  "ActionController::RoutingError",
-  "ActionController::InvalidAuthenticityToken",
-  "CGI::Session::CookieStore::TamperedWithCookie",
-  "ActionController::UnknownAction",
-  "AbstractController::ActionNotFound"
-]
-```
-
-###ignore_user_agents
-
-Sets an array of Regexps that can be used to ignore exceptions from
-certain user agents.
-
-```ruby
-config.ignore_user_agents << %r{Chrome}
-```
-
-By default, `ignore_user_agents` is empty, so exceptions caused by all
-user agents are reported.
+Bugsnag Ruby works out of the box with Rails, Sidekiq, Resque, DelayedJob (3+), Mailman, Rake and Rack. It
+should be easy to add support for other frameworks, either by sending a pull request here or adding a hook
+to those projects.
 
-###proxy_host
+#### Rack/Sinatra Apps
 
-Sets the address of the HTTP proxy that should be used for requests to bugsnag.
+Activate the Bugsnag Rack middleware
 
 ```ruby
-config.proxy_host = "10.10.10.10"
+use Bugsnag::Rack
 ```
 
-###proxy_port
-
-Sets the port of the HTTP proxy that should be used for requests to bugsnag.
+**Sinatra**: Note that `raise_errors` must be enabled. If you are
+    using custom error handlers, then you will need to notify Bugsnag
+    explicitly:
 
 ```ruby
-config.proxy_port = 1089
+error 500 do
+  Bugsnag.auto_notify($!)
+  erb :"errors/500"
+end
 ```
 
-###proxy_user
+#### Custom Ruby Scripts
 
-Sets the user that should be used to send requests to the HTTP proxy for requests to bugsnag.
+**Custom Ruby Scripts**: If you are running a standard ruby script,
+you can ensure that all exceptions are sent to Bugsnag by adding
+the following code to your app:
 
 ```ruby
-config.proxy_user = "proxy_user"
+at_exit do
+  if $!
+    Bugsnag.notify($!)
+  end
+end
 ```
 
-###proxy_password
-
-Sets the password for the user that should be used to send requests to the HTTP proxy for requests to bugsnag.
-
-```ruby
-config.proxy_password = "proxy_secret_password_here"
-```
+#### EventMachine Apps
 
-###timeout
-By default the timeout for posting errors to Bugsnag is 15 seconds, to change this
-you can set the `timeout`:
+If your app uses [EventMachine](http://rubyeventmachine.com/) you'll need to
+manually notify Bugsnag of errors. There are two ways to do this in your
+EventMachine apps, first you should implement `EventMachine.error_handler`:
 
 ```ruby
-config.timeout = 10
+EventMachine.error_handler{|e|
+  Bugsnag.notify(e)
+}
 ```
 
-###logger
-
-Sets which logger to use for Bugsnag log messages. In rails apps, this is
-automatically set to use `Rails.logger`, otherwise it will be set to
-`Logger.new(STDOUT)`.
-
-###middleware
-
-Provides access to the middleware stack, see the
-[Bugsnag Middleware](#bugsnag-middleware) section below for details.
-
-###app_type
-
-You can set the type of application executing the current code by using `app_type`:
+If you want more fine-grained error handling, you can use the
+[errback](http://eventmachine.rubyforge.org/EventMachine/Deferrable.html#errback-instance_method)
+function, for example:
 
 ```ruby
-config.app_type = "resque"
+EventMachine::run do
+  server = EventMachine::start_server('0.0.0.0', PORT, MyServer)
+  server.errback {
+    EM.defer do
+      Bugsnag.notify(RuntimeError.new("Something bad happened"))
+    end
+  }
+end
 ```
 
-This is usually used to represent if you are running in a Rails server, Sidekiq job or
-Rake task for example. Bugsnag will automatically detect most application types for you.
+For this to work, include [Deferrable](http://eventmachine.rubyforge.org/EventMachine/Deferrable.html)
+in your `MyServer`, then whenever you want to raise an error, call `fail`.
 
-###send_environment
+### Sending Non-fatal Exceptions
 
-Bugsnag can transmit your rack environment to help diagnose issues. This environment
-can sometimes contain private information so Bugsnag does not transmit by default. To
-send your rack environment, set the `send_environment` option to `true`.
+If you would like to send non-fatal exceptions to Bugsnag, you can call
+`Bugsnag.notify`:
 
 ```ruby
-config.send_environment = true
+Bugsnag.notify(RuntimeError.new("Something broke"))
 ```
 
-###send_code
-
-Bugsnag automatically sends a small snippet of the code that crashed to help you diagnose
-even faster from within your dashboard. If you don't want to send this snippet you can
-set the `send_code` option to `false`.
+Additional data can be sent with exceptions as an options hash as detailed in the [Notification Options](docs/Notification Options.md) documentation, including some [options specific to non-fatal exceptions](docs/Notification Options.md#handled-notification-options).
 
-```ruby
-config.send_code = false
-```
 
-Bugsnag Middleware
-------------------
+### Callbacks
 
 The Bugsnag Notifier for Ruby provides its own middleware system, similar to
 the one used in Rack applications. Middleware allows you to execute code
@@ -626,28 +232,6 @@ You can also view the order of the currently activated middleware by running `ra
 Check out Bugsnag's [built in middleware classes](https://github.com/bugsnag/bugsnag-ruby/tree/master/lib/bugsnag/middleware)
 for some real examples of middleware in action.
 
-### Multiple projects
-
-If you want to divide errors into multiple Bugsnag projects, you can specify the API key as a parameter to `Bugsnag.notify`:
-
-```ruby
-rescue => e
-  Bugsnag.notify e, api_key: "your-api-key-here"
-end
-```
-
-### Grouping hash
-
-If you want to override Bugsnag's grouping algorithm, you can specify a grouping hash key as a parameter to `Bugsnag.notify`:
-
-```ruby
-rescue => e
-  Bugsnag.notify e, grouping_hash: "this-is-my-grouping-hash"
-end
-```
-
-All errors with the same groupingHash will be grouped together within the bugsnag dashboard.
-
 
 Deploy Tracking
 ---------------
@@ -731,45 +315,6 @@ For more information, check out the [deploy tracking api](https://bugsnag.com/do
 documentation.
 
 
-EventMachine Apps
------------------
-
-If your app uses [EventMachine](http://rubyeventmachine.com/) you'll need to
-manually notify Bugsnag of errors. There are two ways to do this in your
-EventMachine apps, first you should implement `EventMachine.error_handler`:
-
-```ruby
-EventMachine.error_handler{|e|
-  Bugsnag.notify(e)
-}
-```
-
-If you want more fine-grained error handling, you can use the
-[errback](http://eventmachine.rubyforge.org/EventMachine/Deferrable.html#errback-instance_method)
-function, for example:
-
-```ruby
-EventMachine::run do
-  server = EventMachine::start_server('0.0.0.0', PORT, MyServer)
-  server.errback {
-    EM.defer do
-      Bugsnag.notify(RuntimeError.new("Something bad happened"))
-    end
-  }
-end
-```
-
-For this to work, include [Deferrable](http://eventmachine.rubyforge.org/EventMachine/Deferrable.html)
-in your `MyServer`, then whenever you want to raise an error, call `fail`.
-
-Integrations
-------------
-
-Bugsnag ruby works out of the box with Rails, Sidekiq, Resque, DelayedJob (3+), Mailman, Rake and Rack. It
-should be easy to add support for other frameworks, either by sending a pull request here or adding a hook
-to those projects.
-
-
 Demo Applications
 -----------------
 
@@ -777,28 +322,22 @@ Demo Applications
 examples include Rails, Sinatra, Rack, Padrino integrations, etc.
 
 
-Reporting Bugs or Feature Requests
-----------------------------------
-
-Please report any bugs or feature requests on the github issues page for this
-project here:
+Support
+-------
 
-<https://github.com/bugsnag/bugsnag-ruby/issues>
+* [Additional Documentation](https://github.com/bugsnag/bugsnag-ruby/tree/master/docs)
+* [Search open and closed issues](https://github.com/bugsnag/bugsnag-ruby/issues?utf8=✓&q=is%3Aissue) for similar problems
+* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-ruby/issues/new)
 
 
 Contributing
 ------------
 
-We'd love you to file issues and send pull requests. If you need help getting started, see [CONTRIBUTING.md](https://github.com/bugsnag/bugsnag-ruby/blob/master/CONTRIBUTING.md)
-
-
-Build Status
-------------
-[![Build Status](https://secure.travis-ci.org/bugsnag/bugsnag-ruby.png)](http://travis-ci.org/bugsnag/bugsnag-ruby)
+We'd love you to file issues and send pull requests. The [contributing guidelines](https://github.com/bugsnag/bugsnag-ruby/CONTRIBUTING.md) details the process of building and testing `bugsnag-ruby`, as well as the pull request process. Feel free to comment on [existing issues](https://github.com/bugsnag/bugsnag-ruby/issues) for clarification or starting points.
 
 
 License
 -------
 
 The Bugsnag ruby notifier is free software released under the MIT License.
-See [LICENSE.txt](https://github.com/bugsnag/bugsnag-ruby/blob/master/LICENSE.txt) for details.
+See [LICENSE.txt](LICENSE.txt) for details.