ratchetio 0.3.2 → 0.4.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+**0.4.0**
+ 
+    - Breaking change to make the "person" more configurable. If you were previously relying on your `current_member` method being called to return the person object, you will need to add the following line to `config/initializers/ratchetio.rb`:
+        
+        config.person_method = "current_member"
+
+    - Person id, username, and email method names are now configurable -- see README for details.

data/README.md

@@ -66,19 +66,26 @@ Ratchetio.report_message("Login successful", "info", :user => @user)
 
 ## Person tracking
 
-Ratchet will send information about the current user (called a "person" in Ratchet parlance) along with each error report, when available. This works by trying the `current_user` and `current_member` controller methods. The return value should be an object with an `id` property and, optionally, `username` and `email` properties.
+Ratchet will send information about the current user (called a "person" in Ratchet parlance) along with each error report, when available. This works by calling the `current\_user` controller method. The return value should be an object with an `id` method and, optionally, `username` and `email` methods.
 
-If you use different naming, add the following in your controller:
+If the gem should call a controller method besides `current\_user`, add the following in `config/initializers/ratchetio.rb`:
 
 ```ruby
-alias_method :my_user_method, :current_user
-helper_method :my_user_method
+  config.person_method = "my_current_user"
+```
+
+If the methods to extract the `id`, `username`, and `email` from the object returned by the `person\_method` have other names, configure like so in `config/initializers/ratchetio.rb`:
+
+```ruby
+  config.person_id_method = "user_id"  # default is "id"
+  config.person_username_method = "user_name"  # default is "username"
+  config.person_email_method = "email_address"  # default is "email"
 ```
 
 
 ## Exception level filters
 
-By default, all exceptions reported through `Ratchetio.report_exception()` are reporeted at the "error" level, except for the following, which are reported at "warning" level:
+By default, all exceptions reported through `Ratchetio.report\_exception()` are reporeted at the "error" level, except for the following, which are reported at "warning" level:
 
 - ActiveRecord::RecordNotFound
 - AbstractController::ActionNotFound
@@ -89,7 +96,7 @@ If you'd like to customize this list, see the example code in `config/initialize
 
 ## Help / Support
 
-If you run into any issues, please email me at brian@ratchet.io
+If you run into any issues, please email me at support@ratchet.io
 
 ## Contributing
 

data/lib/generators/ratchetio/templates/initializer.rb

@@ -2,6 +2,14 @@ require 'ratchetio/rails'
 Ratchetio.configure do |config|
   config.access_token = <%= access_token_expr %>
 
+  # By default, Ratchetio will try to call the `current_user` controller method
+  # to fetch the logged-in user object, and then call that object's `id`,
+  # `username`, and `email` methods to fetch those properties. To customize:
+  # config.person_method = "my_current_user"
+  # config.person_id_method = "my_id"
+  # config.person_username_method = "my_username"
+  # config.person_email_method = "my_email"
+
   # Add exception class names to the exception_level_filters hash to
   # change the level that exception is reported at. Note that if an exception
   # has already been reported and logged the level will need to be changed

data/lib/ratchetio/configuration.rb

@@ -8,6 +8,10 @@ module Ratchetio
     attr_accessor :framework
     attr_accessor :endpoint
     attr_accessor :exception_level_filters
+    attr_accessor :person_method
+    attr_accessor :person_id_method
+    attr_accessor :person_username_method
+    attr_accessor :person_email_method
 
     attr_accessor :logger
 
@@ -21,6 +25,10 @@ module Ratchetio
         'AbstractController::ActionNotFound' => 'warning',
         'ActionController::RoutingError' => 'warning'
       }
+      @person_method = "current_user"
+      @person_id_method = "id"
+      @person_username_method = "username"
+      @person_email_method = "email"
     end
 
     # allow params to be read like a hash

data/lib/ratchetio/rails/controller_methods.rb

@@ -16,17 +16,17 @@ module Ratchetio
       end
 
       def ratchetio_person_data
-        user = begin current_user rescue current_member end
+        user = send(Ratchetio.configuration.person_method)
         # include id, username, email if non-empty
-        user.attributes.select do |k, v|
-          if v.blank?
-            false
-          elsif ['id', 'username', 'email'].include? k
-            true
-          else
-            false
-          end
-        end.symbolize_keys
+        if user
+          { 
+            :id => begin user.send(Ratchetio.configuration.person_id_method) rescue nil end,
+            :username => begin user.send(Ratchetio.configuration.person_username_method) rescue nil end,
+            :email => begin user.send(Ratchetio.configuration.person_email_method) rescue nil end
+          }
+        else
+          {}
+        end
       rescue NoMethodError, NameError
         {}
       end

data/lib/ratchetio/version.rb

@@ -1,3 +1,3 @@
 module Ratchetio
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratchetio
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies: []
 description: Rails plugin to catch and send exceptions to Ratchet.io
 email:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md