split 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b771c2496cd674b0512e956fcdb3bf67768ba4a8
-  data.tar.gz: cd3ac62720dbaa5968d58be74ebc689854fd0fac
+  metadata.gz: 9fa1bd87e254e6e0bc2f244f3fd6e479d40e096f
+  data.tar.gz: c50789065bf80c9b850bdc0851d1b6dbcd330183
 SHA512:
-  metadata.gz: f94c6eca1509241995790fefc2407ae8cdc546ceae8aad2a4fa4975c47dd4370f5cc835b630a9c91a1cd7682a24bf49c34af422a31f576af70162003717f396e
-  data.tar.gz: 9e47de4c77fa41c39d525c2c79448c3d1e5fdc564dfa340d00857a91cedd11517fc3e871b7f4bb208eab9a5dfe29e2a026dcd40139569d471e146d68bfbc982c
+  metadata.gz: d1ce3cc70e83f014d69136754658030b310aaff9450d6ad8750011202d071f44a0157c824e79a0a4dd7938e2534090949e6f138c913c799caec02ba01b2b277c
+  data.tar.gz: db2e2a14bdd4bfb3e8620c211e74cf649dbfe9c67a0555e1304f79ab2e8c9da707c5798816d90887c4f2d1f7ab2ad87d99157d00125801eb29afb8026033983b

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.3.0 (October 20th, 2015)
+
+Features
+
+ - allow for custom redis_url different from ENV variable (@davidgrieser, #323)
+ - add ability to change the length of the persistence cookie (@peterylai, #335)
+
+Bugfixes:
+
+ - Rescue from Redis::BaseError instead of Redis::CannotConnectError (@nfm, #342)
+ - Fix active experiments when experiment is on a later version (@ndrisso, #331)
+ - Fix caching of winning alternative (@nfm, #329)
+
+Misc:
+
+ - Remove duplication from Experiment#save (@pakallis, #333)
+ - Remove unnecessary argument from Experiment#write_to_alternative (@t4deu, #332)
+
 ## 1.2.1 (May 17th, 2015)
 
 Features

data/README.md

@@ -23,47 +23,29 @@ Split only supports redis 2.0 or greater.
 If you're on OS X, Homebrew is the simplest way to install Redis:
 
 ```bash
-$ brew install redis
-$ redis-server /usr/local/etc/redis.conf
+brew install redis
+redis-server /usr/local/etc/redis.conf
 ```
 
 You now have a Redis daemon running on 6379.
 
 ## Setup
 
-If you are using bundler add split to your Gemfile:
-
-``` ruby
-gem 'split'
-```
-
-Then run:
-
-```bash
-$ bundle install
-```
-
-Otherwise install the gem:
-
 ```bash
-$ gem install split
-```
-
-and require it in your project:
-
-```ruby
-require 'split'
+gem install split
 ```
 
-### Rails 3
+### Rails
 
-Split is autoloaded when rails starts up, as long as you've configured redis it will 'just work'.
+Adding `gem 'split'` to your Gemfile will autoloaded it when rails starts up, as long as you've configured redis it will 'just work'.
 
 ### Sinatra
 
 To configure sinatra with Split you need to enable sessions and mix in the helper methods. Add the following lines at the top of your sinatra app:
 
 ```ruby
+require 'split'
+
 class MySinatraApp < Sinatra::Base
   enable :sessions
   helpers Split::Helper
@@ -86,8 +68,8 @@ It can be used to render different templates, show different text or any other c
 Example: View
 
 ```erb
-<% ab_test("login_button", "/images/button1.jpg", "/images/button2.jpg") do |button_file| %>
-  <%= image_tag(button_file, :alt => "Login!") %>
+<% ab_test(:login_button, "/images/button1.jpg", "/images/button2.jpg") do |button_file| %>
+  <%= image_tag(button_file, alt: "Login!") %>
 <% end %>
 ```
 
@@ -96,7 +78,7 @@ Example: Controller
 ```ruby
 def register_new_user
   # See what level of free points maximizes users' decision to buy replacement points.
-  @starter_points = ab_test("new_user_free_points", '100', '200', '300')
+  @starter_points = ab_test(:new_user_free_points, '100', '200', '300')
 end
 ```
 
@@ -105,14 +87,14 @@ Example: Conversion tracking (in a controller!)
 ```ruby
 def buy_new_points
   # some business logic
-  finished("new_user_free_points")
+  finished(:new_user_free_points)
 end
 ```
 
 Example: Conversion tracking (in a view)
 
 ```erb
-Thanks for signing up, dude! <% finished("signup_page_redesign") %>
+Thanks for signing up, dude! <% finished(:signup_page_redesign) %>
 ```
 
 You can find more examples, tutorials and guides on the [wiki](https://github.com/splitrb/split/wiki).
@@ -139,11 +121,11 @@ Perhaps you only want to show an alternative to 10% of your visitors because it
 To do this you can pass a weight with each alternative in the following ways:
 
 ```ruby
-ab_test('homepage design', {'Old' => 20}, {'New' => 2})
+ab_test(:homepage_design, {'Old' => 18}, {'New' => 2})
 
-ab_test('homepage design', 'Old', {'New' => 0.1})
+ab_test(:homepage_design, 'Old', {'New' => 1.0/9})
 
-ab_test('homepage design', {'Old' => 10}, 'New')
+ab_test(:homepage_design', {'Old' => 9}, 'New')
 ```
 
 This will only show the new alternative to visitors 1 in 10 times, the default weight for an alternative is 1.
@@ -161,7 +143,7 @@ will always have red buttons. This won't be stored in your session or count towa
 
 In the event you want to disable all tests without having to know the individual experiment names, add a `SPLIT_DISABLE` query parameter.
 
-    http://myawesomesite.com?SPLIT_DISABLE=trues
+    http://myawesomesite.com?SPLIT_DISABLE=true
 
 It is not required to send `SPLIT_DISABLE=false` to activate Split.
 
@@ -179,7 +161,7 @@ When a user completes a test their session is reset so that they may start the t
 To stop this behaviour you can pass the following option to the `finished` method:
 
 ```ruby
-finished('experiment_name', :reset => false)
+finished(:experiment_name, reset: false)
 ```
 
 The user will then always see the alternative they started with.
@@ -212,6 +194,15 @@ Split.configure do |config|
 end
 ```
 
+By default, cookies will expire in 1 year. To change that, set the `persistence_cookie_length` in the configuration (unit of time in seconds).
+
+```ruby
+Split.configure do |config|
+  config.persistence = :cookie
+  config.persistence_cookie_length = 2592000 # 30 days
+end
+```
+
 __Note:__ Using cookies depends on `ActionDispatch::Cookies` or any identical API
 
 #### Redis
@@ -220,9 +211,9 @@ 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 })
+  config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: -> (context) { context.current_user_id })
   # Equivalent
-  # config.persistence = Split::Persistence::RedisAdapter.with_config(:lookup_by => :current_user_id }
+  # config.persistence = Split::Persistence::RedisAdapter.with_config(lookup_by: :current_user_id)
 end
 ```
 
@@ -233,7 +224,7 @@ Options:
 #### Custom Adapter
 
 Your custom adapter needs to implement the same API as existing adapters.
-See `Split::Persistance::CookieAdapter` or `Split::Persistence::SessionAdapter` for a starting point.
+See `Split::Persistence::CookieAdapter` or `Split::Persistence::SessionAdapter` for a starting point.
 
 ```ruby
 Split.configure do |config|
@@ -294,8 +285,8 @@ For example:
 
 ``` ruby
 Split.configure do |config|
-  config.on_experiment_reset  = proc{ |experiment| # Do something on reset }
-  config.on_experiment_delete = proc{ |experiment| # Do something else on delete }
+  config.on_experiment_reset  = -> (example) { # Do something on reset }
+  config.on_experiment_delete = -> (experiment) { # Do something else on delete }
 end
 ```
 
@@ -316,13 +307,13 @@ run Rack::URLMap.new \
 However, if you are using Rails 3: You can mount this inside your app routes by first adding this to the Gemfile:
 
 ```ruby
-gem 'split', :require => 'split/dashboard'
+gem 'split', require: 'split/dashboard'
 ```
 
 Then adding this to config/routes.rb
 
 ```ruby
-mount Split::Dashboard, :at => 'split'
+mount Split::Dashboard, at: 'split'
 ```
 
 You may want to password protect that page, you can do so with `Rack::Auth::Basic` (in your split initializer file)
@@ -335,11 +326,11 @@ end
 
 You can even use Devise or any other Warden-based authentication method to authorize users. Just replace `mount Split::Dashboard, :at => 'split'` in `config/routes.rb` with the following:
 ```ruby
-match "/split" => Split::Dashboard, :anchor => false, :via => [:get, :post], :constraints => lambda { |request|
+match "/split" => Split::Dashboard, anchor: false, via: [:get, :post, :delete], constraints: -> (request) do
   request.env['warden'].authenticated? # are we authenticated?
   request.env['warden'].authenticate! # authenticate if not already
   # or even check any other condition such as request.env['warden'].user.is_admin?
-}
+end
 ```
 
 More information on this [here](http://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
@@ -355,16 +346,17 @@ You can override the default configuration options of Split like so:
 ```ruby
 Split.configure do |config|
   config.db_failover = true # handle redis errors gracefully
-  config.db_failover_on_db_error = proc{|error| Rails.logger.error(error.message) }
+  config.db_failover_on_db_error = -> (error) { Rails.logger.error(error.message) }
   config.allow_multiple_experiments = true
   config.enabled = true
   config.persistence = Split::Persistence::SessionAdapter
   #config.start_manually = false ## new test will have to be started manually from the admin panel. default false
   config.include_rails_helper = true
+  config.redis_url = "custom.redis.url:6380"
 end
 ```
 
-You can set different Redis host via environment variable ```REDIS_URL```.
+Split looks for the Redis host in the environment variable ```REDIS_URL``` then defaults to ```localhost:6379``` if not specified by configure block.
 
 ### Filtering
 
@@ -381,7 +373,7 @@ Split.configure do |config|
   config.ignore_ip_addresses << '81.19.48.130' # or regex: /81\.19\.48\.[0-9]+/
 
   # or provide your own filter functionality, the default is proc{ |request| is_robot? || is_ignored_ip_address? }
-  config.ignore_filter = proc{ |request| CustomExcludeLogic.excludes?(request) }
+  config.ignore_filter = -> (request) { CustomExcludeLogic.excludes?(request) }
 end
 ```
 
@@ -394,15 +386,15 @@ algorithm and if the experiment resets once finished:
 ```ruby
 Split.configure do |config|
   config.experiments = {
-    "my_first_experiment" => {
-      :alternatives => ["a", "b"],
-      :resettable => false
+    my_first_experiment: {
+      alternatives: ["a", "b"],
+      resettable: false
     },
-    "my_second_experiment" => {
-      :algorithm => 'Split::Algorithms::Whiplash',
-      :alternatives => [
-        { :name => "a", :percent => 67 },
-        { :name => "b", :percent => 33 }
+    :my_second_experiment => {
+      algorithm: 'Split::Algorithms::Whiplash',
+      alternatives: [
+        { name: "a", percent: 67 },
+        { name: "b", percent: 33 }
       ]
     }
   }
@@ -436,27 +428,41 @@ my_second_experiment:
 This simplifies the calls from your code:
 
 ```ruby
-ab_test("my_first_experiment")
+ab_test(:my_first_experiment)
 ```
 
 and:
 
 ```ruby
-finished("my_first_experiment")
+finished(:my_first_experiment)
 ```
 
 You can also add meta data for each experiment, very useful when you need more than an alternative name to change behaviour:
 
+```ruby
+Split.configure do |config|
+  config.experiments = {
+    my_first_experiment: {
+      alternatives: ["a", "b"],
+      metadata: {
+        "a" => {"text" => "Have a fantastic day"},
+        "b" => {"text" => "Don't get hit by a bus"},
+      }
+    },
+  }
+end
+```
+
 ```yaml
 my_first_experiment:
   alternatives:
     - a
     - b
-    meta:
-      a:
-        text: "Have a fantastic day"
-      b:
-        text: "Don't get hit by a bus"
+  metadata:
+    a:
+      text: "Have a fantastic day"
+    b:
+      text: "Don't get hit by a bus"
 ```
 
 This allows for some advanced experiment configuration using methods like:
@@ -486,9 +492,9 @@ the `:metric` option.
 ```ruby
 Split.configure do |config|
   config.experiments = {
-    "my_first_experiment" => {
-      :alternatives => ["a", "b"],
-      :metric => :my_metric,
+    my_first_experiment: {
+      alternatives: ["a", "b"],
+      metric: :my_metric,
     }
   }
 end
@@ -514,7 +520,7 @@ You might wish to allow an experiment to have multiple, distinguishable goals.
 The API to define goals for an experiment is this:
 
 ```ruby
-ab_test({"link_color" => ["purchase", "refund"]}, "red", "blue")
+ab_test({link_color: ["purchase", "refund"]}, "red", "blue")
 ```
 
 or you can you can define them in a configuration file:
@@ -522,9 +528,9 @@ or you can you can define them in a configuration file:
 ```ruby
 Split.configure do |config|
   config.experiments = {
-    "link_color" => {
-      :alternatives => ["red", "blue"],
-      :goals => ["purchase", "refund"]
+    link_color: {
+      alternatives: ["red", "blue"],
+      goals: ["purchase", "refund"]
     }
   }
 end
@@ -533,7 +539,7 @@ end
 To complete a goal conversion, you do it like:
 
 ```ruby
-finished("link_color" => "purchase")
+finished(link_color: "purchase")
 ```
 
 **NOTE:** This does not mean that a single experiment can have/complete progressive goals.

data/lib/split.rb

@@ -53,7 +53,7 @@ module Split
   # create a new one.
   def redis
     return @redis if @redis
-    self.redis = ENV.fetch('REDIS_URL', 'localhost:6379')
+    self.redis = self.configuration.redis_url
     self.redis
   end
 

data/lib/split/configuration.rb

@@ -10,6 +10,7 @@ module Split
     attr_accessor :allow_multiple_experiments
     attr_accessor :enabled
     attr_accessor :persistence
+    attr_accessor :persistence_cookie_length
     attr_accessor :algorithm
     attr_accessor :store_override
     attr_accessor :start_manually
@@ -19,6 +20,7 @@ module Split
     attr_accessor :on_experiment_delete
     attr_accessor :include_rails_helper
     attr_accessor :beta_probability_simulations
+    attr_accessor :redis_url
 
     attr_reader :experiments
 
@@ -201,9 +203,11 @@ module Split
       @enabled = true
       @experiments = {}
       @persistence = Split::Persistence::SessionAdapter
+      @persistence_cookie_length = 31536000 # One year from now
       @algorithm = Split::Algorithms::WeightedSample
       @include_rails_helper = true
       @beta_probability_simulations = 10000
+      @redis_url = ENV.fetch('REDIS_URL', 'localhost:6379')
     end
 
     private

data/lib/split/dashboard/views/_experiment.erb

@@ -4,9 +4,7 @@
   <% experiment_class = "experiment" %>
 <% end %>
 
-<% unless experiment.calc_time == Time.now.day %>
-  <% experiment.estimate_winning_alternative %>
-<% end %>
+<% experiment.calc_winning_alternatives %>
 
 <div class="<%= experiment_class %>">
   <div class="experiment-header">

data/lib/split/experiment.rb

@@ -83,7 +83,8 @@ module Split
         Split.redis.sadd(:experiments, name)
         start unless Split.configuration.start_manually
         @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
-        @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
+        save_goals
+        save_metadata
         Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
       else
         existing_alternatives = load_alternatives_from_redis
@@ -96,8 +97,8 @@ module Split
           delete_metadata
           Split.redis.del(@name)
           @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
-          @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
-          Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
+          save_goals
+          save_metadata
         end
       end
 
@@ -274,17 +275,22 @@ module Split
     end
 
     def calc_winning_alternatives
-      if goals.empty?
-        self.estimate_winning_alternative
-      else
-        goals.each do |goal|
-          self.estimate_winning_alternative(goal)
+      # Super simple cache so that we only recalculate winning alternatives once per day
+      days_since_epoch = Time.now.utc.to_i / 86400
+
+      if self.calc_time != days_since_epoch
+        if goals.empty?
+          self.estimate_winning_alternative
+        else
+          goals.each do |goal|
+            self.estimate_winning_alternative(goal)
+          end
         end
-      end
 
-      calc_time = Time.now.day
+        self.calc_time = days_since_epoch
 
-      self.save
+        self.save
+      end
     end
 
     def estimate_winning_alternative(goal = nil)
@@ -309,12 +315,12 @@ module Split
 
       @alternative_probabilities = calc_alternative_probabilities(winning_counts, Split.configuration.beta_probability_simulations)
 
-      write_to_alternatives(@alternative_probabilities, goal)
+      write_to_alternatives(goal)
 
       self.save
     end
 
-    def write_to_alternatives(alternative_probabilities, goal = nil)
+    def write_to_alternatives(goal = nil)
       alternatives.each do |alternative|
         alternative.set_p_winner(@alternative_probabilities[alternative], goal)
       end
@@ -390,7 +396,7 @@ module Split
     end
 
     def calc_time
-      Split.redis.hget(experiment_config_key, :calc_time)
+      Split.redis.hget(experiment_config_key, :calc_time).to_i
     end
 
     def jstring(goal = nil)
@@ -451,5 +457,13 @@ module Split
       end
     end
 
+    def save_goals
+      @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
+    end
+
+    def save_metadata
+      Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
+    end
+
   end
 end

data/lib/split/helper.rb

@@ -16,7 +16,7 @@ module Split
         else
           control_variable(experiment.control)
         end
-      rescue Errno::ECONNREFUSED, Redis::CannotConnectError, SocketError => e
+      rescue Errno::ECONNREFUSED, Redis::BaseError, SocketError => e
         raise(e) unless Split.configuration.db_failover
         Split.configuration.db_failover_on_db_error.call(e)
 
@@ -116,9 +116,10 @@ module Split
     def active_experiments
       experiment_pairs = {}
       ab_user.keys.each do |key|
-        Metric.possible_experiments(key).each do |experiment|
+        key_without_version = key.split(/\:\d(?!\:)/)[0]
+        Metric.possible_experiments(key_without_version).each do |experiment|
           if !experiment.has_winner?
-            experiment_pairs[key] = ab_user[key]
+            experiment_pairs[key_without_version] = ab_user[key]
           end
         end
       end

data/lib/split/persistence/cookie_adapter.rb

@@ -4,10 +4,9 @@ module Split
   module Persistence
     class CookieAdapter
 
-      EXPIRES = Time.now + 31536000 # One year from now
-
       def initialize(context)
         @cookies = context.send(:cookies)
+        @expires = Time.now + cookie_length_config
       end
 
       def [](key)
@@ -31,7 +30,7 @@ module Split
       def set_cookie(value)
         @cookies[:split] = {
           :value => JSON.generate(value),
-          :expires => EXPIRES
+          :expires => @expires
         }
       end
 
@@ -47,6 +46,10 @@ module Split
         end
       end
 
+      def cookie_length_config
+        Split.configuration.persistence_cookie_length
+      end
+
     end
   end
 end

data/lib/split/version.rb

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

data/spec/configuration_spec.rb

@@ -210,4 +210,34 @@ describe Split::Configuration do
 
     expect(@config.normalized_experiments).to eq({:my_experiment=>{:alternatives=>[{"control_opt"=>0.67}, [{"second_opt"=>0.1}, {"third_opt"=>0.23}]]}})
   end
+
+  context "configuration URL" do
+    it "should default to local redis server" do
+      expect(@config.redis_url).to eq("localhost:6379")
+    end
+
+    it "should allow for redis url to be configured" do
+      @config.redis_url = "custom_redis_url"
+      expect(@config.redis_url).to eq("custom_redis_url")
+    end
+
+    context "provided REDIS_URL environment variable" do
+      it "should use the ENV variable" do
+        ENV['REDIS_URL'] = "env_redis_url"
+        expect(Split::Configuration.new.redis_url).to eq("env_redis_url")
+      end
+    end
+  end
+
+  context "persistence cookie length" do
+    it "should default to 1 year" do
+      expect(@config.persistence_cookie_length).to eq(31536000)
+    end
+
+    it "should allow the persistence cookie length to be configured" do
+      @config.persistence_cookie_length = 2592000
+      expect(@config.persistence_cookie_length).to eq(2592000)
+    end
+  end
+
 end

data/spec/experiment_spec.rb

@@ -428,6 +428,13 @@ describe Split::Experiment do
       p_goal2 = alt.p_winner(goal2)
       expect(p_goal1).not_to be_within(0.04).of(p_goal2)
     end
+
+    it "should return nil and not re-calculate probabilities if they have already been calculated today" do
+      experiment = Split::ExperimentCatalog.find_or_create({'link_color3' => ["purchase", "refund"]}, 'blue', 'red', 'green')
+      experiment_calc_time = Time.now.utc.to_i / 86400
+      experiment.calc_time = experiment_calc_time
+      expect(experiment.calc_winning_alternatives).to be nil
+    end
   end
 
 end

data/spec/helper_spec.rb

@@ -449,6 +449,14 @@ describe Split::Helper do
       expect(active_experiments.first[0]).to eq "def"
       expect(active_experiments.first[1]).to eq alternative
     end
+    
+    it 'should show an active test when an experiment is on a later version' do
+      experiment.reset
+      expect(experiment.version).to eq(1)
+      ab_test('link_color', 'blue', 'red')
+      expect(active_experiments.count).to eq 1
+      expect(active_experiments.first[0]).to eq "link_color"
+    end
 
     it 'should show multiple tests' do
       Split.configure do |config|

data/split.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.licenses    = ['MIT']
   s.email       = ["andrewnez@gmail.com"]
   s.homepage    = "https://github.com/splitrb/split"
-  s.summary     = %q{Rack based split testing framework}
+  s.summary     = "Rack based split testing framework"
 
   s.required_ruby_version = '>= 1.9.2'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: split
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rack based split testing framework
@@ -252,3 +252,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
+has_rdoc: