metry 1.2.0 → 2.0.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 2.0.0 / 2009-08-07
+
+* Switched to MongoDB for persistence.
+* Added basic goal support to Psycho.
+* Ignored events generated by Psycho.
+
 === 1.2.0 / 2009-07-30
 
 * Added Psycho for viewing Metry results.

data/Manifest.txt

@@ -3,18 +3,27 @@ Manifest.txt
 README.txt
 Rakefile
 TODO
+cucumber.yml
 example/example.rb
 features/app_tracking.feature
 features/basic_tracking.feature
+features/psycho/dashboard.feature
+features/psycho/goals.feature
+features/psycho/visitor_tracking.feature
 features/sample_application.feature
+features/step_definitions/goals.rb
 features/step_definitions/tracking.rb
 features/step_definitions/web.rb
 features/support/env.rb
 lib/metry.rb
 lib/metry/experiment.rb
-lib/metry/memory.rb
+lib/metry/psycho.rb
+lib/metry/psycho/dashboard.erb
+lib/metry/psycho/layout.erb
+lib/metry/psycho/new_goal.erb
+lib/metry/psycho/visitor.erb
 lib/metry/rack/tracking.rb
-lib/metry/tokyo.rb
+lib/metry/storage.rb
 radiant/example/CHANGELOG
 radiant/example/CONTRIBUTORS
 radiant/example/INSTALL
@@ -31,6 +40,7 @@ radiant/example/config/environments/test.rb
 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
@@ -97,77 +107,12 @@ radiant/example/script/spec_server
 radiant/example/script/version
 radiant/extension/README
 radiant/extension/Rakefile
+radiant/extension/lib/metry_authenticator.rb
 radiant/extension/lib/metry_tags.rb
 radiant/extension/lib/tasks/metry_extension_tasks.rake
 radiant/extension/metry_extension.rb
 test/shared.rb
-test/test_tokyo.rb
-vendor/rufus-tokyo/CHANGELOG.txt
-vendor/rufus-tokyo/CREDITS.txt
-vendor/rufus-tokyo/LICENSE.txt
-vendor/rufus-tokyo/README.txt
-vendor/rufus-tokyo/Rakefile
-vendor/rufus-tokyo/TODO.txt
-vendor/rufus-tokyo/doc/decision_table.numbers
-vendor/rufus-tokyo/doc/rdoc-style.css
-vendor/rufus-tokyo/lib/rufus-edo.rb
-vendor/rufus-tokyo/lib/rufus-tokyo.rb
-vendor/rufus-tokyo/lib/rufus/edo.rb
-vendor/rufus-tokyo/lib/rufus/edo/README.txt
-vendor/rufus-tokyo/lib/rufus/edo/cabcore.rb
-vendor/rufus-tokyo/lib/rufus/edo/cabinet/abstract.rb
-vendor/rufus-tokyo/lib/rufus/edo/cabinet/table.rb
-vendor/rufus-tokyo/lib/rufus/edo/error.rb
-vendor/rufus-tokyo/lib/rufus/edo/ntyrant.rb
-vendor/rufus-tokyo/lib/rufus/edo/ntyrant/abstract.rb
-vendor/rufus-tokyo/lib/rufus/edo/ntyrant/table.rb
-vendor/rufus-tokyo/lib/rufus/edo/tabcore.rb
-vendor/rufus-tokyo/lib/rufus/tokyo.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/cabinet/abstract.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/cabinet/lib.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/cabinet/table.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/cabinet/util.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/config.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/dystopia.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/dystopia/lib.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/dystopia/words.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/hmethods.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/query.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/transactions.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/ttcommons.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/tyrant.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/tyrant/abstract.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/tyrant/lib.rb
-vendor/rufus-tokyo/lib/rufus/tokyo/tyrant/table.rb
-vendor/rufus-tokyo/rufus-tokyo.gemspec
-vendor/rufus-tokyo/spec/cabinet_spec.rb
-vendor/rufus-tokyo/spec/cabinetconfig_spec.rb
-vendor/rufus-tokyo/spec/edo_cabinet_spec.rb
-vendor/rufus-tokyo/spec/edo_ntyrant_spec.rb
-vendor/rufus-tokyo/spec/edo_ntyrant_table_spec.rb
-vendor/rufus-tokyo/spec/edo_table_spec.rb
-vendor/rufus-tokyo/spec/hmethods_spec.rb
-vendor/rufus-tokyo/spec/incr.lua
-vendor/rufus-tokyo/spec/spec.rb
-vendor/rufus-tokyo/spec/spec_base.rb
-vendor/rufus-tokyo/spec/start_tyrants.sh
-vendor/rufus-tokyo/spec/stop_tyrants.sh
-vendor/rufus-tokyo/spec/table_spec.rb
-vendor/rufus-tokyo/spec/tyrant_spec.rb
-vendor/rufus-tokyo/spec/tyrant_table_spec.rb
-vendor/rufus-tokyo/spec/util_list_spec.rb
-vendor/rufus-tokyo/spec/util_map_spec.rb
-vendor/rufus-tokyo/tasks/dev.rb
-vendor/rufus-tokyo/test/bm0.rb
-vendor/rufus-tokyo/test/bm1_compression.rb
-vendor/rufus-tokyo/test/con0.rb
-vendor/rufus-tokyo/test/mem.rb
-vendor/rufus-tokyo/test/mem1.rb
-vendor/rufus-tokyo/test/readme0.rb
-vendor/rufus-tokyo/test/readme1.rb
-vendor/rufus-tokyo/test/readme2.rb
-vendor/rufus-tokyo/test/readme3.rb
-vendor/rufus-tokyo/test/readmes_test.sh
+test/test_storage.rb
 vendor/webrat/.document
 vendor/webrat/History.txt
 vendor/webrat/MIT-LICENSE.txt

data/TODO

@@ -1,6 +1,5 @@
-Switch to MongoDB
-Add ability to track goals in Psycho
-Allow ignoring requests in Metry, and have Psycho requests ignored
+Show goal conversion for each experiment
+
 Switch to submodules for vendor'd libs
 
 More unit tests

data/cucumber.yml

@@ -0,0 +1 @@
+default: --require features/support/ --require features/step_definitions/

data/example/example.rb

@@ -4,7 +4,7 @@ require 'sinatra'
 require File.dirname(__FILE__) + '/../lib/metry'
 
 configure do
-  Metry.init(ENV["USE_MEMORY"] ? Metry::Memory.new : Metry::Tokyo.new("tracking"))
+  Metry.init("tracking")
   use Metry::Rack::Tracking
   use Metry::Psycho, {:path => "/admin/metry"}
 end

data/features/psycho/dashboard.feature

@@ -0,0 +1,17 @@
+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 "/"
+    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"
+    

data/features/psycho/goals.feature

@@ -0,0 +1,24 @@
+Feature: Track Goals
+
+  Background:
+    Given an empty tracking database
+  
+  Scenario: No goals
+    When I view "/admin/metry"
+    Then the page should have "#goals"
+    And the page should not have "#goals .goal"
+    
+  Scenario: Create a goal
+    Given I view "/admin/metry"
+    And I follow "New Goal"
+    And I fill in "name" with "Cool goal"
+    And I fill in "path" with "/goal"
+    And I press "Create"
+    Then I should be on "/admin/metry/"
+    And the page should have "#goals .goal"
+  
+  Scenario: Goal count
+    Given I add a goal named "My Goal" with path "/"
+    And I view "/"
+    When I view "/admin/metry"
+    Then I should see "My Goal: 1 visits"

data/features/psycho/visitor_tracking.feature

@@ -0,0 +1,32 @@
+Feature: Psycho Visitor Tracking
+  In order to see how visitors are using my site
+  As a site admin
+  I want to see visitors and drill down into their behavior
+  
+  Background:
+    Given an empty tracking database
+    And I am a new visitor
+  
+  Scenario: See list of visitors
+    Given I view "/"
+    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"
+    
+  Scenario: View visitor detail
+    Given I view "/"
+    And I view "/subpage"
+    And I am a new visitor
+    And I view "/"
+    When I view "/admin/metry"
+    And I follow "Visitor 1"
+    Then I should see "/"
+    And I should see "/subpage"
+    
+  Scenario: Psycho visits should not be tracked
+    Given I view "/admin/metry"
+    And I view "/admin/metry"
+    When I view "/admin/metry"
+    Then I should not see "Visitor 1"

data/features/step_definitions/goals.rb

@@ -0,0 +1,3 @@
+Given /^I add a goal named "([^\"]*)" with path "([^\"]*)"$/ do |name, path|
+  Metry.current.add_goal('name' => name, 'path' => path)
+end

data/features/step_definitions/tracking.rb

@@ -11,7 +11,7 @@ Then /^there should be (\d+) visitors$/ do |visitor_count|
 end
 
 When /^there should be a tracking event "(\d+)":$/ do |id, table|
-  event = Metry.current[id]
+  event = Metry.current.event(id)
   assert event, "Unable to lookup event #{id}."
   table.hashes.each do |hash|
     expected = hash["value"]

data/features/step_definitions/web.rb

@@ -11,7 +11,19 @@ When /^I (post|put) to "([^\"]*)":$/ do |meth, path, params|
 end
 
 Then /^I should see "([^\"]*)"$/ do |string|
-  assert_match(string, last_response.body)
+  assert_contain(string)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |string|
+  assert_not_contain(string)
+end
+
+Then /^the page should have "([^\"]*)"$/ do |selector|
+  assert_have_selector selector
+end
+
+Then /^the page should not have "([^\"]*)"$/ do |selector|
+  assert_have_no_selector selector
 end
 
 When /^I follow "([^\"]*)"$/ do |link|
@@ -27,5 +39,5 @@ When /^I press "([^\"]*)"$/ do |button|
 end
 
 Then /^I should be on "([^\"]*)"$/ do |path|
-  assert_equal path, last_response.path
+  assert_equal path, current_url
 end

