sentry-raven 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c812e5ab292c9f9351064bfc75f13bf3f6fff8ea1163a79a0e7da2e5efa9afb
-  data.tar.gz: 2fb7356fa0b26ee6f8a09a8ab023a21dcee132aa75fd3d1d87fd5f528a1c3366
+  metadata.gz: 765b22e2ec433b8ab12697da42d40ba6c0f2f95956bd6ce93b0923b9160f386f
+  data.tar.gz: b4f97a6effa6828a10cb7844001852db042627dfe375aae61e93b92d10eb2ba7
 SHA512:
-  metadata.gz: b406e28322db6c9e96db35d108521f617c484cdef0367a6ea246709356d61b5917795289c3caf1cc7324f3228fba349a8b3f9a2b45aeaef0d01872848540db2a
-  data.tar.gz: f079139a9cf52c7344d28d55eec1fc108c237c76c23df7880122e66851d858bce86da817887d5a83f35c9732c619328178bfdd6f8cb6742c84024f0445710fed
+  metadata.gz: 25c1a39ce4a97b7e40fa66fc1dd1eb7ae4ef96a6e0956f7600db04717eb8c9f147d83317513ba072db31a4390b678b9c56f406f6ba02377f11b4810a3fef5128
+  data.tar.gz: 17adf7a479a1539a9fdc81003b2204c0334334cb54482812339af18cd7a75eb9830e22389fc0eed7e304787b993f8aaca92bb1d1c2f414e88a61858acadf08aa

data/.craft.yml

@@ -0,0 +1,14 @@
+minVersion: '0.9.0'
+github:
+    owner: getsentry
+    repo: raven-ruby
+changelogPolicy: simple
+preReleaseCommand: ruby .scripts/bump-version.sh
+statusProvider: 
+    name: github
+targets:
+    - name: github
+    - name: registry
+      type: sdk
+      config:
+          canonical: 'gem:sentry-raven'

data/.github/workflows/test.yml

@@ -0,0 +1,77 @@
+name: Test
+
+on: 
+  push:
+    branches:
+      - master
+      - release/**
+  pull_request:
+jobs:
+  test:
+    name: Test on ruby ${{ matrix.ruby_version }} and rails ${{ matrix.rails_version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        rails_version: [0, 4.2, 5.2, 6.0]
+        ruby_version: [2.3, 2.4, 2.5, 2.6, 2.7, jruby, head]
+        os: [ubuntu-latest]
+        include:
+          - ruby_version: head
+            rails_version: 0
+          - ruby_version: 2.7
+            rails_version: 6.0
+            env: RUBYOPT="--enable-frozen-string-literal --debug=frozen-string-literal"
+        exclude:
+          - ruby_version: 2.3
+            rails_version: 6.0
+          - ruby_version: 2.4
+            rails_version: 6.0
+          - ruby_version: 2.7
+            rails_version: 4.2
+          - ruby_version: head
+            rails_version: 4.2
+          - ruby_version: head
+            rails_version: 5.2
+          - ruby_version: head
+            rails_version: 6.0
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler: 1
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - name: Build with Rails ${{ matrix.rails_version }}
+      env:
+        RAILS_VERSION: ${{ matrix.rails_version }}
+      run: | 
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+
+  job_zeus:
+    name: Zeus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6 # Not needed with a .ruby-version file
+      - run: bundle install
+      - name: Install Zeus
+        run: |
+          yarn global add @zeus-ci/cli
+          echo "::add-path::$(yarn global bin)"
+      - name: Upload to Zeus
+        env:
+          ZEUS_API_TOKEN: ${{ secrets.ZEUS_API_TOKEN }}
+          ZEUS_HOOK_BASE: ${{ secrets.ZEUS_HOOK_BASE }}
+        run: |
+          zeus job update -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA
+          gem build sentry-raven.gemspec
+          zeus upload -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -t "application/tar+gem" ./*.gem
+          zeus job update --status=passed -b $GITHUB_RUN_ID -j $GITHUB_RUN_NUMBER -r $GITHUB_SHA

data/.gitignore

@@ -11,3 +11,5 @@ Gemfile.lock
 .ruby-gemset
 .idea
 *.rdb
+
+examples/**/node_modules

data/.rubocop.yml

@@ -13,33 +13,45 @@ Metrics/ClassLength:
 Metrics/AbcSize:
   Max: 40
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/CyclomaticComplexity:
   Max: 12
 
 Metrics/PerceivedComplexity:
   Max: 11
 
-Metrics/LineLength:
-  Max: 155
-
 Metrics/MethodLength:
   Max: 30
 
-Style/SignalException:
+Style/SymbolArray:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-Performance/Casecmp:
+Style/SignalException:
   Enabled: false
 
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/RescueStandardError:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
 
+Style/CommentedKeyword:
+  Enabled: false
+
 Style/RescueModifier:
   Enabled: false
 
@@ -52,10 +64,11 @@ Style/CaseEquality:
 Style/DoubleNegation:
   Enabled: false
 
-Style/FileName:
-  Exclude:
-    - 'lib/sentry-raven-without-integrations.rb'
-    - 'lib/sentry-raven.rb'
+Style/GuardClause:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
 
 Style/NumericLiterals:
   Exclude:
@@ -64,6 +77,9 @@ Style/NumericLiterals:
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/IfUnlessModifier:
+  Enabled: false
+
 Lint/RescueException:
   Exclude:
     - 'lib/raven/base.rb'
@@ -72,3 +88,22 @@ Lint/RescueException:
     - 'lib/raven/integrations/rack.rb'
     - 'lib/raven/integrations/sidekiq.rb'
     - 'spec/raven/event_spec.rb'
+
+Lint/SuppressedException:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 155
+
+Naming/FileName:
+  Exclude:
+    - 'lib/sentry-raven-without-integrations.rb'
+    - 'lib/sentry-raven.rb'
+    - 'lib/raven/integrations/rack-timeout.rb'
+
+Naming/MethodParameterName:
+  Enabled: false
+

data/.scripts/bump-version.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+file_names = ['lib/raven/version.rb']
+
+file_names.each do |file_name|
+  text = File.read(file_name)
+  new_contents = text.gsub(/\d.\d.\d/, ARGV[1])
+  File.open(file_name, "w") {|file| file.puts new_contents }
+end

data/Gemfile

@@ -2,37 +2,29 @@ source "https://rubygems.org/"
 
 gemspec
 
-if ENV["RAILS_VERSION"] && (ENV["RAILS_VERSION"].to_i == 4)
-  gem "rails", "< 5"
-  gem "rspec-rails", "> 3"
-elsif ENV["RAILS_VERSION"] && (ENV["RAILS_VERSION"].to_i == 0)
-  # no-op. No Rails.
-else
-  gem "rails", "< 6"
-  gem "rspec-rails", "> 3"
-end
+rails_version = ENV["RAILS_VERSION"].to_f
 
-if RUBY_VERSION < '2.0'
-  gem "mime-types", "< 3.0.0"
-  gem "nokogiri", "~> 1.6.8"
-  gem "rack", "~> 1.6.8"
-  gem "sidekiq", "< 3.2"
-  gem "rack-timeout", "0.3.0"
-else
-  gem "rack"
-  gem "sidekiq"
-  gem "rack-timeout"
+if rails_version != 0
+  gem "rails", "~> #{rails_version}"
+  gem "rspec-rails", "~> 4.0"
 end
+
+gem "sidekiq"
+
+gem "rack"
+gem "rack-timeout"
+
 gem "pry"
-gem "pry-coolline"
 gem "benchmark-ips"
-gem "benchmark-ipsa" if RUBY_VERSION > '2.0'
+gem "benchmark-ipsa"
 gem "ruby-prof", platform: :mri
 gem "rake", "> 12"
-gem "rubocop", "~> 0.41.1" # Last version that supported 1.9, upgrade to 0.50 after we drop 1.9
-gem "rspec", "> 3"
-gem "capybara" # rspec system tests
+gem "rubocop", "~> 0.81.0"
+gem "rspec", "~> 3.9.0"
+gem "capybara", "~> 3.15.0" # rspec system tests
 gem "puma" # rspec system tests
 
 gem "timecop"
-gem "test-unit", platform: :mri if RUBY_VERSION > '2.2'
+gem "test-unit"
+gem "simplecov"
+gem "codecov"

data/README.md

@@ -8,7 +8,8 @@
 # Raven-Ruby, the Ruby Client for Sentry
 
 [![Gem Version](https://img.shields.io/gem/v/sentry-raven.svg)](https://rubygems.org/gems/sentry-raven)
-[![Build Status](https://img.shields.io/travis/getsentry/raven-ruby/master.svg)](https://travis-ci.org/getsentry/raven-ruby)
+![Build Status](https://github.com/getsentry/raven-ruby/workflows/Test/badge.svg)
+[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/raven-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/raven-ruby/branch/master)
 [![Gem](https://img.shields.io/gem/dt/sentry-raven.svg)](https://rubygems.org/gems/sentry-raven/)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-raven&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-raven&package-manager=bundler&version-scheme=semver)
 
@@ -19,7 +20,7 @@ The official Ruby-language client and integration layer for the [Sentry](https:/
 
 ## Requirements
 
-We test on Ruby 2.3, 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny version. We also support JRuby 9.0. Our Rails integration works with Rails 4.2+ (including Rails 5).
+We test on Ruby 2.3, 2.4, 2.5, 2.6 and 2.7 at the latest patchlevel/teeny version. We also support JRuby 9.0. Our Rails integration works with Rails 4.2+, including Rails 5 and Rails 6.
 
 ## Getting Started
 

data/changelog.md

@@ -1,3 +1,15 @@
+# Changelog
+
+## Unreleased
+
+## 3.0.1
+
+* fix: Improve SanitizeData processor (#984)
+* fix: Masking cookies as key/pair instead of a single string (#983)
+* fix: Transports classes' requiring issue (#986)
+* fix: Frozen string issues (#977)
+* feat: Officially support Rails 6 (#982)
+
 3.0.0
 ----
 

data/lib/raven/backtrace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## Inspired by Rails' and Airbrake's backtrace parsers.
 
 module Raven
@@ -5,16 +7,16 @@ module Raven
   class Backtrace
     # Handles backtrace parsing line by line
     class Line
-      RB_EXTENSION = ".rb".freeze
+      RB_EXTENSION = ".rb"
       # regexp (optional leading X: on windows, or JRuby9000 class-prefix)
       RUBY_INPUT_FORMAT = /
         ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
         (\d+)
         (?: :in \s `([^']+)')?$
-      /x
+      /x.freeze
 
       # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
-      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/
+      JAVA_INPUT_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
 
       # The file portion of the line (such as app/models/user.rb)
       attr_reader :file
@@ -74,7 +76,7 @@ module Raven
 
       def self.in_app_pattern
         @in_app_pattern ||= begin
-          project_root = Raven.configuration.project_root && Raven.configuration.project_root.to_s
+          project_root = Raven.configuration.project_root&.to_s
           Regexp.new("^(#{project_root}/)?#{Raven.configuration.app_dirs_pattern || APP_DIRS_PATTERN}")
         end
       end
@@ -84,7 +86,7 @@ module Raven
       attr_writer :file, :number, :method, :module_name
     end
 
-    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test)/
+    APP_DIRS_PATTERN = /(bin|exe|app|config|lib|test)/.freeze
 
     # holder for an Array of Backtrace::Line instances
     attr_reader :lines

data/lib/raven/base.rb

@@ -85,12 +85,13 @@ module Raven
 
     def load_integration(integration)
       require "raven/integrations/#{integration}"
-    rescue Exception => error
-      logger.warn "Unable to load raven/integrations/#{integration}: #{error}"
+    rescue Exception => e
+      logger.warn "Unable to load raven/integrations/#{integration}: #{e}"
     end
 
     def safely_prepend(module_name, opts = {})
       return if opts[:to].nil? || opts[:from].nil?
+
       if opts[:to].respond_to?(:prepend, true)
         opts[:to].send(:prepend, opts[:from].const_get(module_name))
       else
@@ -101,6 +102,7 @@ module Raven
     def sys_command(command)
       result = `#{command} 2>&1` rescue nil
       return if result.nil? || result.empty? || ($CHILD_STATUS && $CHILD_STATUS.exitstatus != 0)
+
       result.strip
     end
   end

data/lib/raven/breadcrumbs.rb

@@ -64,7 +64,7 @@ module Raven
     end
 
     def empty?
-      !members.any?
+      members.none?
     end
 
     def to_hash

data/lib/raven/breadcrumbs/activesupport.rb

@@ -1,19 +1,19 @@
 module Raven
   module ActiveSupportBreadcrumbs
     class << self
-        def add(name, started, _finished, _unique_id, data)
-          Raven.breadcrumbs.record do |crumb|
-            crumb.data = data
-            crumb.category = name
-            crumb.timestamp = started.to_i
-          end
+      def add(name, started, _finished, _unique_id, data)
+        Raven.breadcrumbs.record do |crumb|
+          crumb.data = data
+          crumb.category = name
+          crumb.timestamp = started.to_i
         end
+      end
 
-        def inject
-          ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
-            add(name, started, finished, unique_id, data)
-          end
+      def inject
+        ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
+          add(name, started, finished, unique_id, data)
         end
+      end
     end
   end
 end

data/lib/raven/breadcrumbs/logger.rb

@@ -4,13 +4,13 @@ module Raven
   module BreadcrumbLogger
     LEVELS = {
       ::Logger::DEBUG => 'debug',
-      ::Logger::INFO  => 'info',
-      ::Logger::WARN  => 'warn',
+      ::Logger::INFO => 'info',
+      ::Logger::WARN => 'warn',
       ::Logger::ERROR => 'error',
       ::Logger::FATAL => 'fatal'
     }.freeze
 
-    EXC_FORMAT = /^([a-zA-Z0-9]+)\:\s(.*)$/
+    EXC_FORMAT = /^([a-zA-Z0-9]+)\:\s(.*)$/.freeze
 
     def self.parse_exception(message)
       lines = message.split(/\n\s*/)

data/lib/raven/cli.rb

@@ -29,8 +29,8 @@ module Raven
 
       begin
         1 / 0
-      rescue ZeroDivisionError => exception
-        evt = instance.capture_exception(exception)
+      rescue ZeroDivisionError => e
+        evt = instance.capture_exception(e)
       end
 
       if evt && !(evt.is_a? Thread)

data/lib/raven/client.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
+
 require 'base64'
 require 'json'
 require 'zlib'
 
+require "raven/transports"
+
 module Raven
   # Encodes events and sends them to the Sentry server.
   class Client
-    PROTOCOL_VERSION = '5'.freeze
-    USER_AGENT = "raven-ruby/#{Raven::VERSION}".freeze
-    CONTENT_TYPE = 'application/json'.freeze
+    PROTOCOL_VERSION = '5'
+    USER_AGENT = "raven-ruby/#{Raven::VERSION}"
+    CONTENT_TYPE = 'application/json'
 
     attr_accessor :configuration
 
@@ -120,7 +123,9 @@ module Raven
         configuration.logger.warn "Not sending event due to previous failure(s)."
       end
       configuration.logger.warn("Failed to submit event: #{get_log_message(event)}")
-      configuration.transport_failure_callback.call(event) if configuration.transport_failure_callback
+
+      # configuration.transport_failure_callback can be false & nil
+      configuration.transport_failure_callback.call(event) if configuration.transport_failure_callback # rubocop:disable Style/SafeNavigation
     end
   end
 

data/lib/raven/configuration.rb

@@ -236,6 +236,7 @@ module Raven
 
     def server=(value)
       return if value.nil?
+
       uri = URI.parse(value)
       uri_path = uri.path.split('/')
 
@@ -253,13 +254,14 @@ module Raven
 
       # For anyone who wants to read the base server string
       @server = "#{scheme}://#{host}"
-      @server << ":#{port}" unless port == { 'http' => 80, 'https' => 443 }[scheme]
-      @server << path
+      @server += ":#{port}" unless port == { 'http' => 80, 'https' => 443 }[scheme]
+      @server += path
     end
     alias dsn= server=
 
     def encoding=(encoding)
       raise(Error, 'Unsupported encoding') unless %w(gzip json).include? encoding
+
       @encoding = encoding
     end
 
@@ -267,6 +269,7 @@ module Raven
       unless value == false || value.respond_to?(:call)
         raise(ArgumentError, "async must be callable (or false to disable)")
       end
+
       @async = value
     end
 
@@ -274,6 +277,7 @@ module Raven
       unless value == false || value.respond_to?(:call)
         raise(ArgumentError, "transport_failure_callback must be callable (or false to disable)")
       end
+
       @transport_failure_callback = value
     end
 
@@ -281,6 +285,7 @@ module Raven
       unless value == false || value.respond_to?(:call)
         raise ArgumentError, "should_capture must be callable (or false to disable)"
       end
+
       @should_capture = value
     end
 
@@ -288,6 +293,7 @@ module Raven
       unless value == false || value.respond_to?(:call)
         raise ArgumentError, "before_send must be callable (or false to disable)"
       end
+
       @before_send = value
     end
 
@@ -351,8 +357,8 @@ module Raven
         detect_release_from_git ||
         detect_release_from_capistrano ||
         detect_release_from_heroku
-    rescue => ex
-      logger.error "Error detecting release: #{ex.message}"
+    rescue => e
+      logger.error "Error detecting release: #{e.message}"
     end
 
     def excluded_exception?(incoming_exception)
@@ -418,18 +424,21 @@ module Raven
 
     def capture_in_current_environment?
       return true unless environments.any? && !environments.include?(current_environment)
+
       @errors << "Not configured to send/capture in environment '#{current_environment}'"
       false
     end
 
     def capture_allowed_by_callback?(message_or_exc)
-      return true if !should_capture || message_or_exc.nil? || should_capture.call(*[message_or_exc])
+      return true if !should_capture || message_or_exc.nil? || should_capture.call(message_or_exc)
+
       @errors << "should_capture returned false"
       false
     end
 
     def valid?
       return true if %w(server host path public_key project_id).all? { |k| public_send(k) }
+
       if server
         %w(server host path public_key project_id).map do |key|
           @errors << "No #{key} specified" unless public_send(key)
@@ -442,6 +451,7 @@ module Raven
 
     def sample_allowed?
       return true if sample_rate == 1.0
+
       if Random::DEFAULT.rand >= sample_rate
         @errors << "Excluded by random sample"
         false

data/lib/raven/event.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'socket'
 require 'securerandom'
 
@@ -76,7 +77,7 @@ module Raven
     end
 
     def message
-      @interfaces[:logentry] && @interfaces[:logentry].unformatted_message
+      @interfaces[:logentry]&.unformatted_message
     end
 
     def message=(args)
@@ -96,12 +97,13 @@ module Raven
     end
 
     def level=(new_level) # needed to meet the Sentry spec
-      @level = new_level == "warn" || new_level == :warn ? :warning : new_level
+      @level = new_level.to_s == "warn" ? :warning : new_level
     end
 
     def interface(name, value = nil, &block)
       int = Interface.registered[name]
       raise(Error, "Unknown interface: #{name}") unless int
+
       @interfaces[int.sentry_alias] = int.new(value, &block) if value || block
       @interfaces[int.sentry_alias]
     end

data/lib/raven/instance.rb

@@ -51,6 +51,7 @@ module Raven
     # Tell the log that the client is good to go
     def report_status
       return if configuration.silence_ready
+
       if configuration.capture_allowed?
         logger.info "Raven #{VERSION} ready to catch errors"
       else
@@ -111,15 +112,15 @@ module Raven
       message_or_exc = obj.is_a?(String) ? "message" : "exception"
       options[:configuration] = configuration
       options[:context] = context
-      if (evt = Event.send("from_" + message_or_exc, obj, options))
+      if evt = Event.send("from_" + message_or_exc, obj, options)
         yield evt if block_given?
         if configuration.async?
           begin
             # We have to convert to a JSON-like hash, because background job
             # processors (esp ActiveJob) may not like weird types in the event hash
             configuration.async.call(evt.to_json_compatible)
-          rescue => ex
-            logger.error("async event sending failed: #{ex.message}")
+          rescue => e
+            logger.error("async event sending failed: #{e.message}")
             send_event(evt, make_hint(obj))
           end
         else

data/lib/raven/integrations/delayed_job.rb

@@ -8,19 +8,18 @@ module Delayed
           begin
             # Forward the call to the next callback in the callback chain
             block.call(job, *args)
-
-          rescue Exception => exception
+          rescue Exception => e
             # Log error to Sentry
             extra = {
               :delayed_job => {
-                :id          => job.id.to_s,
-                :priority    => job.priority,
-                :attempts    => job.attempts,
-                :run_at      => job.run_at,
-                :locked_at   => job.locked_at,
-                :locked_by   => job.locked_by,
-                :queue       => job.queue,
-                :created_at  => job.created_at
+                :id => job.id.to_s,
+                :priority => job.priority,
+                :attempts => job.attempts,
+                :run_at => job.run_at,
+                :locked_at => job.locked_at,
+                :locked_by => job.locked_by,
+                :queue => job.queue,
+                :created_at => job.created_at
               }
             }
             # last_error can be nil
@@ -32,16 +31,16 @@ module Delayed
             if job.respond_to?('payload_object') && job.payload_object.respond_to?('job_data')
               extra[:active_job] = job.payload_object.job_data
             end
-            ::Raven.capture_exception(exception,
-                                      :logger  => 'delayed_job',
-                                      :tags    => {
+            ::Raven.capture_exception(e,
+                                      :logger => 'delayed_job',
+                                      :tags => {
                                         :delayed_job_queue => job.queue,
                                         :delayed_job_id => job.id.to_s
                                       },
                                       :extra => extra)
 
             # Make sure we propagate the failure!
-            raise exception
+            raise e
           ensure
             ::Raven::Context.clear!
             ::Raven::BreadcrumbBuffer.clear!

data/lib/raven/integrations/rack-timeout.rb

@@ -14,6 +14,5 @@ module RackTimeoutExtensions
   end
 end
 
-# Include is private in Ruby 1.9
-Rack::Timeout::Error.__send__(:include, RackTimeoutExtensions)
-Rack::Timeout::RequestTimeoutException.__send__(:include, RackTimeoutExtensions)
+Rack::Timeout::Error.include(RackTimeoutExtensions)
+Rack::Timeout::RequestTimeoutException.include(RackTimeoutExtensions)

data/lib/raven/integrations/rack.rb

@@ -92,8 +92,8 @@ module Raven
         request.body.rewind
         data
       end
-    rescue IOError => ex
-      ex.message
+    rescue IOError => e
+      e.message
     end
 
     def format_headers_for_sentry(env_hash)
@@ -112,6 +112,7 @@ module Raven
           next if key == 'HTTP_COOKIE' # Cookies don't go here, they go somewhere else
 
           next unless key.start_with?('HTTP_') || %w(CONTENT_TYPE CONTENT_LENGTH).include?(key)
+
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever
           key = key.sub(/^HTTP_/, "")
           key = key.split('_').map(&:capitalize).join('-')

data/lib/raven/integrations/rails.rb

@@ -5,6 +5,7 @@ module Raven
     require 'raven/integrations/rails/overrides/streaming_reporter'
     require 'raven/integrations/rails/controller_methods'
     require 'raven/integrations/rails/controller_transaction'
+    require 'raven/integrations/rack'
 
     initializer "raven.use_rack_middleware" do |app|
       app.config.middleware.insert 0, Raven::Rack

data/lib/raven/integrations/rails/active_job.rb

@@ -20,10 +20,11 @@ module Raven
 
       def capture_and_reraise_with_sentry(job, block)
         block.call
-      rescue Exception => exception # rubocop:disable Lint/RescueException
-        return if rescue_with_handler(exception)
-        Raven.capture_exception(exception, :extra => raven_context(job))
-        raise exception
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        return if rescue_with_handler(e)
+
+        Raven.capture_exception(e, :extra => raven_context(job))
+        raise e
       ensure
         Context.clear!
         BreadcrumbBuffer.clear!

data/lib/raven/integrations/rails/overrides/debug_exceptions_catcher.rb

@@ -6,7 +6,7 @@ module Raven
           begin
             env = env_or_request.respond_to?(:env) ? env_or_request.env : env_or_request
             Raven::Rack.capture_exception(exception, env)
-          rescue # rubocop:disable Lint/HandleExceptions
+          rescue
           end
           super
         end
@@ -21,7 +21,7 @@ module Raven
           begin
             env = env_or_request.respond_to?(:env) ? env_or_request.env : env_or_request
             Raven::Rack.capture_exception(exception, env)
-          rescue # rubocop:disable Lint/HandleExceptions
+          rescue
           end
           render_exception_without_raven(env_or_request, exception)
         end

data/lib/raven/interface.rb

@@ -1,9 +1,9 @@
 module Raven
   class Interface
     def initialize(attributes = nil)
-      attributes.each do |attr, value|
+      attributes&.each do |attr, value|
         public_send "#{attr}=", value
-      end if attributes
+      end
 
       yield self if block_given?
     end

data/lib/raven/interfaces/stack_trace.rb

@@ -58,7 +58,7 @@ module Raven
       end
 
       def project_root
-        @project_root ||= Raven.configuration.project_root && Raven.configuration.project_root.to_s
+        @project_root ||= Raven.configuration.project_root&.to_s
       end
 
       def longest_load_path

data/lib/raven/linecache.rb

@@ -10,6 +10,7 @@ module Raven
     # line should be the line requested by lineno. See specs for more information.
     def get_file_context(filename, lineno, context)
       return nil, nil, nil unless valid_path?(filename)
+
       lines = Array.new(2 * context + 1) do |i|
         getline(filename, lineno - context + i)
       end
@@ -26,15 +27,17 @@ module Raven
     def getlines(path)
       @cache[path] ||= begin
         IO.readlines(path)
-      rescue
-        nil
+                       rescue
+                         nil
       end
     end
 
     def getline(path, n)
       return nil if n < 1
+
       lines = getlines(path)
       return nil if lines.nil?
+
       lines[n - 1]
     end
   end

data/lib/raven/logger.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'logger'
 
 module Raven
   class Logger < ::Logger
-    LOG_PREFIX = "** [Raven] ".freeze
-    PROGNAME   = "sentry".freeze
+    LOG_PREFIX = "** [Raven] "
+    PROGNAME   = "sentry"
 
     def initialize(*)
       super

data/lib/raven/processor/cookies.rb

@@ -10,17 +10,27 @@ module Raven
     private
 
     def process_if_symbol_keys(data)
-      data[:request][:cookies] = STRING_MASK if data[:request][:cookies]
+      if cookies = data.dig(:request, :cookies)
+        data[:request][:cookies] = generate_masked_cookies(cookies)
+      end
 
-      return unless data[:request][:headers] && data[:request][:headers]["Cookie"]
-      data[:request][:headers]["Cookie"] = STRING_MASK
+      if cookies_header = data[:request][:headers]["Cookie"]
+        data[:request][:headers]["Cookie"] = generate_masked_cookies(cookies_header)
+      end
     end
 
     def process_if_string_keys(data)
-      data["request"]["cookies"] = STRING_MASK if data["request"]["cookies"]
+      if cookies = data.dig("request", "cookies")
+        data["request"]["cookies"] = generate_masked_cookies(cookies)
+      end
 
-      return unless data["request"]["headers"] && data["request"]["headers"]["Cookie"]
-      data["request"]["headers"]["Cookie"] = STRING_MASK
+      if cookies_header = data.dig("request", "headers", "Cookie")
+        data["request"]["headers"]["Cookie"] = generate_masked_cookies(cookies_header)
+      end
+    end
+
+    def generate_masked_cookies(cookies)
+      cookies.merge(cookies) { STRING_MASK }
     end
   end
 end

data/lib/raven/processor/post_data.rb

@@ -11,11 +11,13 @@ module Raven
 
     def process_if_symbol_keys(data)
       return unless data[:request][:method] == "POST"
+
       data[:request][:data] = STRING_MASK
     end
 
     def process_if_string_keys(data)
       return unless data["request"]["method"] == "POST"
+
       data["request"]["data"] = STRING_MASK
     end
   end

data/lib/raven/processor/removecircularreferences.rb

@@ -2,6 +2,7 @@ module Raven
   class Processor::RemoveCircularReferences < Processor
     def process(value, visited = [])
       return "(...)" if visited.include?(value.__id__)
+
       visited << value.__id__ if value.is_a?(Array) || value.is_a?(Hash)
 
       case value

data/lib/raven/processor/sanitizedata.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'json'
 
 module Raven
   class Processor::SanitizeData < Processor
     DEFAULT_FIELDS = %w(authorization password passwd secret ssn social(.*)?sec).freeze
-    CREDIT_CARD_RE = /\b(?:3[47]\d|(?:4\d|5[1-5]|65)\d{2}|6011)\d{12}\b/
+    CREDIT_CARD_RE = /\b(?:3[47]\d|(?:4\d|5[1-5]|65)\d{2}|6011)\d{12}\b/.freeze
     QUERY_STRING = ['query_string', :query_string].freeze
     JSON_STARTS_WITH = ["[", "{"].freeze
 
@@ -20,22 +21,13 @@ module Raven
     def process(value, key = nil)
       case value
       when Hash
-        !value.frozen? ? value.merge!(value) { |k, v| process v, k } : value.merge(value) { |k, v| process v, k }
+        sanitize_hash_value(key, value)
       when Array
-        !value.frozen? ? value.map! { |v| process v, key } : value.map { |v| process v, key }
+        sanitize_array_value(key, value)
       when Integer
         matches_regexes?(key, value.to_s) ? INT_MASK : value
       when String
-        if value =~ fields_re && (json = parse_json_or_nil(value))
-          # if this string is actually a json obj, convert and sanitize
-          process(json).to_json
-        elsif matches_regexes?(key, value)
-          STRING_MASK
-        elsif QUERY_STRING.include?(key)
-          sanitize_query_string(value)
-        else
-          value
-        end
+        sanitize_string_value(key, value)
       else
         value
       end
@@ -49,6 +41,39 @@ module Raven
       @utf8_processor ||= Processor::UTF8Conversion.new
     end
 
+    def sanitize_hash_value(key, value)
+      if key =~ sensitive_fields
+        STRING_MASK
+      elsif value.frozen?
+        value.merge(value) { |k, v| process v, k }
+      else
+        value.merge!(value) { |k, v| process v, k }
+      end
+    end
+
+    def sanitize_array_value(key, value)
+      if value.frozen?
+        value.map { |v| process v, key }
+      else
+        value.map! { |v| process v, key }
+      end
+    end
+
+    def sanitize_string_value(key, value)
+      if value =~ sensitive_fields && (json = parse_json_or_nil(value))
+        # if this string is actually a json obj, convert and sanitize
+        process(json).to_json
+      elsif matches_regexes?(key, value)
+        STRING_MASK
+      elsif QUERY_STRING.include?(key)
+        sanitize_query_string(value)
+      elsif value =~ sensitive_fields
+        sanitize_sensitive_string_content(value)
+      else
+        value
+      end
+    end
+
     def sanitize_query_string(query_string)
       query_hash = CGI.parse(query_string)
       sanitized = utf8_processor.process(query_hash)
@@ -56,16 +81,38 @@ module Raven
       URI.encode_www_form(processed_query_hash)
     end
 
+    # this scrubs some sensitive info from the string content. for example:
+    #
+    # ```
+    # unexpected token at '{
+    # "role": "admin","password": "Abc@123","foo": "bar"
+    # }'
+    # ```
+    #
+    # will become
+    #
+    # ```
+    # unexpected token at '{
+    # "role": "admin","password": *******,"foo": "bar"
+    # }'
+    # ```
+    #
+    # it's particularly useful in hash or param-parsing related errors
+    def sanitize_sensitive_string_content(value)
+      value.gsub(/(#{sensitive_fields}['":]\s?(:|=>)?\s?)(".*?"|'.*?')/, '\1' + STRING_MASK)
+    end
+
     def matches_regexes?(k, v)
       (sanitize_credit_cards && v =~ CREDIT_CARD_RE) ||
-        k =~ fields_re
+        k =~ sensitive_fields
     end
 
-    def fields_re
-      return @fields_re if instance_variable_defined?(:@fields_re)
+    def sensitive_fields
+      return @sensitive_fields if instance_variable_defined?(:@sensitive_fields)
+
       fields = DEFAULT_FIELDS | sanitize_fields
       fields -= sanitize_fields_excluded
-      @fields_re = /#{fields.map do |f|
+      @sensitive_fields = /#{fields.map do |f|
         use_boundary?(f) ? "\\b#{f}\\b" : f
       end.join("|")}/i
     end
@@ -80,6 +127,7 @@ module Raven
 
     def parse_json_or_nil(string)
       return unless string.start_with?(*JSON_STARTS_WITH)
+
       JSON.parse(string)
     rescue JSON::ParserError, NoMethodError
       nil

data/lib/raven/processor/utf8conversion.rb

@@ -14,6 +14,7 @@ module Raven
         !value.frozen? ? value.map! { |v| process v } : value.map { |v| process v }
       when Exception
         return value if value.message.valid_encoding?
+
         clean_exc = value.class.new(remove_invalid_bytes(value.message))
         clean_exc.set_backtrace(value.backtrace)
         clean_exc
@@ -27,6 +28,7 @@ module Raven
           value.force_encoding(Encoding::UTF_8)
         end
         return value if value.valid_encoding?
+
         remove_invalid_bytes(value)
       else
         value

data/lib/raven/transports.rb

@@ -13,3 +13,7 @@ module Raven
     end
   end
 end
+
+require "raven/transports/dummy"
+require "raven/transports/http"
+require "raven/transports/stdout"

data/lib/raven/transports/http.rb

@@ -26,10 +26,10 @@ module Raven
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data
         end
-      rescue Faraday::Error => ex
-        error_info = ex.message
-        if ex.response && ex.response[:headers]['x-sentry-error']
-          error_info += " Error in headers is: #{ex.response[:headers]['x-sentry-error']}"
+      rescue Faraday::Error => e
+        error_info = e.message
+        if e.response && e.response[:headers]['x-sentry-error']
+          error_info += " Error in headers is: #{e.response[:headers]['x-sentry-error']}"
         end
         raise Raven::Error, error_info
       end
@@ -42,7 +42,7 @@ module Raven
         proxy = configuration.public_send(:proxy)
 
         Faraday.new(configuration.server, :ssl => ssl_configuration, :proxy => proxy) do |builder|
-          configuration.faraday_builder.call(builder) if configuration.faraday_builder
+          configuration.faraday_builder&.call(builder)
           builder.response :raise_error
           builder.options.merge! faraday_opts
           builder.headers[:user_agent] = "sentry-ruby/#{Raven::VERSION}"

data/lib/raven/utils/exception_cause_chain.rb

@@ -7,6 +7,7 @@ module Raven
           while exception.cause
             exception = exception.cause
             break if exceptions.any? { |e| e.object_id == exception.object_id }
+
             exceptions << exception
           end
           exceptions

data/lib/raven/utils/real_ip.rb

@@ -13,7 +13,7 @@ module Raven
         "fc00::/7",       # private IPv6 range fc00::/7
         "10.0.0.0/8",     # private IPv4 range 10.x.x.x
         "172.16.0.0/12",  # private IPv4 range 172.16.0.0 .. 172.31.255.255
-        "192.168.0.0/16", # private IPv4 range 192.168.x.x
+        "192.168.0.0/16" # private IPv4 range 192.168.x.x
       ].map { |proxy| IPAddr.new(proxy) }
 
       attr_accessor :ip, :ip_addresses

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
+
 module Raven
-  # Freezing this constant breaks in 1.9.x
-  VERSION = "3.0.0" # rubocop:disable Style/MutableConstant
+  VERSION = "3.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -33,11 +33,13 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- ".craft.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".scripts/bump-version.sh"
 - Gemfile
 - LICENSE
 - README.md

data/.travis.yml

@@ -1,43 +0,0 @@
-language: ruby
-dist: trusty
-group: beta
-cache: bundler
-
-services:
-  - redis-server
-
-branches:
-  only: [master]
-
-rvm:
-  - 2.3.8
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-
-env:
-  - RAILS_VERSION=4
-  - RAILS_VERSION=5
-  - RAILS_VERSION=0
-
-addons:
-  apt:
-    packages:
-      - haveged
-
-before_install:
-  - service haveged start
-  # Pin bundler version due to https://github.com/rubygems/rubygems/issues/2055
-  - gem install bundler -v 1.16.0
-
-matrix:
-  include:
-    - rvm: jruby-9.2.9.0
-      env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=4
-    - rvm: jruby-9.2.9.0
-      env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=5
-    - rvm: ruby-head
-      env: RAILS_VERSION=0
-  allow_failures:
-    - rvm: ruby-head