test_track_rails_client 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e89607653cb61940fedd99d80d61957a0bf57a1
-  data.tar.gz: dd88c45263723f36ac874a066dce626d24b85cc8
+  metadata.gz: 30685a58f06262e141d5deb48bce124da381861e
+  data.tar.gz: 22c790111f624535e1165bba5ad83b68b765944b
 SHA512:
-  metadata.gz: a49693c2afd28427caacc2398673a8dc6442eabfa57bbc00a8d999343b7bf9220c0fd8a0c6dfba72bfb28e1a91009e67d97e7d77e229aee611190b7caa9a20bb
-  data.tar.gz: ea250b67d413d2e3e6acd8b854d5bb9799cce2d2b6105570af3c192813cfcaff655d8e50cfb19218a35007003225005a95f4025bed779d541f9b6bcd91c0325c
+  metadata.gz: 7452da90b5d34c19107e6a446908fd48034e094997b0c40f612b9fdf4c3c10b0c7f80779eed9981294184c7982f39919a83b5086671b47bf42970dc2adca3106
+  data.tar.gz: 805507d3629c7cd387a0f90604a9e0725fa234360bd4d575a84a7f756c698440a39d088f29cc0dd642ff2bb9da947b581600d1584f6432a6cef07820a75634f6

data/README.md

@@ -8,6 +8,17 @@ It provides server-side split-testing and feature-toggling through a simple API.
 
 If you're looking to do client-side assignment, then check out our [JS client](https://github.com/Betterment/test_track_js_client).
 
+* [Installation](#installation)
+* [Concepts](#concepts)
+* [Configuring the TestTrack server from your app](#configuring-the-testtrack-server-from-your-app)
+* [Varying app behavior based on assigned variant](#varying-app-behavior-based-on-assigned-variant)
+* [Tracking visitor logins](#tracking-visitor-logins)
+* [Tracking signups](#tracking-signups)
+* [Testing splits](#testing-splits)
+* [Custom Analytics](#custom-analytics)
+* [Upgrading](#upgrading)
+* [How to Contribute](#how-to-contribute)
+
 ## Installation
 
 Install the gem:
@@ -349,6 +360,12 @@ def track_assignment(visitor_id, assignment, properties)
 def alias(visitor_id, existing_id)
 ```
 
+## Upgrading
+
+### 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.
+
 ## How to Contribute
 
 We would love for you to contribute! Anything that benefits the majority of `test_track` users—from a documentation fix to an entirely new feature—is encouraged.

data/app/controllers/concerns/test_track/controller.rb

@@ -18,7 +18,7 @@ module TestTrack::Controller
   end
 
   def manage_test_track_session
-    RequestStore[:test_track_controller] = self
+    RequestStore[:test_track_session] = test_track_session
     test_track_session.manage do
       yield
     end

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

@@ -2,74 +2,54 @@ module TestTrack::Identity
   extend ActiveSupport::Concern
 
   module ClassMethods
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity
-    def test_track_identifier(identifier_type, identifier_value_method)
+    def test_track_identifier(identifier_type, identifier_value_method) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       instance_methods = Module.new
       include instance_methods
 
       instance_methods.module_eval do
+        define_method :test_track_identifier_type do
+          identifier_type
+        end
+
+        define_method :test_track_identifier_value do
+          send(identifier_value_method)
+        end
+
         define_method :test_track_ab do |*args|
           discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-
-          if discriminator.authenticated_resource_matches_identity?
-            discriminator.controller.send(:test_track_visitor).ab(*args)
-          else
-            identifier_value = send(identifier_value_method)
-            TestTrack::OfflineSession.with_visitor_for(identifier_type, identifier_value) do |v|
-              v.ab(*args)
-            end
+          discriminator.with_visitor do |v|
+            v.ab(*args)
           end
         end
 
         define_method :test_track_vary do |*args, &block|
           discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-
-          if discriminator.authenticated_resource_matches_identity?
-            discriminator.controller.send(:test_track_visitor).vary(*args, &block)
-          else
-            identifier_value = send(identifier_value_method)
-            TestTrack::OfflineSession.with_visitor_for(identifier_type, identifier_value) do |v|
-              v.vary(*args, &block)
-            end
+          discriminator.with_visitor do |v|
+            v.vary(*args, &block)
           end
         end
 
         define_method :test_track_visitor_id do
           discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-
-          if discriminator.authenticated_resource_matches_identity?
-            discriminator.controller.send(:test_track_visitor).id
-          else
-            identifier_value = send(identifier_value_method)
-            TestTrack::OfflineSession.with_visitor_for(identifier_type, identifier_value) do |v|
-              v.id
-            end
+          discriminator.with_visitor do |v|
+            v.id
           end
         end
 
         define_method :test_track_sign_up! do
           discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-
-          if discriminator.web_context?
-            identifier_value = send(identifier_value_method)
-            discriminator.controller.send(:test_track_session).sign_up! identifier_type, identifier_value
-          else
-            raise "test_track_sign_up! called outside of a web context"
+          discriminator.with_session do |session|
+            session.sign_up! self
           end
         end
 
         define_method :test_track_log_in! do |opts = {}|
           discriminator = TestTrack::IdentitySessionDiscriminator.new(self)
-
-          if discriminator.web_context?
-            identifier_value = send(identifier_value_method)
-            discriminator.controller.send(:test_track_session).log_in! identifier_type, identifier_value, opts
-          else
-            raise "test_track_log_in! called outside of a web context"
+          discriminator.with_session do |session|
+            session.log_in! self, opts
           end
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity
   end
 end

data/app/models/test_track/identity_session_discriminator.rb

@@ -5,26 +5,39 @@ class TestTrack::IdentitySessionDiscriminator
     @identity = identity
   end
 
-  def controller
-    @controller ||= RequestStore[:test_track_controller]
-  end
+  def with_visitor
+    raise ArgumentError, "must provide block to `with_visitor`" unless block_given?
 
-  def authenticated_resource_matches_identity?
-    controller_has_authenticated_resource? && controller.send(authenticated_resource_method_name) == identity
+    if matching_identity?
+      yield session.visitor_dsl
+    else
+      TestTrack::OfflineSession.with_visitor_for(identity.test_track_identifier_type, identity.test_track_identifier_value) do |v|
+        yield v
+      end
+    end
   end
 
-  def web_context?
-    controller.present?
+  def with_session
+    raise ArgumentError, "must provide block to `with_session`" unless block_given?
+
+    if web_context?
+      yield session
+    else
+      raise "#with_session called outside of web context"
+    end
   end
 
   private
 
-  def controller_has_authenticated_resource?
-    # pass true to `respond_to?` to include private methods
-    web_context? && controller.respond_to?(authenticated_resource_method_name, true)
+  def matching_identity?
+    session.present? && session.has_matching_identity?(identity)
+  end
+
+  def web_context?
+    session.present?
   end
 
-  def authenticated_resource_method_name
-    @authenticated_resource_method_name ||= "current_#{identity.class.model_name.element}"
+  def session
+    @session ||= RequestStore[:test_track_session]
   end
 end

data/app/models/test_track/session.rb

@@ -31,18 +31,48 @@ class TestTrack::Session
     }
   end
 
-  def log_in!(identifier_type, identifier_value, opts = {})
+  def log_in!(*args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    opts = args[-1].is_a?(Hash) ? args.pop : {}
+
+    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.link_identifier!(identifier_type, identifier_value)
+
+    identities << identity if identity.present?
     self.mixpanel_distinct_id = visitor.id
     true
   end
 
-  def sign_up!(identifier_type, identifier_value)
+  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
+
     visitor.link_identifier!(identifier_type, identifier_value)
+
+    identities << identity if identity.present?
     @signed_up = true
   end
 
+  def has_matching_identity?(identity)
+    identities.include?(identity)
+  end
+
   private
 
   attr_reader :controller, :signed_up
@@ -215,4 +245,8 @@ class TestTrack::Session
       end
     end
   end
+
+  def identities
+    @identities ||= TestTrack::SessionIdentityCollection.new(controller)
+  end
 end

data/app/models/test_track/session_identity_collection.rb

@@ -0,0 +1,29 @@
+class TestTrack::SessionIdentityCollection
+  def initialize(controller)
+    @controller = controller
+  end
+
+  def include?(identity)
+    found_identity = identities[identity.test_track_identifier_type] || authenticated_resource_for_identity(identity)
+    found_identity.present? && found_identity == identity
+  end
+
+  def <<(identity)
+    identities[identity.test_track_identifier_type] = identity
+  end
+
+  private
+
+  attr_reader :controller
+
+  def identities
+    @identities ||= {}
+  end
+
+  def authenticated_resource_for_identity(identity)
+    authenticated_resource_method_name = "current_#{identity.class.model_name.element}"
+
+    # pass true to `respond_to?` to include private methods
+    controller.respond_to?(authenticated_resource_method_name, true) && controller.send(authenticated_resource_method_name)
+  end
+end

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "1.2.0" # rubocop:disable Style/MutableConstant
+  VERSION = "1.3.0" # 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: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan O'Neill
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -291,6 +291,7 @@ files:
 - app/models/test_track/remote/visitor.rb
 - app/models/test_track/remote/visitor_detail.rb
 - app/models/test_track/session.rb
+- app/models/test_track/session_identity_collection.rb
 - app/models/test_track/unsynced_assignments_notifier.rb
 - app/models/test_track/variant_calculator.rb
 - app/models/test_track/vary_dsl.rb
@@ -441,7 +442,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Rails client for TestTrack