sentry-raven 2.13.0 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 478a0cd677f1508fc2153381addf6956e189c5f9491ede8f79b6097977dd59b9
-  data.tar.gz: d87fe2f303acf7e1d8b658950a1e591800eaf8a0f8bbdd35637355ac6856f571
+  metadata.gz: e0e19bd3b705bd0a2c680d367ea7420941d5df1c5b245317170b9c31fd177006
+  data.tar.gz: f826cbfb501dfd844ff1096b8561ffc8a2e4f589d51d186ce063e4cfcabc65aa
 SHA512:
-  metadata.gz: c83298b6f11a500e50f4e530de5421f32d15f7ea72d3a6aea18cd4330f832073a2000a68228b0237313e709b3e4adba570b140837256798ff3987b9eb0bb0fc9
-  data.tar.gz: 80405a6c1d1f99a7b65ed9491bd17c0d4143a5d5f212c6408988c9de329bc2bee2f2c6c1421d6134cc7f3d4c23ed2da06d0ba76509f6ae191f0236e83c53bdf8
+  metadata.gz: 8f47ca78fad6ebc47e9a76efd32e8009e6b8196256b06edef38dc1081a4eafb57f0f880e69d3e423ef5dffe6f66f2651c6c1fa2ca4002ad1c5be352b541bdfb3
+  data.tar.gz: f6e95e7a313ece5ebfb1af584d2cd11648575a6121a0ff0b807180e396bfb8102b1bc0cc1914d96e26058273193dbf6014c0acd6ded8dbef284cac6d0279ab79

data/.craft.yml

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

data/.github/workflows/test.yml

@@ -0,0 +1,87 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+  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
+
+  compare_allocation:
+    name: Compare memory allocation with ${{ matrix.ruby_version }} and rails ${{ matrix.rails_version }}
+    runs-on: ${{ matrix.os }}
+    needs: test
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    strategy:
+      matrix:
+        rails_version: [5.2, 6.0]
+        ruby_version: [2.6, 2.7]
+        os: [ubuntu-latest]
+    steps:
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler: 1
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - uses: actions/checkout@v2
+      with:
+        ref: master
+
+    - name: Build and run allocation report on master
+      run: |
+        bundle install --jobs 4 --retry 3
+        bundle exec ruby benchmarks/allocation_comparison.rb
+
+    - uses: actions/checkout@v1
+
+    - name: Rebuild on the branch
+      run: |
+        bundle install --jobs 4 --retry 3
+    - name: Run allocation report on the branch
+      run: |
+        bundle exec ruby benchmarks/allocation_comparison.rb

data/.github/workflows/zeus_upload.yml

@@ -0,0 +1,32 @@
+name: Zeus Upload
+
+on:
+  push:
+    branches:
+      - release/**
+
+jobs:
+  zeus_upload:
+    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/{changelog.md → CHANGELOG.md}

@@ -1,3 +1,40 @@
+# Changelog
+
+## Unreleased
+
+## 3.0.4
+
+- fix: Don't log warning messages when it doesn't need to (#1000)
+- fix: Revert "Refactor Raven::Client class" (#1002)
+
+## 3.0.3
+
+- fix: Ensure Processor::Cookie can run after Processor::RemoveCircularReferences (#996)
+- fix: Avoid mutating user passed in options (#994)
+- fix: Fix/Refactor Raven::Cli (#989)
+- ref: Refactor Raven::Client class (#995)
+  - It adds `Event#message_from_exception` and `Event#log_message` interfaces
+
+## 3.0.2
+
+- fix: Add gem target for craft
+
+## 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
+----
+
+* SDK now requires Ruby >= 2.3
+* REF: Retain any literal "HTTP-" in header names [@elliterate, #950]
+* REF: Delete JSON spec for recursive hashes [@ksylvest, #952]
+* FEAT: Bump faraday version to latest [@ksylvest, #946] 
+
 2.13.0
 ----
 
@@ -475,7 +512,7 @@ OTHER CHANGES:
 0.12.0
 ------
 
-- You can now give additional fields to the SanitizeData processor. Values matched are replaced by the string mask (*********). Full documentation (and how to use with Rails config.filter_parameters) [here](https://docs.getsentry.com/hosted/clients/ruby/config/). [jamescway, #232]
+- You can now give additional fields to the SanitizeData processor. Values matched are replaced by the string mask (*********). Full documentation (and how to use with Rails config.filter_parameters) [here](https://docs.sentry.io/platforms/ruby/config/). [jamescway, #232]
 - An additional processor has been added, though it isn't turned on by default: RemoveStacktrace. Use it to remove stacktraces from exception reports. [nateberkopec, #233]
 - Dependency on `uuidtools` has been removed. [nateberkopec, #231]
 

data/CONTRIUTING.md

@@ -0,0 +1,26 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+# Contributing
+
+We welcome suggested improvements and bug fixes in the form of pull requests. The guide below will help you get started, but if you have further questions, please feel free to reach out on [Discord](https://discord.gg/Ww9hbqr).
+
+
+## Making a release
+
+Install and use `craft`: https://github.com/getsentry/craft
+
+Make sure the `CHANGELOG.md` is update and latest `master` contains all changes.
+
+Run:
+
+```bash
+craft prepare x.x.x
+```
+
+Where `x.x.x` stands for the version you want to release.
+Afterwards reach out to an employee of Sentry, they will cut a release by running the `publish` process of `craft`.

data/Gemfile

@@ -2,37 +2,32 @@ 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"]
+rails_version = "5.2" if rails_version.nil?
 
-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.to_f != 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_driver"
+gem "benchmark-ipsa"
+gem "benchmark-memory"
 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 1.9, 2.2, 2.3, and 2.4 at the latest patchlevel/teeny version. We also support JRuby 1.7 and 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
 
@@ -29,7 +30,7 @@ We test on Ruby 1.9, 2.2, 2.3, and 2.4 at the latest patchlevel/teeny version. W
 gem "sentry-raven"
 ```
 
-### Raven only runs when SENTRY_DSN is set
+### Raven only runs when Sentry DSN is set
 
 Raven will capture and send exceptions to the Sentry server whenever its DSN is set. This makes environment-based configuration easy - if you don't want to send errors in a certain environment, just don't set the DSN in that environment!
 
@@ -38,7 +39,7 @@ Raven will capture and send exceptions to the Sentry server whenever its DSN is
 export SENTRY_DSN=http://public@example.com/project-id
 ```
 ```ruby
-# Or you can configure the client in the code (not recommended - keep your DSN secret!)
+# Or you can configure the client in the code.
 Raven.configure do |config|
   config.dsn = 'http://public@example.com/project-id'
 end
@@ -48,11 +49,11 @@ end
 
 **Raven ignores some exceptions by default** - most of these are related to 404s or controller actions not being found. [For a complete list, see the `IGNORE_DEFAULT` constant](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb).
 
-Raven doesn't report POST data or cookies by default. In addition, it will attempt to remove any obviously sensitive data, such as credit card or Social Security numbers. For more information about how Sentry processes your data, [check out the documentation on the `processors` config setting.](https://docs.getsentry.com/hosted/clients/ruby/config/)
+Raven doesn't report POST data or cookies by default. In addition, it will attempt to remove any obviously sensitive data, such as credit card or Social Security numbers. For more information about how Sentry processes your data, [check out the documentation on the `processors` config setting.](https://docs.sentry.io/platforms/ruby/config/)
 
 ### Usage
 
-**If you use Rails, you're already done - no more configuration required!** Check [Integrations](https://docs.getsentry.com/hosted/clients/ruby/integrations/) for more details on other gems Sentry integrates with automatically.
+**If you use Rails, you're already done - no more configuration required!** Check [Integrations](https://docs.sentry.io/platforms/ruby/integrations/) for more details on other gems Sentry integrates with automatically.
 
 Otherwise, Raven supports two methods of capturing exceptions:
 
@@ -111,19 +112,28 @@ config.transport_failure_callback = lambda { |event|
 
 #### Context
 
-Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events.
-
-There are three primary methods for providing request context:
+Much of the usefulness of Sentry comes from additional context data with the events. Raven makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events:
 
 ```ruby
-# bind the logged in user
 Raven.user_context email: 'foo@example.com'
 
-# tag the request with something interesting
-Raven.tags_context interesting: 'yes'
+Raven.tags.merge!(interesting: 'yes')
+
+Raven.extra.merge!(additional_info: 'foo')
+```
+
+You can also use `tags_context` and `extra_context` to provide scoped information:
+
+```ruby
+Raven.tags_context(interesting: 'yes') do
+  # the `interesting: 'yes'` tag will only present in the requests sent inside the block
+  Raven.capture_exception(exception)
+end
 
-# provide a bit of additional context
-Raven.extra_context happiness: 'very'
+Raven.extra_context(additional_info: 'foo') do
+  # same as above, the `additional_info` will only present in this request
+  Raven.capture_exception(exception)
+end
 ```
 
 For more information, see [Context](https://docs.sentry.io/clients/ruby/context/).