whenauser 0.6.0 → 0.6.1

data/README.md

@@ -57,7 +57,6 @@ to your Gemfile, and add something like this to `config/whenauser.rb`:
 
 See the [girl_friday wiki](https://github.com/mperham/girl_friday/wiki) for more information on how to use girl_friday.
 
-
 Options
 -------
 
@@ -67,6 +66,7 @@ WhenAUser::Rack accepts these options:
 * `webhook_url` -- defaults to 'http://whenauser.com/events'
 * `middleware` -- takes the symbol for a middleware and a block, configuring it
 * `queue` -- takes the class used for queuing (default: WhenAUser::MemoryQueue), and an optional hash
+* `custom_data` -- this proc is passed env, and should return a hash to be merged into every event
 
 The `exceptions` middleware accepts these options:
 
@@ -74,13 +74,13 @@ The `exceptions` middleware accepts these options:
 * `ignore_exceptions` -- an array of exception class names, defaults to ['ActiveRecord::RecordNotFound', 'AbstractController::ActionNotFound', 'ActionController::RoutingError']
 * `ignore_crawlers` -- an array of strings to match against the user agent, includes a number of webcrawlers by default
 * `ignore_if` -- this proc is passed env and an exception; if it returns true, the exception is not reported to WhenAUser
-* `custom_data` -- this proc is passed env, and should return a hash to be merged into each event
+* `custom_data` -- this proc is passed env, and should return a hash to be merged into each automatically generated exception event
 
 The `pageviews` middleware accepts these options:
 
 * `ignore_crawlers` -- an array of strings to match against the user agent, includes a number of webcrawlers by default
 * `ignore_if` -- this proc is passed env; if it returns true, the pageview is not reported to WhenAUser
-* `custom_data` -- this proc is passed env, and should return a hash to be merged into each event
+* `custom_data` -- this proc is passed env, and should return a hash to be merged into each automatically generated event
 
 The WhenAUser::Pageviews middleware uses the same token as WhenAUser::Rack.
 
@@ -123,3 +123,8 @@ Use Cases
 * add a data point to a Librato graph
 * tag a user in WhenAUser, or in your CRM
 * segment a user in your email campaign tool
+
+Compatibility
+-------------
+
+This gem can be used without Rails, but when used with Rails it depends on Rails 3 (we've tested with Rails 3.1 and 3.2). If you want to use girl_friday, you must use Ruby 1.9.2 or greater, JRuby, or Rubinius.

data/lib/whenauser/exceptions.rb

@@ -30,14 +30,14 @@ module WhenAUser
         @app.call(env)
       rescue Exception => exception
         env['whenauser.exception'] = exception
-        send_event_now event(env, exception), @options[:token] unless should_be_ignored(env, exception)
+        send_event_now event(env, exception), @options[:token], env unless should_be_ignored(env, exception)
         raise exception
       end
     end
 
   private
-    def send_event_now(event, token)
-      WhenAUser.post_payload_to_token WhenAUser.prepare_event(event), token
+    def send_event_now(event, token, env)
+      WhenAUser.post_payload_to_token WhenAUser.prepare_event(event, env), token
     end
 
     def should_be_ignored(env, exception)
@@ -57,22 +57,16 @@ module WhenAUser
     end
 
     def event(env, exception)
-      request = ActionDispatch::Request.new(env)
       backtrace = clean_backtrace(exception)
       event = {
         :_actor => actor_for_exception(exception),
         :_domain => 'exception',
         :_name => exception.class.to_s,
         :message => exception.to_s,
-        :backtrace => backtrace.join("\n"),
-        :request_url => request.url,
-        :request_method => request.request_method,
-        :params => request.params.except(*WhenAUser.filter_parameters),
-        :user_agent => request.user_agent
+        :backtrace => backtrace.join("\n")
       }
-      user = current_user(env)
+      user = WhenAUser.current_user(env)
       event.merge!(:current_user => user) if user
-      event.merge!(:referer_url => request.referer) if request.referer
       event.merge!(@options[:custom_data].call(env))
       event
     end

data/lib/whenauser/helpers.rb

@@ -7,18 +7,6 @@ module WhenAUser
       false
     end
 
-    def current_user(env)
-      controller = env['action_controller.instance']
-      if current_user = controller.instance_variable_get('@current_user') || controller.instance_eval('current_user')
-        [:login, :username, :email, :id].each do |field|
-          return current_user.send(field) if current_user.respond_to?(field)
-        end
-      end
-      nil
-    rescue
-      nil
-    end
-
     def clean_backtrace(exception)
       if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
         Rails.backtrace_cleaner.send(:filter, exception.backtrace)

data/lib/whenauser/pageviews.rb

@@ -54,15 +54,9 @@ module WhenAUser
     end
 
     def event(env, request, status, duration)
-      actor = current_user(env) || 'anonymous'
       event = {
-        :_actor => actor,
         :_domain => (status >= 400) ? 'pageerror' : 'pageview',
         :_name => page_event_name(request),
-        :request_url => request.url,
-        :request_method => request.request_method,
-        :params => request.params.except(*WhenAUser.filter_parameters),
-        :user_agent => request.user_agent,
         :status => status,
         :duration => "%.2f" % (duration * 1000)
       }
@@ -70,8 +64,6 @@ module WhenAUser
         event.merge!(:error => actor_for_exception(exception))
         event.merge!(:message => exception.to_s)
       end
-      event.merge!(:referer_url => request.referer) if request.referer
-      event.merge!(:rails_env => Rails.env) if defined?(Rails)
       event.merge!(@options[:custom_data].call(env))
       event
     end

data/lib/whenauser/railtie.rb

@@ -1,6 +1,5 @@
 require 'rails/railtie'
-require 'action_view/log_subscriber'
-require 'action_controller/log_subscriber'
+require 'active_record'
 
 module Whenauser
   class RailsConfigurator
@@ -82,5 +81,12 @@ module Whenauser
         end
       end
     end
+
+    config.after_initialize do
+      ActiveSupport.on_load(:active_record) do
+        require 'whenauser/active_record_extension'
+        include ActiveRecord::WhenAUserExtension
+      end
+    end
   end
 end

data/lib/whenauser/version.rb

@@ -1,3 +1,3 @@
 module WhenAUser
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/lib/whenauser.rb

@@ -10,19 +10,21 @@ require 'logger'
 require 'active_support/core_ext/module/attribute_accessors'
 
 module WhenAUser
-  mattr_accessor :filter_parameters, :buffer, :token, :webhook_url, :queue, :queue_options, :logger
+  mattr_accessor :filter_parameters, :buffer, :token, :webhook_url, :queue, :queue_options, :custom_data, :logger
 
   def self.default_ignored_crawlers
     %w(Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg Yandex Jyxobot Huaweisymantecspider ApptusBot)
   end
 
   def self.send_event(event)
-    WhenAUser.buffer << WhenAUser.prepare_event(event)
+    logger.debug "============= #{event.inspect} ============="
+    buffer << event
   end
 
-  def self.flush
+  def self.flush(env={})
     return if (events = WhenAUser.buffer).empty?
     WhenAUser.buffer = []
+    events.each {|event| WhenAUser.prepare_event(event, env)}
     WhenAUser.queue.push(:payload => events)
     # WhenAUser.post_payload_to_token events.to_json, WhenAUser.token
   end
@@ -36,10 +38,34 @@ module WhenAUser
       http.request(req)
     end
   end
-  
-  def self.prepare_event(event)
-    event[:_timestamp] = Time.now.to_f unless event[:_timestamp] || event['_timestamp']
+
+  def self.current_user(env)
+    if controller = env['action_controller.instance']
+      if current_user = controller.instance_variable_get('@current_user') || controller.instance_eval('current_user')
+        [:login, :username, :email, :id].each do |field|
+          return current_user.send(field) if current_user.respond_to?(field)
+        end
+      end
+    end
+    nil
+  rescue
+    nil
+  end
+
+  private
+  def self.prepare_event(event, env)
+    event[:_actor] ||= current_user(env) || 'anonymous'
+    event[:_timestamp] = Time.now.to_f unless (event[:_timestamp] || event['_timestamp'])
     event[:rails_env] = Rails.env if defined?(Rails)
+    unless env.empty?
+      event[:request_url] = env['whenauser.request_url']
+      event[:request_method] = env['whenauser.request_method']
+      event[:user_agent] = env['whenauser.user_agent']
+      event[:referer_url] = env['whenauser.referer_url'] if env['whenauser.referer_url']
+    end
+    request = ActionDispatch::Request.new(env)
+    event[:params] = request.params.except(*WhenAUser.filter_parameters)
+    event.merge!(WhenAUser.custom_data.call(env))
     event
   end
 
@@ -53,13 +79,19 @@ module WhenAUser
       WhenAUser.token = options[:token]
       WhenAUser.queue = options[:queue] || WhenAUser::MemoryQueue
       WhenAUser.queue_options = options[:queue_options] || {}
+      WhenAUser.custom_data = options[:custom_data] || lambda { |env| {} }
     end
 
     def call(env)
       WhenAUser.buffer = []
+      request = ActionDispatch::Request.new(env)
+      env['whenauser.request_url'] = request.url
+      env['whenauser.request_method'] = request.request_method
+      env['whenauser.user_agent'] = request.user_agent
+      env['whenauser.referer_url'] = request.referer
       @app.call(env)
     ensure
-      WhenAUser.flush
+      WhenAUser.flush(env)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whenauser
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport