vinted-ab 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73b2901ba92e371c5f79d864db755df119cadd6a
-  data.tar.gz: 14bfef36209d2fd22a70ec59d7741812a18c67a7
+  metadata.gz: 67031305b2c5c180288a616ff7d931d4918604dc
+  data.tar.gz: de313c446acea2eda841eea20930c82938628c0c
 SHA512:
-  metadata.gz: 8ae98d8cd54d30db32c7a54aee1377a9b782f4ca9d38c7e5d00cfea6f63f7e616faba5309601698eea4045ba6497612f12d4a47ff3a9f90cdfefbe45d1a8df62
-  data.tar.gz: 7c709e4b04db27be43ddc6b03fa37aca36d6e31dab8625abe153b2b68305c52ec8a8bbb138384295603ecccafec54eef421b8c65ee10c5937576761cc7fe2e61
+  metadata.gz: 8cd252fbb99403b6405401584879f9a410450adbaf2b8efa1c942d113e6046089fea519c90c7d4a9ae449e3e45a236acc1fc2ec0d9762071dcde2e2b88e07712
+  data.tar.gz: e0f21c86e0a21c40359da87572cfcfc9a23b955ea4d61c0730b547ea80d16a565e85c9a4c75da3551fbabda8f7c76703ae07c8cb7fa35f3bf3edeb8dc90fe9bd

data/README.md

@@ -4,9 +4,9 @@
 [![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).
+If you didn't guess it from the name, this library is meant for ab testing. But it doesn't cover everything associated with it, it lacks configuration and management parts. [vinted/ab](https://github.com/vinted/ab) is only used to determine which variant should be applied for a user. Two inputs are expected - [configuration](#configuration) and identifier. Identifier, at least in Vinted's case, represents users, but other scenarios are certainly possible.
 
-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.
+Each identifier is assigned to a bucket, using a hashing function. Buckets can then be assigned to tests. That allows isolation control, when we don't want clashing and creation of biases. Each test also has a seed, which is used to randomise how identifiers are divided among test variants. You can find algorithm description [here](#algorithm) if you want more detail.
 
 ![users](https://cloud.githubusercontent.com/assets/54526/2971326/0535267a-db69-11e3-9878-e2b6a5d5505d.png)
 
@@ -19,8 +19,7 @@ ab = Ab::Tests.new(configuration, identifier)
 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
+# ab.test never returns nil, but #variant can
 case ab.test.variant
 when 'red_button'
   red_button
@@ -32,6 +31,9 @@ end
 
 # calls #variant underneath, results of that call are cached
 puts 'red button' if ab.test.red_button?
+
+# both start_at and end_at dates are accessible
+puts 'newbie button' if user.created_at > ab.test.start_at && ab.test.for_newbies?
 ```
 
 ## Configuration
@@ -91,7 +93,7 @@ Short explanation for a couple of config parameters:
 
 `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.
+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). `input.json` is configuration json and `output.json` gives expectations - which identifiers should fall to which variant. We strongly recommend using those examples if you're reimplementing this library in another language.
 
 ## Algorithm
 
@@ -100,12 +102,14 @@ Most of the logic, is in `AssignedTest` class, which can be used as an [example
 Here's some procedural pseudo code to serve as a reference:
 
 ```pseudo
-bucket_id = SHA256(salt + identifier.to_string).to_integer % bucket_count
+salted_identifier = salt + identifier.to_string
+bucket_id = SHA256.hexdigest(salted_identifier).to_int % bucket_count
 
 return if not (test.all_buckets? or test.buckets.include?(bucket_id))
 return if not DateTime.now.between?(test.start_at, test.end_at)
 
 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
+seeded_identifier = test.seed + identifier.to_string
+weight_id = SHA256.hexdigest(seeded_identifier).to_int % chance_weight_sum
 test.variants.find { |variant| variant.accumulated_chance_weight > weight_id }
 ```

data/ab.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'ruby-prof', '~> 0.15.0', '>= 0.15.0'
+  spec.add_development_dependency 'pry', '~> 0.10.0', '>= 0.10.0'
 end

data/lib/ab/assigned_test.rb

@@ -24,6 +24,14 @@ module Ab
       end
     end
 
+    def start_at
+      @test.start_at
+    end
+
+    def end_at
+      @test.end_at
+    end
+
     private
 
     def part_of_test?

data/lib/ab/null_test.rb

@@ -1,12 +1,23 @@
-class NullTest
-  def variant
-  end
+module Ab
+  class NullTest
+    def variant
+    end
 
-  def method_missing(meth, *args, &block)
-    meth.to_s.end_with?('?') ? false : super
-  end
+    def start_at
+      Test::DEFAULT_START_AT
+    end
+
+    def end_at
+      Test::DEFAULT_END_AT
+    end
+
+
+    def method_missing(meth, *args, &block)
+      meth.to_s.end_with?('?') ? false : super
+    end
 
-  def respond_to?(meth)
-    meth.to_s.end_with?('?') ? true : super
+    def respond_to?(meth)
+      meth.to_s.end_with?('?') ? true : super
+    end
   end
 end

data/lib/ab/test.rb

@@ -1,5 +1,8 @@
 module Ab
   class Test < Struct.new(:hash, :salt, :bucket_count)
+    DEFAULT_START_AT =  DateTime.new(0)
+    DEFAULT_END_AT = DateTime.new(3000)
+
     def buckets
       hash['buckets']
     end
@@ -26,11 +29,11 @@ module Ab
     end
 
     def start_at
-      @start_at ||= parse_time('start_at', 0)
+      @start_at ||= parse_time('start_at', DEFAULT_START_AT)
     end
 
     def end_at
-      @end_at ||= parse_time('end_at', 3000)
+      @end_at ||= parse_time('end_at', DEFAULT_END_AT)
     end
 
     def weight_sum
@@ -41,7 +44,7 @@ module Ab
 
     def parse_time(name, default)
       value = hash[name]
-      value.nil? ? DateTime.new(default) : DateTime.parse(value)
+      value.nil? ? default : DateTime.parse(value)
     end
   end
 end

data/lib/ab/tests.rb

@@ -11,6 +11,7 @@ module Ab
     end
 
     def initialize(json, id)
+      json ||= {}
       config = json.is_a?(Hash) ? json : JSON.parse(json)
 
       salt = config['salt']

data/lib/ab/version.rb

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

data/spec/integration_spec.rb

@@ -21,6 +21,7 @@ describe 'ab' do
         cases.each do |id, variant|
           tests = Ab::Tests.new(input, id)
           tests.send(output['test']).variant.to_s.should == variant
+          tests.send(output['test']).send("#{variant}?").should be_true unless variant.empty?
         end
       end
     end

data/spec/null_test_spec.rb

@@ -5,6 +5,8 @@ module Ab
     subject { NullTest.new }
 
     its(:variant) { should be_nil }
+    its(:start_at) { should_not be_nil }
+    its(:end_at) { should_not be_nil }
 
     specify 'does not raise for method ending in question mark' do
       expect { subject.bla? }.to_not raise_error

data/spec/tests_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Ab
   describe Tests do
     let(:tests) { Tests.new(config, id) }
-    let(:config) { {} }
+    let(:config) { nil }
     let(:id) { 1 }
 
     shared_context 'simple config with feed' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vinted-ab
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mindaugas Mozūras
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hooks
@@ -105,6 +105,46 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 description: 
 email:
 - mindaugas.mozuras@gmail.com