rollbar 2.11.5 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6edb7fcbd4c4ffc66f2451d062c827adefd22616
-  data.tar.gz: 601ce3760bb0f43db2ccd5be4ab277675ff1df59
+  metadata.gz: c81062a0a25993cc7d6e1cb8a16d6f2f2b2faf43
+  data.tar.gz: ddfba1b5a84dafd6d2b2113ae383a1a1255dd1b7
 SHA512:
-  metadata.gz: db4d227277234a877903b5c3516667428526449ca113da5703c242dce1c44156d494d8eaf5a7c01a2015c3443b2ac31e4ea89dac36cef0f992cd81bac28cb0bb
-  data.tar.gz: a3965fdadc10b602b0d8f721bea94924f5f183ec3d346cc8dcab996d916ac13e816d38340ea8f9797dcae8d4468b80532a9f6e2318fb7c450b5c10f46ef35542
+  metadata.gz: 498f4e0b6509703b0c2c8044f669bf9aa60417ff198376abfbb02ac5d8e4953c0cc470d97e4f68212b38368e1d62e5bcb61783d80a078fcc7dc5735eb7408ac4
+  data.tar.gz: 23fa88ce1a8422d70cc6f409439a32a703321435b2a43d7c6f2eb30ecb0ba60510d1b3e2fa0a79ff493eab9be053ac8b007767c6df8d4fd741ae0d6acd3042bf

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## 2.12.0
+
+Features:
+
+- Scrub sidekiq params if needed
+- Prepare rake task for non Rails frameworks
+
+Others:
+- Typo on README.md
+- Add documentation for plugins architecture in docs/plugins.md
+
+## 2.11.5
+
 Bugfixes:
 
 - Use require_dependency for rake and sidekiq plugins. See [#485](https://github.com/rollbar/rollbar-gem/pull/485).

data/README.md

@@ -1,4 +1,10 @@
-# Rollbar [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.11.5)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+---
+layout: page
+sidebar: rollbar_sidebar
+permalink: /notifiers/rollbar-gem/
+toc: false
+---
+# Rollbar [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.12.0)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 [Rollbar](https://rollbar.com) is an error tracking service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.
@@ -26,7 +32,7 @@ This is the Ruby library for Rollbar. It will instrument many kinds of Ruby appl
 - [Data sanitization (scrubbing)](#data-sanitization-scrubbing)
 - [Including additional runtime data](#including-additional-runtime-data)
 - [Exception level filters](#exception-level-filters)
-  - [Dyanmic levels](#dynamic-levels)
+  - [Dynamic levels](#dynamic-levels)
 - [Before process hook](#before-process-hook)
 - [Transform hook](#transform-hook)
 - [The Scope](#the-scope)
@@ -56,6 +62,7 @@ This is the Ruby library for Rollbar. It will instrument many kinds of Ruby appl
 - [SSL](#ssl)
 - [Using with Zeus](#using-with-zeus)
 - [Configuration options](#configuration-options)
+- [Plugins](#plugins)
 - [Backwards Compatibility](#backwards-compatibility)
 - [Known Issues](#known-issues)
 - [Supported Language/Framework Versions](#supported-languageframework-versions)
@@ -218,6 +225,22 @@ $ rake rollbar:test
 
 This will raise an exception within a test request; if it works, you'll see a stacktrace in the console, and the exception will appear in the Rollbar dashboard.
 
+If you're not using Rails, you may first need to add the following to your Rakefile:
+
+```ruby
+require 'rollbar/rake_tasks'
+```
+
+You may also need to add an `:environment` task to your Rakefile if you haven't already defined one. At a bare minimum, this task should call `Rollbar.configure()` and set your access token.
+
+```ruby
+task :environment do
+  Rollbar.configure do |config |
+    config.access_token = '...'
+  end
+end
+```
+
 ## Usage
 
 ### Uncaught exceptions
@@ -937,6 +960,10 @@ Some users have reported problems with Zeus when ```rake``` was not explicitly i
 For a listing of all configuration options available, see
 [configuration](https://rollbar.com/docs/notifier/rollbar-gem/configuration).
 
+## Plugins
+
+The support for the different frameworks and libraries is organized into different plugin definitions. The plugins architecture documentation can be found in [Plugins](https://rollbar.com/docs/notifier/rollbar-gem/plugins).
+
 ## Backwards Compatibility
 
 You can find upgrading notes in [UPGRADING.md](UPGRADING.md).

data/docs/plugins.md

@@ -0,0 +1,46 @@
+# Plugins
+
+The plugins architecture offers an easy way to load the wrappers for libaries or frameworks we want to send Rollbar reports from. The different plugins we've written can be found in https://github.com/rollbar/rollbar-gem/tree/master/lib/rollbar/plugins. In this document we'll explain the interface that a plugin offers.
+
+If you'd like to open a PR in this gem in order to add a plugin for a library or framework that this gem does not yet support, create a file with the name of the framework in `lib/rollbar/plugins`. Here an example of a plugin:
+
+```ruby
+# lib/rollbar/plugins/my_framework.rb
+
+Rollbar.plugins.define('my-framework') do
+  require_dependency 'my_framework'
+  dependency { defined?(MyFramework::ErrorHandlers) }
+
+  execute! do
+    # This block is executed before Rollbar.configure is called
+  end
+
+  execute do
+    MyWramework::ErrorHandlers.add do |e| do
+      Rollbar.error(e)
+    end
+  end
+end
+```
+
+In the example from above you can guess we've defined a plugin called `my-framework` using the statement `Rollbar.plugins.define('my-framework')`. All the Rollbar plugins are defined under `Rollbar.plugins`, an instance of `Rollbar::Plugins`, which is the plugins manager.
+
+## Plugin DSL
+
+The DSL used in the plugins architecture is quite easy:
+
+- `dependency` recieves a block that will be executed in order to evaluate if the `execute` blocks should be executed or not. You can define any number of `dependency` blocks. If any of those return a non-truthy value, the `execute` blocks will be avoided and your plugin will not have any impact on the gem behavior.
+
+- `require_dependency` receives a string. It calls `require` with the passed string and aborts the plugin load should the `require` call fail. This is useful when you want to ensure the library or framework gem you want to wrap really exists in the project.
+
+- `execute` also receives a block. You can define any number of `execute` blocks that will be executed in order if all the dependencies, defined by the `dependency` blocks, are satisfied. In the block passed to `execute` you should add the error handler for the framework you are wrapping, inject a module to an existing one, monkey patch a class, or whatever you need in order to send reports to Rollbar when using that framework.
+
+  The blocks passed to `execute` are always executed after `Rollbar.configure` has been called in any of your initializer files or configuration files, so you are sure the `Rollbar.configuration` in your `execute` blocks is valid and what you expect to be.
+
+- `execute!` is used on your plugin definition in those cases where you need to execute a block of code before `Rollbar.configure` is called. So in the moment the plugin file is read, that happens on a `require 'rollbar'` statement, the block passed to `execute!` is called.
+
+  This is useful in those cases when the framework initialization needs your plugin to be attached to some hooks or any initialization process. This is what happens for example in the Rails plugin, where we need to define our own engine and that needs to be done before the `Rollbar.configure` call.
+
+## Examples
+
+The best way to understand how to build other plugins for the gem is taking a look into our existing plugins code, in https://github.com/rollbar/rollbar-gem/tree/master/lib/rollbar/plugins. If you have any doubt about how to define a new plugin, please, open an issue in the gem repository and we'll be very glad to help you!

data/lib/rollbar/plugins/sidekiq/plugin.rb

@@ -1,3 +1,5 @@
+require 'rollbar/scrubbers/params'
+
 module Rollbar
   class Sidekiq
     PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
@@ -14,8 +16,9 @@ module Rollbar
       return if skip_report?(msg_or_context, e)
 
       params = msg_or_context.reject{ |k| PARAM_BLACKLIST.include?(k) }
+      scrubbed_params = scrub_params(params)
       scope = {
-        :request => { :params => params },
+        :request => { :params => scrubbed_params },
         :framework => "Sidekiq: #{::Sidekiq::VERSION}"
       }
       if params.is_a?(Hash)
@@ -26,6 +29,15 @@ module Rollbar
       Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
     end
 
+    def self.scrub_params(params)
+      options = {
+        :params => params,
+        :config => Rollbar.configuration.scrub_fields
+      }
+
+      Rollbar::Scrubbers::Params.call(options)
+    end
+
     def self.skip_report?(msg_or_context, e)
       msg_or_context.is_a?(Hash) && msg_or_context["retry"] &&
         msg_or_context["retry_count"] && msg_or_context["retry_count"] < ::Rollbar.configuration.sidekiq_threshold

data/lib/rollbar/rake_tasks.rb

@@ -1,72 +1,98 @@
 require 'rollbar'
+require 'rack/mock'
 require 'logger'
 
 namespace :rollbar do
-  desc "Verify your gem installation by sending a test exception to Rollbar"
+  desc 'Verify your gem installation by sending a test exception to Rollbar'
   task :test => [:environment] do
-    Rails.logger = defined?(ActiveSupport::TaggedLogging) ?
-      ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) :
-      Logger.new(STDOUT)
+    if defined?(Rails)
+      Rails.logger = if defined?(ActiveSupport::TaggedLogging)
+                       ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
+                     else
+                       Logger.new(STDOUT)
+                     end
 
-    Rails.logger.level = Logger::DEBUG
-    Rollbar.preconfigure do |config|
-      config.logger = Rails.logger
+      Rails.logger.level = Logger::DEBUG
+      Rollbar.preconfigure do |config|
+        config.logger = Rails.logger
+      end
     end
 
     class RollbarTestingException < RuntimeError; end
 
     unless Rollbar.configuration.access_token
-      puts "Rollbar needs an access token configured. Check the README for instructions."
+      puts 'Rollbar needs an access token configured. Check the README for instructions.'
+
       exit
     end
 
+    puts 'Testing manual report...'
     Rollbar.error('Test error from rollbar:test')
 
-    begin
-      require './app/controllers/application_controller'
-    rescue LoadError
-    end
+    # Module to inject into the Rails controllers or
+    # rack apps
+    module RollbarTest
+      def test_rollbar
+        puts 'Raising RollbarTestingException to simulate app failure.'
 
-    unless defined?(ApplicationController)
-      puts "No ApplicationController found, using ActionController::Base instead"
-      class ApplicationController < ActionController::Base; end
+        raise RollbarTestingException.new, 'Testing rollbar with "rake rollbar:test". If you can see this, it works.'
+      end
     end
 
-    puts "Setting up the controller."
-    class ApplicationController
-      prepend_before_filter :test_rollbar
-      def test_rollbar
-        puts "Raising RollbarTestingException to simulate app failure."
-        raise RollbarTestingException.new, 'Testing rollbar with "rake rollbar:test". If you can see this, it works.'
+    if defined?(Rails)
+      begin
+        require './app/controllers/application_controller'
+      rescue LoadError
       end
 
-      def verify
+      unless defined?(ApplicationController)
+        puts 'No ApplicationController found, using ActionController::Base instead'
+        class ApplicationController < ActionController::Base; end
       end
 
-      def logger
-        nil
+      puts 'Setting up the controller.'
+
+      class RollbarTestController < ApplicationController
+        include RollbarTest
+
+        def verify
+          test_rollbar
+        end
+
+        def logger
+          nil
+        end
+      end
+
+      Rails.application.routes_reloader.execute_if_updated
+      Rails.application.routes.draw do
+        get 'verify' => 'rollbar_test#verify', :as => 'verify'
       end
-    end
 
-    class RollbarTestController < ApplicationController; end
+      # from http://stackoverflow.com/questions/5270835/authlogic-activation-problems
+      if defined? Authlogic
+        Authlogic::Session::Base.controller = Authlogic::ControllerAdapters::RailsAdapter.new(self)
+      end
 
-    Rails.application.routes_reloader.execute_if_updated
-    Rails.application.routes.draw do
-      get 'verify' => 'application#verify', :as => 'verify'
-    end
+      protocol = (defined? Rails.application.config.force_ssl && Rails.application.config.force_ssl) ? 'https' : 'http'
+      app = Rails.application
+    else
+      protocol = 'http'
+      app = Class.new do
+        include RollbarTest
 
-    # from http://stackoverflow.com/questions/5270835/authlogic-activation-problems
-    if defined? Authlogic
-      Authlogic::Session::Base.controller = Authlogic::ControllerAdapters::RailsAdapter.new(self)
+        def self.call(_env)
+          new.test_rollbar
+        end
+      end
     end
 
-    puts "Processing..."
-    protocol = (defined? Rails.application.config.force_ssl && Rails.application.config.force_ssl) ? 'https' : 'http'
+    puts 'Processing...'
     env = Rack::MockRequest.env_for("#{protocol}://www.example.com/verify")
-    status, headers, response = Rails.application.call(env)
+    status, = app.call(env)
 
     unless status.to_i == 500
-      puts "Test failed! You may have a configuration issue, or you could be using a gem that's blocking the test. Contact support@rollbar.com if you need help troubleshooting."
+      puts 'Test failed! You may have a configuration issue, or you could be using a gem that\'s blocking the test. Contact support@rollbar.com if you need help troubleshooting.'
     end
   end
 end

data/lib/rollbar/scrubbers/params.rb

@@ -49,6 +49,8 @@ module Rollbar
         fields_regex = options[:fields_regex]
         scrub_all = options[:scrub_all]
 
+        return scrub_array(params, options) if params.is_a?(Array)
+
         params.to_hash.inject({}) do |result, (key, value)|
           if value.is_a?(Hash)
             result[key] = scrub(value, options)

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.11.5'
+  VERSION = '2.12.0'
 end

data/spec/rollbar/plugins/sidekiq_spec.rb

@@ -34,6 +34,33 @@ describe Rollbar::Sidekiq, :reconfigure_notifier => false do
       described_class.handle_exception(msg_or_context, exception)
     end
 
+    context 'with fields in params to be scrubbed' do
+      let(:msg_or_context) do
+        {
+          :foo => 'bar',
+          :secret => 'foo',
+          :password => 'foo',
+          :password_confirmation => 'foo'
+        }
+      end
+      let(:expected_params) do
+        {
+          :foo => 'bar',
+          :secret => /\*+/,
+          :password => /\*+/,
+          :password_confirmation => /\*+/
+        }
+      end
+
+      before { reconfigure_notifier }
+
+      it 'sends a report with the scrubbed fields' do
+        described_class.handle_exception(msg_or_context, exception)
+
+        expect(Rollbar.last_report[:request][:params]).to be_eql_hash_with_regexes(expected_params)
+      end
+    end
+
     context 'when a sidekiq worker class is set' do
       it 'adds the sidekiq#queue-name to the error report context' do
         msg_or_context = {"retry" => true, "retry_count" => 1, 'queue' => 'default', 'class' => 'MyWorkerClass'}
@@ -92,7 +119,6 @@ describe Rollbar::Sidekiq, :reconfigure_notifier => false do
           described_class.handle_exception(msg_or_context, exception)
         }.to_not raise_error
       end
-
     end
   end
 

data/spec/rollbar/scrubbers/params_spec.rb

@@ -27,6 +27,33 @@ describe Rollbar::Scrubbers::Params do
         [:secret, :password]
       end
 
+      context 'with Array object' do
+        let(:params) do
+          [
+            {
+              :foo => 'bar',
+              :secret => 'the-secret',
+              :password => 'the-password',
+              :password_confirmation => 'the-password'
+            }
+          ]
+        end
+        let(:result) do
+          [
+            {
+              :foo => 'bar',
+              :secret => /\*+/,
+              :password => /\*+/,
+              :password_confirmation => /\*+/
+            }
+          ]
+        end
+
+        it 'scrubs the required parameters' do
+          expect(subject.call(options).first).to be_eql_hash_with_regexes(result.first)
+        end
+      end
+
       context 'with simple Hash' do
         let(:params) do
           {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 2.11.5
+  version: 2.12.0
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -49,6 +49,7 @@ files:
 - bin/rollbar-rails-runner
 - data/rollbar.snippet.js
 - docs/configuration.md
+- docs/plugins.md
 - gemfiles/rails30.gemfile
 - gemfiles/rails31.gemfile
 - gemfiles/rails32.gemfile