@@ -46,6 +46,15 @@ def send_to redirect_to destination_url end +Extra columns +============= +You can add extra application-specific columns to the events table if you like. To do so, modify +the migration to include the columns after you run the add_event_table rake task and before you +run the migration. Then you can pass a hash of extra options as part of the call to log_user_event: + +log_user_event "In controller", "http://example.com", "27", {:user_id => 13, :product_id => 7} +<%= log_user_event "In view", "http://example.com", "27", {:user_id => 13, :product_id => 7} %> + Gem installation ================ If you are running rails 2.1 or above you can choose between a standard plugin install and a gem install. To README @@ -1,12 +1,18 @@ module UserEventLogger module UserEventLoggerMixin - def log_user_event(name, destination_url = nil, extra_data = nil) + def log_user_event(name, destination_url = nil, extra_data = nil, options = {}) event = Event.create(:source_url => request.path, :destination_url => destination_url, :remote_ip => request.remote_ip, :logged_at => Time.now, :extra_data => extra_data, :event_type => name) + if !options.empty? + options.each do |key, value| + event.send("#{key.to_s}=", value) + end + event.save! + end end end end lib/user_event_logger.rb @@ -1,6 +1,6 @@ module UserEventLogger module UserEventLoggerViewHelper - def log_user_event(name, destination_url = nil, extra_data = nil) + def log_user_event(name, destination_url = nil, extra_data = nil, options = {}) returning "" do |result| event = Event.create(:source_url => request.path, :destination_url => destination_url, @@ -9,6 +9,12 @@ module UserEventLogger :extra_data => extra_data, :event_type => name ) + if !options.empty? + options.each do |key, value| + event.send("#{key.to_s}=", value) + end + event.save! + end end end end lib/view_helpers.rb @@ -7,6 +7,7 @@ ActiveRecord::Schema.define(:version => 0) do t.datetime "logged_at" t.text "extra_data" t.string "event_type" + t.string "extra_option" end end test/schema.rb @@ -37,5 +37,18 @@ class UserEventLoggerTest < Test::Unit::TestCase assert_equal nil, e.extra_data assert_equal "the name", e.event_type end + + def test_log_user_event_with_extra_option + @controller.log_user_event "the name", "the destination URL", "the extra data", {:extra_option => "the extra option"} + e = get_last_event + assert_equal "the path", e.source_url + assert_equal "the destination URL", e.destination_url + assert_equal "the name", e.event_type + assert_equal "the remote IP", e.remote_ip + assert_equal "the extra data", e.extra_data + assert_equal "the name", e.event_type + assert_equal "the extra option", e.extra_option + end + end test/user_event_logger_test.rb @@ -38,4 +38,17 @@ class ViewHelpersTest < Test::Unit::TestCase assert_equal nil, e.extra_data assert_equal "the name", e.event_type end + + def test_log_user_event_with_extra_option + @view.log_user_event "the name", "the destination URL", "the extra data", {:extra_option => "the extra option"} + e = get_last_event + assert_equal "the path", e.source_url + assert_equal "the destination URL", e.destination_url + assert_equal "the name", e.event_type + assert_equal "the remote IP", e.remote_ip + assert_equal "the extra data", e.extra_data + assert_equal "the name", e.event_type + assert_equal "the extra option", e.extra_option + end + end \ No newline at end of file test/view_helpers_test.rb @@ -1,7 +1,7 @@ Gem::Specification.new do |s| s.name = "user_event_logger" - s.version = "0.4.2" - s.date = "2008-08-28" + s.version = "0.4.3" + s.date = "2008-09-07" s.summary = "Simple user-triggered event tracking for Rails" s.email = "MikeG1@larkfarm.com" s.homepage = "http://github.com/ffmike/user_event_logger" user_event_logger.gemspec 18d7cd72fc13605edd682d345f685547fe3e0b67 Mike Gunderloy MikeG1@larkfarm.com http://github.com/ffmike/user_event_logger/commit/6f0573d6a53f25abb40e223535f7f7816de5299b 6f0573d6a53f25abb40e223535f7f7816de5299b 2008-09-07T09:29:45-07:00 2008-09-07T09:29:45-07:00 Added ability to handle extra columns in the events table. 8b2151a5c1ef56aae396b6fae86f97217d246d92 Mike Gunderloy MikeG1@larkfarm.com