rollbar 3.2.0 → 3.3.0

data/lib/generators/rollbar/rollbar_generator.rb

@@ -5,7 +5,8 @@ require 'generators/rollbar/rollbar_generator'
 module Rollbar
   module Generators
     class RollbarGenerator < ::Rails::Generators::Base
-      argument :access_token, :type => :string, :banner => 'access_token', :default => :use_env_sentinel
+      argument :access_token, :type => :string, :banner => 'access_token',
+                              :default => :use_env_sentinel
 
       source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
 
@@ -13,32 +14,35 @@ module Rollbar
         say 'creating initializer...'
         if access_token_configured?
           say "It looks like you've already configured Rollbar."
-          say 'To re-create the config file, remove it first: config/initializers/rollbar.rb'
+          say 'To re-create the config file, remove it first: ' \
+            'config/initializers/rollbar.rb'
           exit
         end
 
         begin
           require 'ey_config'
         rescue LoadError
+          # Skip loading
         end
 
         if defined? EY::Config
           say 'Access token will be read from Engine Yard configuration'
+        elsif access_token === :use_env_sentinel
+          say 'Generator run without an access token; assuming you want to ' \
+            'configure using an environment variable.'
+          say "You'll need to add an environment variable ROLLBAR_ACCESS_TOKEN " \
+            'with your access token:'
+          say "\n$ export ROLLBAR_ACCESS_TOKEN=yourtokenhere"
+          say "\nIf that's not what you wanted to do:"
+          say "\n$ rm config/initializers/rollbar.rb"
+          say '$ rails generate rollbar yourtokenhere'
+          say "\n"
         else
-          if access_token === :use_env_sentinel
-            say 'Generator run without an access token; assuming you want to configure using an environment variable.'
-            say "You'll need to add an environment variable ROLLBAR_ACCESS_TOKEN with your access token:"
-            say "\n$ export ROLLBAR_ACCESS_TOKEN=yourtokenhere"
-            say "\nIf that's not what you wanted to do:"
-            say "\n$ rm config/initializers/rollbar.rb"
-            say '$ rails generate rollbar yourtokenhere'
-            say "\n"
-          else
-            say 'access token: ' << access_token
-          end
+          say 'access token: ' << access_token
         end
 
-        template 'initializer.rb', 'config/initializers/rollbar.rb', :assigns => { :access_token => access_token_expr }
+        template 'initializer.erb', 'config/initializers/rollbar.rb',
+                 :assigns => { :access_token => access_token_expr }
 
         # TODO: run rake test task
       end

data/lib/rails/rollbar_runner.rb

@@ -4,7 +4,10 @@ require 'rollbar'
 # Rails.root is not present here.
 # RSpec needs ENV['DUMMYAPP_PATH'] in order to have a valid path.
 # Dir.pwd is used in normal operation.
-APP_PATH = File.expand_path('config/application', (ENV['DUMMYAPP_PATH'] || Dir.pwd))
+APP_PATH = File.expand_path(
+  'config/application',
+  (ENV['DUMMYAPP_PATH'] || Dir.pwd)
+)
 
 module Rails
   class RollbarRunner
@@ -49,9 +52,9 @@ module Rails
     def legacy_runner
       string_to_eval = File.read(runner_path)
 
-      ::Rails.module_eval(<<-EOL, __FILE__, __LINE__ + 2)
+      ::Rails.module_eval(<<-FILE, __FILE__, __LINE__ + 1)
           #{string_to_eval}
-      EOL
+      FILE
     end
 
     def rails5_runner
@@ -68,11 +71,15 @@ module Rails
     end
 
     def runner_path
-      railties_gem_dir + '/lib/rails/commands/runner.rb'
+      "#{railties_gem_dir}/lib/rails/commands/runner.rb"
     end
 
     def railties_gem
-      resolver_class = Gem::Specification.respond_to?(:find_by_name) ? GemResolver : LegacyGemResolver
+      resolver_class = if Gem::Specification.respond_to?(:find_by_name)
+                         GemResolver
+                       else
+                         LegacyGemResolver
+                       end
       gem = resolver_class.new.railties_gem
 
       abort 'railties gem not found' unless gem

