vanity 1.8.3.beta2 → 1.8.3

data/.travis.yml

@@ -3,6 +3,7 @@ bundler_args: --without development
 script: 'bundle exec rake test'
 services:
   - mongodb
+  - redis-server
 rvm:
 - 1.8.7
 - 1.9.3

data/CHANGELOG

@@ -1,3 +1,12 @@
+== 1.8.3 (2013-11-20)
+
+Add support for Rails 4. (@phillbaker)
+Update redis gem depedendencies. (@phillbaker)
+Add Bayesian multi-armed bandit scoring for experiments as an alternative to the standard A/B calculations, as well as periodic alternative rebalancing based on alternative performance (@lotze).
+Add 'complete' UI functionality to the dashboard to complete an experiment from the rails web interface (@lotze).
+Gem maintenance: license specification to gemspec, remove .rvmrc file (@phillbaker).
+Add #ab_assigned to adapters: to get an array of the experiments a specific identity is assigned to, as well as a controller action to display those assignments (@lotze).
+
 == 1.8.2 (2013-10-27)
 
 Optimize metric_values query (@zawaideh).
@@ -26,9 +35,9 @@ Allow for table names in specified :timestamps (Peter Kovacs)
 
 When a named scope includes a join, created_at can be ambiguous.  Use
 
-	metric "Sky is limit" do
-		model Sky, :timestamp => 'skies.created_at'
-	end
+  metric "Sky is limit" do
+    model Sky, :timestamp => 'skies.created_at'
+  end
 
 to disambiguate.
 
@@ -48,12 +57,12 @@ connections are deprecated in favor of using the connection option with a URI
 
 1.7.0 adds support for ActionMailer, for example:
 
-	class UserMailer < ActionMailer::Base
-		def invite_email(user)
-			use_vanity_mailer user
-			mail :to => user.email, :subject => ab_test(:invite_subject)
-		end
-	end
+  class UserMailer < ActionMailer::Base
+    def invite_email(user)
+      use_vanity_mailer user
+      mail :to => user.email, :subject => ab_test(:invite_subject)
+    end
+  end
 
 See the documentation for more details.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (1.8.3.beta2)
+    vanity (1.8.3)
       redis (>= 2.1)
       redis-namespace (>= 1.1.0)
 

data/README.rdoc

@@ -25,16 +25,12 @@ http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg
     end
   end
 
-===== Rails 3 installation
+===== Rails 3 & Rails 4 installation
 
 Add to your Gemfile:
 
   gem "vanity"
 
-===== Rails 4 installation
-
-Coming soon!
-
 ==== Step 1.2
 
 Choose a method to store experiment results: for Redis or an external tracking mechanism, migrations aren't needed. Mongo is also available. To use a relational database, via ActiveRecord, run the generator and migrations to create the database schema:
@@ -68,6 +64,8 @@ NOTE: If using a metric as above ("signups"), there needs to be a corresponding
 
 === <b>Step 4:</b> Measure conversion
 
+Conversions are created via the <code>track!</code> method. For example:
+
   class SignupController < ApplicationController
     def signup
       @account = Account.new(params[:account])
@@ -84,28 +82,51 @@ NOTE: If using a metric as above ("signups"), there needs to be a corresponding
 
   vanity report --output vanity.html
 
-Or see instructions for viewing the results using Rails.
+To view metrics and experiment results with the dashboard in Rails 3 & Rails 4:
+
+  rails generate controller Vanity
+
+In <code>config/routes.rb</code>, add:
+
+  match '/vanity(/:action(/:id(.:format)))', :controller => :vanity, :via => :get
+
+Where the controller should looks like:
+
+  class VanityController < ApplicationController
+    include Vanity::Rails::Dashboard
+  end
+
+NOTE: By default, Vanity turns collection off in development mode. To turn it on, in <code>config/environments/development.rb</code> add:
+
+  Vanity.playground.collecting = true
 
 == Registering participants with Javascript
 
 If robots or spiders make up a significant portion of your sites traffic they can affect your conversion rate.  Vanity can optionally add participants to the experiments using asynchronous javascript callbacks, which will keep almost all robots out.  To set this up simply do the following:
 
-* Add Vanity.playground.use_js!
-* Set Vanity.playground.add_participant_path = '/path/to/vanity/action', this should point to the add_participant path that is added with Vanity::Rails::Dashboard, make sure that this action is available to all users
-* Add <%= vanity_js %> to any page that needs uses an ab_test. vanity_js needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of.  The helper will render nothing if the there are no ab_tests running on the current page, so adding vanity_js to the bottom of your layouts is a good option.  Keep in mind that if you call use_js! and don't include vanity_js in your view no participants will be recorded.
+* Add <code>Vanity.playground.use_js!</code>
+* Set <code>Vanity.playground.add_participant_path = '/path/to/vanity/action'</code>, this should point to the add_participant path that is added with Vanity::Rails::Dashboard, make sure that this action is available to all users
+* Add <code><%= vanity_js %></code> to any page that needs uses an ab_test. <code>vanity_js</code> needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of. The helper will render nothing if the there are no ab_tests running on the current page, so adding <code>vanity_js</code> to the bottom of your layouts is a good option. Keep in mind that if you call <code>use_js!</code> and don't include <code>vanity_js</code> in your view no participants will be recorded.
 
-== Compatibility Matrix
+== Compatibility
 
 Here's what's tested and known to work:
 
-  Ruby 1.8.7, 1.9.3
+  Ruby 1.8.7
     Persistence: Redis, Mongo, ActiveRecord
     Rails: 2.3, 3, 3.1, 3.2
+  Ruby 1.9.3
+    Persistence: Redis, Mongo, ActiveRecord
+    Rails: 3, 3.1, 3.2, 4.0
   Ruby 2.0
     Persistence: Redis, Mongo, ActiveRecord
-    Rails: 3.2
+    Rails: 3.2, 4.0
+
+== Testing
+
+For view tests/specs or integration testing, it's handy to set the outcome of an experiment. This may be done using the <code>chooses</code> method. For example:
 
-NOTE: Support for Rails 4 is coming soon!
+  Vanity.playground.experiment(:price_options).chooses(19)
 
 == Contributing
 

data/gemfiles/rails3.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.3.beta2)
+    vanity (1.8.3)
       redis (>= 2.1)
       redis-namespace (>= 1.1.0)
 

data/gemfiles/rails31.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.3.beta2)
+    vanity (1.8.3)
       redis (>= 2.1)
       redis-namespace (>= 1.1.0)
 

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.3.beta2)
+    vanity (1.8.3)
       redis (>= 2.1)
       redis-namespace (>= 1.1.0)
 

data/gemfiles/rails4.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.3.beta2)
+    vanity (1.8.3)
       redis (>= 2.1)
       redis-namespace (>= 1.1.0)
 

data/lib/vanity/experiment/ab_test.rb

@@ -85,7 +85,7 @@ module Vanity
       end
 
       # What method to use for calculating score.  Default is :ab_test, but can
-      # also be set to :bandit_score to calculate probability of each
+      # also be set to :bayes_bandit_score to calculate probability of each
       # alternative being the best.
       #
       # @example Define A/B test which uses bayes_bandit_score in reporting

data/lib/vanity/version.rb

@@ -1,5 +1,5 @@
 module Vanity
-  VERSION = "1.8.3.beta2"
+  VERSION = "1.8.3"
 
   module Version
     version = VERSION.to_s.split(".").map { |i| i.to_i }

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vanity
 version: !ruby/object:Gem::Version
-  version: 1.8.3.beta2
-  prerelease: 6
+  version: 1.8.3
+  prerelease: 
 platform: ruby
 authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -196,7 +196,7 @@ licenses:
 post_install_message: To get started run vanity --help
 rdoc_options:
 - --title
-- Vanity 1.8.3.beta2
+- Vanity 1.8.3
 - --main
 - README.rdoc
 - --webcvs
@@ -212,9 +212,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23