profitably-abingo 0.1.2

data/lib/generators/abingo_migration/abingo_migration_generator.rb

@@ -0,0 +1,13 @@
+class AbingoMigrationGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def generate_migration
+    copy_file "create_abingo_tables.rb", "db/migrate/#{migration_timestamp}_create_abingo_tables.rb" 
+  end
+  
+  private
+  
+  def migration_timestamp
+    @migration_timestamp ||= Time.now.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/abingo_migration/templates/create_abingo_tables.rb

@@ -0,0 +1,29 @@
+class CreateAbingoTables < ActiveRecord::Migration
+  def self.up
+    create_table "experiments", :force => true do |t|
+      t.string "test_name"
+      t.string "status"
+      t.timestamps
+    end
+
+    add_index "experiments", "test_name"
+    #add_index "experiments", "created_on"
+
+    create_table "alternatives", :force => true do |t|
+      t.integer :experiment_id
+      t.string :content
+      t.string :lookup, :limit => 32
+      t.integer :weight, :default => 1
+      t.integer :participants, :default => 0
+      t.integer :conversions, :default => 0
+    end
+
+    add_index "alternatives", "experiment_id"
+    add_index "alternatives", "lookup"  #Critical for speed, since we'll primarily be updating by that.
+  end
+
+  def self.down
+    drop_table :experiments
+    drop_table :alternatives
+  end
+end

data/lib/generators/abingo_views/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate abingo_migration Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/abingo_views/abingo_views_generator.rb

@@ -0,0 +1,8 @@
+class AbingoViewsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_views
+    copy_file "views/ab_dashboard/_experiment.html.erb", "app/views/ab_dashboard/_experiment.html.erb" 
+    copy_file "views/ab_dashboard/index.html.erb", "app/views/ab_dashboard/index.html.erb" 
+  end
+end

data/lib/generators/abingo_views/templates/views/ab_dashboard/_experiment.html.erb

@@ -0,0 +1,43 @@
+<h3><%= experiment.test_name.titleize %> <%= %Q|<i>(Test completed)</i>| if experiment.status != "Live" %> </h3>
+<% short_circuit = Abingo.cache.read("Abingo::Experiment::short_circuit(#{experiment.test_name})".gsub(" ", "")) %>
+<table class="experiment" style="border: 1px black;">
+  <tr class="header_row">
+    <th>Name</th>
+    <th>Participants</th>
+    <th>Conversions</th>
+    <th>Notes</th>
+  </tr>
+  <tr class="experiment_row">
+    <td>Experiment Total: </td>
+    <td><%= experiment.participants %> </td>
+    <td><%= experiment.conversions %> (<%= experiment.pretty_conversion_rate %>)</td>
+    <td></td>
+  </tr>
+  <% experiment.alternatives.each do |alternative| %>
+  <tr class="alternative_row">
+    <td>
+        <%= h alternative.content %>
+    </td>
+    <td><%= alternative.participants %></td>
+    <td><%= alternative.conversions %> (<%= alternative.pretty_conversion_rate %>)</td>
+    <td>
+      <% unless experiment.status != "Live" %>
+      <%= link_to("End experiment, picking this.", url_for(:id => alternative.id,
+      :action => "end_experiment"),
+      :method => :post,
+      :confirm => "Are you sure you want to terminate this experiment?  This is not reversible."
+      ) %>
+      <% else %>
+        <% if alternative.content == short_circuit %>
+          <b>(All users seeing this.)</b>
+        <% end %>
+      <% end %>
+    </td>
+  </tr>
+  <% end %>
+  <tr>
+    <td colspan="4">
+      <b>Significance test results: </b><%= experiment.describe_result_in_words %>
+    </td>
+  </tr>
+</table>

data/lib/generators/abingo_views/templates/views/ab_dashboard/index.html.erb

