sentry-raven 0.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5fbeb1ae8141697af3bf06f4c2167f97af8a7e58
-  data.tar.gz: 3431f08512c915bce224d07fb8ad77d5f04fe62a
+SHA256:
+  metadata.gz: 478a0cd677f1508fc2153381addf6956e189c5f9491ede8f79b6097977dd59b9
+  data.tar.gz: d87fe2f303acf7e1d8b658950a1e591800eaf8a0f8bbdd35637355ac6856f571
 SHA512:
-  metadata.gz: 869b6bb29a4a351c8694de220ea6513bafea70554488fd1086b3fcced14510cae903621e37c9f86dedab1e12d40da51fb73c138a12a9b460afddba1485f7fd71
-  data.tar.gz: ef80ba9d906d81621e4add41b76368ee2549c7bbef3053bf9c280f10b8c3808a1cff39019bc20b01d70201f37bdf28585f65f977dcd76d1f9fc0863d005d26cb
+  metadata.gz: c83298b6f11a500e50f4e530de5421f32d15f7ea72d3a6aea18cd4330f832073a2000a68228b0237313e709b3e4adba570b140837256798ff3987b9eb0bb0fc9
+  data.tar.gz: 80405a6c1d1f99a7b65ed9491bd17c0d4143a5d5f212c6408988c9de329bc2bee2f2c6c1421d6134cc7f3d4c23ed2da06d0ba76509f6ae191f0236e83c53bdf8

data/.gitignore

@@ -0,0 +1,13 @@
+coverage
+pkg
+ruby/
+log/
+.bundle
+*.gem
+gemfiles/*.lock
+Gemfile.lock
+.coveralls.yml
+.ruby-version
+.ruby-gemset
+.idea
+*.rdb

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rubocop.yml

@@ -0,0 +1,74 @@
+AllCops:
+   Include:
+     - 'lib/**/*.rb'
+     - 'spec/**/*.rb'
+   Exclude:
+     - 'examples/**/*'
+     - 'vendor/**/*'
+
+Metrics/ClassLength:
+  Max: 300
+  CountComments: false
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/PerceivedComplexity:
+  Max: 11
+
+Metrics/LineLength:
+  Max: 155
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/SignalException:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/sentry-raven-without-integrations.rb'
+    - 'lib/sentry-raven.rb'
+
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/raven/processors/sanitizedata_processor_spec.rb'
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Lint/RescueException:
+  Exclude:
+    - 'lib/raven/base.rb'
+    - 'lib/raven/instance.rb'
+    - 'lib/raven/integrations/delayed_job.rb'
+    - 'lib/raven/integrations/rack.rb'
+    - 'lib/raven/integrations/sidekiq.rb'
+    - 'spec/raven/event_spec.rb'

data/.travis.yml

@@ -0,0 +1,47 @@
+language: ruby
+dist: trusty
+group: beta
+cache: bundler
+
+services:
+  - redis-server
+
+branches:
+  only: [master]
+
+rvm:
+  - 2.2.10
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+
+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: 1.9
+      env: RAILS_VERSION=4
+    - rvm: jruby-1.7.27
+      env: JRUBY_OPTS="--dev" RAILS_VERSION=4
+    - 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

data/Gemfile

@@ -0,0 +1,38 @@
+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
+
+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"
+end
+gem "pry"
+gem "pry-coolline"
+gem "benchmark-ips"
+gem "benchmark-ipsa" if RUBY_VERSION > '2.0'
+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 "puma" # rspec system tests
+
+gem "timecop"
+gem "test-unit", platform: :mri if RUBY_VERSION > '2.2'

data/LICENSE

@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
    same "printed page" as the copyright notice for easier
    identification within third-party archives.
 
-Copyright [yyyy] [name of copyright owner]
+Copyright 2015 Functional Software, Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,35 +1,61 @@
-# Raven-Ruby
+<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>
+
+# 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)
-[![Coverage Status](https://img.shields.io/coveralls/getsentry/raven-ruby/master.svg)](https://coveralls.io/r/getsentry/raven-ruby)
+[![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)
+
+
+[Documentation](https://docs.sentry.io/clients/ruby/) | [Bug Tracker](https://github.com/getsentry/raven-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
 
-A client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
+The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
 ## Requirements
 
-We test on Ruby MRI 1.8.7/REE, 1.9.3, 2.0 and 2.1. JRuby support is experimental - check TravisCI to see if the build is passing or failing.
+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).
 
 ## Getting Started
+
 ### Install
+
 ```ruby
-gem "sentry-raven", :require => 'raven' #, :github => "getsentry/raven-ruby"
+gem "sentry-raven"
 ```
-### Set SENTRY_DSN
+
+### 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!
+
 ```bash
 # Set your SENTRY_DSN environment variable.
-export SENTRY_DSN=http://public:secret@example.com/project-id
+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!)
 Raven.configure do |config|
-  config.dsn = 'http://public:secret@example.com/project-id'
+  config.dsn = 'http://public@example.com/project-id'
 end
 ```
-### Call
-If you use Rails, you're already done - no more configuration required! Check [Integrations](https://github.com/getsentry/raven-ruby/wiki/Integrations) for more details on other gems Sentry integrates with automatically.
+
+### Raven doesn't report some kinds of data by default
+
+**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/)
+
+### 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.
 
 Otherwise, Raven supports two methods of capturing exceptions:
+
 ```ruby
 Raven.capture do
   # capture any exceptions which happen during execution of this block
@@ -43,12 +69,68 @@ rescue ZeroDivisionError => exception
 end
 ```
 
-## More Information
+### More configuration
+
+You're all set - but there's a few more settings you may want to know about too!
+
+#### async
+
+When an error or message occurs, the notification is immediately sent to Sentry. Raven can be configured to send asynchronously:
+
+```ruby
+config.async = lambda { |event|
+  Thread.new { Raven.send_event(event) }
+}
+```
+
+Using a thread to send events will be adequate for truly parallel Ruby platforms such as JRuby, though the benefit on MRI/CRuby will be limited. If the async callback raises an exception, Raven will attempt to send synchronously.
 
-Full documentation and more information on advanced configuration, sending more information, scrubbing sensitive data, and more can be found on [the wiki](https://github.com/getsentry/raven-ruby/wiki). 
+Note that the naive example implementation has a major drawback - it can create an infinite number of threads. We recommend creating a background job, using your background job processor, that will send Sentry notifications in the background.
+
+```ruby
+config.async = lambda { |event| SentryJob.perform_later(event) }
+
+class SentryJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(event)
+    Raven.send_event(event)
+  end
+end
+```
+
+#### transport_failure_callback
+
+If Raven fails to send an event to Sentry for any reason (either the Sentry server has returned a 4XX or 5XX response), this Proc or lambda will be called.
+
+```ruby
+config.transport_failure_callback = lambda { |event|
+  AdminMailer.email_admins("Oh god, it's on fire!", event).deliver_later
+}
+```
+
+#### 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:
+
+```ruby
+# bind the logged in user
+Raven.user_context email: 'foo@example.com'
+
+# tag the request with something interesting
+Raven.tags_context interesting: 'yes'
+
+# provide a bit of additional context
+Raven.extra_context happiness: 'very'
+```
+
+For more information, see [Context](https://docs.sentry.io/clients/ruby/context/).
+
+## More Information
 
-* [Documentation](https://github.com/getsentry/raven-ruby/wiki)
-* [Bug Tracker](http://github.com/getsentry/raven-ruby/issues>)
-* [Code](http://github.com/getsentry/raven-ruby>)
-* [Mailing List](https://groups.google.com/group/getsentry>)
-* [IRC](irc://irc.freenode.net/sentry>)  (irc.freenode.net, #sentry)
+* [Documentation](https://docs.sentry.io/clients/ruby/)
+* [Bug Tracker](https://github.com/getsentry/raven-ruby/issues)
+* [Forum](https://forum.sentry.io/)
+- [Discord](https://discord.gg/ez5KZN7)

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'raven'
+require 'rubygems/package_task'
+require 'bundler/gem_tasks'
+
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
+
+Gem::PackageTask.new(gemspec).define
+
+begin
+  require 'rubygems'
+  require 'rspec/core/rake_task'
+
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb','spec/**/*.rb',]
+    task.options << '--display-cop-names'
+  end
+
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+  end
+
+rescue LoadError
+  task :spec do
+    abort "Rspec is not available. bundle install to run unit tests"
+  end
+end
+
+task :default => [:rubocop, :spec]