rollbar 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c71304582c4e3e90c305212907f516cce923104a
-  data.tar.gz: 233e2f5605cefcdce34ae82021d176c349c5fbb0
+  metadata.gz: 5014d11d0ce47ae5f2e50751236a81404148c787
+  data.tar.gz: 12aa1c0e3509ebdb622083e4d90ca20b731414d5
 SHA512:
-  metadata.gz: ea71e508f060e52cc6e80320035fd9f97ad269ba3a7635b1dce6554910ed18f3be0cab12ecb373f2d1f6b9213d28b87d7f85bd470926e26b3b44328adb246d3d
-  data.tar.gz: d7399f7773162732ddba0f66f5080818005308d03ab8e4d3e110b966b54d595439f2ccaa5cc16a85b997cd22939d9ec1de2777862e4d9dc675a4004b26d285f4
+  metadata.gz: 83428ce3fb1b1a7287a81e1f22a862b5d3c2d429e4f133c7c7e005927724f184b4123e4446e0d2a7777e23ac7856d0b769e4e9d7ffb1cf05ee29c930b25eadbc
+  data.tar.gz: de80c650cde9ba6e3909d3b45a4b4fb6346a2b49cec49298449e2cb7201bfcf0d32b44c2dd73a3afdea35295abbead953b86015fcf03082f08fc71c6a4c8a86b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 1.4.3
+
+New features:
+
+- The current thread's scope can now be modified using `Rollbar.scope!`. This can be used to provide context data which will be included if the current request/job/etc. later throws an exception. See [#212](https://github.com/rollbar/rollbar-gem/pull/212)
+
+Bug fixes:
+
+- Remove duplicate `#configure` definition. See [#207](https://github.com/rollbar/rollbar-gem/pull/207)
+- In the capistrano task, don't override set variables. See [#210](https://github.com/rollbar/rollbar-gem/pull/210)
+- Style fix in sidekiq handler. See [#209](https://github.com/rollbar/rollbar-gem/pull/209)
+
 ## 1.4.2
 
 Bug fixes:

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.4.2)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.4.3)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).
@@ -9,7 +9,7 @@ Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https:/
 
 Add this line to your application's Gemfile:
 
-    gem 'rollbar', '~> 1.4.2'
+    gem 'rollbar', '~> 1.4.3'
 
 And then execute:
 
@@ -184,7 +184,7 @@ notifier = notifier.scope({
 notifier.info('Jobs processed')
 ```
 
-If you don't want to work with a new `Notifier` instance `#scoped` will do it for you:
+If you don't want to work with a new `Notifier` instance `.scoped` will do it for you:
 
 ```ruby
 while job
@@ -208,6 +208,24 @@ while job
 end
 ```
 
+To modify the current scope (rather than creating a new one), use `Rollbar.scope!`. You can use this to add additional context data from inside a web request, background job, etc.
+
+```ruby
+class NotificationJob
+  include Sidekiq::Worker
+
+  def perform(user_id)
+    Rollbar.scope!(:person => { :id => :user_id })
+
+    # If this next line causes an exception, the reported exception (which will
+    # be reported by Rollbar's standard Sidekiq instrumentation) will also
+    # include the above person information.
+    Notification.send_to_user(user_id)
+  end
+end
+```
+
+
 ## Person tracking
 
 Rollbar will send information about the current user (called a "person" in Rollbar parlance) along with each error report, when available. This works by calling the ```current_user``` controller method. The return value should be an object with an ```id``` method and, optionally, ```username``` and ```email``` methods.

data/THANKS.md

@@ -7,6 +7,7 @@ Huge thanks to the following contributors (by github username). For the most up-
 - [antico5](https://github.com/antico5)
 - [arr-ee](https://github.com/arr-ee)
 - [awmichel](https://github.com/awmichel)
+- [blaet](https://github.com/blaet)
 - [bradx3](https://github.com/bradx3)
 - [chrisb](https://github.com/chrisb)
 - [derekrockwell](https://github.com/derekrockwell)
@@ -28,6 +29,7 @@ Huge thanks to the following contributors (by github username). For the most up-
 - [JoshuaOSHickman](https://github.com/JoshuaOSHickman)
 - [juggler](https://github.com/juggler)
 - [kavu](https://github.com/kavu)
+- [kdonovan](https://github.com/kdonovan)
 - [kroky](https://github.com/kroky)
 - [lanej](https://github.com/lanej)
 - [lesliev-figured](https://github.com/lesliev-figured)

data/lib/rollbar.rb

@@ -71,8 +71,9 @@ module Rollbar
       self.class.new(self, options)
     end
 
-    def configure
-      yield(configuration)
+    def scope!(options = {})
+      Rollbar::Util.deep_merge(@configuration.payload_options, options)
+      self
     end
 
     # Turns off reporting for the given block.
@@ -757,6 +758,10 @@ module Rollbar
       self.notifier = old_notifier
     end
 
+    def scope!(options = {})
+      notifier.scope!(options)
+    end
+
     # Backwards compatibility methods
 
     def report_exception(exception, request_data = nil, person_data = nil, level = 'error')

data/lib/rollbar/sidekiq.rb

@@ -1,20 +1,18 @@
 # encoding: utf-8
 
-PARAM_BLACKLIST = ['backtrace', 'error_backtrace', 'error_message', 'error_class']
+PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
 
 if Sidekiq::VERSION < '3'
   module Rollbar
     class Sidekiq
       def call(worker, msg, queue)
-        begin
-          yield
-        rescue Exception => e
-          params = msg.reject{ |k| PARAM_BLACKLIST.include?(k) }
-          scope = { :request => { :params => params } }
+        yield
+      rescue Exception => e
+        params = msg.reject{ |k| PARAM_BLACKLIST.include?(k) }
+        scope = { :request => { :params => params } }
 
-          Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
-          raise
-        end
+        Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
+        raise
       end
     end
   end

data/lib/rollbar/tasks/rollbar.cap

@@ -34,9 +34,9 @@ end
 
 namespace :load do
   task :defaults do
-    set :rollbar_user,  Proc.new { ENV['USER'] || ENV['USERNAME'] }
-    set :rollbar_env,   Proc.new { fetch :rails_env, 'production' }
-    set :rollbar_token, Proc.new { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" }
-    set :rollbar_role,  Proc.new { :app }
+    set :rollbar_user,  fetch(:rollbar_user,  Proc.new { ENV['USER'] || ENV['USERNAME'] } )
+    set :rollbar_env,   fetch(:rollbar_env,   Proc.new { fetch :rails_env, 'production' } )
+    set :rollbar_token, fetch(:rollbar_token, Proc.new { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" } )
+    set :rollbar_role,  fetch(:rollbar_role,  Proc.new { :app } )
   end
 end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.4.2"
+  VERSION = "1.4.3"
 end

data/spec/rollbar_spec.rb

@@ -1581,6 +1581,21 @@ describe Rollbar do
     end
   end
 
+  describe '.scope!' do
+    let(:new_scope) do
+      { :person => { :id => 1 } }
+    end
+
+    before { reconfigure_notifier }
+
+    it 'adds the new scope to the payload options' do
+      configuration = Rollbar.notifier.configuration
+      Rollbar.scope!(new_scope)
+
+      expect(configuration.payload_options).to be_eql(new_scope)
+    end
+  end
+
   describe '.reset_notifier' do
     it 'resets the notifier' do
       notifier1_id = Rollbar.notifier.object_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json