field_test 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 177ccc428012c8862f9d798b6cf58629d41d54bb
-  data.tar.gz: 5b57269ef51ea55f5f10ff280d3c8aac895db01d
+  metadata.gz: f8bbd74bb28099c186bacc0ea7b195c7d89a7e35
+  data.tar.gz: e87355a520385d34192ab200b80411a4bbc70310
 SHA512:
-  metadata.gz: e014861b6912b47d5320511ebfbc0a5a8abd9470fc6a2f8b4c25f0c7d5cd07ff217836cb3d6f6bcda44a1d615fb3bf782ebdfb3161c49a292df251b581717ed4
-  data.tar.gz: d12c7f9d920bd6aa0df5c5aa15876b31c9693cca38f3fd628013ffa3f72e2323852405ea50d3fc9719509a78a8abfdaa2b4a4316e899fb37b692c7149acdfaf4
+  metadata.gz: 6f717922757f35cd62c835beb58bde3bce74fb326ca1965ddb5bbdd03811d1433fd99f1e677738b52d12f3c9158919faf832f99427d507ce5f23423b03757ccc
+  data.tar.gz: 5912035f52bfb111970e1fcf3f6bf73a9c4dbe55334e04b39a1ba9e456481ffe23f5838974989f45f560a16960b6f2a835bce2a0603c34991167fe39caa75230

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.2
+
+- Exclude bots
+- Mailer improvements
+
 ## 0.1.1
 
 - Added basic web UI

data/README.md

@@ -16,7 +16,7 @@ Add this line to your application’s Gemfile:
 gem 'field_test'
 ```
 
-And run:
+Run:
 
 ```sh
 rails g field_test:install
