conductor 0.8.3 → 0.9.3

data/{LICENSE → MIT-LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Noctivity
+Copyright 2012 YOURNAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,3 +1,10 @@
+= MASSIVE UPGRADE TO RAILS ENGINE
+
+If anyone is using this with Rails < 3 you need to specify branch 0.8.3
+
+For all using 3 and above use branch 0.9.3
+
+
 = conductor
 
 Conductor is the bastard child of a/b testing and personalization.  

data/Rakefile

@@ -1,57 +1,37 @@
-require 'rubygems'
-require 'rake'
-
+#!/usr/bin/env rake
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "conductor"
-    gem.summary = %Q{lets you just try things while always maximizing towards a goal (e.g. purchase, signups, etc)}
-    gem.description = %Q{Conductor is the bastard child of a/b testing and personalization.  It throws everything you know about creating a web site our the window and lets you just "try stuff" without ever having to worry about not maximing your site's "purpose."  Have a new landing page?  Just throw it to the conductor.  Want to try different price points - conductor.  Different form designs?  Conductor.  Conductor will rotate all alternatives through the mix and eventually settle on the top performing of all, without you having to do anything other than just creating.  Think "intelligent A/B testing" on steriods.}
-    gem.email = "jlippiner@noctivity.com"
-    gem.homepage = "http://github.com/noctivityinc/conductor"
-    gem.authors = ["Noctivity"]
-    gem.rubyforge_project = "conductor"
-    gem.files =  FileList["[A-Z]*", "{generators,lib,tasks,rails}/**/*", "init.rb"]
-    gem.add_dependency 'googlecharts'
-    gem.add_dependency 'haml'
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
+  require 'bundler/setup'
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-
 begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
+  require 'rdoc/task'
 rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Conductor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :test => :check_dependencies
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
-task :default => :test
+Bundler::GemHelper.install_tasks
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'rake/testtask'
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "conductor #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
 end
 
+task :default => :test

data/app/assets/javascripts/conductor/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/conductor/dashboard.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/conductor/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/conductor/application_controller.rb

@@ -0,0 +1,4 @@
+module Conductor
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/conductor/dashboard_controller.rb

@@ -0,0 +1,11 @@
+require_dependency "conductor/application_controller"
+
+module Conductor
+  class DashboardController < ApplicationController
+    def index
+      @weights = Conductor::Experiment::Weight.all
+      @weight_history = Conductor::Experiment::History.all
+      @dailies = Conductor::Experiment::Daily.all
+    end
+  end
+end

data/app/helpers/conductor/application_helper.rb

@@ -0,0 +1,4 @@
+module Conductor
+  module ApplicationHelper
+  end
+end

data/{lib/conductor/rails/helpers → app/helpers/conductor}/dashboard_helper.rb

@@ -1,4 +1,6 @@
-module DashboardHelper
+require 'googlecharts'
+
+module Conductor::DashboardHelper
   def current_weights(group_name, group)
     total = group.inject(0) {|res, x| res += x.weight}
     data = []

data/app/models/conductor/experiment/daily.rb

@@ -0,0 +1,47 @@
+module Conductor
+  class Experiment
+    
+    class Daily < ActiveRecord::Base
+      self.table_name = "conductor_daily_experiments"
+
+      attr_accessible :activity_date, :conversion_value, :conversions, :group_name, :option_name, :views, :alternative
+
+      scope :since, lambda { |a_date| { :conditions =>  ['activity_date >= ?',a_date] }}
+      scope :for_group, lambda { |group_name| { :conditions =>  ['group_name = ?',group_name] }}
+
+      def self.find_equalization_period_stats_for(group_name, alternatives=nil)
+        alternative_filter = alternatives ? alternatives.inject([]) {|res,x| res << "alternative = '#{Conductor.sanitize(x)}'"}.join(' OR ') : 'true'
+
+        sql = "SELECT alternative, min(activity_date) AS activity_date
+        FROM conductor_daily_experiments
+        WHERE group_name = '#{group_name}'
+        AND (#{alternative_filter})
+        GROUP BY alternative
+        HAVING min(activity_date) > '#{Date.today - Conductor.equalization_period}'"
+
+        self.find_by_sql(sql)
+      end
+
+
+      def self.find_post_equalization_period_stats_for(group_name, alternatives=nil)
+        alternative_filter = alternatives ? alternatives.inject([]) {|res,x| res << "alternative = '#{Conductor.sanitize(x)}'"}.join(' OR ') : 'true'
+
+        sql = "SELECT alternative, min(activity_date) AS activity_date, sum(views) AS views, sum(conversions) AS conversions, sum(conversion_value) AS conversion_value
+        FROM conductor_daily_experiments
+        WHERE group_name = '#{group_name}'
+        AND (#{alternative_filter})
+        AND activity_date >=
+        (SELECT max(min_date) FROM
+        (SELECT alternative, min(activity_date) AS min_date
+        FROM conductor_daily_experiments
+        WHERE activity_date >= '#{Date.today - Conductor.inclusion_period}'
+        GROUP BY alternative) AS a)
+        GROUP BY alternative
+        HAVING min(activity_date) <= '#{Date.today - Conductor.equalization_period}'"
+
+        self.find_by_sql(sql)
+      end
+
+    end
+  end
+end

data/app/models/conductor/experiment/history.rb

@@ -0,0 +1,9 @@
+module Conductor
+  class Experiment
+    class History < ActiveRecord::Base
+      self.table_name = 'conductor_weight_histories'
+      
+      attr_accessible :computed_at, :group_name, :option_name, :weight, :alternative, :launch_window
+    end
+  end
+end

data/app/models/conductor/experiment/raw.rb

@@ -0,0 +1,20 @@
+module Conductor
+  class Experiment
+    class Raw < ActiveRecord::Base
+      self.table_name = 'conductor_raw_experiments'
+
+      attr_accessible :conversion_value, :group_name, :identity_id, :option_name, :alternative, :created_at, :updated_at, :goal
+
+      validates_presence_of :group_name, :alternative
+      scope :since, lambda { |a_date| { :conditions =>  ['created_at >= ?',a_date] }}
+
+      def created_date
+        self.created_at.strftime('%Y-%m-%d')
+      end
+
+      def self.purge(days_old=30)
+        Conductor::Experiment::Raw.delete_all("created_at <= #{days_old.days.ago}")
+      end
+    end
+  end
+end

data/app/models/conductor/experiment/weight.rb

@@ -0,0 +1,11 @@
+module Conductor
+  class Experiment
+    class Weight < ActiveRecord::Base
+      self.table_name = 'conductor_weighted_experiments'
+      attr_accessible :group_name, :option_name, :weight, :alternative, :created_at, :updated_at
+
+      scope :for_group, lambda { |group_name| { :conditions =>  ['group_name = ?',group_name] }}
+      scope :with_alternative, lambda { |alternative| { :conditions =>  ['alternative = ?',alternative] }}
+    end
+  end
+end

data/app/views/conductor/dashboard/index.html.haml

@@ -0,0 +1,12 @@
+#conductor_dashboard
+  .title
+    %h1 Conductor Statistics
+    .generated= "Generated on #{Time.now}"
+
+  .top_nav= render :file => 'conductor/dashboard/_top_nav'
+  #weights= render :file => 'conductor/dashboard/_current_weights'
+  #group_stats= render :file => 'conductor/dashboard/_group_stats'
+  #dailies= render :file => 'conductor/dashboard/_daily_stats'
+  #history= render :file => 'conductor/dashboard/_weight_history'
+
+          

data/app/views/layouts/conductor/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Conductor</title>
+  <%= stylesheet_link_tag    "conductor/application", :media => "all" %>
+  <%= javascript_include_tag "conductor/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Conductor::Engine.routes.draw do
+  match '/conductor', :to => "dashboard#index", :as => "conductor_dashboard"
+  root :to => "dashboard#index"
+end

data/db/migrate/20121010131323_create_conductor_daily_experiments.rb

@@ -0,0 +1,16 @@
+class CreateConductorDailyExperiments < ActiveRecord::Migration
+  def change
+    create_table "conductor_daily_experiments", :force => true do |t|
+      t.date    "activity_date"
+      t.string  "group_name"
+      t.string  "alternative"
+      t.decimal "conversion_value", :precision => 8, :scale => 2
+      t.integer "views"
+      t.integer "conversions"
+    end
+
+    add_index "conductor_daily_experiments", ["activity_date"], :name => "index_conductor_daily_experiments_on_activity_date"
+    add_index "conductor_daily_experiments", ["group_name"], :name => "index_conductor_daily_experiments_on_group_name"
+
+  end
+end

data/db/migrate/20121010173406_create_conductor_experiment_weights.rb

@@ -0,0 +1,13 @@
+class CreateConductorExperimentWeights < ActiveRecord::Migration
+  def change
+    create_table "conductor_weighted_experiments", :force => true do |t|
+      t.string   "group_name"
+      t.string   "alternative"
+      t.decimal  "weight",      :precision => 8, :scale => 2
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    add_index "conductor_weighted_experiments", ["group_name"], :name => "index_conductor_weighted_experiments_on_group_name"
+  end
+end

data/db/migrate/20121010174835_create_conductor_raw_experiments.rb

@@ -0,0 +1,13 @@
+class CreateConductorRawExperiments < ActiveRecord::Migration
+  def change
+    create_table "conductor_raw_experiments", :force => true do |t|
+      t.string   "identity_id"
+      t.string   "group_name"
+      t.string   "alternative"
+      t.decimal  "conversion_value", :precision => 8, :scale => 2
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.string   "goal"
+    end
+  end
+end

data/db/migrate/20121010174950_create_conductor_weight_histories.rb

@@ -0,0 +1,14 @@
+class CreateConductorWeightHistories < ActiveRecord::Migration
+  def change
+    create_table "conductor_weight_histories", :force => true do |t|
+      t.string   "group_name"
+      t.string   "alternative"
+      t.decimal  "weight",        :precision => 8, :scale => 2
+      t.datetime "computed_at"
+      t.integer  "launch_window"
+    end
+
+    add_index "conductor_weight_histories", ["computed_at", "group_name"], :name => "conductor_wh_date_and_group_ndx"
+
+  end
+end

data/lib/conductor.rb

@@ -1,27 +1,37 @@
-class Conductor
+require "conductor/engine"
+require 'conductor/core_ext'
+require 'conductor/experiment'
+require 'conductor/roll_up'
+require 'conductor/weights'
+require 'haml'
+
+module Conductor
   MAX_WEIGHTING_FACTOR = 1.25
   EQUALIZATION_PERIOD_DEFAULT = 7
-  MINIMUM_CONVERSIONS_PER_GROUP_DEFAULT = 10
   DBG = false
 
-  cattr_writer :cache
-  
+  # attr_accessor :cache
+
   def self.cache
-    @@cache || Rails.cache
+    $cache || Rails.cache
   end
 
   class << self
-    # Specifies a unique identity for the current visitor.  If no identity is specified 
-    # then a random value is selected.  Conductor makes sure that the same visitor 
+    # Specifies a unique identity for the current visitor.  If no identity is specified
+    # then a random value is selected.  Conductor makes sure that the same visitor
     # will always see the same alternative selections to reduce confusion.
     def identity=(value)
       @conductor_identity = value
     end
 
     def identity
-      return (@conductor_identity || ActiveSupport::SecureRandom.hex(16))
+      return (@conductor_identity || SecureRandom.hex(16))
+    end
+
+    def reset_identity
+      @conductor_identity = SecureRandom.hex(16)
     end
-    
+
     # The number of days to include when calculating weights
     # The inclusion period MUST be higher than then equalization period
     # The default is 14 days
@@ -30,51 +40,38 @@ class Conductor
       raise "Conductor.inclusion_period must be greater than the equalization period" if value < equalization_period
       @inclusion_period = value
     end
-    
+
     def inclusion_period
       return (@inclusion_period || 14)
     end
-    
-    # The minimum number of conversions that a group needs to have in TOTAL before 
-    # weighting is allowed.  
-    #
-    # TODO: trigger a notification if a post equalized group hits below this number
-    def minimum_conversions_per_group=(value)
-      raise "Conductor.minimum_conversions_per_group must be a positive number > 0" unless value.is_a?(Numeric) && value > 0
-      @minimum_conversions_per_group = value
-    end
-    
-    def minimum_conversions_per_group
-      return (@minimum_conversions_per_group || MINIMUM_CONVERSIONS_PER_GROUP_DEFAULT)
-    end
-    
-    # The equalization period is the initial amount of time, in days, that conductor 
-    # should apply the max_weighting_factor towards a new alternative to ensure 
+
+    # The equalization period is the initial amount of time, in days, that conductor
+    # should apply the max_weighting_factor towards a new alternative to ensure
     # that it receives a far shot of performing.
     #
-    # If an equalization period was not used then any new alternative would 
-    # immediately be weighed very low since it has no conversions and would 
+    # If an equalization period was not used then any new alternative would
+    # immediately be weighed very low since it has no conversions and would
     # never have a chance of performing
     def equalization_period=(value)
       raise "Conductor.equalization_period must be a positive number > 0" unless value.is_a?(Numeric) && value > 0
       @equalization_period = value
     end
-    
+
     def equalization_period
       return (@equalization_period || EQUALIZATION_PERIOD_DEFAULT)
     end
-    
-    # The attribute for weighting specifies if the conversion_value OR number of conversions 
-    # should be used to calculate the weight.  The default is conversions.
+
+    # The attribute for weighting specifies if the conversion_value OR number of conversions
+    # should be used to calculate the weight.  The default is conversion_value.
     #
-    # TODO: Change this to only use conversion rate when normalization is figured out
+    # TODO: Allow of avg_conversion_value where acv = conversion_value / conversions
     def attribute_for_weighting=(value)
-      raise "Conductor.attribute_for_weighting must be either :views, :conversions or :conversion_value (default)" unless [:views, :conversions, :conversion_value].include?(value) 
+      raise "Conductor.attribute_for_weighting must be either :views, :conversions or :conversion_value (default)" unless [:views, :conversions, :conversion_value].include?(value)
       @attribute_for_weighting = value
     end
-    
+
     def attribute_for_weighting
-      return (@attribute_for_weighting || :conversions)
+      return (@attribute_for_weighting || :conversion_value)
     end
 
     def log(msg)
@@ -85,25 +82,4 @@ class Conductor
       str.gsub(/\s/,'_').downcase
     end
   end
-
-end
-
-
-class Array
-  def sum_it(attribute)
-    self.map {|x| x.send(attribute) }.compact.sum
-  end
-
-  def weighted_mean_of_attribute(attribute)
-    self.map {|x| x.send(attribute) }.compact.weighted_mean
-  end
-
-  def weighted_mean
-    w_sum = sum(self)
-    return 0.00 if w_sum == 0.00
-    
-    w_prod = 0
-    self.each_index {|i| w_prod += (i+1) * self[i].to_f}
-    w_prod.to_f / w_sum.to_f
-  end
 end