test_track_rails_client 3.0.1 → 4.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de83b3a3626b4f8852627295f9c84330b79cbe86
-  data.tar.gz: cbb4f5236a634654c5521334fe194627388eaea4
+  metadata.gz: 15d95f4893c2f57f54d755bc1c8bb7130537767c
+  data.tar.gz: 5a26c66732114f90119b54636ae6e7122cb6efeb
 SHA512:
-  metadata.gz: a7ffe3bffe66ea43947f12aeb17ca5ed33c1bdb164e635c27d1638b8f85f9ce83eb12a628fed6828abfd62799f6923dbc6e071591c2785eb483b675eeb24b96f
-  data.tar.gz: fa05c8f371ad213edcf9d492b9218b3ac19fd1748a4cd4d8204db64d4c7980d5354ad079796f27242cf9829278d6cb12e16710e6ba6b614f14875012116709a1
+  metadata.gz: 654863b402ff1e8a8ae2257999afb947c1ac3875fbb205c6b8de628b439f7dfafc84066f51d167aa4feb9082ec97466a7bb3928a6111e7d4673eb63020278683
+  data.tar.gz: 6704876202051c7d04dec540c5adb74a6d20d8fc9344d616d014d9355959e542a317dbeb1d66facc5e28434ba1ac57a5669a52ae8097c82caa7b35dc852d7ec7

data/README.md

@@ -349,9 +349,10 @@ Your client must implement the following methods:
 ```ruby
 # Called when a new Split has been Assigned
 #
-# @param visitor_id [String] TestTrack's unique visitor identification key
-# @param assignment [TestTrack::Assignment] The assignment model itself
-def track_assignment(visitor_id, assignment)
+# @param analytics_event [TestTrack::AnalyticsEvent] An object
+# representing an analytics event providing name and properties
+# values you can send to your analytics backend
+def track(analytics_event)
 
 # Called after TestTrack.sign_up!
 #
@@ -361,7 +362,7 @@ 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.
+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` 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:
 
@@ -373,44 +374,15 @@ mixpanel.init('YOUR MIXPANEL TOKEN', {
 });
 ```
 
-### 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
-```
+## Upgrading
 
-Then in your custom analytics plugin, use that value for assignment events and aliasing.
+### From 3.0 to 4.0
 
-```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
+The contract of custom analytics plugins has changed. Instead of
+implementing `track_assignment` you now must implement `track`. It's
+easier and more conventional, though, and takes care of differentiating
+between expiriment assignments and feature gate experiences, which are
+no longer recorded server-side.
 
 ### From 2.0 to 3.0
 

data/app/models/concerns/test_track/identity.rb

@@ -16,36 +16,36 @@ module TestTrack::Identity
         end
 
         define_method :test_track_ab do |*args|
-          discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-          discriminator.with_visitor do |v|
+          locator = TestTrack::IdentitySessionLocator.new(self)
+          locator.with_visitor do |v|
             v.ab(*args)
           end
         end
 
         define_method :test_track_vary do |*args, &block|
-          discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-          discriminator.with_visitor do |v|
+          locator = TestTrack::IdentitySessionLocator.new(self)
+          locator.with_visitor do |v|
             v.vary(*args, &block)
           end
         end
 
         define_method :test_track_visitor_id do
-          discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-          discriminator.with_visitor do |v|
+          locator = TestTrack::IdentitySessionLocator.new(self)
+          locator.with_visitor do |v|
             v.id
           end
         end
 
         define_method :test_track_sign_up! do
-          discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-          discriminator.with_session do |session|
+          locator = TestTrack::IdentitySessionLocator.new(self)
+          locator.with_session do |session|
             session.sign_up! self
           end
         end
 
         define_method :test_track_log_in! do |opts = {}|
-          discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-          discriminator.with_session do |session|
+          locator = TestTrack::IdentitySessionLocator.new(self)
+          locator.with_session do |session|
             session.log_in! self, opts
           end
         end

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

@@ -1,7 +1,7 @@
 module TestTrack::Analytics
   class MixpanelClient
-    def track_assignment(visitor_id, assignment)
-      mixpanel.track(visitor_id, 'SplitAssigned', split_properties(assignment).merge(TTVisitorID: visitor_id))
+    def track(analytics_event)
+      mixpanel.track(analytics_event.visitor_id, analytics_event.name, analytics_event.properties)
     end
 
     private
@@ -10,13 +10,5 @@ module TestTrack::Analytics
       raise "ENV['MIXPANEL_TOKEN'] must be set" unless ENV['MIXPANEL_TOKEN']
       @mixpanel ||= Mixpanel::Tracker.new(ENV['MIXPANEL_TOKEN'])
     end
-
-    def split_properties(assignment)
-      {
-        SplitName: assignment.split_name,
-        SplitVariant: assignment.variant,
-        SplitContext: assignment.context
-      }
-    end
   end
 end

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

@@ -12,8 +12,8 @@ module TestTrack::Analytics
       @error_handler = handler
     end
 
-    def track_assignment(visitor_id, assignment)
-      safe_action { underlying.track_assignment(visitor_id, assignment) }
+    def track(analytics_event)
+      safe_action { underlying.track(analytics_event) }
     end
 
     def sign_up!(visitor_id)

data/app/models/test_track/analytics_event.rb

@@ -0,0 +1,28 @@
+module TestTrack
+  class AnalyticsEvent
+    attr_reader :assignment
+
+    delegate :visitor_id, to: :assignment
+
+    def initialize(assignment)
+      @assignment = assignment
+    end
+
+    def name
+      if assignment.feature_gate?
+        'FeatureGateExperienced'
+      else
+        'SplitAssigned'
+      end
+    end
+
+    def properties
+      {
+        TTVisitorID: visitor_id,
+        SplitName: assignment.split_name,
+        SplitVariant: assignment.variant,
+        SplitContext: assignment.context
+      }
+    end
+  end
+end

data/app/models/test_track/assignment.rb

@@ -19,6 +19,18 @@ class TestTrack::Assignment
     true
   end
 
+  def feature_gate?
+    split_name.end_with?('_enabled')
+  end
+
+  def analytics_event
+    @analytics_event ||= AnalyticsEvent.new(self)
+  end
+
+  def visitor_id
+    visitor.id
+  end
+
   private
 
   def _variant

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

@@ -1,7 +1,7 @@
 class TestTrack::Fake::Visitor
   attr_reader :id
 
-  Assignment = Struct.new(:split_name, :variant, :unsynced, :context)
+  Assignment = Struct.new(:split_name, :variant, :unsynced, :context, :visitor_id)
 
   def self.instance
     @instance ||= new(TestTrack::FakeServer.seed)
@@ -28,7 +28,7 @@ class TestTrack::Fake::Visitor
   def _assignments
     split_registry.keys.map do |split_name|
       variant = TestTrack::VariantCalculator.new(visitor: self, split_name: split_name).variant
-      Assignment.new(split_name, variant, false, "the_context")
+      Assignment.new(split_name, variant, false, "the_context", id)
     end
   end
 end

data/app/models/test_track/{identity_session_discriminator.rb → identity_session_locator.rb}

@@ -1,4 +1,4 @@
-class TestTrack::IdentitySessionDiscriminator
+class TestTrack::IdentitySessionLocator
   attr_reader :identity
 
   def initialize(identity)
@@ -8,8 +8,8 @@ class TestTrack::IdentitySessionDiscriminator
   def with_visitor
     raise ArgumentError, "must provide block to `with_visitor`" unless block_given?
 
-    if matching_identity?
-      yield session.visitor_dsl
+    if web_context?
+      yield session.visitor_dsl_for(identity)
     else
       TestTrack::OfflineSession.with_visitor_for(identity.test_track_identifier_type, identity.test_track_identifier_value) do |v|
         yield v
@@ -29,10 +29,6 @@ class TestTrack::IdentitySessionDiscriminator
 
   private
 
-  def matching_identity?
-    session.present? && session.has_matching_identity?(identity)
-  end
-
   def web_context?
     session.present?
   end

data/app/models/test_track/notify_assignment_job.rb

@@ -12,19 +12,22 @@ class TestTrack::NotifyAssignmentJob
   end
 
   def perform
-    TestTrack::Remote::AssignmentEvent.create!(
-      visitor_id: visitor_id,
-      split_name: assignment.split_name,
-      context: assignment.context,
-      mixpanel_result: track
-    )
+    tracking_result = track
+    unless assignment.feature_gate?
+      TestTrack::Remote::AssignmentEvent.create!(
+        visitor_id: visitor_id,
+        split_name: assignment.split_name,
+        context: assignment.context,
+        mixpanel_result: tracking_result
+      )
+    end
   end
 
   private
 
   def track
     return "failure" unless TestTrack.enabled?
-    result = TestTrack.analytics.track_assignment(visitor_id, assignment)
+    result = TestTrack.analytics.track(assignment.analytics_event)
     result ? "success" : "failure"
   end
 end

data/app/models/test_track/session.rb

@@ -16,6 +16,27 @@ class TestTrack::Session
     notify_unsynced_assignments! if sync_assignments?
   end
 
+  def visitor_dsl_for(identity)
+    if has_matching_identity?(identity)
+      visitor_dsl
+    else
+      TestTrack::VisitorDSL.new(visitors_by_identity[identity])
+    end
+  end
+
+  def visitors_by_identity
+    @visitors_by_identity ||= Hash.new do |visitors_by_identity, identity|
+      remote_visitor = TestTrack::Remote::Visitor.from_identifier(
+        identity.test_track_identifier_type,
+        identity.test_track_identifier_value
+      )
+      visitors_by_identity[identity] = TestTrack::Visitor.new(
+        id: remote_visitor.id,
+        assignments: remote_visitor.assignments
+      )
+    end
+  end
+
   def visitor_dsl
     @visitor_dsl ||= TestTrack::VisitorDSL.new(visitor)
   end

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "3.0.1" # rubocop:disable Style/MutableConstant
+  VERSION = "4.0.0.alpha1" # rubocop:disable Style/MutableConstant
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_track_rails_client
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.0.alpha1
 platform: ruby
 authors:
 - Ryan O'Neill
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake
@@ -259,6 +259,7 @@ files:
 - app/models/test_track/ab_configuration.rb
 - app/models/test_track/analytics/mixpanel_client.rb
 - app/models/test_track/analytics/safe_wrapper.rb
+- app/models/test_track/analytics_event.rb
 - app/models/test_track/assignment.rb
 - app/models/test_track/config_updater.rb
 - app/models/test_track/fake/split_detail.rb
@@ -266,7 +267,7 @@ files:
 - app/models/test_track/fake/visitor.rb
 - app/models/test_track/fake/visitor_detail.rb
 - app/models/test_track/fake_server.rb
-- app/models/test_track/identity_session_discriminator.rb
+- app/models/test_track/identity_session_locator.rb
 - app/models/test_track/misconfiguration_notifier.rb
 - app/models/test_track/notify_assignment_job.rb
 - app/models/test_track/offline_session.rb
@@ -356,9 +357,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1