data/features/support/env.rb

@@ -3,6 +3,7 @@ World(Test::Unit::Assertions)
 
 require 'rack/test'
 
+$: << File.dirname(__FILE__) + "/../../lib"
 $: << File.dirname(__FILE__) + "/../../vendor/webrat/lib"
 require 'webrat'
 require 'logger'
@@ -14,6 +15,9 @@ World(Rack::Test::Methods)
 World(Webrat::Methods)
 World(Webrat::Matchers)
 
+require 'metry'
+Metry::Storage.predictable_keys = true
+
 require File.dirname(__FILE__) + '/../../example/example.rb'
 def app
   Sinatra::Application

data/lib/metry.rb

@@ -1,17 +1,15 @@
 $: << File.dirname(__FILE__)
-$: << File.dirname(__FILE__) + '/../vendor/rufus-tokyo/lib'
 
+require 'metry/storage'
 require 'metry/rack/tracking'
-require 'metry/memory'
-require 'metry/tokyo'
 require 'metry/experiment'
 require 'metry/psycho'
 
 module Metry
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
   
-  def self.init(storage)
-    @storage = storage
+  def self.init(dbname)
+    @storage = Storage.new(dbname)
   end
   
   def self.current

data/lib/metry/experiment.rb

@@ -2,21 +2,19 @@ module Metry
   class Experiment
     METHODS = {
       "rand" => proc{|list, visitor| list.sort_by{rand}.first},
-      "mod_visitor" => proc{|list, visitor| list[(visitor.to_i-1)%list.size]},
+      "mod_visitor" => proc{|list, visitor| list[(visitor['_id'].to_i-1)%list.size]}, # mod_visitor will only work with predictable_keys = true
     }
 
-    def initialize(name, event)
-      @key = "experiment.#{name}"
+    def initialize(name, event, visitor)
+      @key = "experiment:#{name}"
       @event = event
-      @visitor = event["visitor"]
-      @storage = Metry.current
+      @visitor = visitor
     end
     
     def choose(options, method=nil)
-      visitor_hash = @storage.visitor(@visitor)
-      unless choice = visitor_hash[@key]
+      unless choice = @visitor[@key]
         choice = METHODS[method || "rand"][options.keys, @visitor]
-        @storage.save_visitor(@visitor, visitor_hash.merge(@key => choice))
+        @visitor[@key] = choice
       end
       @event[@key] = choice
       options[choice]

data/lib/metry/psycho.rb

@@ -0,0 +1,112 @@
+require 'sinatra/base'
+
+module Metry
+  class Psycho < Sinatra::Base
+    def initialize(app, options={})
+      super(app)
+      @options = options
+      path = options[:path] || "/psycho"
+      auth = options[:authorize] || proc{true}
+      on_deny = options[:on_deny] || proc{[403, {"Content-Type" => "text/plain"}, "You must log in."]}
+      
+      self.class.class_eval do
+        set :views, File.dirname(__FILE__) + '/psycho'
+        
+        before do
+          if unescape(@request.path_info) =~ /^#{path}/
+            @request.env["metry.ignore"] = "true"
+            if !auth.call(env)
+              reply = on_deny.call(env)
+              status reply.first
+              response.header.merge!(reply[1])
+              halt reply.last
+            end
+          end
+        end
+
+        get "#{path}/?" do
+          @visitors = Visitor.all
+          @goals = Goal.all
+          erb :dashboard
+        end
+      
+        get "#{path}/visitor/:id" do
+          @visitor = Visitor.find(params["id"])
+          erb :visitor
+        end
+        
+        post "#{path}/goals" do
+          Goal.create!(params[:name], params[:path])
+          redirect url('/')
+        end
+        
+        get "#{path}/goals/new" do
+          erb :new_goal
+        end
+      
+        helpers do
+          define_method(:url) do |url|
+            "#{path}#{url}"
+          end
+        end
+      end
+    end
+    
+    class Goal
+      def self.create!(name, path)
+        Metry.current.add_goal('name' => name, 'path' => path)
+      end
+      
+      def self.all
+        Metry.current.goals.collect{|e| new(e)}
+      end
+      
+      attr_reader :name, :path
+      
+      def initialize(hash)
+        @name = hash['name']
+        @path = hash['path']
+      end
+      
+      def visits
+        Metry.current.all_events({'path' => @path}).size
+      end
+    end
+    
+    class Visitor
+      def self.all
+        Metry.current.visitors.collect{|e| new(e)}.select{|e| e.has_events?}
+      end
+      
+      def self.find(id)
+        new(Metry.current.visitor(id))
+      end
+
+      def initialize(visitor)
+        @visitor = visitor
+      end
+      
+      def id
+        @visitor['_id']
+      end
+      
+      def events
+        Metry.current.events_for(id).collect{|e| Event.new(e)}
+      end
+      
+      def has_events?
+        !events.empty?
+      end
+    end
+    
+    class Event
+      def initialize(event)
+        @event = event
+      end
+      
+      def path
+        @event["path"]
+      end
+    end
+  end
+end