light_abtest 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa63219217431598713e4e282e97d02e5e80a207
+  data.tar.gz: 7537c7efdb247566dad435674beedc3f7d09d774
+SHA512:
+  metadata.gz: ced67ea256d17fffab5216e0957df806fecdab9d5597e962dae7c6e52761d482f8c2d5765db0b1106145335c84c91bbce73f8dd9b3ba863c147529f2d8fba1ba
+  data.tar.gz: 078436dd1bdeb8cd04fbb0da069916cebdcc7c3bc9e0d7373e163a8e88de09870dbedb6a0f0ea96891e03171c98280cfecc7a24f6907396f99598356572bd636

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mo Lin
+
+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,68 @@
+# LightAbtest
+
+This is a light weight, easy to use AB testing framework gem for backend algorithm test
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'light_abtest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install light_abtest
+
+## Usage
+
+This gem is very light weight and easy to use. The framework is based on redis.
+Example of usage:
+```ruby
+require 'light_abtest'
+redis = Redis.new(:host => "localhost", :port => 6379, :db => 0)
+```
+the input will be:
+number of parts you want to split, weight of each part, your redis server
+after you initialize the LightAbtest object, it will store your split rate into redis, the key is called "abtest_rate:"
+```ruby
+abtest = LightAbtest.new(3, [0.5, 0.3, 0.2], redis)
+```
+then using split method to split your users, assume you have users
+```ruby
+users = [0,1,2,3,4,5,6,7,8,9]
+abtest.split(users)
+```
+then you should see keys "ab:0", "ab:1", ..., "ab:9" in your redis db, and the value will be 0 or 1 or 2 as algo_id
+
+the add_method function will let you associate your algorithms to these algo_ids
+for example you have three recommendation algorithms, you can do
+```ruby
+abtest.add_method(0, "RecommendAlgo1.process")
+abtest.add_method(1, "RecommendAlgo2.process")
+abtest.add_method(2, "RecommendAlgo3.process")
+```
+
+then you will have below information stored in your redis db
+key: "algo_id:0", value: "RecommendAlgo1.process"
+key: "algo_id:1", value: "RecommendAlgo2.process"
+key: "algo_id:2", value: "RecommendAlgo3.process"
+then whenever you want to do recommendation for your user and test these three algorithm
+you just need to retrieve the user's algo_id by
+
+```ruby
+algo_id = redis.get("ab:#{user_id}")
+eval(redis.get("algo_id:" + algo_id))
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/light_abtest/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/light_abtest/version.rb

@@ -0,0 +1,3 @@
+module LightAbtest
+  VERSION = "0.0.2"
+end

data/lib/light_abtest.rb

@@ -0,0 +1,48 @@
+require "light_abtest/version"
+require "redis"
+
+class LightAbtest
+  def initialize
+  end
+
+  def set_split_rate(n, rate, redis)
+    @n = n
+    @ratio = ratio
+    @split_results = {}
+    @redis = redis
+    store_split_rate
+  end
+
+  def split(target)
+    full_size = target.size
+    (0..@n-1).each do |i|
+      split_result = target.sample(@ratio[i]*full_size)
+      target -= split_result
+      @split_results[i] = split_result
+    end
+    if target.size > 0
+      @split_results[0] += target
+    end
+    save_split_to_redis
+  end
+
+  def add_method(algo_id, code)
+    key = "algo_id:" + algo_id.to_s
+    @redis.set(key, code)
+  end
+
+  def save_split_to_redis
+    @split_results.keys.each do |i|
+      @split_results[i].each do |j|
+        key = "ab:" + j.to_s
+        @redis.set(key, i)
+      end
+    end
+  end
+
+  def store_split_rate
+    key = "abtest_rate:"
+    @redis.set(key, @ratio)
+  end
+end
+

data/light_abtest.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'light_abtest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "light_abtest"
+  spec.version       = LightAbtest::VERSION
+  spec.authors       = ["Mo Lin"]
+  spec.email         = ["ml3309@columbia.edu"]
+  spec.summary       = "This is a light weight, easy to use AB testing framework gem for backend algorithm test"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/madnoodlesmlin/RubyLightWeightABTesting"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'redis'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: light_abtest
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mo Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: ''
+email:
+- ml3309@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/light_abtest.rb
+- lib/light_abtest/version.rb
+- light_abtest.gemspec
+homepage: https://github.com/madnoodlesmlin/RubyLightWeightABTesting
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: This is a light weight, easy to use AB testing framework gem for backend
+  algorithm test
+test_files: []