data/lib/rollbar/capistrano.rb

@@ -34,7 +34,11 @@ module Rollbar
           _cset(:rollbar_role)  { :app }
           _cset(:rollbar_user)  { ENV['USER'] || ENV['USERNAME'] }
           _cset(:rollbar_env)   { fetch(:rails_env, 'production') }
-          _cset(:rollbar_token) { abort("Please specify the Rollbar access token, set :rollbar_token, 'your token'") }
+          _cset(:rollbar_token) do
+            abort(
+              "Please specify the Rollbar access token, set :rollbar_token, 'your token'"
+            )
+          end
           _cset(:rollbar_revision) { real_revision }
           _cset(:rollbar_comment) { nil }
         end
@@ -51,7 +55,9 @@ module Rollbar
           :task => :deploy_started,
           :configuration => configuration
         ) do
-          ::Rollbar::CapistranoTasks.deploy_started(configuration, configuration.logger, configuration.dry_run)
+          ::Rollbar::CapistranoTasks.deploy_started(
+            configuration, configuration.logger, configuration.dry_run
+          )
         end
       end
 
@@ -61,17 +67,17 @@ module Rollbar
           :task => :deploy_succeeded,
           :configuration => configuration
         ) do
-          ::Rollbar::CapistranoTasks.deploy_succeeded(configuration, configuration.logger, configuration.dry_run)
+          ::Rollbar::CapistranoTasks.deploy_succeeded(
+            configuration, configuration.logger, configuration.dry_run
+          )
         end
       end
 
-      def load_task(configuration:, desc:, task:)
+      def load_task(configuration:, desc:, task:, &block)
         configuration.load do
           namespace :rollbar do
             desc(desc)
-            task(task) do
-              yield
-            end
+            task(task, &block)
           end
         end
       end
@@ -79,4 +85,6 @@ module Rollbar
   end
 end
 
-Rollbar::Capistrano2.load_into(Capistrano::Configuration.instance) if Capistrano::Configuration.instance
+if Capistrano::Configuration.instance
+  Rollbar::Capistrano2.load_into(Capistrano::Configuration.instance)
+end

data/lib/rollbar/capistrano3.rb

@@ -8,7 +8,10 @@ require 'rollbar/capistrano_tasks'
 
 namespace :rollbar do
   # dry_run? wasn't introduced till Capistrano 3.5.0; use the old fetch(:sshkit_backed)
-  set :dry_run, (proc { ::Capistrano::Configuration.env.fetch(:sshkit_backend) == ::SSHKit::Backend::Printer })
+  set :dry_run, (proc {
+                   ::Capistrano::Configuration.env.fetch(:sshkit_backend) ==
+                     ::SSHKit::Backend::Printer
+                 })
 
   desc 'Send deployment started notification to Rollbar.'
   task :deploy_started do
@@ -49,7 +52,10 @@ namespace :load do
   task :defaults do
     set :rollbar_user,      (proc { fetch :local_user, ENV['USER'] || ENV['USERNAME'] })
     set :rollbar_env,       (proc { fetch :rails_env, 'production' })
-    set :rollbar_token,     (proc { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" })
+    set :rollbar_token,     (proc {
+                               abort 'Please specify the Rollbar access token, ' \
+                                     "set :rollbar_token, 'your token'"
+                             })
     set :rollbar_role,      (proc { :app })
     set :rollbar_revision,  (proc { fetch :current_revision })
   end

data/lib/rollbar/capistrano_tasks.rb

@@ -13,7 +13,9 @@ module Rollbar
           capistrano.set(:rollbar_deploy_id, 123) if dry_run
 
           skip_in_dry_run(logger, dry_run) do
-            if result[:success] && (deploy_id = result[:data] && result[:data][:deploy_id])
+            if result[:success] &&
+               (deploy_id = result[:data] &&
+               result[:data][:deploy_id])
               capistrano.set :rollbar_deploy_id, deploy_id
             else
               message = format_message('Unable to report deploy to Rollbar',
@@ -25,13 +27,17 @@ module Rollbar
       end
 
       def deploy_succeeded(capistrano, logger, dry_run)
-        deploy_update(capistrano, logger, dry_run, :desc => 'Setting deployment status to `succeeded` in Rollbar') do
+        deploy_update(
+          capistrano, logger, dry_run,
+          :desc => 'Setting deployment status to `succeeded` in Rollbar'
+        ) do
           report_deploy_succeeded(capistrano, dry_run)
         end
       end
 
       def deploy_failed(capistrano, logger, dry_run)
-        deploy_update(capistrano, logger, dry_run, :desc => 'Setting deployment status to `failed` in Rollbar') do
+        deploy_update(capistrano, logger, dry_run,
+                      :desc => 'Setting deployment status to `failed` in Rollbar') do
           report_deploy_failed(capistrano, dry_run)
         end
       end
@@ -42,7 +48,6 @@ module Rollbar
         capistrano_300_warning(logger)
         logger.info opts[:desc] if opts[:desc]
         yield
-
       rescue StandardError => e
         log_error logger, "Error reporting to Rollbar: #{e.inspect}"
       end
@@ -68,7 +73,9 @@ module Rollbar
       end
 
       def capistrano_300_warning(logger)
-        return unless ::Capistrano.const_defined?('VERSION') && ::Capistrano::VERSION =~ /^3\.0/
+        unless ::Capistrano.const_defined?('VERSION') && ::Capistrano::VERSION =~ /^3\.0/
+          return
+        end
 
         logger.warn('You need to upgrade capistrano to >= 3.1 version in order'\
           'to correctly report deploys to Rollbar. (On 3.0, the reported revision'\
@@ -121,7 +128,8 @@ module Rollbar
         if capistrano.fetch(:rollbar_deploy_id)
           yield
         else
-          log_error logger, 'Failed to update the deploy in Rollbar. No deploy id available.'
+          log_error logger,
+                    'Failed to update the deploy in Rollbar. No deploy id available.'
         end
       end
 
@@ -134,7 +142,8 @@ module Rollbar
       end
 
       def debug_request_response(logger, result)
-        # NOTE: in Capistrano debug messages go to log/capistrano.log but not to stdout even if log_level == :debug
+        # NOTE: in Capistrano debug messages go to log/capistrano.log but not to
+        # stdout even if log_level == :debug
         logger.debug result[:request_info]
         logger.debug result[:response_info] if result[:response_info]
       end

data/lib/rollbar/configuration.rb

@@ -4,82 +4,82 @@ module Rollbar
   class Configuration
     SEND_EXTRA_FRAME_DATA_OPTIONS = [:none, :app, :all].freeze
 
-    attr_accessor :access_token
-    attr_accessor :async_handler
-    attr_accessor :branch
-    attr_reader :before_process
-    attr_accessor :capture_uncaught
-    attr_accessor :code_version
-    attr_accessor :custom_data_method
-    attr_accessor :delayed_job_enabled
-    attr_accessor :default_logger
-    attr_reader :logger_level
-    attr_accessor :disable_monkey_patch
-    attr_accessor :disable_rack_monkey_patch
-    attr_accessor :disable_core_monkey_patch
-    attr_accessor :enable_error_context
-    attr_accessor :dj_threshold
-    attr_accessor :async_skip_report_handler
-    attr_accessor :enabled
-    attr_accessor :endpoint
-    attr_accessor :environment
-    attr_accessor :exception_level_filters
-    attr_accessor :failover_handlers
-    attr_accessor :framework
-    attr_accessor :ignored_person_ids
-    attr_accessor :host
-    attr_accessor :locals
-    attr_writer :logger
-    attr_accessor :payload_options
-    attr_accessor :person_method
-    attr_accessor :person_id_method
-    attr_accessor :person_username_method
-    attr_accessor :person_email_method
-    attr_accessor :populate_empty_backtraces
-    attr_accessor :report_dj_data
-    attr_accessor :open_timeout
-    attr_accessor :request_timeout
-    attr_accessor :net_retries
-    attr_accessor :root
-    attr_accessor :js_options
-    attr_accessor :js_enabled
-    attr_accessor :safely
-    attr_accessor :scrub_fields
-    attr_accessor :scrub_user
-    attr_accessor :scrub_password
-    attr_accessor :scrub_whitelist
-    attr_accessor :collect_user_ip
-    attr_accessor :anonymize_user_ip
-    attr_accessor :user_ip_obfuscator_secret
-    attr_accessor :randomize_scrub_length
-    attr_accessor :uncaught_exception_level
-    attr_accessor :scrub_headers
-    attr_accessor :sidekiq_threshold
-    attr_accessor :sidekiq_use_scoped_block
-    attr_reader :transform
-    attr_accessor :verify_ssl_peer
-    attr_accessor :use_async
-    attr_accessor :async_json_payload
-    attr_reader :use_eventmachine
-    attr_accessor :web_base
-    attr_reader :send_extra_frame_data
-    attr_accessor :use_exception_level_filters_default
-    attr_accessor :proxy
-    attr_accessor :raise_on_error
-    attr_accessor :transmit
-    attr_accessor :log_payload
-    attr_accessor :backtrace_cleaner
-
-    attr_accessor :write_to_file
-    attr_accessor :filepath
-    attr_accessor :files_with_pid_name_enabled
-    attr_accessor :files_processed_enabled
-    attr_accessor :files_processed_duration # seconds
-    attr_accessor :files_processed_size # bytes
-    attr_accessor :use_payload_access_token
-
-    attr_reader :project_gem_paths
-    attr_accessor :configured_options
+    attr_accessor :access_token,
+                  :anonymize_user_ip,
+                  :async_handler,
+                  :async_json_payload,
+                  :async_skip_report_handler,
+                  :backtrace_cleaner,
+                  :branch,
+                  :capture_uncaught,
+                  :code_version,
+                  :collect_user_ip,
+                  :configured_options,
+                  :custom_data_method,
+                  :default_logger,
+                  :delayed_job_enabled,
+                  :disable_core_monkey_patch,
+                  :disable_monkey_patch,
+                  :disable_rack_monkey_patch,
+                  :dj_threshold,
+                  :enable_error_context,
+                  :enabled,
+                  :endpoint,
+                  :environment,
+                  :exception_level_filters,
+                  :failover_handlers,
+                  :filepath,
+                  :files_processed_duration,
+                  :files_processed_enabled,
+                  :files_processed_size,
+                  :files_with_pid_name_enabled,
+                  :framework,
+                  :ignore_internal_errors,
+                  :ignored_person_ids,
+                  :js_enabled,
+                  :js_options,
+                  :host,
+                  :locals,
+                  :log_payload,
+                  :net_retries,
+                  :open_timeout,
+                  :payload_options,
+                  :person_email_method,
+                  :person_id_method,
+                  :person_method,
+                  :person_username_method,
+                  :populate_empty_backtraces,
+                  :proxy,
+                  :raise_on_error,
+                  :randomize_scrub_length,
+                  :report_dj_data,
+                  :request_timeout,
+                  :root,
+                  :safely,
+                  :scrub_fields,
+                  :scrub_password,
+                  :scrub_user,
+                  :scrub_whitelist,
+                  :transmit,
+                  :uncaught_exception_level,
+                  :user_ip_obfuscator_secret,
+                  :user_ip_rack_env_key,
+                  :scrub_headers,
+                  :sidekiq_threshold,
+                  :sidekiq_use_scoped_block,
+                  :use_async,
+                  :use_exception_level_filters_default,
+                  :use_payload_access_token,
+                  :verify_ssl_peer,
+                  :web_base,
+                  :write_to_file
+    attr_reader :before_process,
+                :logger_level,
+                :project_gem_paths,
+                :send_extra_frame_data,
+                :transform,
+                :use_eventmachine
+    attr_writer :logger # seconds # bytes
 
     alias safely? safely
 
@@ -94,7 +94,7 @@ module Rollbar
       @capture_uncaught = nil
       @code_version = nil
       @custom_data_method = nil
-      @default_logger = lambda { ::Logger.new(STDERR) }
+      @default_logger = lambda { ::Logger.new($stderr) }
       @logger_level = :info
       @delayed_job_enabled = true
       @disable_monkey_patch = false
@@ -113,6 +113,11 @@ module Rollbar
       }
       @failover_handlers = []
       @framework = 'Plain'
+      @ignore_internal_errors = [
+        'Net::ReadTimeout',
+        'Net::OpenTimeout',
+        'SocketError'
+      ]
       @ignored_person_ids = []
       @host = nil
       @payload_options = {}
@@ -158,6 +163,7 @@ module Rollbar
       @collect_user_ip = true
       @anonymize_user_ip = false
       @user_ip_obfuscator_secret = nil
+      @user_ip_rack_env_key = nil
       @backtrace_cleaner = nil
       @hooks = {
         :on_error_response => nil, # params: response
@@ -214,7 +220,8 @@ module Rollbar
     def use_active_job(options = {})
       require 'rollbar/delay/active_job'
 
-      Rollbar::Delay::ActiveJob.queue_as(options[:queue] || Rollbar::Delay::ActiveJob.default_queue_name)
+      Rollbar::Delay::ActiveJob.queue_as(options[:queue] ||
+      Rollbar::Delay::ActiveJob.default_queue_name)
 
       @use_async      = true
       @async_handler  = Rollbar::Delay::ActiveJob
@@ -254,8 +261,13 @@ module Rollbar
     end
 
     def use_sidekiq=(value)
-      deprecation_message = '#use_sidekiq=(value) has been deprecated in favor of #use_sidekiq(options = {}). Please update your rollbar configuration.'
-      defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
+      deprecation_message = '#use_sidekiq=(value) has been deprecated in favor ' \
+        'of #use_sidekiq(options = {}). Please update your rollbar configuration.'
+      if defined?(ActiveSupport)
+        ActiveSupport::Deprecation.warn(deprecation_message)
+      else
+        puts(deprecation_message)
+      end
 
       value.is_a?(Hash) ? use_sidekiq(value) : use_sidekiq
     end
@@ -274,8 +286,13 @@ module Rollbar
     end
 
     def use_sucker_punch=(_value)
-      deprecation_message = '#use_sucker_punch=(value) has been deprecated in favor of #use_sucker_punch. Please update your rollbar configuration.'
-      defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
+      deprecation_message = '#use_sucker_punch=(value) has been deprecated in ' \
+        'favor of #use_sucker_punch. Please update your rollbar configuration.'
+      if defined?(ActiveSupport)
+        ActiveSupport::Deprecation.warn(deprecation_message)
+      else
+        puts(deprecation_message)
+      end
 
       use_sucker_punch
     end
@@ -306,7 +323,9 @@ module Rollbar
 
     def send_extra_frame_data=(value)
       unless SEND_EXTRA_FRAME_DATA_OPTIONS.include?(value)
-        logger.warning("Wrong 'send_extra_frame_data' value, :none, :app or :full is expected")
+        logger.warning(
+          "Wrong 'send_extra_frame_data' value, :none, :app or :full is expected"
+        )
 
         return
       end
@@ -332,14 +351,14 @@ module Rollbar
     end
 
     def hook(symbol, &block)
-      if @hooks.key?(symbol)
-        if block_given?
-          @hooks[symbol] = block
-        else
-          @hooks[symbol]
-        end
+      unless @hooks.key?(symbol)
+        raise StandardError, "Hook :#{symbol} is not supported by Rollbar SDK."
+      end
+
+      if block_given?
+        @hooks[symbol] = block
       else
-        raise StandardError, 'Hook :' + symbol.to_s + ' is not supported by Rollbar SDK.'
+        @hooks[symbol]
       end
     end
 
@@ -360,7 +379,10 @@ module Rollbar
       return super unless configuration.respond_to?(method)
 
       method_string = method.to_s
-      configured[method_string.chomp('=').to_sym] = args.first if method_string.end_with?('=')
+      if method_string.end_with?('=')
+        configured[method_string.chomp('=').to_sym] =
+          args.first
+      end
 
       configuration.send(method, *args, &block)
     end

data/lib/rollbar/delay/shoryuken.rb

@@ -2,9 +2,10 @@ require 'shoryuken'
 
 module Rollbar
   module Delay
-    # Following class allows to send rollbars using Sho-ryu-ken as a background jobs processor.
-    # see the queue_name method which states that your queues needs to be names as "rollbar_ENVIRONMENT".
-    # retry intervals will be used to retry sending the same message again if failed before.
+    # Following class allows to send rollbars using Sho-ryu-ken as a background
+    # jobs processor. See the queue_name method which states that your queues
+    # needs to be names as "rollbar_ENVIRONMENT". Retry intervals will be used
+    # to retry sending the same message again if failed before.
     class Shoryuken
       include ::Shoryuken::Worker
 

data/lib/rollbar/delay/sidekiq.rb

@@ -10,7 +10,9 @@ module Rollbar
       end
 
       def call(payload)
-        raise StandardError, 'Unable to push the job to Sidekiq' if ::Sidekiq::Client.push(@options.merge('args' => [payload])).nil?
+        return unless ::Sidekiq::Client.push(@options.merge('args' => [payload])).nil?
+
+        raise(StandardError, 'Unable to push the job to Sidekiq')
       end
 
       include ::Sidekiq::Worker

data/lib/rollbar/delay/sucker_punch.rb

@@ -7,8 +7,7 @@ module Rollbar
       include ::SuckerPunch::Job
 
       class << self
-        attr_accessor :perform_proc
-        attr_accessor :ready
+        attr_accessor :perform_proc, :ready
       end
 
       self.ready = false

data/lib/rollbar/delay/thread.rb

@@ -62,11 +62,12 @@ module Rollbar
                 reaper.join
               end
             rescue Timeout::Error
-              raise TimeoutError, "unable to reap all threads within #{EXIT_TIMEOUT} seconds"
+              raise TimeoutError,
+                    "unable to reap all threads within #{EXIT_TIMEOUT} seconds"
             end
           end
         end
-      end # class << self
+      end
 
       def priority
         self.class.options[:priority] || DEFAULT_PRIORITY

data/lib/rollbar/deploy.rb

@@ -30,9 +30,7 @@ module Rollbar
       return {} unless access_token && !access_token.empty?
 
       uri = ::URI.parse(
-        ::Rollbar::Deploy::ENDPOINT +
-        deploy_id.to_s +
-        '?access_token=' + access_token
+        "#{::Rollbar::Deploy::ENDPOINT}#{deploy_id}?access_token=#{access_token}"
       )
 
       request = ::Net::HTTP::Patch.new(uri.request_uri)
@@ -74,17 +72,18 @@ module Rollbar
 
       def request_result(uri, request)
         {
-          :request_info => uri.inspect + ': ' + request.body,
+          :request_info => "#{uri.inspect}: #{request.body}",
           :request => request
         }
       end
 
       def response_result(response)
+        code = response.code
+        message = response.message
+        body = response.body.delete("\n")
         {
           :response => response,
-          :response_info => response.code + '; ' +
-            response.message + '; ' +
-            response.body.delete("\n")
+          :response_info => "#{code}; #{message}; #{body}"
         }.merge(::JSON.parse(response.body, :symbolize_names => true))
       end
     end

data/lib/rollbar/encoding/encoder.rb

@@ -1,8 +1,10 @@
 module Rollbar
   module Encoding
     class Encoder
-      ALL_ENCODINGS = [::Encoding::UTF_8, ::Encoding::ISO_8859_1, ::Encoding::ASCII_8BIT, ::Encoding::US_ASCII].freeze
-      ASCII_ENCODINGS = [::Encoding::US_ASCII, ::Encoding::ASCII_8BIT, ::Encoding::ISO_8859_1].freeze
+      ALL_ENCODINGS = [::Encoding::UTF_8, ::Encoding::ISO_8859_1, ::Encoding::ASCII_8BIT,
+                       ::Encoding::US_ASCII].freeze
+      ASCII_ENCODINGS = [::Encoding::US_ASCII, ::Encoding::ASCII_8BIT,
+                         ::Encoding::ISO_8859_1].freeze
       UTF8 = 'UTF-8'.freeze
       BINARY = 'binary'.freeze
 
@@ -40,7 +42,9 @@ module Rollbar
       def force_encoding(value)
         return value if value.frozen?
 
-        value.force_encoding(detect_encoding(value)) if value.encoding == ::Encoding::UTF_8
+        if value.encoding == ::Encoding::UTF_8
+          value.force_encoding(detect_encoding(value))
+        end
 
         value
       end