rollbar 2.23.2 → 3.3.0

data/lib/rollbar/rollbar_test.rb

@@ -1,48 +1,16 @@
 require 'rollbar'
-begin
-  require 'rack/mock'
-rescue LoadError
-  puts 'Cannot load rack/mock'
-end
-require 'logger'
 
-# Module to inject into the Rails controllers or rack apps
 module RollbarTest # :nodoc:
-  def test_rollbar
-    puts 'Raising RollbarTestingException to simulate app failure.'
-
-    raise RollbarTestingException.new, ::RollbarTest.success_message
-  end
-
   def self.run
     return unless confirmed_token?
 
-    configure_rails if defined?(Rails)
-
-    puts 'Testing manual report...'
-    Rollbar.error('Test error from rollbar:test')
-
-    return unless defined?(Rack::MockRequest)
-
-    protocol, app = setup_app
-
-    puts 'Processing...'
-    env = Rack::MockRequest.env_for("#{protocol}://www.example.com/verify", 'REMOTE_ADDR' => '127.0.0.1')
-    status, = app.call(env)
-
-    puts error_message unless status.to_i == 500
-  end
-
-  def self.configure_rails
-    Rails.logger = if defined?(ActiveSupport::TaggedLogging)
-                     ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
-                   else
-                     Logger.new(STDOUT)
-                   end
+    puts 'Test sending to Rollbar...'
+    result = Rollbar.info('Test message from rollbar:test')
 
-    Rails.logger.level = Logger::DEBUG
-    Rollbar.preconfigure do |config|
-      config.logger = Rails.logger
+    if result == 'error'
+      puts error_message
+    else
+      puts success_message
     end
   end
 
@@ -54,94 +22,17 @@ module RollbarTest # :nodoc:
     false
   end
 
-  def self.authlogic_config
-    # from http://stackoverflow.com/questions/5270835/authlogic-activation-problems
-    return unless defined?(Authlogic)
-
-    Authlogic::Session::Base.controller = Authlogic::ControllerAdapters::RailsAdapter.new(self)
-  end
-
-  def self.setup_app
-    puts 'Setting up the test app.'
-
-    if defined?(Rails)
-      app = rails_app
-
-      draw_rails_route(app)
-
-      authlogic_config
-
-      [rails_protocol(app), app]
-    else
-      ['http', rack_app]
-    end
-  end
-
-  def self.rails_app
-    # The setup below is needed for Rails 5.x, but not for Rails 4.x and below.
-    # (And fails on Rails 4.x in various ways depending on the exact version.)
-    return Rails.application if Rails.version < '5.0.0'
-
-    # Spring now runs by default in development on all new Rails installs. This causes
-    # the new `/verify` route to not get picked up if `config.cache_classes == false`
-    # which is also a default in development env.
-    #
-    # `config.cache_classes` needs to be set, but the only possible time is at app load,
-    # so here we clone the default app with an updated config.
-    #
-    config = Rails.application.config
-    config.cache_classes = true
-
-    # Make a copy of the app, so the config can be updated.
-    Rails.application.class.name.constantize.new(:config => config)
-  end
-
-  def self.draw_rails_route(app)
-    app.routes_reloader.execute_if_updated
-    app.routes.draw do
-      get 'verify' => 'rollbar_test#verify', :as => 'verify'
-    end
-  end
-
-  def self.rails_protocol(app)
-    defined?(app.config.force_ssl && app.config.force_ssl) ? 'https' : 'http'
-  end
-
-  def self.rack_app
-    Class.new do
-      include RollbarTest
-
-      def self.call(_env)
-        new.test_rollbar
-      end
-    end
-  end
-
   def self.token_error_message
     'Rollbar needs an access token configured. Check the README for instructions.'
   end
 
   def self.error_message
-    '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.'
+    '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
 
   def self.success_message
     'Testing rollbar with "rake rollbar:test". If you can see this, it works.'
   end
 end
-
-class RollbarTestingException < RuntimeError; end
-
-if defined?(Rails)
-  class RollbarTestController < ActionController::Base # :nodoc:
-    include RollbarTest
-
-    def verify
-      test_rollbar
-    end
-
-    def logger
-      nil
-    end
-  end
-end

data/lib/rollbar/scrubbers/params.rb

@@ -10,7 +10,8 @@ module Rollbar
     # configuration array even if :scrub_all is true.
     class Params
       SKIPPED_CLASSES = [::Tempfile].freeze