@@ -0,0 +1,20 @@
+<div id="abingo_dashboard">
+<p><h1>Welcome to your A/Bingo dashboard!</h1>
+
+See <a href="http://www.bingocardcreator.com/abingo">the official site</a> for documentation.
+I encourage you to customize this page to fit your needs.  See /vendor/plugins/abingo/views for
+the view templates.  Hack them to pieces -- please!
+</p>
+
+<p>
+  <% if flash[:notice] %>
+  <span style="color: green;"><%= flash[:notice] %> </span>
+  <% end %>
+  <h2>All Experiments</h2>
+  
+<% @experiments.each do |experiment| %>
+  <%= render :partial => "dashboard/experiment", :locals => {:experiment => experiment} %>
+  <br/>
+<% end %>
+</p>
+</div>

data/profitably-abingo.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{profitably-abingo}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Patrick McKenzie", "Wildfalcon", "Matthias Bauer"]
+  s.date = %q{2011-10-25}
+  s.description = %q{Rails A/B testing. One minute to install. One line to set up a new A/B test. One line to track conversion.}
+  s.email = %q{admin@profitably.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "install.rb",
+    "lib/abingo.rb",
+    "lib/abingo/alternative.rb",
+    "lib/abingo/controller/dashboard.rb",
+    "lib/abingo/conversion_rate.rb",
+    "lib/abingo/experiment.rb",
+    "lib/abingo/rails/controller/dashboard.rb",
+    "lib/abingo/railtie.rb",
+    "lib/abingo/statistics.rb",
+    "lib/abingo/views/ab_dashboard/_experiment.erb",
+    "lib/abingo/views/ab_dashboard/index.erb",
+    "lib/abingo_sugar.rb",
+    "lib/abingo_view_helper.rb",
+    "lib/generators/abingo_migration/USAGE",
+    "lib/generators/abingo_migration/abingo_migration_generator.rb",
+    "lib/generators/abingo_migration/templates/create_abingo_tables.rb",
+    "lib/generators/abingo_views/USAGE",
+    "lib/generators/abingo_views/abingo_views_generator.rb",
+    "lib/generators/abingo_views/templates/views/ab_dashboard/_experiment.html.erb",
+    "lib/generators/abingo_views/templates/views/ab_dashboard/index.html.erb",
+    "profitably-abingo.gemspec",
+    "strip.rb",
+    "test/abingo_test.rb",
+    "test/test_helper.rb",
+    "uninstall.rb"
+  ]
+  s.homepage = %q{https://github.com/profitably/abingo}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{A/B Testing for Rails}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/strip.rb

@@ -0,0 +1,11 @@
+require 'find'
+require 'fileutils'
+def find_and_delete(path, pattern)
+  Find.find(path) do |f|
+	if !File.file?(f) and f[pattern]
+	  FileUtils.rm_rf(f)
+	end
+  end
+end
+# print all the ruby files
+find_and_delete(".", /\.svn$/)

data/test/abingo_test.rb

@@ -0,0 +1,187 @@
+require 'test_helper'
+
+class AbingoTest < ActiveSupport::TestCase
+
+  #Wipes cache, D/B prior to doing a test run.
+  Abingo.cache.clear
+  Abingo::Experiment.delete_all
+  Abingo::Alternative.delete_all
+
+  test "identity automatically assigned" do
+    assert Abingo.identity != nil
+  end
+
+  test "alternative parsing" do
+    array = %w{a b c}
+    assert_equal array, Abingo.parse_alternatives(array)
+    assert_equal 65, Abingo.parse_alternatives(65).size
+    assert_equal 4, Abingo.parse_alternatives(2..5).size
+    assert !(Abingo.parse_alternatives(2..5).include? 1)
+  end
+
+  test "experiment creation" do
+    assert_equal 0, Abingo::Experiment.count
+    assert_equal 0, Abingo::Alternative.count
+    alternatives = %w{A B}
+    alternative_selected = Abingo.test("unit_test_sample_A", alternatives)
+    assert_equal 1, Abingo::Experiment.count
+    assert_equal 2, Abingo::Alternative.count
+    assert alternatives.include?(alternative_selected)
+  end
+
+  test "exists works right" do
+    Abingo.test("exist works right", %w{does does_not})
+    assert Abingo::Experiment.exists?("exist works right")
+  end
+
+  test "alternatives picked consistently" do
+    alternative_picked = Abingo.test("consistency_test", 1..100)
+    100.times do
+      assert_equal alternative_picked, Abingo.test("consistency_test", 1..100)
+    end
+  end
+
+  test "participation works" do
+    new_tests = %w{participationA participationB participationC}
+    new_tests.map do |test_name|
+      Abingo.test(test_name, 1..5)
+    end
+
+    participating_tests = Abingo.cache.read("Abingo::participating_tests::#{Abingo.identity}") || []
+
+    new_tests.map do |test_name|
+      assert participating_tests.include? test_name
+    end
+  end
+
+  test "participants counted" do
+    test_name = "participants_counted_test"
+    alternative = Abingo.test(test_name, %w{a b c})
+
+    ex = Abingo::Experiment.find_by_test_name(test_name)
+    lookup = Abingo::Alternative.calculate_lookup(test_name, alternative)
+    chosen_alt = Abingo::Alternative.find_by_lookup(lookup)
+    assert_equal 1, ex.participants
+    assert_equal 1, chosen_alt.participants
+  end
+
+  test "conversion tracking by test name" do
+    test_name = "conversion_test_by_name"
+    alternative = Abingo.test(test_name, %w{a b c})
+    Abingo.bingo!(test_name)
+    ex = Abingo::Experiment.find_by_test_name(test_name)
+    lookup = Abingo::Alternative.calculate_lookup(test_name, alternative)
+    chosen_alt = Abingo::Alternative.find_by_lookup(lookup)
+    assert_equal 1, ex.conversions
+    assert_equal 1, chosen_alt.conversions
+    Abingo.bingo!(test_name)
+
+    #Should still only have one because this conversion should not be double counted.
+    #We haven't specified that in the test options.
+    assert_equal 1, Abingo::Experiment.find_by_test_name(test_name).conversions
+  end
+
+  test "conversion tracking by conversion name" do
+    conversion_name = "purchase"
+    tests = %w{conversionTrackingByConversionNameA conversionTrackingByConversionNameB conversionTrackingByConversionNameC}
+    tests.map do |test_name|
+      Abingo.test(test_name, %w{A B}, :conversion => conversion_name)
+    end
+
+    Abingo.bingo!(conversion_name)
+    tests.map do |test_name|
+      assert_equal 1, Abingo::Experiment.find_by_test_name(test_name).conversions
+    end
+  end
+
+  test "short circuiting works" do
+    conversion_name = "purchase"
+    test_name = "short circuit test"
+    alt_picked = Abingo.test(test_name, %w{A B}, :conversion => conversion_name)
+    ex = Abingo::Experiment.find_by_test_name(test_name)
+    alt_not_picked = (%w{A B} - [alt_picked]).first
+
+    ex.end_experiment!(alt_not_picked, conversion_name)
+
+    ex.reload
+    assert_equal "Finished", ex.status
+    
+    Abingo.bingo!(test_name)  #Should not be counted, test is over.
+    assert_equal 0, ex.conversions
+
+    old_identity = Abingo.identity
+    Abingo.identity = "shortCircuitTestNewIdentity"
+    Abingo.test(test_name, %w{A B}, :conversion => conversion_name)
+    Abingo.identity = old_identity
+    ex.reload
+    assert_equal 1, ex.participants  #Original identity counted, new identity not counted b/c test stopped
+  end
+
+  test "proper experiment creation in high concurrency" do
+    conversion_name = "purchase"
+    test_name = "high_concurrency_test"
+    alternatives = %w{foo bar}
+
+    threads = []
+    5.times do
+      threads << Thread.new do
+        Abingo.test(test_name, alternatives, conversion_name)
+        1
+      end
+    end
+    sleep(10)
+    assert_equal 1, Abingo::Experiment.count_by_sql(["select count(id) from experiments where test_name = ?", test_name])
+  end
+
+  test "non-humans are ignored for participation and conversions if not explicitly counted" do
+    Abingo.options[:count_humans_only] = true
+    Abingo.options[:expires_in] = 1.hour
+    Abingo.options[:expires_in_for_bots] = 3.seconds
+    first_identity = Abingo.identity = "unsure_if_human#{Time.now.to_i}"
+    test_name = "are_you_a_human"
+    Abingo.test(test_name, %w{does_not matter})
+
+    assert_false Abingo.is_human?, "Identity not marked as human yet."
+
+    ex = Abingo::Experiment.find_by_test_name(test_name)
+    Abingo.bingo!(test_name)
+    assert_equal 0, ex.participants, "Not human yet, so should have no participants."
+    assert_equal 0, ex.conversions, "Not human yet, so should have no conversions."
+
+    Abingo.human!
+    
+    #Setting up second participant who doesn't convert.
+    Abingo.identity = "unsure_if_human_2_#{Time.now.to_i}"
+    Abingo.test(test_name, %w{does_not matter})
+    Abingo.human!
+
+    ex = Abingo::Experiment.find_by_test_name(test_name)
+    assert_equal 2, ex.participants, "Now that we're human, our participation should matter."
+    assert_equal 1, ex.conversions, "Now that we're human, our conversions should matter, but only one of us converted."
+  end
+
+  test "Participating tests for a given identity" do
+    Abingo.identity = "test_participant"
+    test_names = (1..3).map {|t| "participating_test_test_name #{t}"}
+    test_alternatives = %w{yes no}
+    test_names.each {|test_name| Abingo.test(test_name, test_alternatives)}
+    ex = Abingo::Experiment.last
+    ex.end_experiment!("no")  #End final of 3 tests, leaving 2 presently running
+
+    assert_equal 2, Abingo.participating_tests.size  #Pairs for two tests
+    Abingo.participating_tests.each do |key, value|
+      assert test_names.include? key
+      assert test_alternatives.include? value
+    end
+    
+    assert_equal 3, Abingo.participating_tests(false).size #pairs for three tests
+    Abingo.participating_tests(false).each do |key, value|
+      assert test_names.include? key
+      assert test_alternatives.include? value
+    end
+
+    Abingo.identity = "test_nonparticipant"
+    assert_equal({}, Abingo.participating_tests)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: profitably-abingo
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Patrick McKenzie
+- Wildfalcon
+- Matthias Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Rails A/B testing. One minute to install. One line to set up a new A/B test. One line to track conversion.
+email: admin@profitably.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/abingo.rb
+- lib/abingo/alternative.rb
+- lib/abingo/controller/dashboard.rb
+- lib/abingo/conversion_rate.rb
+- lib/abingo/experiment.rb
+- lib/abingo/rails/controller/dashboard.rb
+- lib/abingo/railtie.rb
+- lib/abingo/statistics.rb
+- lib/abingo/views/ab_dashboard/_experiment.erb
+- lib/abingo/views/ab_dashboard/index.erb
+- lib/abingo_sugar.rb
+- lib/abingo_view_helper.rb
+- lib/generators/abingo_migration/USAGE
+- lib/generators/abingo_migration/abingo_migration_generator.rb
+- lib/generators/abingo_migration/templates/create_abingo_tables.rb
+- lib/generators/abingo_views/USAGE
+- lib/generators/abingo_views/abingo_views_generator.rb
+- lib/generators/abingo_views/templates/views/ab_dashboard/_experiment.html.erb
+- lib/generators/abingo_views/templates/views/ab_dashboard/index.html.erb
+- profitably-abingo.gemspec
+- strip.rb
+- test/abingo_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: https://github.com/profitably/abingo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A/B Testing for Rails
+test_files: []
+