fabes 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+  rvm:
+    - 1.8.7
+    - 1.9.2
+    - 1.9.3
+  before_install:
+    - gem install bundler --pre

data/CHANGELOG

@@ -0,0 +1,12 @@
+=== Fabes ===
+
+= v0.0.1
+ - Improved the alternative selection, now using a basic 'epsilon-greedy' multi-armed bandit
+    # http://stevehanov.ca/blog/index.php?id=132
+    # http://www.cs.mcgill.ca/~vkules/bandits.pdf
+    # http://www.cs.nyu.edu/~mohri/pub/bandit.pdf
+
+ - Advancing with tests, though some love is needed
+
+= v0.0.0
+  - Basic implementation of the system, based on existing gems: split, vanity, some rails insights :)

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'redis'
+gem 'sinatra'
+
+group :development do
+  gem "mocha"
+  gem "pry"
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "> 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    metaclass (0.0.1)
+    method_source (0.8)
+    mocha (0.12.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (3.0.1)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    slop (3.3.2)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.0.0)
+  jeweler (>= 1.8.4)
+  mocha
+  pry
+  rdoc (~> 3.12)
+  redis
+  shoulda
+  simplecov
+  sinatra

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Alejandro Andres
+
+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.rdoc

@@ -0,0 +1,18 @@
+= fabes {<img src="https://secure.travis-ci.org/fuzzyalej/fabes.png" />}[http://travis-ci.org/fuzzyalej/fabes] {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/fuzzyalej/fabes]
+
+Fabes is an a/b testing gem
+
+== Contributing to fabes
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Sources
+
+* {split gem}[https://github.com/andrew/split/]
+* {vanity gem}[https://github.com/assaf/vanity/]

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fabes"
+  gem.homepage = "http://github.com/fuzzyalej/fabes"
+  gem.license = "MIT"
+  gem.summary = %Q{Fabulous A/B Experimenting System}
+  gem.description = %Q{Fabes is an A/B testing system for your ruby projects}
+  gem.email = "fuzzy.alej@gmail.com"
+  gem.authors = ["Alejandro Andres"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fabes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fabes.gemspec

@@ -0,0 +1,93 @@
+# 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 = "fabes"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alejandro Andres"]
+  s.date = "2012-07-23"
+  s.description = "Fabes is an A/B testing system for your ruby projects"
+  s.email = "fuzzy.alej@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fabes.gemspec",
+    "lib/fabes.rb",
+    "lib/fabes/admin.rb",
+    "lib/fabes/admin/public/application.css",
+    "lib/fabes/admin/views/index.haml",
+    "lib/fabes/admin/views/layout.haml",
+    "lib/fabes/alternative.rb",
+    "lib/fabes/configuration.rb",
+    "lib/fabes/connection_adapters/abstract_adapter.rb",
+    "lib/fabes/connection_adapters/redis_adapter.rb",
+    "lib/fabes/connection_handling.rb",
+    "lib/fabes/experiment.rb",
+    "lib/fabes/helper.rb",
+    "lib/fabes/utils.rb",
+    "test/helper.rb",
+    "test/test_abstract_adapter.rb",
+    "test/test_alternative.rb",
+    "test/test_configuration.rb",
+    "test/test_experiment.rb",
+    "test/test_helper.rb",
+    "test/test_redis_adapter.rb"
+  ]
+  s.homepage = "http://github.com/fuzzyalej/fabes"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Fabulous A/B Experimenting System"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis>, [">= 0"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<redis>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<redis>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["> 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/fabes/admin/public/application.css

@@ -0,0 +1,59 @@
+body {
+  font: normal 12px auto Verdana, Arial, Helvetica, sans-serif;
+  color: #FDF3E7;
+  background: #3B3738;
+}
+
+a {
+  color: #7E8F7C;
+}
+
+h2 {
+  font-size: 20px;
+  text-align: left;
+  margin-top: 50px;
+}
+
+h2.span {
+  font-size: 16px;
+}
+
+table {
+  width: 700px;
+  padding: 0px;
+  margin: 0px;
+}
+
+th {
+  border-right: 1px solid #A64C2E;
+  border-bottom: 1px solid #A64C2E;
+  border-top: 1px solid #D53500;
+  border-left: 1px solid #D53500;
+  letter-spacing: 2px;
+  text-transform: uppercase;
+  text-align: center;
+  font-size: 13px;
+  padding: 10px;
+  background: #C63D0F;
+  color: #FFFFFF;
+  text-shadow: 1px 1px 1px black;
+}
+
+td {
+  border-right: 1px solid #C1DAD7;
+  border-bottom: 1px solid #C1DAD7;
+  background: #FDF3E7;
+  padding: 6px;
+  color: #3B3738;
+  font-size: 13px;
+}
+
+#container {
+  margin: 50px auto;
+  text-align: center;
+  overflow: hidden;
+}
+
+#content {
+  display: inline-block;
+}

data/lib/fabes/admin/views/index.haml

@@ -0,0 +1,17 @@
+.experiments
+  -@experiments.each do |experiment|
+    -name = experiment.name
+    .experiment
+      %h2= "Experiment: #{name.capitalize}"
+      %table{id: name.first, cellspacing: 0, summary: "Data for experiment '#{name}'"}
+        %tr
+          %th{scope: 'col'} Alternative
+          %th{scope: 'col'} Participants
+          %th{scope: 'col'} Hits
+          %th{scope: 'col'} Weight
+        - experiment.alternatives.each do |alternative|
+          %tr
+            %td{title: alternative.id}= alternative.payload
+            %td= alternative.participants
+            %td= alternative.hits
+            %td= alternative.weight

data/lib/fabes/admin/views/layout.haml

@@ -0,0 +1,11 @@
+!!!
+%html
+  %head
+    %title= @title || 'Fabes Administration Panel'
+    %link{href: request.env['SCRIPT_NAME'] + '/application.css', media: 'all', rel: 'stylesheet', type: 'text/css'}
+  %body
+    #container
+      #header
+        .logo
+      #content
+        =yield

data/lib/fabes/admin.rb

@@ -0,0 +1,15 @@
+require 'sinatra'
+
+module Fabes
+  class Admin < Sinatra::Base
+    dir = File.dirname File.expand_path __FILE__
+    set :views, dir + '/admin/views'
+    set :public_folder, dir + '/admin/public'
+    set :static, true
+
+    get '/' do
+      @experiments = Fabes::Experiment.all
+      haml :index
+    end
+  end
+end

data/lib/fabes/alternative.rb

@@ -0,0 +1,54 @@
+module Fabes
+  class Alternative
+    #TODO: move some of these to attr_reader
+    attr_accessor :weight, :payload, :participants, :hits, :id
+
+    def initialize(payload)
+      @id = generate_id
+      @weight = 0.0
+      @participants = 0
+      @hits = 0
+      @payload = payload
+    end
+
+    def increment_participants!
+      @participants = @participants.to_i + 1
+      Fabes.db.increment_participants!(id)
+    end
+
+    def increment_hits!
+      @hits = @hits.to_i + 1
+      Fabes.db.increment_hits!(id)
+    end
+
+    def update_weight
+      @weight = calculate_weight
+      Fabes.db.update_weight(id, @weight)
+    end
+
+    def self.create_from(data)
+      alternative = new(data.delete :payload)
+      data.each do |k, v|
+        alternative.send "#{k}=", v
+      end
+      alternative
+    rescue
+      raise 'Error creating an alternative'
+    end
+
+    def weight
+      @weight.to_f
+    end
+
+    private
+
+    def generate_id
+      #TODO: maybe this could be easier with a redis counter?
+      rand(36**10).to_s(36)
+    end
+
+    def calculate_weight
+      @hits.to_f / @participants.to_f
+    end
+  end
+end

data/lib/fabes/configuration.rb

@@ -0,0 +1,17 @@
+module Fabes
+  class Configuration
+    attr_accessor :adapter, :db
+
+    def initialize
+      @adapter = 'redis'
+      @db = nil
+    end
+
+    def use(db_config)
+      @adapter = db_config[:adapter].to_s
+      @db = db_config[:db] || ENV['FABES_DB_URL'] || ENV['REDISTOGO_URL']
+    rescue => e
+      raise "Bad 'use' config: #{e.message}"
+    end
+  end
+end

data/lib/fabes/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,29 @@
+module Fabes
+  module ConnectionHandling
+    extend self
+
+    def establish_connection(db, adapter)
+      #TODO: automagically parse db a la rails
+      #REF: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_handling.rb
+      adapter_method = "#{adapter}_connection"
+      send adapter_method, db
+    rescue => e
+      raise "Could not find #{adapter} adapter!"
+    end
+
+    def parse_connection_url(url)
+    end
+  end
+
+  module ConnectionAdapters
+    class AbstractAdapter
+      def clear!;end
+      def save_experiment(experiment);end
+      def find_experiment(name);end
+      def increment_participants!(id);end
+      def increment_hits!(id);end
+      def update_weight(id, weight);end
+      def all_experiments;end
+    end
+  end
+end

data/lib/fabes/connection_adapters/redis_adapter.rb

@@ -0,0 +1,109 @@
+module Fabes
+  module ConnectionHandling
+    def self.redis_connection(db)
+      require 'redis'
+      db ||= ::Redis.new
+      ConnectionAdapters::RedisAdapter.new(db)
+    end
+  end
+
+  module ConnectionAdapters
+    class RedisAdapter < AbstractAdapter
+      def initialize(redis)
+        @redis = redis
+      end
+
+      def clear!
+        @redis.flushdb
+      end
+
+      def save_experiment(experiment)
+        add_to_current_experiments(experiment.name)
+        save_experiment_data(experiment)
+      rescue
+        raise "Unable to save experiment"
+      end
+
+      def find_experiment(name)
+        if @redis.sismember "fabes:experiments", name
+          load_experiment(name)
+        else
+          nil
+        end
+      end
+
+      def increment_hits!(id)
+        @redis.hincrby "fabes:alternatives_pool:#{id}", 'hits', 1
+      end
+
+      def increment_participants!(id)
+        @redis.hincrby "fabes:alternatives_pool:#{id}", 'participants', 1
+      end
+
+      def update_weight(id, weight)
+        @redis.hset "fabes:alternatives_pool:#{id}", 'weight', weight
+      end
+
+      def all_experiments
+        experiments = Array.new
+        names = get_all_experiment_names
+        names.each do |name|
+          experiments << load_experiment(name)
+        end
+        experiments
+      end
+
+      private
+
+      def get_all_experiment_names
+        @redis.smembers 'fabes:experiments'
+      end
+
+      def add_to_current_experiments(name)
+        @redis.sadd "fabes:experiments", name
+      end
+
+      def save_experiment_data(experiment)
+        save_alternatives(experiment.name, experiment.alternatives)
+      end
+
+      def save_alternatives(base, alternatives)
+        alternatives.each do |alt|
+          add_to_alternatives(base, alt.id)
+          data = Array.new
+          alt.instance_variables.each do |var|
+            data << var.slice(1..-1) << alt.instance_variable_get(var)
+          end
+          @redis.hmset "fabes:alternatives_pool:#{alt.id}", *data
+        end
+      end
+
+      def add_to_alternatives(base, alternative)
+        @redis.rpush "fabes:alternatives:#{base}", alternative
+      end
+
+      def load_experiment(name)
+        experiment = Experiment.new(name)
+        alternatives = load_alternatives(name)
+        alternatives.each do |alternative|
+          experiment.add_alternative(alternative)
+        end
+        experiment
+      end
+
+      def load_alternatives(base)
+        alternatives = Array.new
+          ids = @redis.lrange "fabes:alternatives:#{base}", 0, -1
+          ids.each do |id|
+            alternatives.push load_alternative(id)
+          end
+        alternatives
+      end
+
+      def load_alternative(id)
+        data = @redis.hgetall "fabes:alternatives_pool:#{id}"
+        Alternative.create_from data
+      end
+    end
+  end
+end

data/lib/fabes/connection_handling.rb

@@ -0,0 +1,2 @@
+require 'fabes/connection_adapters/abstract_adapter'
+require 'fabes/connection_adapters/redis_adapter'

data/lib/fabes/experiment.rb

@@ -0,0 +1,66 @@
+module Fabes
+  class Experiment
+    attr_accessor :name, :description, :alternatives
+
+    def initialize(name, *alternatives)
+      @name = name
+      @alternatives = alternatives.map do |alternative|
+        Fabes::Alternative.new alternative
+      end
+      save
+    end
+
+    def self.find_or_create(name, *alternatives)
+      #TODO: What happens if same experiment but different alternatives?
+      #TODO: check the validation of alternatives
+      experiment = find(name) or new(name, *alternatives)
+    end
+
+    def self.find(name)
+      Fabes.db.find_experiment name
+    end
+
+    def self.all
+      Fabes.db.all_experiments
+    end
+
+    #TODO: make this an option and add different alternative selection algorithms
+    def select_alternative!
+      if exploration?
+        random_alternative
+      else #exploitation
+        heaviest_alternative
+      end
+    end
+
+    def find_alternative(id)
+      @alternatives.select {|alternative| alternative.id == id }.first or control
+    end
+
+    def save
+      Fabes.db.save_experiment(self)
+    end
+
+    def add_alternative(alternative)
+      @alternatives.push alternative
+    end
+
+    def control
+      @alternatives.first
+    end
+
+    private
+
+    def exploration?
+      rand() < 0.2 # 20% of times
+    end
+
+    def random_alternative
+      @alternatives.shuffle.first
+    end
+
+    def heaviest_alternative
+      @alternatives.max {|alternative| alternative.weight}
+    end
+  end
+end