split 0.6.4 → 0.6.5

data/CHANGELOG.mdown

@@ -1,3 +1,13 @@
+## 0.6.5 (August 23, 2013)
+
+Features:
+
+  - Added Redis adapter for persisting experiments across sessions (@fengb, #203)
+
+Misc:
+
+  - Expand upon algorithms section in README (@swrobel, #200)
+
 ## 0.6.4 (August 8, 2013)
 
 Features:

data/README.mdown

@@ -191,11 +191,11 @@ end
 
 ### Experiment Persistence
 
-Split comes with two built-in persistence adapters for storing users and the alternatives they've been given for each experiment.
+Split comes with three built-in persistence adapters for storing users and the alternatives they've been given for each experiment.
 
 By default Split will store the tests for each user in the session.
 
-You can optionally configure Split to use a cookie or any custom adapter of your choosing.
+You can optionally configure Split to use a cookie, Redis, or any custom adapter of your choosing.
 
 #### Cookies
 
@@ -207,6 +207,22 @@ end
 
 __Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
 
+#### Redis
+
+Using Redis will allow ab_users to persist across sessions or machines.
+
+```ruby
+Split.configure do |config|
+  config.persistence = Split::Persistence::RedisAdapter.with_config(:lookup_by => proc { |context| context.current_user_id }
+  # Equivalent
+  # config.persistence = Split::Persistence::RedisAdapter.with_config(:lookup_by => :current_user_id }
+end
+```
+
+Options:
+* `lookup_by`: method to invoke per request for uniquely identifying ab_users (mandatory configuration)
+* `namespace`: separate namespace to store these persisted values (default "persistence")
+
 #### Custom Adapter
 
 Your custom adapter needs to implement the same API as existing adapters.
@@ -554,12 +570,23 @@ end
 
 ## Algorithms
 
-By default, Split ships with an algorithm that randomly selects from possible alternatives for a traditional a/b test.
+By default, Split ships with `Split::Algorithms::WeightedSample` that randomly selects from possible alternatives for a traditional a/b test. 
+It is possible to specify static weights to favor certain alternatives.
 
-An implementation of a bandit algorithm is also provided.
+`Split::Algorithms::Whiplash` is an implementation of a [multi-armed bandit algorithm](http://stevehanov.ca/blog/index.php?id=132). 
+This algorithm will automatically weight the alternatives based on their relative performance, 
+choosing the better-performing ones more often as trials are completed.
 
 Users may also write their own algorithms. The default algorithm may be specified globally in the configuration file, or on a per experiment basis using the experiments hash of the configuration file.
 
+To change the algorithm globally for all experiments, use the following in your initializer:
+
+```ruby
+Split.configure do |config|
+  config.algorithm = Split::Algorithms::Whiplash
+end
+```
+
 ## Extensions
 
   - [Split::Export](http://github.com/andrew/split-export) - easily export ab test data out of Split

data/lib/split.rb

@@ -1,4 +1,14 @@
-%w[algorithms extensions metric trial experiment alternative helper version configuration persistence exceptions].each do |f|
+%w[algorithms
+   alternative
+   configuration
+   exceptions
+   experiment
+   extensions
+   helper
+   metric
+   persistence
+   trial
+   version].each do |f|
   require "split/#{f}"
 end
 

data/lib/split/persistence.rb

@@ -1,4 +1,4 @@
-%w[session_adapter cookie_adapter].each do |f|
+%w[session_adapter cookie_adapter redis_adapter].each do |f|
   require "split/persistence/#{f}"
 end
 
@@ -25,4 +25,4 @@ module Split
       Split.configuration.persistence
     end
   end
-end
+end

data/lib/split/persistence/redis_adapter.rb

@@ -0,0 +1,52 @@
+module Split
+  module Persistence
+    class RedisAdapter
+      DEFAULT_CONFIG = {:namespace => 'persistence'}.freeze
+
+      attr_reader :redis_key
+
+      def initialize(context)
+        if lookup_by = self.class.config[:lookup_by]
+          if lookup_by.respond_to?(:call)
+            key_frag = lookup_by.call(context)
+          else
+            key_frag = context.send(lookup_by)
+          end
+          @redis_key = "#{self.class.config[:namespace]}:#{key_frag}"
+        else
+          raise "Please configure lookup_by"
+        end
+      end
+
+      def [](field)
+        Split.redis.hget(redis_key, field)
+      end
+
+      def []=(field, value)
+        Split.redis.hset(redis_key, field, value)
+      end
+
+      def delete(field)
+        Split.redis.hdel(redis_key, field)
+      end
+
+      def keys
+        Split.redis.hkeys(redis_key)
+      end
+
+      def self.with_config(options={})
+        self.config.merge!(options)
+        self
+      end
+
+      def self.config
+        @config ||= DEFAULT_CONFIG.dup
+      end
+
+      def self.reset_config!
+        @config = DEFAULT_CONFIG.dup
+      end
+
+    end
+  end
+end

data/lib/split/version.rb

@@ -1,6 +1,6 @@
 module Split
   MAJOR   = 0
   MINOR   = 6
-  PATCH   = 4
+  PATCH   = 5
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/persistence/redis_adapter_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+describe Split::Persistence::RedisAdapter do
+
+  let(:context) { double(:lookup => 'blah') }
+
+  subject { Split::Persistence::RedisAdapter.new(context) }
+
+  describe '#redis_key' do
+    before { Split::Persistence::RedisAdapter.reset_config! }
+
+    context 'default' do
+      it 'should raise error with prompt to set lookup_by' do
+        expect{Split::Persistence::RedisAdapter.new(context)
+              }.to raise_error
+      end
+    end
+
+    context 'config with lookup_by = proc { "block" }' do
+      before { Split::Persistence::RedisAdapter.with_config(:lookup_by => proc{'block'}) }
+
+      it 'should be "persistence:block"' do
+        subject.redis_key.should == 'persistence:block'
+      end
+    end
+
+    context 'config with lookup_by = proc { |context| context.test }' do
+      before { Split::Persistence::RedisAdapter.with_config(:lookup_by => proc{'block'}) }
+      let(:context) { double(:test => 'block') }
+
+      it 'should be "persistence:block"' do
+        subject.redis_key.should == 'persistence:block'
+      end
+    end
+
+    context 'config with lookup_by = "method_name"' do
+      before { Split::Persistence::RedisAdapter.with_config(:lookup_by => 'method_name') }
+      let(:context) { double(:method_name => 'val') }
+
+      it 'should be "persistence:bar"' do
+        subject.redis_key.should == 'persistence:val'
+      end
+    end
+
+    context 'config with namespace and lookup_by' do
+      before { Split::Persistence::RedisAdapter.with_config(:lookup_by => proc{'frag'}, :namespace => 'namer') }
+
+      it 'should be "namer"' do
+        subject.redis_key.should == 'namer:frag'
+      end
+    end
+  end
+
+  context 'functional tests' do
+    before { Split::Persistence::RedisAdapter.with_config(:lookup_by => 'lookup') }
+
+    describe "#[] and #[]=" do
+      it "should set and return the value for given key" do
+        subject["my_key"] = "my_value"
+        subject["my_key"].should eq("my_value")
+      end
+    end
+
+    describe "#delete" do
+      it "should delete the given key" do
+        subject["my_key"] = "my_value"
+        subject.delete("my_key")
+        subject["my_key"].should be_nil
+      end
+    end
+
+    describe "#keys" do
+      it "should return an array of the user's stored keys" do
+        subject["my_key"] = "my_value"
+        subject["my_second_key"] = "my_second_value"
+        subject.keys.should =~ ["my_key", "my_second_key"]
+      end
+    end
+
+  end
+end

data/split.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Split::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Andrew Nesbitt"]
+  s.licenses    = ['MIT']
   s.email       = ["andrewnez@gmail.com"]
   s.homepage    = "https://github.com/andrew/split"
   s.summary     = %q{Rack based split testing framework}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -204,6 +204,7 @@ files:
 - lib/split/metric.rb
 - lib/split/persistence.rb
 - lib/split/persistence/cookie_adapter.rb
+- lib/split/persistence/redis_adapter.rb
 - lib/split/persistence/session_adapter.rb
 - lib/split/trial.rb
 - lib/split/version.rb
@@ -217,6 +218,7 @@ files:
 - spec/helper_spec.rb
 - spec/metric_spec.rb
 - spec/persistence/cookie_adapter_spec.rb
+- spec/persistence/redis_adapter_spec.rb
 - spec/persistence/session_adapter_spec.rb
 - spec/persistence_spec.rb
 - spec/spec_helper.rb
@@ -224,7 +226,8 @@ files:
 - spec/trial_spec.rb
 - split.gemspec
 homepage: https://github.com/andrew/split
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -258,6 +261,7 @@ test_files:
 - spec/helper_spec.rb
 - spec/metric_spec.rb
 - spec/persistence/cookie_adapter_spec.rb
+- spec/persistence/redis_adapter_spec.rb
 - spec/persistence/session_adapter_spec.rb
 - spec/persistence_spec.rb
 - spec/spec_helper.rb