sentry-raven 0.10.1 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 057d8d70d5fbf847fa8c41a33a8dabc5f4bf1f4d
-  data.tar.gz: 2042e4bbae25824369c260746f21c31b64d3c4f4
+  metadata.gz: 6edaa8907b593e814f5fac83ed1fcedd5f48138d
+  data.tar.gz: a5ba9906fdee7ae55db2245962b605d194c8bc78
 SHA512:
-  metadata.gz: a74a58c59287a2d4fde07886f26d9634e08f1b3b5bcf9c5c793facaec632094a83e047f426953a88b193911b71e4364fa541a0276b851f2dc86c1ea1a1aa7913
-  data.tar.gz: de5656fd29ce7aff1ad06c919179363f3330ff05cd4a7ab0ad17a733fb300d4468c2e3b487b4c9480abf9841d8ed28a928336d31d8df0d7d9a979c1f0cf9938b
+  metadata.gz: a8755f16a1d1ee91c7195d9cca81fc4257acf6f9913e4d0452772d282efaece4448cb7ea701175f0768102fae2e09454325cdb238ef505df600fcf6a7067139b
+  data.tar.gz: 7a993be651953b5d57dd582baef3eecf4d9d791b8465b5dce2eee901610f38ba452e68f09c07c178cb410d03c77cdb0281627ea5c32d827ba6b51032d6c8656a

data/README.md

@@ -8,59 +8,42 @@ A client and integration layer for the [Sentry](https://github.com/getsentry/sen
 
 ## Requirements
 
-We test on Ruby MRI 1.8.7, 1.9.3 and 2.0.0. Rubinius and JRuby support is experimental.
+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.
 
 ## Installation
 
 ```ruby
-gem "sentry-raven" #, :github => "getsentry/raven-ruby"
+gem "sentry-raven", :require => 'raven' #, :github => "getsentry/raven-ruby"
 ```
 
 ## Usage
 
-The minimum configuration require setting the ``SENTRY_DSN`` with value found on your Sentry project settings page. It should resemble something like ```https://public:secret@app.getsentry.com/9999```. See [Configuration](#configuration) for configuration methods, and other options.
+Set the ``SENTRY_DSN`` environment variable with the value found on your Sentry project settings page. It should resemble something like ```https://public:secret@app.getsentry.com/9999```.
 
 Many implementations will automatically capture uncaught exceptions (such as Rails, Sidekiq or by using
 the Rack middleware). If you catch those exceptions yourself, but still want to report on them, see section [Capturing Events](#capturing-events).
 
-### Rails 3 or 4
+### Rails
 
-In Rails 3 or 4 all uncaught exceptions will be automatically reported under most situations.
+In Rails, all uncaught exceptions will be automatically reported.
 
-You'll still want to ensure you've disabled anything that would prevent errors from being propagated to the ```Raven::Rack``` middleware:
-
-Disable ```ActionDispatch::ShowExceptions```:
+You'll still want to ensure you've disabled anything that would prevent errors from being propagated to the ```Raven::Rack``` middleware, like ```ActionDispatch::ShowExceptions```:
 
 ```ruby
-config.action_dispatch.show_exceptions = false
+config.action_dispatch.show_exceptions = false # this is the default setting in production
 ```
 
-#### Delayed::Job
-
-No extra configuration required. Usage of [delayed-plugins-raven](https://github.com/qiushihe/delayed-plugins-raven) gem is deprecated.
-
-### Rails 2
-
-No support for Rails 2 yet, but it is being worked on.
-
 ### Rack
 
-Add ```use Raven::Rack``` to your ```config.ru``` (or other rackup file).
+Add ```use Raven::Rack``` to your ```config.ru``` or other rackup file (this is automatically inserted in Rails).
 
 ### Sinatra
 
 Like any other Rack middleware, add ```use Raven::Rack``` to your Sinatra app.
 
-### Sidekiq
-
-Raven includes [Sidekiq middleware](https://github.com/mperham/sidekiq/wiki/Middleware) which takes
-care of reporting errors that occur in Sidekiq jobs. To use it, just require the middleware by doing
-
-```ruby
-require 'raven/sidekiq'
-```
-after you require Sidekiq. If you are using Sidekiq with Rails, just put this require somewhere in the initializers.
+### Sidekiq, Delayed::Job and Rake
 
+Raven works out-of-the-box with all these tools!
 
 ## Capturing Events
 
@@ -166,7 +149,6 @@ class UserSession < Authlogic::Session::Base
 end
 ```
 
-
 ## Configuration
 
 ### SENTRY_DSN
@@ -176,6 +158,7 @@ After you complete setting up a project, you'll be given a value which we call a
 With Raven, you may either set the ```SENTRY_DSN``` environment variable (recommended), or set your DSN manually in a config block:
 
 ```ruby
+# in Rails, this might be in config/initializers/sentry.rb
 Raven.configure do |config|
   config.dsn = 'http://public:secret@example.com/project-id'
 end
@@ -183,7 +166,7 @@ end
 
 ### Environments
 
-By default, events will be sent to Sentry in all environments. If you do not wish
+As of [v0.10.0](https://github.com/getsentry/raven-ruby/blob/21cb3164e0d0ab91394ba98b78195c4f6342b4bb/changelog.md#0100), events will be sent to Sentry in all environments. If you do not wish
 to send events in an environment, we suggest you unset the ```SENTRY_DSN```
 variable in that environment.
 
@@ -215,7 +198,17 @@ Raven.configure do |config|
 end
 ```
 
-You can find the list of exceptions that are excluded by default in [Raven::Configuration::IGNORE_DEFAULT](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb#L74-L80). Remember you'll be overriding those defaults by setting this configuration.
+You can find the list of exceptions that are excluded by default in [Raven::Configuration::IGNORE_DEFAULT](https://github.com/getsentry/raven-ruby/blob/master/lib/raven/configuration.rb). Remember you'll be overriding those defaults by setting this configuration.
+
+You can also use a configuration option to determine if an individual event should
+be sent to Sentry. Events are passed to the Proc or lambda you provide - returning
+`false` will stop the event from sending to Sentry:
+
+```ruby
+Raven.configure do |config|
+  config.should_send = Proc.new { |e| true unless e.contains_sensitive_info? }
+end
+```
 
 ### Tags
 

data/lib/raven/base.rb

@@ -10,7 +10,10 @@ require 'raven/interfaces/message'
 require 'raven/interfaces/exception'
 require 'raven/interfaces/stack_trace'
 require 'raven/interfaces/http'
-require 'raven/processors/sanitizedata'
+require 'raven/processor'
+require 'raven/processor/sanitizedata'
+require 'raven/processor/removecircularreferences'
+require 'raven/processor/utf8conversion'
 
 module Raven
   class << self
@@ -98,7 +101,7 @@ module Raven
     end
 
     def capture_exception(exception, options = {})
-      send_or_skip do
+      send_or_skip(exception) do
         if evt = Event.from_exception(exception, options)
           yield evt if block_given?
           if configuration.async?
@@ -111,7 +114,7 @@ module Raven
     end
 
     def capture_message(message, options = {})
-      send_or_skip do
+      send_or_skip(message) do
         if evt = Event.from_message(message, options)
           yield evt if block_given?
           if configuration.async?
@@ -123,8 +126,14 @@ module Raven
       end
     end
 
-    def send_or_skip
-      if configuration.send_in_current_environment?
+    def send_or_skip(exc)
+      should_send = if configuration.should_send
+        configuration.should_send.call(*[exc])
+      else
+        true
+      end
+
+      if configuration.send_in_current_environment? && should_send
         yield if block_given?
       else
         configuration.log_excluded_environment_message
@@ -198,11 +207,13 @@ module Raven
 
     # Injects various integrations
     def inject
-      # TODO(dcramer): integrations should have a way to opt-out
       require 'raven/integrations/delayed_job' if defined?(::Delayed::Plugin)
       require 'raven/railtie' if defined?(::Rails::Railtie)
       require 'raven/sidekiq' if defined?(Sidekiq)
-      require 'raven/tasks' if defined?(Rake)
+      if defined?(Rake)
+        require 'raven/rake'
+        require 'raven/tasks'
+      end
     end
 
     # For cross-language compat

data/lib/raven/cli.rb

@@ -46,8 +46,10 @@ module Raven
         evt = Raven.capture_exception(exception)
       end
 
-      if evt
+      if evt && !(evt.is_a? Thread)
         puts "-> event ID: #{evt.id}"
+      elsif evt #async configuration
+        puts "-> event ID: #{evt.value.id}"
       else
         puts ""
         puts "An error occurred while attempting to send the event."

data/lib/raven/configuration.rb

@@ -80,6 +80,9 @@ module Raven
     # ActionDispatch::ShowExceptions or ActionDispatch::DebugExceptions
     attr_accessor :catch_debugged_exceptions
 
+    # Provide a configurable callback to block or send events
+    attr_accessor :should_send
+
     IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
                       'ActionController::RoutingError',
                       'ActionController::InvalidAuthenticityToken',
@@ -94,7 +97,7 @@ module Raven
       self.current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
       self.send_modules = true
       self.excluded_exceptions = IGNORE_DEFAULT
-      self.processors = [Raven::Processor::SanitizeData]
+      self.processors = [Raven::Processor::RemoveCircularReferences, Raven::Processor::UTF8Conversion, Raven::Processor::SanitizeData]
       self.ssl_verification = false
       self.encoding = 'gzip'
       self.timeout = 1

data/lib/raven/processor.rb

@@ -1,13 +1,25 @@
+require 'json'
+
 module Raven
-  module Processor
-    class Processor
-      def initialize(client)
-        @client = client
-      end
+  class Processor
+    def initialize(client)
+      @client = client
+    end
 
-      def process(data)
-        data
+    def process(data)
+      data
+    end
+
+    private
+
+    def parse_json_or_nil(string)
+      begin
+        result = OkJson.decode(string)
+        result.is_a?(String) ? nil : result
+      rescue Raven::OkJson::Error
+        nil
       end
     end
+
   end
 end

data/lib/raven/processor/removecircularreferences.rb

@@ -0,0 +1,17 @@
+module Raven
+  class Processor::RemoveCircularReferences < Processor
+
+    def process(v, visited = [])
+      return "(...)" if visited.include?(v.__id__)
+      visited += [v.__id__]
+      if v.is_a?(Hash)
+        v.reduce({}) { |memo, (k, v_)| memo[k] = process(v_, visited); memo }
+      elsif v.is_a?(Array)
+        v.map { |v_| process(v_, visited) }
+      else
+        v
+      end
+    end
+
+  end
+end

data/lib/raven/processor/sanitizedata.rb

@@ -0,0 +1,26 @@
+module Raven
+  class Processor::SanitizeData < Processor
+    STRING_MASK = '********'
+    INT_MASK = 0
+    FIELDS_RE = /(authorization|password|passwd|secret|ssn|social(.*)?sec)/i
+    VALUES_RE = /^\d{16}$/
+
+    def process(value)
+      value.merge(value) do |k, v|
+        if v.is_a?(Hash)
+          process(v)
+        elsif v.is_a?(String) && (json_hash = parse_json_or_nil(v))
+          #if this string is actually a json obj, convert and sanitize
+          process(json_hash).to_json
+        elsif v.is_a?(Integer) && (VALUES_RE.match(v.to_s) || FIELDS_RE.match(k))
+          INT_MASK
+        elsif VALUES_RE.match(v.to_s) || FIELDS_RE.match(k)
+          STRING_MASK
+        else
+          v
+        end
+      end
+    end
+  end
+end
+

data/lib/raven/processor/utf8conversion.rb

@@ -0,0 +1,26 @@
+module Raven
+  class Processor::UTF8Conversion < Processor
+
+    def process(value)
+      if value.is_a? Array
+        value.map { |v_| process v_ }
+      elsif value.is_a? Hash
+        value.merge(value) { |k, v_| process v_ }
+      else
+        clean_invalid_utf8_bytes(value)
+      end
+    end
+
+    private
+
+    def clean_invalid_utf8_bytes(obj)
+      if obj.respond_to?(:to_utf8)
+        obj.to_utf8
+      elsif obj.respond_to?(:encoding)
+        obj.encode('UTF-16', :invalid => :replace, :undef => :replace, :replace => '').encode('UTF-8')
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/raven/rake.rb

@@ -0,0 +1,13 @@
+require 'raven'
+require 'rake/task'
+
+module Rake
+  class Application
+    alias :orig_display_error_messsage :display_error_message
+    def display_error_message(ex)
+      Raven.capture_exception ex, :logger => 'rake', :tags => { 'rake_task' => @name }
+      orig_display_error_messsage(ex)
+    end
+  end
+end
+

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.10.1"
+  VERSION = "0.11.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.1
 platform: ruby
 authors:
 - Noah Kantrowitz
@@ -9,104 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.6
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -118,6 +118,10 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- LICENSE
+- README.md
+- bin/raven
+- lib/raven.rb
 - lib/raven/backtrace.rb
 - lib/raven/base.rb
 - lib/raven/better_attr_accessor.rb
@@ -128,31 +132,30 @@ files:
 - lib/raven/error.rb
 - lib/raven/event.rb
 - lib/raven/integrations/delayed_job.rb
+- lib/raven/interfaces.rb
 - lib/raven/interfaces/exception.rb
 - lib/raven/interfaces/http.rb
 - lib/raven/interfaces/message.rb
 - lib/raven/interfaces/stack_trace.rb
-- lib/raven/interfaces.rb
 - lib/raven/linecache.rb
 - lib/raven/logger.rb
 - lib/raven/okjson.rb
 - lib/raven/processor.rb
-- lib/raven/processors/sanitizedata.rb
+- lib/raven/processor/removecircularreferences.rb
+- lib/raven/processor/sanitizedata.rb
+- lib/raven/processor/utf8conversion.rb
 - lib/raven/rack.rb
 - lib/raven/rails/controller_methods.rb
 - lib/raven/rails/middleware/debug_exceptions_catcher.rb
 - lib/raven/railtie.rb
+- lib/raven/rake.rb
 - lib/raven/sidekiq.rb
 - lib/raven/tasks.rb
+- lib/raven/transports.rb
 - lib/raven/transports/http.rb
 - lib/raven/transports/udp.rb
-- lib/raven/transports.rb
 - lib/raven/version.rb
-- lib/raven.rb
 - lib/sentry-raven.rb
-- README.md
-- LICENSE
-- bin/raven
 homepage: http://github.com/getsentry/raven-ruby
 licenses:
 - Apache-2.0
@@ -163,17 +166,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for the Sentry error logger

data/lib/raven/processors/sanitizedata.rb

@@ -1,76 +0,0 @@
-require 'raven/processor'
-require 'json'
-
-module Raven
-  module Processor
-    class SanitizeData < Processor
-
-      MASK = '********'
-      FIELDS_RE = /(authorization|password|passwd|secret)/i
-      VALUES_RE = /^\d{16}$/
-
-      def apply(value, key = nil, visited = [], &block)
-        if value.is_a?(Hash)
-          return "{...}" if visited.include?(value.__id__)
-          visited += [value.__id__]
-
-          value.each.reduce({}) do |memo, (k, v)|
-            memo[k] = apply(v, k, visited, &block)
-            memo
-          end
-        elsif value.is_a?(Array)
-          return "[...]" if visited.include?(value.__id__)
-          visited += [value.__id__]
-
-          value.map do |value_|
-            apply(value_, key, visited, &block)
-          end
-        elsif value.is_a?(String) && json_hash = JSON.parse(value) rescue nil
-          return "[...]" if visited.include?(value.__id__)
-          visited += [value.__id__]
-
-          json_hash = json_hash.each.reduce({}) do |memo, (k, v)|
-            memo[k] = apply(v, k, visited, &block)
-            memo
-          end
-
-          json_hash.to_json
-        else
-          block.call(key, value)
-        end
-      end
-
-      def sanitize(key, value)
-        if !value.is_a?(String) || value.empty?
-          value
-        elsif VALUES_RE.match(clean_invalid_utf8_bytes(value)) || FIELDS_RE.match(key)
-          MASK
-        else
-          clean_invalid_utf8_bytes(value)
-        end
-      end
-
-      def process(data)
-        apply(data) do |key, value|
-          sanitize(key, value)
-        end
-      end
-
-      private
-
-      def clean_invalid_utf8_bytes(text)
-        if RUBY_VERSION <= '1.8.7'
-          text
-        else
-          text.encode(
-            'UTF-8',
-            'binary',
-            :invalid => :replace,
-            :undef => :replace,
-            :replace => ''
-          )
-        end
-      end
-    end
-  end
-end