Merge pull request #212 from rollbar/override-scope-method

Add convenience scope! method to Rollbar public interface.

README.md

@@ -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.

lib/rollbar.rb

@@ -71,6 +71,11 @@ def scope(options = {})
  self.class.new(self, options)
  end
 
+ def scope!(options = {})
+ Rollbar::Util.deep_merge(@configuration.payload_options, options)
+ self
+ end
+
  # Turns off reporting for the given block.
  #
  # @example
@@ -753,6 +758,10 @@ def scoped(options = {})
  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')

spec/rollbar_spec.rb

@@ -1581,6 +1581,21 @@ class DummyClass
  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