rollbar 2.9.1 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e042ba30e8f58da588a6120707660687171c9e3f
-  data.tar.gz: 4d3ca325544cac64b6af94ad19da687cf797aa7c
+  metadata.gz: a45a6459fbc4fdc48b10d24d8f789ac3dc6c712a
+  data.tar.gz: a6391231fe97e651db01a382a214c3f9cf002310
 SHA512:
-  metadata.gz: d1c0e2121b62a668e884ee7f60954b6559d917339552334f9f797aab421483b144d0dff21c924e90617c7359870c98916899f3d4a0f5a21764fd4d2351dacda4
-  data.tar.gz: a0f60c013d3ad9d49beaeb78cd95a19f4b2fdb56afd4f45a2ae26588d62e41c77c095d04e7b7ce0d59d20c44b6cdd3d47b866cd3ba1622e49d0a1efb92ab9661
+  metadata.gz: 75910ee630569144378fdc9bbb3039e514273e335b4b1fca19be9f02ad60158414e396a75e3ee01b05bc3053dd5efed95bb1a3a111357a03ee22c42a41539d69
+  data.tar.gz: 45fe74d97b172e168127fac6478d9eeca7e155018a95cc4df7c01aa6823868156297fddedef3da6df93404532604f64d174c2ce28cf2a551dafccf977f3e1873

data/.travis.yml

@@ -29,6 +29,8 @@ gemfile:
   - gemfiles/rails32.gemfile
   - gemfiles/rails40.gemfile
   - gemfiles/rails41.gemfile
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails50.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head
@@ -72,6 +74,13 @@ matrix:
       jdk: oraclejdk7
     - rvm: 2.1.0
       jdk: oraclejdk8
+    - rvm: 2.2.2
+      jdk: openjdk6
+    - rvm: 2.2.2
+      jdk: oraclejdk7
+    - rvm: 2.2.2
+      jdk: oraclejdk8
+
     - rvm: ruby-head
       jdk: openjdk6
     - rvm: ruby-head
@@ -96,6 +105,8 @@ matrix:
       gemfile: gemfiles/rails41.gemfile
     - rvm: 1.8.7
       gemfile: gemfiles/rails42.gemfile
+    - rvm: 1.8.7
+      gemfile: gemfiles/rails50.gemfile
     - rvm: 1.9.2
       gemfile: gemfiles/rails31.gemfile
     - rvm: 1.9.2
@@ -106,6 +117,14 @@ matrix:
       gemfile: gemfiles/rails41.gemfile
     - rvm: 1.9.2
       gemfile: gemfiles/rails42.gemfile
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.1.0
+      gemfile: gemfiles/rails50.gemfile
     - rvm: 2.2.2
       gemfile: gemfiles/rails30.gemfile
     - rvm: 2.2.2
@@ -134,6 +153,8 @@ matrix:
       gemfile: gemfiles/rails41.gemfile
     - rvm: jruby-19mode
       gemfile: gemfiles/rails42.gemfile
+    - rvm: jruby-19mode
+      gemfile: gemfiles/rails50.gemfile
     - rvm: rbx
       gemfile: gemfiles/rails30.gemfile
     - rvm: rbx
@@ -146,10 +167,5 @@ matrix:
       gemfile: gemfiles/rails41.gemfile
     - rvm: rbx
       gemfile: gemfiles/rails42.gemfile
-gemfile:
-  - gemfiles/rails30.gemfile
-  - gemfiles/rails31.gemfile
-  - gemfiles/rails32.gemfile
-  - gemfiles/rails40.gemfile
-  - gemfiles/rails41.gemfile
-  - gemfiles/rails42.gemfile
+    - rvm: rbx
+      gemfile: gemfiles/rails50.gemfile

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 2.10.0
+
+New features:
+
+- Set the Sidekiq error context to the worker class name. See [#440](https://github.com/rollbar/rollbar-gem/pull/440).
+- Secure headers support for rollbar.js integration. See [#437](https://github.com/rollbar/rollbar-gem/pull/437).
+- Rails 5 support. See [#433](https://github.com/rollbar/rollbar-gem/pull/433).
+- Add scrub all parameters option. See [#431](https://github.com/rollbar/rollbar-gem/pull/431).
+- Add delayed_job async handler. See [#430](https://github.com/rollbar/rollbar-gem/pull/430).
+- Disable logging if Rollbar is disabled. See [#425](https://github.com/rollbar/rollbar-gem/pull/425).
+
+Bug fixes:
+
+- Add nil check for rake.patch! for future robustness. See [#434](https://github.com/rollbar/rollbar-gem/pull/434).
+- Fix two doc bugs. See [#401](https://github.com/rollbar/rollbar-gem/pull/401).
+
 ## 2.9.1
 
 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=v2.9.1)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.10.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.
@@ -377,7 +377,6 @@ By default, the notifier will "scrub" the following fields from payloads before
 - ```:password_confirmation```
 - ```:secret```
 - ```:confirm_password```
-- ```:password_confirmation```
 - ```:secret_token```
 
 And the following http header
@@ -434,7 +433,7 @@ If you'd like to customize this list, modify the example code in ```config/initi
 
 ```ruby
 config.exception_level_filters.merge!({
-  'ActiveRecord::RecordNotFound' => 'ignore',
+  'ActionController::RoutingError' => 'ignore',
   'NoMethodError' => 'critical'
 })
 ```
@@ -589,7 +588,7 @@ Only versions >= 3.0 of delayed_job are supported.
 
 ## Asynchronous reporting
 
-By default, all messages are reported synchronously. You can enable asynchronous reporting with [girl_friday](https://github.com/mperham/girl_friday), [sucker_punch](https://github.com/brandonhilkert/sucker_punch), [Sidekiq](https://github.com/mperham/sidekiq), [Resque](https://github.com/resque/resque) or using threading.
+By default, all messages are reported synchronously. You can enable asynchronous reporting with [girl_friday](https://github.com/mperham/girl_friday), [sucker_punch](https://github.com/brandonhilkert/sucker_punch), [Sidekiq](https://github.com/mperham/sidekiq), [Resque](https://github.com/resque/resque), [DelayedJob](https://github.com/collectiveidea/delayed_job) or using threading.
 
 ### Using girl_friday
 
@@ -662,6 +661,14 @@ Now you can just start a new Resque worker processing jobs in that queue:
 $ QUEUE=my_queue bundle exec resque:work
 ```
 
+### Using DelayedJob
+
+Add the following in ```config/initializers/rollbar.rb```:
+
+```ruby
+config.use_delayed_job
+```
+
 ### Using threading
 
 Add the following in ```config/initializers/rollbar.rb```:

data/gemfiles/rails50.gemfile

@@ -0,0 +1,47 @@
+require 'rubygems/version'
+
+source "https://rubygems.org"
+
+is_jruby = defined?(JRUBY_VERSION) || (defined?(RUBY_ENGINE) && 'jruby' == RUBY_ENGINE)
+
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+gem 'jruby-openssl', :platform => :jruby
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'appraisal'
+gem 'rubysl', '~> 2.0', :platform => :rbx
+gem 'racc', :platform => :rbx
+gem 'minitest', :platform => :rbx
+gem 'rubinius-developer_tools', :platform => :rbx
+gem 'rails', '~> 5.0.0.beta1'
+
+gem 'rspec-core', '~> 3.5.0.beta3'
+gem 'rspec-rails', '~> 3.5.0.beta3'
+gem 'rspec-support', '~> 3.5.0.beta3'
+gem 'rspec-expectations', '~> 3.5.0.beta3'
+gem 'rspec-mocks', '~> 3.5.0.beta3'
+gem 'rake'
+
+gem 'oj', '~> 2.12.14' unless is_jruby
+gem 'sidekiq', '>= 2.13.0' if RUBY_VERSION != '1.8.7'
+
+if RUBY_VERSION.start_with?('1.9')
+  gem 'sucker_punch', '~> 1.0'
+elsif RUBY_VERSION.start_with?('2')
+  gem 'sucker_punch', '~> 2.0'
+end
+
+# We need last sinatra that uses rack 2.x
+gem 'sinatra', :git => 'https://github.com/sinatra/sinatra'
+gem 'resque'
+gem 'delayed_job', :require => false
+gem 'redis'
+gem 'database_cleaner', '~> 1.x'
+gem 'girl_friday', '>= 0.11.1'
+gem 'generator_spec'
+gem 'codeclimate-test-reporter', :group => :test, :require => nil
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0')
+  gem 'mime-types', '< 3.0'
+end
+
+gemspec :path => '../'

data/lib/rollbar.rb

@@ -25,10 +25,6 @@ require 'rollbar/exceptions'
 require 'rollbar/lazy_store'
 
 module Rollbar
-  ATTACHMENT_CLASSES = %w[
-    ActionDispatch::Http::UploadedFile
-    Rack::Multipart::UploadedFile
-  ].freeze
   PUBLIC_NOTIFIER_METHODS = %w(debug info warn warning error critical log logger
                                process_payload process_from_async_handler scope send_failsafe log_info log_debug
                                log_warning log_error silenced)

data/lib/rollbar/configuration.rb

@@ -118,6 +118,12 @@ module Rollbar
       end
     end
 
+    def use_delayed_job
+      require 'rollbar/delay/delayed_job'
+      @use_async      = true
+      @async_handler  = Rollbar::Delay::DelayedJob
+    end
+
     def use_sidekiq(options = {})
       require 'rollbar/delay/sidekiq' if defined?(Sidekiq)
       @use_async      = true

data/lib/rollbar/delay/delayed_job.rb

@@ -0,0 +1,17 @@
+module Rollbar
+  module Delay
+    # This class provides the DelayedJob async handler. Users can
+    # use DelayedJob in order to send the reports to the Rollbar API
+    class DelayedJob
+      class << self
+        def call(payload)
+          new.delay.call(payload)
+        end
+      end
+
+      def call(payload)
+        Rollbar.process_from_async_handler(payload)
+      end
+    end
+  end
+end

data/lib/rollbar/js/frameworks/rails.rb

@@ -9,6 +9,24 @@ module Rollbar
         def prepare
           return if prepared?
 
+          if secure_headers?
+            insert_middleware_after_secure_headers
+          else
+            insert_middleware
+          end
+
+          self.prepared = true
+        end
+
+        def insert_middleware_after_secure_headers
+          instance = self
+
+          Rollbar::Railtie.initializer 'rollbar.js.frameworks.rails', :after => 'secure_headers.middleware' do |_app|
+            instance.insert_middleware
+          end
+        end
+
+        def insert_middleware
           require 'rollbar/js/middleware'
 
           config = {
@@ -16,8 +34,10 @@ module Rollbar
             :enabled => Rollbar.configuration.js_enabled
           }
           rails_config.middleware.use(::Rollbar::Js::Middleware, config)
+        end
 
-          self.prepared = true
+        def secure_headers?
+          defined?(::SecureHeaders)
         end
 
         def rails_config

data/lib/rollbar/js/middleware.rb

@@ -27,7 +27,7 @@ module Rollbar
       def _call(env, result)
         return result unless should_add_js?(env, result[0], result[1])
 
-        if response_string = add_js(result[2])
+        if response_string = add_js(env, result[2])
           env[JS_IS_INJECTED_KEY] = true
           response = ::Rack::Response.new(response_string, result[0], result[1])
 
@@ -67,7 +67,7 @@ module Rollbar
         env['action_controller.instance'].class.included_modules.include?(ActionController::Live)
       end
 
-      def add_js(response)
+      def add_js(env, response)
         body = join_body(response)
         close_old_response(response)
 
@@ -78,9 +78,9 @@ module Rollbar
 
         if head_open_end
           body = body[0..head_open_end] <<
-                 config_js_tag <<
-                 snippet_js_tag <<
-                 body[head_open_end..-1]
+                 config_js_tag(env) <<
+                 snippet_js_tag(env) <<
+                 body[head_open_end + 1..-1]
         end
 
         body
@@ -91,7 +91,7 @@ module Rollbar
 
       def find_end_of_head_open(body)
         head_open = body.index(/<head\W/)
-        body.index('>', head_open) + 1 if head_open
+        body.index('>', head_open) if head_open
       end
 
       def join_body(response)
@@ -104,20 +104,27 @@ module Rollbar
         response.close if response.respond_to?(:close)
       end
 
-      def config_js_tag
-        script_tag("var _rollbarConfig = #{config[:options].to_json};")
+      def config_js_tag(env)
+        script_tag("var _rollbarConfig = #{config[:options].to_json};", env)
       end
 
-      def snippet_js_tag
-        script_tag(js_snippet)
+      def snippet_js_tag(env)
+        script_tag(js_snippet, env)
       end
 
       def js_snippet
         SNIPPET
       end
 
-      def script_tag(content)
-        html_safe_if_needed("\n<script type=\"text/javascript\">#{content}</script>")
+      def script_tag(content, env)
+        if defined?(::SecureHeaders)
+          nonce = ::SecureHeaders.content_security_policy_script_nonce(::Rack::Request.new(env))
+          script_tag_content = "\n<script type=\"text/javascript\" nonce=\"#{nonce}\">#{content}</script>"
+        else
+          script_tag_content = "\n<script type=\"text/javascript\">#{content}</script>"
+        end
+
+        html_safe_if_needed(script_tag_content)
       end
 
       def html_safe_if_needed(string)

data/lib/rollbar/logger_proxy.rb

@@ -23,6 +23,8 @@ module Rollbar
     end
 
     def log(level, message)
+      return unless Rollbar.configuration.enabled
+
       @object.send(level, message)
     rescue
       puts "[Rollbar] Error logging #{level}:"

data/lib/rollbar/rake.rb

@@ -20,7 +20,9 @@ module Rollbar
     end
 
     def self.patch?
-      major, minor, *_ = rake_version.split('.').map(&:to_i)
+      return false unless rake_version
+
+      major, minor, = rake_version.split('.').map(&:to_i)
 
       major > 0 || major == 0 && minor > 8
     end

data/lib/rollbar/request_data_extractor.rb

@@ -1,15 +1,15 @@
 require 'rack'
 require 'tempfile'
 
+require 'rollbar/scrubbers'
 require 'rollbar/scrubbers/url'
+require 'rollbar/scrubbers/params'
 require 'rollbar/util/ip_obfuscator'
 
 module Rollbar
   module RequestDataExtractor
-    SKIPPED_CLASSES = [Tempfile]
-
     def extract_person_data_from_controller(env)
-      if env.has_key? 'rollbar.person_data'
+      if env.has_key?('rollbar.person_data')
         person_data = env['rollbar.person_data'] || {}
       else
         controller = env['action_controller.instance']
@@ -47,24 +47,16 @@ module Rollbar
         :cookies => cookies,
         :session => session,
         :method => rollbar_request_method(env),
-        :route => route_params,
+        :route => route_params
       }
 
-      if env["action_dispatch.request_id"]
-        data[:request_id] = env["action_dispatch.request_id"]
+      if env['action_dispatch.request_id']
+        data[:request_id] = env['action_dispatch.request_id']
       end
 
       data
     end
 
-    def rollbar_scrubbed(value)
-      if Rollbar.configuration.randomize_scrub_length
-        random_filtered_value
-      else
-        '*' * (value.length rescue 8)
-      end
-    end
-
     private
 
     def mergeable_raw_body_params(rack_req)
@@ -89,7 +81,7 @@ module Rollbar
         if name == 'Cookie'
           {}
         elsif sensitive_headers_list.include?(name)
-          { name => rollbar_scrubbed(env[header]) }
+          { name => Rollbar::Scrubbers.scrub_value(env[header]) }
         else
           { name => env[header] }
         end
@@ -108,8 +100,8 @@ module Rollbar
 
       port = env['HTTP_X_FORWARDED_PORT']
       if port && !(scheme.downcase == 'http' && port.to_i == 80) && \
-                 !(scheme.downcase == 'https' && port.to_i == 443) && \
-                 !(host.include? ':')
+         !(scheme.downcase == 'https' && port.to_i == 443) && \
+         !(host.include? ':')
         host = host + ':' + port
       end
 
@@ -151,7 +143,7 @@ module Rollbar
 
     def json_request?(rack_req)
       !!(rack_req.env['CONTENT_TYPE'] =~ %r{application/json} ||
-         rack_req.env['ACCEPT']       =~ /\bjson\b/)
+         rack_req.env['ACCEPT'] =~ /\bjson\b/)
     end
 
     def rollbar_request_params(env)
@@ -189,59 +181,15 @@ module Rollbar
     end
 
     def rollbar_filtered_params(sensitive_params, params)
-      sensitive_params_regexp = Regexp.new(sensitive_params.map{ |val| Regexp.escape(val.to_s).to_s }.join('|'), true)
-
-      return {} unless params
-
-      params.to_hash.inject({}) do |result, (key, value)|
-        if sensitive_params_regexp =~ Rollbar::Encoding.encode(key).to_s
-          result[key] = rollbar_scrubbed(value)
-        elsif value.is_a?(Hash)
-          result[key] = rollbar_filtered_params(sensitive_params, value)
-        elsif value.is_a?(Array)
-          result[key] = value.map do |v|
-            v.is_a?(Hash) ? rollbar_filtered_params(sensitive_params, v) : rollbar_filtered_param_value(v)
-          end
-        elsif skip_value?(value)
-          result[key] = "Skipped value of class '#{value.class.name}'"
-        else
-          result[key] = rollbar_filtered_param_value(value)
-        end
-
-        result
-      end
-    end
-
-    def rollbar_filtered_param_value(value)
-      if ATTACHMENT_CLASSES.include?(value.class.name)
-        begin
-          {
-            :content_type => value.content_type,
-            :original_filename => value.original_filename,
-            :size => value.tempfile.size
-          }
-        rescue
-          'Uploaded file'
-        end
-      else
-        value
-      end
+      Rollbar::Scrubbers::Params.call(params, sensitive_params)
     end
 
     def sensitive_params_list(env)
-      Array(Rollbar.configuration.scrub_fields) | Array(env['action_dispatch.parameter_filter'])
+      Array(env['action_dispatch.parameter_filter'])
     end
 
     def sensitive_headers_list
       Rollbar.configuration.scrub_headers || []
     end
-
-    def random_filtered_value
-      '*' * (rand(5) + 3)
-    end
-
-    def skip_value?(value)
-      SKIPPED_CLASSES.any? { |klass| value.is_a?(klass) }
-    end
   end
 end