vinted-ab 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45ab4518594015ccbca8ebd4d441f835e103e22c
-  data.tar.gz: 80fa73e5144373f439208f7773b82c76c4949de4
+  metadata.gz: 73b2901ba92e371c5f79d864db755df119cadd6a
+  data.tar.gz: 14bfef36209d2fd22a70ec59d7741812a18c67a7
 SHA512:
-  metadata.gz: 467ebec6807d536330430ebd111cff5fcb7d43935b43fa01866d370d61a5db9afa934b662836d5c025cd44395737270a1d029209ed4b5a8a01c58b953530f58c
-  data.tar.gz: a6a561c9a611031fd09d75da86ad36d6b3714fed4980e46cdae5a863aa1c7c45a25c48135134a5e87a1f183dd78e847c07cb0f45def7bf2495ad136c6ef918fa
+  metadata.gz: 8ae98d8cd54d30db32c7a54aee1377a9b782f4ca9d38c7e5d00cfea6f63f7e616faba5309601698eea4045ba6497612f12d4a47ff3a9f90cdfefbe45d1a8df62
+  data.tar.gz: 7c709e4b04db27be43ddc6b03fa37aca36d6e31dab8625abe153b2b68305c52ec8a8bbb138384295603ecccafec54eef421b8c65ee10c5937576761cc7fe2e61

data/.rubocop.yml

@@ -0,0 +1,11 @@
+LineLength:
+  Max: 99
+
+Documentation:
+  Enabled: false
+
+SignalException:
+  EnforcedStyle: only_raise
+
+TrailingComma:
+  Enabled: false

data/README.md

@@ -1,8 +1,48 @@
 # ab
 
+[![Code Climate](https://codeclimate.com/github/vinted/ab.png)](https://codeclimate.com/github/vinted/ab)
+[![Gem Version](https://badge.fury.io/rb/vinted-ab.png)](http://badge.fury.io/rb/vinted-ab)
+[![Dependency Status](https://gemnasium.com/vinted/ab.png)](https://gemnasium.com/vinted/ab)
+
+vinted-ab is used to determine whether an identifier belongs to a particular ab test and which variant of that ab test. Identifiers will usually represent users, but other scenario are possible. There are two parts to that: [Configuration](#configuration) and [Algorithm](#algorithm).
+
+High-level description: Identifiers are divided into some number of buckets, using hashing. Before a test is started, buckets are chosen for that test. That gives the ability to pick the needed level of isolation. Each test also has a seed, which is used to randomise how users are divided among test variants.
+
+![users](https://cloud.githubusercontent.com/assets/54526/2971326/0535267a-db69-11e3-9878-e2b6a5d5505d.png)
+
+## Usage
+
+```ruby
+ab = Ab::Tests.new(configuration, identifier)
+
+# defining callbacks
+Ab::Tests.before_picking_variant { |test| puts "picking variant for #{test}" }
+Ab::Tests.after_picking_variant { |test, variant| puts "#{variant_name}" }
+
+# ab.test never returns nil
+# but if you don't belong to any of the buckets, variant will be nil
+case ab.test.variant
+when 'red_button'
+  red_button
+when 'green_button'
+  green_button
+else
+  blue_button
+end
+
+# calls #variant underneath, results of that call are cached
+puts 'red button' if ab.test.red_button?
+```
+
 ## Configuration
 
-For this lib to work, it requires a configuration json, which looks like this:
+Configuration is expected to be in JSON, for which you can find the Schema [here](https://github.com/vinted/ab/blob/master/config.json). The provided schema is compatible with JSON Schema Draft 3. If you'd like to validate your JSON against this schema, in Ruby, you can do it using `json-schema` gem:
+
+```
+JSON::Validator.validate('/path/to/schema/config.json', json, version: :draft3)
+```
+
+An example config:
 
 ```json
 {
@@ -15,13 +55,7 @@ For this lib to work, it requires a configuration json, which looks like this:
             "start_at": "2014-05-21T11:06:30+03:00",
             "end_at": "2014-05-28T11:06:30+03:00",
             "seed": "aaaa1111",
-            "buckets": [
-                1,
-                2,
-                3,
-                4,
-                5
-            ],
+            "buckets": [1, 2, 3, 4, 5],
             "variants": [
                 {
                     "name": "green_button",
@@ -37,71 +71,41 @@ For this lib to work, it requires a configuration json, which looks like this:
                 }
             ]
         },
-        {
-            "id": 44,
-            "name": "red_shirts",
-            "start_at": "2014-05-24T11:09:30+03:00",
-            "end_at": "2099-05-24T11:09:30+03:00",
-            "seed": "bbbb4444",
-            "buckets": [
-                4,
-                5,
-                6,
-                7
-            ],
-            "variants": [
-                {
-                    "name": "red_shirt",
-                    "chance_weight": 1
-                },
-                {
-                    "name": "control",
-                    "chance_weight": 1
-                }
-            ]
-        },
-        {
-            "id": 47,
-            "name": "feed",
-            "start_at": "1999-03-31T00:00:00+03:00",
-            "end_at": "2099-03-31T00:00:00+03:00",
-            "seed": "cccc8888",
-            "buckets": "all",
-            "variants": [
-                {
-                    "name": "enabled",
-                    "chance_weight": 1
-                }
-            ]
-        },
     ]
 }
 ```
 
-## Usage
+Short explanation for a couple of config parameters:
 
-```ruby
-configuration = retrieve_from_svc_abs
-ab = Ab::Tests.new(configuration, user_id)
+`salt`: used to salt every identifier, before determining to which bucket that identifier belongs.
 
-# defining callbacks
-Ab::Tests.before_picking_variant { |test| puts 'magic' }
-Ab::Tests.after_picking_variant { |test, variant| puts "#{variant_name}" }
+`bucket_count`: the total number of buckets.
 
-# ab.experiment never returns nil
-# but if you don't belong to any of the buckets, variant will be nil
-case ab.experiment.variant
-when 'red_button'
-  red_button
-when 'green_button'
-  green_button
-else
-  blue_button
-end
+`all_buckets`: optional boolean which tells that all buckets are used in this test. Checking `buckets` is not required in that case.
+
+`ab_tests.start_at`: the start date time for ab test, in ISO 8601 format. Is not required, in which case, test has already started.
+
+`ab_tests.end_at`: the end date time for ab test, in ISO 8601 format. Is not required, in which case, there's no predetermined date when test will end.
+
+`ab_tests.buckets`: which buckets should be used for this ab test, represented as bucket ids. If the total number of buckets is 1000, values of this arrays are expected to be in 1..1000 range.
+
+`ab_tests.variants`: tests can have multiple variants, each with a name and a weight.
+
+More examples can be found in [spec/examples](https://github.com/vinted/ab/tree/master/spec/examples). Those examples are part of the test suite, which is run using [this code](https://github.com/vinted/ab/blob/master/spec/integration_spec.rb). We strongly recommend using those examples if you're reimplementing this library in another language.
+
+## Algorithm
+
+Most of the logic, is in `AssignedTest` class, which can be used as an [example implementation](https://github.com/vinted/ab/blob/master/lib/ab/assigned_test.rb).
+
+Here's some procedural pseudo code to serve as a reference:
+
+```pseudo
+bucket_id = SHA256(salt + identifier.to_string).to_integer % bucket_count
 
-# calls #variant underneath
-# #variant caches results, so meta tracking events would not be sent multiple times
-puts 'magic' if ab.experiment.red_button?
+return if not (test.all_buckets? or test.buckets.include?(bucket_id))
+return if not DateTime.now.between?(test.start_at, test.end_at)
 
-render_feed if ab.feed.enabled?
+chance_weight_sum = chance_weight_sum > 0 ? test.chance_weight_sum : 1
+weight_id = SHA256(test.seed + identifier.to_string).to_integer % chance_weight_sum
+test.variants.find { |variant| variant.accumulated_chance_weight > weight_id }
 ```

data/ab.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.1', '>= 10.1.0'
   spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.0'
+  spec.add_development_dependency 'json-schema', '~> 2.2.2', '>= 2.2.2'
 end

data/config.json

@@ -0,0 +1,74 @@
+{
+    "type": "object",
+    "required": true,
+    "properties": {
+        "bucket_count": {
+            "type": "number",
+            "required": true
+        },
+        "salt": {
+            "type": "string",
+            "required": true
+        },
+        "ab_tests": {
+            "type": "array",
+            "required": false,
+            "items": [
+                {
+                    "type": "object",
+                    "properties": {
+                        "all_buckets": {
+                            "type": "boolean",
+                            "required": false
+                        },
+                        "buckets": {
+                            "type": "array",
+                            "required": false,
+                            "items": {
+                                "type": "number",
+                                "required": false
+                            }
+                        },
+                        "start_at": {
+                            "type": "string",
+                            "required": false
+                        },
+                        "end_at": {
+                            "type": "string",
+                            "required": false
+                        },
+                        "id": {
+                            "type": "number",
+                            "required": true
+                        },
+                        "name": {
+                            "type": "string",
+                            "required": true
+                        },
+                        "seed": {
+                            "type": "string",
+                            "required": true
+                        },
+                        "variants": {
+                            "type": "array",
+                            "required": true,
+                            "items": {
+                                "type": "object",
+                                "properties": {
+                                    "chance_weight": {
+                                        "type": "number",
+                                        "required": true
+                                    },
+                                    "name": {
+                                        "type": "string",
+                                        "required": true
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            ]
+        }
+    }
+}

data/lib/ab/assigned_test.rb

@@ -27,16 +27,16 @@ module Ab
     private
 
     def part_of_test?
-      @test.buckets == 'all' || @test.buckets.include?(bucket_id)
+      @test.all_buckets? ||
+        @test.buckets && @test.buckets.include?(bucket_id)
     end
 
     def bucket_id
-      @bucket_id ||= digest(@test.salt + @id.to_s) % @test.bucket_count
+      @bucket_id ||= digest("#{@test.salt}#{@id}") % @test.bucket_count
     end
 
     def running?
-      now = DateTime.now
-      now.between?(@test.start_at, @test.end_at)
+      DateTime.now.between?(@test.start_at, @test.end_at)
     end
 
     def weight_id

data/lib/ab/null_test.rb

@@ -1,6 +1,5 @@
 class NullTest
   def variant
-    nil
   end
 
   def method_missing(meth, *args, &block)

data/lib/ab/test.rb

@@ -4,6 +4,10 @@ module Ab
       hash['buckets']
     end
 
+    def all_buckets?
+      hash['all_buckets']
+    end
+
     def name
       hash['name']
     end
@@ -12,7 +16,7 @@ module Ab
       @variants ||= begin
         accumulated = 0
         hash['variants'].map do |variant_hash|
-          Variant.new(variant_hash, accumulated += variant_hash['chance_weight'] )
+          Variant.new(variant_hash, accumulated += variant_hash['chance_weight'])
         end
       end
     end
@@ -22,15 +26,22 @@ module Ab
     end
 
     def start_at
-      @start_at ||= hash['start_at'].nil? ? DateTime.new(0) : DateTime.parse(hash['start_at'])
+      @start_at ||= parse_time('start_at', 0)
     end
 
     def end_at
-      @end_at ||= hash['end_at'].nil? ? DateTime.new(3000) : DateTime.parse(hash['end_at'])
+      @end_at ||= parse_time('end_at', 3000)
     end
 
     def weight_sum
       variants.map(&:chance_weight).inject(:+)
     end
+
+    private
+
+    def parse_time(name, default)
+      value = hash[name]
+      value.nil? ? DateTime.new(default) : DateTime.parse(value)
+    end
   end
 end

data/lib/ab/tests.rb

@@ -10,24 +10,23 @@ module Ab
       Ab::Tests.run_hook :after_picking_variant, test, variant
     end
 
-    def initialize(config, id)
-      @assigned_tests ||= {}
-
-      (config['ab_tests'] || []).each do |test|
-        name = test['name']
-        @assigned_tests[name] = nil
-        define_singleton_method(name) do
-          test = Test.new(test, config['salt'], config['bucket_count'])
-          @assigned_tests[name] ||= AssignedTest.new(test, id)
-        end
+    def initialize(json, id)
+      config = json.is_a?(Hash) ? json : JSON.parse(json)
+
+      salt = config['salt']
+      bucket_count = config['bucket_count']
+
+      tests = (config['ab_tests'] || []).map { |test| Test.new(test, salt, bucket_count) }
+
+      @assigned_tests = tests.map do |test|
+        assigned_test = AssignedTest.new(test, id)
+        define_singleton_method(test.name) { assigned_test }
+        [test.name, assigned_test]
       end
     end
 
     def all
-      result = @assigned_tests.keys.map do |name|
-        [name, send(name).variant]
-      end
-      Hash[result]
+      Hash[@assigned_tests.map { |name, assigned_test| [name, assigned_test.variant] }]
     end
 
     def method_missing(meth, *args, &block)

data/lib/ab/version.rb

@@ -1,3 +1,3 @@
 module Ab
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/assigned_test_spec.rb

@@ -1,52 +1,46 @@
 require 'spec_helper'
+require 'ostruct'
 
 module Ab
   describe AssignedTest do
     let(:assigned_test) { AssignedTest.new(test, id) }
-    let(:test) { Test.new(hash, 'e131bfcfcab06c65d633d0266c7e62a4918', 1000) }
-    let(:hash) {
-      {
-        'name' => name,
-        'start_at' => start_at,
-        'end_at' => end_at,
-        'buckets' => buckets,
-        'seed' => seed,
-        'variants' => variants
-      }
-    }
+    let(:test) do
+      OpenStruct.new(name: name, start_at: start_at, end_at: end_at,
+                     buckets: buckets, seed: 'cccc8888', variants: variants,
+                     weight_sum: 2, salt: 'e131bfcfcab06c65d633d0266c7e62a4918', bucket_count: 1000)
+    end
     let(:id) { 1 }
     let(:name) { 'feed' }
-    let(:start_at) { DateTime.now.prev_year.to_s }
-    let(:end_at) { DateTime.now.next_year.to_s }
-    let(:seed) { 'cccc8888' }
-    let(:buckets) { 'all' }
+    let(:start_at) { DateTime.now.prev_year }
+    let(:end_at) { DateTime.now.next_year }
+    let(:buckets) { 1..1000 }
     let(:thousand_variants) { 1.upto(1000).map { |i| AssignedTest.new(test, i).variant } }
 
     describe '#variant' do
       subject { assigned_test.variant }
 
       context 'single variant' do
-        let(:variants) { [{ 'name' => 'enabled', 'chance_weight' => chance_weight }] }
+        let(:variants) { [OpenStruct.new(name: 'enabled', accumulated_chance_weight: accumulated_chance_weight)] }
 
         context 'that is turned off' do
-          let(:chance_weight) { 0 }
+          let(:accumulated_chance_weight) { 0 }
           it { should be_nil }
         end
 
-        context 'that is turned on with 1' do
-          let(:chance_weight) { 1 }
+        context 'that is turned on with 2' do
+          let(:accumulated_chance_weight) { 2 }
           it { should == 'enabled' }
         end
 
         context 'that is turned on with 111' do
-          let(:chance_weight) { 111 }
+          let(:accumulated_chance_weight) { 111 }
           it { should == 'enabled' }
         end
       end
 
       context 'single variant with buckets' do
         let(:buckets) { (1..100) }
-        let(:variants) { [{ 'name' => 'enabled', 'chance_weight' => 1 }] }
+        let(:variants) { [OpenStruct.new(name: 'enabled', accumulated_chance_weight: 2)] }
 
         specify 'half the ids fall under one, other under other' do
           enabled = thousand_variants.select { |variant| variant == 'enabled' }
@@ -57,25 +51,25 @@ module Ab
       context 'test that has not started yet' do
         let(:start_at) { DateTime.now.next_year.to_s }
         let(:buckets) { [1, 2, 3] }
-        let(:variants) { [{ 'name' => 'enabled', 'chance_weight' => 1 }] }
+        let(:variants) { [OpenStruct.new(name: 'enabled', accumulated_chance_weight: 2)] }
         it { should be_nil }
       end
 
       context 'test that has already ended' do
         let(:end_at) { DateTime.now.prev_year.to_s }
         let(:buckets) { [1, 2, 3] }
-        let(:variants) { [{ 'name' => 'enabled', 'chance_weight' => 1 }] }
+        let(:variants) { [OpenStruct.new(name: 'enabled', accumulated_chance_weight: 2)] }
         it { should be_nil }
       end
 
       context 'two variants' do
         let(:name) { 'button' }
-        let(:variants) {
+        let(:variants) do
           [
-            { 'name' => 'red', 'chance_weight' => 1 },
-            { 'name' => 'blue', 'chance_weight' => 1 }
+            OpenStruct.new(name: 'red', accumulated_chance_weight: 1),
+            OpenStruct.new(name: 'blue', accumulated_chance_weight: 2)
           ]
-        }
+        end
 
         specify 'half the ids fall under one, other under other' do
           reds = thousand_variants.select { |variant| variant == 'red' }

data/spec/examples/all_buckets/input.json

@@ -0,0 +1,22 @@
+{
+    "salt": "aaaa1111",
+    "bucket_count": 1000,
+    "ab_tests": [
+        {
+            "id": 42,
+            "name": "all_buckets",
+            "seed": "bbbb2222",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                },
+                {
+                    "name": "red",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/all_buckets/output.json

@@ -0,0 +1,7 @@
+{
+    "test": "all_buckets",
+    "variants": {
+      "green": [1, 2, 3, 4, 6, 10, 13, 16, 18, 19, 21, 22, 23, 25, 26, 30, 33, 34, 38, 41, 42, 43, 44, 47, 48, 51, 52, 53, 55, 57, 58, 59, 61, 65, 66, 72, 73, 74, 75, 79, 81, 83, 88, 89, 91, 92, 97, 98],
+      "red": [5, 7, 8, 9, 11, 12, 14, 15, 17, 20, 24, 27, 28, 29, 31, 32, 35, 36, 37, 39, 40, 45, 46, 49, 50, 54, 56, 60, 62, 63, 64, 67, 68, 69, 70, 71, 76, 77, 78, 80, 82, 84, 85, 86, 87, 90, 93, 94, 95, 96, 99, 100]
+    }
+}

data/spec/examples/already_finished/input.json

@@ -0,0 +1,20 @@
+{
+    "salt": "9a38d3194fc4c1b43c500c551d3c80a0",
+    "bucket_count": 4,
+    "ab_tests": [
+        {
+            "id": 2,
+            "name": "already_finished",
+            "seed": "792e3b32a6dd59d3f300b2ac8b4caa09",
+            "start_at": "1605-11-05T00:00:00+01:00",
+            "end_at": "2014-02-01T02:15:00+03:00",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/already_finished/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "already_finished",
+    "variants": {
+      "": [291605, 304029, 260623, 330108, 579320, 530360, 372392, 700813, 244200, 541818, 432400, 943631, 437817, 226191, 569129, 436127, 490360, 929904, 603358, 437705, 878118, 807422, 972099, 404677, 67694, 384045, 48608, 518304, 830501, 902758, 915681, 211550, 748688, 606226, 309490, 12909, 762, 560680, 945245, 795680, 358793, 850366, 278017, 765934, 378015, 156624, 878811, 814470, 830857, 712438]
+    }
+}

data/spec/examples/big_weights/input.json

@@ -0,0 +1,22 @@
+{
+    "salt": "1fd3eca97a86c4458bf3b6308ed4d990",
+    "bucket_count": 1000000,
+    "ab_tests": [
+        {
+            "id": 11,
+            "name": "big_weights",
+            "seed": "5aae80d25c5ba1931cbd1bfabada7628",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1111111
+                },
+                {
+                    "name": "red",
+                    "chance_weight": 2222222
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/big_weights/output.json

@@ -0,0 +1,7 @@
+{
+    "test": "big_weights",
+    "variants": {
+      "green": [4, 6, 8, 10, 20, 21, 26, 27, 33, 35, 37, 38, 41, 43, 45, 48, 54, 63, 68, 72, 74, 75, 77, 80, 82, 84, 89, 92, 94, 96, 97, 98, 100000, 222222, 3333333],
+      "red": [1, 2, 3, 5, 7, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 22, 23, 24, 25, 28, 29, 30, 31, 32, 34, 36, 39, 40, 42, 44, 46, 47, 49, 50, 51, 52, 53, 55, 56, 57, 58, 59, 60, 61, 62, 64, 65, 66, 67, 69, 70, 71, 73, 76, 78, 79, 81, 83, 85, 86, 87, 88, 90, 91, 93, 95, 99, 100, 44444444, 5555555555, 66666666666666, 7777777777777777777, 888888888888888]
+    }
+}

data/spec/examples/explicit_times/input.json

@@ -0,0 +1,20 @@
+{
+    "salt": "26c9eb8052e063c0c90ccfc2b2b8d3f9",
+    "bucket_count": 10,
+    "ab_tests": [
+        {
+            "id": 5,
+            "name": "explicit_times",
+            "seed": "2a14d8c5a30618799547e428dfa4a807",
+            "start_at": "2013-01-01T00:00:00+00:00",
+            "end_at": "2222-02-02T02:02:02+02:00",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/explicit_times/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "explicit_times",
+    "variants": {
+      "green": [246634, 189232, 261124, 258312, 143345, 61526, 563378, 183884, 292018, 85369, 241636, 797666, 364106, 514650, 185138, 881918, 349238, 605224, 290364, 517050, 923044, 522072, 745441, 194585, 18954, 836159, 733972, 847258, 330674, 547290, 614244, 230881, 994375, 933292, 184046, 954399, 951499, 986197, 302526, 245495, 406331, 162540, 782412, 502991, 926435, 439917, 949962, 161191, 435941, 809921]
+    }
+}

data/spec/examples/few_buckets/input.json

@@ -0,0 +1,22 @@
+{
+    "salt": "61b81d7844c40c4057ebe6fc1a7a4a54",
+    "bucket_count": 10,
+    "ab_tests": [
+        {
+            "id": 7,
+            "name": "few_buckets",
+            "seed": "f63eb232778ee3b0ad7b8f515dea18a2",
+            "buckets": [1, 2, 3, 4],
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                },
+                {
+                    "name": "red",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/few_buckets/output.json

@@ -0,0 +1,8 @@
+{
+    "test": "few_buckets",
+    "variants": {
+      "": [2, 5, 6, 8, 9],
+      "green": [1, 3, 4],
+      "red": [7, 10, 11]
+    }
+}

data/spec/examples/has_not_started/input.json

@@ -0,0 +1,19 @@
+{
+    "salt": "2",
+    "bucket_count": 333,
+    "ab_tests": [
+        {
+            "id": 2,
+            "name": "has_not_started",
+            "seed": "2",
+            "start_at": "2444-01-01T00:00:00+00:00",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/has_not_started/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "has_not_started",
+    "variants": {
+      "": [183045, 691488, 793455, 522272, 961068, 778995, 753374, 995071, 219, 9, 765648, 519309, 581785, 419174, 62315, 901724, 739080, 528967, 744073, 751906, 886404, 457847, 817084, 160980, 302650, 911722, 447343, 871078, 450743, 879249, 276816, 826730, 697169, 344382, 511211, 154169, 55093, 648220, 964453, 862546, 208317, 16098, 341078, 111032, 277598, 876165, 650530, 446612, 583245, 7724]
+    }
+}

data/spec/examples/multiple_tests/input.json

@@ -0,0 +1,30 @@
+{
+    "salt": "61b81d7844c40c4057ebe6fc1a7a4a54",
+    "bucket_count": 22222,
+    "ab_tests": [
+        {
+            "id": 8,
+            "name": "one",
+            "seed": "f63eb232778ee3b0ad7b8f515dea18a2",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                }
+            ]
+        },
+        {
+            "id": 9,
+            "name": "two",
+            "seed": "f63eb232778ee3b0ad7b8f515dea18a2",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "red",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/multiple_tests/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "two",
+    "variants": {
+      "red": [376108, 78463, 987379, 883214, 484448, 91173, 404534, 192288, 422282, 409742, 56641, 738643, 314843, 970353, 47323, 702285, 574459, 545482, 359063, 972527, 83465, 779284, 632264, 888819, 18155, 863241, 451140, 396046, 622149, 206291, 129760, 357063, 749273, 46561, 18731, 237123, 486940, 911556, 919840, 235874, 290879, 480711, 738111, 266919, 532775, 323640, 313300, 820330, 532474, 431884]
+    }
+}

data/spec/examples/multiple_variants/input.json

@@ -0,0 +1,30 @@
+{
+    "salt": "61b81d7844c40c4057ebe6fc1a7a4a54",
+    "bucket_count": 20,
+    "ab_tests": [
+        {
+            "id": 6,
+            "name": "multiple_variants",
+            "seed": "1995f6808c018b6dd91a3bc927fd7e92",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                },
+                {
+                    "name": "red",
+                    "chance_weight": 1
+                },
+                {
+                    "name": "blue",
+                    "chance_weight": 1
+                },
+                {
+                    "name": "orange",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/multiple_variants/output.json

@@ -0,0 +1,9 @@
+{
+    "test": "multiple_variants",
+    "variants": {
+      "green": [1, 2, 3, 7, 8, 9, 12, 19, 31, 34, 37, 43, 49, 60, 62, 64, 65, 68, 71, 75, 78, 79, 87, 91, 94, 95],
+      "orange": [4, 11, 15, 21, 25, 32, 33, 35, 38, 40, 46, 48, 56, 57, 59, 61, 63, 74, 77, 84, 88],
+      "blue": [5, 10, 14, 16, 17, 20, 24, 28, 30, 42, 44, 45, 53, 55, 67, 69, 76, 81, 86, 90, 92, 93, 98, 100],
+      "red": [6, 13, 18, 22, 23, 26, 27, 29, 36, 39, 41, 47, 50, 51, 52, 54, 58, 66, 70, 72, 73, 80, 82, 83, 85, 89, 96, 97, 99]
+    }
+}

data/spec/examples/no_buckets/input.json

@@ -0,0 +1,17 @@
+{
+    "salt": "dddd4444",
+    "bucket_count": 200,
+    "ab_tests": [
+        {
+            "id": 1,
+            "name": "no_buckets",
+            "seed": "cccc3333",
+            "variants": [
+                {
+                    "name": "nononononononon",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/no_buckets/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "no_buckets",
+    "variants": {
+      "": [221661, 512005, 429796, 860028, 10044, 249906, 491257, 188883, 793187, 86200, 155542, 257569, 534172, 506476, 461784, 123346, 882492, 933085, 105147, 575351, 756286, 293415, 946852, 894051, 109248, 285169, 499834, 422777, 793, 353968, 470821, 300689, 994515, 352756, 527621, 811497, 12865, 405584, 783387, 23868, 1577, 402157, 645302, 921879, 743877, 65532, 729269, 704958, 473143, 621616]
+    }
+}

data/spec/examples/no_variants/input.json

@@ -0,0 +1,13 @@
+{
+    "salt": "89808d1afb4a334119e6d017289cf46a",
+    "bucket_count": 21,
+    "ab_tests": [
+        {
+            "id": 12,
+            "name": "no_variants",
+            "seed": "6e76ebb941d7e65a59d28071d00e3910",
+            "all_buckets": true,
+            "variants": []
+        }
+    ]
+}

data/spec/examples/no_variants/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "no_variants",
+    "variants": {
+      "":  [622251, 272484, 204185, 253530, 568849, 707722, 716486, 995162, 824709, 767433, 492812, 248413, 167496, 656567, 151008, 922024, 329511, 720392, 736955, 661974, 97247, 543083, 639996, 699049, 157179, 307863, 889578, 95851, 677312, 337342, 324874, 566262, 625613, 394275, 363587, 441650, 117251, 689288, 313266, 732267, 263893, 27783, 357379, 673605, 127934, 940549, 254671, 732244, 628961, 87713]
+    }
+}

data/spec/examples/zero_buckets/input.json

@@ -0,0 +1,18 @@
+{
+    "salt": "61b81d7844c40c4057ebe6fc1a7a4a54",
+    "bucket_count": 2,
+    "ab_tests": [
+        {
+            "id": 4,
+            "name": "zero_buckets",
+            "seed": "1995f6808c018b6dd91a3bc927fd7e92",
+            "buckets": [],
+            "variants": [
+                {
+                    "name": "green",
+                    "chance_weight": 1
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/zero_buckets/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "zero_buckets",
+    "variants": {
+      "": [407157, 680726, 413486, 225300, 884397, 493575, 77961, 191171, 540935, 504825, 276950, 750121, 964532, 987549, 250191, 644840, 906385, 584061, 56659, 397052, 544631, 107797, 485280, 418972, 547068, 726896, 224553, 369481, 713741, 739533, 639550, 895066, 397180, 829280, 581343, 566108, 438772, 173296, 99849, 106325, 308317, 135582, 82913, 994233, 882570, 72915, 699850, 161517, 420297, 836392]
+    }
+}

data/spec/examples/zero_weight/input.json

@@ -0,0 +1,22 @@
+{
+    "salt": "199c13b89551aa4127370496ee557892",
+    "bucket_count": 44,
+    "ab_tests": [
+        {
+            "id": 6,
+            "name": "zero_weights",
+            "seed": "2631740ab92aa67dd64172e4f740896d",
+            "all_buckets": true,
+            "variants": [
+                {
+                    "name": "zero",
+                    "chance_weight": 0
+                },
+                {
+                    "name": "weight",
+                    "chance_weight": 0
+                }
+            ]
+        }
+    ]
+}

data/spec/examples/zero_weight/output.json

@@ -0,0 +1,6 @@
+{
+    "test": "zero_weight",
+    "variants": {
+      "": [407157, 680726, 413486, 225300, 884397, 493575, 77961, 191171, 540935, 504825, 276950, 750121, 964532, 987549, 250191, 644840, 906385, 584061, 56659, 397052, 544631, 107797, 485280, 418972, 547068, 726896, 224553, 369481, 713741, 739533, 639550, 895066, 397180, 829280, 581343, 566108, 438772, 173296, 99849, 106325, 308317, 135582, 82913, 994233, 882570, 72915, 699850, 161517, 420297, 836392]
+    }
+}

data/spec/integration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'json-schema'
+
+describe 'ab' do
+  path_to_schema = "#{File.dirname(__FILE__)}/../config.json"
+
+  Dir.glob("#{File.dirname(__FILE__)}/examples/**").each do |name|
+    context "#{name} example" do
+      let(:input) { IO.read("#{name}/input.json") }
+      let(:output) { JSON.parse(IO.read("#{name}/output.json")) }
+
+      specify 'validates against schema' do
+        result = JSON::Validator.validate(path_to_schema, input, version: :draft3)
+        result.should be_true
+      end
+
+      specify 'correctly assigns variants' do
+        cases = []
+        output['variants'].map { |variant, ids| ids.each { |id| cases << [id, variant] } }
+
+        cases.each do |id, variant|
+          tests = Ab::Tests.new(input, id)
+          tests.send(output['test']).variant.to_s.should == variant
+        end
+      end
+    end
+  end
+end

data/spec/null_test_spec.rb

@@ -4,12 +4,14 @@ module Ab
   describe NullTest do
     subject { NullTest.new }
 
+    its(:variant) { should be_nil }
+
     specify 'does not raise for method ending in question mark' do
-      expect{ subject.bla? }.to_not raise_error
+      expect { subject.bla? }.to_not raise_error
     end
 
     specify 'raises for method not ending in question mark' do
-      expect{ subject.bla }.to raise_error
+      expect { subject.bla }.to raise_error
     end
   end
 end

data/spec/test_spec.rb

@@ -16,10 +16,27 @@ module Ab
       it { should == 'test' }
     end
 
+    context '#weight_sum' do
+      subject { test.weight_sum }
+      let(:test_hash) do
+        { 'variants' => [{ 'chance_weight' => 1 },
+                         { 'chance_weight' => 2 }] }
+      end
+      it { should == 3 }
+    end
+
     context '#start_at' do
       subject { test.start_at }
-      let(:test_hash) { { 'start_at' => '2014-05-27T11:56:25+03:00' } }
-      it { should == DateTime.new(2014, 5, 27, 11, 56, 25, '+3') }
+
+      context 'nil' do
+        let(:test_hash) { {} }
+        it { should < DateTime.new(1977) }
+      end
+
+      context 'april fools' do
+        let(:test_hash) { { 'start_at' => '2014-04-01T12:00:00+00:00' } }
+        it { should == DateTime.new(2014, 4, 1, 12) }
+      end
     end
 
     context '#end_at' do

data/spec/tests_spec.rb

@@ -2,36 +2,62 @@ require 'spec_helper'
 
 module Ab
   describe Tests do
-    describe '.new' do
-      subject { Tests.new(config, id) }
-      let(:id) { 1 }
+    let(:tests) { Tests.new(config, id) }
+    let(:config) { {} }
+    let(:id) { 1 }
+
+    shared_context 'simple config with feed' do
+      let(:config) do
+        {
+          'salt' => 'anything',
+          'bucket_count' => 1000,
+          'ab_tests' => [{
+            'name' => 'feed',
+            'all_buckets' => true,
+            'variants' => [{ 'name' => 'enabled', 'chance_weight' => 1 }]
+          }]
+        }
+      end
+    end
 
-      context 'empty config' do
-        let(:config) { {} }
+    describe '#respond_to?' do
+      subject { tests.respond_to?(method_name) }
 
-        specify 'has no public methods' do
-          (subject.public_methods(false) - [:method_missing, :respond_to?, :all]).count.should == 0
+      1.upto(10).each do |i|
+        context "random method name of #{i} length" do
+          let(:method_name) { SecureRandom.hex(i) }
+          it { should be_true }
         end
+      end
+    end
+
+    describe '#method_missing' do
+      subject { tests.send(method_name) }
 
-        specify 'does not raise if method is not existant' do
-          expect{ subject.bla_bla_bla }.to_not raise_error
+      1.upto(10).each do |i|
+        context "random method name of #{i} length" do
+          let(:method_name) { SecureRandom.hex(i) }
+          it { should be_kind_of(NullTest) }
         end
       end
+    end
+
+    describe '#all' do
+      include_context 'simple config with feed'
+      subject { tests.all }
+      it { should == { 'feed' => 'enabled' } }
+    end
+
+    describe '.new' do
+      subject { tests }
+
+      specify 'has no public methods' do
+        (subject.public_methods(false) - [:method_missing, :respond_to?, :all]).count.should == 0
+      end
 
       context 'single experiment with single variant' do
-        let(:config) {
-          {
-            'salt' => 'anything',
-            'bucket_count' => 1000,
-            'ab_tests' => [{
-              'name' => 'feed',
-              'buckets' => 'all',
-              'variants' => [{ 'name' => 'enabled', 'chance_weight' => 1 }]
-            }]
-          }
-        }
+        include_context 'simple config with feed'
         its(:feed) { should be_kind_of AssignedTest }
-        its(:all) { should == { 'feed' => 'enabled' } }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vinted-ab
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hooks
@@ -85,6 +85,26 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 description: 
 email:
 - mindaugas.mozuras@gmail.com
@@ -94,11 +114,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - ab.gemspec
+- config.json
 - lib/ab.rb
 - lib/ab/assigned_test.rb
 - lib/ab/null_test.rb
@@ -107,6 +129,31 @@ files:
 - lib/ab/variant.rb
 - lib/ab/version.rb
 - spec/assigned_test_spec.rb
+- spec/examples/all_buckets/input.json
+- spec/examples/all_buckets/output.json
+- spec/examples/already_finished/input.json
+- spec/examples/already_finished/output.json
+- spec/examples/big_weights/input.json
+- spec/examples/big_weights/output.json
+- spec/examples/explicit_times/input.json
+- spec/examples/explicit_times/output.json
+- spec/examples/few_buckets/input.json
+- spec/examples/few_buckets/output.json
+- spec/examples/has_not_started/input.json
+- spec/examples/has_not_started/output.json
+- spec/examples/multiple_tests/input.json
+- spec/examples/multiple_tests/output.json
+- spec/examples/multiple_variants/input.json
+- spec/examples/multiple_variants/output.json
+- spec/examples/no_buckets/input.json
+- spec/examples/no_buckets/output.json
+- spec/examples/no_variants/input.json
+- spec/examples/no_variants/output.json
+- spec/examples/zero_buckets/input.json
+- spec/examples/zero_buckets/output.json
+- spec/examples/zero_weight/input.json
+- spec/examples/zero_weight/output.json
+- spec/integration_spec.rb
 - spec/null_test_spec.rb
 - spec/spec_helper.rb
 - spec/test_spec.rb