bandit 0.0.8 → 0.0.9

data/README.rdoc

@@ -12,7 +12,7 @@ Then, run the following:
     bundle install
     rails generate bandit:install
 
-You can then edit the bandit.yml file in your config directory to set your storage and player parameters.  Redis, memcache, and memory storage options are available.  Memory storage should only be used for testing.
+You can then edit the bandit.yml file in your config directory to set your storage and player parameters.  Redis, memcache, dalli, and memory storage options are available (you will need to add either the memcache-client, redis, or dalli gem to your Gemfile).  Memory storage should only be used for testing.
 
 See the file players.rdoc for information about available players.
 
@@ -84,6 +84,7 @@ To run tests:
     rake test_memory
     rake test_memcache
     rake test_redis
+    rake test_dalli
 
 To produce fake data for the past week, first create an experiment definition.  Then, run the following rake task:
 

data/Rakefile

@@ -26,6 +26,13 @@ Rake::TestTask.new("test_memcache") { |t|
   t.verbose = true
 }
 
+desc "Run all unit tests with dalli storage"
+Rake::TestTask.new("test_dalli") { |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/dalli_*.rb']
+  t.verbose = true
+}
+
 desc "Run all unit tests with redis storage"
 Rake::TestTask.new("test_redis") { |t|
   t.libs << "lib"

data/bandit.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency("rails", ">= 3.0.5")
-  s.add_dependency("redis", ">= 2.2.2")
+  s.add_dependency("rails", ">= 3.2.0")
+  s.requirements << "Either redis or memcache gem"
   s.add_development_dependency('rdoc')
 end

data/lib/bandit.rb

@@ -13,6 +13,7 @@ require "bandit/storage/base"
 require "bandit/storage/memory"
 require "bandit/storage/memcache"
 require "bandit/storage/redis"
+require "bandit/storage/dalli"
 
 require "bandit/extensions/controller_concerns"
 require "bandit/extensions/array"
@@ -32,7 +33,7 @@ module Bandit
     config.check!
     # intern keys in storage config
     config.storage_config = config.storage_config.inject({}) { |n,o| n[o.first.intern] = o.last; n }
-  end  
+  end
 
   def self.storage
     # try using configured storage at least once every 5 minutes until resolved
@@ -53,7 +54,7 @@ module Bandit
   end
 
   def self.get_experiment(name)
-    exp = Experiment.instances.select { |e| e.name == name } 
+    exp = Experiment.instances.select { |e| e.name == name }
     exp.length > 0 ? exp.first : nil
   end
 

data/lib/bandit/extensions/controller_concerns.rb

@@ -4,40 +4,35 @@ module Bandit
   module ControllerConcerns
     extend ActiveSupport::Concern
 
-    module ClassMethods
+    # default convert is a session based conversion
+    def bandit_convert!(exp, alt=nil, count=1)
+      bandit_session_convert!(exp, alt, count)
     end
 
-    module InstanceMethods
-      # default convert is a session based conversion
-      def bandit_convert!(exp, alt=nil, count=1)
-        bandit_session_convert!(exp, alt, count)
-      end
+    # look mum, no cookies
+    def bandit_simple_convert!(exp, alt, count=1)
+      Bandit.get_experiment(exp).convert!(alt, count)
+    end
 
-      # look mum, no cookies
-      def bandit_simple_convert!(exp, alt, count=1)
+    # 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? or cookies.signed[cookiename_converted]
         Bandit.get_experiment(exp).convert!(alt, count)
+        cookies.delete(cookiename)
       end
+    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? or cookies.signed[cookiename_converted]
-          Bandit.get_experiment(exp).convert!(alt, count)
-          cookies.delete(cookiename)
-        end
-      end
-
-      # 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]
-        unless alt.nil? or cookies.signed[cookiename_converted]
-          cookies.permanent.signed[cookiename_converted] = "true"
-          Bandit.get_experiment(exp).convert!(alt, count)
-        end
+    # 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]
+      unless alt.nil? or cookies.signed[cookiename_converted]
+        cookies.permanent.signed[cookiename_converted] = "true"
+        Bandit.get_experiment(exp).convert!(alt, count)
       end
     end
   end

data/lib/bandit/extensions/view_concerns.rb

@@ -4,43 +4,38 @@ module Bandit
   module ViewConcerns
     extend ActiveSupport::Concern
 
-    module ClassMethods
+    # default choose is a session based choice
+    def bandit_choose(exp)
+      bandit_session_choose(exp)
     end
 
-    module InstanceMethods
-      # default choose is a session based choice
-      def bandit_choose(exp)
-        bandit_session_choose(exp)
-      end
-
-      # always choose something new and increase the participant count
-      def bandit_simple_choose(exp)
-        Bandit.get_experiment(exp).choose(nil)
-      end
+    # 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 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
+    # 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
   end
 end

data/lib/bandit/storage/base.rb

@@ -17,9 +17,10 @@ module Bandit
     def self.get_storage(name, config)
       config ||= {}
 
-      case name 
+      case name
       when :memory then MemoryStorage.new(config)
       when :memcache then MemCacheStorage.new(config)
+      when :dalli then DalliStorage.new(config)
       when :redis then RedisStorage.new(config)
       else raise UnknownStorageEngineError, "#{name} not a known storage method"
       end
@@ -50,17 +51,17 @@ module Bandit
       raise NotImplementedError
     end
 
-    def incr_participants(experiment, alternative, count=1, date_hour=nil)      
+    def incr_participants(experiment, alternative, count=1, date_hour=nil)
       date_hour ||= DateHour.now
 
       # initialize first start time for alternative if we haven't inited yet
       init alt_started_key(experiment, alternative), date_hour.to_i
-      
+
       # increment total count and per hour count
       incr part_key(experiment, alternative), count
       incr part_key(experiment, alternative, date_hour), count
     end
-    
+
     def incr_conversions(experiment, alternative, count=1, date_hour=nil)
       # increment total count and per hour count
       incr conv_key(experiment, alternative), count
@@ -78,7 +79,7 @@ module Bandit
     def conversion_count(experiment, alternative, date_hour=nil)
       get conv_key(experiment, alternative, date_hour)
     end
-    
+
     def player_state_set(experiment, player, name, value)
       set player_state_key(experiment, player, name), value
     end
@@ -91,7 +92,7 @@ module Bandit
       secs = get alt_started_key(experiment, alternative), nil
       secs.nil? ? nil : Time.at(secs).to_date_hour
     end
-    
+
     # if date_hour is nil, create key for total
     # otherwise, create key for hourly based
     def part_key(exp, alt, date_hour=nil)

data/lib/bandit/storage/dalli.rb

@@ -0,0 +1,44 @@
+module Bandit
+  class DalliStorage < BaseStorage
+    def initialize(config)
+      require 'dalli'
+      config[:namespace] ||= 'bandit'
+      @dalli = Dalli::Client.new(config.fetch(:host, 'localhost:11211'), config)
+    end
+
+    # increment key by count
+    def incr(key, count=1)
+      # dalli incr is broken just like in memcache-client gem
+      with_failure_grace(count) {
+        set(key, get(key, 0) + count)
+      }
+    end
+
+    # initialize key if not set
+    def init(key, value)
+      with_failure_grace(value) {
+        @dalli.add(key, value)
+      }
+    end
+
+    # get key if exists, otherwise 0
+    def get(key, default=0)
+      with_failure_grace(default) {
+        @dalli.get(key) || default
+      }
+    end
+
+    # set key with value, regardless of whether it is set or not
+    def set(key, value)
+      with_failure_grace(value) {
+        @dalli.set(key, value)
+      }
+    end
+
+    def clear!
+      with_failure_grace(nil) {
+        @dalli.flush_all
+      }
+    end
+  end
+end

data/lib/bandit/version.rb

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

data/test/dalli_storage_test.rb

@@ -0,0 +1,17 @@
+require File.join File.dirname(__FILE__), 'helper'
+require File.join File.dirname(__FILE__), 'storage_test_base'
+
+class DalliStorageTest < Test::Unit::TestCase
+  include StorageTestBase
+  include SetupHelper
+
+  def setup
+    Bandit.setup do |config|
+      config.player = "round_robin"
+      config.storage = 'dalli'
+      config.storage_config = CONFIG['memcache_storage_config']
+    end
+
+    @storage = Bandit.storage
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bandit
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Brian Muller
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-10 00:00:00 Z
+date: 2012-05-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -25,34 +25,18 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 15
         segments: 
         - 3
+        - 2
         - 0
-        - 5
-        version: 3.0.5
+        version: 3.2.0
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redis
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 2
-        - 2
-        version: 2.2.2
-  type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,7 +46,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 description: Bandit provides a way to do multi-armed bandit optimization of alternatives in a rails website
 email: 
 - brian.muller@livingsocial.com
@@ -95,6 +79,7 @@ files:
 - lib/bandit/players/epsilon_greedy.rb
 - lib/bandit/players/round_robin.rb
 - lib/bandit/storage/base.rb
+- lib/bandit/storage/dalli.rb
 - lib/bandit/storage/memcache.rb
 - lib/bandit/storage/memory.rb
 - lib/bandit/storage/redis.rb
@@ -124,6 +109,7 @@ files:
 - lib/generators/bandit/templates/dashboard/view/show.html.erb
 - players.rdoc
 - test/config.yml
+- test/dalli_storage_test.rb
 - test/helper.rb
 - test/memcache_storage_test.rb
 - test/memory_storage_test.rb
@@ -156,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments: 
       - 0
       version: "0"
-requirements: []
-
+requirements: 
+- Either redis or memcache gem
 rubyforge_project: bandit
 rubygems_version: 1.8.17
 signing_key: 
@@ -165,6 +151,7 @@ specification_version: 3
 summary: Multi-armed bandit testing in rails
 test_files: 
 - test/config.yml
+- test/dalli_storage_test.rb
 - test/helper.rb
 - test/memcache_storage_test.rb
 - test/memory_storage_test.rb