@@ -30,6 +30,8 @@ mount FieldTest::Engine, at: "field_test"
 
 Be sure to [secure the dashboard](#security) in production.
 
+![Screenshot](https://ankane.github.io/field_test/screenshot5.png)
+
 ## Getting Started
 
 Add an experiment to `config/field_test.yml`.
@@ -70,7 +72,7 @@ experiments:
     winner: red
 ```
 
-All calls to `field_test` will now return the winner.
+All calls to `field_test` will now return the winner, and metrics will stop being recorded.
 
 ## Features
 
@@ -80,26 +82,67 @@ You can specify a variant with query parameters to make testing easier
 http://localhost:3000/?field_test[button_color]=red
 ```
 
-For mailers, you need to specify a participant:
+Assign a specific variant to a user with:
+
+```ruby
+experiment = FieldTest::Experiment.find(:button_color)
+experiment.variant(user, variant: "red")
+```
+
+Specify a participant with:
 
 ```ruby
 field_test(:button_color, participant: "test@example.org")
 ```
 
+You can pass an object as well.
+
+```ruby
+field_test(:button_color, participant: user)
+```
+
+## Config
+
+By default, bots are returned the first variant and excluded from metrics. Change this with:
+
+```yml
+exclude:
+  bots: false
+```
+
 Keep track of when experiments started and ended.
 
 ```yml
 experiments:
-  button_colors:
+  button_color:
     started_at: 2016-12-01 14:00:00
     ended_at: 2016-12-08 14:00:00
 ```
 
+By default, variants are given the same probability of being selected. Change this with:
+
+```yml
+experiments:
+  button_color:
+    variants:
+      - red
+      - blue
+    weights:
+      - 90
+      - 10
+```
+
 ## Funnels
 
 For advanced funnels, we recommend an analytics platform like [Ahoy](https://github.com/ankane/ahoy) or [Mixpanel](https://mixpanel.com/).
 
-You can pass experiments and variants as properties.
+You can use:
+
+```ruby
+field_test_experiments
+```
+
+to get all experiments and variants for a participant, and pass them as properties.
 
 ## Security
 
@@ -108,8 +151,8 @@ You can pass experiments and variants as properties.
 Set the following variables in your environment or an initializer.
 
 ```ruby
-ENV["FIELD_TEST_USERNAME"] = "link"
-ENV["FIELD_TEST_PASSWORD"] = "hyrule"
+ENV["FIELD_TEST_USERNAME"] = "moonrise"
+ENV["FIELD_TEST_PASSWORD"] = "kingdom"
 ```
 
 #### Devise
@@ -124,10 +167,6 @@ end
 
 A huge thanks to [Evan Miller](http://www.evanmiller.org/) for deriving the Bayesian formulas.
 
-## TODO
-
-- Exclude bots
-
 ## History
 
 View the [changelog](https://github.com/ankane/field_test/blob/master/CHANGELOG.md)

data/app/views/field_test/home/_experiments.html.erb

@@ -5,7 +5,7 @@
   <table>
     <thead>
       <tr>
-        <th>Name</th>
+        <th>Variant</th>
         <th style="width: 20%;">Participants</th>
         <th style="width: 20%;">Conversions</th>
         <th style="width: 20%;">Conversion Rate</th>

data/field_test.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "railties"
   spec.add_dependency "activerecord"
   spec.add_dependency "distribution"
+  spec.add_dependency "browser", "~> 2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/field_test.rb

@@ -1,4 +1,5 @@
 require "distribution/math_extension"
+require "browser"
 require "field_test/experiment"
 require "field_test/engine"
 require "field_test/helpers"
@@ -7,14 +8,20 @@ require "field_test/version"
 
 module FieldTest
   class Error < StandardError; end
-class ExperimentNotFound < Error; end
+  class ExperimentNotFound < Error; end
+  class UnknownParticipant < Error; end
 
-def self.config
+  def self.config
     # reload in dev
     @config = nil if Rails.env.development?
 
     @config ||= YAML.load(ERB.new(File.read("config/field_test.yml")).result)
   end
+
+  def self.exclude_bots?
+    config = self.config # dev performance
+    config["exclude"] && config["exclude"]["bots"]
+  end
 end
 
 ActiveSupport.on_load(:action_controller) do

data/lib/field_test/experiment.rb

@@ -1,12 +1,13 @@
 module FieldTest
   class Experiment
-    attr_reader :id, :name, :variants, :winner, :started_at, :ended_at
+    attr_reader :id, :name, :variants, :weights, :winner, :started_at, :ended_at
 
     def initialize(attributes)
       attributes = attributes.symbolize_keys
       @id = attributes[:id]
       @name = attributes[:name] || @id.to_s.titleize
       @variants = attributes[:variants]
+      @weights = @variants.size.times.map { |i| attributes[:weights].to_a[i] || 1 }
       @winner = attributes[:winner]
       @started_at = Time.zone.parse(attributes[:started_at].to_s) if attributes[:started_at]
       @ended_at = Time.zone.parse(attributes[:ended_at].to_s) if attributes[:ended_at]
@@ -17,12 +18,13 @@ module FieldTest
       return variants.first if options[:exclude]
 
       participants = FieldTest::Participant.standardize(participants)
+      check_participants(participants)
       membership = membership_for(participants) || FieldTest::Membership.new(experiment: id)
 
       if options[:variant] && variants.include?(options[:variant])
         membership.variant = options[:variant]
       else
-        membership.variant ||= variants.sample
+        membership.variant ||= weighted_variant
       end
 
       # upgrade to preferred participant
@@ -41,6 +43,7 @@ module FieldTest
 
     def convert(participants)
       participants = FieldTest::Participant.standardize(participants)
+      check_participants(participants)
       membership = membership_for(participants)
 
       if membership
@@ -117,11 +120,26 @@ module FieldTest
 
     private
 
+      def check_participants(participants)
+        raise FieldTest::UnknownParticipant, "Use the :participant option to specify a participant" if participants.empty?
+      end
+
       def membership_for(participants)
         memberships = self.memberships.where(participant: participants).index_by(&:participant)
         participants.map { |part| memberships[part] }.compact.first
       end
 
+      def weighted_variant
+        total = weights.sum.to_f
+        pick = rand
+        n = 0
+        weights.map { |w| w / total }.each_with_index do |w, i|
+          n += w
+          return variants[i] if n >= pick
+        end
+        variants.last
+      end
+
       # formula from
       # http://www.evanmiller.org/bayesian-ab-testing.html
       def prob_b_beats_a(alpha_a, beta_a, alpha_b, beta_b)

data/lib/field_test/helpers.rb

@@ -9,6 +9,10 @@ module FieldTest
         if params[:field_test] && params[:field_test][experiment]
           options[:variant] ||= params[:field_test][experiment]
         end
+
+        if FieldTest.exclude_bots?
+          options[:exclude] = Browser.new(request.user_agent).bot?
+        end
       end
 
       # cache results for request
@@ -29,7 +33,7 @@ module FieldTest
       memberships = FieldTest::Membership.where(participant: participants).group_by(&:participant)
       experiments = {}
       participants.each do |participant|
-        memberships[participant].each do |membership|
+        memberships[participant].to_a.each do |membership|
           experiments[membership.experiment] ||= membership.variant
         end
       end
@@ -46,6 +50,7 @@ module FieldTest
           participants << current_user
         end
 
+        # controllers and views
         if try(:request)
           # use cookie
           cookie_key = "field_test"
@@ -58,6 +63,12 @@ module FieldTest
             participants << "cookie:#{token.gsub(/[^a-z0-9\-]/i, "")}"
           end
         end
+
+        # mailers
+        to = try(:message).try(:to).try(:first)
+        if to
+          participants << to
+        end
       end
 
       FieldTest::Participant.standardize(participants)

data/lib/field_test/version.rb

@@ -1,3 +1,3 @@
 module FieldTest
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/generators/field_test/templates/config.yml

@@ -5,3 +5,6 @@ experiments:
       - green
       - blue
     # winner: green
+
+exclude:
+  bots: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: field_test
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2016-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement