ablab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e0904fd152e122cdfb9d1ffc0df8d53218da409
+  data.tar.gz: 045967d4a48b868743483c63330705eb033b02ea
+SHA512:
+  metadata.gz: 60ec6daba0bd352ebe1e2ababb95b52a0dab305ed6635bf8bdede39497beb2fb50edaf49b7d9ac1fc92fa8d61afdf4f87cb62b1b19ebdb2b6ea3071a4a4b26b5
+  data.tar.gz: 57e929adb46056e0b1172720552150fb92ab7f998431bb6ad04a8a5d8bac16e350e9a5846e961469f4c1a4dee00505d7dc3cc7a10d8414490127508e1e5d8011

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+dump.rdb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loveos-abtest.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# ABLab
+
+A minimal library for performing AB-tests in Rails applications and checking
+their statistical significance.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ablab'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ablab
+
+
+## Usage
+
+```ruby
+# In `initializers/ablab.rb`
+
+ABLab.setup do
+  store :redis, host: 'localhost', port: 6379
+
+  experiment :product_page do
+    description "Experiments on the product page"
+
+    group :a, control: true, description: "control group"
+    group :b, description: "show more products from the shop at the top"
+  end
+
+  experiment :search do
+    description "Search experiments"
+
+    group :a, control: true, description: "control group"
+    group :b, description: "boost CTR"
+    group :c, description: "boost GMV"
+  end
+end
+
+
+# In application_controller.rb
+
+require 'ablab'
+
+class ApplicationController < ActionController::Base
+  include ABLab::Controller
+end
+
+
+# In app controllers/views code
+
+experiment(:product_page).in_group?(:a) # => true or false
+experiment(:product_page).group         # => :a or :b
+
+experiment(:product_page).track_view!
+experiment(:product_page).track_conversion!
+
+
+# Results of the experiment
+ABTest.experiments.each do |experiment|
+  puts "#{experiment.name}: #{experiment.results.inspect}"
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/lucaong/ablab).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ablab.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ablab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ablab"
+  spec.version       = ABLab::VERSION
+  spec.authors       = ["Luca Ongaro"]
+  spec.email         = ["lukeongaro@gmail.com"]
+
+  spec.summary       = "Minimal library for performing AB tests"
+  spec.description   = "Minimal library for performing AB tests, measuring statistical significance."
+  spec.homepage      = "http://github.com/lucaong/ablab"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "loveos/abtest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ablab.rb

@@ -0,0 +1,124 @@
+require "ablab/version"
+require "ablab/controller"
+require "ablab/store"
+
+module ABLab
+  module ModuleMethods
+    attr_reader :experiments
+
+    def setup(&block)
+      instance_exec(&block)
+    end
+
+    def experiment(name, &block)
+      @experiments ||= {}
+      @experiments[name] = Experiment.new(name, &block)
+    end
+
+    def store(type, *args)
+      if type.is_a? Class
+        @tracker = Class.new(*args)
+      else
+        class_name = type.to_s.split('_').map(&:capitalize).join
+        @tracker = ABLab::Store.const_get(class_name).new(*args)
+      end
+    end
+
+    def tracker
+      @tracker ||= ABLab::Store::Memory.new
+    end
+  end
+
+  extend ModuleMethods
+
+  class Experiment
+    attr_reader :name, :groups, :control
+
+    def initialize(name, &block)
+      @name   = name
+      @groups = []
+      instance_exec(&block)
+    end
+
+    def description(desc = nil)
+      @description = desc if desc
+      @description
+    end
+
+    def group(name, options = {})
+      group = Group.new(name, options[:description])
+      @control = group if options[:control]
+      @groups << group
+    end
+
+    def results
+      @result ||= Result.new(self)
+      @result.data
+    end
+
+    def run(uid)
+      draw = Random.new(uid.hash * name.hash).rand(1000)
+      Run.new(self, draw)
+    end
+  end
+
+  class Run
+    attr_reader :group, :experiment
+
+    def initialize(experiment, draw)
+      idx         = (draw / (1000.0 / experiment.groups.size)).floor
+      @experiment = experiment
+      @group      = experiment.groups[idx].name
+    end
+
+    def in_group?(name)
+      group == name
+    end
+
+    def track_view!
+      ABLab.tracker.track_view!(experiment.name, group)
+    end
+
+    def track_conversion!
+      ABLab.tracker.track_conversion!(experiment.name, group)
+    end
+  end
+
+  class Group < Struct.new(:name, :description); end
+
+  class Result
+    extend Forwardable
+    def_delegators :@experiment, :name, :control, :groups
+
+    def initialize(experiment)
+      @experiment = experiment
+    end
+
+    def data
+      raise NoControlGroup.new("no control group") if control.nil?
+      c_views, c_conv = views_and_conversions(control)
+      groups.map do |group|
+        if group == control
+          next { views: c_views, conversions: c_conv, control: true }
+        end
+        views, conv = views_and_conversions(group)
+        z = z_score(views, conv, c_views, c_conv)
+        { views: views, conversions: conv, z_score: z, control: false }
+      end
+    end
+
+    private def views_and_conversions(group)
+      views       = ABLab.tracker.views(name, group.name)
+      conversions = ABLab.tracker.conversions(name, group.name)
+      [views, conversions]
+    end
+
+    private def z_score(views, conv, c_views, c_conv)
+      p  = conv.to_f / views
+      pc = c_conv.to_f / c_views
+      (p - pc) / Math.sqrt((p*(1 - p) / views) + (pc*(1 - pc) / c_views))
+    end
+
+    class NoControlGroup < StandardError; end
+  end
+end

data/lib/ablab/controller.rb

@@ -0,0 +1,16 @@
+module ABLab
+  module Controller
+    private def experiment(name)
+      @experiments ||= {}
+      unless ABLab.experiments.has_key?(name)
+        raise "No experiment with name #{name}"
+      end
+      @experiments[name] ||=
+        ABLab.experiments[name].run(user_id_for_experiments)
+    end
+
+    private def user_id_for_experiments
+      env['rack.session'].id
+    end
+  end
+end

data/lib/ablab/store.rb

@@ -0,0 +1,2 @@
+require 'ablab/store/memory'
+require 'ablab/store/redis'

data/lib/ablab/store/memory.rb

@@ -0,0 +1,30 @@
+module ABLab
+  module Store
+    class Memory
+      def initialize
+        @views = Hash.new do |hash, key|
+          hash[key] = Hash.new { |hash, key| hash[key] = 0 }
+        end
+        @conversions = Hash.new do |hash, key|
+          hash[key] = Hash.new { |hash, key| hash[key] = 0 }
+        end
+      end
+
+      def track_view!(experiment, bucket)
+        @views[experiment][bucket] += 1
+      end
+
+      def track_conversion!(experiment, bucket)
+        @conversions[experiment][bucket] += 1
+      end
+
+      def views(experiment, bucket)
+        @views[experiment][bucket]
+      end
+
+      def conversions(experiment, bucket)
+        @conversions[experiment][bucket]
+      end
+    end
+  end
+end

data/lib/ablab/store/redis.rb

@@ -0,0 +1,39 @@
+require 'redis'
+
+module ABLab
+  module Store
+    class Redis
+      attr_reader :redis
+
+      def initialize(opts = {})
+        @key_prefix = opts[:key_prefix] || 'ablab'
+        @redis = ::Redis.new(opts)
+      end
+
+      def track_view!(experiment, bucket)
+        redis.hincrby(key(:views), field(experiment, bucket), 1)
+      end
+
+      def track_conversion!(experiment, bucket)
+        redis.hincrby(key(:conversions), field(experiment, bucket), 1)
+      end
+
+      def views(experiment, bucket)
+        (redis.hget(key(:views), field(experiment, bucket)) || 0).to_i
+      end
+
+      def conversions(experiment, bucket)
+        (redis.hget(key(:conversions), field(experiment, bucket)) || 0).to_i
+      end
+
+      private def key(type)
+        "#{@key_prefix}:#{type}"
+      end
+
+      private def field(experiment, bucket)
+        "#{experiment}:#{bucket}"
+      end
+    end
+  end
+end
+

data/lib/ablab/version.rb

@@ -0,0 +1,3 @@
+module ABLab
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ablab
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luca Ongaro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimal library for performing AB tests, measuring statistical significance.
+email:
+- lukeongaro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- ablab.gemspec
+- bin/console
+- bin/setup
+- lib/ablab.rb
+- lib/ablab/controller.rb
+- lib/ablab/store.rb
+- lib/ablab/store/memory.rb
+- lib/ablab/store/redis.rb
+- lib/ablab/version.rb
+homepage: http://github.com/lucaong/ablab
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Minimal library for performing AB tests
+test_files: []