raygun4ruby 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff2e858a57edda6f5d225855e17ab54988203d8c
-  data.tar.gz: 30844792347a2415d14596d9c6a81fff79ea0b81
+  metadata.gz: 30c96f5c697418070d9887e7bd698f3d560c50ea
+  data.tar.gz: 3320b9b575ddbc04a06e61b26bb848b30d4e4c7e
 SHA512:
-  metadata.gz: 4874e0568ff22d99fa5caf329b7edd5d222c5e1bfec57c89210055633e5fbe07024915e147c1e24501603f1d1b4d29e0698632f4909ddd6e6fb677e06710c85d
-  data.tar.gz: f0006b1a6634515963ad336505f65741f13c4a078bd30849d5b101464395b5a1f55d653084e9441e85d2ef4deb0902d1331c26dc74bc4292e7134cbb7d30a3a4
+  metadata.gz: ef94e8d1e90c14929c84b5d13bfa3ecd868379c422113f94b0116f109273a5c2c97182001e2eb52bc9f4898233df4420d4ab28fa14cf77acfed34273fa5f01d6
+  data.tar.gz: ebf0bd808d57af7b29fac0326f8b79b380461bede714f9db014845b8dbf78933f354559a31d8158e6a18c831667689a0960180b3776e8232425ab7abedea071e

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## 2.3.0 (09/05/2017)
+## 2.4.0 (31/07/2017)
+
+Features
+  - Add functionality to track affected user in Sidekiq jobs, refer to the README for more information, under the "Affected User Tracking in Sidekiq" heading ([#121](https://github.com/MindscapeHQ/raygun4ruby/pull/121))
+## 2.3.0 (09/05/2017)"
 
 Bugfixes
   - Fix issue preventing affected users for a crash report from showing up in the affected users page ([#119](https://github.com/MindscapeHQ/raygun4ruby/pull/119))

data/README.md

@@ -352,6 +352,32 @@ Raygun4Ruby can track errors from Sidekiq (2.x or 3+). All you need to do is add
 
 Either in your Raygun initializer or wherever else takes your fancy :)
 
+#### Affected User Tracking in Sidekiq
+
+To track affected users, define a class method on your worker class that returns a user object.
+Make sure the name of this method is the same as whatever you have defined as the `affected_user_method` in your Raygun configuration and that it returns an object that fits the mappings defined in `affected_user_mapping`
+If you have not changed these, refer to [Affected user tracking](#affected-user-tracking) for the defaults
+
+```ruby
+class FailingWorker
+  include Sidekiq::Worker
+
+  def perform(arg1, arg2)
+  end
+
+  # Your method must accept an array of arguments
+  # These will be the same as those passed to `perform`
+  def self.current_user(args)
+    arg1 = args[0]
+    arg2 = args[1]
+
+    user = User.find_by(name: arg1)
+
+    # Your method must return a user object
+    user
+  end
+```
+
 ### Other Configuration options
 
 For a complete list of configuration options see the [configuration.rb](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb) file

data/lib/raygun/sidekiq.rb

@@ -19,12 +19,38 @@ module Raygun
 
   class SidekiqReporter
     def self.call(exception, context_hash)
-      ::Raygun.track_exception(exception,
-          custom_data: {
-            sidekiq_context: context_hash
-          }
+      user = affected_user(context_hash)
+      data =  {
+        custom_data: {
+          sidekiq_context: context_hash
+        }
+      }
+      ::Raygun.track_exception(
+          exception,
+          data,
+          user
         )
     end
+
+    # Extracts affected user information out of a Sidekiq worker class
+    def self.affected_user(context_hash)
+      job = context_hash[:job]
+
+      return if job.nil? || job['class'].nil? || !Module.const_defined?(job['class'])
+
+      worker_class = Module.const_get(job['class'])
+      affected_user_method = Raygun.configuration.affected_user_method
+
+      return if worker_class.nil? || !worker_class.respond_to?(affected_user_method)
+
+      worker_class.send(affected_user_method, job['args'])
+    rescue => e
+      return unless Raygun.configuration.failsafe_logger
+
+      failsafe_log("Problem in sidekiq affected user tracking: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
+
+      nil
+    end
   end
 end
 
@@ -38,4 +64,4 @@ else
   Sidekiq.configure_server do |config|
     config.error_handlers << Raygun::SidekiqReporter
   end
-end
+end

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2017-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty