eeny-meeny 1.0.0 → 2.0.0

data/lib/eeny-meeny/{experiment.rb → models/experiment.rb}

@@ -1,4 +1,4 @@
-require 'eeny-meeny/variation'
+require 'eeny-meeny/models/variation'
 require 'active_support/time'
 require 'active_support/core_ext/enumerable'
 
@@ -6,6 +6,17 @@ module EenyMeeny
   class Experiment
     attr_reader :id, :name, :version, :variations, :total_weight, :end_at, :start_at
 
+    def self.find_all
+      EenyMeeny.config.experiments.map do |id, experiment|
+        new(id, **experiment)
+      end
+    end
+
+    def self.find_by_id(experiment_id)
+      experiment = EenyMeeny.config.experiments[experiment_id.to_sym]
+      new(experiment_id, **experiment) if experiment
+    end
+
     def initialize(id, name: '', version: 1, variations: {}, start_at: nil, end_at: nil)
       @id = id
       @name = name
@@ -14,11 +25,17 @@ module EenyMeeny
         Variation.new(variation_id, **variation)
       end
       @total_weight = (@variations.empty? ? 1.0 : @variations.sum { |variation| variation.weight.to_f })
-
       @start_at = Time.zone.parse(start_at) if start_at
       @end_at = Time.zone.parse(end_at) if end_at
     end
 
+    def active?(now = Time.zone.now)
+      return true if @start_at.nil? && @end_at.nil?
+      return true if @end_at.nil? && (@start_at && (now > @start_at)) # specified start - open-ended
+      return true if @start_at.nil? && (@end_at && (now < @end_at)) # unspecified start - specified end
+      !!((@start_at && (now > @start_at)) && (@end_at && (now < @end_at))) # specified start and end
+    end
+
     def pick_variation
       Hash[
           @variations.map do |variation|

data/lib/eeny-meeny/railtie.rb

@@ -1,27 +1,28 @@
+require 'eeny-meeny'
 require 'eeny-meeny/experiment_helper'
 require 'eeny-meeny/middleware'
 
 module EenyMeeny
   class Railtie < Rails::Railtie
     config.eeny_meeny = ActiveSupport::OrderedOptions.new
-    # default config values. these can be changed in the rails environment configuration.
-    config.eeny_meeny.experiments = []
-    config.eeny_meeny.secure = true
-    config.eeny_meeny.secret = '9fc8b966eca7d03d55df40c01c10b8e02bf1f9d12d27b8968d53eb53e8c239902d00bf6afae5e726ce1111159eeb2f8f0e77233405db1d82dd71397f651a0a4f'
-    config.eeny_meeny.cookies = ActiveSupport::OrderedOptions.new
-    config.eeny_meeny.cookies.path = '/'
-    config.eeny_meeny.cookies.same_site = :strict
 
-    initializer 'eeny_meeny.initialize' do |app|
+    initializer 'eeny_meeny.configure' do |app|
+      # Configrue EenyMeeny (defaults set in eeny_meeny.rb)
+      EenyMeeny.configure do |config|
+        config.cookies     = app.config.eeny_meeny[:cookies]     if app.config.eeny_meeny.has_key?(:cookies)
+        config.experiments = app.config.eeny_meeny[:experiments] if app.config.eeny_meeny.has_key?(:experiments)
+        config.secret      = app.config.eeny_meeny[:secret]      if app.config.eeny_meeny.has_key?(:secret)
+        config.secure      = app.config.eeny_meeny[:secure]      if app.config.eeny_meeny.has_key?(:secure)
+      end
+      # Include Helpers in ActionController and ActionView
       ActionController::Base.send :include, EenyMeeny::ExperimentHelper
       ActionView::Base.send :include, EenyMeeny::ExperimentHelper
+      # Insert Middleware
+      app.middleware.insert_before 'ActionDispatch::Cookies', EenyMeeny::Middleware
+    end
 
-      app.middleware.insert_before 'ActionDispatch::Cookies', EenyMeeny::Middleware,
-                                   config.eeny_meeny.experiments,
-                                   config.eeny_meeny.secure,
-                                   config.eeny_meeny.secret,
-                                   config.eeny_meeny.cookies.path,
-                                   config.eeny_meeny.cookies.same_site
+    rake_tasks do
+      load 'tasks/cookie.rake'
     end
   end
 end

data/lib/eeny-meeny/routing/experiment_constraint.rb

@@ -0,0 +1,19 @@
+require 'eeny-meeny/models/cookie'
+require 'eeny-meeny/models/experiment'
+
+module EenyMeeny
+  class ExperimentConstraint
+
+    def initialize(experiment_id, variation_id: nil)
+      @experiment = EenyMeeny::Experiment.find_by_id(experiment_id)
+      @variation_id = variation_id
+    end
+
+    def matches?(request)
+      return false unless @experiment.active?
+      cookie = EenyMeeny::Cookie.read(request.cookie_jar[EenyMeeny::Cookie.cookie_name(@experiment)])
+      return false if cookie.nil? # Not participating in experiment
+      (@variation_id.nil? || @variation_id == cookie[:variation].id)
+    end
+  end
+end

data/lib/eeny-meeny/routing/smoke_test_constraint.rb

@@ -0,0 +1,15 @@
+require 'eeny-meeny/models/cookie'
+
+module EenyMeeny
+  class SmokeTestConstraint
+
+    def initialize(smoke_test_id, version: 1)
+      @smoke_test_cookie_name = EenyMeeny::Cookie.smoke_test_name(smoke_test_id, version: version)
+    end
+
+    def matches?(request)
+      cookie = EenyMeeny::Cookie.read(request.cookie_jar[@smoke_test_cookie_name])
+      !cookie.nil?
+    end
+  end
+end

data/lib/eeny-meeny/version.rb

@@ -1,3 +1,3 @@
 module EenyMeeny
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/tasks/cookie.rake

@@ -0,0 +1,48 @@
+require 'rake'
+require 'eeny-meeny/models/cookie'
+require 'eeny-meeny/models/experiment'
+
+def write_cookie(experiment_id, variation_id: nil)
+  experiment = EenyMeeny::Experiment.find_by_id(experiment_id)
+  raise "Experiment with id '#{experiment_id}' not found!" if experiment.nil?
+  if variation_id.nil?
+    EenyMeeny::Cookie.create_for_experiment(experiment, EenyMeeny.config.cookies)
+  else
+    EenyMeeny::Cookie.create_for_experiment_variation(experiment, variation_id, EenyMeeny.config.cookies)
+  end
+end
+
+namespace :eeny_meeny do
+
+  namespace :cookie do
+    desc 'Create a valid EenyMeeny experiment cookie'
+    task :experiment, [:experiment_id] => :environment do |t, args|
+      raise "Missing 'experiment_id' parameter" if (args['experiment_id'].nil? || args['experiment_id'].empty?)
+      experiment_id = args['experiment_id'].to_sym
+      cookie = write_cookie(experiment_id)
+      puts cookie
+    end
+
+    desc 'Create a valid EenyMeeny experiment cookie for a specific variation'
+    task :experiment_variation, [:experiment_id, :variation_id] => :environment do |t, args|
+      raise "Missing 'experiment_id' parameter" if (args['experiment_id'].nil? || args['experiment_id'].empty?)
+      raise "Missing 'variation_id' parameter" if (args['variation_id'].nil? || args['variation_id'].empty?)
+      experiment_id = args['experiment_id'].to_sym
+      variation_id = args['variation_id'].to_sym
+      cookie = write_cookie(experiment_id, variation_id: variation_id)
+      puts cookie
+    end
+
+    desc 'Create a valid EenyMeeny smoke test cookie'
+    task :smoke_test, [:smoke_test_id, :version] => :environment do |t, args|
+      raise "Missing 'smoke_test_id' parameter" if (args['smoke_test_id'].nil? || args['smoke_test_id'].empty?)
+      smoke_test_id = args['smoke_test_id']
+      version       = args['version'] || 1
+      cookie = EenyMeeny::Cookie.create_for_smoke_test(smoke_test_id, version: version)
+      puts cookie
+    end
+  end
+
+
+
+end

data/spec/eeny-meeny/middleware_spec.rb

@@ -1,35 +1,32 @@
 require 'spec_helper'
-require 'eeny-meeny/encryptor'
+require 'eeny-meeny/models/encryptor'
 require 'eeny-meeny/middleware'
 
 def initialize_app(secure: true, secret: 'test', path: '/', same_site: :strict)
-  experiments = YAML.load_file(File.join('spec','fixtures','experiments.yml'))
-  described_class.new(app, experiments, secure, secret, path, same_site)
+  EenyMeeny.reset!
+  EenyMeeny.configure do |config|
+    config.cookies     = { path: path, same_site: same_site }
+    config.experiments = YAML.load_file(File.join('spec','fixtures','experiments.yml'))
+    config.secret      = secret
+    config.secure      = secure
+  end
+  described_class.new(app)
 end
 
 describe EenyMeeny::Middleware do
 
   let(:app) { MockRackApp.new }
-  before(:example) do
-    allow(Time).to receive_message_chain(:zone, :now) { Time.now }
-  end
 
   describe 'when initialized' do
 
-    context "with 'config.eeny_meeny.secure = true'" do
-      it 'creates an instance of EenyMeeny::Encryptor' do
-        instance = initialize_app
-        expect(instance.instance_variable_get(:@secure)).to be true
-        expect(instance.instance_variable_get(:@encryptor)).to be_a EenyMeeny::Encryptor
-      end
+    subject { initialize_app }
+
+    it 'sets the experiments' do
+      expect(subject.instance_variable_get(:@experiments)).to be
     end
 
-    context "with 'config.eeny_meeny.secure = false'" do
-      it 'does not have an instance of EenyMeeny::Encryptor' do
-        instance = initialize_app(secure: false)
-        expect(instance.instance_variable_get(:@secure)).to be false
-        expect(instance.instance_variable_get(:@encryptor)).to be nil
-      end
+    it 'sets the cookie config' do
+      expect(subject.instance_variable_get(:@cookie_config)).to be
     end
   end
 

data/spec/eeny-meeny/models/cookie_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'eeny-meeny/models/cookie'
+require 'eeny-meeny/models/experiment'
+
+describe EenyMeeny::Cookie do
+  describe 'when initialized' do
+    subject do
+      described_class.new(name: 'test', value: '12345')
+    end
+
+    it 'sets the instance variables correctly' do
+      expect(subject.name).to eq('test')
+      expect(subject.value).to eq('12345')
+      expect(subject.expires).to be
+      expect(subject.httponly).to be
+      expect(subject.same_site).to be_nil
+      expect(subject.path).to be_nil
+    end
+
+    describe '#to_h' do
+      it 'returns cookie options' do
+        options = subject.to_h
+        expect(options).to be_a Hash
+        expect(options.keys.sort).to eq([:value, :httponly, :expires].sort)
+      end
+    end
+  end
+
+  describe '.create_for_smoke_test' do
+    context 'given a smoke test id' do
+      it 'creates a cookie' do
+        instance = described_class.create_for_smoke_test(:shadow)
+        expect(instance).to be_a EenyMeeny::Cookie
+        expect(instance.name).to eq(described_class.smoke_test_name(:shadow))
+      end
+    end
+  end
+
+  describe '.create_for_experiment', experiments: true do
+    context 'given an experiment' do
+      it 'creates a cookie' do
+        experiment = EenyMeeny::Experiment.find_by_id(:my_page)
+        instance = described_class.create_for_experiment(experiment)
+        expect(instance).to be_a EenyMeeny::Cookie
+        expect(instance.name).to eq(described_class.cookie_name(experiment))
+      end
+
+      context 'and given cookie options' do
+        it 'creates a cookie with the given options' do
+          experiment = EenyMeeny::Experiment.find_by_id(:my_page)
+          instance = described_class.create_for_experiment(experiment, same_site: :fun_stuff)
+          expect(instance).to be_a EenyMeeny::Cookie
+          expect(instance.name).to eq(described_class.cookie_name(experiment))
+          expect(instance.same_site).to eq(:fun_stuff)
+        end
+      end
+    end
+  end
+
+  describe '.create_for_experiment_variation', experiments: true do
+    context 'given an experiment and an variation id' do
+      it 'creates a cookie for that variation' do
+        experiment = EenyMeeny::Experiment.find_by_id(:my_page)
+        instance = described_class.create_for_experiment_variation(experiment, :new)
+        expect(instance).to be_a EenyMeeny::Cookie
+        expect(instance.name).to eq(described_class.cookie_name(experiment))
+        expect(described_class.read(instance.value)[:variation].id).to eq(:new)
+      end
+
+      context 'and given cookie options' do
+        it 'creates a cookie for that variation with the given options' do
+          experiment = EenyMeeny::Experiment.find_by_id(:my_page)
+          instance = described_class.create_for_experiment_variation(experiment, :new, same_site: :fun_stuff)
+          expect(instance).to be_a EenyMeeny::Cookie
+          expect(instance.name).to eq(described_class.cookie_name(experiment))
+          expect(instance.same_site).to eq(:fun_stuff)
+          expect(described_class.read(instance.value)[:variation].id).to eq(:new)
+        end
+      end
+    end
+  end
+
+  describe '.smoke_test_name' do
+    context 'given a smoke_test_id' do
+      it 'returns the smoke test cookie name' do
+        expect(described_class.smoke_test_name(:something)).to eq('smoke_test_something_v1')
+      end
+    end
+  end
+
+  describe '.cookie_name', experiments: true do
+    context 'given an experiment' do
+      it 'returns the experiment cookie name' do
+        experiment = EenyMeeny::Experiment.find_by_id(:my_page)
+        expect(described_class.cookie_name(experiment)).to eq('eeny_meeny_my_page_v1')
+      end
+    end
+  end
+
+  describe '.read', experiments: true do
+    context 'given an empty cookie string' do
+      it 'returns nil' do
+        expect(described_class.read(nil)).to be_nil
+        expect(described_class.read('')).to be_nil
+      end
+    end
+
+    context 'when EenyMeeny.config.secure = true' do
+      context 'and given a valid cookie string' do
+        it 'decrypts the string and returns the cookie hash' do
+          valid_cookie_string = 'DhtZMLAtVpWiruuq6BdQ+YEeDTK4G1p0HQLeyKFZd2+fD8YyT004p56S03yXsE/kzCASnD9O1sk1tsIHDZ8W2gq+5zQD3fu2aqqLm461FOfy0En4/LqHCP0J0VYol3Py0BlhepjSGDuJrRU7TdKZWsG2/dCiMVLjMf0Pt00NZWooUvQfRz9SCzaFL0mywoVrY1ErKKQCNEPmLREaxavCng=='
+          expect(described_class.read(valid_cookie_string)).to be_a Hash
+        end
+      end
+
+      context 'and given an invalid cookie string' do
+        it 'returns nil' do
+          expect(described_class.read('qwedasdafagasdaasdasd')).to be_nil
+        end
+      end
+    end
+
+    context 'when EenyMeeny.config.secure = false' do
+      context 'and given a valid cookie string' do
+        it 'returns the cookie hash' do
+          EenyMeeny.configure do |config|
+            config.secure = false
+            config.experiments = YAML.load_file(File.join('spec','fixtures','experiments.yml'))
+          end
+          experiment = EenyMeeny::Experiment.find_by_id(:my_page)
+          valid_cookie_string = described_class.create_for_experiment(experiment).value
+          expect(described_class.read(valid_cookie_string)).to be_a Hash
+        end
+      end
+    end
+  end
+end

data/spec/eeny-meeny/models/experiment_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+require 'eeny-meeny/models/experiment'
+require 'eeny-meeny/models/variation'
+
+def experiment_with_time(time = {})
+  experiment_options = {
+      name: 'Test 1',
+      variations: {
+          a: { name: 'A' },
+          b: { name: 'B' }}
+  }.merge(time)
+  described_class.new(:experiment_1,
+                      **experiment_options)
+end
+
+describe EenyMeeny::Experiment do
+  describe 'when initialized' do
+
+    context 'with weighted variations' do
+      subject do
+        described_class.new(:experiment_1,
+                            name: 'Test 1',
+                            variations: {
+                                a: { name: 'A', weight: 0.5 },
+                                b: { name: 'B', weight: 0.3 }})
+      end
+
+      it 'sets the instance variables' do
+        expect(subject.id).to eq(:experiment_1)
+        expect(subject.name).to eq('Test 1')
+        expect(subject.variations).to be_a Array
+        expect(subject.variations.size).to eq(2)
+      end
+
+      it "has a 'total_weight' equal to the sum of the variation weights" do
+        expect(subject.total_weight).to eq(0.8)
+      end
+
+      describe '#pick_variation' do
+        it 'picks a variation' do
+          expect(subject.pick_variation).to be_a EenyMeeny::Variation
+        end
+      end
+    end
+
+    context 'with non-weighted variations' do
+      subject do
+        described_class.new(:experiment_1,
+                            name: 'Test 1',
+                            variations: {
+                                a: { name: 'A' },
+                                b: { name: 'B' }})
+      end
+
+      it 'sets the instance variables' do
+        expect(subject.id).to eq(:experiment_1)
+        expect(subject.name).to eq('Test 1')
+        expect(subject.variations).to be_a Array
+        expect(subject.variations.size).to eq(2)
+      end
+
+      it "has a 'total_weight' equal to the number of the variation weights" do
+        expect(subject.total_weight).to eq(2)
+      end
+
+      describe '#pick_variation' do
+        it 'picks a variation' do
+          expect(subject.pick_variation).to be_a EenyMeeny::Variation
+        end
+      end
+
+      describe '#active?' do
+        context 'when the experiment neither have a start_at or end_at time' do
+          it 'returns true' do
+            expect(subject.active?).to be true
+          end
+        end
+
+        context 'when the experiment only have an end_at time' do
+          context 'and the current time < end_at' do
+            it 'returns true' do
+              instance = experiment_with_time(end_at: (Time.zone.now+3600).iso8601)
+              expect(instance.active?).to be true
+            end
+          end
+
+          context 'and the current time > end_at' do
+            it 'returns false' do
+              instance = experiment_with_time(end_at: (Time.zone.now-3600).iso8601)
+              expect(instance.active?).to be false
+            end
+          end
+        end
+
+        context 'when the experiment only have a start_at time' do
+          context 'and the current time < start_at' do
+            it 'returns false' do
+              instance = experiment_with_time(start_at: (Time.zone.now+3600).iso8601)
+              expect(instance.active?).to be false
+            end
+          end
+
+          context 'and the current time > start_at' do
+            it 'returns true' do
+              instance = experiment_with_time(start_at: (Time.zone.now-3600).iso8601)
+              expect(instance.active?).to be true
+            end
+          end
+        end
+
+        context 'when the experiment both have a start_at and end_at time' do
+          context 'and current_time < start_at' do
+            it 'returns false' do
+              instance = experiment_with_time(start_at: (Time.zone.now+3600).iso8601,
+                                              end_at: (Time.zone.now+7200).iso8601)
+              expect(instance.active?).to be false
+            end
+          end
+
+          context 'and current_time > start_at and current time < end_at' do
+            it 'returns true' do
+              instance = experiment_with_time(start_at: (Time.zone.now-3600).iso8601,
+                                              end_at: (Time.zone.now+7200).iso8601)
+              expect(instance.active?).to be true
+            end
+          end
+
+          context 'and current time > start_at and current time > end_at' do
+            it 'returns false' do
+              instance = experiment_with_time(start_at: (Time.zone.now-7200).iso8601,
+                                              end_at: (Time.zone.now-3600).iso8601)
+              expect(instance.active?).to be false
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '.find_all' do
+    context 'when the EenyMeeny is configured with experiments', experiments: true do
+      it 'returns those experiments' do
+        instances = described_class.find_all
+        expect(instances).to be_a Array
+        expect(instances.size).to eq(2)
+        instances.each do |instance|
+          expect(instance).to be_a EenyMeeny::Experiment
+        end
+      end
+    end
+
+    context 'when EenyMeeny is not configured with experiments' do
+      it 'returns an empty array' do
+        expect(described_class.find_all).to eq([])
+      end
+    end
+  end
+
+  describe '.find_by_id' do
+    context 'when EenyMeeny is configured with experiments', experiments: true do
+      context 'and the given id exists' do
+        it 'returns the experiment' do
+          expect(described_class.find_by_id(:my_page)).to be_a EenyMeeny::Experiment
+        end
+      end
+
+      context 'and the given id does not exist' do
+        it 'returns nil' do
+          expect(described_class.find_by_id(:experiment_missing)).to be_nil
+        end
+      end
+    end
+
+    context 'when EenyMeeny is not configured with experiments' do
+      it 'returns nil' do
+        expect(described_class.find_by_id(:experiment_missing)).to be_nil
+      end
+    end
+  end
+
+end