abongo 0.0.1

data/test/test_abongo.rb~

@@ -0,0 +1,472 @@
+require 'test/unit'
+require 'rubygems'
+require 'mongo'
+
+class TestAbongo < Test::Unit::TestCase
+
+  def setup
+    conn = Mongo::Connection.new
+    db = conn['abongo_test']
+    Abongo.db = db
+    Abongo.options = {}
+    Abongo.identity = nil
+    Abongo.salt = 'Not really necessary.'
+    Abongo.participants.drop
+    Abongo.alternatives.drop
+    Abongo.conversions.drop
+    Abongo.experiments.drop
+  end
+
+  def teardown
+  end
+
+  def test_experiment_creation
+    experiment = Abongo.start_experiment!('test_test', ['alt1', 'alt2'])
+    assert_equal('test_test', experiment['name'])
+    assert_equal(['alt1', 'alt2'], experiment['alternatives'])
+    assert(Abongo.tests_listening_to_conversion('test_test').include?(experiment['_id']))
+  end
+
+  def test_experiment_creation_occurs_once
+    experiment1 = Abongo.start_experiment!('test_test', ['alt1', 'alt2'])
+    experiment2 = Abongo.start_experiment!('test_test', ['alt1', 'alt2'])
+    assert_equal(experiment1, experiment2)
+  end
+
+  def test_experiment_creation_with_conversion
+    Abongo.start_experiment!('test_test', ['alt1', 'alt2'], 'convert')
+    experiment = Abongo.get_test('test_test')
+    assert_equal('test_test', experiment['name'])
+    assert_equal(['alt1', 'alt2'], experiment['alternatives'])
+    assert(Abongo.tests_listening_to_conversion('convert').include?(experiment['_id']))
+  end
+
+  def test_default_identity
+    assert 0 <= Abongo.identity.to_i
+    assert 10**10 >= Abongo.identity.to_i
+  end
+
+  def test_add_participation
+    Abongo.add_participation('ident', 'test1')
+    assert_equal(['test1'], Abongo.find_participant('ident')['tests'])
+    Abongo.add_participation('ident', 'test2')
+    assert_equal(['test1', 'test2'], Abongo.find_participant('ident')['tests'])
+  end
+  
+  def test_add_conversions
+    Abongo.add_conversion('ident', 'test1')
+    assert_equal(['test1'], Abongo.find_participant('ident')['conversions'])
+    Abongo.add_conversion('ident', 'test2')
+    assert_equal(['test1', 'test2'], Abongo.find_participant('ident')['conversions'])
+  end
+    
+  def test_find_alternative_for_user
+    Abongo.identity = 'ident'
+    experiment = Abongo.start_experiment!('test_test', ['alt1', 'alt2'])
+    assert_equal('alt1', Abongo.find_alternative_for_user('ident', experiment))
+  end
+  
+  def test_test
+    Abongo.identity = 'ident'
+    assert_equal('alt1', Abongo.test('test_test', ['alt1', 'alt2']))
+    experiment = Abongo.get_test('test_test')
+    assert_equal('test_test', experiment['name'])
+    assert_equal(['alt1', 'alt2'], experiment['alternatives'])
+    assert_equal([experiment['_id']], Abongo.find_participant('ident')['tests'])    
+  end
+
+  def test_test_with_block
+    Abongo.identity = 'ident'
+    Abongo.test('test_test', ['alt1', 'alt2']){|alt|
+      assert_equal('alt1', alt)
+    }
+  end
+
+  def test_flip
+    Abongo.identity = 'ident'
+    assert_equal(true, Abongo.flip('test_test'))
+    experiment = Abongo.get_test('test_test')
+    assert_equal('test_test', experiment['name'])
+    assert_equal([true, false], experiment['alternatives'])
+    assert_equal([experiment['_id']], Abongo.find_participant('ident')['tests'])    
+  end
+
+  def test_flip_with_block
+    Abongo.identity = 'ident'
+    Abongo.flip('test_test'){|alt|
+      assert_equal(true, alt)
+    }
+    experiment = Abongo.get_test('test_test')
+    assert_equal([true, false], experiment['alternatives'])
+  end
+
+  def test_flip_with_options
+    Abongo.identity = 'ident'
+    Abongo.flip('test_test', :conversion => 'test_conversions')
+    experiment = Abongo.get_test('test_test')
+    assert_equal([experiment['_id']], Abongo.tests_listening_to_conversion('test_conversions'))
+  end
+  
+  def test_flip_with_options
+    Abongo.identity = 'ident'
+    Abongo.flip('test_test', :conversion => 'test_conversions') do |alt|
+      # do nothing
+    end
+    experiment = Abongo.get_test('test_test')
+    assert_equal([experiment['_id']], Abongo.tests_listening_to_conversion('test_conversions'))
+  end
+  
+  def test_test_short_circuit
+    Abongo.identity = 'ident'
+    assert_equal('alt1', Abongo.test('test_test', ['alt1', 'alt2']))
+    Abongo.end_experiment!('test_test', 'alt2')
+    assert_equal('alt2', Abongo.test('test_test', ['alt1', 'alt2']))
+    Abongo.end_experiment!('test_test', 'alt3')
+    assert_equal('alt3', Abongo.test('test_test', ['alt1', 'alt2']))
+  end
+
+  def test_ensure_one_participation_per_participant
+    Abongo.identity = 'ident'
+    10.times do
+      Abongo.test('test_test', ['alt1', 'alt2'])
+      participant = Abongo.find_participant('ident')
+      assert_equal(1, participant['tests'].size)
+      alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+      assert_equal(1, alternative['participants'])
+    end
+  end
+
+  def test_ensure_multiple_participation
+    Abongo.identity = 'ident'
+    10.times do |num|
+      Abongo.test('test_test', ['alt1', 'alt2'], {:multiple_participation => true})
+      participant = Abongo.find_participant('ident')
+      assert_equal(1, participant['tests'].size)
+      alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+      assert_equal(num+1, alternative['participants'])
+    end
+  end
+
+  def test_score_conversion
+    Abongo.identity = 'ident'
+    Abongo.test('test_test', ['alt1', 'alt2'])
+    participant = Abongo.find_participant('ident')
+    alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+    experiment = Abongo.get_test('test_test')
+    Abongo.score_conversion!(experiment['_id'])
+    alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+    assert_equal(1, alternative['conversions'])
+  end
+
+  def test_score_conversion_with_name
+    Abongo.identity = 'ident'
+    Abongo.test('test_test', ['alt1', 'alt2'])
+    participant = Abongo.find_participant('ident')
+    alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+    experiment = Abongo.get_test('test_test')
+    Abongo.score_conversion!('test_test')
+    alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+    assert_equal(1, alternative['conversions'])
+  end
+
+  def test_score_conversion_only_once_per_participant
+    Abongo.identity = 'ident'
+    Abongo.test('test_test', ['alt1', 'alt2'])
+    participant = Abongo.find_participant('ident')
+    alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+    experiment = Abongo.get_test('test_test')
+    10.times do
+      Abongo.score_conversion!(experiment['_id'])
+      alternative = Abongo.alternatives.find_one(:test => participant['tests'].first, :content => 'alt1')
+      assert_equal(1, alternative['conversions'])
+    end
+  end
+
+  def test_score_conversion_with_multiple_conversions
+    Abongo.identity = 'ident'
+    Abongo.options[:multiple_conversions] = true
+    Abongo.test('test_test', ['alt1', 'alt2'])
+    experiment = Abongo.get_test('test_test')
+    alternative = Abongo.alternatives.find_one(:test => experiment["_id"], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+    10.times do |num|
+      Abongo.score_conversion!(experiment['_id'])
+      alternative = Abongo.alternatives.find_one(:test => experiment["_id"], :content => 'alt1')
+      assert_equal(num+1, alternative['conversions'])
+    end
+  end
+
+  def test_salt
+    Abongo.identity = 'ident'
+    assert_equal('alt1', Abongo.test('test_test', ['alt1', 'alt2']))
+    Abongo.salt = "This will change the result"
+    assert_equal('alt2', Abongo.test('test_test', ['alt1', 'alt2']))
+  end
+  
+  def test_count_humans_only
+    Abongo.identity = 'ident'
+    Abongo.options[:count_humans_only] = true
+    assert_equal("alt1", Abongo.test('test_test', ['alt1', 'alt2']))
+
+    experiment = Abongo.get_test('test_test')
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(0, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+
+    Abongo.score_conversion!('test_test')
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(0, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+
+    Abongo.human!
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(1, alternative['conversions'])
+
+
+    assert_equal("alt1", Abongo.test('test2', ['alt1', 'alt2']))
+    
+    experiment = Abongo.get_test('test2')
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+
+    Abongo.score_conversion!('test2')
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(1, alternative['conversions'])
+
+    Abongo.human!
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(1, alternative['conversions'])
+  end
+
+  def test_count_humans_only_without_conversion_before_marked_human
+    Abongo.identity = 'ident'
+    Abongo.options[:count_humans_only] = true
+    assert_equal("alt1", Abongo.test('test_test', ['alt1', 'alt2']))
+
+    experiment = Abongo.get_test('test_test')
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(0, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+
+    Abongo.human!
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+
+    Abongo.score_conversion!('test_test')
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(1, alternative['conversions'])
+  end
+
+  def test_parse_alternatives_array
+    assert_equal([1, 5, 2, 4, true], Abongo.parse_alternatives([1, 5, 2, 4, true]))
+  end
+
+  def test_parse_alternatives_integer
+    assert_equal([1, 2, 3, 4, 5], Abongo.parse_alternatives(5))
+  end
+
+  def test_parse_alternatives_range
+    assert_equal([2, 3, 4, 5], Abongo.parse_alternatives(2..5))
+  end
+
+  def test_parse_alternatives_hash
+    assert_equal(["three", "three", "three", "one"], Abongo.parse_alternatives({"three" => 3, "one" => 1}))
+  end
+
+  def test_parse_alternatives_hash_invalid_value
+    assert_raise RuntimeError do
+      Abongo.parse_alternatives({"three" => "bob"})
+    end
+  end
+
+  def test_parse_alternatives_invalid_type
+    assert_raise RuntimeError do
+      Abongo.parse_alternatives(Abongo.new)
+    end
+  end
+
+  def test_bongo_array
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    test2 = Abongo.start_experiment!('test2', ['alt1', 'alt2'])
+    test3 = Abongo.start_experiment!('test3', ['alt1', 'alt2'])
+    test4 = Abongo.start_experiment!('test3', ['alt1', 'alt2'])
+    Abongo.test('test1', ['alt1', 'alt2'])
+    Abongo.test('test2', ['alt1', 'alt2'])
+    Abongo.test('test3', ['alt1', 'alt2'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test3), :test => test3['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test4), :test => test4['_id']})['conversions'])
+
+    Abongo.bongo!(['test1', 'test2'])
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test3), :test => test3['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test4), :test => test4['_id']})['conversions'])
+  end
+
+  def test_bongo_nil
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    test2 = Abongo.start_experiment!('test2', ['alt1', 'alt2'])
+    test3 = Abongo.start_experiment!('test3', ['alt1', 'alt2'])
+    Abongo.test('test1', ['alt1', 'alt2'])
+    Abongo.test('test2', ['alt1', 'alt2'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test3), :test => test3['_id']})['conversions'])
+
+    Abongo.bongo!
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test3), :test => test3['_id']})['conversions'])
+  end
+
+  def test_bongo_with_alternative_conversion
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'], "convert!")
+    test2 = Abongo.start_experiment!('test2', ['alt1', 'alt2'], "convert!")
+    test3 = Abongo.start_experiment!('test3', ['alt1', 'alt2'], "dontconvert!")
+    Abongo.test('test1', ['alt1', 'alt2'])
+    Abongo.test('test2', ['alt1', 'alt2'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test3), :test => test3['_id']})['conversions'])
+
+    Abongo.bongo!('convert!')
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test3), :test => test3['_id']})['conversions'])
+  end
+
+  def test_bongo_with_test_name
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    test2 = Abongo.start_experiment!('test2', ['alt1', 'alt2'])
+    test3 = Abongo.start_experiment!('test3', ['alt1', 'alt2'])
+    Abongo.test('test1', ['alt1', 'alt2'])
+    Abongo.test('test2', ['alt1', 'alt2'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+    Abongo.bongo!('test1')
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test2), :test => test2['_id']})['conversions'])
+  end
+
+  def test_bongo_doesnt_assume_participation
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    Abongo.bongo!('test1')
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    Abongo.test('test1', ['alt1', 'alt2'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    Abongo.bongo!('test1')
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+  end
+
+  def test_bongo_with_assume_participation
+    Abongo.identity = 'ident'
+    Abongo.options[:assume_participation] = true
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    assert_equal(0, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    Abongo.bongo!('test1')
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    Abongo.test('test1', ['alt1', 'alt2'])
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+    Abongo.bongo!('test1')
+    assert_equal(1, Abongo.alternatives.find_one({:content => Abongo.find_alternative_for_user(Abongo.identity, test1), :test => test1['_id']})['conversions'])
+  end
+
+  def test_participating_tests
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    test2 = Abongo.start_experiment!('test2', ['alt1', 'alt2'])
+    test3 = Abongo.start_experiment!('test3', ['alt1', 'alt2'])
+    assert_equal({}, Abongo.participating_tests)
+    Abongo.test('test1', ['alt1', 'alt2'])
+    assert_equal({'test1' => 'alt1'}, Abongo.participating_tests)
+    Abongo.test('test2', ['alt1', 'alt2'])
+    assert_equal({'test1' => 'alt1', 'test2' => 'alt1'}, Abongo.participating_tests)
+    Abongo.end_experiment!('test1', 'alt1')
+    assert_equal({'test2' => 'alt1'}, Abongo.participating_tests)
+    Abongo.end_experiment!('test2', 'alt1')
+    assert_equal({}, Abongo.participating_tests)
+  end
+
+  def test_participating_tests_with_noncurrent
+    Abongo.identity = 'ident'
+    test1 = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    test2 = Abongo.start_experiment!('test2', ['alt1', 'alt2'])
+    test3 = Abongo.start_experiment!('test3', ['alt1', 'alt2'])
+    assert_equal({}, Abongo.participating_tests)
+    Abongo.test('test1', ['alt1', 'alt2'])
+    assert_equal({'test1' => 'alt1'}, Abongo.participating_tests(false))
+    Abongo.test('test2', ['alt1', 'alt2'])
+    assert_equal({'test1' => 'alt1', 'test2' => 'alt1'}, Abongo.participating_tests(false))
+    Abongo.end_experiment!('test1', 'alt1')
+    assert_equal({'test1' => 'alt1', 'test2' => 'alt1'}, Abongo.participating_tests(false))
+    Abongo.end_experiment!('test2', 'alt1')
+    assert_equal({'test1' => 'alt1', 'test2' => 'alt1'}, Abongo.participating_tests(false))
+  end
+
+  def test_expires_in
+    Abongo.identity = 'ident'
+    Abongo.options[:expires_in] = 1
+    experiment = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+    
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(0, alternative['participants'])
+    assert_equal(0, alternative['conversions'])
+
+    Abongo.test('test1', ['alt1', 'alt2'])
+    Abongo.bongo!
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(1, alternative['participants'])
+    assert_equal(1, alternative['conversions'])
+
+    sleep(1)
+
+    Abongo.test('test1', ['alt1', 'alt2'])
+    Abongo.bongo!
+    alternative = Abongo.alternatives.find_one(:test => experiment['_id'], :content => 'alt1')
+    assert_equal(2, alternative['participants'])
+    assert_equal(2, alternative['conversions'])
+  end
+
+  def test_expires_in_for_bots
+    Abongo.identity = 'ident'
+    Abongo.options[:count_humans_only] = true
+    Abongo.options[:expires_in] = 1000
+    Abongo.options[:expires_in_for_bots] = 1
+    experiment = Abongo.start_experiment!('test1', ['alt1', 'alt2'])
+
+    Abongo.test('test1', ['alt1', 'alt2'])
+    participant = Abongo.find_participant(Abongo.identity)
+    assert(participant['expires'] < Time.now+1)
+
+    Abongo.human!
+    participant = Abongo.find_participant(Abongo.identity)
+    assert(participant['expires'] > Time.now+1)
+
+    Abongo.identity = 'ident2'
+    Abongo.human!
+    Abongo.test('test1', ['alt1', 'alt2'])
+    participant = Abongo.find_participant(Abongo.identity)
+    assert(participant['expires'] > Time.now+1)
+  end
+
+end