abnormal 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Patrick McKenzie
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+A/B testing for Ruby

data/lib/abnormal.rb

@@ -0,0 +1,95 @@
+require 'abnormal/version'
+
+class Abnormal
+  def self.db; @@db; end
+  def self.db=(db)
+    @@db = db
+  end
+
+  def self.ab_test(identity, test_name, alternatives, conversions)
+    conversions = [conversions]  unless conversions.is_a? Array
+
+    test_id = Digest::MD5.hexdigest(test_name)
+    db['tests'].update(
+      {:name => test_name, :_id => test_id},
+      {
+        :$set => {
+          :alternatives => alternatives,
+        },
+        :$addToSet => {
+          :conversions => {:$each => conversions}
+        }
+      },
+      :upsert => true
+    )
+
+    conversions.each do |conversion|
+      db['participations'].update(
+        {
+          :participant => identity,
+          :test_id => test_id,
+          :conversion => conversion
+        },
+        {
+          :$set => {:conversions => 0}
+        },
+        :upsert => true
+      )
+    end
+
+    chose_alternative(identity, test_name, alternatives)
+  end
+
+  def self.convert!(identity, conversion)
+    db['participations'].update(
+      {
+        :participant => identity,
+        :conversion => conversion
+      },
+      {
+        :$inc => {:conversions => 1}
+      },
+      :multi => true
+    )
+  end
+
+  def self.get_test(test_id)
+    db['tests'].find_one(:_id => test_id)
+  end
+
+  def self.tests
+    db['tests'].find.to_a
+  end
+
+  def self.get_participation(id, test_name, conversion)
+    db['participations'].find_one(
+      :participant => id,
+      :test_id => Digest::MD5.hexdigest(test_name),
+      :conversion => conversion
+    )
+  end
+
+  def self.participations
+    db['participations'].find.to_a
+  end
+
+  def self.chose_alternative(identity, test_name, alternatives)
+    alternatives_array = normalize_alternatives(alternatives)
+    index = Digest::MD5.hexdigest(test_name + identity).to_i(16) % alternatives_array.size
+    alternatives_array[index]
+  end
+
+  def self.normalize_alternatives(alternatives)
+    case alternatives
+    when Array
+      alternatives
+    when Hash
+      alternatives_array = []
+      idx = 0
+      alternatives.each{|k,v| alternatives_array.fill(k, idx, v); idx += v}
+      alternatives_array
+    when Range
+      alternatives.to_a
+    end
+  end
+end

data/lib/abnormal.rb~

@@ -0,0 +1,20 @@
+require 'abnormal/version'
+
+class Abnormal
+  def self.db; @@db; end
+  def self.db=(db)
+    @@db = db
+  end
+
+  def self.ab_test(identity, test_name, alternatives, conversions)
+    db['tests'].update({:name => test_name}, {:$set => {:alternatives => alternatives, :id => Digest::MD5.hexdigest(test_name)}}, :upsert => true)
+  end
+
+  def self.get_test(test_id)
+    db['tests'].find_one(:id => test_id)
+  end
+
+  def self.tests
+    db['tests'].find.to_a
+  end
+end

data/lib/abnormal/version.rb

@@ -0,0 +1,4 @@
+class Abnormal
+  VERSION = '0.0.0'
+  MAJOR_VERSION = '0'
+end

data/spec/abnormal_spec.rb

@@ -0,0 +1,240 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'abnormal'
+
+Bundler.require(:development)
+
+describe Abnormal do
+  before(:all) do
+    Abnormal.db = Mongo::Connection.new['abnormal_test']
+  end
+
+  before(:each) do
+    Abnormal.db['tests'].drop
+    Abnormal.db['participations'].drop
+  end
+
+  describe 'ab_test' do
+    describe 'the first call for a new test' do
+      it "adds that test to the test table" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+	Abnormal.get_test(Digest::MD5.hexdigest('test'))['name'].should == 'test'
+      end
+    end
+
+    describe "multiple calls for the same test" do
+      it "doesn't add a duplicate test" do
+        Abnormal.ab_test('id1', 'test', [1, 2], 'conversion')
+        Abnormal.ab_test('id2', 'test', [1, 2], 'conversion')
+        Abnormal.should have(1).tests
+      end
+    end
+
+    describe "multiple calls for multiple tests" do
+      it "creates multiple tests" do
+        Abnormal.ab_test('id', 'test1', [1, 2], 'conversion')
+        Abnormal.ab_test('id', 'test2', [1, 2], 'conversion')
+        Abnormal.should have(2).tests
+      end
+    end
+
+    describe "a call with one conversion" do
+      it "sets that conversion on the test" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.get_test(Digest::MD5.hexdigest('test'))['conversions'].to_set.should == %w[conversion].to_set
+      end
+    end
+
+    describe "multiple calls with the same conversion" do
+      it "doesn't add a duplicate conversions" do
+        Abnormal.ab_test('id1', 'test', [1, 2], 'conversion')
+        Abnormal.ab_test('id2', 'test', [1, 2], 'conversion')
+        Abnormal.get_test(Digest::MD5.hexdigest('test'))['conversions'].should have(1).items
+      end
+    end
+
+    describe "a call with multiple conversions" do
+      it "sets all of the conversions" do
+        Abnormal.ab_test('id', 'test', [1, 2], %w[conversion1 conversion2])
+        Abnormal.get_test(Digest::MD5.hexdigest('test'))['conversions'].to_set.should == %w[conversion1 conversion2].to_set
+      end
+    end
+
+    describe "multiple calls with different conversions" do
+      it "sets all of the conversions" do
+        Abnormal.ab_test('id1', 'test', [1, 2], 'conversion1')
+        Abnormal.ab_test('id2', 'test', [1, 2], 'conversion2')
+        Abnormal.get_test(Digest::MD5.hexdigest('test'))['conversions'].to_set.should == %w[conversion1 conversion2].to_set
+      end
+    end
+
+    describe "the first call by an identity that has not participated in the test with the conversion" do
+      it "records in the participation" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.get_participation('id', 'test', 'conversion').should be
+      end
+
+      it "has 0 conversions" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.get_participation('id', 'test', 'conversion')['conversions'].should == 0
+      end
+    end
+
+    describe "subsequent calls by an identity that has participated in the test with the conversion" do
+      it "records in the participation" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.should have(1).participations
+      end
+    end
+
+    describe "a call with multiple conversions" do
+      it "makes multiple participations" do
+        Abnormal.ab_test('id1', 'test', [1, 2], %w[conversion1 conversion2])
+        Abnormal.should have(2).participations
+      end
+    end
+
+    describe "different calls by different identities" do
+      it "makes different participations" do
+        Abnormal.ab_test('id1', 'test', [1, 2], 'conversion')
+        Abnormal.ab_test('id2', 'test', [1, 2], 'conversion')
+        Abnormal.should have(2).participations
+      end
+    end
+
+    describe "different calls for different tests" do
+      it "makes different participations" do
+        Abnormal.ab_test('id', 'test1', [1, 2], 'conversion')
+        Abnormal.ab_test('id', 'test2', [1, 2], 'conversion')
+        Abnormal.should have(2).participations
+      end
+    end
+
+    describe "different calls with different conversions" do
+      it "makes different participations" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion1')
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion2')
+        Abnormal.should have(2).participations
+      end
+    end
+
+    it "returns the correct alternative" do
+      Abnormal.stub(:chose_alternative){ 3 }
+      Abnormal.ab_test('id', 'test', [1, 2], 'conversion').should == 3
+    end
+  end
+
+  # I don't like any of these... is there a better way to do this?
+  describe "choose_alternative" do
+    it "returns the same result for the same user and test" do
+      alt1 = Abnormal.chose_alternative('id', 'test', [1, 2])
+      alt2 = Abnormal.chose_alternative('id', 'test', [1, 2])
+      alt1.should == alt2
+    end
+
+    it "returns different results for different users" do
+      alt1 = Abnormal.chose_alternative('id1', 'test', [1, 2])
+      alt2 = Abnormal.chose_alternative('id2', 'test', [1, 2])
+      alt1.should_not == alt2
+    end
+
+    it "returns different results for different tests" do
+      alt1 = Abnormal.chose_alternative('id', 'test_1', [1, 2])
+      alt2 = Abnormal.chose_alternative('id', 'test2', [1, 2])
+      alt1.should_not == alt2
+    end
+
+    it "returns all possible alternatives" do
+      alternatives = [1, 2]
+      actual_alternatives = (1..10).map{|i| Abnormal.chose_alternative("id#{i}", 'test', alternatives) }
+
+      actual_alternatives.to_set.should == alternatives.to_set
+    end
+
+    it "uses normalize_alternatives" do
+      Abnormal.stub(:normalize_alternatives){ [3] }
+      Abnormal.chose_alternative('id', 'test1', [1, 2]).should == 3
+    end
+  end
+
+  describe "convert!" do
+    describe "with an identity/conversion pair that does not exist" do
+      it "does nothing" do
+        Abnormal.convert!('id', 'conversion')
+        Abnormal.should have(0).participations
+      end
+
+      it "does not apply to future participations" do
+        identity = 'id'
+        test_name = 'test'
+        conversion = 'conversion'
+
+        Abnormal.convert!(identity, conversion)
+        Abnormal.ab_test(identity, test_name, [1, 2], conversion)
+        Abnormal.get_participation(identity, test_name, conversion)['conversions'].should == 0
+      end
+    end
+
+    describe "with an identity/conversion pair that does exist" do
+      it "records the conversions" do
+        identity = 'id'
+        test_name = 'test'
+        conversion = 'conversion'
+
+        Abnormal.ab_test(identity, test_name, [1, 2], conversion)
+        Abnormal.convert!(identity, conversion)
+        Abnormal.get_participation(identity, test_name, conversion)['conversions'].should == 1
+      end
+    end
+
+    describe "an identity participating in multiple tests with the conversions" do
+      it "records the conversion for the each test" do
+        identity = 'id'
+        conversion = 'conversion'
+
+        Abnormal.ab_test(identity, 'test1', [1, 2], conversion)
+        Abnormal.ab_test(identity, 'test2', [1, 2], conversion)
+        Abnormal.convert!(identity, conversion)
+        Abnormal.get_participation(identity, 'test1', conversion)['conversions'].should == 1
+        Abnormal.get_participation(identity, 'test2', conversion)['conversions'].should == 1
+      end
+    end
+
+    describe "an identity participating in multiple tests, not all of which have the conversion" do
+      it "only records a conversion for the test listening to that conversion" do
+        identity = 'id'
+
+        Abnormal.ab_test(identity, 'test1', [1, 2], 'conversion1')
+        Abnormal.ab_test(identity, 'test2', [1, 2], 'conversion2')
+        Abnormal.convert!(identity, 'conversion1')
+        Abnormal.get_participation(identity, 'test1', 'conversion1')['conversions'].should == 1
+        Abnormal.get_participation(identity, 'test2', 'conversion2')['conversions'].should == 0
+      end
+    end
+  end
+
+  describe "normalize_alternatives" do
+    describe "given an array" do
+      it "returns the array" do
+        Abnormal.normalize_alternatives([1, 2, 7]).should == [1, 2, 7]
+      end
+    end
+
+    describe "given a hash" do
+      it "expands the hash into an array" do
+        Abnormal.normalize_alternatives({:a => 1, :b => 9}).should == [:a, :b, :b, :b, :b, :b, :b, :b, :b, :b]
+      end
+    end
+
+    describe "given a range" do
+      it "converts the range into a hash" do
+        Abnormal.normalize_alternatives(1..10).should == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+      end
+    end
+  end
+end

