ffmike-user_event_logger 0.4.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,61 @@
+UserEventLogger
+===============
+
+This plugin is extracted from several applications where I had similar problems:
+tracking various things that users did within the application. For example, I've
+used this to be able to log outgoing clicks without hooking up an analytics package,
+to count the number of times an ad was displayed, or to keep track of how often
+a particular page was visited.
+
+To use the plugin, you must first create the table that it uses:
+
+./script/generate user_event_logger add_event_table
+rake db:migrate
+
+After that, you can add information to the table from either your controllers or
+your views:
+
+log_user_event "In controller", "http://example.com", "27"
+<%= log_user_event "In view", "http://example.com", "27" %>
+
+The first argument is the event name, which is required. The second is the
+destination URL, which is optional. The third is arbitrary extra data, which is
+optional. The extra data is stored in a text column, so you can add as much
+as you want here.
+
+Reporting is left as an exercise for the user. The events table has these columns:
+
+create_table :events do |t|
+  t.column  :source_url, :string
+  t.column  :destination_url, :string
+  t.column  :remote_ip, :string
+  t.column  :logged_at, :datetime
+  t.column  :extra_data, :text
+  t.column  :event_type, :string
+end
+
+Example
+=======
+
+To do outgoing link tracking, you can set up a controller method similar to this one:
+
+def send_to 
+    @advertiser = Advertiser.find(params[:id])
+    destination_url = @advertiser.website.sub(/^www/, "http://www")
+    log_user_event "Clicked through", destination_url, params[:id]
+    redirect_to destination_url
+end 
+
+Gem installation
+================
+If you are running rails 2.1 or above you can choose between a standard plugin install and a gem install. To
+install as a gem, add this to your environment.rb file:
+    
+    config.gem 'ffmike-user_event_logger', :source => 'http://gems.github.com'
+    
+and then run:
+
+    rake gems:install
+
+
+Copyright (c) 2008 Michael A. Gunderloy, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the user_event_logger plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the user_event_logger plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UserEventLogger'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/user_event_logger/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Create a migration that adds the user event logging table to the project
+
+Example:
+    ./script/generate user_event_logger add_event_table
+
+This will create:
+    db/migrate/TIMESTAMP_add_event_table
+
+You will then need to run rake db:migrate to add the table to the database

data/generators/user_event_logger/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :events do |t|
+      t.column  :source_url, :string
+      t.column  :destination_url, :string
+      t.column  :remote_ip, :string
+      t.column  :logged_at, :datetime
+      t.column  :extra_data, :text
+      t.column  :event_type, :string
+    end
+  end
+
+  def self.down
+    drop_table :events
+  end
+end

data/generators/user_event_logger/user_event_logger_generator.rb

@@ -0,0 +1,7 @@
+class UserEventLoggerGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => name
+    end
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/models/event.rb

@@ -0,0 +1,2 @@
+class Event < ActiveRecord::Base
+end

data/lib/user_event_logger.rb

@@ -0,0 +1,12 @@
+module UserEventLogger
+  module UserEventLoggerMixin
+    def log_user_event(name, destination_url = nil, extra_data = nil)
+      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)
+    end
+  end
+end

data/lib/view_helpers.rb

@@ -0,0 +1,15 @@
+module UserEventLogger
+  module UserEventLoggerViewHelper
+    def log_user_event(name, destination_url = nil, extra_data = nil)
+      returning "" do |result|
+        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
+        )
+      end
+    end
+  end
+end

data/tasks/user_event_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :user_event_logger do
+#   # Task goes here
+# end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: user_event_logger_plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: user_event_logger_plugin.sqlite3.db
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: user_event_logger_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: user_event_logger_plugin_test

data/test/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define(:version => 0) do
+    
+  create_table "events", :force => true do |t|
+    t.string   "source_url"
+    t.string   "destination_url"
+    t.string   "remote_ip"
+    t.datetime "logged_at"
+    t.text     "extra_data"
+    t.string   "event_type"
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+db_adapter = ENV['DB']
+
+# no db passed, try one of these fine config-free DBs before bombing. 
+db_adapter ||= begin 
+  require 'rubygems' 
+  require 'sqlite'
+  'sqlite' 
+  rescue MissingSourceFile 
+    begin 
+    require 'sqlite3' 
+    'sqlite3' 
+    rescue MissingSourceFile 
+  end 
+end
+
+if db_adapter.nil?
+  raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3." 
+end
+
+ActiveRecord::Base.establish_connection(config[db_adapter])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+require File.dirname(__FILE__) + '/../init.rb'
+

data/test/user_event_logger_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+class UserEventLoggerTest < Test::Unit::TestCase
+  def setup
+    @controller = ActionController::Base.new
+    r = mock('request')
+    r.stubs(:path).returns("the path")
+    r.stubs(:remote_ip).returns("the remote IP")
+    @controller.stubs(:request).returns(r)
+  end
+  
+  def get_last_event
+    Event.find(:first, :order => "id DESC")
+  end
+  
+  def test_log_user_event
+    @controller.log_user_event "the name", "the destination URL", "the extra data"
+    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
+  end
+
+  def test_log_user_event_with_defaults
+    @controller.log_user_event "the name"
+    e = get_last_event
+    assert_equal "the path", e.source_url
+    assert_equal nil, e.destination_url
+    assert_equal "the name", e.event_type
+    assert_equal "the remote IP", e.remote_ip
+    assert_equal nil, e.extra_data
+    assert_equal "the name", e.event_type
+  end
+end
+

data/test/view_helpers_test.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require File.dirname(__FILE__) + '/test_helper.rb'
+#include UserEventLogger::UserEventLoggerViewHelper
+
+class ViewHelpersTest < Test::Unit::TestCase
+  def setup
+    @view = ActionView::Base.new
+    r = mock('request')
+    r.stubs(:path).returns("the path")
+    r.stubs(:remote_ip).returns("the remote IP")
+    @view.stubs(:request).returns(r)
+  end
+  
+  def get_last_event
+    Event.find(:first, :order => "id DESC")
+  end
+  
+  def test_log_user_event
+    @view.log_user_event "the name", "the destination URL", "the extra data"
+    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
+  end
+
+  def test_log_user_event_with_defaults
+    @view.log_user_event "the name"
+    e = get_last_event
+    assert_equal "the path", e.source_url
+    assert_equal nil, e.destination_url
+    assert_equal "the name", e.event_type
+    assert_equal "the remote IP", e.remote_ip
+    assert_equal nil, e.extra_data
+    assert_equal "the name", e.event_type
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: ffmike-user_event_logger
+version: !ruby/object:Gem::Version 
+  version: 0.4.1
+platform: ruby
+authors: 
+- Mike Gunderloy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: User Event Logger provides a simple interface for tracking user actions such as outbound clicks.
+email: MikeG1@larkfarm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- generators/user_event_logger
+- generators/user_event_logger/templates
+- generators/user_event_logger/templates/migration.rb
+- generators/user_event_logger/USAGE
+- generators/user_event_logger/user_event_logger_generator.rb
+- init.rb
+- install.rb
+- lib/models/event.rb
+- lib/user_event_logger.rb
+- lib/view_helpers.rb
+- tasks/user_event_logger_tasks.rake
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+- test/user_event_logger_test.rb
+- test/view_helpers_test.rb
+- uninstall.rb
+has_rdoc: false
+homepage: http://github.com/ffmike/user_event_logger
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple user-triggered event tracking for Rails
+test_files: []
+