sentry-raven 0.6.1 → 0.7.1

data/README.md

@@ -6,7 +6,7 @@ A client and integration layer for the [Sentry](https://github.com/getsentry/sen
 
 ## Requirements
 
-We test on Ruby MRI 1.8.7, 1.9.2, 1.9.3 and 2.0.0. Other versions/VMs are untested but we will accept pull requests to support them.
+We test on Ruby MRI 1.8.7, 1.9.3 and 2.0.0. Rubinius and JRuby support is experimental.
 
 ## Installation
 
@@ -41,12 +41,24 @@ 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).
 
 ### 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.
+
+
 ## Capturing Events
 
 Many implementations will automatically capture uncaught exceptions (such as Rails, Sidekiq or by using
@@ -97,6 +109,41 @@ The following attributes are available:
 * `tags`: a mapping of [tags](https://www.getsentry.com/docs/tags/) describing this event
 * `extra`: a mapping of arbitrary context
 
+## Providing Request Context
+
+Most of the time you're not actually calling out to Raven directly, but you still want to provide some additional context. This lifecycle generally constists of something like the following:
+
+- Set some context via a middleware (e.g. the logged in user)
+- Send all given context with any events during the request lifecycle
+- Cleanup context
+
+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'})
+```
+
+Additionally, if you're using Rack (without the middleware), you can easily provide context with the ``rack_context`` helper:
+
+```ruby
+Raven.rack_context(env)
+```
+
+If you're using the Rack middleware, we've already taken care of cleanup for you, otherwise you'll need to ensure you perform it manually:
+
+```ruby
+Raven.context.clear!
+```
+
+Note: the rack and user context will perform a set operation, whereas tags and extra context will merge with any existing request context.
+
 ## Configuration
 
 ### SENTRY_DSN
@@ -168,6 +215,20 @@ Raven.configure do |config|
   config.ssl_verification = true
 ```
 
+### Logging
+
+You can use any logger with Raven - just set config.logger. Raven respects logger
+levels.
+
+```ruby
+logger = ::Logger.new(STDOUT)
+logger.level = ::Logger::WARN
+
+Raven.configure do |config|
+  config.logger = logger
+end
+```
+
 ## Sanitizing Data (Processors)
 
 If you need to sanitize or pre-process (before its sent to the server) data, you can do so using the Processors
@@ -203,8 +264,8 @@ Done!
 
 A couple of things to note:
 
-* This won't test your environment configuration. The test CLI forces the your
-  coniguration to represent itself as if it were running in the production env.
+* This won't test your environment configuration. The test CLI forces your
+  configuration to represent itself as if it were running in the production env.
 * If you're running within Rails (or anywhere else that will bootstrap the
   rake environment), you should be able to omit the DSN argument.
 

data/lib/raven.rb

@@ -118,6 +118,32 @@ module Raven
       end
     end
 
+    # Provides extra context to the exception prior to it being handled by
+    # Raven. An exception can have multiple annotations, which are merged
+    # together.
+    #
+    # The options (annotation) is treated the same as the ``options``
+    # parameter to ``capture_exception`` or ``Event.from_exception``, and
+    # can contain the same ``:user``, ``:tags``, etc. options as these
+    # methods.
+    #
+    # These will be merged with the ``options`` parameter to
+    # ``Event.from_exception`` at the top of execution.
+    #
+    # @example
+    #   begin
+    #     raise "Hello"
+    #   rescue => exc
+    #     Raven.annotate_exception(exc, :user => { 'id' => 1,
+    #                              'email' => 'foo@example.com' })
+    #   end
+    def annotate_exception(exc, options = {})
+      notes = exc.instance_variable_get(:@__raven_context) || {}
+      notes.merge!(options)
+      exc.instance_variable_set(:@__raven_context, notes)
+      exc
+    end
+
     # Bind user context. Merges with existing context (if any).
     #
     # It is recommending that you send at least the ``id`` and ``email``
@@ -126,7 +152,7 @@ module Raven
     # @example
     #   Raven.user_context('id' => 1, 'email' => 'foo@example.com')
     def user_context(options={})
-      self.context.user.merge!(options)
+      self.context.user = options
     end
 
     # Bind tags context. Merges with existing context (if any).
@@ -151,11 +177,16 @@ module Raven
     end
 
     def rack_context(env)
+      if env.empty?
+        env = nil
+      end
       self.context.rack_env = env
     end
 
     # For cross-language compat
     alias :captureException :capture_exception
     alias :captureMessage :capture_message
+    alias :annotateException :annotate_exception
+    alias :annotate :annotate_exception
   end
 end

data/lib/raven/client.rb

@@ -37,6 +37,7 @@ module Raven
                      :content_type => content_type)
       rescue => e
         Raven.logger.error "Unable to record event with remote Sentry server (#{e.class} - #{e.message})"
+        e.backtrace[0..10].each { |line| Raven.logger.error(line) }
         return
       end
 

data/lib/raven/context.rb

@@ -3,14 +3,14 @@ module Raven
     def self.current
       Thread.current[:sentry_context] ||= new
     end
-    
+
     def self.clear!
       Thread.current[:sentry_context] = nil
     end
-    
-    attr_reader :extra, :tags, :user
-    attr_accessor :rack_env
-    
+
+    attr_reader :extra, :tags
+    attr_accessor :rack_env, :user
+
     def initialize
       @extra = {}
       @tags = {}

data/lib/raven/event.rb

@@ -58,9 +58,11 @@ module Raven
 
       block.call(self) if block
 
-      if !self[:http] && context.rack_env
-        self.interface :http do |int|
-          int.from_rack(context.rack_env)
+      if @configuration.send_in_current_environment?
+        if !self[:http] && context.rack_env
+          self.interface :http do |int|
+            int.from_rack(context.rack_env)
+          end
         end
       end
 
@@ -118,6 +120,9 @@ module Raven
     end
 
     def self.from_exception(exc, options={}, &block)
+      notes = exc.instance_variable_get(:@__raven_context) || {}
+      options = notes.merge(options)
+
       configuration = options[:configuration] || Raven.configuration
       if exc.is_a?(Raven::Error)
         # Try to prevent error reporting loops

data/lib/raven/interfaces/stack_trace.rb

@@ -45,7 +45,7 @@ module Raven
       def filename
         return nil if self.abs_path.nil?
 
-        prefix = $:.select {|s| self.abs_path.start_with?(s.to_s)}.sort_by {|s| s.length}.last
+        prefix = $:.select {|s| self.abs_path.start_with?(s.to_s)}.sort_by {|s| s.to_s.length}.last
         prefix ? self.abs_path[prefix.chomp(File::SEPARATOR).length+1..-1] : self.abs_path
       end
 

data/lib/raven/okjson.rb

@@ -271,8 +271,7 @@ private
       elsif m[2]
         [:val, m[0], Float(m[0])]
       else
-        # We don't convert scientific notation
-        [:val, m[0], m[0]]
+        [:val, m[0], Integer(m[1])*(10**Integer(m[3][1..-1]))]
       end
     else
       []
@@ -604,4 +603,5 @@ private
   Spc = ' '[0]
   Unesc = {?b=>?\b, ?f=>?\f, ?n=>?\n, ?r=>?\r, ?t=>?\t}
 end
+
 end

data/lib/raven/processors/sanitizedata.rb

@@ -32,10 +32,10 @@ module Raven
       def sanitize(key, value)
         if !value.is_a?(String) || value.empty?
           value
-        elsif VALUES_RE.match(value) or FIELDS_RE.match(key)
+        elsif VALUES_RE.match(clean_invalid_utf8_bytes(value)) or FIELDS_RE.match(key)
           MASK
         else
-          value
+          clean_invalid_utf8_bytes(value)
         end
       end
 
@@ -44,6 +44,21 @@ module Raven
           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

data/lib/raven/tasks.rb

@@ -5,6 +5,9 @@ require 'raven/cli'
 namespace :raven do
   desc "Send a test event to the remote Sentry server"
   task :test, [:dsn] do |t, args|
+    if defined? Rails
+      Rake::Task["environment"].invoke
+    end
     Raven::CLI::test(args.dsn)
   end
 end

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.6.1"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
+  prerelease: 
 platform: ruby
 authors:
 - Noah Kantrowitz
@@ -9,92 +10,74 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2013-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70257293798340 !ruby/object:Gem::Requirement
+    none: false
     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
+  version_requirements: *70257293798340
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70257293797940 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70257293797940
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70257293797400 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+  version_requirements: *70257293797400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70257293796920 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70257293796920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70257293796300 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.10'
+  version_requirements: *70257293796300
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70257293795880 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70257293795880
 description: 
 email: noah@coderanger.net
 executables:
@@ -104,10 +87,6 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- LICENSE
-- README.md
-- bin/raven
-- lib/raven.rb
 - lib/raven/backtrace.rb
 - lib/raven/cli.rb
 - lib/raven/client.rb
@@ -115,11 +94,11 @@ files:
 - lib/raven/context.rb
 - lib/raven/error.rb
 - lib/raven/event.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
@@ -131,32 +110,37 @@ files:
 - lib/raven/railtie.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: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.10
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A gem that provides a client interface for the Sentry error logger
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjY4OWQ0MWVmNzM5YjVjMzM2NGYwOGI5NTkzNmI2MGRjYjhjMWVjOQ==
-  data.tar.gz: !binary |-
-    MTYxZTM3ZDkwMjk3NGE0OGVhZTUyYjU1Nzk5ODE3ZGRlNjcyM2VjMQ==
-SHA512:
-  metadata.gz: !binary |-
-    OTEyNzIyNjRiYTEzNmFkZDU0ZWI2NDRlYTJhYzVjMTcwYzcxNzQ2MjFkOWFm
-    NjUzZjg5MWI2MGQzZTZkYjBhNGIxMmEzYThlMWYxMDVkNzAwYzYxZjAwYWZi
-    MDAyMTgxZDA1MzQ2NzBhZWQwZmVjNzUwNmNhMWJjYzQ2ODQwNzM=
-  data.tar.gz: !binary |-
-    MDRlMTFkNTVjOWFkNWUyNjBiMmY4MjgyYTFlNjhlNTkzZTYwNDNkYzE5ZDM3
-    ZTdjOTdiZDhjNjRmNjJkNWY1ZTI3NDYwNmIzYzhkMzc5YzlhZWRlODM3YjI3
-    ZTJhNjAxYjY3ZjhlZGUxOTBhZTBiMGM4OWFmODU2N2IzMWE1YjI=