data/spec/abnormal_spec.rb~

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'abnormal'
+
+Bundler.require(:development)
+
+describe Abnormal do
+  before(:all) do
+    Abnormal.db = Mongo::Connection.new['abnormal_test']
+  end
+
+  before(:each) do
+    Abnormal.db['tests'].drop
+  end
+
+  describe 'ab_test' do
+    describe 'the first call for a new test' do
+      it "adds that test to the test table" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+	Abnormal.get_test(Digest::MD5.hexdigest('test'))['name'].should == 'test'
+      end
+    end
+
+    describe "multiple calls for the same test" do
+      it "doesn't add a duplicate test" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.ab_test('id2', 'test', [1, 2], 'conversion')
+        Abnormal.should have(1).tests
+      end
+    end
+
+    describe "multiple calls for multiple tests" do
+      it "should create multiple tests" do
+        Abnormal.ab_test('id', 'test', [1, 2], 'conversion')
+        Abnormal.ab_test('id', 'test2', [1, 2], 'conversion')
+        Abnormal.should have(2).tests
+      end
+    end
+
+    it "returns the correct alternative" do
+      Abnormal.stub(:chose_alternative){ 3 }
+      Abnormal.ab_test('id', 'test', [1, 2], 'conversion').should == 3
+    end
+  end
+
+  # I don't like any of these... is there a better way to do this?
+  describe "choose_alternative" do
+    it "returns the same result for the same user and test" do
+      alt1 = Abnormal.chose_alternative('id', 'test', [1, 2])
+      alt2 = Abnormal.chose_alternative('id', 'test', [1, 2])
+      alt1.should == alt2
+    end
+
+    it "returns different results for different users" do
+      alt1 = Abnormal.chose_alternative('id1', 'test', [1, 2])
+      alt2 = Abnormal.chose_alternative('id2', 'test', [1, 2])
+      alt1.should_not == alt2
+    end
+
+    it "returns different results for different tests" do
+      alt1 = Abnormal.chose_alternative('id', 'test_1', [1, 2])
+      alt2 = Abnormal.chose_alternative('id', 'test2', [1, 2])
+      alt1.should_not == alt2
+    end
+
+    it "returns all possible alternatives" do
+      alternatives = [1, 2]
+      actual_alternatives = (1..10).map{|i| Abnormal.chose_alternative("id#{i}", 'test', alternatives) }
+
+      actual_alternatives.to_set.should == alternatives.to_set
+    end
+  end
+end

data/test/test_abnormal.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test/unit'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'abnormal'
+
+Bundler.require(:development)
+
+class TestAbnormal < Test::Unit::TestCase
+  def setup
+  end
+end

data/test/test_abnormal.rb~

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test/unit'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'abnormal'
+
+Bundler.require(:development)
+
+class TestAbnormal < Test::Unit::TestCase
+  def setup
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: abnormal
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Michael Fairley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- michaelfairley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/abnormal/version.rb
+- lib/abnormal/version.rb~
+- lib/abnormal.rb
+- lib/abnormal.rb~
+- test/test_abnormal.rb
+- test/test_abnormal.rb~
+- spec/abnormal_spec.rb
+- spec/abnormal_spec.rb~
+- MIT-LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/michaelfairley/abnormal
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby A/B testing
+test_files: 
+- test/test_abnormal.rb
+- spec/abnormal_spec.rb