-      ATTACHMENT_CLASSES = %w[ActionDispatch::Http::UploadedFile Rack::Multipart::UploadedFile].freeze
+      ATTACHMENT_CLASSES = %w[ActionDispatch::Http::UploadedFile
+                              Rack::Multipart::UploadedFile].freeze
       SCRUB_ALL = :scrub_all
 
       def self.call(*args)
@@ -21,7 +22,7 @@ module Rollbar
         params = options[:params]
         return {} unless params
 
-        @scrubbed_object_ids = {}
+        @scrubbed_objects = {}.compare_by_identity
 
         config = options[:config]
         extra_fields = options[:extra_fields]
@@ -52,16 +53,20 @@ module Rollbar
       end
 
       def build_whitelist_regex(whitelist)
-        fields = whitelist.find_all { |f| f.is_a?(String) || f.is_a?(Symbol) || f.is_a?(Regexp) }
+        fields = whitelist.find_all do |f|
+          f.is_a?(String) || f.is_a?(Symbol) || f.is_a?(Regexp)
+        end
         return unless fields.any?
 
-        Regexp.new(fields.map { |val| val.is_a?(Regexp) ? val : /\A#{Regexp.escape(val.to_s)}\z/ }.join('|'))
+        Regexp.new(fields.map do |val|
+                     val.is_a?(Regexp) ? val : /\A#{Regexp.escape(val.to_s)}\z/
+                   end.join('|'))
       end
 
       def scrub(params, options)
-        return params if @scrubbed_object_ids[params.object_id]
+        return params if @scrubbed_objects[params]
 
-        @scrubbed_object_ids[params.object_id] = true
+        @scrubbed_objects[params] = true
 
         fields_regex = options[:fields_regex]
         scrub_all = options[:scrub_all]
@@ -71,7 +76,8 @@ module Rollbar
 
         params.to_hash.inject({}) do |result, (key, value)|
           encoded_key = Rollbar::Encoding.encode(key).to_s
-          result[key] = if (fields_regex === encoded_key) && !(whitelist_regex === encoded_key)
+          result[key] = if (fields_regex === encoded_key) &&
+                           !(whitelist_regex === encoded_key)
                           scrub_value(value)
                         elsif value.is_a?(Hash)
                           scrub(value, options)

data/lib/rollbar/scrubbers/url.rb

@@ -13,7 +13,7 @@ module Rollbar
       end
 
       def call(options = {})
-        url = options[:url]
+        url = ascii_encode(options[:url])
 
         filter(url,
                build_regex(options[:scrub_fields]),
@@ -23,12 +23,29 @@ module Rollbar
                options[:scrub_fields].include?(SCRUB_ALL),
                build_whitelist_regex(options[:whitelist] || []))
       rescue StandardError => e
-        Rollbar.logger.error("[Rollbar] There was an error scrubbing the url: #{e}, options: #{options.inspect}")
+        message = '[Rollbar] There was an error scrubbing the url: ' \
+          "#{e}, options: #{options.inspect}"
+        Rollbar.logger.error(message)
         url
       end
 
       private
 
+      def ascii_encode(url)
+        # In some cases non-ascii characters won't be properly encoded, so we do it here.
+        #
+        # The standard encoders (the CGI and URI methods) are not reliable when
+        # the query string is already embedded in the full URL, but the inconsistencies
+        # are limited to issues with characters in the ascii range. (For example,
+        # the '#' if it appears in an unexpected place.) For escaping non-ascii,
+        # they are all OK, so we'll take care to skip the ascii chars.
+
+        return url if url.ascii_only?
+
+        # Iterate each char and only escape non-ascii characters.
+        url.each_char.map { |c| c.ascii_only? ? c : CGI.escape(c) }.join
+      end
+
       def build_whitelist_regex(whitelist)
         fields = whitelist.find_all { |f| f.is_a?(String) || f.is_a?(Symbol) }
         return unless fields.any?
@@ -36,12 +53,15 @@ module Rollbar
         Regexp.new(fields.map { |val| /\A#{Regexp.escape(val.to_s)}\z/ }.join('|'))
       end
 
-      def filter(url, regex, scrub_user, scrub_password, randomize_scrub_length, scrub_all, whitelist)
+      def filter(url, regex, scrub_user, scrub_password, randomize_scrub_length,
+                 scrub_all, whitelist)
         uri = URI.parse(url)
 
         uri.user = filter_user(uri.user, scrub_user, randomize_scrub_length)
-        uri.password = filter_password(uri.password, scrub_password, randomize_scrub_length)
-        uri.query = filter_query(uri.query, regex, randomize_scrub_length, scrub_all, whitelist)
+        uri.password = filter_password(uri.password, scrub_password,
+                                       randomize_scrub_length)
+        uri.query = filter_query(uri.query, regex, randomize_scrub_length, scrub_all,
+                                 whitelist)
 
         uri.to_s
       end
@@ -59,7 +79,12 @@ module Rollbar
       end
 
       def filter_password(password, scrub_password, randomize_scrub_length)
-        scrub_password && password ? filtered_value(password, randomize_scrub_length) : password
+        if scrub_password && password
+          filtered_value(password,
+                         randomize_scrub_length)
+        else
+          password
+        end
       end
 
       def filter_query(query, regex, randomize_scrub_length, scrub_all, whitelist)
@@ -67,10 +92,8 @@ module Rollbar
 
         params = decode_www_form(query)
 
-        encoded_query = encode_www_form(filter_query_params(params, regex, randomize_scrub_length, scrub_all, whitelist))
-
-        # We want this to rebuild array params like foo[]=1&foo[]=2
-        URI.escape(CGI.unescape(encoded_query))
+        encode_www_form(filter_query_params(params, regex, randomize_scrub_length,
+                                            scrub_all, whitelist))
       end
 
       def decode_www_form(query)
@@ -78,12 +101,28 @@ module Rollbar
       end
 
       def encode_www_form(params)
-        URI.encode_www_form(params)
+        restore_square_brackets(URI.encode_www_form(params))
+      end
+
+      def restore_square_brackets(query)
+        # We want this to rebuild array params like foo[]=1&foo[]=2
+        #
+        # URI.encode_www_form follows the spec at
+        # https://url.spec.whatwg.org/#concept-urlencoded-serializer
+        # and percent encodes square brackets. Here we change them back.
+        query.gsub('%5B', '[').gsub('%5D', ']')
       end
 
-      def filter_query_params(params, regex, randomize_scrub_length, scrub_all, whitelist)
+      def filter_query_params(params, regex, randomize_scrub_length, scrub_all,
+                              whitelist)
         params.map do |key, value|
-          [key, filter_key?(key, regex, scrub_all, whitelist) ? filtered_value(value, randomize_scrub_length) : value]
+          [key,
+           if filter_key?(key, regex, scrub_all,
+                          whitelist)
+             filtered_value(value, randomize_scrub_length)
+           else
+             value
+           end]
         end
       end
 
@@ -96,10 +135,10 @@ module Rollbar
           random_filtered_value
         else
           '*' * (begin
-                   value.length
-                 rescue StandardError
-                   8
-                 end)
+            value.length
+          rescue StandardError
+            8
+          end)
         end
       end
 

data/lib/rollbar/scrubbers.rb

@@ -2,7 +2,7 @@ module Rollbar
   module Scrubbers
     module_function
 
-    def scrub_value(value)
+    def scrub_value(_value)
       if Rollbar.configuration.randomize_scrub_length
         random_filtered_value
       else

data/lib/rollbar/truncation/remove_any_key_strategy.rb

@@ -91,7 +91,10 @@ module Rollbar
       def extract_title(body)
         return body['message']['body'] if body['message'] && body['message']['body']
         return extract_title_from_trace(body['trace']) if body['trace']
-        return extract_title_from_trace(body['trace_chain'][0]) if body['trace_chain'] && body['trace_chain'][0]
+
+        return unless body['trace_chain'] && body['trace_chain'][0]
+
+        extract_title_from_trace(body['trace_chain'][0])
       end
 
       def extract_title_from_trace(trace)

data/lib/rollbar/truncation/remove_extra_strategy.rb

@@ -24,7 +24,9 @@ module Rollbar
       end
 
       def delete_trace_chain_extra(body)
-        body['trace_chain'][0].delete('extra') if body['trace_chain'] && body['trace_chain'][0]['extra']
+        return unless body['trace_chain'] && body['trace_chain'][0]['extra']
+
+        body['trace_chain'][0].delete('extra')
       end
 
       def delete_trace_extra(body)

data/lib/rollbar/util/hash.rb

@@ -2,9 +2,10 @@ module Rollbar
   module Util
     module Hash # :nodoc:
       def self.deep_stringify_keys(hash, seen = {})
-        return if seen[hash.object_id]
+        seen.compare_by_identity
+        return if seen[hash]
 
-        seen[hash.object_id] = true
+        seen[hash] = true
         replace_seen_children(hash, seen)
 
         hash.reduce({}) do |h, (key, value)|
@@ -19,10 +20,10 @@ module Rollbar
         when ::Hash
           send(meth, thing, seen)
         when Array
-          if seen[thing.object_id]
+          if seen[thing]
             thing
           else
-            seen[thing.object_id] = true
+            seen[thing] = true
             replace_seen_children(thing, seen)
             thing.map { |v| map_value(v, meth, seen) }
           end
@@ -34,12 +35,18 @@ module Rollbar
       def self.replace_seen_children(thing, seen)
         case thing
         when ::Hash
-          thing.keys.each do |key|
-            thing[key] = "removed circular reference: #{thing[key]}" if seen[thing[key].object_id]
+          thing.keys.each do |key| # rubocop:disable Style/HashEachMethods
+            if seen[thing[key]]
+              thing[key] =
+                "removed circular reference: #{thing[key]}"
+            end
           end
         when Array
           thing.each_with_index do |_, i|
-            thing[i] = "removed circular reference: #{thing[i]}" if seen[thing[i].object_id]
+            if seen[thing[i]]
+              thing[i] =
+                "removed circular reference: #{thing[i]}"
+            end
           end
         end
       end

data/lib/rollbar/util/ip_anonymizer.rb

@@ -24,7 +24,7 @@ module Rollbar
       def self.anonymize_ipv6(ip)
         ip_parts = ip.to_s.split ':'
 
-        ip_string = ip_parts[0..2].join(':') + ':0000:0000:0000:0000:0000'
+        ip_string = "#{ip_parts[0..2].join(':')}:0000:0000:0000:0000:0000"
 
         IPAddr.new(ip_string).to_s
       end

data/lib/rollbar/util.rb

@@ -7,9 +7,10 @@ module Rollbar
     end
 
     def self.iterate_and_update(obj, block, seen = {})
-      return if obj.frozen? || seen[obj.object_id]
+      seen.compare_by_identity
+      return if obj.frozen? || seen[obj]
 
-      seen[obj.object_id] = true
+      seen[obj] = true
 
       if obj.is_a?(Array)
         iterate_and_update_array(obj, block, seen)
@@ -29,7 +30,7 @@ module Rollbar
     end
 
     def self.iterate_and_update_hash(obj, block, seen)
-      obj.keys.each do |k|
+      obj.keys.each do |k| # rubocop:disable Style/HashEachMethods
         v = obj[k]
         new_key = block.call(k)
 
@@ -47,18 +48,21 @@ module Rollbar
     end
 
     def self.deep_copy(obj, copied = {})
+      copied.compare_by_identity
+
       # if we've already made a copy, return it.
-      return copied[obj.object_id] if copied[obj.object_id]
+      return copied[obj] if copied[obj]
 
       result = clone_obj(obj)
 
       # Memoize the cloned object before recursive calls to #deep_copy below.
       # This is the point of doing the work in two steps.
-      copied[obj.object_id] = result
+      copied[obj] = result
 
-      if obj.is_a?(::Hash)
+      case obj
+      when ::Hash
         obj.each { |k, v| result[k] = deep_copy(v, copied) }
-      elsif obj.is_a?(Array)
+      when Array
         obj.each { |v| result << deep_copy(v, copied) }
       end
 
@@ -66,9 +70,10 @@ module Rollbar
     end
 
     def self.clone_obj(obj)
-      if obj.is_a?(::Hash)
+      case obj
+      when ::Hash
         obj.dup
-      elsif obj.is_a?(Array)
+      when Array
         obj.dup.clear
       else
         obj
@@ -78,12 +83,13 @@ module Rollbar
     def self.deep_merge(hash1, hash2, merged = {})
       hash1 ||= {}
       hash2 ||= {}
+      merged.compare_by_identity
 
       # If we've already merged these two objects, return hash1 now.
-      return hash1 if merged[hash1.object_id] && merged[hash1.object_id].include?(hash2.object_id)
+      return hash1 if merged[hash1] && merged[hash1].include?(hash2.object_id)
 
-      merged[hash1.object_id] ||= []
-      merged[hash1.object_id] << hash2.object_id
+      merged[hash1] ||= []
+      merged[hash1] << hash2.object_id
 
       perform_deep_merge(hash1, hash2, merged)
 
@@ -121,7 +127,7 @@ module Rollbar
     end
 
     def self.count_method_in_stack(method_symbol, file_path = '')
-      caller.grep(/#{file_path}.*#{method_symbol.to_s}/).count
+      caller.grep(/#{file_path}.*#{method_symbol}/).count
     end
 
     def self.method_in_stack(method_symbol, file_path = '')

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.23.2'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/lib/rollbar.rb

@@ -8,6 +8,7 @@ require 'forwardable'
 begin
   require 'securerandom'
 rescue LoadError
+  # Skip loading
 end
 
 require 'rollbar/version'
@@ -31,8 +32,7 @@ module Rollbar
 
     def_delegators :notifier, *PUBLIC_NOTIFIER_METHODS
 
-    attr_writer :plugins
-    attr_writer :root_notifier
+    attr_writer :plugins, :root_notifier
 
     def notifier
       # Use the global instance @root_notifier so we don't fall
@@ -160,8 +160,10 @@ module Rollbar
 
     # Backwards compatibility methods
 
-    def report_exception(exception, request_data = nil, person_data = nil, level = 'error')
-      Kernel.warn('[DEPRECATION] Rollbar.report_exception has been deprecated, please use log() or one of the level functions')
+    def report_exception(exception, request_data = nil, person_data = nil,
+                         level = 'error')
+      Kernel.warn('[DEPRECATION] Rollbar.report_exception has been deprecated, ' \
+        'please use log() or one of the level functions')
 
       scope = {}
       scope[:request] = request_data if request_data
@@ -173,13 +175,16 @@ module Rollbar
     end
 
     def report_message(message, level = 'info', extra_data = nil)
-      Kernel.warn('[DEPRECATION] Rollbar.report_message has been deprecated, please use log() or one of the level functions')
+      Kernel.warn('[DEPRECATION] Rollbar.report_message has been deprecated, ' \
+        'please use log() or one of the level functions')
 
       Rollbar.notifier.log(level, message, extra_data)
     end
 
-    def report_message_with_request(message, level = 'info', request_data = nil, person_data = nil, extra_data = nil)
-      Kernel.warn('[DEPRECATION] Rollbar.report_message_with_request has been deprecated, please use log() or one of the level functions')
+    def report_message_with_request(message, level = 'info', request_data = nil,
+                                    person_data = nil, extra_data = nil)
+      Kernel.warn('[DEPRECATION] Rollbar.report_message_with_request has been ' \
+        'deprecated, please use log() or one of the level functions')
 
       scope = {}
       scope[:request] = request_data if request_data

data/lib/tasks/benchmark.rake

@@ -77,7 +77,8 @@ class BenchmarkTraceWithBindings # :nodoc:
   def trace_point # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     return unless defined?(TracePoint)
 
-    @trace_point ||= TracePoint.new(:call, :return, :b_call, :b_return, :c_call, :c_return, :raise) do |tp|
+    @trace_point ||= TracePoint.new(:call, :return, :b_call, :b_return, :c_call,
+                                    :c_return, :raise) do |tp|
       next if options['hook_only']
 
       case tp.event

data/rollbar.gemspec

@@ -12,10 +12,13 @@ Gem::Specification.new do |gem|
   gem.summary       = 'Reports exceptions to Rollbar'
   gem.homepage      = 'https://rollbar.com'
   gem.license       = 'MIT'
-  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  gem.files        += ['spec/support/rollbar_api.rb'] # useful helper for app spec/tests.
   gem.name          = 'rollbar'
   gem.require_paths = ['lib']
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.0.0'
   gem.version = Rollbar::VERSION
 
   if gem.respond_to?(:metadata)

data/spec/support/rollbar_api.rb

@@ -0,0 +1,67 @@
+require 'rack/request'
+
+class RollbarAPI
+  UNAUTHORIZED_ACCESS_TOKEN = 'unauthorized'.freeze
+
+  def call(env)
+    request = Rack::Request.new(env)
+    json = JSON.parse(request.body.read)
+
+    return unauthorized unless authorized?(json, request)
+
+    return bad_request(json) unless valid_data?(json, request)
+
+    success(json, request)
+  end
+
+  protected
+
+  def authorized?(_json, request)
+    request.env['HTTP_X_ROLLBAR_ACCESS_TOKEN'] != UNAUTHORIZED_ACCESS_TOKEN
+  end
+
+  def response_headers
+    {
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  def valid_data?(_json, request)
+    !!request.env['HTTP_X_ROLLBAR_ACCESS_TOKEN']
+  end
+
+  def unauthorized
+    [401, response_headers, [unauthorized_body]]
+  end
+
+  def bad_request(_json)
+    [400, response_headers, [bad_request_body]]
+  end
+
+  def success(json, request)
+    [200, response_headers, [success_body(json, request)]]
+  end
+
+  def unauthorized_body
+    result(1, nil, 'invalid access token')
+  end
+
+  def bad_request_body
+    result(1, nil, 'bad request')
+  end
+
+  def success_body(json, _request)
+    result(0, {
+             :id => rand(1_000_000),
+             :uuid => json['data']['uuid']
+           }, nil)
+  end
+
+  def result(err, body, message)
+    {
+      :err => err,
+      :result => body,
+      :message => message
+    }.to_json
+  end
+end