sentry-raven 0.2 → 0.3

data/README.md

@@ -1,8 +1,8 @@
 # Raven-Ruby
 
-[![Build Status](https://secure.travis-ci.org/coderanger/raven-ruby.png?branch=master)](http://travis-ci.org/coderanger/raven-ruby)
+[![Build Status](https://secure.travis-ci.org/getsentry/raven-ruby.png?branch=master)](http://travis-ci.org/getsentry/raven-ruby)
 
-A client and integration layer for the [Sentry](https://github.com/dcramer/sentry) error reporting API.
+A client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
 
 This library is still forming, so if you are looking to just use it, please check back in a few weeks.
 
@@ -11,7 +11,7 @@ This library is still forming, so if you are looking to just use it, please chec
 Add the following to your `Gemfile`:
 
 ```ruby
-gem "sentry-raven", :git => "https://github.com/coderanger/raven-ruby.git"
+gem "sentry-raven", :git => "https://github.com/getsentry/raven-ruby.git"
 ```
 
 Or install manually
@@ -37,7 +37,7 @@ end
 
 No support for Rails 2 yet.
 
-### Other Rack Servers
+### Rack
 
 Basic RackUp file.
 
@@ -51,6 +51,23 @@ end
 use Raven::Rack
 ```
 
+### Sinatra
+
+```ruby
+require 'sinatra'
+require 'raven'
+
+Raven.configure do |config|
+  config.dsn = 'http://public:secret@example.com/project-id'
+end
+
+use Raven::Rack
+
+get '/' do
+  1 / 0
+end
+```
+
 ### Other Ruby
 
 ```ruby
@@ -90,4 +107,44 @@ Raven.configure do |config|
   config.dsn = 'http://public:secret@example.com/project-id'
   config.environments = %w[ development production ]
 end
-```
+```
+
+## Excluding Exceptions
+
+If you never wish to be notified of certain exceptions, specify 'excluded_exceptions' in your config file.
+
+In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.
+
+```ruby
+require 'raven'
+
+Raven.configure do |config|
+  config.dsn = 'http://public:secret@example.com/project-id'
+  config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
+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
+implementation. By default, a single processor is installed (Raven::Processors::SanitizeData), which will attempt to
+sanitize keys that match various patterns (e.g. password) and values that resemble credit card numbers.
+
+To specify your own (or to remove the defaults), simply pass them with your configuration:
+
+```ruby
+require 'raven'
+
+Raven.configure do |config|
+  config.dsn = 'http://public:secret@example.com/project-id'
+  config.processors = [Raven::Processors::SanitizeData]
+end
+
+Resources
+---------
+
+* `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)
+

data/lib/raven.rb

@@ -8,6 +8,7 @@ require 'raven/interfaces/message'
 require 'raven/interfaces/exception'
 require 'raven/interfaces/stack_trace'
 require 'raven/interfaces/http'
+require 'raven/processors/sanitizedata'
 
 require 'raven/railtie' if defined?(Rails::Railtie)
 
@@ -72,8 +73,7 @@ module Raven
         rescue Error => e
           raise # Don't capture Raven errors
         rescue Exception => e
-          evt = Event.capture_exception(e)
-          send(evt) if evt
+          self.captureException(e)
           raise
         end
       else
@@ -81,12 +81,21 @@ module Raven
         at_exit do
           if $!
             logger.debug "Caught a post-mortem exception: #{$!.inspect}"
-            evt = Event.capture_exception($!)
-            send(evt) if evt
+            self.captureException($!)
           end
         end
       end
     end
 
+    def captureException(exception)
+      evt = Event.capture_exception(exception)
+      send(evt) if evt
+    end
+
+    def captureMessage(message)
+      evt = Event.capture_message(message)
+      send(evt) if evt
+    end
+
   end
 end

data/lib/raven/client.rb

@@ -1,6 +1,6 @@
 require 'openssl'
 require 'uri'
-require 'yajl'
+require 'multi_json'
 require 'faraday'
 
 require 'raven/version'
@@ -59,7 +59,7 @@ module Raven
       Raven.logger.debug "Sending event #{event.id} to Sentry"
       response = self.conn.post '/api/store/' do |req|
         req.headers['Content-Type'] = 'application/json'
-        req.body = Yajl::Encoder.encode(event.to_hash)
+        req.body = MultiJson.encode(event.to_hash)
         req.headers[AUTH_HEADER_KEY] = self.generate_auth_header(req.body)
       end
       raise Error.new("Error from Sentry server (#{response.status}): #{response.body}") unless response.status == 200

data/lib/raven/configuration.rb

@@ -25,6 +25,12 @@ module Raven
     # Include module versions in reports?
     attr_accessor :send_modules
 
+    # Which exceptions should never be sent
+    attr_accessor :excluded_exceptions
+
+    # Processors to run on data before sending upstream
+    attr_accessor :processors
+
     attr_reader :current_environment
 
     def initialize
@@ -33,6 +39,8 @@ module Raven
       self.environments = %w[ production ]
       self.current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
       self.send_modules = true
+      self.excluded_exceptions = []
+      self.processors = [Raven::Processor::SanitizeData]
     end
 
     def server=(value)

data/lib/raven/error.rb

@@ -1,6 +1,6 @@
 module Raven
 
-  class Error < Exception
+  class Error < StandardError
   end
 
 end

data/lib/raven/event.rb

@@ -24,7 +24,8 @@ module Raven
     attr_accessor :logger, :culprit, :server_name, :modules, :extra
 
     def initialize(options={}, configuration=nil, &block)
-      configuration ||= Raven.configuration
+      @configuration = configuration || Raven.configuration
+      @interfaces = {}
 
       @id = options[:id] || UUIDTools::UUID.random_create.hexdigest
       @message = options[:message]
@@ -32,21 +33,19 @@ module Raven
       @level = options[:level] || :error
       @logger = options[:logger] || 'root'
       @culprit = options[:culprit]
+      @extra = options[:extra]
 
       # Try to resolve the hostname to an FQDN, but fall back to whatever the load name is
       hostname = Socket.gethostname
       hostname = Socket.gethostbyname(hostname).first rescue hostname
       @server_name = options[:server_name] || hostname
 
-      if configuration.send_modules && !options.has_key?(:modules)
-        options[:modules] = Hash[Gem::Specification.map {|spec| [spec.name, spec.version]}]
+      # Older versions of Rubygems don't support iterating over all specs
+      if @configuration.send_modules && Gem::Specification.respond_to?(:map)
+        options[:modules] ||= Hash[Gem::Specification.map {|spec| [spec.name, spec.version.to_s]}]
       end
       @modules = options[:modules]
 
-      @extra = options[:extra]
-
-      @interfaces = {}
-
       block.call(self) if block
 
       # Some type coercion
@@ -99,36 +98,20 @@ module Raven
         Raven.logger.info "Refusing to capture Raven error: #{exc.inspect}"
         return nil
       end
+      if configuration[:excluded_exceptions].include? exc.class.name
+        Raven.logger.info "User excluded error: #{exc.inspect}"
+        return nil
+      end
       self.new({}, configuration) do |evt|
-        evt.message = exc.message
+        evt.message = "#{exc.class.to_s}: #{exc.message}"
         evt.level = :error
-        evt.interface :exception do |int|
-          int.type = exc.class.to_s
-          int.value = exc.message
-          class_parts = exc.class.to_s.split('::')
-          class_parts.pop
-          int.module = class_parts.join('::')
-        end
-        evt.interface :stack_trace do |int|
-          int.frames = exc.backtrace.reverse.map do |trace_line|
-            md = BACKTRACE_RE.match(trace_line)
-            raise Error.new("Unable to parse backtrace line: #{trace_line.inspect}") unless md
-            int.frame do |frame|
-              frame.abs_path = md[1]
-              frame.lineno = md[2].to_i
-              frame.function = md[3] if md[3]
-              lib_path = $:.select{|s| frame.abs_path.start_with?(s)}.sort_by{|s| s.length}.last
-              if lib_path
-                frame.filename = frame.abs_path[lib_path.chomp(File::SEPARATOR).length+1..frame.abs_path.length]
-              else
-                frame.filename = frame.abs_path
-              end
-              if configuration[:context_lines]
-                frame.context_line = Raven::LineCache::getline(frame.abs_path, frame.lineno)
-                frame.pre_context = (frame.lineno-configuration[:context_lines]..frame.lineno-1).map{|i| Raven::LineCache.getline(frame.abs_path, i)}.select{|line| line}
-                frame.post_context = (frame.lineno+1..frame.lineno+configuration[:context_lines]).map{|i| Raven::LineCache.getline(frame.abs_path, i)}.select{|line| line}
-              end
+        evt.parse_exception(exc)
+        if (exc.backtrace)
+          evt.interface :stack_trace do |int|
+            int.frames = exc.backtrace.reverse.map do |trace_line|
+              int.frame {|frame| evt.parse_backtrace_line(trace_line, frame) }
             end
+            evt.culprit = evt.get_culprit(int.frames)
           end
         end
         block.call(evt) if block
@@ -145,9 +128,48 @@ module Raven
       end
     end
 
+    def self.capture_message(message, configuration=nil)
+      configuration ||= Raven.configuration
+      self.new({}, configuration) do |evt|
+        evt.message = message
+        evt.level = :error
+        evt.interface :message do |int|
+          int.message = message
+        end
+      end
+    end
+
+    def get_culprit(frames)
+        lastframe = frames[-2]
+        "#{lastframe.filename} in #{lastframe.function}" if lastframe
+    end
+
+    def parse_exception(exception)
+      interface(:exception) do |int|
+        int.type = exception.class.to_s
+        int.value = exception.message
+        int.module = exception.class.to_s.split('::')[0...-1].join('::')
+      end
+    end
+
+    def parse_backtrace_line(line, frame)
+      md = BACKTRACE_RE.match(line)
+      raise Error.new("Unable to parse backtrace line: #{line.inspect}") unless md
+      frame.abs_path = md[1]
+      frame.lineno = md[2].to_i
+      frame.function = md[3] if md[3]
+      frame.filename = strip_load_path_from(frame.abs_path)
+      if context_lines = @configuration[:context_lines]
+        frame.pre_context, frame.context_line, frame.post_context = \
+          get_context(frame.abs_path, frame.lineno, context_lines)
+      end
+      frame
+    end
+
     # For cross-language compat
     class << self
       alias :captionException :capture_exception
+      alias :captureMessage :capture_message
     end
 
     private
@@ -156,6 +178,16 @@ module Raven
     def self._source_lines(path, from, to)
     end
 
-  end
+    def get_context(path, line, context)
+      lines = (2 * context + 1).times.map do |i|
+        Raven::LineCache::getline(path, line - context + i)
+      end
+      [lines[0..(context-1)], lines[context], lines[(context+1)..-1]]
+    end
 
+    def strip_load_path_from(path)
+      prefix = $:.select {|s| path.start_with?(s)}.sort_by {|s| s.length}.last
+      prefix ? path[prefix.chomp(File::SEPARATOR).length+1..-1] : path
+    end
+  end
 end

data/lib/raven/interfaces/http.rb

@@ -10,8 +10,14 @@ module Raven
     property :data
     property :query_string
     property :cookies
-    property :headers, :default => {}
-    property :env, :default => {}
+    property :headers
+    property :env
+
+    def initialize(*arguments)
+      self.headers = {}
+      self.env = {}
+      super(*arguments)
+    end
 
     def from_rack(env)
       require 'rack'

data/lib/raven/interfaces/message.rb

@@ -6,8 +6,12 @@ module Raven
 
     name 'sentry.interfaces.Message'
     property :message, :required => true
-    property :params, :default => []
+    property :params
 
+    def initialize(*arguments)
+      self.params = []
+      super(*arguments)
+    end
   end
 
   register_interface :message => MessageInterface

data/lib/raven/interfaces/stack_trace.rb

@@ -9,6 +9,11 @@ module Raven
     name 'sentry.interfaces.Stacktrace'
     property :frames, :default => []
 
+    def initialize(*arguments)
+      self.frames = []
+      super(*arguments)
+    end
+
     def to_hash
       data = super
       data['frames'] = data['frames'].map{|frame| frame.to_hash}
@@ -24,12 +29,19 @@ module Raven
       property :abs_path
       property :filename, :required => true
       property :function
-      property :vars, :default => {}
-      property :pre_context, :default => []
-      property :post_context, :default => []
+      property :vars
+      property :pre_context
+      property :post_context
       property :context_line
       property :lineno, :required => true
 
+      def initialize(*arguments)
+        self.vars= {}
+        self.pre_context = []
+        self.post_context = []
+        super(*arguments)
+      end
+
       def to_hash
         data = super
         data.delete('vars') unless self.vars && !self.vars.empty?

data/lib/raven/processor.rb

@@ -0,0 +1,15 @@
+module Raven
+
+  module Processor
+    class Processor
+      def initialize(client)
+        @client = client
+      end
+
+      def process(data)
+        data
+      end
+    end
+  end
+
+end

data/lib/raven/processors/sanitizedata.rb

@@ -0,0 +1,43 @@
+require 'raven/processor'
+
+module Raven
+  module Processor
+    class SanitizeData < Processor
+
+      MASK = '********'
+      FIELDS_RE = /(authorization|password|passwd|secret)/i
+      VALUES_RE = /^\d{16}$/
+
+      def apply(value, key=nil, &block)
+        if value.is_a?(Hash)
+          value.each.inject({}) do |memo, (k, v)|
+            memo[k] = apply(v, k, &block)
+            memo
+          end
+        elsif value.is_a?(Array)
+          value.map do |value|
+            apply(value, key, &block)
+          end
+        else
+          block.call(key, value)
+        end
+      end
+
+      def sanitize(key, value)
+        if !value || value.empty?
+          value
+        elsif VALUES_RE.match(value) or FIELDS_RE.match(key)
+          MASK
+        else
+          value
+        end
+      end
+
+      def process(data)
+        apply(data) do |key, value|
+          sanitize(key, value)
+        end
+      end
+    end
+  end
+end

data/lib/raven/rack.rb

@@ -29,12 +29,12 @@ module Raven
         raise # Don't capture Raven errors
       rescue Exception => e
         evt = Event.capture_rack_exception(e, env)
-        Raven.send(evt) if evt
+        Raven.send(evt)
         raise
       end
 
       if env['rack.exception']
-        evt = Event.capture_rack_exception(e, env)
+        evt = Event.capture_rack_exception(env['rack.exception'], env)
         Raven.send(evt) if evt
       end
 

data/lib/raven/railtie.rb

@@ -4,7 +4,7 @@ require 'rails'
 module Raven
   class Railtie < ::Rails::Railtie
     initializer "raven.use_rack_middleware" do |app|
-      app.config.middleware.use "Raven::Rack" unless defined?(::ActionDispatch::DebugExceptions)
+      app.config.middleware.insert 0, "Raven::Rack"
     end
 
     config.after_initialize do
@@ -15,6 +15,9 @@ module Raven
       if defined?(::ActionDispatch::DebugExceptions)
         require 'raven/rails/middleware/debug_exceptions_catcher'
         ::ActionDispatch::DebugExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
+      elsif defined?(::ActionDispatch::ShowExceptions)
+        require 'raven/rails/middleware/debug_exceptions_catcher'
+        ::ActionDispatch::ShowExceptions.send(:include, Raven::Rails::Middleware::DebugExceptionsCatcher)
       end
     end
   end

data/lib/raven/version.rb

@@ -1,3 +1,3 @@
 module Raven
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

metadata

@@ -1,8 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: sentry-raven
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: "0.2"
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Noah Kantrowitz
@@ -10,16 +13,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-14 00:00:00 Z
+date: 2012-10-26 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: faraday
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 0
+        - rc2
         version: 0.8.0.rc2
   type: :runtime
   version_requirements: *id001
@@ -27,32 +35,36 @@ dependencies:
   name: uuidtools
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: yajl-ruby
+  name: multi_json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hashie
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id004
@@ -77,6 +89,8 @@ files:
 - lib/raven/interfaces.rb
 - lib/raven/linecache.rb
 - lib/raven/logger.rb
+- lib/raven/processor.rb
+- lib/raven/processors/sanitizedata.rb
 - lib/raven/rack.rb
 - lib/raven/rails/middleware/debug_exceptions_catcher.rb
 - lib/raven/railtie.rb
@@ -84,7 +98,8 @@ files:
 - lib/raven.rb
 - README.md
 - LICENSE
-homepage: http://github.com/coderanger/raven-ruby
+has_rdoc: true
+homepage: http://github.com/getsentry/raven-ruby
 licenses: []
 
 post_install_message: 
@@ -93,21 +108,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A gem that provides a client interface for the Sentry error logger