bugsnag 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 717d9f1b2304beb17e79f70136524fe05f02e836
-  data.tar.gz: ba4b7b6fe97c78d6ca8f7f627e6c696f34516451
+  metadata.gz: ea271d0d36a02d47b465c7a9fccd390cec2f447a
+  data.tar.gz: aa1f7cacb476081242d3969624ac9b52dcf613f1
 SHA512:
-  metadata.gz: 4db0b788c0c54085a2f5d45e221ed4daa33169d1846a75b51319ba416de3eef0e6e6ccbb267ef816077786028f064557204bd7025a53fb1a3dff5ffb41cd50f9
-  data.tar.gz: 1c335846a6340ff3f2c9eec2797d4a0288f3b77073221532dd6bcb5ae001af956eac3e4a7d1c511df7f0c3b2e6781e642c7da21d89c8dd129d7c46d928e0a2d3
+  metadata.gz: 920c18c4fa6679f2a0b7f9609ca542100734fd113fb4fc624d7960c32cf029d6f2b1950fab1ee0ae5bc55cbc5be7b4fc4ed05cccf20993ac06031ed47122e25a
+  data.tar.gz: 89acbdf699198a962b65c51e6935459a7310ce30581ee7f35e2963ccd799b03615b986505d768a4a6144a7b817fe3f700541250695f00bb5f77c7ad86a46c457

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 
 rvm:
+  - 2.0.0
   - 1.9.3
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
   - 1.8.7
 
 notifications:

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+1.7.0
+-----
+-   Allow users to configure app type
+-   Send severity of error to bugsnag
+-   Allo users to configure users in a structured way for search etc.
+
 1.6.5
 -----
 -   Send hostname to Bugsnag

data/README.md

@@ -87,10 +87,18 @@ class MyController < ApplicationController
 
   private
   def add_user_info_to_bugsnag(notif)
+    # Set the user that this bug affected
+    # Email, name and id are searchable on bugsnag.com
+    notif.user = {
+      email: current_user.email,
+      name: current_user.name,
+      id: current_user.id
+    }
+
     # Add some app-specific data which will be displayed on a custom
-    # "User Info" tab on each error page on bugsnag.com
-    notif.add_tab(:user_info, {
-      name: current_user.name
+    # "Diagnostics" tab on each error page on bugsnag.com
+    notif.add_tab(:diagnostics, {
+      product: current_product.name
     })
   end
 end

data/VERSION

@@ -1 +1 @@
-1.6.5
+1.7.0

data/bugsnag.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bugsnag"
-  s.version = "1.6.5"
+  s.version = "1.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Smith"]
-  s.date = "2013-12-14"
+  s.date = "2013-12-17"
   s.description = "Ruby notifier for bugsnag.com"
   s.email = "james@bugsnag.com"
   s.extra_rdoc_files = [

data/lib/bugsnag.rb

@@ -61,6 +61,8 @@ module Bugsnag
     # rescuers, unless auto notification is disabled, or we should ignore this
     # error class
     def auto_notify(exception, overrides=nil, request_data=nil)
+      overrides ||= {}
+      overrides.merge!({:severity => "fatal"})
       notify_or_ignore(exception, overrides, request_data) if configuration.auto_notify
     end
 

data/lib/bugsnag/configuration.rb

@@ -12,6 +12,7 @@ module Bugsnag
     attr_accessor :use_ssl
     attr_accessor :project_root
     attr_accessor :app_version
+    attr_accessor :app_type
     attr_accessor :params_filters
     attr_accessor :ignore_classes
     attr_accessor :ignore_user_agents

data/lib/bugsnag/middleware/warden_user.rb

@@ -1,7 +1,7 @@
 module Bugsnag::Middleware
   class WardenUser
     SCOPE_PATTERN = /^warden\.user\.([^.]+)\.key$/
-    COMMON_USER_FIELDS = [:email, :name, :first_name, :last_name, :created_at]
+    COMMON_USER_FIELDS = [:email, :name, :first_name, :last_name, :created_at, :id]
 
     def initialize(bugsnag)
       @bugsnag = bugsnag
@@ -18,33 +18,18 @@ module Bugsnag::Middleware
           # Pick the best scope for unique id (the default is "user")
           best_scope = warden_scopes.include?("user") ? "user" : warden_scopes.first
 
-          # Set the user_id
-          if best_scope
-            scope_key = "warden.user.#{best_scope}.key"
-            scope = session[scope_key]
-            if scope.is_a? Array
-              user_ids = scope.detect {|el| el.is_a? Array}
-              if user_ids
-                user_id = user_ids.first
-                notification.user_id = user_id unless user_id.nil?
-              end
-            end
-          end
-
           # Extract useful user information
-          warden_tab = {}
-          warden_scopes.each do |scope|
-            user_object = env["warden"].user({:scope => scope, :run_callbacks => false}) rescue nil
-            if user_object
-              # Build the user info for this scope
-              scope_hash = warden_tab["Warden #{scope.capitalize}"] = {}
-              COMMON_USER_FIELDS.each do |field|
-                scope_hash[field] = user_object.send(field) if user_object.respond_to?(field)
-              end
+          user = {}
+          user_object = env["warden"].user({:scope => best_scope, :run_callbacks => false}) rescue nil
+          if user_object
+            # Build the user info for this scope
+            COMMON_USER_FIELDS.each do |field|
+              user[field] = user_object.send(field) if user_object.respond_to?(field)
             end
           end
 
-          notification.add_tab(:user, warden_tab) unless warden_tab.empty?
+          # We merge the first warden scope down, so that it is the main "user" for the request
+          notification.user = user unless user.empty?
         end
       end
 

data/lib/bugsnag/notification.rb

@@ -15,12 +15,14 @@ module Bugsnag
 
     MAX_EXCEPTIONS_TO_UNWRAP = 5
 
+    SUPPORTED_SEVERITIES = ["fatal", "error", "warning", "info"]
+
     # HTTParty settings
     headers  "Content-Type" => "application/json"
     default_timeout 5
 
     attr_accessor :context
-    attr_accessor :user_id
+    attr_accessor :user
     attr_accessor :configuration
 
     class << self
@@ -52,6 +54,10 @@ module Bugsnag
       @overrides = Bugsnag::Helpers.flatten_meta_data(overrides) || {}
       @request_data = request_data
       @meta_data = {}
+      @user = {}
+      
+      self.severity = @overrides[:severity]
+      @overrides.delete :severity
 
       # Unwrap exceptions
       @exceptions = []
@@ -110,6 +116,26 @@ module Bugsnag
       @meta_data.delete(name.to_sym)
     end
 
+    def user_id=(user_id)
+      @user[:id] = user_id
+    end
+
+    def user_id
+      @user[:id]
+    end
+
+    def user=(user = {})
+      @user.merge!(user).delete_if{|k,v| v == nil}
+    end
+
+    def severity=(severity)
+      @severity = severity if SUPPORTED_SEVERITIES.include?(severity)
+    end
+
+    def severity
+      @severity || "error"
+    end
+
     # Deliver this notification to bugsnag.com Also runs through the middleware as required.
     def deliver
       return unless @configuration.should_notify?
@@ -142,7 +168,7 @@ module Bugsnag
           end
         end
 
-        [:user_id, :context].each do |symbol|
+        [:user_id, :context, :user].each do |symbol|
           if @overrides[symbol]
             self.send("#{symbol}=", @overrides[symbol])
             @overrides.delete symbol
@@ -155,11 +181,15 @@ module Bugsnag
 
         # Build the payload's exception event
         payload_event = {
-          :releaseStage => @configuration.release_stage,
-          :appVersion => @configuration.app_version,
+          :app => {
+            :version => @configuration.app_version,
+            :releaseStage => @configuration.release_stage,
+            :type => @configuration.app_type
+          },
           :context => self.context,
-          :userId => self.user_id,
+          :user => @user,
           :exceptions => exception_list,
+          :severity => self.severity,
           :metaData => Bugsnag::Helpers.cleanup_obj(generate_meta_data(@exceptions, @overrides), @configuration.params_filters)
         }.reject {|k,v| v.nil? }
 

data/spec/middleware_spec.rb

@@ -41,6 +41,26 @@ describe Bugsnag::MiddlewareStack do
     Bugsnag.notify(BugsnagTestException.new("It crashed"))
     callback_run_count.should be == 1
   end
+
+  it "should run before_bugsnag_notify callbacks, setting the user" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:user].should_not be_nil
+      event[:user][:id].should be == "here"
+      event[:user][:email].should be == "also here"
+      event[:user][:name].should be == "also here too"
+      event[:user][:random_key].should be == "also here too too"
+    end
+    
+    callback_run_count = 0
+    Bugsnag.before_notify_callbacks << lambda {|notif|
+      notif.user = {:id => "here", :email => "also here", :name => "also here too", :random_key => "also here too too"}
+      callback_run_count += 1
+    }
+
+    Bugsnag.notify(BugsnagTestException.new("It crashed"))
+    callback_run_count.should be == 1
+  end
   
   it "overrides should override data set in before_notify" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|

data/spec/notification_spec.rb

@@ -144,7 +144,7 @@ describe Bugsnag::Notification do
   it "should accept user_id from an exception that mixes in Bugsnag::MetaData" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
-      event[:userId].should be == "exception_user_id"
+      event[:user][:id].should be == "exception_user_id"
     end
 
     exception = BugsnagTestExceptionWithMetaData.new("It crashed")
@@ -156,7 +156,7 @@ describe Bugsnag::Notification do
   it "should accept user_id from an exception that mixes in Bugsnag::MetaData, but override using the overrides" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
-      event[:userId].should be == "override_user_id"
+      event[:user][:id].should be == "override_user_id"
     end
 
     exception = BugsnagTestExceptionWithMetaData.new("It crashed")
@@ -224,6 +224,46 @@ describe Bugsnag::Notification do
     })
   end
 
+  it "should accept a severity in overrides" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:severity].should be == "info"
+    end
+
+    Bugsnag.notify(BugsnagTestException.new("It crashed"), {
+      :severity => "info"
+    })
+  end
+
+  it "should default to error severity" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:severity].should be == "error"
+    end
+
+    Bugsnag.notify(BugsnagTestException.new("It crashed"))
+  end
+
+  it "should not accept a bad severity in overrides" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:severity].should be == "error"
+    end
+
+    Bugsnag.notify(BugsnagTestException.new("It crashed"), {
+      :severity => "infffo"
+    })
+  end
+
+  it "should autonotify fatal errors" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:severity].should be == "fatal"
+    end
+
+    Bugsnag.auto_notify(BugsnagTestException.new("It crashed"))
+  end
+
   it "should accept a context in overrides" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
@@ -238,7 +278,7 @@ describe Bugsnag::Notification do
   it "should accept a user_id in overrides" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
-      event[:userId].should be == "test_user"
+      event[:user][:id].should be == "test_user"
     end
 
     Bugsnag.notify(BugsnagTestException.new("It crashed"), {
@@ -263,7 +303,7 @@ describe Bugsnag::Notification do
 
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
-      event[:releaseStage].should be == "production"
+      event[:app][:releaseStage].should be == "production"
     end
 
     Bugsnag.auto_notify(BugsnagTestException.new("It crashed"))
@@ -347,7 +387,7 @@ describe Bugsnag::Notification do
   it "should add app_version to the payload if it is set" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
-      event[:appVersion].should be == "1.1.1"
+      event[:app][:version].should be == "1.1.1"
     end
 
     Bugsnag.configuration.app_version = "1.1.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.7.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json