test_track_rails_client 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 907a4c144a91bae9ff7be92b2275ed72760731e1
-  data.tar.gz: e19a1990632c47427b20d3bab81d5b71a1046488
+  metadata.gz: 6eefba329c2d3bcbf7e2ec64800ac65ae8d5b389
+  data.tar.gz: 9227d7cca55324a963b399c65d48088d917b143e
 SHA512:
-  metadata.gz: 07ffbb3a5ee2fd8d8bcdf89a1d4268f34cdfe45b530e42b32186be058588eaa3946574274fc5c4887c6b861fa8f13b0290c8c253567347f0bbe68185603994fb
-  data.tar.gz: 7742bbea0b0b764185a15440d5d8c32b3731e2d7f06db9b9350f5aa50b75b17f2aca7fe56e66b6a728577c4d7cfb23379c0bba65ada2dd81de856a870244111c
+  metadata.gz: 9496d2f71697004936ed0896e6805d32723b067ea93c6915ec07ac75b81371e1ddd2b0b697961f7ba188a22f77d45abe912e7b306355c34d449af4ef16bfd9bb
+  data.tar.gz: 4981fc0c2992de2469ff3d82b45a8a24af5d1dcef4ae70aa0dd615e77c4519c0210eba62f5b39b5239b8d5383dc53c49b41e2f3c9710bd4c374f4b4dc042c329

data/README.md

@@ -15,7 +15,7 @@ If you're looking to do client-side assignment, then check out our [JS client](h
 * [Tracking visitor logins](#tracking-visitor-logins)
 * [Tracking signups](#tracking-signups)
 * [Testing splits](#testing-splits)
-* [Custom Analytics](#custom-analytics)
+* [Analytics](#analytics)
 * [Upgrading](#upgrading)
 * [How to Contribute](#how-to-contribute)
 
@@ -335,8 +335,9 @@ it "shows the right info" do
 end
 ```
 
-## Custom Analytics
-By default, TestTrack will use Mixpanel as an analytics backend. If you wish to use another provider, you can set the `analytics` attribute on `TestTrack` with your custom client. You should do this in a Rails initializer.
+## Analytics
+
+TestTrack does not offer built-in functionality for analyzing the results of split tests. TestTrack does provide hooks to easily integrate with your preferred analytics tool. By default, TestTrack will use Mixpanel as an analytics backend. If you wish to use another tool, you can set the `analytics` attribute on `TestTrack` with your custom client. You should do this in a Rails initializer.
 
 ```ruby
 # config/initializers/test_track.rb
@@ -350,18 +351,72 @@ Your client must implement the following methods:
 #
 # @param visitor_id [String] TestTrack's unique visitor identification key
 # @param assignment [TestTrack::Assignment] The assignment model itself
-# @param properties [String] Any additional properties, currently only utilized for Mixpanel's UniqueId
-def track_assignment(visitor_id, assignment, properties)
+def track_assignment(visitor_id, assignment)
 
 # Called after TestTrack.sign_up!
 #
 # @param visitor_id [String] TestTrack's unique visitor identification key
-# @param existing_id [String] Any existing identifier for the visitor(defaults to Mixpanel's UniqueId)
-def alias(visitor_id, existing_id)
+def sign_up!(visitor_id)
+```
+
+### Using TestTrack with a new analytics tool
+
+TestTrack manages its own visitor identifier which is different from the identifier of your analytics tool. We recommend using TestTrack's visitor identifier as your analytics identifier when possible. Within TestTrack Rails Client, assignment events will trigger a call to `TestTrack.analytics.track_assignment` with a TestTrack visitor identifier. To ensure that analytics events coming from within the browser have the right identifier, you must set the identifier when your analytics javascript library is loaded.
+
+Here's an example for how to do it with Mixpanel:
+
+```javascript
+mixpanel.init('YOUR MIXPANEL TOKEN', {
+    loaded: function(mixpanel) {
+        mixpanel.identify('<%= test_track_visitor.id %>');
+    }
+});
+```
+
+### Using TestTrack with an existing analytics tool
+
+In cases where you have already established identities with your analytics tool, you can use TestTrack's hooks to link TestTrack's visitor identifier to your analytics identifier.
+
+Using Mixpanel as an example, you must call [`mixpanel.alias`](https://mixpanel.com/help/questions/articles/assigning-your-own-unique-ids-to-users) with the visitor's analytics identifier and their TestTrack visitor identifier. This will establish a link between those two identifiers within your analytics tool, allowing you to analyze your funnels. We recommend using a thread-local storage like [`RequestStore`](https://github.com/steveklabnik/request_store) to make your identifier available to the TestTrack analytics client.
+
+In your controller, store the Mixpanel distinct ID in the RequestStore.
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :store_mixpanel_distinct_id
+
+  def store_mixpanel_distinct_id
+    RequestStore[:mixpanel_distinct_id] = cookies["mp_#{ENV['MIXPANEL_TOKEN']}_mixpanel"]
+  end
+end
+```
+
+Then in your custom analytics plugin, use that value for assignment events and aliasing.
+
+```ruby
+def track_assignment!(visitor_id)
+  identifier = RequestStore[:mixpanel_distinct_id] || visitor_id
+  properties = {
+    SplitName: assignment.split_name,
+    SplitVariant: assignment.variant,
+    SplitContext: assignment.context
+  }
+
+  mixpanel.track(identifier, 'SplitAssigned', properties)
+end
+
+def sign_up!(visitor_id)
+  mixpanel.alias(visitor_id, RequestStore[:mixpanel_distinct_id])
+end
 ```
 
 ## Upgrading
 
+### From 2.0 to 3.0
+
+TestTrack Rails Client no longer manages your Mixpanel cookie. The analytics plugin now provides a callback on `sign_up!` that will allow you to implement this functionality within your application. Please see the [analytics documentation](#analytics) for more details.
+The TestTrack.analytics client `#track_assignment` method no longer accepts a properties hash as an argument as `mixpanel_distinct_id` is no longer relevant.
+
 ### From 1.x to 1.3
 
 `TestTrack::Session#log_in!` and `TestTrack:Session#sign_up!` now take a `TestTrack::Identity` instance argument instead of an identity type and identity value.

data/Rakefile

@@ -36,30 +36,34 @@ task :vendor_deps do
   FileUtils.module_eval do
     cd "vendor/gems" do
       rm_r Dir.glob('*')
-      %w(ruby_spec_helpers her fakeable_her publicsuffix-ruby).each do |repo|
+      %w(her fakeable_her).each do |repo|
         `git clone --depth=1 git@github.com:Betterment/#{repo}.git && rm -rf #{repo}/.git`
       end
     end
 
-    cd "vendor/gems/ruby_spec_helpers" do
+    cd "vendor/gems/her" do
       rm_r(Dir.glob('.*') - %w(. ..))
       rm_r Dir.glob('*.md')
       rm_r %w(
+        Appraisals
         Gemfile
         Gemfile.lock
+        Rakefile
+        gemfiles
         spec
       ), force: true
-      `sed -E -i '' '/license/d' ruby_spec_helpers.gemspec`
     end
 
     cd "vendor/gems/fakeable_her" do
       rm_r(Dir.glob('.*') - %w(. ..))
       rm_r Dir.glob('*.md')
       rm_r %w(
+        Appraisals
         Gemfile
         Gemfile.lock
         Rakefile
         bin
+        gemfiles
         spec
       ), force: true
       `sed -E -i '' '/license/d' fakeable_her.gemspec`
@@ -70,7 +74,7 @@ end
 
 task(:default).clear
 if ENV['APPRAISAL_INITIALIZED'] || ENV['TRAVIS']
-  task default: [:rubocop, :spec]
+  task default: %i(rubocop spec)
 else
   require 'appraisal'
   Appraisal::Task.new

data/app/models/test_track/analytics/mixpanel_client.rb

@@ -1,10 +1,7 @@
 module TestTrack::Analytics
   class MixpanelClient
-    delegate :alias, to: :mixpanel
-
-    def track_assignment(visitor_id, assignment, params = {})
-      distinct_id = params.delete(:mixpanel_distinct_id) || visitor_id
-      mixpanel.track(distinct_id, 'SplitAssigned', split_properties(assignment).merge(TTVisitorID: visitor_id))
+    def track_assignment(visitor_id, assignment)
+      mixpanel.track(visitor_id, 'SplitAssigned', split_properties(assignment).merge(TTVisitorID: visitor_id))
     end
 
     private

data/app/models/test_track/analytics/safe_wrapper.rb

@@ -12,12 +12,12 @@ module TestTrack::Analytics
       @error_handler = handler
     end
 
-    def track_assignment(visitor_id, assignment, params = {})
-      safe_action { underlying.track_assignment(visitor_id, assignment, params) }
+    def track_assignment(visitor_id, assignment)
+      safe_action { underlying.track_assignment(visitor_id, assignment) }
     end
 
-    def alias(visitor_id, existing_id)
-      safe_action { underlying.alias(visitor_id, existing_id) }
+    def sign_up!(visitor_id)
+      safe_action { underlying.sign_up!(visitor_id) } if underlying.respond_to?(:sign_up!)
     end
 
     private

data/app/models/test_track/config_updater.rb

@@ -1,5 +1,5 @@
 class TestTrack::ConfigUpdater
-  def initialize(schema_file_path = "#{Rails.root}/db/test_track_schema.yml")
+  def initialize(schema_file_path = Rails.root.join('db', 'test_track_schema.yml'))
     @schema_file_path = schema_file_path
   end
 
@@ -86,7 +86,7 @@ class TestTrack::ConfigUpdater
   end
 
   def schema_file_hash
-    @schema_hash ||= YAML.load(schema_file_contents) || {}
+    @schema_hash ||= YAML.safe_load(schema_file_contents) || {}
   end
 
   def schema_file_contents

data/app/models/test_track/fake/split_registry.rb

@@ -39,7 +39,7 @@ class TestTrack::Fake::SplitRegistry
   end
 
   def test_track_schema_yml_path
-    ENV["TEST_TRACK_SCHEMA_FILE_PATH"] || "#{Rails.root}/db/test_track_schema.yml"
+    ENV["TEST_TRACK_SCHEMA_FILE_PATH"] || Rails.root.join('db', 'test_track_schema.yml')
   end
 
   def splits_with_deterministic_weights
@@ -47,7 +47,7 @@ class TestTrack::Fake::SplitRegistry
       default_variant = weighting_registry.keys.sort.first
 
       adjusted_weights = { default_variant => 100 }
-      weighting_registry.except(default_variant).keys.each do |variant|
+      weighting_registry.except(default_variant).each_key do |variant|
         adjusted_weights[variant] = 0
       end
 

data/app/models/test_track/notify_assignment_job.rb

@@ -1,13 +1,12 @@
 class TestTrack::NotifyAssignmentJob
-  attr_reader :mixpanel_distinct_id, :visitor_id, :assignment
+  attr_reader :visitor_id, :assignment
 
   def initialize(opts)
     @visitor_id = opts.delete(:visitor_id)
-    @mixpanel_distinct_id = opts.delete(:mixpanel_distinct_id)
     @assignment = opts.delete(:assignment)
 
     %w(visitor_id assignment).each do |param_name|
-      raise "#{param_name} must be present" unless send(param_name).present?
+      raise "#{param_name} must be present" if send(param_name).blank?
     end
     raise "unknown opts: #{opts.keys.to_sentence}" if opts.present?
   end
@@ -25,7 +24,7 @@ class TestTrack::NotifyAssignmentJob
 
   def track
     return "failure" unless TestTrack.enabled?
-    result = TestTrack.analytics.track_assignment(visitor_id, assignment, mixpanel_distinct_id: mixpanel_distinct_id)
+    result = TestTrack.analytics.track_assignment(visitor_id, assignment)
     result ? "success" : "failure"
   end
 end

data/app/models/test_track/offline_session.rb

@@ -45,9 +45,11 @@ class TestTrack::OfflineSession
   end
 
   def notify_unsynced_assignments!
-    TestTrack::UnsyncedAssignmentsNotifier.new(
-      visitor_id: visitor.id,
-      assignments: visitor.unsynced_assignments
-    ).notify if unsynced_assignments?
+    if unsynced_assignments?
+      TestTrack::UnsyncedAssignmentsNotifier.new(
+        visitor_id: visitor.id,
+        assignments: visitor.unsynced_assignments
+      ).notify
+    end
   end
 end

data/app/models/test_track/remote/split_registry.rb

@@ -26,9 +26,9 @@ class TestTrack::Remote::SplitRegistry
     if faked?
       instance.attributes.freeze
     else
-      Rails.cache.fetch(CACHE_KEY, expires_in: 5.seconds) do
+      Rails.cache.fetch(CACHE_KEY, expires_in: 5.seconds) {
         instance.attributes
-      end.freeze
+      }.freeze
     end
   rescue *TestTrack::SERVER_ERRORS => e
     Rails.logger.error "TestTrack failed to load split registry. #{e}"

data/app/models/test_track/remote/visitor.rb

@@ -6,8 +6,8 @@ class TestTrack::Remote::Visitor
   has_many :assignments
 
   def self.from_identifier(identifier_type, identifier_value)
-    raise "must provide an identifier_type" unless identifier_type.present?
-    raise "must provide an identifier_value" unless identifier_value.present?
+    raise "must provide an identifier_type" if identifier_type.blank?
+    raise "must provide an identifier_value" if identifier_value.blank?
 
     # TODO: FakeableHer needs to make this faking a feature of `get`
     if faked?

data/app/models/test_track/session.rb

@@ -14,7 +14,6 @@ class TestTrack::Session
     manage_cookies!
     manage_response_headers!
     notify_unsynced_assignments! if sync_assignments?
-    create_alias! if signed_up?
   end
 
   def visitor_dsl
@@ -31,42 +30,27 @@ class TestTrack::Session
     }
   end
 
-  def log_in!(*args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    opts = args[-1].is_a?(Hash) ? args.pop : {}
+  def log_in!(identity, forget_current_visitor: nil)
+    identifier_type = identity.test_track_identifier_type
+    identifier_value = identity.test_track_identifier_value
 
-    if args[0].is_a?(TestTrack::Identity)
-      identity = args[0]
-      identifier_type = identity.test_track_identifier_type
-      identifier_value = identity.test_track_identifier_value
-    else
-      identifier_type = args[0]
-      identifier_value = args[1]
-      warn "#log_in! with two args is deprecated. Please provide a TestTrack::Identity"
-    end
-
-    @visitor = TestTrack::Visitor.new if opts[:forget_current_visitor]
+    @visitor = TestTrack::Visitor.new if forget_current_visitor
     visitor.link_identifier!(identifier_type, identifier_value)
 
     identities << identity if identity.present?
-    self.mixpanel_distinct_id = visitor.id
     true
   end
 
-  def sign_up!(*args) # rubocop:disable Metrics/MethodLength
-    if args[0].is_a?(TestTrack::Identity)
-      identity = args[0]
-      identifier_type = identity.test_track_identifier_type
-      identifier_value = identity.test_track_identifier_value
-    else
-      identifier_type = args[0]
-      identifier_value = args[1]
-      warn "#sign_up! with two args is deprecated. Please provide a TestTrack::Identity"
-    end
+  def sign_up!(identity)
+    identifier_type = identity.test_track_identifier_type
+    identifier_value = identity.test_track_identifier_value
 
     visitor.link_identifier!(identifier_type, identifier_value)
-
     identities << identity if identity.present?
-    @signed_up = true
+
+    TestTrack.analytics.sign_up!(visitor.id)
+
+    true
   end
 
   def has_matching_identity?(identity)
@@ -75,8 +59,7 @@ class TestTrack::Session
 
   private
 
-  attr_reader :controller, :signed_up
-  alias signed_up? signed_up
+  attr_reader :controller
 
   def visitor
     @visitor ||= TestTrack::Visitor.new(id: visitor_id)
@@ -127,7 +110,6 @@ class TestTrack::Session
   end
 
   def manage_cookies!
-    set_cookie(mixpanel_cookie_name, mixpanel_cookie.to_json)
     set_cookie(visitor_cookie_name, visitor.id)
   end
 
@@ -157,7 +139,6 @@ class TestTrack::Session
 
   def notify_unsynced_assignments!
     payload = {
-      mixpanel_distinct_id: mixpanel_distinct_id,
       visitor_id: visitor.id,
       assignments: visitor.unsynced_assignments
     }
@@ -171,52 +152,10 @@ class TestTrack::Session
     end
   end
 
-  def create_alias!
-    create_alias_job = TestTrack::CreateAliasJob.new(
-      existing_id: mixpanel_distinct_id,
-      alias_id: visitor.id
-    )
-    Delayed::Job.enqueue(create_alias_job)
-  end
-
   def sync_assignments?
     visitor.loaded? && visitor.unsynced_assignments.present?
   end
 
-  def mixpanel_distinct_id
-    mixpanel_cookie['distinct_id']
-  end
-
-  def mixpanel_distinct_id=(value)
-    mixpanel_cookie['distinct_id'] = value
-  end
-
-  def mixpanel_cookie
-    @mixpanel_cookie ||= read_mixpanel_cookie || generate_mixpanel_cookie
-  end
-
-  def read_mixpanel_cookie
-    mixpanel_cookie = cookies[mixpanel_cookie_name]
-    begin
-      JSON.parse(mixpanel_cookie) if mixpanel_cookie
-    rescue JSON::ParserError
-      Rails.logger.error("malformed mixpanel JSON from cookie #{URI.unescape(mixpanel_cookie)}")
-      nil
-    end
-  end
-
-  def generate_mixpanel_cookie
-    { 'distinct_id' => visitor.id }
-  end
-
-  def mixpanel_token
-    ENV['MIXPANEL_TOKEN'] || raise("ENV['MIXPANEL_TOKEN'] must be set")
-  end
-
-  def mixpanel_cookie_name
-    "mp_#{mixpanel_token}_mixpanel"
-  end
-
   def visitor_cookie_name
     ENV['TEST_TRACK_VISITOR_COOKIE_NAME'] || 'tt_visitor_id'
   end

data/app/models/test_track/unsynced_assignments_notifier.rb

@@ -1,13 +1,12 @@
 class TestTrack::UnsyncedAssignmentsNotifier
-  attr_reader :mixpanel_distinct_id, :visitor_id, :assignments
+  attr_reader :visitor_id, :assignments
 
   def initialize(opts)
     @visitor_id = opts.delete(:visitor_id)
-    @mixpanel_distinct_id = opts.delete(:mixpanel_distinct_id) || visitor_id
     @assignments = opts.delete(:assignments)
 
     %w(visitor_id assignments).each do |param_name|
-      raise "#{param_name} must be present" unless send(param_name).present?
+      raise "#{param_name} must be present" if send(param_name).blank?
     end
     raise "unknown opts: #{opts.keys.to_sentence}" if opts.present?
   end
@@ -29,7 +28,6 @@ class TestTrack::UnsyncedAssignmentsNotifier
 
   def build_notify_assignment_job(assignment)
     TestTrack::NotifyAssignmentJob.new(
-      mixpanel_distinct_id: mixpanel_distinct_id,
       visitor_id: visitor_id,
       assignment: assignment
     )

data/app/models/test_track/vary_dsl.rb

@@ -17,7 +17,7 @@ class TestTrack::VaryDSL
   end
 
   def when(*variants, &block)
-    raise ArgumentError, "must provide at least one variant" unless variants.present?
+    raise ArgumentError, "must provide at least one variant" if variants.blank?
     variants.each do |variant|
       assign_behavior_to_variant(variant, block)
     end
@@ -57,6 +57,10 @@ class TestTrack::VaryDSL
     variant = variant.to_s
 
     raise ArgumentError, "must provide block for #{variant}" unless behavior_proc
+    notify_because_vary(<<-MESSAGE) if variant_behaviors.include?(variant)
+      configures variant "#{variant}" more than once.
+      This will raise an error in the next version of test_track_rails_client.
+    MESSAGE
     notify_because_vary "configures unknown variant \"#{variant}\"" unless variant_acceptable?(variant)
 
     variant_behaviors[variant] = behavior_proc

data/app/models/test_track/visitor.rb

@@ -79,17 +79,6 @@ class TestTrack::Visitor
     end
   end
 
-  def self.backfill_identity(opts)
-    remote_identifier_visitor = TestTrack::Remote::Visitor.from_identifier(opts[:identifier_type], opts[:identifier_value])
-    visitor = new(
-      id: remote_identifier_visitor.id,
-      assignments: remote_identifier_visitor.assignments
-    )
-
-    TestTrack::CreateAliasJob.new(existing_id: opts[:existing_id], alias_id: visitor.id).perform
-    visitor
-  end
-
   def offline?
     @tt_offline
   end

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "2.0.0" # rubocop:disable Style/MutableConstant
+  VERSION = "3.0.0" # rubocop:disable Style/MutableConstant
 end

data/vendor/gems/fakeable_her/fakeable_her.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fakeable_her/version'
@@ -16,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'her'
-  spec.add_dependency 'rails', '~> 4.1'
+  spec.add_dependency 'rails', '>= 4.1', '< 5.2'
 
-  spec.add_development_dependency 'rubocop', '>= 0.36'
+  spec.add_development_dependency 'appraisal', '~> 2.2.0'
 end

data/vendor/gems/her/her.gemspec

@@ -18,14 +18,13 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 2.13"
-  s.add_development_dependency "rspec-its", "~> 1.0"
-  s.add_development_dependency "fivemat", "~> 1.2"
+  s.add_development_dependency "rspec", "~> 3.5"
   s.add_development_dependency "json", "~> 1.8"
   s.add_development_dependency "pry"
+  s.add_development_dependency 'appraisal', '~> 2.2.0'
 
-  s.add_runtime_dependency "activemodel", ">= 3.0.0", "<= 4.3.0"
-  s.add_runtime_dependency "activesupport", ">= 3.0.0", "<= 4.3.0"
+  s.add_runtime_dependency "activemodel", ">= 3.0.0", "<= 6.0.0"
+  s.add_runtime_dependency "activesupport", ">= 3.0.0", "<= 6.0.0"
   s.add_runtime_dependency "faraday", ">= 0.8", "< 1.0"
   s.add_runtime_dependency "multi_json", "~> 1.7"
 end

data/vendor/gems/her/lib/her/api.rb

@@ -6,7 +6,7 @@ module Her
     attr_reader :connection, :options
 
     # Constants
-    FARADAY_OPTIONS = [:request, :proxy, :ssl, :builder, :url, :parallel_manager, :params, :headers, :builder_class].freeze
+    FARADAY_OPTIONS = [:request, :proxy, :ssl, :builder, :url, :parallel_manager, :params, :headers, :builder_class, :timeout, :open_timeout].freeze
 
     # Setup a default API connection. Accepted arguments and options are the same as {API#setup}.
     def self.setup(opts={}, &block)

data/vendor/gems/her/lib/her/model/associations/association_proxy.rb

@@ -33,8 +33,7 @@ module Her
           end
 
           # create a proxy to the fetched object's method
-          metaclass = (class << self; self; end)
-          metaclass.install_proxy_methods 'association.fetch', name
+          AssociationProxy.install_proxy_methods 'association.fetch', name
 
           # resend message to fetched object
           __send__(name, *args, &block)