bandido 0.0.6 → 0.0.8

data/README.rdoc

@@ -1,3 +1,23 @@
+= bandido
+
+Bandido is a fork of the bandit gem, the README for which you may find below this section. It still uses the same code namespace as bandit (Bandit), should be compatible with projects already using bandit. If you run into any problems because of this, consider adding:
+
+    require 'bandit'
+
+in your bandit initializer, e.g. config/initializers/bandit.rb
+
+Bandido provides more control over cookies, participant counts and the like. Instead of calling bandit_choose and bandit_convert! in your code, you may use the following method combinations:
+
+    bandit_simple_choose/bandit_simple_convert!   (no cookies involved, same as raw impressions)
+    bandit_session_choose/bandit_session_convert! (session cookie, same as bandit_choose with a fix)
+    bandit_sticky_choose/bandit_sticky_convert!   (persistent cookies)
+
+bandit_sticky_convert! creates a _converted cookie which stops additional conversions from being counted. For example, if you are collecting email addresses, a user may enter their email address more than once, but you may want to count all these attempts as one conversion.
+
+You may also use the bandit_sticky_choose/bandit_session_convert! combination if you wish to use persistent cookies but allow each user to convert multiple times. This way visitors are always presented with the same alternative until they convert, at which point they are presented with another and so on.
+
+Finally, if you use bandit_simple_convert!, please remember the second argument (alternative) is not optional, as we have no cookie to read from.
+
 = bandit
 
 Bandit is a multi-armed bandit optimization framework for Rails.  It provides an alternative to A/B testing in Rails.  For background and a comparison with A/B testing, see the whybandit.rdoc document or the blog post here[http://findingscience.com/rails/vanity/statistics/testing/2011/11/12/bandit:-a-b-testing-alternative-for-rails.html].
@@ -74,4 +94,4 @@ For instance, to generate a week's worth of fake data for the click_test above:
     rake bandit:populate_data[click_test]
 
 = Fault Tolerance
-If the storage mechanism fails, then Bandit will automatically switch to in memory storage.  It will then check every 5 minutes after that to see if the original storage mechanism is back up.  If you have distributed front ends then each front end will continue to optimize (based on the in memory storage), but this optimization will be inefficient compared to shared storage among all front ends.
+If the storage mechanism fails, then Bandit will automatically switch to in memory storage.  It will then check every 5 minutes after that to see if the original storage mechanism is back up.  If you have distributed front ends then each front end will continue to optimize (based on the in memory storage), but this optimization will be inefficient compared to shared storage among all front ends.

data/{bandit.gemspec → bandido.gemspec}

@@ -2,16 +2,14 @@ $:.push File.expand_path("../lib", __FILE__)
 require "bandit/version"
 
 Gem::Specification.new do |s|
-  s.name        = "bandit"
+  s.name        = "bandido"
   s.version     = Bandit::VERSION
-  s.authors     = ["Brian Muller"]
-  s.email       = ["brian.muller@livingsocial.com"]
-  s.homepage    = "https://github.com/bmuller/bandit"
+  s.authors     = ["Michael Nacos"] # original author is Brian Muller, this is a fork
+  s.email       = ["m.nacos@gmail.com"]
+  s.homepage    = "https://github.com/mnacos/bandit"
   s.summary     = "Multi-armed bandit testing in rails"
-  s.description = "Bandit provides a way to do multi-armed bandit optimization of alternatives in a rails website"
-
-  s.rubyforge_project = "bandit"
-
+  s.description = "Bandit-clone, more options around cookies (simple/session/sticky)"
+  s.rubyforge_project = "bandido"
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/bandit/extensions/controller_concerns.rb

@@ -3,22 +3,29 @@ require 'active_support/concern'
 module Bandit
   module ControllerConcerns
     extend ActiveSupport::Concern
-  
+
     module ClassMethods
-      
     end
 
     module InstanceMethods
-      def bandit_convert!(exp, alt=nil, count=1)
+      # look mum, no cookies
+      def bandit_simple_convert!(exp, alt, count=1)
+        Bandit.get_experiment(exp).convert!(alt, count)
+      end
+
+      # expects a session cookie, deletes it, will convert again
+      def bandit_session_convert!(exp, alt=nil, count=1)
         cookiename = "bandit_#{exp}".intern
+        cookiename_converted = "bandit_#{exp}_converted".intern
         alt ||= cookies.signed[cookiename]
-        unless alt.nil?
+        unless alt.nil? or cookies.signed[cookiename_converted]
           Bandit.get_experiment(exp).convert!(alt, count)
           cookies.delete(cookiename)
         end
       end
 
-      def bandit_final_convert!(exp, alt=nil, count=1)
+      # creates a _converted cookie, prevents multiple conversions
+      def bandit_sticky_convert!(exp, alt=nil, count=1)
         cookiename = "bandit_#{exp}".intern
         cookiename_converted = "bandit_#{exp}_converted".intern
         alt ||= cookies.signed[cookiename]
@@ -27,7 +34,16 @@ module Bandit
           Bandit.get_experiment(exp).convert!(alt, count)
         end
       end
-    end
 
+      # FIXME: deprecated (for compatibility with bandit gem & older bandido versions)
+      # ------------------------------------------------------------------------------
+      def bandit_convert!(exp, alt=nil, count=1)
+        bandit_session_convert!(exp, alt, count)
+      end
+
+      def bandit_final_convert!(exp, alt=nil, count=1)
+        bandit_sticky_convert!(exp, alt, count)
+      end
+    end
   end
 end

data/lib/bandit/extensions/view_concerns.rb

@@ -3,38 +3,45 @@ require 'active_support/concern'
 module Bandit
   module ViewConcerns
     extend ActiveSupport::Concern
-  
+
     module ClassMethods
-      
     end
 
     module InstanceMethods
-      def bandit_choose(exp)
-        name = "bandit_#{exp}".intern
+      # always choose something new and increase the participant count
+      def bandit_simple_choose(exp)
+        Bandit.get_experiment(exp).choose(nil)
+      end
 
+      # stick to one alternative for the entire browser session
+      def bandit_session_choose(exp)
+        name = "bandit_#{exp}".intern
         # choose url param with preference
         value = params[name].nil? ? cookies.signed[name] : params[name]
-
         # choose with default, and set cookie
         cookies.signed[name] = Bandit.get_experiment(exp).choose(value)
       end
 
+      # stick to one alternative until user deletes cookies or changes browser
       def bandit_sticky_choose(exp)
         name = "bandit_#{exp}".intern
-
         # choose url param with preference
         value = params[name].nil? ? cookies.signed[name] : params[name]
-
         # sticky choice may outlast a given alternative
         alternative = if Bandit.get_experiment(exp).alternatives.include?(value)
                         value
                       else
                         Bandit.get_experiment(exp).choose(value)
                       end
-
         # re-set cookie
         cookies.permanent.signed[name] = alternative
       end
+
+      # FIXME: deprecated (for compatibility with bandit gem & older bandido versions)
+      # ------------------------------------------------------------------------------
+      def bandit_choose(exp)
+        bandit_session_choose(exp)
+      end
     end
   end
 end

data/lib/bandit/version.rb

@@ -1,3 +1,3 @@
 module Bandit
-  VERSION = "0.0.6"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: bandido
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
-- Brian Muller
+- Michael Nacos
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-01-30 00:00:00 Z
+date: 2012-03-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -63,9 +63,9 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Bandit-clone, with support for persistent cookies
+description: Bandit-clone, more options around cookies (simple/session/sticky)
 email: 
-- brian.muller@livingsocial.com
+- m.nacos@gmail.com
 executables: []
 
 extensions: []
@@ -78,7 +78,7 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- bandit.gemspec
+- bandido.gemspec
 - lib/bandit.rb
 - lib/bandit/config.rb
 - lib/bandit/date_hour.rb