raygun4ruby 0.0.6 → 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 364f723004d0b0a022bb82d74551e274466cd296
+  data.tar.gz: 2a403d1dc79b9ea1c580e4f232284769894a3eaf
+SHA512:
+  metadata.gz: a7597177c7877ca08356ded80ba631e437b173b1e3fa9409458e564c4b5174a0aa5b35156d4e8dabe7d5aefc991e790b4c4da23553248f6c52dc3af6483a296b
+  data.tar.gz: 57f578a39ae59d7ef0dc1c275b945b86b4b23e26bf51f5cb41a60ba30eac727dac4956e38f68b3aa255669c578a1dba8be2864c5930fb6bb462311faa9ea68f8

data/README.md

@@ -62,6 +62,19 @@ end
 
 (You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html))
 
+###Custom User Data
+Custom data can be added to `track_exception` by passing a custom_data key in the second parameter hash.
+
+```ruby
+
+begin
+  # more lovely code
+rescue Exception => e
+  Raygun.track_exception(e, custom_data: {my: 'custom data', goes: 'here'})
+end
+
+```
+
 ###Ignoring Some Errors
 
 You can ignore certain types of Exception using the `ignore` option in the setup block, like so:
@@ -75,6 +88,40 @@ end
 
 You can also check which [exceptions are ignored by default](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb#L26)
 
+###Affected User Tracking
+
+Raygun can now track how many users have been affected by an error.
+
+By default, Raygun looks for a method called `current_user` on your controller, and calls either `email`, `username` or `id` on the object returned by that method. 
+
+You can customize those method names in your configuration block:
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "MY_SWEET_API_KEY"
+  config.affected_user_method = :my_current_user # `current_user` by default
+  config.affected_user_identifier_methods << :login # `[ :email, :username, :id ]` by default - will use the first that works
+end
+```
+
+If you're using Rails, most authentication systems will have this method set and you should be good to go.
+
+The count of unique affected users will appear on the error group in the Raygun dashboard. If your user has an `email` method, and that email has a Gravatars associated, you will also see your user's avatar. 
+
+If you wish to keep it anonymous, you could set this identifier to something like `SecureRandom.uuid` and store that in a cookie, like so:
+
+```ruby
+class ApplicationController < ActionController::Base
+ 
+  def raygun_user
+    cookies.permanent[:raygun_user_identifier] ||= SecureRandom.uuid
+  end
+
+end
+```
+
+(Remember to set `affected_user_method` to `:raygun_user` in your config block...)
+
 ###Resque Error Tracking
 
 Raygun4Ruby also includes a Resque failure backend. You should include it inside your Resque initializer (usually something like `config/initializers/load_resque.rb`)

data/lib/raygun/client.rb

@@ -58,6 +58,14 @@ module Raygun
         Raygun.configuration.version
       end
 
+      def user_information(env)
+        env["raygun.affected_user"]
+      end
+
+      def affected_user_present?(env)
+        !!env["raygun.affected_user"]
+      end
+
       def request_information(env)
         return {} if env.nil? || env.empty?
 
@@ -65,7 +73,7 @@ module Raygun
           hostName:    env["SERVER_NAME"],
           url:         env["PATH_INFO"],
           httpMethod:  env["REQUEST_METHOD"],
-          ipAddress:   env["REMOTE_ADDR"],
+          iPAddress:   env["REMOTE_ADDR"],
           queryString: Rack::Utils.parse_nested_query(env["QUERY_STRING"]),
           form:        form_data(env),
           headers:     headers(env),
@@ -74,11 +82,19 @@ module Raygun
       end
 
       def headers(rack_env)
-        rack_env.select do |k, v|
-          k.to_s.start_with?("HTTP_")
+        rack_env.select { |k, v| k.to_s.start_with?("HTTP_") }.inject({}) do |hsh, (k, v)|
+          hsh[normalize_raygun_header_key(k)] = v
+          hsh
         end
       end
 
+      def normalize_raygun_header_key(key)
+        key.sub(/^HTTP_/, '')
+           .sub(/_/, ' ')
+           .split.map(&:capitalize).join(' ')
+           .sub(/ /, '-')
+      end
+
       def form_data(rack_env)
         request = Rack::Request.new(rack_env)
 
@@ -91,16 +107,20 @@ module Raygun
       def build_payload_hash(exception_instance, env = {})
         custom_data = env.delete(:custom_data) || {}
 
-        {
-          occurredOn: Time.now.utc.iso8601,
-          details: {
+        error_details = {
             machineName:    hostname,
             version:        version,
             client:         client_details,
             error:          error_details(exception_instance),
             userCustomData: Raygun.configuration.custom_data.merge(custom_data),
             request:        request_information(env)
-          }
+        }
+
+        error_details.merge!(user: user_information(env)) if affected_user_present?(env)
+
+        {
+          occurredOn: Time.now.utc.iso8601,
+          details:    error_details
         }
       end
 

data/lib/raygun/configuration.rb

@@ -22,6 +22,12 @@ module Raygun
     # Failsafe logger (for exceptions that happen when we're attempting to report exceptions)
     attr_accessor :failsafe_logger
 
+    # Which controller method should we call to find out the affected user?
+    attr_accessor :affected_user_method
+
+    # Which methods should we try on the affected user object in order to get an identifier
+    attr_accessor :affected_user_identifier_methods
+
     # Exception classes to ignore by default
     IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
                       'ActionController::RoutingError',
@@ -33,9 +39,11 @@ module Raygun
 
     def initialize
       # set default attribute values
-      @ignore            = IGNORE_DEFAULT
-      @custom_data       = {}
-      @silence_reporting = false
+      @ignore                           = IGNORE_DEFAULT
+      @custom_data                      = {}
+      @silence_reporting                = nil
+      @affected_user_method             = :current_user
+      @affected_user_identifier_methods = [ :email, :username, :id ]
     end
 
     def [](key)

data/lib/raygun/middleware/rack_exception_interceptor.rb

@@ -0,0 +1,18 @@
+module Raygun
+  module Middleware
+    class RackExceptionInterceptor
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        response = @app.call(env)
+      rescue Exception => exception
+        Raygun.track_exception(exception, env)
+        raise exception
+      end
+
+    end
+  end
+end

data/lib/raygun/middleware/rails_insert_affected_user.rb

@@ -0,0 +1,32 @@
+module Raygun
+  module Middleware
+    # Adapted from the Rollbar approach https://github.com/rollbar/rollbar-gem/blob/master/lib/rollbar/middleware/rails/rollbar_request_store.rb
+    class RailsInsertAffectedUser
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        response = @app.call(env)
+      rescue Exception => exception
+        if (controller = env["action_controller.instance"]) && controller.respond_to?(Raygun.configuration.affected_user_method)
+          user = controller.send(Raygun.configuration.affected_user_method)
+
+          if user
+            identifier = if (m = Raygun.configuration.affected_user_identifier_methods.detect { |m| user.respond_to?(m) })
+              user.send(m)
+            else
+              user
+            end
+
+            env["raygun.affected_user"] = { :identifier => identifier }
+          end
+          
+        end
+        raise exception
+      end
+
+    end
+  end
+end

data/lib/raygun/railtie.rb

@@ -11,12 +11,16 @@ class Raygun::Railtie < Rails::Railtie
       "ActionDispatch::ShowExceptions"
     end
 
-    app.config.middleware.insert_after middleware, "Raygun::RackExceptionInterceptor"
+    app.config.middleware.insert_after middleware, "Raygun::Middleware::RackExceptionInterceptor"
+
+    # Affected User tracking
+    require "raygun/middleware/rails_insert_affected_user"
+    app.config.middleware.insert_after Raygun::Middleware::RackExceptionInterceptor, "Raygun::Middleware::RailsInsertAffectedUser"
   end
 
   config.to_prepare do
-    Raygun.configuration.logger            ||= Rails.logger
-    Raygun.configuration.silence_reporting ||= !Rails.env.production?
+    Raygun.configuration.logger          ||= Rails.logger
+    Raygun.configuration.silence_reporting = !Rails.env.production? if Raygun.configuration.silence_reporting.nil?
   end
 
   rake_tasks do

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "0.0.6"
+  VERSION = "0.0.9"
 end

data/lib/raygun.rb

@@ -10,7 +10,7 @@ require "rack"
 require "raygun/version"
 require "raygun/configuration"
 require "raygun/client"
-require "raygun/rack_exception_interceptor"
+require "raygun/middleware/rack_exception_interceptor"
 require "raygun/testable"
 require "raygun/railtie" if defined?(Rails)
 
@@ -69,7 +69,7 @@ module Raygun
 
       def should_report?(exception)
         return false if configuration.silence_reporting
-        return false if configuration.ignore.include?(exception.class.to_s)
+        return false if configuration.ignore.flatten.include?(exception.class.to_s)
         true
       end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.9
 platform: ruby
 authors:
 - Mindscape
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,71 +28,62 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -103,7 +91,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,23 +98,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -135,7 +119,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -143,17 +126,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby Adapter for Raygun.io
@@ -166,7 +147,8 @@ files:
 - lib/raygun.rb
 - lib/raygun/client.rb
 - lib/raygun/configuration.rb
-- lib/raygun/rack_exception_interceptor.rb
+- lib/raygun/middleware/rack_exception_interceptor.rb
+- lib/raygun/middleware/rails_insert_affected_user.rb
 - lib/raygun/railtie.rb
 - lib/raygun/version.rb
 - lib/raygun4ruby.rb
@@ -178,27 +160,26 @@ files:
 homepage: http://raygun.io
 licenses:
 - MIT
+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: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: This gem provides support for Ruby and Ruby on Rails for the Raygun.io error
   reporter
 test_files: []

data/lib/raygun/rack_exception_interceptor.rb

@@ -1,16 +0,0 @@
-module Raygun
-  class RackExceptionInterceptor
-
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      response = @app.call(env)
-    rescue Exception => exception
-      Raygun.track_exception(exception, env)
-      raise exception
-    end
-
-  end
-end