opbeat 0.8.0 → 0.9.0

data/README.md

@@ -104,13 +104,6 @@ Resque::Failure::Multiple.classes = [Resque::Failure::Opbeat]
 Resque::Failure.backend = Resque::Failure::Multiple
 ```
 
-## Testing
-
-```bash
-$ bundle install
-$ rake spec
-```
-
 ## Explicitly notifying Opbeat
 
 It is possible to explicitely notify Opbeat. In the case of a simple message:
@@ -126,6 +119,12 @@ rescue Exception => e
   Opbeat.captureException(e)
 ```
 
+Both `Opbeat.captureException` and `Opbeat.captureMessage` take additional `options`:
+```ruby
+Opbeat.captureMessage("Device registration error", :extra => {:device_id => my_device_id})
+```
+
+
 ## Notifications in development mode
 
 By default events will be sent to Opbeat if your application is running in any of the following environments: `development`, `production`, `default`. Environment is set by default if you are running a Rack application (i.e. anytime `ENV['RACK_ENV']` is set).
@@ -182,6 +181,38 @@ Opbeat.configure do |config|
 end
 ```
 
+## User information
+
+With Rails, Opbeat expects `controller#current_user` to return an object with `id`, `email` and/or `username` attributes. You can change the name of the current user method in the following manner:
+
+```ruby
+Opbeat.configure do |config|
+  ...
+  config.user_controller_method = "my_other_user_method"
+end
+```
+
+Opbeat will now call `controller#my_other_user_method` to retrieve the user object.
+
+## Setting context
+
+It is possible to set a context which be included an exceptions that are captured.
+
+```ruby
+Opbeat.set_context :extra => {:device_id => my_device_id}
+
+Opbeat.captureMessage("Hello world")  # will include the context
+```
+
+
+## Testing
+
+```bash
+$ bundle install
+$ rake spec
+```
+
+
 ## Resources
 
 * [Bug Tracker](http://github.com/opbeat/opbeat_ruby/issues)

data/lib/opbeat.rb

@@ -19,7 +19,7 @@ require 'opbeat/railtie' if defined?(Rails::Railtie)
 module Opbeat
   class << self
     # The client object is responsible for delivering formatted data to the Opbeat server.
-    # Must respond to #send. See Opbeat::Client.
+    # Must respond to #send_event. See Opbeat::Client.
     attr_accessor :client
 
     # A Opbeat configuration object. Must act like a hash and return sensible
@@ -91,15 +91,18 @@ module Opbeat
       end
     end
 
-    def captureException(exception)
-      evt = Event.capture_exception(exception)
+    def captureException(exception, options={})
+      evt = Event.capture_exception(exception, options)
       send(evt) if evt
     end
 
-    def captureMessage(message)
-      evt = Event.capture_message(message)
+    def captureMessage(message, options={})
+      evt = Event.capture_message(message, options)
       send(evt) if evt
     end
 
+    def set_context(options={})
+      Event.set_context(options)
+    end
   end
 end

data/lib/opbeat/client.rb

@@ -95,7 +95,6 @@ module Opbeat
           req.headers[AUTH_HEADER_KEY] = self.generate_auth_header(req.body)
           req.headers["User-Agent"] = USER_AGENT
         end
-
         unless response.status == 202
           raise Error.new("Error from Opbeat server (#{response.status}): #{response.body}")
         end

data/lib/opbeat/configuration.rb

@@ -42,6 +42,8 @@ module Opbeat
 
     attr_reader :current_environment
 
+    attr_accessor :user_controller_method
+
     def initialize
       self.server = ENV['OPBEAT_SERVER'] || "https://opbeat.com"
       self.secret_token = ENV['OPBEAT_SECRET_TOKEN'] if ENV['OPBEAT_SECRET_TOKEN']
@@ -55,6 +57,7 @@ module Opbeat
       self.timeout = 1
       self.backoff_multiplier = 2
       self.ssl_verification = true
+      self.user_controller_method = 'current_user'
     end
 
     # Allows config options to be read like a hash

data/lib/opbeat/event.rb

@@ -21,7 +21,7 @@ module Opbeat
 
     attr_reader :id
     attr_accessor :organization, :app, :message, :timestamp, :level
-    attr_accessor :logger, :culprit, :hostname, :modules, :extra
+    attr_accessor :logger, :culprit, :hostname, :modules, :extra, :user
     attr_accessor :environment
 
     def initialize(options={}, configuration=nil, &block)
@@ -36,6 +36,7 @@ module Opbeat
       @culprit = options[:culprit]
       @environment = @configuration[:current_environment]
       @extra = options[:extra]
+      @user = options[:user]
 
       # Try to resolve the hostname to an FQDN, but fall back to whatever the load name is
       hostname = Socket.gethostname
@@ -81,14 +82,20 @@ module Opbeat
       data['machine'] = {'hostname' => self.hostname } if self.hostname
       data['environment'] = self.environment if self.environment
       data['extra'] = self.extra if self.extra
+      if self.user
+        data['user'] = self.user
+        if self.user[:id] or self.user[:email] or self.user[:username]
+          data['user'][:is_authenticated] = true
+        end
+      end
       @interfaces.each_pair do |name, int_data|
         data[name] = int_data.to_hash
       end
       data
     end
 
-    def self.capture_exception(exc, configuration=nil, &block)
-      configuration ||= Opbeat.configuration
+    def self.capture_exception(exc, options={}, &block)
+      configuration = Opbeat.configuration
       if exc.is_a?(Opbeat::Error)
         # Try to prevent error reporting loops
         Opbeat.logger.info "Refusing to capture Opbeat error: #{exc.inspect}"
@@ -98,7 +105,8 @@ module Opbeat
         Opbeat.logger.info "User excluded error: #{exc.inspect}"
         return nil
       end
-      self.new({}, configuration) do |evt|
+      options = self.merge_context(options)
+      self.new(options, configuration) do |evt|
         evt.message = "#{exc.class.to_s}: #{exc.message}"
         evt.level = :error
         evt.parse_exception(exc)
@@ -114,19 +122,29 @@ module Opbeat
       end
     end
 
-    def self.capture_rack_exception(exc, rack_env, configuration=nil, &block)
-      configuration ||= Opbeat.configuration
-      capture_exception(exc, configuration) do |evt|
+    def self.capture_rack_exception(exc, rack_env, options={}, &block)
+      capture_exception(exc, options) do |evt|
         evt.interface :http do |int|
           int.from_rack(rack_env)
         end
+
+        if not evt.user
+          controller = rack_env["action_controller.instance"]
+          user_method_name = Opbeat.configuration.user_controller_method
+          if controller and controller.respond_to? user_method_name
+            user_obj = controller.send user_method_name
+            evt.from_user_object(user_obj)
+          end
+        end        
+
         block.call(evt) if block
       end
     end
 
-    def self.capture_message(message, configuration=nil)
+    def self.capture_message(message, options={})
       configuration ||= Opbeat.configuration
-      self.new({}, configuration) do |evt|
+      options = self.merge_context(options)
+      self.new(options, configuration) do |evt|
         evt.message = message
         evt.level = :error
         evt.interface :message do |int|
@@ -135,6 +153,10 @@ module Opbeat
       end
     end
 
+    def self.set_context(options={})
+      Thread.current["_opbeat_context"] = options
+    end
+
     def get_culprit(frames)
         lastframe = frames[-2]
         "#{lastframe.filename} in #{lastframe.function}" if lastframe
@@ -157,11 +179,18 @@ module Opbeat
       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)
+          get_contextlines(frame.abs_path, frame.lineno, context_lines)
       end
       frame
     end
 
+    def from_user_object(user_obj)
+      @user = {} if not @user
+      @user[:id] = user_obj.send(:id) rescue nil
+      @user[:email] = user_obj.send(:email) rescue nil
+      @user[:username] = user_obj.send(:username) rescue nil
+    end
+
     # For cross-language compat
     class << self
       alias :captionException :capture_exception
@@ -170,11 +199,17 @@ module Opbeat
 
     private
 
+    def self.merge_context(options={})
+      context_options = Thread.current["_opbeat_context"] || {}
+      context_options.merge(options)
+    end
+
+
     # Because linecache can go to hell
     def self._source_lines(path, from, to)
     end
 
-    def get_context(path, line, context)
+    def get_contextlines(path, line, context)
       lines = (2 * context + 1).times.map do |i|
         Opbeat::LineCache::getline(path, line - context + i)
       end

data/lib/opbeat/rails/middleware/debug_exceptions_catcher.rb

@@ -3,10 +3,10 @@ module Opbeat
     module Middleware
       module DebugExceptionsCatcher
         def self.included(base)
-          base.send(:alias_method_chain, :render_exception, :raven)
+          base.send(:alias_method_chain, :render_exception, :opbeat)
         end
 
-        def render_exception_with_raven(env, exception)
+        def render_exception_with_opbeat(env, exception)
           begin
             evt = Opbeat::Event.capture_rack_exception(exception, env)
             Opbeat.send(evt) if evt
@@ -14,7 +14,7 @@ module Opbeat
             ::Rails::logger.debug "Error capturing or sending exception #{$!}"
           end
 
-          render_exception_without_raven(env, exception)
+          render_exception_without_opbeat(env, exception)
         end
       end
     end

data/lib/opbeat/version.rb

@@ -1,3 +1,3 @@
 module Opbeat
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opbeat
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &16930920 !ruby/object:Gem::Requirement
+  requirement: &17054920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -25,10 +25,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *16930920
+  version_requirements: *17054920
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &16929160 !ruby/object:Gem::Requirement
+  requirement: &17054160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -36,10 +36,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *16929160
+  version_requirements: *17054160
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &16928640 !ruby/object:Gem::Requirement
+  requirement: &17053700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -47,10 +47,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16928640
+  version_requirements: *17053700
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &16927620 !ruby/object:Gem::Requirement
+  requirement: &17053240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -58,7 +58,7 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *16927620
+  version_requirements: *17053240
 description: 
 email: ron@opbeat.com
 executables: []