eeny-meeny 1.0.0 → 2.0.0

data/spec/eeny-meeny/{variation_spec.rb → models/variation_spec.rb}

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'eeny-meeny/variation'
+require 'eeny-meeny/models/variation'
 
 describe EenyMeeny::Variation do
   describe 'when initialized' do

data/spec/eeny-meeny/routing/experiment_constraint_spec.rb

@@ -0,0 +1,39 @@
+require 'eeny-meeny/routing/experiment_constraint'
+require 'eeny-meeny/middleware'
+require 'rack/test'
+
+describe EenyMeeny::ExperimentConstraint, experiments: true do
+
+  let(:request) do
+    session = Rack::MockSession.new(EenyMeeny::Middleware.new(MockRackApp.new))
+    session.set_cookie('eeny_meeny_my_page_v1=IlI%2FGW9IZvayAGQbBOroxIrfr6Z116OJqdjFdrw6FOZXOrinmxQmsKw2a%2Fb8kJFP0Up%2BLr4FACovT9%2Bo0hRdcY0AJtcYqMXC96GDMSwa2HauZbjHw16Q3%2BboSnWjfaEOHmqlyxtPxQwxlr3rsT%2FYblPjqqQ%2FiPbaJUqou3LiMtpVg4V%2FJxJdhn0XJUgFMDaFWXVFYYA6VmJSFUGglhRlbg%3D%3D; path=/; expires=Tue, 11 Oct 2016 13:07:53 -0000; HttpOnly')
+    session
+  end
+
+  describe 'when initialized' do
+
+    context 'for an inactive experiment' do
+      subject do
+        described_class.new(:expired)
+      end
+
+      describe '#matches?' do
+        it 'returns false' do
+          expect(subject.matches?(request)).to be false
+        end
+      end
+    end
+
+    context 'for an active experiment' do
+      subject do
+        described_class.new(:my_page)
+      end
+
+      describe '#matches?' do
+        it 'returns true' do
+          expect(subject.matches?(request)).to be true
+        end
+      end
+    end
+  end
+end

data/spec/eeny-meeny/routing/smoke_test_constraint_spec.rb

@@ -0,0 +1,35 @@
+require 'eeny-meeny/routing/smoke_test_constraint'
+require 'eeny-meeny/middleware'
+require 'rack/test'
+
+describe EenyMeeny::SmokeTestConstraint do
+
+  let(:request) do
+    Rack::MockSession.new(EenyMeeny::Middleware.new(MockRackApp.new))
+  end
+
+  let(:request_with_cookie) do
+    request.set_cookie('smoke_test_shadow_v1=kqe%2Bt%2F72JZ9s7fOv0nQ8GszTEmmXj3tUsjqmqy31i4yZLku5okuya%2F3PYb8Oi%2BSi53hDP8egfeiCcbrlBN4s5ifQwToaZHNAs43V1EKb8ca%2BTRK0lpCWfR58%2BQjpWwZL; expires=Tue, 11 Oct 2016 13:30:31 -0000; HttpOnly')
+    request
+  end
+
+  describe 'when initialized' do
+
+    subject do
+      described_class.new(:shadow)
+    end
+
+    describe '#matches?' do
+      context 'for a request with a valid smoke test cookie' do
+        it 'returns true' do
+          expect(subject.matches?(request_with_cookie)).to be true
+        end
+      end
+      context 'for a request without a smoke test cookie' do
+        it 'returns false' do
+          expect(subject.matches?(request)).to be false
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/experiments.yml

@@ -8,3 +8,15 @@
     :new:
       :name: New My Page
       :weight: 0.98
+:expired:
+  :name: Expired
+  :version: 1
+  :start_at: '2016-08-11T11:55:40Z'
+  :end_at: '2016-08-11T11:55:40Z'
+  :variations:
+    :old:
+      :name: Old Expired Page
+      :weight: 0.02
+    :new:
+      :name: New Expired Page
+      :weight: 0.98

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'simplecov'
 require 'simplecov-rcov'
 require 'codeclimate-test-reporter'
+require 'active_support/time'
 
 SimpleCov.start do
   formatter SimpleCov::Formatter::MultiFormatter[
@@ -9,16 +10,32 @@ SimpleCov.start do
                 CodeClimate::TestReporter::Formatter
             ]
   add_group('EenyMeeny', 'lib/eeny-meeny')
+  add_group('Rake Tasks', 'lib/tasks')
   add_group('Specs', 'spec')
 end
 
 require 'rspec'
 require 'yaml'
-require 'eeny-meeny'
 require 'mock_rack_app'
 
+require 'eeny-meeny'
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = "random"
+
+  config.before(:suite) do
+    Time.zone = 'UTC'
+  end
+
+  config.before(:each) do
+    EenyMeeny.reset! # reset configuration before every test.
+  end
+  config.before(:each, experiments: true) do
+    EenyMeeny.configure do |config|
+      config.experiments = YAML.load_file(File.join('spec','fixtures','experiments.yml'))
+    end
+  end
+
 end

data/spec/tasks/cookie_task_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'cookie.rake', experiments: true do
+  before do
+    Rake.application.rake_require "tasks/cookie"
+    Rake::Task.define_task(:environment)
+  end
+
+  describe 'eeny_meeny:cookie:experiment' do
+    context 'executed with an experiment id' do
+      it 'generates a cookie' do
+        expect {
+          Rake::Task['eeny_meeny:cookie:experiment'].execute(Rake::TaskArguments.new([:experiment_id],['my_page']))
+        }.to_not raise_error
+      end
+    end
+
+    context 'executed without arguments' do
+      it 'results in an error' do
+        expect {
+          Rake::Task['eeny_meeny:cookie:experiment'].execute
+        }.to raise_error(RuntimeError, "Missing 'experiment_id' parameter")
+      end
+    end
+  end
+
+  describe 'eeny_meeny:cookie:experiment_variation' do
+    context 'executed with an experiment id' do
+      it 'results in an error' do
+        expect {
+          Rake::Task['eeny_meeny:cookie:experiment_variation'].execute(Rake::TaskArguments.new([:experiment_id],['my_page']))
+        }.to raise_error(RuntimeError, "Missing 'variation_id' parameter")
+      end
+
+      context 'and a variation_id' do
+        it 'generates a cookie' do
+          expect {
+            Rake::Task['eeny_meeny:cookie:experiment_variation'].execute(Rake::TaskArguments.new([:experiment_id, :variation_id],['my_page', 'new']))
+          }.to_not raise_error
+        end
+      end
+    end
+
+    context 'executed without arguments' do
+      it 'results in an error' do
+        expect {
+          Rake::Task['eeny_meeny:cookie:experiment_variation'].execute
+        }.to raise_error(RuntimeError, "Missing 'experiment_id' parameter")
+      end
+    end
+  end
+
+  describe 'eeny_meeny:cookie:smoke_test' do
+    context 'executed with an smoke test id' do
+      it 'generates a cookie' do
+        expect {
+          Rake::Task['eeny_meeny:cookie:smoke_test'].execute(Rake::TaskArguments.new([:smoke_test_id],['shadow']))
+        }.to_not raise_error
+      end
+    end
+
+    context 'executed without arguments' do
+      it 'results in an error' do
+        expect {
+          Rake::Task['eeny_meeny:cookie:smoke_test'].execute
+        }.to raise_error(RuntimeError, "Missing 'smoke_test_id' parameter")
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eeny-meeny
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Christian Orthmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-03 00:00:00.000000000 Z
+date: 2016-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -133,22 +147,27 @@ files:
 - Rakefile
 - eeny-meeny.gemspec
 - lib/eeny-meeny.rb
-- lib/eeny-meeny/encryptor.rb
-- lib/eeny-meeny/experiment.rb
 - lib/eeny-meeny/experiment_helper.rb
 - lib/eeny-meeny/middleware.rb
-- lib/eeny-meeny/middleware_helper.rb
+- lib/eeny-meeny/models/cookie.rb
+- lib/eeny-meeny/models/encryptor.rb
+- lib/eeny-meeny/models/experiment.rb
+- lib/eeny-meeny/models/variation.rb
 - lib/eeny-meeny/railtie.rb
-- lib/eeny-meeny/route_constraint.rb
-- lib/eeny-meeny/shared_methods.rb
-- lib/eeny-meeny/variation.rb
+- lib/eeny-meeny/routing/experiment_constraint.rb
+- lib/eeny-meeny/routing/smoke_test_constraint.rb
 - lib/eeny-meeny/version.rb
-- spec/eeny-meeny/experiment_spec.rb
+- lib/tasks/cookie.rake
 - spec/eeny-meeny/middleware_spec.rb
-- spec/eeny-meeny/variation_spec.rb
+- spec/eeny-meeny/models/cookie_spec.rb
+- spec/eeny-meeny/models/experiment_spec.rb
+- spec/eeny-meeny/models/variation_spec.rb
+- spec/eeny-meeny/routing/experiment_constraint_spec.rb
+- spec/eeny-meeny/routing/smoke_test_constraint_spec.rb
 - spec/fixtures/experiments.yml
 - spec/mock_rack_app.rb
 - spec/spec_helper.rb
+- spec/tasks/cookie_task_spec.rb
 homepage: http://rubygems.org/gems/eeny-meeny
 licenses:
 - MIT
@@ -169,9 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A simple split testing tool for Rails
+summary: A simple split and smoke testing tool for Rails
 test_files: []
-has_rdoc: 

data/lib/eeny-meeny/middleware_helper.rb

@@ -1,25 +0,0 @@
-module EenyMeeny::MiddlewareHelper
-  def has_experiment_cookie?(cookies, experiment)
-    cookies.has_key?(experiment_cookie_name(experiment))
-  end
-
-  def generate_cookie_value(experiment, cookie_config)
-    variation = experiment.pick_variation
-    cookie = {
-        expires: (experiment.end_at || 1.year.from_now),
-        httponly: true,
-        value: Marshal.dump({
-                                name: experiment.name,
-                                variation: variation,
-                            })
-    }
-    cookie[:same_site] = cookie_config[:same_site] unless cookie_config[:same_site].nil?
-    cookie[:path] = cookie_config[:path] unless cookie_config[:path].nil?
-    cookie
-  end
-
-  private
-  def experiment_cookie_name(experiment)
-    EenyMeeny::EENY_MEENY_COOKIE_PREFIX+experiment.id.to_s+'_v'+experiment.version.to_s
-  end
-end

data/lib/eeny-meeny/route_constraint.rb

@@ -1,33 +0,0 @@
-require 'eeny-meeny/shared_methods'
-
-module EenyMeeny
-  class RouteConstraint
-    @@eeny_meeny_encryptor = nil
-
-    def initialize(experiment_id, variation_id: nil)
-      @experiment_id = experiment_id
-      @variation_id = variation_id
-      @version = experiment_version(experiment_id)
-    end
-
-    def matches?(request)
-      !participates_in?(request).nil?
-    end
-
-    private
-
-    def participates_in?(request)
-      cookie = eeny_meeny_cookie(request)
-      cookie[:variation] unless cookie.nil? || (!cookie.nil? && @variation_id.present? && @variation_id != cookie[:variation].id)
-    end
-
-    def eeny_meeny_cookie(request)
-      cookie = request.cookie_jar[EenyMeeny::EENY_MEENY_COOKIE_PREFIX+@experiment_id.to_s+'_v'+@version.to_s]
-      if cookie
-        Marshal.load(decrypt(cookie)) rescue nil
-      end
-    end
-
-    include EenyMeeny::SharedMethods
-  end
-end

data/lib/eeny-meeny/shared_methods.rb

@@ -1,23 +0,0 @@
-module EenyMeeny::SharedMethods
-
-  private
-
-  def experiment_version(experiment_id)
-    (Rails.application.config.eeny_meeny.experiments.
-        try(:[], experiment_id.to_sym).try(:[], :version) || 1) rescue 1
-  end
-
-  def decrypt(cookie)
-    begin
-      if Rails.application.config.eeny_meeny.secure
-        # Memoize encryptor to avoid creating new instances on every request.
-        @@eeny_meeny_encryptor ||= EenyMeeny::Encryptor.new(Rails.application.config.eeny_meeny.secret)
-        @@eeny_meeny_encryptor.decrypt(cookie)
-      else
-        cookie
-      end
-    rescue
-      nil
-    end
-  end
-end

data/spec/eeny-meeny/experiment_spec.rb

@@ -1,62 +0,0 @@
-require 'spec_helper'
-require 'eeny-meeny/experiment'
-require 'eeny-meeny/variation'
-
-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
-    end
-  end
-end