vinted-ab 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3566b6e9c6dc50f3ca1e435644b7e3bb1eab9fd1
-  data.tar.gz: 062d9118532a050d1155981c7ca4633911365421
+  metadata.gz: 45ab4518594015ccbca8ebd4d441f835e103e22c
+  data.tar.gz: 80fa73e5144373f439208f7773b82c76c4949de4
 SHA512:
-  metadata.gz: 3a23e68efe7ebd7e8442f088feb526f1718338b4b41e94375de361deca94b865ad526634a4fd267999b6aebed3d4729d419a7a0a1bbc6159480e38e2b4516e42
-  data.tar.gz: 5f40b68ced5a8adf1f9eed2a34066e68ca94d7716419694bcba22004b3df738509a079d9eb37aeb3987bfecafd279c40114c7dbb7e03c8d9813acf89e90ec903
+  metadata.gz: 467ebec6807d536330430ebd111cff5fcb7d43935b43fa01866d370d61a5db9afa934b662836d5c025cd44395737270a1d029209ed4b5a8a01c58b953530f58c
+  data.tar.gz: a6a561c9a611031fd09d75da86ad36d6b3714fed4980e46cdae5a863aa1c7c45a25c48135134a5e87a1f183dd78e847c07cb0f45def7bf2495ad136c6ef918fa

data/README.md

@@ -82,11 +82,11 @@ For this lib to work, it requires a configuration json, which looks like this:
 
 ```ruby
 configuration = retrieve_from_svc_abs
-ab = Ab::Experiments.new(configuration, user_id)
+ab = Ab::Tests.new(configuration, user_id)
 
 # defining callbacks
-Ab::Experiments.before_picking_variant { |experiment| puts 'magic' }
-Ab::Experiments.after_picking_variant { |experiment, variant| puts "#{variant_name}" }
+Ab::Tests.before_picking_variant { |test| puts 'magic' }
+Ab::Tests.after_picking_variant { |test, variant| puts "#{variant_name}" }
 
 # ab.experiment never returns nil
 # but if you don't belong to any of the buckets, variant will be nil

data/lib/ab/assigned_test.rb

@@ -0,0 +1,54 @@
+module Ab
+  class AssignedTest
+    include Hooks
+    define_hooks :before_picking_variant, :after_picking_variant
+
+    def initialize(test, id)
+      @test, @id = test, id
+      @test.variants.map(&:name).each do |name|
+        define_singleton_method("#{name}?") { name == variant }
+      end
+    end
+
+    def variant
+      @variant ||= begin
+        return unless part_of_test?
+        return unless running?
+
+        run_hook :before_picking_variant, @test.name
+        picked_variant = @test.variants.find { |v| v.accumulated_chance_weight > weight_id }
+
+        result = picked_variant.name if picked_variant
+        run_hook :after_picking_variant, @test.name, result
+        result
+      end
+    end
+
+    private
+
+    def part_of_test?
+      @test.buckets == 'all' || @test.buckets.include?(bucket_id)
+    end
+
+    def bucket_id
+      @bucket_id ||= digest(@test.salt + @id.to_s) % @test.bucket_count
+    end
+
+    def running?
+      now = DateTime.now
+      now.between?(@test.start_at, @test.end_at)
+    end
+
+    def weight_id
+      @variant_digest ||= digest("#{@test.seed}#{@id}") % positive_weight_sum
+    end
+
+    def positive_weight_sum
+      @test.weight_sum > 0 ? @test.weight_sum : 1
+    end
+
+    def digest(string)
+      Digest::SHA256.hexdigest(string).to_i(16)
+    end
+  end
+end

data/lib/ab/{null_experiment.rb → null_test.rb}

@@ -1,4 +1,4 @@
-class NullExperiment
+class NullTest
   def variant
     nil
   end

data/lib/ab/{experiment.rb → test.rb}

@@ -1,5 +1,5 @@
 module Ab
-  class Experiment < Struct.new(:hash, :salt, :bucket_count)
+  class Test < Struct.new(:hash, :salt, :bucket_count)
     def buckets
       hash['buckets']
     end

data/lib/ab/tests.rb

@@ -0,0 +1,41 @@
+module Ab
+  class Tests
+    include Hooks
+    define_hooks :before_picking_variant, :after_picking_variant
+
+    Ab::AssignedTest.before_picking_variant do |test|
+      Ab::Tests.run_hook :before_picking_variant, test
+    end
+    Ab::AssignedTest.after_picking_variant do |test, variant|
+      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
+      end
+    end
+
+    def all
+      result = @assigned_tests.keys.map do |name|
+        [name, send(name).variant]
+      end
+      Hash[result]
+    end
+
+    def method_missing(meth, *args, &block)
+      @null_test ||= NullTest.new
+    end
+
+    def respond_to?(meth)
+      true
+    end
+  end
+end

data/lib/ab/version.rb

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

data/lib/ab.rb

@@ -1,7 +1,7 @@
 require 'hooks'
 require 'ab/version'
-require 'ab/null_experiment'
+require 'ab/null_test'
 require 'ab/variant'
-require 'ab/experiment'
-require 'ab/assigned_experiment'
-require 'ab/experiments'
+require 'ab/test'
+require 'ab/assigned_test'
+require 'ab/tests'

data/spec/{assigned_experiment_spec.rb → assigned_test_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 module Ab
-  describe AssignedExperiment do
-    let(:assigned_experiment) { AssignedExperiment.new(experiment, id) }
-    let(:experiment) { Experiment.new(hash, 'e131bfcfcab06c65d633d0266c7e62a4918', 1000) }
+  describe AssignedTest do
+    let(:assigned_test) { AssignedTest.new(test, id) }
+    let(:test) { Test.new(hash, 'e131bfcfcab06c65d633d0266c7e62a4918', 1000) }
     let(:hash) {
       {
         'name' => name,
@@ -20,10 +20,10 @@ module Ab
     let(:end_at) { DateTime.now.next_year.to_s }
     let(:seed) { 'cccc8888' }
     let(:buckets) { 'all' }
-    let(:thousand_variants) { 1.upto(1000).map { |i| AssignedExperiment.new(experiment, i).variant } }
+    let(:thousand_variants) { 1.upto(1000).map { |i| AssignedTest.new(test, i).variant } }
 
     describe '#variant' do
-      subject { assigned_experiment.variant }
+      subject { assigned_test.variant }
 
       context 'single variant' do
         let(:variants) { [{ 'name' => 'enabled', 'chance_weight' => chance_weight }] }
@@ -54,14 +54,14 @@ module Ab
         end
       end
 
-      context 'experiment that has not started yet' do
+      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 }] }
         it { should be_nil }
       end
 
-      context 'experiment that has already ended' do
+      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 }] }

data/spec/{null_experiment_spec.rb → null_test_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 module Ab
-  describe NullExperiment do
-    subject { NullExperiment.new }
+  describe NullTest do
+    subject { NullTest.new }
 
     specify 'does not raise for method ending in question mark' do
       expect{ subject.bla? }.to_not raise_error

data/spec/test_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module Ab
+  describe Test do
+    let(:test) { Test.new(test_hash, '4321', 100) }
+
+    context '#buckets' do
+      subject { test.buckets }
+      let(:test_hash) { { 'buckets' => [1, 2, 3] } }
+      it { should == [1, 2, 3] }
+    end
+
+    context '#name' do
+      subject { test.name }
+      let(:test_hash) { { 'name' => 'test' } }
+      it { should == 'test' }
+    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') }
+    end
+
+    context '#end_at' do
+      subject { test.end_at }
+
+      context 'nil' do
+        let(:test_hash) { {} }
+        it { should > DateTime.new(2020) }
+      end
+
+      context 'april fools' do
+        let(:test_hash) { { 'end_at' => '2014-04-01T12:00:00+00:00' } }
+        it { should == DateTime.new(2014, 4, 1, 12) }
+      end
+    end
+  end
+end

data/spec/{experiments_spec.rb → tests_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 module Ab
-  describe Experiments do
+  describe Tests do
     describe '.new' do
-      subject { Experiments.new(config, id) }
+      subject { Tests.new(config, id) }
       let(:id) { 1 }
 
       context 'empty config' do
@@ -30,7 +30,7 @@ module Ab
             }]
           }
         }
-        its(:feed) { should be_kind_of AssignedExperiment }
+        its(:feed) { should be_kind_of AssignedTest }
         its(:all) { should == { 'feed' => 'enabled' } }
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vinted-ab
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hooks
@@ -100,17 +100,17 @@ files:
 - Rakefile
 - ab.gemspec
 - lib/ab.rb
-- lib/ab/assigned_experiment.rb
-- lib/ab/experiment.rb
-- lib/ab/experiments.rb
-- lib/ab/null_experiment.rb
+- lib/ab/assigned_test.rb
+- lib/ab/null_test.rb
+- lib/ab/test.rb
+- lib/ab/tests.rb
 - lib/ab/variant.rb
 - lib/ab/version.rb
-- spec/assigned_experiment_spec.rb
-- spec/experiment_spec.rb
-- spec/experiments_spec.rb
-- spec/null_experiment_spec.rb
+- spec/assigned_test_spec.rb
+- spec/null_test_spec.rb
 - spec/spec_helper.rb
+- spec/test_spec.rb
+- spec/tests_spec.rb
 homepage: https://github.com/vinted/ab
 licenses:
 - MIT

data/lib/ab/assigned_experiment.rb

@@ -1,54 +0,0 @@
-module Ab
-  class AssignedExperiment
-    include Hooks
-    define_hooks :before_picking_variant, :after_picking_variant
-
-    def initialize(experiment, id)
-      @experiment, @id = experiment, id
-      @experiment.variants.map(&:name).each do |name|
-        define_singleton_method("#{name}?") { name == variant }
-      end
-    end
-
-    def variant
-      @variant ||= begin
-        return unless part_of_experiment?
-        return unless running?
-
-        run_hook :before_picking_variant, @experiment.name
-        picked_variant = @experiment.variants.find { |v| v.accumulated_chance_weight > weight_id }
-
-        result = picked_variant.name if picked_variant
-        run_hook :after_picking_variant, @experiment.name, result
-        result
-      end
-    end
-
-    private
-
-    def part_of_experiment?
-      @experiment.buckets == 'all' || @experiment.buckets.include?(bucket_id)
-    end
-
-    def bucket_id
-      @bucket_id ||= digest(@experiment.salt + @id.to_s) % @experiment.bucket_count
-    end
-
-    def running?
-      now = DateTime.now
-      now.between?(@experiment.start_at, @experiment.end_at)
-    end
-
-    def weight_id
-      @variant_digest ||= digest("#{@experiment.seed}#{@id}") % positive_weight_sum
-    end
-
-    def positive_weight_sum
-      @experiment.weight_sum > 0 ? @experiment.weight_sum : 1
-    end
-
-    def digest(string)
-      Digest::SHA256.hexdigest(string).to_i(16)
-    end
-  end
-end

data/lib/ab/experiments.rb

@@ -1,41 +0,0 @@
-module Ab
-  class Experiments
-    include Hooks
-    define_hooks :before_picking_variant, :after_picking_variant
-
-    Ab::AssignedExperiment.before_picking_variant do |experiment|
-      Ab::Experiments.run_hook :before_picking_variant, experiment
-    end
-    Ab::AssignedExperiment.after_picking_variant do |experiment, variant|
-      Ab::Experiments.run_hook :after_picking_variant, experiment, variant
-    end
-
-    def initialize(config, id)
-      @assigned_experiments ||= {}
-
-      (config['ab_tests'] || []).each do |experiment|
-        name = experiment['name']
-        @assigned_experiments[name] = nil
-        define_singleton_method(name) do
-          experiment = Experiment.new(experiment, config['salt'], config['bucket_count'])
-          @assigned_experiments[name] ||= AssignedExperiment.new(experiment, id)
-        end
-      end
-    end
-
-    def all
-      result = @assigned_experiments.keys.map do |name|
-        [name, send(name).variant]
-      end
-      Hash[result]
-    end
-
-    def method_missing(meth, *args, &block)
-      @null_experiment ||= NullExperiment.new
-    end
-
-    def respond_to?(meth)
-      true
-    end
-  end
-end

data/spec/experiment_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-
-module Ab
-  describe Experiment do
-    let(:experiment) { Experiment.new(experiment_hash, '4321', 100) }
-
-    context '#buckets' do
-      subject { experiment.buckets }
-      let(:experiment_hash) { { 'buckets' => [1, 2, 3] } }
-      it { should == [1, 2, 3] }
-    end
-
-    context '#name' do
-      subject { experiment.name }
-      let(:experiment_hash) { { 'name' => 'test' } }
-      it { should == 'test' }
-    end
-
-    context '#start_at' do
-      subject { experiment.start_at }
-      let(:experiment_hash) { { 'start_at' => '2014-05-27T11:56:25+03:00' } }
-      it { should == DateTime.new(2014, 5, 27, 11, 56, 25, '+3') }
-    end
-
-    context '#end_at' do
-      subject { experiment.end_at }
-
-      context 'nil' do
-        let(:experiment_hash) { {} }
-        it { should > DateTime.new(2020) }
-      end
-
-      context 'april fools' do
-        let(:experiment_hash) { { 'end_at' => '2014-04-01T12:00:00+00:00' } }
-        it { should == DateTime.new(2014, 4, 1, 12) }
-      end
-    end
-  end
-end