trailguide 0.1.23 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58c9c8c98d0955f2f43194bbea245101c16227c103a885376f5c7bfdfdfa6de2
-  data.tar.gz: 55511233504312e35c9ceda5ba5a08dcb27c0afdec04fb0684c201ac4575ae94
+  metadata.gz: 11e84a1721748ce5766e400941e5802dcc549cc7dc343172ea4379fbcc0b9aca
+  data.tar.gz: 7d7327e04519bc5998108c020792b4f646d525f3336ec0ebd3d865700895ea1b
 SHA512:
-  metadata.gz: 1f44e0158dd4c7a25fd3a02a2f8a518c9bd46acd40a1680603f60aa01d0836e49a1dd5a4472816a6479fb0159e20bdff68051e923aae84ab5ddee7a0daf3b6a5
-  data.tar.gz: 2801b067ab586c24775621b6a5355a2256db75d568b7093f10c04870b4881df4f31d42b660324e19123845b4a3c80cd0f12f89b8baa52497b12d91e1f39ccb27
+  metadata.gz: 2170a96f4c9d24a440607c7691b43ae10cb783c53fcb11cc06e641ef98871e9d7a116379593a7569d3230980fd5d21a4d78504df1db2e0e8cc75fc876c068920
+  data.tar.gz: 31e9785970eb3710dc9f56a3525112031e7fa03b70178def7799d4e521179471d4c1d506e24b69199463ec991bfccf9b4d4294956a94e1c91d329c910f596ae8

data/config/initializers/trailguide.rb

@@ -48,6 +48,28 @@ TrailGuide.configure do |config|
   #             logged in/out sessions and across devices
   config.adapter = :cookie
 
+  # whether or not to clean up any old/inactive experiments for participants
+  # regularly as part of the experiment flow - this is very fast, and only adds
+  # a couple milliseconds to participant initialization, but isn't strictly
+  # necessary, since expired enrollment will never affect future experiment
+  # participation - it might be good practice if you're using redis to store
+  # participant data without expiration
+  #
+  # true      will clean up any old/inactive experiment keys for each
+  #           participant the first time they're encountered during a script
+  #           execution (web request, etc.)
+  # false     will skip the cleanup process entirely
+  config.cleanup_participant_experiments = true
+
+  # the ttl (in seconds) for unity session unification keys - only applicable if
+  # you're using the unity adapter and/or are leveraging unity outside of
+  # trailguide experiments - particularly useful if you want to use something
+  # like the volatile-lru eviction policy for your redis instance
+  #
+  # nil       no expiration for unity session unification keys
+  # 31556952  1 year (in seconds) expiration for unity keys
+  config.unity_ttl = nil
+
   # callback when your participant adapter fails to initialize, and trailguide
   # falls back to the anonymous adapter
   config.on_adapter_failover = -> (adapter, error) do

data/lib/trail_guide/adapters/participants/unity.rb

@@ -14,11 +14,13 @@ module TrailGuide
             config.user_adapter = TrailGuide::Adapters::Participants::Redis.configure do |config|
               config.namespace = 'unity:users'
               config.lookup = -> (user_id) { user_id }
+              config.expiration = 1.year.seconds
             end
 
             config.visitor_adapter = TrailGuide::Adapters::Participants::Redis.configure do |config|
               config.namespace = 'unity:visitors'
               config.lookup = -> (visitor_id) { visitor_id }
+              config.expiration = 1.year.seconds
             end
 
             config.anonymous_adapter = TrailGuide::Adapters::Participants::Anonymous

data/lib/trail_guide/catalog.rb

@@ -184,7 +184,8 @@ module TrailGuide
 
     class DSL
       def self.experiment(name, **opts, &block)
-        Class.new(TrailGuide::Experiment) do
+        klass = opts.delete(:class) || TrailGuide::Experiment
+        Class.new(klass) do
           configure opts.merge({name: name}), &block
         end
       end

data/lib/trail_guide/config.rb

@@ -3,7 +3,8 @@ module TrailGuide
     DEFAULT_KEYS = [
       :redis, :disabled, :override_parameter, :allow_multiple_experiments,
       :adapter, :on_adapter_failover, :filtered_ip_addresses,
-      :filtered_user_agents, :request_filter, :include_helpers
+      :filtered_user_agents, :request_filter, :include_helpers,
+      :cleanup_participant_experiments, :unity_ttl
     ].freeze
 
     def initialize(*args, **opts, &block)

data/lib/trail_guide/participant.rb

@@ -1,35 +1,38 @@
 module TrailGuide
   class Participant
-    attr_reader :adapter
+    attr_reader :context
     delegate :key?, :keys, :[], :[]=, :delete, :destroy!, :to_h, to: :adapter
 
     def initialize(context, adapter: nil)
-      @adapter = adapter.present? ? adapter.new(context) : configured_adapter.new(context)
-      #cleanup_inactive_experiments!
+      @context = context
+      @adapter = adapter.new(context) if adapter.present?
+      cleanup_inactive_experiments! if TrailGuide.configuration.cleanup_participant_experiments
     end
 
-    def configured_adapter
-      config_adapter = TrailGuide.configuration.adapter
-      case config_adapter
-      when :cookie
-        config_adapter = TrailGuide::Adapters::Participants::Cookie
-      when :session
-        config_adapter = TrailGuide::Adapters::Participants::Session
-      when :redis
-        config_adapter = TrailGuide::Adapters::Participants::Redis
-      when :anonymous
-        config_adapter = TrailGuide::Adapters::Participants::Anonymous
-      when :multi
-        config_adapter = TrailGuide::Adapters::Participants::Multi
-      else
-        config_adapter = config_adapter.constantize if config_adapter.is_a?(String)
-      end
-      config_adapter
-    rescue => e
-      [TrailGuide.configuration.on_adapter_failover].flatten.compact.each do |callback|
-        callback.call(config_adapter, e)
+    def adapter
+      @adapter ||= begin
+        config_adapter = TrailGuide.configuration.adapter
+        case config_adapter
+        when :cookie
+          config_adapter = TrailGuide::Adapters::Participants::Cookie
+        when :session
+          config_adapter = TrailGuide::Adapters::Participants::Session
+        when :redis
+          config_adapter = TrailGuide::Adapters::Participants::Redis
+        when :anonymous
+          config_adapter = TrailGuide::Adapters::Participants::Anonymous
+        when :multi
+          config_adapter = TrailGuide::Adapters::Participants::Multi
+        else
+          config_adapter = config_adapter.constantize if config_adapter.is_a?(String)
+        end
+        config_adapter.new(context)
+      rescue => e
+        [TrailGuide.configuration.on_adapter_failover].flatten.compact.each do |callback|
+          callback.call(config_adapter, e)
+        end
+        TrailGuide::Adapters::Participants::Anonymous.new(context)
       end
-      TrailGuide::Adapters::Participants::Anonymous
     end
 
     def variant(experiment)

data/lib/trail_guide/unity.rb

@@ -55,6 +55,11 @@ module TrailGuide
       return false unless valid?
       TrailGuide.redis.set(user_key, visitor_id)
       TrailGuide.redis.set(visitor_key, user_id)
+      if TrailGuide.configuration.unity_ttl
+        TrailGuide.redis.expire(user_key, TrailGuide.configuration.unity_ttl)
+        TrailGuide.redis.expire(visitor_key, TrailGuide.configuration.unity_ttl)
+      end
+      true
     end
 
     def delete!

data/lib/trail_guide/version.rb

@@ -2,7 +2,7 @@ module TrailGuide
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 23
+    PATCH = 24
     VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
     class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.1.23
+  version: 0.1.24
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails