vanity 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99e7f2261835eee5e49f1a1286c134f5329586be
-  data.tar.gz: 4de7123ddf75a32cd6228552e853db0228e29f85
+  metadata.gz: 785019e8d6f59f84073d7645a9b8a12c7c07edf0
+  data.tar.gz: 75b44173bbc79629b5c70d6bc545e3cdffb73962
 SHA512:
-  metadata.gz: 4f2d1673cb4ee38a6ef9622d1413fcf404fb47f2acfe2fb115ba4f03c15586da19e86267ce76ef1a683e3e864cbb0b079a489850f0f5442146b05a83aea45e50
-  data.tar.gz: f524dd7f7c260a4dc4c511d62aa9ae8b284525cae92afb7daf3f16fe09868e843817bf740438ceffdecbbbddefeed3a5ac884c94dff1493f78931c91f989a966
+  metadata.gz: a5b228f3a04a5f28db6a9c927b685c211340f3d6f4612e156d533683b35ede1089571c22119ff1db522259cb285948c63fba9d0c1b78ce9624f8c48b85ffb4ba
+  data.tar.gz: 1b337660bc064b51074dfd3979cfa32696b4a103d98ad1adac987e58376f613a8a384a8f58423a317a36b08ec94f39784688477053347281918f5278b19e5a52

data/.travis.yml

@@ -11,7 +11,6 @@ services:
   - mongodb
   - redis-server
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.0
@@ -22,6 +21,6 @@ env:
   - DB=active_record
 gemfile:
   - gemfiles/rails32.gemfile
-  - gemfiles/rails4.gemfile
   - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
+  - gemfiles/rails42_protected_attributes.gemfile

data/Appraisals

@@ -7,22 +7,22 @@ appraise "rails32" do
   gem "passenger", "~>3.0"
 end
 
-appraise "rails4" do
+appraise "rails41" do
   gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.0.13"
+  gem "rails", "4.1.9"
   gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
   gem "passenger", "~>3.0"
-  gem 'test-unit'
 end
 
-appraise "rails41" do
+appraise "rails42" do
   gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.1.9"
+  gem "rails", "4.2.0"
   gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
   gem "passenger", "~>3.0"
 end
 
-appraise "rails42" do
+appraise "rails42-protected_attributes" do
+  gem "protected_attributes", "1.1.0"
   gem "mocha",  "~> 1.0", :require=>false
   gem "rails", "4.2.0"
   gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20

data/CHANGELOG

@@ -1,6 +1,12 @@
-== 2.0.0 (2016-01-18)
-
-Add back deprecated connection key for vanity.yml. (@phillbaker)
+== 2.1.0 (2015-1-19)
+
+Add ability to define test alternatives with custom probabilities, #283. (@peterkovacs)
+Allow ActiveRecord model metrics to provide their own identity source, #285. (@peterkovacs)
+Add individual cookie options for name, domain, path, secure, and httponly properties of the cookie in the `Vanity.configuration`, #282. (@peterkovacs)
+Update default_request_filter to exclude more bots, #284. (@peterkovacs)
+Remove testing support for ruby 1.9.3. (@phillbaker)
+Remove testing support for rails 4.0. (@phillbaker)
+Add attr_accessible for VanityConversion model alternative attribute (@mikem836)
 
 == 2.0.0 (2015-12-14)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (2.0.1)
+    vanity (2.1.0)
       i18n
 
 GEM

data/README.md

@@ -0,0 +1,299 @@
+# Vanity
+[![Build
+Status](https://travis-ci.org/assaf/vanity.png?branch=master)](https://travis-ci.org/assaf/vanity)
+
+Vanity is an A/B testing framework for Rails that is datastore agnostic.
+
+*   All about Vanity: http://vanity.labnotes.org
+*   On Github: http://github.com/assaf/vanity
+
+[![Dashboard](doc/images/sidebar_test.png)](http://github.com/assaf/vanity)
+
+## A/B Testing With Rails
+
+### **Step 1:** Start using Vanity in your Rails application
+
+#### Step 1.1
+
+##### Rails 3 & Rails 4 installation
+
+Add to your Gemfile:
+
+    gem "vanity"
+
+(For support for older versions of Rails and Ruby 1.8, please see the [1.9.x
+branch](https://github.com/assaf/vanity/tree/1-9-stable).)
+
+#### Step 1.2
+
+Choose a datastore that best fits your needs and preferences for storing
+experiment results. Choose one of: Redis, MongoDB or an SQL database. While
+Redis is usually faster, it may add additional complexity to your stack.
+Datastores should be configured using a `config/vanity.yml`.
+
+##### Redis Setup
+
+Add to your Gemfile:
+
+    gem "redis", ">= 2.1"
+    gem "redis-namespace", ">= 1.1.0"
+
+By default Vanity is configured to use Redis on localhost port 6379 with
+database 0.
+
+A sample `config/vanity.yml` might look like:
+
+```yaml
+test:
+  collecting: false
+production:
+  adapter: redis
+  url: redis://<%= ENV["REDIS_USER"] %>:<%= ENV["REDIS_PASSWORD"] %>@<%= ENV["REDIS_HOST"] %>:<%= ENV["REDIS_PORT"] %>/0
+```
+
+If you want to use your test environment with RSpec you will need to add an
+adapter to test:
+
+```yaml
+test:
+  adapter: redis
+  collecting: false
+```
+
+##### MongoDB Setup
+
+Add to your Gemfile:
+
+```ruby
+gem "bson_ext"
+gem "mongo"
+```
+
+A sample `config/vanity.yml` might look like:
+
+```yaml
+development:
+  adapter: mongodb
+  database: analytics
+test:
+  collecting: false
+production:
+  adapter: mongodb
+  database: analytics
+```
+
+##### SQL Database Setup
+
+Vanity supports multiple SQL stores (like MySQL, MariaDB, Postgres, Sqlite,
+etc.) using ActiveRecord, which is built into Rails. If you're using
+DataMapper, Sequel or another persistence framework, add to your Gemfile:
+
+```ruby
+    gem "active_record"
+```
+
+A sample `config/vanity.yml` might look like:
+
+```yaml
+development:
+  adapter: active_record
+  active_record_adapter: sqlite3
+  database: db/development.sqlite3
+test:
+  collecting: false
+production:
+  adapter: active_record
+  active_record_adapter: default
+```
+
+If you're going to store data in the database, run the generator and
+migrations to create the database schema:
+
+```sh
+$ rails generate vanity
+$ rake db:migrate
+```
+
+#### Step 1.3
+
+Turn Vanity on, and pass a reference to a method that identifies a user. For
+example:
+
+```ruby
+class ApplicationController < ActionController::Base
+  use_vanity :current_user
+end
+```
+
+For more information, please see the [identity
+documentation](http://vanity.labnotes.org/identity.html).
+
+### **Step 2:** Define your first A/B test
+
+This experiment goes in the file `experiments/price_options.rb`:
+
+```ruby
+ab_test "Price options" do
+  description "Mirror, mirror on the wall, who's the better price of all?"
+  alternatives 19, 25, 29
+  metrics :signups
+end
+```
+
+If the experiment uses a metric as above ("signups"), there needs to be a
+corresponding ruby file for that metric, `experiments/metrics/signups.rb`.
+
+```ruby
+metric "Signup (Activation)" do
+  description "Measures how many people signed up for our awesome service."
+end
+```
+
+### **Step 3:** Present the different options to your users
+
+```erb
+<h2>Get started for only $<%= ab_test :price_options %> a month!</h2>
+```
+
+### **Step 4:** Measure conversion
+
+Conversions are created via the `Vanity.track!` method. For example:
+
+```ruby
+class SignupController < ApplicationController
+  def signup
+    @account = Account.new(params[:account])
+    if @account.save
+      Vanity.track!(:signups)
+      redirect_to @acccount
+    else
+      render action: :offer
+    end
+  end
+end
+```
+
+### **Step 5:** Check the report:
+
+```sh
+vanity report --output vanity.html
+```
+
+To view metrics and experiment results with the dashboard in Rails 3 & Rails
+4:
+
+```sh
+rails generate controller Vanity --helper=false
+```
+
+In `config/routes.rb`, add:
+
+```ruby
+get '/vanity' =>'vanity#index'
+get '/vanity/participant/:id' => 'vanity#participant'
+post '/vanity/complete'
+post '/vanity/chooses'
+post '/vanity/reset'
+post '/vanity/enable'
+post '/vanity/disable'
+post '/vanity/add_participant'
+get '/vanity/image'
+```
+
+The controller should look like:
+
+```ruby
+class VanityController < ApplicationController
+  include Vanity::Rails::Dashboard
+  layout false  # exclude this if you want to use your application layout
+end
+```
+
+## 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 many
+robots out. For those robots that do execute Javascript and are well-behaved
+(like Googlebot), Vanity filters out requests based on their user-agent
+string.
+
+In Rails, add the following to `application.rb`:
+
+```ruby
+Vanity.configure do |config|
+  config.use_js = true
+
+  # Optionally configure the add_participant route that is added with Vanity::Rails::Dashboard,
+  # make sure that this action does not require authentication
+  # config.add_participant_route = '/vanity/add_participant'
+end
+```
+
+Then add `<%= vanity_js %>` to any page that calls an A/B test **after calling
+`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 set `use_js` and don't include `vanity_js` in
+your view no participants will be recorded.
+
+## Compatibility
+
+Here's what's tested and known to work:
+
+    Ruby 2.0
+      Persistence: Redis, Mongo, ActiveRecord
+      Rails: 3.2, 4.1, 4.2
+    Ruby 2.1
+      Persistence: Redis, Mongo, ActiveRecord
+      Rails: 3.2, 4.1, 4.2
+    Ruby 2.2
+      Persistence: Redis, Mongo, ActiveRecord
+      Rails: 3.2, 4.1, 4.2
+
+## Testing
+
+For view tests/specs or integration testing, it's handy to set the outcome of
+an experiment. This may be done using the `chooses` method. For example:
+
+```ruby
+Vanity.playground.experiment(:price_options).chooses(19)
+
+## Updating documentation
+
+Documenation is written in the textile format in the [docs](docs/) directory,
+and is hosted on Github Pages. To update the docs commit changes to the master
+branch in this repository, then:
+
+```sh
+bundle exec rake docs # output HTML files into html/
+git checkout gh-pages
+mv html/* . # Move generated html to the top of the repo
+git commit # Add, commit and push any changes!
+```
+
+Go ahead and target a pull request against the `gh-pages` branch.
+
+## Contributing
+
+*   Fork the project
+*   Please use a feature branch to make your changes, it's easier to test them
+    that way
+*   To set up the test suite run `bundle`, then run `appraisal install` to
+    prepare the test suite to run against multiple versions of Rails
+*   Fix, patch, enhance, document, improve, sprinkle pixie dust
+*   Tests. Please. Run `appraisal rake test`, of if you can, `rake test:all`.
+    (This project uses Travis CI where the test suite is run against multiple
+    versions of ruby, rails and backends.)
+*   Send a pull request on GitHub
+
+
+## Credits/License
+
+Original code, copyright of Assaf Arkin, released under the MIT license.
+
+Documentation available under the Creative Commons Attribution license.
+
+For full list of credits and licenses:
+http://vanity.labnotes.org/credits.html.

data/doc/configuring.textile

@@ -44,6 +44,13 @@ Available configuration options are:
 | request_filter             | A proc that returns whether to to ignore the request for the add JS participant route | Ignore requests with a HTTP_USER_AGENT that contain a URL |
 | templates_path             | Path to templates for Vanity admin | the templates in the gem |
 | use_js                     | Whether to use JS to add particpants, useful to ignore bots | false |
+| experiments_start_enabled  | Whether new experiments start in the enabled or disabled state | true |
+| cookie_name                | The name of the anonymous tracking cookie | @vanity_id@ |
+| cookie_expires             | The duration of the cookie                | 20 years |
+| cookie_domain              | The domain for the cookie. Rails.application.config.session_options[:domain] will be substituted if @nil@. | @nil@ |
+| cookie_path                | The path of the cookie | @nil@ |
+| cookie_secure              | The secure (ssl-only) parameter of the cookie. | @false@ |
+| cookie_httponly            | The httponly parameter of the cookie | @false@ |
 
 When "running under Rails":rails.html, Vanity defaults to using the Rails logger, locates the load_path relative to Rails root, uses the @config/vanity.yml@ configuration file (if present) and turns collection on only in production mode.
 
@@ -68,4 +75,4 @@ config.after_initialize do
   require "garb"
   Garb::Session.login('..ga email..', '..ga pwd..', account_type: "GOOGLE")
 end
-</pre>
+</pre>

data/doc/identity.textile

@@ -31,6 +31,8 @@ end
 
 If you use either block or method name and they return @nil@, Vanity will fallback on persistent cookie mechanism.
 
+Note that @current_user@ in this case must return @nil@ for non-persisted accounts.  That is, @current_user.id@ *must* be non-@nil@.
+
 An identity can be anything.  For example, if you're running an experiment to test a new feature that will be available in some projects but not others, you'll want to slice the audience by project identifier, not user ID.
 
 You can also give each experiment a different identity using the @identify@ callback.  Here's an example that tells one experiment to use a project identifier:

data/doc/metrics.textile

@@ -133,6 +133,16 @@ metric "Signups (Unlimited)" do
 end
 </pre>
 
+The @model@ specifier can also take an @:identity@ option.  @:identity:@ should be a @Proc@ that specifies how to fetch the identity of the experiment participant.  This is useful when constructing objects outside the ActionController context (perhaps in a background task).  However, note that your experiment participants may still be identified by their anonymous cookie identifier, if you started any experiments before the user was identifiable.
+
+This example will record conversions for the Account to which the Subscription belongs:
+
+<pre>
+metric "Subscriptions finished on backend" do
+  description "These signups were actually created in a background task."
+  model Subscription, :identity => lambda { |record| record.account_id }
+end
+</pre>
 
 h3(#ga).  Google Analytics
 

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.1)
+    vanity (2.1.0)
       i18n
 
 GEM

data/gemfiles/rails41.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .././
   specs:
-    vanity (2.0.1)
+    vanity (2.1.0)
       i18n
 
 GEM

data/gemfiles/rails42.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.1)
+    vanity (2.1.0)
       i18n
 
 GEM

data/gemfiles/{rails4.gemfile → rails42_protected_attributes.gemfile}

@@ -12,11 +12,11 @@ gem "garb", "< 0.9.2", :require => false
 gem "timecop", :require => false
 gem "webmock", :require => false
 gem "fakefs", :require => "fakefs/safe"
+gem "protected_attributes", "1.1.0"
 gem "mocha", "~> 1.0", :require => false
-gem "rails", "4.0.13"
+gem "rails", "4.2.0"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"
-gem "test-unit"
 
 group :development do
   gem "appraisal", "~> 1.0.2"

data/gemfiles/rails42_protected_attributes.gemfile.lock

@@ -0,0 +1,209 @@
+GIT
+  remote: git://github.com/zoltankiss/fastthread.git
+  revision: cefbca3009b9c68df5e473d840462ebcc7fa1504
+  specs:
+    fastthread (1.0.7)
+
+PATH
+  remote: ../
+  specs:
+    vanity (2.1.0)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    appraisal (1.0.3)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.3)
+    bson (1.12.5)
+    bson_ext (1.12.5)
+      bson (~> 1.12.5)
+    builder (3.2.2)
+    colorator (0.1)
+    concurrent-ruby (1.0.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    daemon_controller (1.2.0)
+    erubis (2.7.0)
+    fakefs (0.6.7)
+    ffi (1.9.10)
+    garb (0.9.1)
+      activesupport (>= 2.2.0)
+      crack (>= 0.1.6)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    hashdiff (0.2.3)
+    i18n (0.7.0)
+    integration (0.1.0)
+    jekyll (3.0.1)
+      colorator (~> 0.1)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.4.0)
+      sass (~> 3.4)
+    jekyll-watch (1.3.0)
+      listen (~> 3.0)
+    json (1.8.3)
+    kramdown (1.9.0)
+    liquid (3.0.6)
+    listen (3.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mercenary (0.3.5)
+    metaclass (0.0.4)
+    mime-types (2.99)
+    mini_portile2 (2.0.0)
+    minitest (5.8.3)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    mongo (1.12.5)
+      bson (= 1.12.5)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
+    passenger (3.0.21)
+      daemon_controller (>= 1.0.0)
+      fastthread (>= 1.0.1)
+      rack
+      rake (>= 0.8.1)
+    protected_attributes (1.1.0)
+      activemodel (>= 4.0.1, < 5.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redis (3.2.2)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    rouge (1.10.1)
+    rubystats (0.2.3)
+    safe_yaml (1.0.4)
+    sass (3.4.20)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    timecop (0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.22.5)
+      addressable (< 2.4.0)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord-jdbc-adapter
+  appraisal (~> 1.0.2)
+  bson_ext
+  bundler (>= 1.0.0)
+  fakefs
+  fastthread!
+  garb (< 0.9.2)
+  integration (<= 0.1.0)
+  jdbc-sqlite3
+  jekyll
+  minitest (>= 4.2)
+  mocha (~> 1.0)
+  mongo
+  passenger (~> 3.0)
+  protected_attributes (= 1.1.0)
+  rack
+  rails (= 4.2.0)
+  rake
+  redis (>= 2.1)
+  redis-namespace (>= 1.1.0)
+  rubystats
+  sqlite3 (~> 1.3.10)
+  timecop
+  vanity!
+  webmock
+  yard
+
+BUNDLED WITH
+   1.11.2

data/lib/generators/templates/vanity_migration.rb

@@ -17,6 +17,7 @@ class VanityMigration < ActiveRecord::Migration
     create_table :vanity_experiments do |t|
       t.string :experiment_id
       t.integer :outcome
+      t.boolean :enabled
       t.datetime :created_at
       t.datetime :completed_at
     end