metry 2.0.5 → 2.1.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 2.1.0 / 2009-08-13
+
+* Added experiment/cohort analysis.
+
 === 2.0.5 / 2009-08-09
 
 * Added missed files.

data/Manifest.txt

@@ -8,24 +8,30 @@ example/example.rb
 features/app_tracking.feature
 features/basic_tracking.feature
 features/psycho/dashboard.feature
-features/psycho/goals.feature
+features/psycho/experiments.feature
 features/psycho/visitor_tracking.feature
 features/sample_application.feature
-features/step_definitions/goals.rb
+features/step_definitions/experiments.rb
+features/step_definitions/psycho.rb
 features/step_definitions/tracking.rb
 features/step_definitions/web.rb
 features/support/env.rb
+features/support/helpers.rb
 lib/metry.rb
+lib/metry/cohort.rb
+lib/metry/event.rb
 lib/metry/experiment.rb
+lib/metry/goal.rb
 lib/metry/psycho.rb
 lib/metry/psycho/dashboard.erb
 lib/metry/psycho/edit_goal.erb
-lib/metry/psycho/goal.erb
+lib/metry/psycho/experiment.erb
 lib/metry/psycho/layout.erb
 lib/metry/psycho/new_goal.erb
 lib/metry/psycho/visitor.erb
+lib/metry/psycho/visitors.erb
 lib/metry/rack/tracking.rb
-lib/metry/storage.rb
+lib/metry/visitor.rb
 radiant/example/CHANGELOG
 radiant/example/CONTRIBUTORS
 radiant/example/INSTALL
@@ -43,11 +49,11 @@ radiant/example/config/routes.rb
 radiant/example/db/schema.rb
 radiant/example/features/metry.feature
 radiant/example/features/psycho.feature
-radiant/example/features/step_definitions/experiments.rb
 radiant/example/features/step_definitions/radiant.rb
 radiant/example/features/step_definitions/tracking.rb
 radiant/example/features/step_definitions/web.rb
 radiant/example/features/support/env.rb
+radiant/example/features/support/helpers.rb
 radiant/example/public/.htaccess
 radiant/example/public/404.html
 radiant/example/public/500.html
@@ -114,7 +120,7 @@ radiant/extension/lib/metry_tags.rb
 radiant/extension/lib/tasks/metry_extension_tasks.rake
 radiant/extension/metry_extension.rb
 test/shared.rb
-test/test_storage.rb
+test/test_experiment.rb
 vendor/webrat/.document
 vendor/webrat/History.txt
 vendor/webrat/MIT-LICENSE.txt

data/Rakefile

@@ -1,9 +1,14 @@
+ENV["RUBY_FLAGS"] = "-I#{%w(lib ext bin test).join(File::PATH_SEPARATOR)}"
+
 require 'rubygems'
 require 'hoe'
 
 Hoe.spec 'metry' do
   developer('Nathaniel Talbott', 'nathaniel@terralien.com')
   self.rubyforge_name = 'terralien'
+  extra_deps << ['mongomapper', '~> 0.3']
+  extra_deps << ['mongodb-mongo', '~> 0.10']
+  extra_deps << ['mongodb-mongo_ext', '~> 0.4']
 end
 
 require 'cucumber/rake/task'

data/TODO

@@ -1,10 +1,5 @@
-Limit visitors on dashboard to 10 most recent
-Add full listing of visitors
-Show more details about visitors
-Add referrer to event display on visitor pages
-Add display of last 10 events to dashboard
 Show goal conversion for each experiment
-Allow manually viewing a particular alternatively
+Allow manually viewing a particular alternative
 
 More unit tests
 

data/example/example.rb

@@ -18,5 +18,5 @@ get '/subpage' do
 end
 
 get '/extra' do
-  request.env["metry.event"]["extra"] = params[:track]
+  request.env["metry.event"].extra["extra"] = params[:track]
 end

data/features/app_tracking.feature

@@ -6,6 +6,5 @@ Feature: Application Tracking
   Scenario: Track an additional facet
     Given an empty tracking database
     When I view "/extra?track=stuff"
-    Then there should be a tracking event "1":
-      | key   | value |
+    Then tracking event #1 extra should contain:
       | extra | stuff |

data/features/basic_tracking.feature

@@ -20,73 +20,54 @@ Feature: Access Tracking
   Scenario: Basic request data is tracked
     When I view "/"
     And I view "/subpage"
-    Then there should be a tracking event "1":
-      | key  | value    |
+    Then tracking event #1 should contain:
       | path | /        |
-      | time | _exists_ |
-    And there should be a tracking event "2":
-      | key  | value    |
+      | created_at | _exists_ |
+    And tracking event #2 should contain:
       | path | /subpage |
-      | time | _exists_ |
+      | created_at | _exists_ |
     
   Scenario: New visitor is tracked
     When I view "/"
     And I view "/subpage"
-    Then there should be a tracking event "1":
-      | key     | value |
-      | visitor | 1     |
-    And there should be a tracking event "2":
-      | key     | value |
-      | visitor | 1     |
-    And there should be a visitor "1"
+    Then there should be a tracking event #1 with visitor #1
+    And there should be a tracking event #2 with visitor #1
+    And there should be a visitor #1
 
   Scenario: Two visitors are tracked
     Given I view "/"
     When I am a new visitor
     Given I view "/"
-    Then there should be a tracking event "1":
-      | key     | value |
-      | visitor | 1     |
-    And there should be a tracking event "2":
-      | key     | value |
-      | visitor | 2     |
+    Then there should be a tracking event #1 with visitor #1
+    Then there should be a tracking event #2 with visitor #2
     And there should be 2 visitors
-    And there should be a visitor "1"
-    And there should be a visitor "2"
       
   Scenario: All facets should be tracked
     When I view "/"
-    Then there should be a tracking event "1":
-      | key  | value       |
-      | path | /           |
-      | time | _exists_    |
-      | ip   | 127.0.0.1   |
-      | host | example.org |
+    Then tracking event #1 should contain:
+      | path | /               |
+      | created_at | _exists_        |
+      | ip   | 127.0.0.1       |
+      | host | www.example.com |
 
   Scenario: path should include query string
     When I view "/?here=there"
-    Then there should be a tracking event "1":
-      | key          | value        |
+    Then tracking event #1 should contain:
       | path | /?here=there |
       
   Scenario: Should track status codes
     When I view "/"
     And I view "/missing"
-    Then there should be a tracking event "1":
-      | key    | value |
+    Then tracking event #1 should contain:
       | status | 200   |
-    Then there should be a tracking event "2":
-      | key    | value |
+    Then tracking event #2 should contain:
       | status | 404   |
 
   Scenario: Should track method
     When I view "/"
     And I post to "/post":
-      | key   | value |
       | bogus | bogus |
-    Then there should be a tracking event "1":
-      | key    | value |
+    Then tracking event #1 should contain:
       | method | GET   |
-    Then there should be a tracking event "2":
-      | key    | value |
+    Then tracking event #2 should contain:
       | method | POST  |

data/features/psycho/dashboard.feature

@@ -2,16 +2,8 @@ Feature: Psycho Dashboard
 
   Scenario: Basics
     Given an empty tracking database
-    And I add a goal named "sweet" with path "/"
-    And I am a new visitor
-    And I view "/"
-    And I view "/subpage"
-    And I am a new visitor
-    And I view "/"
+    And I add an experiment "sweet"
     When I view "/admin/metry"
-    Then I should see "Goals"
-    And I should see "sweet: 2 visits"
-    And I should see "Recent Visitors"
-    And I should see "Visitor 1"
-    And I should see "Visitor 2"
+    Then I should see "Experiments"
+    And I should see "sweet"
     

data/features/psycho/experiments.feature

@@ -0,0 +1,28 @@
+Feature: Track Experiments
+
+  Background:
+    Given an empty tracking database
+    And I add an experiment "Fred"
+  
+  Scenario: Add a goal
+    Given I view "/admin/metry"
+    And I follow "Fred"
+    And I follow "New Goal"
+    And I fill in "name" with "Cool"
+    And I fill in "path" with "/goal"
+    And I press "Create"
+    Then I should be on the page for experiment #1
+    And I should see "Cool"
+    And I should see "Path: /goal"
+  
+  Scenario: Edit a Goal
+    Given I add a goal named "Bogus" to experiment "Fred" with path "/"
+    When I view "/admin/metry"
+    And I follow "Fred"
+    And I follow "Edit"
+    And I fill in "name" with "Right"
+    And I fill in "path" with "/subpage"
+    And I press "Save"
+    Then I should be on the page for experiment #1
+    And I should see "Right"
+    And I should see "Path: /subpage"

data/features/psycho/visitor_tracking.feature

@@ -12,8 +12,8 @@ Feature: Psycho Visitor Tracking
     And I am a new visitor
     And I view "/"
     When I view "/admin/metry"
-    Then I should see "Visitor 1"
-    And I should see "Visitor 2"
+    Then I should see visitor #1
+    And I should see visitor #2
     
   Scenario: View visitor detail
     Given I view "/"
@@ -21,7 +21,7 @@ Feature: Psycho Visitor Tracking
     And I am a new visitor
     And I view "/"
     When I view "/admin/metry"
-    And I follow "Visitor 1"
+    And I follow "Visitor"
     Then I should see "/"
     And I should see "/subpage"
     
@@ -29,4 +29,4 @@ Feature: Psycho Visitor Tracking
     Given I view "/admin/metry"
     And I view "/admin/metry"
     When I view "/admin/metry"
-    Then I should not see "Visitor 1"
+    Then I should see "0 events"

data/features/step_definitions/experiments.rb

@@ -0,0 +1,8 @@
+Given /^I add an experiment "([^\"]*)"$/ do |name|
+  Metry::Experiment.create(:name => name)
+end
+
+Given /^I add a goal named "([^\"]*)" to experiment "([^\"]*)" with path "([^\"]*)"$/ do |name, experiment, path|
+  experiment = Metry::Experiment.find(:first, :conditions => {:name => experiment})
+  experiment.goals << Metry::Goal.create(:name => name, :path => path)
+end

data/features/step_definitions/psycho.rb

@@ -0,0 +1,14 @@
+Then /^I should see visitor #(\d+)$/ do |index|
+  visitor = at(Metry::Visitor, index)
+  assert_contain "Visitor #{visitor.id}"
+end
+
+Then /^I should not see visitor #(\d+)$/ do |index|
+  visitor = at(Metry::Visitor, index)
+  assert_not_contain "Visitor #{visitor.id}"
+end
+
+Then /^I should be on the page for experiment #(\d+)$/ do |index|
+  experiment = at(Metry::Experiment, index)
+  assert_equal "/admin/metry/experiments/#{experiment.id}", current_url
+end

data/features/step_definitions/tracking.rb

@@ -1,43 +1,75 @@
 Given /^an empty tracking database$/ do
-  Metry.current.clear
+  Metry.clear
 end
 
 Then /^there should be (\d+) tracking events?$/ do |event_count|
-  assert_equal(event_count.to_i, Metry.current.event_count)
+  assert_equal(event_count.to_i, Metry::Event.count)
 end
 
 Then /^there should be (\d+) visitors$/ do |visitor_count|
-  assert_equal(visitor_count.to_i, Metry.current.visitor_count)
+  assert_equal(visitor_count.to_i, Metry::Visitor.count)
 end
 
-When /^there should be a tracking event "(\d+)":$/ do |id, table|
-  event = Metry.current.event(id)
-  assert event, "Unable to lookup event #{id}."
-  table.hashes.each do |hash|
-    expected = hash["value"]
+Then /^tracking event #(\d+) should contain:$/ do |index, table|
+  event = at(Metry::Event, index)
+  assert event, "Unable to lookup event at #{index}."
+  table.rows_hash.each do |key, expected|
     case expected
     when "_exists_"
-      assert event[hash["key"]], "Key #{hash["key"]} does not exist."
+      assert event.send(key), "Key #{key} does not exist."
     else
-      assert_equal expected, event[hash["key"]], "Key #{hash["key"]} does not match."
+      assert_equal expected, event.send(key), "Key #{key} does not match."
     end
   end
 end
 
-Then /^there should be a visitor "([^\"]*)":$/ do |id, table|
-  visitor = Metry.current.visitor(id)
-  assert visitor, "Unable to lookup visitor #{id}."
-  table.hashes.each do |hash|
-    expected = hash["value"]
-    case expected
-    when "_exists_"
-      assert visitor[hash["key"]], "Key #{hash["key"]} does not exist."
-    else
-      assert_equal expected, visitor[hash["key"]], "Key #{hash["key"]} does not match."
-    end
+Then /^tracking event #(\d+) extra should contain:$/ do |index, table|
+  event = at(Metry::Event, index)
+  table.rows_hash.each do |key, expected|
+    assert_equal expected, event.extra[key]
   end
 end
 
-Then /^there should be a visitor "([^\"]*)"$/ do |id|
-  assert Metry.current.visitor(id)
-end
+Then /^there should be a tracking event #(\d+) with visitor #(\d+)$/ do |event_index, visitor_index|
+  event = at(Metry::Event, event_index)
+  visitor = at(Metry::Visitor, visitor_index)
+  assert_equal event.visitor, visitor
+end
+
+Then /^there should be a visitor #(\d+)$/ do |index|
+  assert at(Metry::Visitor, index)
+end
+
+Then /^visitor #(\d+) should have experiment "([^\"]*)" with "([^\"]*)"$/ do |index, experiment, alternative|
+  visitor = at(Metry::Visitor, index)
+  experiment = Metry::Experiment.find(:first, :conditions => {:name => experiment})
+  assert experiment.cohort_for(visitor)
+end
+
+Then /^event #(\d+) should have experiment "([^\"]*)" with "([^\"]*)"$/ do |index, experiment, alternative|
+  event = at(Metry::Event, index)
+  experiment = Metry::Experiment.find(:first, :conditions => {:name => experiment})
+  assert_equal alternative, event.experiments[experiment.id]
+end
+
+Then /^I should see the same page (\d+) times$/ do |count|
+  expected_body = webrat.response_body
+  count.to_i.times do
+    When(%(I view "#{current_url}"))
+    assert_equal expected_body, webrat.response_body
+  end
+end
+
+When /^(\d+) visitors view "([^\"]*)"$/ do |count, path|
+  @alternatives = Hash.new(0)
+  count.to_i.times do
+    visit(path)
+    @alternatives[webrat.response_body] += 1
+    clear_cookies
+  end
+end
+
+Then /^there should be (\d+) alternatives each displayed at least (\d+) times$/ do |alternatives, minimum|
+  assert_equal alternatives.to_i, @alternatives.size
+  assert @alternatives.values.all?{|e| e >= minimum.to_i}
+end

data/features/support/env.rb

@@ -16,7 +16,6 @@ World(Webrat::Methods)
 World(Webrat::Matchers)
 
 require 'metry'
-Metry::Storage.predictable_keys = true
 
 require File.dirname(__FILE__) + '/../../example/example.rb'
 def app

data/features/support/helpers.rb

@@ -0,0 +1,6 @@
+module CucumberHelpers
+  def at(model, index)
+    model.find(:all, :order => 'created_at')[index.to_i-1]
+  end
+end
+World(CucumberHelpers)

data/lib/metry.rb

@@ -1,18 +1,25 @@
 $: << File.dirname(__FILE__)
 
-require 'metry/storage'
+require 'mongomapper'
+
+require 'metry/event'
+require 'metry/visitor'
+require 'metry/goal'
 require 'metry/rack/tracking'
 require 'metry/experiment'
+require 'metry/cohort'
 require 'metry/psycho'
 
 module Metry
-  VERSION = '2.0.5'
+  VERSION = '2.1.0'
   
   def self.init(dbname)
-    @storage = Storage.new(dbname)
+    MongoMapper.database = dbname
   end
   
-  def self.current
-    @storage
+  def self.clear
+    [Metry::Event, Metry::Visitor, Metry::Goal, Metry::Experiment].each do |m|
+      m.delete_all
+    end
   end
 end