field_test 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5303485194bd6850672facf548ba671a2e661e242edfc4a4e3ad90beeed7485d
-  data.tar.gz: c694d25c71464323daf17e7cd9844d8aa8f51eb3d65e0f788e92e0f5998f18b5
+  metadata.gz: 5935d4b9a0cca9bd7d08fb1e0acaf5ab6e0e7f8c8c44b71efae5a3667a0d37a6
+  data.tar.gz: e839006d04adfe1e06d27c2b32b8ea601ada47106b05537bf6a11168c8b0864a
 SHA512:
-  metadata.gz: df92ba63ed13eaec202546d497b2408288b9b4c8901e3a8a25fff96fbb098fa4c3f6acbb9edcd713f94b4ff95540c9542a3c026b4842ca519b76b7f31df2888b
-  data.tar.gz: b9407161a151713987f2db017200ad673cff0eba08f5c114d5787bb322dc4eb87f431fac708b90b42653bed90d34a71a595763cbd32cb107a2a631bcfb7f198c
+  metadata.gz: 0ab03821f1b5a95f8cf2681820ab4d13c10bde98889e2d5995cd05f7426f815d207bfcdd894db0da90acb1e1743adf6f7256c75d5f62572e27f7183a0992a722
+  data.tar.gz: 84009fba31741d3c737f0623b580512bed5dadd455c35691fbe0388899dcf706a8d5ed1740f3d94cb877058e19740aa5321a5b51ef7595c31cea483b85dfd1bc

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.3.1 [unreleased]
+
+- Added `closed` and `keep_variant`
+- Added `field_test_upgrade_memberships` method
+- Fixed API controller error
+- Fixed bug where conversions were recorded after winner
+
+Security
+
+- Fixed arbitrary variants via query parameters - see [#17](https://github.com/ankane/field_test/issues/17)
+
 ## 0.3.0
 
 - Added support for native apps

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Andrew Kane
+Copyright (c) 2016-2019 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,6 +4,7 @@
 
 - Designed for web and email
 - Comes with a [dashboard](https://fieldtest.dokkuapp.com/) to view results and update variants
+- Uses your database for storage
 - Seamlessly handles the transition from anonymous visitor to logged in user
 
 Uses [Bayesian statistics](https://www.evanmiller.org/bayesian-ab-testing.html) to evaluate results so you don’t need to choose a sample size ahead of time.
@@ -76,6 +77,25 @@ experiments:
 
 All calls to `field_test` will now return the winner, and metrics will stop being recorded.
 
+You can keep returning the variant for existing participants after a winner is declared:
+
+```yml
+experiments:
+  button_color:
+    winner: green
+    keep_variant: true
+```
+
+You can also close an experiment to new participants without declaring a winner while still recording metrics for existing participants:
+
+```yml
+experiments:
+  button_color:
+    closed: true
+```
+
+Calls to `field_test` for new participants will return the control, and they won’t be added to the experiment.
+
 You can get the list of experiments and variants for a user with:
 
 ```ruby

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

@@ -1,6 +1,7 @@
 <% experiments.each do |experiment| %>
   <h2>
     <%= experiment.name %>
+    <% if experiment.active? && experiment.closed? %><small class="closed">Closed</small><% end %>
     <small><%= link_to "Details", experiment_path(experiment.id) %></small>
   </h2>
 

data/app/views/layouts/field_test/application.html.erb

@@ -66,6 +66,10 @@
         color: #5cb85c;
       }
 
+      .closed {
+        color: orange;
+      }
+
       .pagination {
         text-align: center;
       }

data/lib/field_test/controller.rb

@@ -11,6 +11,20 @@ module FieldTest
       end
     end
 
+    def field_test_upgrade_memberships(options = {})
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
+      preferred = participants.first
+      Array(participants[1..-1]).each do |participant|
+        # can do this in single query once legacy_participants is removed
+        FieldTest::Membership.where(participant.where_values).each do |membership|
+          membership.participant = preferred.participant if membership.respond_to?(:participant=)
+          membership.participant_type = preferred.type if membership.respond_to?(:participant_type=)
+          membership.participant_id = preferred.id if membership.respond_to?(:participant_id=)
+          membership.save!
+        end
+      end
+    end
+
     private
 
     def field_test_participant
@@ -23,22 +37,27 @@ module FieldTest
 
       cookie_key = "field_test"
 
+      # name not entirely accurate
+      # can still set cookies in ActionController::API through request.cookie_jar
+      # however, best to prompt developer to pass participant manually
+      cookies_supported = respond_to?(:cookies, true)
+
       if request.headers["Field-Test-Visitor"]
         token = request.headers["Field-Test-Visitor"]
-      elsif FieldTest.cookies
+      elsif FieldTest.cookies && cookies_supported
         token = cookies[cookie_key]
 
         if participants.empty? && !token
           token = SecureRandom.uuid
           cookies[cookie_key] = {value: token, expires: 30.days.from_now}
         end
-      else
+      elsif !FieldTest.cookies
         # anonymity set
         # note: hashing does not conceal input
         token = Digest::UUID.uuid_v5(FieldTest::UUID_NAMESPACE, ["visitor", FieldTest.mask_ip(request.remote_ip), request.user_agent].join("/"))
 
         # delete cookie if present
-        cookies.delete(cookie_key) if cookies[cookie_key]
+        cookies.delete(cookie_key) if cookies_supported && cookies[cookie_key]
       end
 
       # sanitize tokens

data/lib/field_test/experiment.rb

@@ -10,6 +10,8 @@ module FieldTest
       @variants = attributes[:variants]
       @weights = @variants.size.times.map { |i| attributes[:weights].to_a[i] || 1 }
       @winner = attributes[:winner]
+      @closed = attributes[:closed]
+      @keep_variant = attributes[:keep_variant]
       @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]
       @goals = attributes[:goals] || ["conversion"]
@@ -18,17 +20,21 @@ module FieldTest
     end
 
     def variant(participants, options = {})
-      return winner if winner
-      return variants.first if options[:exclude]
+      return winner if winner && !keep_variant?
+      return control if options[:exclude]
 
       participants = FieldTest::Participant.standardize(participants)
       check_participants(participants)
       membership = membership_for(participants) || FieldTest::Membership.new(experiment: id)
 
+      if winner # and keep_variant?
+        return membership.variant || winner
+      end
+
       if options[:variant] && variants.include?(options[:variant])
         membership.variant = options[:variant]
       else
-        membership.variant ||= weighted_variant
+        membership.variant ||= closed? ? control : weighted_variant
       end
 
       participant = participants.first
@@ -38,7 +44,7 @@ module FieldTest
       membership.participant_type = participant.type if membership.respond_to?(:participant_type=)
       membership.participant_id = participant.id if membership.respond_to?(:participant_id=)
 
-      if membership.changed?
+      if membership.changed? && (!closed? || membership.persisted?)
         begin
           membership.save!
         rescue ActiveRecord::RecordNotUnique
@@ -46,10 +52,12 @@ module FieldTest
         end
       end
 
-      membership.try(:variant) || variants.first
+      membership.try(:variant) || control
     end
 
     def convert(participants, goal: nil)
+      return false if winner
+
       goal ||= goals.first
 
       participants = FieldTest::Participant.standardize(participants)
@@ -174,6 +182,18 @@ module FieldTest
       !winner
     end
 
+    def closed?
+      @closed
+    end
+
+    def keep_variant?
+      @keep_variant
+    end
+
+    def control
+      variants.first
+    end
+
     def use_events?
       if @use_events.nil?
         FieldTest.events_supported?

data/lib/field_test/helpers.rb

@@ -1,12 +1,14 @@
 module FieldTest
   module Helpers
-    def field_test(experiment, options = {})
+    def field_test(experiment, **options)
       exp = FieldTest::Experiment.find(experiment)
 
-      participants = FieldTest::Participant.standardize(field_test_participant, options)
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
 
       if try(:request)
-        if !options[:variant] && params[:field_test] && params[:field_test][experiment]
+        options = options.dup
+
+        if !options[:variant] && params[:field_test] && params[:field_test][experiment] && exp.variants.include?(params[:field_test][experiment])
           params_variant = params[:field_test][experiment]
         end
 
@@ -25,17 +27,17 @@ module FieldTest
       @field_test_cache[experiment] ||= params_variant || exp.variant(participants, options)
     end
 
-    def field_test_converted(experiment, options = {})
+    def field_test_converted(experiment, **options)
       exp = FieldTest::Experiment.find(experiment)
 
-      participants = FieldTest::Participant.standardize(field_test_participant, options)
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
 
       exp.convert(participants, goal: options[:goal])
     end
 
     # TODO fetch in single query
-    def field_test_experiments(options = {})
-      participants = FieldTest::Participant.standardize(field_test_participant, options)
+    def field_test_experiments(**options)
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
       experiments = {}
       participants.each do |participant|
         FieldTest::Membership.where(participant.where_values).each do |membership|

data/lib/field_test/participant.rb

@@ -31,8 +31,8 @@ module FieldTest
       end
     end
 
-    def self.standardize(participants, options = {})
-      Array(options[:participant] || participants).compact.map { |v| FieldTest::Participant.new(v) }
+    def self.standardize(participant)
+      Array(participant).compact.map { |v| FieldTest::Participant.new(v) }
     end
   end
 end

data/lib/field_test/version.rb

@@ -1,3 +1,3 @@
 module FieldTest
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/generators/field_test/events_generator.rb

@@ -1,23 +1,10 @@
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module FieldTest
   module Generators
     class EventsGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ::ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "events.rb", "db/migrate/create_field_test_events.rb", migration_version: migration_version

data/lib/generators/field_test/install_generator.rb

@@ -1,23 +1,10 @@
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module FieldTest
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ::ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "memberships.rb", "db/migrate/create_field_test_memberships.rb", migration_version: migration_version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: field_test
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-02 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A/B testing for Rails