trailguide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91de95da7df9831c3ab11b091d4caa81d566044ca054f450a4ece7b6c74e50eb
+  data.tar.gz: 3c4a00eccbbb4a3983a87462b52f6e7489ba4079f1f74f5e7bb53959b163a9dd
+SHA512:
+  metadata.gz: fa89b438040e89c75f7ec183f3ded180c95506d205e60f3c7b1c099b13e63162e91b1205147176cb9271c4a7759f59b0ed1dff793a897c6fae253c0df056007d
+  data.tar.gz: e877c3aa6c6abcd9375cfafe45c30cea9e86f1a4ca0215a3fd0581b7337487c48ed2fe9ca05bd5f5768292901f2d4dda184f7a6ebe06d1b4cfdee9dbba014f69

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Mark Rebec
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# TrailGuide
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trailguide'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install trailguide
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/routes.rb

@@ -0,0 +1,2 @@
+TrailGuide::Engine.routes.draw do
+end

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

@@ -0,0 +1,70 @@
+module TrailGuide
+  module Adapters
+    module Participants
+      class Anonymous
+        include Canfig::Instance
+
+        class << self
+          alias_method :configure, :new
+          def new(context, &block)
+            configure(&block).new(context)
+          end
+        end
+
+        def initialize(&block)
+          configure do |config|
+            yield(config) if block_given?
+          end
+        end
+
+        # instance method, creates a new adapter and passes through config
+        def new(context)
+          Adapter.new(context, configuration)
+        end
+
+        class Adapter
+          attr_reader :context, :config
+
+          def initialize(context, config)
+            @context = context
+            @config = config
+          end
+
+          def [](key)
+            hash[key]
+          end
+
+          def []=(key, value)
+            hash[key] = value
+          end
+
+          def delete(key)
+            hash.delete(key)
+          end
+
+          def destroy!
+            @hash = nil
+          end
+
+          def keys
+            hash.keys
+          end
+
+          def key?(key)
+            hash.key?(key)
+          end
+
+          def to_h
+            hash.to_h
+          end
+
+          private
+
+          def hash
+            @hash ||= {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+module TrailGuide
+  module Adapters
+    module Participants
+      class Cookie
+        include Canfig::Instance
+
+        # TODO maybe be a little better about checking for action dispatch, etc.?
+
+        class << self
+          alias_method :configure, :new
+          def new(context, &block)
+            configure(&block).new(context)
+          end
+        end
+
+        def initialize(&block)
+          configure do |config|
+            config.cookie = :trailguide
+            config.path = '/'
+            config.expiration = 1.year.to_i
+            # TODO other cookie options (domain, ssl, etc.)
+
+            yield(config) if block_given?
+          end
+        end
+
+        # instance method, creates a new adapter and passes through config
+        def new(context)
+          raise NoMethodError, "Your current context (#{context}) does not support cookies" unless context.respond_to?(:cookies, true)
+          Adapter.new(context, configuration)
+        end
+
+        class Adapter
+          attr_reader :context, :config
+
+          def initialize(context, config)
+            @context = context
+            @config = config
+          end
+
+          def [](key)
+            cookie[key.to_s]
+          end
+
+          def []=(key, value)
+            cookie.merge!({key.to_s => value})
+            write_cookie
+          end
+
+          def delete(key)
+            cookie.tap { |h| h.delete(key.to_s) }
+            write_cookie
+          end
+
+          def destroy!
+            cookies.delete(config.cookie.to_s)
+          end
+
+          def keys
+            cookie.keys
+          end
+
+          def key?(key)
+            cookie.key?(key)
+          end
+
+          def to_h
+            cookie.to_h
+          end
+
+          private
+
+          def cookie
+            @cookie ||= begin
+              JSON.parse(cookies[config.cookie.to_s])
+            rescue
+              {}
+            end
+          end
+
+          def cookies
+            context.send(:cookies)
+          end
+
+          def write_cookie
+            cookies[config.cookie.to_s] = cookie_options.merge({value: cookie.as_json})
+          end
+
+          def cookie_options
+            {
+              expires: Time.now + config.expiration,
+              path: config.path
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module TrailGuide
+  module Adapters
+    module Participants
+      class Multi
+        include Canfig::Instance
+
+        class << self
+          alias_method :configure, :new
+          def new(context, &block)
+            configure(&block).new(context)
+          end
+        end
+
+        def initialize(&block)
+          configure do |config|
+            config.adapter = -> (context) do
+              if context.respond_to?(:current_user, true) && context.send(:current_user).present?
+                TrailGuide::Adapters::Participants::Redis
+              elsif context.respond_to?(:cookies, true)
+                TrailGuide::Adapters::Participants::Cookie
+              elsif context.respond_to?(:session, true)
+                TrailGuide::Adapters::Participants::Session
+              else
+                TrailGuide::Adapters::Participants::Anonymous
+              end
+            end
+
+            yield(config) if block_given?
+          end
+        end
+
+        # instance method, creates a new adapter and passes through config
+        def new(context)
+          adapter = configuration.adapter.call(context)
+          adapter = configuration.send(adapter) if adapter.is_a?(Symbol)
+          adapter.new(context)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module TrailGuide
+  module Adapters
+    module Participants
+      class Redis
+        include Canfig::Instance
+
+        class << self
+          alias_method :configure, :new
+          def new(context, **opts, &block)
+            configure(&block).new(context, **opts)
+          end
+        end
+
+        def initialize(&block)
+          configure do |config|
+            config.namespace = :participants
+            config.lookup = -> (context) { context.current_user.id }
+            config.expiration = nil
+
+            yield(config) if block_given?
+          end
+        end
+
+        # instance method, creates a new adapter and passes through config
+        def new(context, **opts)
+          Adapter.new(context, configuration, **opts)
+        end
+
+        class Adapter
+          attr_reader :context, :config, :storage_key
+
+          def initialize(context, config, key: nil)
+            @context = context
+            @config = config
+
+            if key
+              @storage_key = "#{config.namespace}:#{key}"
+            elsif config.lookup
+              if config.lookup.respond_to?(:call)
+                key = config.lookup.call(context)
+              else
+                key = context.send(config.lookup)
+              end
+              @storage_key = "#{config.namespace}:#{key}"
+            else
+              # TODO better error
+              raise ArgumentError, "You must configure a `lookup` proc"
+            end
+          end
+
+          def [](field)
+            TrailGuide.redis.hget(storage_key, field.to_s)
+          end
+
+          def []=(field, value)
+            TrailGuide.redis.hset(storage_key, field.to_s, value)
+            TrailGuide.redis.expire(storage_key, config.expiration) if config.expiration
+          end
+
+          def delete(field)
+            TrailGuide.redis.hdel(storage_key, field.to_s)
+          end
+
+          def destroy!
+            TrailGuide.redis.del(storage_key)
+          end
+
+          def keys
+            TrailGuide.redis.hkeys(storage_key)
+          end
+
+          def key?(field)
+            TrailGuide.redis.hexists(storage_key, field.to_s)
+          end
+
+          def to_h
+            TrailGuide.redis.hgetall(storage_key)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module TrailGuide
+  module Adapters
+    module Participants
+      class Session
+        include Canfig::Instance
+
+        class << self
+          alias_method :configure, :new
+          def new(context, &block)
+            configure(&block).new(context)
+          end
+        end
+
+        def initialize(&block)
+          configure do |config|
+            config.key = :trailguide
+
+            yield(config) if block_given?
+          end
+        end
+
+        # instance method, creates a new adapter and passes through config
+        def new(context)
+          raise NoMethodError, "Your current context (#{context}) does not support sessions" unless context.respond_to?(:session, true)
+          Adapter.new(context, configuration)
+        end
+
+        class Adapter
+          attr_reader :context, :config
+
+          def initialize(context, config)
+            @context = context
+            @config = config
+          end
+
+          def [](key)
+            session[key]
+          end
+
+          def []=(key, value)
+            session[key] = value
+          end
+
+          def delete(key)
+            session.delete(key)
+          end
+
+          def destroy!
+            context.send(:session).delete(config.key)
+          end
+
+          def keys
+            session.keys
+          end
+
+          def key?(key)
+            session.key?(key)
+          end
+
+          def to_h
+            session.to_h
+          end
+
+          private
+
+          def session
+            context.send(:session)[config.key] ||= {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+require 'trail_guide/unity'
+
+module TrailGuide
+  module Adapters
+    module Participants
+      class Unity < Multi
+        attr_reader :context, :unity
+
+        def initialize(&block)
+          configure do |config|
+            config.visitor_cookie = nil
+            config.user_id_key = :id
+
+            config.user_adapter = TrailGuide::Adapters::Participants::Redis.configure do |config|
+              config.namespace = 'unity:users'
+              config.lookup = -> (user_id) { user_id }
+            end
+
+            config.visitor_adapter = TrailGuide::Adapters::Participants::Redis.configure do |config|
+              config.namespace = 'unity:visitors'
+              config.lookup = -> (visitor_id) { visitor_id }
+            end
+
+            config.anonymous_adapter = TrailGuide::Adapters::Participants::Anonymous
+
+            yield(config) if block_given?
+          end
+        end
+
+        def new(context)
+          @context = context
+          @unity = TrailGuide::Unity.new
+
+          if trailguide_context?
+            unity.user_id ||= context.send(:try, :trailguide_user).try(configuration.user_id_key)
+            unity.visitor_id ||= context.send(:try, :trailguide_visitor)
+          end
+
+          if logged_in_context?
+            unity.user_id ||= context.send(:current_user).send(configuration.user_id_key)
+          end
+
+          if logged_out_context?
+            unity.visitor_id ||= context.send(:cookies)[configuration.visitor_cookie].gsub(/(%22|")/, '')
+          end
+
+          unity.sync!
+          merge! if unity.synced?
+
+          adapter = configuration.send("#{context_type}_adapter".to_sym)
+          if anonymous_context?
+            adapter.new(context)
+          else
+            adapter.new(unity.send("#{context_type}_id".to_sym))
+          end
+        end
+
+        protected
+
+        def context_type
+          if visitor_context?
+            return :visitor
+          end
+
+          if user_context?
+            return :user
+          end
+
+          return :anonymous
+        end
+
+        def merge!
+          user_adapter.keys.each do |key|
+            visitor_adapter[key] = user_adapter[key] unless visitor_adapter[key].present?
+          end
+          user_adapter.destroy!
+        end
+
+        def trailguide_context?
+          context.send(:try, :trailguide_user).present? ||
+            context.send(:try, :trailguide_visitor).present?
+        end
+
+        def logged_in_context?
+          context.send(:try, :current_user).present?
+        end
+
+        def logged_out_context?
+          return false unless configuration.visitor_cookie.present?
+          context.respond_to?(:cookies, true) && context.send(:cookies)[configuration.visitor_cookie].present?
+        end
+
+        def user_context?
+          unity.user_id.present?
+        end
+
+        def visitor_context?
+          unity.visitor_id.present?
+        end
+
+        def anonymous_context?
+          !visitor_context? && !user_context?
+        end
+      end
+    end
+  end
+end

data/lib/trail_guide/adapters/participants.rb

@@ -0,0 +1,12 @@
+require "trail_guide/adapters/participants/anonymous"
+require "trail_guide/adapters/participants/session"
+require "trail_guide/adapters/participants/cookie"
+require "trail_guide/adapters/participants/redis"
+require "trail_guide/adapters/participants/multi"
+
+module TrailGuide
+  module Adapters
+    module Participants
+    end
+  end
+end

data/lib/trail_guide/adapters.rb

@@ -0,0 +1,6 @@
+require "trail_guide/adapters/participants"
+
+module TrailGuide
+  module Adapters
+  end
+end

data/lib/trail_guide/algorithms/bandit.rb

@@ -0,0 +1,48 @@
+require 'simple-random'
+
+module TrailGuide
+  module Algorithms
+    class Bandit
+      attr_reader :experiment
+
+      def self.choose!(experiment, **opts)
+        new(experiment).choose!(**opts)
+      end
+
+      def initialize(experiment)
+        @experiment = experiment
+      end
+
+      def choose!(**opts)
+        guess = best_guess
+        experiment.variants.find { |var| var == guess }
+      end
+
+      private
+
+      def best_guess
+        @best_guess ||= begin
+          guesses = {}
+          experiment.variants.each do |variant|
+            guesses[variant.name] = arm_guess(variant.participants, variant.converted)
+          end
+          gmax = guesses.values.max
+          best = guesses.keys.select { |name| guesses[name] ==  gmax }
+          best.sample
+        end
+      end
+
+      def arm_guess(participants, conversions)
+        a = [participants, 0].max
+        b = [(participants - conversions), 0].max
+        s = SimpleRandom.new
+        s.set_seed
+        s.beta(a+fairness_constant, b+fairness_constant)
+      end
+
+      def fairness_constant
+        7
+      end
+    end
+  end
+end

data/lib/trail_guide/algorithms/distributed.rb

@@ -0,0 +1,26 @@
+module TrailGuide
+  module Algorithms
+    class Distributed
+      attr_reader :experiment
+
+      def self.choose!(experiment, **opts)
+        new(experiment).choose!(**opts)
+      end
+
+      def initialize(experiment)
+        @experiment = experiment
+      end
+
+      def choose!(**opts)
+        variants.sample
+      end
+
+      private
+
+      def variants
+        groups = experiment.variants.group_by(&:participants)
+        groups.min_by { |c,g| c }.last
+      end
+    end
+  end
+end

data/lib/trail_guide/algorithms/random.rb

@@ -0,0 +1,19 @@
+module TrailGuide
+  module Algorithms
+    class Random
+      attr_reader :experiment
+
+      def self.choose!(experiment, **opts)
+        new(experiment).choose!(**opts)
+      end
+
+      def initialize(experiment)
+        @experiment = experiment
+      end
+
+      def choose!(**opts)
+        experiment.variants.sample
+      end
+    end
+  end
+end

data/lib/trail_guide/algorithms/weighted.rb

@@ -0,0 +1,25 @@
+module TrailGuide
+  module Algorithms
+    class Weighted
+      attr_reader :experiment
+
+      def self.choose!(experiment, **opts)
+        new(experiment).choose!(**opts)
+      end
+
+      def initialize(experiment)
+        @experiment = experiment
+      end
+
+      def choose!(**opts)
+        weights   = experiment.variants.map(&:weight)
+        reference = rand * weights.inject(:+)
+
+        experiment.variants.zip(weights).each do |variant,weight|
+          return variant if weight >= reference
+          reference -= weight
+        end
+      end
+    end
+  end
+end