verdict 0.2.0 → 0.2.1

data/lib/verdict/storage.rb

@@ -1,138 +1,3 @@
-require 'json'
-
-module Verdict::Storage
-
-  class MockStorage
-
-    # Should store the assignments to allow quick lookups.
-    # - Assignments should be unique on the combination of 
-    #   `assignment.experiment.handle` and `assignment.subject_identifier`.
-    # - The main property to store is `group.handle`
-    # - Should return true if stored successfully.
-    def store_assignment(assignment)
-      false
-    end
-
-    # Should do a fast lookup of an assignment of the subject for the given experiment.
-    # - Should return nil if not found in store
-    # - Should return an Assignment instance otherwise.
-    def retrieve_assignment(experiment, subject_identifier)
-      nil
-    end
-
-    # Should remove the subject from storage, so it will be reassigned later.
-    def remove_assignment(experiment, subject_identifier)
-    end
-
-    # Should clear out the storage used for this experiment
-    def clear_experiment(experiment)
-    end
-
-    # Retrieves the start timestamp of the experiment
-    def retrieve_start_timestamp(experiment)
-      nil
-    end
-
-    # Stores the timestamp on which the experiment was started
-    def store_start_timestamp(experiment, timestamp)
-    end
-  end
-
-  class MemoryStorage
-
-    attr_reader :assignments, :start_timestamps
-
-    def initialize
-      @assignments = {}
-      @start_timestamps = {}
-    end
-
-    def store_assignment(assignment)
-      @assignments[assignment.experiment.handle] ||= {}
-      @assignments[assignment.experiment.handle][assignment.subject_identifier] = assignment.returning
-      true
-    end
-
-    def retrieve_assignment(experiment, subject_identifier)
-      experiment_store = @assignments[experiment.handle] || {}
-      experiment_store[subject_identifier]
-    end
-
-    def remove_assignment(experiment, subject_identifier)
-      @assignments[assignment.experiment.handle] ||= {}
-      @assignments[assignment.experiment.handle].delete(subject_identifier)
-    end
-
-    def clear_experiment(experiment)
-      @assignments.delete(experiment.handle)
-    end
-
-    def retrieve_start_timestamp(experiment)
-      @start_timestamps[experiment.handle]
-    end
-
-    def store_start_timestamp(experiment, timestamp)
-      @start_timestamps[experiment.handle] = timestamp
-    end
-  end
-
-  class RedisStorage
-
-    attr_accessor :redis, :key_prefix
-
-    def initialize(redis = nil, options = {})
-      @redis = redis
-      @key_prefix = options[:key_prefix] || 'experiments/'
-    end
-
-    def retrieve_assignment(experiment, subject_identifier)
-      if value = redis.hget(generate_experiment_key(experiment), subject_identifier)
-        hash = JSON.parse(value)
-        experiment.subject_assignment(
-          subject_identifier, 
-          experiment.group(hash['group']),
-          DateTime.parse(hash['created_at']).to_time
-        )
-      end
-    rescue ::Redis::BaseError => e
-      raise Verdict::StorageError, "Redis error: #{e.message}"
-    end
-
-    def store_assignment(assignment)
-      hash = { group: assignment.handle, created_at: assignment.created_at }
-      redis.hset(generate_experiment_key(assignment.experiment), assignment.subject_identifier, JSON.dump(hash))
-    rescue ::Redis::BaseError => e
-      raise Verdict::StorageError, "Redis error: #{e.message}"
-    end
-
-    def remove_assignment(experiment, subject_identifier)
-      redis.hdel(generate_experiment_key(experiment), subject_identifier)
-    end
-
-    def clear_experiment(experiment)
-      redis.del(generate_experiment_key(experiment))
-      redis.del(generate_experiment_start_timestamp_key(experiment))
-    end
-
-    def retrieve_start_timestamp(experiment)
-      if started_at = redis.get(generate_experiment_start_timestamp_key(experiment))
-        DateTime.parse(started_at).to_time
-      end
-    end
-
-    def store_start_timestamp(experiment, timestamp)
-      redis.setnx(generate_experiment_start_timestamp_key(experiment), timestamp.to_s)
-    end
-
-
-    private
-
-    def generate_experiment_key(experiment)
-      "#{@key_prefix}#{experiment.handle}"
-    end
-
-    def generate_experiment_start_timestamp_key(experiment)
-      "#{@key_prefix}#{experiment.handle}/started_at"
-    end
-  end
-end
+require 'verdict/storage/mock_storage'
+require 'verdict/storage/memory_storage'
+require 'verdict/storage/redis_storage'

