raygun4ruby 3.1.1 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1b2d4b0893569016193338e74716ee400aa22318
-  data.tar.gz: c95e698b2376c2592dc19b341a3c82ca213d64bd
+SHA256:
+  metadata.gz: 86c073be26e04ae3b6c2aa39e3a92db2b7a0755ee894f6e7e71075e04ce44f67
+  data.tar.gz: 3864218abdc8c3c7412bff4cd4b2639d2020e98bca6926d934068ca8cd9a4785
 SHA512:
-  metadata.gz: a7ac04cea20753d0e5618af7d8676c8ce48648932de4311d5dc38d311b942f9677e352c3739bb21591b61aeb40859aa1f34af8698a7257a6d27b25a60cba1462
-  data.tar.gz: e1374a86dc5768b89fc10e32548dc6f6beb22b9560b35d9d81b0aee467f53f945cd6c1bc865816fef72fea52db37e2ab64fce8f758b89dced6fb9fd9a53b60b3
+  metadata.gz: e01cb2666afee5e64096c0bc21f4c0a1767d5f3fc7a6441bc8d6b5262865ce0af7cd75072016ba969ac3a4624005cc95ad89f51b9caef5f2de5c86233028d8f8
+  data.tar.gz: 4890df68aed5f5c2f9d46cb1cb2d1882c260b93bcf0c4772e6d349fdab3e5db723f9512c2cb8e6b9d2662d1fe6399978cb9b97d96068a1b01dff5c9410a9c3c2

data/.gitignore

@@ -1,18 +1,18 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-spec/dummy/log
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/dummy/log

data/.rspec

@@ -1 +1 @@
---require spec_helper
+--require spec_helper

data/.travis.yml

@@ -1,12 +1,20 @@
-before_install:
-  - gem install bundler
-
-script:
-  - bundle exec rake
-
-rvm:
- - 2.3.3
- - 2.4.0
-
-gemfile:
-  - Gemfile
+language: ruby
+
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+
+script:
+  - bundle exec rake
+
+rvm:
+ - 2.0.0-p648
+ - 2.1.0
+ - 2.2.10
+ - 2.3.8
+ - 2.4.5
+ - 2.5.3
+ - 2.6.1
+
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -1,109 +1,127 @@
-## 3.1.1 (16/01/2019):
-Bugfix:
-  - Don't attempt to modify response unless JS api key is present
-  - Don't attempt to modify response unless it responds to indexing ([])
-  - See PR ([#140](https://github.com/MindscapeHQ/raygun4ruby/pull/140))
-
-## 3.1.0 (15/01/2019):
-
-Feature:  
-    - Ability to automatically configure Raygun4JS on the client side by injecting it into outbound HTML pages. Thanks @MikeRogers0 for this ([#138](https://github.com/MindscapeHQ/raygun4ruby/pull/138))
-
-## 3.0.0 (18/12/2018):
-  Breaking changes:
-    Parameter filters are now applied if you are using the `filter_payload_with_whitelist` functionality. Previously if this was set to true the parameter filtering was bailed out of ([#136](https://github.com/MindscapeHQ/raygun4ruby/pull/136/files))
-
-## 2.7.1 (11/06/2018)
-  This is a patch release to update the required ruby version to correctly be 2.0 or greater
-
-## 2.7.0 (19/02/2018)
-
-Features
- - Add configuration option to control network timeouts when sending error reports, default value is 10 seconds ([#129](https://github.com/MindscapeHQ/raygun4ruby/pull/129))
-
-## 2.6.0 (25/10/2017)
-
-Features
-  - Enhanced debug logging to assist in resolving issues from support requests ([#128](https://github.com/MindscapeHQ/raygun4ruby/pull/128))
-
-## 2.5.0 (04/10/2017)
-
-Features
-  - Teach tags configuration how to handle a proc to allow dynamically settings tags ([#127](https://github.com/MindscapeHQ/raygun4ruby/pull/127))
-
-Bugfixes
-  - Fix crash when recording breadcrumb with uninitialized store ([#126](https://github.com/MindscapeHQ/raygun4ruby/pull/126))
-  - Make raw data handling more robust and fix in unicorn ([#125](https://github.com/MindscapeHQ/raygun4ruby/pull/125))
-  - Backwards compatible affected_user_identifier_methods ([#120](https://github.com/MindscapeHQ/raygun4ruby/pull/120))
-
-## 2.4.1 (29/08/2017)
-
-Bugfixes
-  - Fix crash in `Client#raw_data` method when `rack.input` buffer is missing `pos` method
-
-## 2.4.0 (31/07/2017)
-
-Features
-  - Add functionality to track affected user in Sidekiq jobs, refer to the README for more information, under the "Affected User Tracking in Sidekiq" heading ([#121](https://github.com/MindscapeHQ/raygun4ruby/pull/121))
-
-## 2.3.0 (09/05/2017)"
-
-Bugfixes
-  - Fix issue preventing affected users for a crash report from showing up in the affected users page ([#119](https://github.com/MindscapeHQ/raygun4ruby/pull/119))
-
-## 2.2.0 (05/05/2017)
-
-Features
-  - Opt in support for sending exceptions in a background thread to not block web request thread during IO ([#117](https://github.com/MindscapeHQ/raygun4ruby/pull/117))
-
-Bugfixes
- - Don't attempt to read raw data during GET requests or if rack.input buffer is empty
-
-## 2.1.0 (27/04/2017)
-
-Features
-  - Ability to record breadcrumbs in your code that will be sent to Raygun along with a raised exception ([#113](https://github.com/MindscapeHQ/raygun4ruby/pull/113))
-
-## 2.0.0 (20/04/2017)
-
-Bugfixes:
-  - Fix broken handling of raw request body reading in Rack applications ([#116](https://github.com/MindscapeHQ/raygun4ruby/pull/116))
-    - This is a breaking change to how raw data was being read before so it requires a major version bump
-    - Raw request data reading is now disabled by default and can be enabled via the `record_raw_data` configuration option
-    
-Since this is a major version bump this release also deprecates ruby versions < 2.0
-
-## 1.5.0 (16/03/2017)
-
-Features
-  - Send utcOffset with Raygun payload to calculate local server time in Raygun dashboard ([#112](https://github.com/MindscapeHQ/raygun4ruby/pull/112))
-
-## 1.4.0 (14/03/2017)
-
-Features:
-  - Raygun API url is now configurable via `Configuration.api_url` ([#111](https://github.com/MindscapeHQ/raygun4ruby/pull/111))
-  - Added support for `Exception#cause` to be tracked as `innerError` on Raygun. Only supported on Ruby >= 2.1 ([#107](https://github.com/MindscapeHQ/raygun4ruby/pull/107))
-
-## 1.3.0 (10/03/2017)
-
-Features:
-  - Improve affected user handling to let you specify all Raygun parameters, identifier, email, first name, full name and uuid. See [README.md](https://github.com/MindscapeHQ/raygun4ruby#affected-user-tracking) for details ([#34](https://github.com/MindscapeHQ/raygun4ruby/pull/34))
-  - Pass a user object as the third parameter to `Raygun.track_exception` to have affected user tracking for manually tracked exceptions, see the above link for more information on configuring this ([#106](https://github.com/MindscapeHQ/raygun4ruby/pull/106))
-  - If the exception instance responds to `:raygun_custom_data` that method will be called and the return value merged into the `custom_data` hash sent to Raygun. For convenience a `Raygun::Error` class is provided that takes this custom data as a second argument ([#101](https://github.com/MindscapeHQ/raygun4ruby/pull/101))
-  - Allowed `Configuration.custom_data` to be set to a proc to allow a global custom data hook for all exceptions. It is passed as arguments the exception and the environment hash ([#108](https://github.com/MindscapeHQ/raygun4ruby/pull/108))
-  - Added `Configuration.debug` to enable logging the reason why an exception was not reported ([#109](https://github.com/MindscapeHQ/raygun4ruby/pull/109))
-
-## 1.2.1 (09/03/2017)
-
-Bugfixes:
-  - dup input hashes before applying whitelist filtering, previously this was modifying the contents of `action_dispatch.request.parameters` ([#105](https://github.com/MindscapeHQ/raygun4ruby/pull/105))
-
-## 1.2.0 (09/03/2017)
-
-Features:
-  - Added two new configuration options, `filter_payload_with_whitelist` and `whitelist_payload_shape` ([#100](https://github.com/MindscapeHQ/raygun4ruby/pull/100))
-    - See [README.md](https://github.com/MindscapeHQ/raygun4ruby#filtering-the-payload-by-whitelist) for an example of how to use them
-  - When raygun4ruby encounters an exception trying to track an exception it will try once to send that exception to Raygun so you are notified ([#104](https://github.com/MindscapeHQ/raygun4ruby/pull/104))
-
-Bugfixes:
-  - raygun4ruby will no longer crash and suppress app exceptions when the API key is not configured ([#87](https://github.com/MindscapeHQ/raygun4ruby/pull/87))
+## 3.2.4 (11/02/2021):
+  - Set sidekiq tag on sidekiq errors ([#161](https://github.com/MindscapeHQ/raygun4ruby/pull/161))
+
+## 3.2.2 (10/06/2020):
+  - Introduce support for Raygun APM exceptions correlation ([#154](https://github.com/MindscapeHQ/raygun4ruby/pull/154))
+
+## 3.2.1 (25/02/2019):
+Bugfix:
+  - Remove Ruby 2.3 syntax to retain support for Ruby >= 2.0 ([#148](https://github.com/MindscapeHQ/raygun4ruby/pull/148))
+
+## 3.2.0 (21/02/2019):
+Bugfix:
+  - Fix NoMethodError Exception: undefined method `include?' for nil:NilClass in `JavascriptExceptionTracking` class. Thanks @yamanaltereh for this ([#141](https://github.com/MindscapeHQ/raygun4ruby/pull/141))
+  - Fix ([#145](https://github.com/MindscapeHQ/raygun4ruby/issues/145)), "raygun4ruby will load pry if it is in the gem bundle". Thanks to @eoinkelly for reporting this
+
+Feature:
+  - If you have recorded a large number of Breadcrumbs, or just very large ones, Raygun4Ruby will now only send up to 100KB of them instead of all of them, potentially going over the 128KB payload limit Raygun accepts ([#147](https://github.com/MindscapeHQ/raygun4ruby/pull/147))
+
+## 3.1.1 (16/01/2019):
+Bugfix:
+  - Don't attempt to modify response unless JS api key is present
+  - Don't attempt to modify response unless it responds to indexing ([])
+  - See PR ([#140](https://github.com/MindscapeHQ/raygun4ruby/pull/140))
+
+## 3.1.0 (15/01/2019):
+
+Feature:
+    - Ability to automatically configure Raygun4JS on the client side by injecting it into outbound HTML pages. Thanks @MikeRogers0 for this ([#138](https://github.com/MindscapeHQ/raygun4ruby/pull/138))
+
+## 3.0.0 (18/12/2018):
+  Breaking changes:
+    Parameter filters are now applied if you are using the `filter_payload_with_whitelist` functionality. Previously if this was set to true the parameter filtering was bailed out of ([#136](https://github.com/MindscapeHQ/raygun4ruby/pull/136/files))
+
+## 2.7.1 (11/06/2018)
+  This is a patch release to update the required ruby version to correctly be 2.0 or greater
+
+## 2.7.0 (19/02/2018)
+
+Features
+ - Add configuration option to control network timeouts when sending error reports, default value is 10 seconds ([#129](https://github.com/MindscapeHQ/raygun4ruby/pull/129))
+
+## 2.6.0 (25/10/2017)
+
+Features
+  - Enhanced debug logging to assist in resolving issues from support requests ([#128](https://github.com/MindscapeHQ/raygun4ruby/pull/128))
+
+## 2.5.0 (04/10/2017)
+
+Features
+  - Teach tags configuration how to handle a proc to allow dynamically settings tags ([#127](https://github.com/MindscapeHQ/raygun4ruby/pull/127))
+
+Bugfixes
+  - Fix crash when recording breadcrumb with uninitialized store ([#126](https://github.com/MindscapeHQ/raygun4ruby/pull/126))
+  - Make raw data handling more robust and fix in unicorn ([#125](https://github.com/MindscapeHQ/raygun4ruby/pull/125))
+  - Backwards compatible affected_user_identifier_methods ([#120](https://github.com/MindscapeHQ/raygun4ruby/pull/120))
+
+## 2.4.1 (29/08/2017)
+
+Bugfixes
+  - Fix crash in `Client#raw_data` method when `rack.input` buffer is missing `pos` method
+
+## 2.4.0 (31/07/2017)
+
+Features
+  - Add functionality to track affected user in Sidekiq jobs, refer to the README for more information, under the "Affected User Tracking in Sidekiq" heading ([#121](https://github.com/MindscapeHQ/raygun4ruby/pull/121))
+
+## 2.3.0 (09/05/2017)"
+
+Bugfixes
+  - Fix issue preventing affected users for a crash report from showing up in the affected users page ([#119](https://github.com/MindscapeHQ/raygun4ruby/pull/119))
+
+## 2.2.0 (05/05/2017)
+
+Features
+  - Opt in support for sending exceptions in a background thread to not block web request thread during IO ([#117](https://github.com/MindscapeHQ/raygun4ruby/pull/117))
+
+Bugfixes
+ - Don't attempt to read raw data during GET requests or if rack.input buffer is empty
+
+## 2.1.0 (27/04/2017)
+
+Features
+  - Ability to record breadcrumbs in your code that will be sent to Raygun along with a raised exception ([#113](https://github.com/MindscapeHQ/raygun4ruby/pull/113))
+
+## 2.0.0 (20/04/2017)
+
+Bugfixes:
+  - Fix broken handling of raw request body reading in Rack applications ([#116](https://github.com/MindscapeHQ/raygun4ruby/pull/116))
+    - This is a breaking change to how raw data was being read before so it requires a major version bump
+    - Raw request data reading is now disabled by default and can be enabled via the `record_raw_data` configuration option
+    
+Since this is a major version bump this release also deprecates ruby versions < 2.0
+
+## 1.5.0 (16/03/2017)
+
+Features
+  - Send utcOffset with Raygun payload to calculate local server time in Raygun dashboard ([#112](https://github.com/MindscapeHQ/raygun4ruby/pull/112))
+
+## 1.4.0 (14/03/2017)
+
+Features:
+  - Raygun API url is now configurable via `Configuration.api_url` ([#111](https://github.com/MindscapeHQ/raygun4ruby/pull/111))
+  - Added support for `Exception#cause` to be tracked as `innerError` on Raygun. Only supported on Ruby >= 2.1 ([#107](https://github.com/MindscapeHQ/raygun4ruby/pull/107))
+
+## 1.3.0 (10/03/2017)
+
+Features:
+  - Improve affected user handling to let you specify all Raygun parameters, identifier, email, first name, full name and uuid. See [README.md](https://github.com/MindscapeHQ/raygun4ruby#affected-user-tracking) for details ([#34](https://github.com/MindscapeHQ/raygun4ruby/pull/34))
+  - Pass a user object as the third parameter to `Raygun.track_exception` to have affected user tracking for manually tracked exceptions, see the above link for more information on configuring this ([#106](https://github.com/MindscapeHQ/raygun4ruby/pull/106))
+  - If the exception instance responds to `:raygun_custom_data` that method will be called and the return value merged into the `custom_data` hash sent to Raygun. For convenience a `Raygun::Error` class is provided that takes this custom data as a second argument ([#101](https://github.com/MindscapeHQ/raygun4ruby/pull/101))
+  - Allowed `Configuration.custom_data` to be set to a proc to allow a global custom data hook for all exceptions. It is passed as arguments the exception and the environment hash ([#108](https://github.com/MindscapeHQ/raygun4ruby/pull/108))
+  - Added `Configuration.debug` to enable logging the reason why an exception was not reported ([#109](https://github.com/MindscapeHQ/raygun4ruby/pull/109))
+
+## 1.2.1 (09/03/2017)
+
+Bugfixes:
+  - dup input hashes before applying whitelist filtering, previously this was modifying the contents of `action_dispatch.request.parameters` ([#105](https://github.com/MindscapeHQ/raygun4ruby/pull/105))
+
+## 1.2.0 (09/03/2017)
+
+Features:
+  - Added two new configuration options, `filter_payload_with_whitelist` and `whitelist_payload_shape` ([#100](https://github.com/MindscapeHQ/raygun4ruby/pull/100))
+    - See [README.md](https://github.com/MindscapeHQ/raygun4ruby#filtering-the-payload-by-whitelist) for an example of how to use them
+  - When raygun4ruby encounters an exception trying to track an exception it will try once to send that exception to Raygun so you are notified ([#104](https://github.com/MindscapeHQ/raygun4ruby/pull/104))
+
+Bugfixes:
+  - raygun4ruby will no longer crash and suppress app exceptions when the API key is not configured ([#87](https://github.com/MindscapeHQ/raygun4ruby/pull/87))

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in raygun4ruby.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in raygun4ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 Nik Wakelin
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2013 Nik Wakelin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,420 +1,420 @@
-# Raygun 4 Ruby [![Build Status](https://travis-ci.org/MindscapeHQ/raygun4ruby.png?branch=master)](https://travis-ci.org/MindscapeHQ/raygun4ruby) [![Gem Version](https://badge.fury.io/rb/raygun4ruby.svg)](https://badge.fury.io/rb/raygun4ruby)
-
-This is the Ruby adapter for the Raygun error reporter, http://raygun.io.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'raygun4ruby'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install raygun4ruby
-
-## Usage
-
-### Rails 3/4
-
-Run:
-
-    rails g raygun:install YOUR_API_KEY_HERE
-
-You can find your API key on your [Raygun Dashboard](https://app.raygun.io/dashboard/)
-
-You can then test your Raygun integration by running:
-
-    rake raygun:test
-
-You should see an "ItWorksException" appear in your Raygun dashboard. You're ready to zap those errors!
-
-NB: Raygun4Ruby currently requires Ruby >= 2.0
-
-Note that the generator will create a file in `config/initializers` called "raygun.rb". If you need to do any further configuration or customization of Raygun, that's the place to do it!
-
-By default the Rails integration is set to only report Exceptions in Production. To change this behaviour, set `config.enable_reporting` to something else in `config/initializers/raygun.rb`.
-
-### Rails 2
-
-Raygun4Ruby doesn't currently support Rails 2. If you'd like Rails 2 support, [drop us a line](http://raygun.io/forums).
-
-### Sinatra
-
-To enable exception tracking in Sinatra, just add configure Raygun and use the Rack middleware in your app:
-
-```ruby
-require 'raygun4ruby'
-Raygun.setup do |config|
-  config.api_key = "YOUR_API_KEY_HERE"
-end
-use Raygun::Middleware::RackExceptionInterceptor
-```
-
-### Standalone / Manual Exception Tracking
-
-```ruby
-
-require 'rubygems'
-require 'raygun4ruby'
-
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.filter_parameters = [ :password, :card_number, :cvv ] # don't forget to filter out sensitive parameters
-  config.enable_reporting = Rails.env.production? # true to send errors, false to not log
-end
-
-begin
-  # your lovely code here
-rescue => e
-  Raygun.track_exception(e)
-end
-
-# You may also pass a user object as the third argument to allow affected user tracking, like so
-begin
-  # your lovely code here
-rescue => e
-  # The second argument is the request environment variables
-  Raygun.track_exception(e, {}, user)
-end
-```
-
-You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html)
-
-### Customizing The Parameter Filtering
-
-If you'd like to customize how parameters are filtered, you can pass a `Proc` to `filter_parameters`. Raygun4Ruby will yield the params hash to the block, and the return value will be sent along with your error.
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.filter_parameters do |params|
-    params.slice("only", "a", "few", "keys") # note that Hash#slice is in ActiveSupport
-  end
-end
-```
-
-### Recording Breadcrumbs
-
-Breadcrumbs let you provide logging points in your code that will be collected and sent along with any exception sent to Raygun. This lets you have a better understanding of the events that happened in the system that lead up to the exception.
-
-1. Include it as a module in your class
-```ruby
-class SomeClass
-  include Raygun::Breadcrumbs
-
-  def some_method
-    record_breadcrumb(
-      message: "<log message goes here>",
-      category: "some category to group them by, maybe authentication or external-apis for example",
-      level: :info, # or debug or warning etc, you can configure what level will get sent
-      metadata: {custom_data: 'can go here'},
-    )
-  end
-end
-```
-This has the added benefit of recording the class the breadcrumb was recorded from automatically
-
-2. Call the `record_breadcrumb` method manually
-```ruby
-def some_method
-  Raygun.record_breadcrumb(
-    message: "<log message goes here>",
-    category: "some category to group them by, maybe authentication or external-apis for example",
-    level: :info, # or debug or warning etc, you can configure what level will get sent
-    metadata: {custom_data: 'can go here'},
-
-    # You can also set the class the breadcrumb was logged from
-    # It will only be set automatically using the included module approach
-    # Method and line number will get added automatically
-    class_name: self.class.name
-  )
-end
-```
-
-If you are using Sinatra or another rack framework you will need to include the Breadcrumbs middleware, this is used for storing the breadcrumbs during a request
-`use Raygun::Middleware::BreadcrumbsStoreInitializer`
-(this must be before you `use` the `Raygun::Middleware::RackExceptionInterceptor`)
-
-If you are using a non web based Ruby application you will have to call `Raygun::Breadcrumbs::Store.initialize` during your applications boot process. The store is per thread, but I have not tested it in a multi threaded application.
-
-### Filtering the payload by whitelist
-
-As an alternative to the above, you can also opt-in to the keys/values to be sent to Raygun by providing a specific whitelist of the keys you want to transmit.
-
-This disables the blacklist filtering above (`filter_parameters`), and is applied to the entire payload (error, request, environment and custom data included), not just the request parameters.
-
-In order to opt-in to this feature, set `filter_payload_with_whitelist` to `true`, and specify a shape of what keys you want (the default is below which is to allow everything through, this also means that the query parameters filtered out by default like password, creditcard etc will not be unless changed):
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.filter_payload_with_whitelist = true
-
-  config.whitelist_payload_shape = {
-      machineName: true,
-      version: true,
-      error: true,
-      userCustomData: true,
-      tags: true,
-      request: {
-        hostName: true,
-        url: true,
-        httpMethod: true,
-        iPAddress: true,
-        queryString: true,
-        headers: true,
-        form: {}, # Set to empty hash so that it doesn't just filter out the whole thing, but instead filters out each individual param
-        rawData: true
-      }
-    }
-end
-```
-
-Alternatively, provide a Proc to filter the payload using your own logic:
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.filter_payload_with_whitelist = true
-
-  config.whitelist_payload_keys do |payload|
-    # Return the payload mutated into your desired form
-    payload
-  end
-end
-```
-
-### Custom User Data
-Custom data can be added to `track_exception` by passing a custom_data key in the second parameter hash.
-
-```ruby
-begin
-  # more lovely code
-rescue Exception => e
-  Raygun.track_exception(e, custom_data: {my: 'custom data', goes: 'here'})
-end
-```
-
-Custom data can also be specified globally either by setting `config.custom_data` to a hash
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.custom_data = {custom_data: 'goes here'}
-end
-```
-
-or to a proc, which gets passed the exception and environment hash
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.custom_data do |e, env|
-    {message: e.message, server: env["SERVER_NAME"]}
-  end
-end
-```
-
-### Ignoring Some Errors
-
-You can ignore certain types of Exception using the `ignore` option in the setup block, like so:
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "MY_SWEET_API_KEY"
-  config.ignore  << ['MyApp::AnExceptionIDontCareAbout']
-end
-```
-
-The following exceptions are ignored by default: 
-
-```
-ActiveRecord::RecordNotFound
-ActionController::RoutingError
-ActionController::InvalidAuthenticityToken
-ActionDispatch::ParamsParser::ParseError
-CGI::Session::CookieStore::TamperedWithCookie
-ActionController::UnknownAction
-AbstractController::ActionNotFound
-Mongoid::Errors::DocumentNotFound
-```
-
- [You can see this here](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb#L51) and unignore them if needed by doing the following:
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "MY_SWEET_API_KEY"
-  config.ignore.delete('ActionController::InvalidAuthenticityToken')
-end
-```
-
-### Using a Proxy
-
-You can pass proxy settings using the `proxy_settings` config option.
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "MY_SWEET_API_KEY"
-  config.proxy_settings = { host: "localhost", port: 8888 }
-end
-```
-
-### Affected User Tracking
-
-Raygun can now track how many users have been affected by an error.
-
-By default, Raygun looks for a method called `current_user` on your controller, and it will populate the user's information based on a default method name mapping.
-
-(e.g Raygun will call `email` to populate the user's email, and `first_name` for the user's first name)
-
-You can inspect and customize this mapping using `config.affected_user_mapping`, like so:
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "MY_SWEET_API_KEY"
-  config.affected_user_method = :my_current_user # `current_user` by default
-  # To augment the defaults with your unique methods you can do the following
-  config.affected_user_mapping = Raygun::AffectedUser::DEFAULT_MAPPING.merge({
-    identifier: :some_custom_unique_identifier,
-    # If you set the key to a proc it will be passed the user object and you can construct the value your self
-    full_name: ->(user) { "#{user.first_name} #{user.last_name}" }
-  })
-end
-```
-
-To see the defaults check out [affected_user.rb](https://github.com/MindscapeHQ/raygun4ruby/tree/master/lib/raygun/affected_user.rb)
-
-If you're using Rails, most authentication systems will have this method set and you should be good to go.
-
-The count of unique affected users will appear on the error group in the Raygun dashboard. If your user has an `Email` attribute, and that email has a Gravatar associated with that address, you will also see your user's avatar.
-
-If you wish to keep it anonymous, you could set this identifier to something like `SecureRandom.uuid` and store that in a cookie, like so:
-
-```ruby
-class ApplicationController < ActionController::Base
-
-  def raygun_user
-    cookies.permanent[:raygun_user_identifier] ||= SecureRandom.uuid
-  end
-
-end
-```
-
-(Remember to set `affected_user_method` to `:raygun_user` in your config block...)
-
-### Version tracking
-
-Raygun can attach the version of your application to its error reports. In your Raygun.setup block, set `version` to the current version of your app.
-
-```ruby
-Raygun.setup do |config|
-  config.version = "1.0.0.4" # you could also pull this from ENV or however you want to set it.
-end
-```
-
-### Tags
-
-Tags can be added to `track_exception` by passing a tags key in the second parameter hash.
-
-```ruby
-begin
-  # more lovely code
-rescue Exception => e
-  Raygun.track_exception(e, tags: ['my', 'tags', 'go here'])
-end
-```
-
-Tags can also be specified globally either by setting `config.custom_data` to an array
-
-```ruby
-Raygun.setup do |config|
-  config.tags = ['heroku']
-end
-```
-
-or to a proc, which gets passed the exception and environment hash. This proc _must_ return an array of strings
-
-```ruby
-Raygun.setup do |config|
-  config.api_key = "YOUR_RAYGUN_API_KEY"
-  config.tags do |e, env|
-    [env["SERVER_NAME"]]
-  end
-end
-```
-
-### Resque Error Tracking
-
-Raygun4Ruby also includes a Resque failure backend. You should include it inside your Resque initializer (usually something like `config/initializers/load_resque.rb`)
-
-```ruby
-require 'resque/failure/multiple'
-require 'resque/failure/raygun'
-require 'resque/failure/redis'
-
-Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Raygun]
-Resque::Failure.backend = Resque::Failure::Multiple
-```
-
-### Sidekiq Error Tracking
-
-Raygun4Ruby can track errors from Sidekiq (2.x or 3+). All you need to do is add the line:
-
-```ruby
-  require 'raygun/sidekiq'
-```
-
-Either in your Raygun initializer or wherever else takes your fancy :)
-
-#### Affected User Tracking in Sidekiq
-
-To track affected users, define a class method on your worker class that returns a user object.
-Make sure the name of this method is the same as whatever you have defined as the `affected_user_method` in your Raygun configuration and that it returns an object that fits the mappings defined in `affected_user_mapping`
-If you have not changed these, refer to [Affected user tracking](#affected-user-tracking) for the defaults
-
-```ruby
-class FailingWorker
-  include Sidekiq::Worker
-
-  def perform(arg1, arg2)
-  end
-
-  # Your method must accept an array of arguments
-  # These will be the same as those passed to `perform`
-  def self.current_user(args)
-    arg1 = args[0]
-    arg2 = args[1]
-
-    user = User.find_by(name: arg1)
-
-    # Your method must return a user object
-    user
-  end
-```
-
-### Other Configuration options
-
-For a complete list of configuration options see the [configuration.rb](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb) file
-
-## Found a bug?
-
-Oops! Just let us know by opening an Issue on Github.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## Building
-
-1. Build the gem (`gem build raygun4ruby.gemspec`) - don't bother trying to build it on Windows,
-the resulting Gem won't work.
-2. Install the gem (`gem install raygun4ruby-VERSION.gem`)
+# Raygun 4 Ruby [![Build Status](https://travis-ci.org/MindscapeHQ/raygun4ruby.png?branch=master)](https://travis-ci.org/MindscapeHQ/raygun4ruby) [![Gem Version](https://badge.fury.io/rb/raygun4ruby.svg)](https://badge.fury.io/rb/raygun4ruby)
+
+This is the Ruby adapter for the Raygun error reporter, https://raygun.com.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'raygun4ruby'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install raygun4ruby
+
+## Usage
+
+### Rails 3/4/5
+
+Run:
+
+    rails g raygun:install YOUR_API_KEY_HERE
+
+You can find your API key in the [Raygun app](https://app.raygun.com/)
+
+You can then test your Raygun integration by running:
+
+    rake raygun:test
+
+You should see an "ItWorksException" appear in your Raygun dashboard. You're ready to zap those errors!
+
+NB: Raygun4Ruby currently requires Ruby >= 2.0
+
+Note that the generator will create a file in `config/initializers` called "raygun.rb". If you need to do any further configuration or customization of Raygun, that's the place to do it!
+
+By default the Rails integration is set to only report Exceptions in Production. To change this behaviour, set `config.enable_reporting` to something else in `config/initializers/raygun.rb`.
+
+### Rails 2
+
+Raygun4Ruby doesn't currently support Rails 2. If you'd like Rails 2 support, [drop us a line](https://raygun.com/forums).
+
+### Sinatra
+
+To enable exception tracking in Sinatra, just add configure Raygun and use the Rack middleware in your app:
+
+```ruby
+require 'raygun4ruby'
+Raygun.setup do |config|
+  config.api_key = "YOUR_API_KEY_HERE"
+end
+use Raygun::Middleware::RackExceptionInterceptor
+```
+
+### Standalone / Manual Exception Tracking
+
+```ruby
+
+require 'rubygems'
+require 'raygun4ruby'
+
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.filter_parameters = [ :password, :card_number, :cvv ] # don't forget to filter out sensitive parameters
+  config.enable_reporting = Rails.env.production? # true to send errors, false to not log
+end
+
+begin
+  # your lovely code here
+rescue => e
+  Raygun.track_exception(e)
+end
+
+# You may also pass a user object as the third argument to allow affected user tracking, like so
+begin
+  # your lovely code here
+rescue => e
+  # The second argument is the request environment variables
+  Raygun.track_exception(e, {}, user)
+end
+```
+
+You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](https://github.com/rack/rack/blob/master/SPEC.rdoc#label-The+Environment)
+
+### Customizing The Parameter Filtering
+
+If you'd like to customize how parameters are filtered, you can pass a `Proc` to `filter_parameters`. Raygun4Ruby will yield the params hash to the block, and the return value will be sent along with your error.
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.filter_parameters do |params|
+    params.slice("only", "a", "few", "keys") # note that Hash#slice is in ActiveSupport
+  end
+end
+```
+
+### Recording Breadcrumbs
+
+Breadcrumbs let you provide logging points in your code that will be collected and sent along with any exception sent to Raygun. This lets you have a better understanding of the events that happened in the system that lead up to the exception.
+
+1. Include it as a module in your class
+```ruby
+class SomeClass
+  include Raygun::Breadcrumbs
+
+  def some_method
+    record_breadcrumb(
+      message: "<log message goes here>",
+      category: "some category to group them by, maybe authentication or external-apis for example",
+      level: :info, # or debug or warning etc, you can configure what level will get sent
+      metadata: {custom_data: 'can go here'},
+    )
+  end
+end
+```
+This has the added benefit of recording the class the breadcrumb was recorded from automatically
+
+2. Call the `record_breadcrumb` method manually
+```ruby
+def some_method
+  Raygun.record_breadcrumb(
+    message: "<log message goes here>",
+    category: "some category to group them by, maybe authentication or external-apis for example",
+    level: :info, # or debug or warning etc, you can configure what level will get sent
+    metadata: {custom_data: 'can go here'},
+
+    # You can also set the class the breadcrumb was logged from
+    # It will only be set automatically using the included module approach
+    # Method and line number will get added automatically
+    class_name: self.class.name
+  )
+end
+```
+
+If you are using Sinatra or another rack framework you will need to include the Breadcrumbs middleware, this is used for storing the breadcrumbs during a request
+`use Raygun::Middleware::BreadcrumbsStoreInitializer`
+(this must be before you `use` the `Raygun::Middleware::RackExceptionInterceptor`)
+
+If you are using a non web based Ruby application you will have to call `Raygun::Breadcrumbs::Store.initialize` during your applications boot process. The store is per thread, but I have not tested it in a multi threaded application.
+
+### Filtering the payload by whitelist
+
+As an alternative to the above, you can also opt-in to the keys/values to be sent to Raygun by providing a specific whitelist of the keys you want to transmit.
+
+This disables the blacklist filtering above (`filter_parameters`), and is applied to the entire payload (error, request, environment and custom data included), not just the request parameters.
+
+In order to opt-in to this feature, set `filter_payload_with_whitelist` to `true`, and specify a shape of what keys you want (the default is below which is to allow everything through, this also means that the query parameters filtered out by default like password, creditcard etc will not be unless changed):
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.filter_payload_with_whitelist = true
+
+  config.whitelist_payload_shape = {
+      machineName: true,
+      version: true,
+      error: true,
+      userCustomData: true,
+      tags: true,
+      request: {
+        hostName: true,
+        url: true,
+        httpMethod: true,
+        iPAddress: true,
+        queryString: true,
+        headers: true,
+        form: {}, # Set to empty hash so that it doesn't just filter out the whole thing, but instead filters out each individual param
+        rawData: true
+      }
+    }
+end
+```
+
+Alternatively, provide a Proc to filter the payload using your own logic:
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.filter_payload_with_whitelist = true
+
+  config.whitelist_payload_shape do |payload|
+    # Return the payload mutated into your desired form
+    payload
+  end
+end
+```
+
+### Custom User Data
+Custom data can be added to `track_exception` by passing a custom_data key in the second parameter hash.
+
+```ruby
+begin
+  # more lovely code
+rescue Exception => e
+  Raygun.track_exception(e, custom_data: {my: 'custom data', goes: 'here'})
+end
+```
+
+Custom data can also be specified globally either by setting `config.custom_data` to a hash
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.custom_data = {custom_data: 'goes here'}
+end
+```
+
+or to a proc, which gets passed the exception and environment hash
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.custom_data do |e, env|
+    {message: e.message, server: env["SERVER_NAME"]}
+  end
+end
+```
+
+### Ignoring Some Errors
+
+You can ignore certain types of Exception using the `ignore` option in the setup block, like so:
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "MY_SWEET_API_KEY"
+  config.ignore  << ['MyApp::AnExceptionIDontCareAbout']
+end
+```
+
+The following exceptions are ignored by default: 
+
+```
+ActiveRecord::RecordNotFound
+ActionController::RoutingError
+ActionController::InvalidAuthenticityToken
+ActionDispatch::ParamsParser::ParseError
+CGI::Session::CookieStore::TamperedWithCookie
+ActionController::UnknownAction
+AbstractController::ActionNotFound
+Mongoid::Errors::DocumentNotFound
+```
+
+ [You can see this here](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb#L90) and unignore them if needed by doing the following:
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "MY_SWEET_API_KEY"
+  config.ignore.delete('ActionController::InvalidAuthenticityToken')
+end
+```
+
+### Using a Proxy
+
+You can pass proxy settings using the `proxy_settings` config option.
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "MY_SWEET_API_KEY"
+  config.proxy_settings = { host: "localhost", port: 8888 }
+end
+```
+
+### Affected User Tracking
+
+Raygun can now track how many users have been affected by an error.
+
+By default, Raygun looks for a method called `current_user` on your controller, and it will populate the user's information based on a default method name mapping.
+
+(e.g Raygun will call `email` to populate the user's email, and `first_name` for the user's first name)
+
+You can inspect and customize this mapping using `config.affected_user_mapping`, like so:
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "MY_SWEET_API_KEY"
+  config.affected_user_method = :my_current_user # `current_user` by default
+  # To augment the defaults with your unique methods you can do the following
+  config.affected_user_mapping = Raygun::AffectedUser::DEFAULT_MAPPING.merge({
+    identifier: :some_custom_unique_identifier,
+    # If you set the key to a proc it will be passed the user object and you can construct the value your self
+    full_name: ->(user) { "#{user.first_name} #{user.last_name}" }
+  })
+end
+```
+
+To see the defaults check out [affected_user.rb](https://github.com/MindscapeHQ/raygun4ruby/tree/master/lib/raygun/affected_user.rb)
+
+If you're using Rails, most authentication systems will have this method set and you should be good to go.
+
+The count of unique affected users will appear on the error group in the Raygun dashboard. If your user has an `Email` attribute, and that email has a Gravatar associated with that address, you will also see your user's avatar.
+
+If you wish to keep it anonymous, you could set this identifier to something like `SecureRandom.uuid` and store that in a cookie, like so:
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  def raygun_user
+    cookies.permanent[:raygun_user_identifier] ||= SecureRandom.uuid
+  end
+
+end
+```
+
+(Remember to set `affected_user_method` to `:raygun_user` in your config block...)
+
+### Version tracking
+
+Raygun can attach the version of your application to its error reports. In your Raygun.setup block, set `version` to the current version of your app.
+
+```ruby
+Raygun.setup do |config|
+  config.version = "1.0.0.4" # you could also pull this from ENV or however you want to set it.
+end
+```
+
+### Tags
+
+Tags can be added to `track_exception` by passing a tags key in the second parameter hash.
+
+```ruby
+begin
+  # more lovely code
+rescue Exception => e
+  Raygun.track_exception(e, tags: ['my', 'tags', 'go here'])
+end
+```
+
+Tags can also be specified globally either by setting `config.custom_data` to an array
+
+```ruby
+Raygun.setup do |config|
+  config.tags = ['heroku']
+end
+```
+
+or to a proc, which gets passed the exception and environment hash. This proc _must_ return an array of strings
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+  config.tags do |e, env|
+    [env["SERVER_NAME"]]
+  end
+end
+```
+
+### Resque Error Tracking
+
+Raygun4Ruby also includes a Resque failure backend. You should include it inside your Resque initializer (usually something like `config/initializers/load_resque.rb`)
+
+```ruby
+require 'resque/failure/multiple'
+require 'resque/failure/raygun'
+require 'resque/failure/redis'
+
+Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Raygun]
+Resque::Failure.backend = Resque::Failure::Multiple
+```
+
+### Sidekiq Error Tracking
+
+Raygun4Ruby can track errors from Sidekiq (2.x or 3+). All you need to do is add the line:
+
+```ruby
+  require 'raygun/sidekiq'
+```
+
+Either in your Raygun initializer or wherever else takes your fancy :)
+
+#### Affected User Tracking in Sidekiq
+
+To track affected users, define a class method on your worker class that returns a user object.
+Make sure the name of this method is the same as whatever you have defined as the `affected_user_method` in your Raygun configuration and that it returns an object that fits the mappings defined in `affected_user_mapping`
+If you have not changed these, refer to [Affected user tracking](#affected-user-tracking) for the defaults
+
+```ruby
+class FailingWorker
+  include Sidekiq::Worker
+
+  def perform(arg1, arg2)
+  end
+
+  # Your method must accept an array of arguments
+  # These will be the same as those passed to `perform`
+  def self.current_user(args)
+    arg1 = args[0]
+    arg2 = args[1]
+
+    user = User.find_by(name: arg1)
+
+    # Your method must return a user object
+    user
+  end
+```
+
+### Other Configuration options
+
+For a complete list of configuration options see the [configuration.rb](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb) file
+
+## Found a bug?
+
+Oops! Just let us know by opening an Issue on Github.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Building
+
+1. Build the gem (`gem build raygun4ruby.gemspec`) - don't bother trying to build it on Windows,
+the resulting Gem won't work.
+2. Install the gem (`gem install raygun4ruby-VERSION.gem`)