trailguide 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50116eb2206e240c060371109c4a16e87d5b7ec5fe39bfad66b824583f99e33f
-  data.tar.gz: 5432c696f6dc9258fd9b9abf9b79322caf70eb9ac0f0efac7e177a08fd5b4f38
+  metadata.gz: e499f17a07bf44c93e4ef7e4312a7d9c41e92081d178789dbac73fc2fc78fa51
+  data.tar.gz: 2d7bab3cd7cf33fed1b05745833f637b3242984607e4fcab447ebb9167f9254f
 SHA512:
-  metadata.gz: b8c465669f1c0b7f7686f55f4c33dc6c0c560bd00c69563ac181cc4bb9110a6ca22c528bf7a1b8e8bd0fe4c22b437a58a151aa57b5639774ed4df5e0453826ff
-  data.tar.gz: 24a51c4c675a18790b5a4676998f628d473ec70b134745b7a0a0192a39b499cb9ccb245309215e16d87910cf673f890056f1c25d1c52969de7937b631d60289f
+  metadata.gz: 7f53ad801154678194c1c4d19aef32c949eea5d230daf3c6c744eae566c7c3ddb671259e28544d778f3fabe582e4729a12762615894ddf95a1b4095318632740
+  data.tar.gz: 3e5ffe742e6e512fb2467b02361504ffc561801abf00d70bd5d1dbff667bd0790afa47209849d8b3c18aa12a10d2a3459069f46b007bc21fd85d8a1e980aca98

data/app/assets/config/trail_guide/admin_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../../javascripts/trail_guide/admin .js
+//= link_directory ../../stylesheets/trail_guide/admin .css

data/app/assets/javascripts/trail_guide/admin/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/trail_guide/admin/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/trail_guide/admin/application_controller.rb

@@ -0,0 +1,7 @@
+module TrailGuide
+  module Admin
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/trail_guide/admin/experiments_controller.rb

@@ -0,0 +1,8 @@
+module TrailGuide
+  module Admin
+    class ExperimentsController < ApplicationController
+      def index
+      end
+    end
+  end
+end

data/app/controllers/trail_guide/application_controller.rb

@@ -0,0 +1,43 @@
+module TrailGuide
+  class ApplicationController < ::ApplicationController
+    before_action do
+      render json: { error: "Experiment does not exist" }, status: 404 and return unless experiment.present?
+    end
+
+    def choose
+      variant = trailguide.choose!(experiment.experiment_name, metadata: metadata)
+      render json: {
+        experiment: experiment.experiment_name,
+        variant: variant.name,
+        metadata: variant.metadata.merge(metadata)
+      }
+    rescue => e
+      render json: { error: e.message }, status: 500
+    end
+
+    def convert
+      trailguide.convert!(experiment.experiment_name, checkpoint, metadata: metadata)
+      render json: {
+        experiment: experiment.experiment_name,
+        checkpoint: checkpoint,
+        metadata: metadata
+      }
+    rescue => e
+      render json: { error: e.message }, status: 500
+    end
+
+    private
+
+    def experiment
+      @experiment ||= TrailGuide.catalog.find(params[:experiment_name])
+    end
+
+    def checkpoint
+      @checkpoint ||= params[:checkpoint]
+    end
+
+    def metadata
+      @metadata ||= params[:metadata].try(:permit!) || {}
+    end
+  end
+end

data/app/views/layouts/trail_guide/admin/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TrailGuide Admin</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "trail_guide/admin/application", media: "all" %>
+  <%= javascript_include_tag "trail_guide/admin/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/trail_guide/admin/experiments/index.html.erb

@@ -0,0 +1 @@
+<h1>Experiments</h1>

data/config/admin/routes.rb

@@ -0,0 +1,3 @@
+TrailGuide::Admin::Engine.routes.draw do
+  resources :experiments, only: [:index]
+end

data/config/routes.rb

@@ -1,2 +1,10 @@
 TrailGuide::Engine.routes.draw do
+  get   '/:experiment_name' => 'application#choose',
+        defaults: { format: :json }
+  match '/:experiment_name' => 'application#convert',
+        defaults: { format: :json },
+        via: [:put, :post]
+  match '/:experiment_name/:checkpoint' => 'application#convert',
+        defaults: { format: :json },
+        via: [:put, :post]
 end

data/lib/trail_guide/admin/engine.rb

@@ -0,0 +1,13 @@
+module TrailGuide
+  module Admin
+    class Engine < ::Rails::Engine
+      isolate_namespace TrailGuide::Admin
+
+      config.generators do |g|
+        g.test_framework = :rspec
+      end
+    end
+  end
+end
+
+load TrailGuide::Admin::Engine.root.join("config/admin/routes.rb")

data/lib/trail_guide/admin.rb

@@ -0,0 +1,6 @@
+require "trail_guide/admin/engine"
+
+module TrailGuide
+  module Admin
+  end
+end

data/lib/trail_guide/experiment.rb

@@ -228,12 +228,22 @@ module TrailGuide
       end
 
       def as_json(opts={})
-        # TODO fill in the rest of the values i've added
-        {
-          experiment_name: experiment_name,
-          algorithm: algorithm,
-          variants: variants.as_json
-        }
+        { experiment_name => {
+          configuration: {
+            metric: metric,
+            algorithm: algorithm.name,
+            variants: variants.as_json,
+            goals: goals.as_json,
+            resettable: resettable?,
+            allow_multiple_conversions: allow_multiple_conversions?,
+            allow_multiple_goals: allow_multiple_goals?
+          },
+          statistics: {
+            # TODO expand on this for variants/goals
+            participants: variants.sum(&:participants),
+            converted: variants.sum(&:converted)
+          }
+        } }
       end
 
       def storage_key

data/lib/trail_guide/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mark Rebec
@@ -103,6 +103,15 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- app/assets/config/trail_guide/admin_manifest.js
+- app/assets/javascripts/trail_guide/admin/application.js
+- app/assets/stylesheets/trail_guide/admin/application.css
+- app/controllers/trail_guide/admin/application_controller.rb
+- app/controllers/trail_guide/admin/experiments_controller.rb
+- app/controllers/trail_guide/application_controller.rb
+- app/views/layouts/trail_guide/admin/application.html.erb
+- app/views/trail_guide/admin/experiments/index.html.erb
+- config/admin/routes.rb
 - config/routes.rb
 - lib/trail_guide/adapters.rb
 - lib/trail_guide/adapters/participants.rb
@@ -112,6 +121,8 @@ files:
 - lib/trail_guide/adapters/participants/redis.rb
 - lib/trail_guide/adapters/participants/session.rb
 - lib/trail_guide/adapters/participants/unity.rb
+- lib/trail_guide/admin.rb
+- lib/trail_guide/admin/engine.rb
 - lib/trail_guide/algorithms.rb
 - lib/trail_guide/algorithms/bandit.rb
 - lib/trail_guide/algorithms/distributed.rb