ab 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sparkboxx
+
+MIT License
+
+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,29 @@
+# OleryAb
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'olery_ab'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install olery_ab
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ab.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ab/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ab"
+  gem.version       = Ab::VERSION
+  gem.authors       = ["sparkboxx", "giannismelidis"]
+  gem.email         = ["wilcovanduinkerken@olery.com", "giannismelidis@olery.com"]
+  gem.description   = %q{Basic AB testing gem}
+  gem.summary       = %q{The gem provides a basic class Tester or view helper function ab that allows you to deterministically show a certain option (a/b/c/etc) to a user based on a certain chance (e.g. 1/5)}
+  gem.homepage      = "http://github.com/olery/ab"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency("rspec")
+end

data/lib/ab.rb

@@ -0,0 +1,23 @@
+require "digest/sha1"
+
+require "ab/version"
+require "ab/tester"
+require "ab/indexer"
+require "ab/chance"
+require 'ab/view_helpers'
+
+require 'ab/railtie' if defined?(Rails)
+
+#
+# Overall Initial Idea:
+#
+
+#options = []
+#options << link_to("some kind of url")
+#options << link_to("the other url")
+
+# = ab_test(:options=>options, :chance=>"1/1", :input=>user.id, :name=>"announcements") # returns an option
+
+module Ab
+end
+

data/lib/ab/chance.rb

@@ -0,0 +1,36 @@
+module Ab
+  class Chance
+    attr_reader :chances
+
+    def initialize(chance_string)
+      raw_chances = self.class.split_chance(chance_string)
+      validate_raw_chances(raw_chances)
+
+      @chances = self.class.normalize(raw_chances)
+    end
+
+    def self.normalize(array)
+      sum = array.reduce(&:+)
+      factor = 100.to_f / sum
+      array.map{|e| e * factor}.map(&:to_i)
+    end
+
+    def self.split_chance(string)
+      string.split("/").map(&:to_i)
+    end
+
+    def validate_raw_chances(chances)
+      chances.each do |chance|
+        raise ArgumentError.new("chance should be > 0") if chance < 0
+      end
+    end
+
+    def count
+      chances.count
+    end
+
+    def to_a
+      chances
+    end
+  end
+end

data/lib/ab/indexer.rb