data/lib/verdict/storage/memory_storage.rb

@@ -0,0 +1,40 @@
+module Verdict
+  module Storage
+    class MemoryStorage
+      attr_reader :assignments, :start_timestamps
+
+      def initialize
+        @assignments = {}
+        @start_timestamps = {}
+      end
+
+      def store_assignment(assignment)
+        @assignments[assignment.experiment.handle] ||= {}
+        @assignments[assignment.experiment.handle][assignment.subject_identifier] = assignment.returning
+        true
+      end
+
+      def retrieve_assignment(experiment, subject_identifier)
+        experiment_store = @assignments[experiment.handle] || {}
+        experiment_store[subject_identifier]
+      end
+
+      def remove_assignment(experiment, subject_identifier)
+        @assignments[assignment.experiment.handle] ||= {}
+        @assignments[assignment.experiment.handle].delete(subject_identifier)
+      end
+
+      def clear_experiment(experiment)
+        @assignments.delete(experiment.handle)
+      end
+
+      def retrieve_start_timestamp(experiment)
+        @start_timestamps[experiment.handle]
+      end
+
+      def store_start_timestamp(experiment, timestamp)
+        @start_timestamps[experiment.handle] = timestamp
+      end
+    end
+  end
+end

data/lib/verdict/storage/mock_storage.rb

@@ -0,0 +1,38 @@
+module Verdict
+  module Storage
+    class MockStorage
+      # Should store the assignments to allow quick lookups.
+      # - Assignments should be unique on the combination of
+      #   `assignment.experiment.handle` and `assignment.subject_identifier`.
+      # - The main property to store is `group.handle`
+      # - Should return true if stored successfully.
+      def store_assignment(assignment)
+        false
+      end
+
+      # Should do a fast lookup of an assignment of the subject for the given experiment.
+      # - Should return nil if not found in store
+      # - Should return an Assignment instance otherwise.
+      def retrieve_assignment(experiment, subject_identifier)
+        nil
+      end
+
+      # Should remove the subject from storage, so it will be reassigned later.
+      def remove_assignment(experiment, subject_identifier)
+      end
+
+      # Should clear out the storage used for this experiment
+      def clear_experiment(experiment)
+      end
+
+      # Retrieves the start timestamp of the experiment
+      def retrieve_start_timestamp(experiment)
+        nil
+      end
+
+      # Stores the timestamp on which the experiment was started
+      def store_start_timestamp(experiment, timestamp)
+      end
+    end
+  end
+end

data/lib/verdict/storage/redis_storage.rb

@@ -0,0 +1,62 @@
+module Verdict
+  module Storage
+    class RedisStorage
+      attr_accessor :redis, :key_prefix
+
+      def initialize(redis = nil, options = {})
+        @redis = redis
+        @key_prefix = options[:key_prefix] || 'experiments/'
+      end
+
+      def retrieve_assignment(experiment, subject_identifier)
+        if value = redis.hget(generate_experiment_key(experiment), subject_identifier)
+          hash = JSON.parse(value)
+          experiment.subject_assignment(
+            subject_identifier,
+            experiment.group(hash['group']),
+            DateTime.parse(hash['created_at']).to_time
+          )
+        end
+      rescue ::Redis::BaseError => e
+        raise Verdict::StorageError, "Redis error: #{e.message}"
+      end
+
+      def store_assignment(assignment)
+        hash = { group: assignment.handle, created_at: assignment.created_at }
+        redis.hset(generate_experiment_key(assignment.experiment), assignment.subject_identifier, JSON.dump(hash))
+      rescue ::Redis::BaseError => e
+        raise Verdict::StorageError, "Redis error: #{e.message}"
+      end
+
+      def remove_assignment(experiment, subject_identifier)
+        redis.hdel(generate_experiment_key(experiment), subject_identifier)
+      end
+
+      def clear_experiment(experiment)
+        redis.del(generate_experiment_key(experiment))
+        redis.del(generate_experiment_start_timestamp_key(experiment))
+      end
+
+      def retrieve_start_timestamp(experiment)
+        if started_at = redis.get(generate_experiment_start_timestamp_key(experiment))
+          DateTime.parse(started_at).to_time
+        end
+      end
+
+      def store_start_timestamp(experiment, timestamp)
+        redis.setnx(generate_experiment_start_timestamp_key(experiment), timestamp.to_s)
+      end
+
+
+      private
+
+      def generate_experiment_key(experiment)
+        "#{@key_prefix}#{experiment.handle}"
+      end
+
+      def generate_experiment_start_timestamp_key(experiment)
+        "#{@key_prefix}#{experiment.handle}/started_at"
+      end
+    end
+  end
+end

data/lib/verdict/tasks.rake

@@ -5,11 +5,11 @@ def require_env(key)
 end
 
 namespace :experiments do
-  
+
   desc "List all defined experiments"
   task :list => 'environment' do
-    length = Experiments.repository.keys.map(&:length).max
-    Experiments.repository.each do |_, experiment|
+    length = Verdict.repository.keys.map(&:length).max
+    Verdict.repository.each do |_, experiment|
       print "#{experiment.handle.ljust(length)} | "
       print "Groups: #{experiment.groups.values.map(&:to_s).join(', ')}"
       puts
@@ -18,7 +18,7 @@ namespace :experiments do
 
   desc "Looks up the assignment for a given experiment and subject"
   task :lookup_assignment => 'environment' do
-    experiment = Experiments[require_env('experiment')] or raise "Experiment not found"
+    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
     subject_identifier = require_env('subject')
     assignment = experiment.lookup_assignment_for_identifier(subject_identifier)
     if assignment.nil?
@@ -32,7 +32,7 @@ namespace :experiments do
 
   desc "Manually assign a subject to a given group in an experiment"
   task :assign_manually => 'environment' do
-    experiment = Experiments[require_env('experiment')] or raise "Experiment not found"
+    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
     group = experiment.group(require_env('group')) or raise "Group not found"
     assignment = experiment.subject_assignment(require_env('subject'), group, false)
     experiment.store_assignment(assignment)
@@ -40,20 +40,20 @@ namespace :experiments do
 
   desc "Disqualify a subject from an experiment"
   task :disqualify => 'environment' do
-    experiment = Experiments[require_env('experiment')] or raise "Experiment not found"
+    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
     assignment = experiment.subject_assignment(require_env('subject'), nil, false)
     experiment.store_assignment(assignment)
   end
 
   desc "Removes the assignment for a subject so it will be reassigned to the experiment."
   task :remove_assignment => 'environment' do
-    experiment = Experiments[require_env('experiment')] or raise "Experiment not found"
+    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
     experiment.remove_subject_identifier(require_env('subject'))
   end
 
   desc "Runs the cleanup tasks for an experiment"
   task :wrapup => 'environment' do
-    experiment = Experiments[require_env('experiment')] or raise "Experiment not found"
+    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
     experiment.wrapup
   end
 end

data/lib/verdict/version.rb

@@ -1,3 +1,3 @@
 module Verdict
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/assignment_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'json'
 
-class AssignmentTest < MiniTest::Unit::TestCase
+class AssignmentTest < Minitest::Test
 
   def setup
     @experiment = Verdict::Experiment.new('assignment test')
@@ -11,8 +11,8 @@ class AssignmentTest < MiniTest::Unit::TestCase
   def test_basic_properties
     assignment = Verdict::Assignment.new(@experiment, 'test_subject_id', @group, Time.now.utc)
     assert_equal 'test_subject_id', assignment.subject_identifier
-    assert_equal @experiment, assignment.experiment 
-    assert_equal @group, assignment.group 
+    assert_equal @experiment, assignment.experiment
+    assert_equal @group, assignment.group
     assert assignment.returning?
     assert assignment.qualified?
     assert_equal :control, assignment.to_sym
@@ -20,7 +20,7 @@ class AssignmentTest < MiniTest::Unit::TestCase
     assert_kind_of Time, assignment.created_at
 
     non_assignment = Verdict::Assignment.new(@experiment, 'test_subject_id', nil, nil)
-    assert_equal nil, non_assignment.group 
+    assert_equal nil, non_assignment.group
     assert !non_assignment.returning?
     assert !non_assignment.qualified?
     assert_equal nil, non_assignment.to_sym

data/test/conversion_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'json'
 
-class ConversionTest < MiniTest::Unit::TestCase
+class ConversionTest < Minitest::Test
 
   def setup
     @experiment = Verdict::Experiment.new('conversion test') do

data/test/event_logger_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class EventLoggerTest < MiniTest::Unit::TestCase
+class EventLoggerTest < Minitest::Test
 
   def setup
     @experiment = Verdict::Experiment.new(:logger) do

data/test/experiment_test.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 'test_helper'
 
-class ExperimentTest < MiniTest::Unit::TestCase
+class ExperimentTest < Minitest::Test
 
   def test_no_qualifier
     e = Verdict::Experiment.new('test')
@@ -109,7 +109,7 @@ class ExperimentTest < MiniTest::Unit::TestCase
     mock_store.expects(:retrieve_assignment).returns(qualified_assignment).once
     mock_store.expects(:store_assignment).never
     e.assign(mock('subject'))
-  end    
+  end
 
   def test_new_unqualified_assignment_with_store_unqualified
     mock_store, mock_qualifier = Verdict::Storage::MockStorage.new, mock('qualifier')
@@ -202,7 +202,7 @@ class ExperimentTest < MiniTest::Unit::TestCase
 
     conversion = e.convert(subject, :my_goal)
     assert_equal 'test_subject', conversion.subject_identifier
-    assert_equal :my_goal, conversion.goal 
+    assert_equal :my_goal, conversion.goal
   end
 
   def test_json
@@ -309,4 +309,13 @@ class ExperimentTest < MiniTest::Unit::TestCase
     e.assign(stub(id: '123'))
     assert e.started?, "The experiment should have started after the first assignment"
   end
+
+  def test_no_storage
+    e = Verdict::Experiment.new('starting_test') do
+      groups { group :all, 100 }
+      storage :none
+    end
+
+    assert_kind_of Verdict::Storage::MockStorage, e.storage
+  end
 end

data/test/experiments_repository_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ExperimentTest < MiniTest::Unit::TestCase
+class ExperimentTest < Minitest::Test
 
   def setup
     Verdict.repository.clear

data/test/group_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class GroupTest < MiniTest::Unit::TestCase
+class GroupTest < Minitest::Test
 
   def setup
     @experiment = Verdict::Experiment.new('a')
@@ -38,5 +38,5 @@ class GroupTest < MiniTest::Unit::TestCase
     assert_equal 'control', json['handle']
     assert_equal 'testing', json['metadata']['name']
     assert_equal 'description', json['metadata']['description']
-  end  
+  end
 end