trailguide 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12093bc501e3daa2a035ad59e2ecc118a2bf9839b6db852763ae52e3e41ffd3a
-  data.tar.gz: c40a654b9ec80c1dc602563647bfd23c9fdfe090b0bc43c2457d7c1e0f1ee1b4
+  metadata.gz: bcb676051862d84d744bf4a84c60adcd1ccba36b0cf319bc3c37c2f3ae774a0e
+  data.tar.gz: 7397a453afdef82edc8ced81f1a54b342324aaf508adcc5d159e0efb2bb958a0
 SHA512:
-  metadata.gz: 100f0c9b8cb8f13cf98f3445afac2ab406bab9ad895a89947f0d7d7199eb7034b0fd29d75a993cc9f5c68d52894b38933438cf00ce3371bc18de122d1b365c98
-  data.tar.gz: 1a5044225a220f9f1e0263953cb0a3019d96b3f4f43d5f2f0913b06809f0c4e13acc9ec3aa91778df669aba16984b8c60e59a6091e05055bec6b1a72e62fbc75
+  metadata.gz: fd5fdd35dd59f7fe8ea812c08d6773850ab0d9acec0a1a20da5d55db3f690bd43ea7aa11126d0a78408059fdef7940fec78504a43ae6d82caac897e11f75bcf0
+  data.tar.gz: 5042d43b78c5ef826854627308632e6db970d755963bc6c7c96e10060ea0ea0f09f42f6b6c0462c38845a708afc3456312cc412b8b513995ba2caa834d698127

data/README.md

@@ -590,24 +590,114 @@ If you're using a custom adapter, you'll need to make sure that your adapter is
 
 ## JavaScript Client
 
-There is a simple javascript client available that mimics the ruby usage as closely as possible, and is ready to be used with the rails asset pipeline. This client uses axios to hit the API, and requires that you mount it in your routes.
+There is a simple javascript client available that mimics the ruby usage as closely as possible, and is ready to be used with the rails asset pipeline or via webpack. This client uses axios to hit the API, and requires that you mount it in your routes.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+
+  mount TrailGuide::Engine => 'api/experiments'
+
+  # ...
+end
+```
+
+### Rails Asset Pipeline
+
+If you're using the rails asset pipeline, just require trailguide in your `application.js` and instantiate a client.
 
 ```javascript
-// require the trailguide client in your application.js or wherever makes sense
+// require the trailguide client in your application.js or wherever makes sense for your project
 //= require trailguide
 
 // create a client instance
 // make sure to pass in the route path where you've mounted the trailguide engine
 var client = TrailGuide.client('/api/experiments');
+```
+
+The client is just a wrapper around `axios`, so you can provide any of their [request configuration options](https://github.com/axios/axios#request-config).
+
+```javascript
+var client = TrailGuide.client({
+  baseURL: '/api/experiments',
+  headers: {...},
+  transformRequest: (data,headers) => (...)
+});
+```
+
+### Webpack
+
+If you're using webpack, you can install the corresponding `trailguide` npm package with `yarn` or `npm`:
+
+```
+yarn add trailguide
+```
+
+```
+npm install trailguide
+```
 
+Then use it in your project:
+
+```javascript
+import { client } from 'trailguide'
+
+// create a client instance
+// make sure to pass in the route path where you've mounted the trailguide engine
+export default client('/api/experiments')
+```
+
+```javascript
+var TrailGuide = require('trailguide');
+
+module.exports = {
+  // create a client instance
+  // make sure to pass in the route path where you've mounted the trailguide engine
+  client: TrailGuide.client('/api/experiments')
+};
+```
+
+The client is just a wrapper around `axios`, so you can provide any of their [request configuration options](https://github.com/axios/axios#request-config).
+
+```javascript
+client({
+  baseURL: '/api/experiments',
+  headers: {...},
+  transformRequest: (data,headers) => (...)
+})
+```
+
+### Usage
+
+Once you have a handle on a client, the usage is the same. All methods return a promise with the `response` as a payload.
+
+```javascript
 // enroll in an experiment
-client.choose('experiment_name');
+client.choose('experiment_name', {...optional_metadata...}).then(response => {
+ // response.data will be:
+ // { experiment: "experiment_name", variant: "assigned_variant_name", metadata: {...} }
+})
 
 // convert for an experiment with an optional goal
-client.convert('experiment_name', 'optional_goal');
+client.convert('experiment_name', 'optional_goal', {...optional_metadata...}).then(response => {
+  // response.data will be:
+  // { experiment: "experiment_name", checkpoint: "optional_goal", metadata: {...} }
+})
 
 // return the participant's active experiments and their assigned variant group
-client.active();
+client.active().then(response => {
+  // response.data will be:
+  // { experiments: { experiment_name: "assigned_variant_name" } }
+})
+```
+
+The client is just a wrapper around `axios`, and all the client methods support any of their [request configuration options](https://github.com/axios/axios#request-config) as the last argument.
+
+```javascript
+client.active({ headers: {...}, transformRequest: (data,headers) => (...) }).then(...)
+client.choose('experiment_name', {...optional_metadata...}, { headers: {...}, transformRequest: (data,headers) => (...) }).then(...)
+client.convert('experiment_name', 'optional_goal', {...optional_metadata...}, { headers: {...}, transformRequest: (data,headers) => (...) }).then(...)
 ```
 
 ## Conversion Goals

data/lib/trail_guide/experiments/base.rb

@@ -71,6 +71,7 @@ module TrailGuide
         :storage_key, :combined?, :start_manually?, :reset_manually?,
         :allow_multiple_conversions?, :allow_multiple_goals?, :is_combined?,
         :enable_calibration?, :track_winner_conversions?, :callbacks, to: :class
+      delegate :context, to: :participant
 
       def initialize(participant)
         @participant = Experiments::Participant.new(self, participant)

data/lib/trail_guide/experiments/participant.rb

@@ -2,6 +2,7 @@ module TrailGuide
   module Experiments
     class Participant
       attr_reader :experiment, :participant
+      delegate :context, to: :participant
 
       def initialize(experiment, participant)
         @experiment = experiment

data/lib/trail_guide/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mark Rebec