@@ -0,0 +1,75 @@
+module Ab
+  class Indexer
+    def self.call(opts={})
+      validate_options(opts)
+
+      value = opts[:value].to_s
+      chances = opts[:chances]
+      salt = opts[:seed].to_s
+
+      seed = Digest::SHA1.hexdigest(salt + value).to_i
+      random_number = Randomizer.new(seed).rand(1..100)
+
+      sum = 0
+      chances.each_index do |index|
+        min = sum
+        max = chances[index] + sum
+
+        if (min..max).include?(random_number)
+          return index
+        end
+
+        sum = max
+      end
+      raise IndexError.new("Could not resolve any index for the given chances")
+    end
+
+
+    private
+
+    def self.validate_options(opts)
+      keys = [:value, :chances, :seed]
+      keys.each do |key|
+        raise ArgumentError.new("Missing option: :#{key}") if opts[key].nil?
+      end
+
+      if opts[:chances].reduce(&:+)==0
+        raise ArgumentError.new("Chances does not actually contain any chance")
+      end
+    end
+
+    class Randomizer
+      attr_reader :randomizer
+
+      def initialize(seed)
+        if RUBY_VERSION =~ /^1.8/
+          @randomizer = OneEight.new(seed)
+        else
+          @randomizer = Random.new(seed)
+        end
+      end
+
+      def rand(value)
+        randomizer.rand(value)
+      end
+
+      private
+
+      class OneEight
+        def initialize(seed)
+          srand(seed)
+        end
+
+        def rand(value)
+          if value.kind_of?(Range)
+            first = value.first
+            last = value.last - first
+            return Kernel::rand(last) + first
+          else
+            Kernel::rand(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ab/railtie.rb

@@ -0,0 +1,9 @@
+require 'ab/view_helpers'
+
+module Ab
+  class Railtie < Rails::Railtie
+    initializer "ab.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/ab/tester.rb

@@ -0,0 +1,42 @@
+module Ab
+  class Tester
+    attr_reader :options, :chances, :input, :name
+
+    def initialize(opts={})
+      opts = defaults.merge!(opts)
+
+      @options = opts[:options]
+      @chances = Chance.new(opts[:chances])
+      @input = opts[:input]
+      @indexer = opts[:indexer]
+      @name = opts[:name]
+    end
+
+    def valid?
+      chances.count == options.count
+    end
+
+    def validate!
+      raise ArgumentError unless valid?
+    end
+
+    def call(id)
+      validate!
+      index = @indexer.call(:value=>id,:chances=>chances.to_a, :seed=>name)
+      if block_given?
+        yield options[index]
+      else
+        return options[index]
+      end
+    end
+    alias_method :for, :call
+
+    private
+    def defaults
+      { :options=>[true,false],
+        :chances=>"50/50",
+        :name=>"Please provide me a name",
+        :indexer=>Indexer }
+    end
+  end
+end

data/lib/ab/version.rb

@@ -0,0 +1,3 @@
+module Ab
+  VERSION = "0.0.1"
+end

data/lib/ab/view_helpers.rb

@@ -0,0 +1,7 @@
+module Ab
+  module ViewHelpers
+    def ab(options={})
+      Ab::Tester.new(options)
+    end
+  end
+end

data/spec/ab_test_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'ab/view_helpers.rb'
+
+describe "Helper Method" do
+  class View
+    include Ab::ViewHelpers
+  end
+
+  let(:view){ View.new}
+
+  it "should do nothing on empty calls" do
+    expect{view.ab}.to_not raise_error
+  end
+
+  it "should take multiple options" do
+    expect{view.ab(:options=>[1,2,3], :chance=>"1/2/2", :input=>50)}.to_not raise_error
+  end
+
+end
+

data/spec/chance_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Ab::Chance do
+  it "should split a string into a an array of integers" do
+    Chance.split_chance("10/20/30").should eql([10,20,30])
+  end
+
+  it "should not accept minus chances" do
+    expect{Chance.new("-1/0/0")}.to raise_error(ArgumentError)
+  end
+
+  it "should return normalized chances" do
+    Chance.new("1/0/0").to_a.should eql([100,0,0])
+    Chance.new("0/1/0").to_a.should eql([0,100,0])
+    Chance.new("0/0/1").to_a.should eql([0,0,100])
+  end
+
+  context "normalizing" do
+    it "should normalize tens" do
+      Chance.normalize([10,15,25]).should eql([20,30,50])
+    end
+
+    it "should normalize thousands" do
+      Chance.normalize([1000,1500,2500]).should eql([20,30,50])
+    end
+
+    it "should normalize decimals" do
+      Chance.normalize([0.1,0.15,0.25]).should eql([20,30,50])
+    end
+
+    it "should cope with zero's" do
+      Chance.normalize([0,0,1]).should eql([0,0,100])
+    end
+
+  end
+end
+

data/spec/int_indexer_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Ab::Indexer do
+  let(:indexer){ Ab::Indexer }
+
+
+  it "should process a bunch of options" do
+    options = [
+      {:chances=>[100,0],   :value=>123, :result=>0, :seed=>123},
+      {:chances=>[0,100],   :value=>123, :result=>1, :seed=>123},
+      {:chances=>[-10,100], :value=>123, :result=>1, :seed=>123},
+      {:chances=>[100,0,0], :value=>123, :result=>0, :seed=>123},
+      {:chances=>[0,100,0], :value=>123, :result=>1, :seed=>123},
+      {:chances=>[0,0,100], :value=>123, :result=>2, :seed=>123},
+    ]
+
+    options.each do |option|
+      indexer.call(option).should eql(option[:result])
+    end
+
+  end
+
+  it "raises ArgumentError when arguments are missing" do
+    expect{indexer.call()}.to raise_error(ArgumentError)
+  end
+
+  it "raises ArgumentError when chances are 0" do
+    expect{indexer.call(:chances=>[0,0], :value=>123, :seed=>123)}.to raise_error(ArgumentError)
+  end
+
+  it "raises Error when it can't resolve an index" do
+    expect{indexer.call(:chances=>[-10, -20], :value=>123, :seed=>123)}.to raise_error(IndexError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'ab'
+include Ab

data/spec/tester_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Ab::Tester do
+
+  it "should initialize with no options" do
+    expect{Tester.new}.to_not raise_error
+  end
+
+  it "should initialize with options" do
+    expect{Tester.new(:options=>[1,2,3], :chances=>"1/2/2", :input=>50)}.to_not raise_error
+  end
+
+  it "should remember the options" do
+    Tester.new(:options=>[1,2,3]).options.should eql([1,2,3])
+  end
+
+  it "should remember the chances" do
+    Tester.new(:chances=>"10/10/10").chances.should_not be_nil
+  end
+
+  it "should remember the input" do
+    Tester.new(:input=>10).input.should eql(10)
+  end
+
+  it "should check if the amount of options equals the amount of chances" do
+    expect{Tester.new(:options=>[1,2,3], :chances=>"10/30").call}.to raise_error(ArgumentError)
+  end
+
+  it "should be able to set it's own indexer" do
+    Tester.new(:options=>[1,2,3],
+               :chances=>"0/0/1",
+               :indexer=>Proc.new{|a,b| 1}).call(1235).should eql(2)
+  end
+
+  it "uses a sane default indexer" do
+    Tester.new(:chances=>"1/0/0", :options=>[1,2,3]).call(1235).should eql(1)
+    Tester.new(:chances=>"0/1/0", :options=>[1,2,3]).call(1235).should eql(2)
+    Tester.new(:chances=>"0/0/1", :options=>[1,2,3]).call(1235).should eql(3)
+  end
+
+  it "should take a block and provide the result to the block" do
+    expect do |b|
+      Tester.new(:chances=>"1/0/0", :options=>[1,2,3])\
+        .call(1235, &b)
+    end.to yield_with_args(1)
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- sparkboxx
+- giannismelidis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic AB testing gem
+email:
+- wilcovanduinkerken@olery.com
+- giannismelidis@olery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ab.gemspec
+- lib/ab.rb
+- lib/ab/chance.rb
+- lib/ab/indexer.rb
+- lib/ab/railtie.rb
+- lib/ab/tester.rb
+- lib/ab/version.rb
+- lib/ab/view_helpers.rb
+- spec/ab_test_spec.rb
+- spec/chance_spec.rb
+- spec/int_indexer_spec.rb
+- spec/spec_helper.rb
+- spec/tester_spec.rb
+homepage: http://github.com/olery/ab
+licenses: []
+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.8.24
+signing_key: 
+specification_version: 3
+summary: The gem provides a basic class Tester or view helper function ab that allows
+  you to deterministically show a certain option (a/b/c/etc) to a user based on a
+  certain chance (e.g. 1/5)
+test_files:
+- spec/ab_test_spec.rb
+- spec/chance_spec.rb
+- spec/int_indexer_spec.rb
+- spec/spec_helper.rb
+- spec/tester_spec.rb
+has_rdoc: