optimizely_server_side 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e914671dc234dd0b0a8cc3b7aa11903a4398095
-  data.tar.gz: 6b2e99cc7637393048c5b4fd1930a0d811c69b3e
+  metadata.gz: 21c1476041632408d773cb808b130c96820800dd
+  data.tar.gz: e331c2e11409f4fc601bd7713cdc6b5ff91747a2
 SHA512:
-  metadata.gz: fb68662ca48927d48c1bfea819646234181cc06c298d5c3af713432a156c80fcb39945435cb7e439266a286329810bc468a7f30e3c7e5b5c6b4cdcf1b3253982
-  data.tar.gz: edbfc9ce0f8200fe70e594030fa37092b8119095c486ee46b3fbee99f9ae5c19be3bb866390e0c523fec18fde906350d303b1499ba9df30380d155a6c6eb23af
+  metadata.gz: 24787d1c316e0d09aff313bf6bfac09fd0abec5c59086c7b59800a7bdd15910ad834ee8fa0f5a38ecec44c898072353cdc494907c46a61f60d1d612910fdd8fc
+  data.tar.gz: 2169eb627e065d0ff2bb98b9bc636602d4f2ab326e0e6b7decaffd83ede9bdbd7b26a540e6ad4adc038696449163cbe17c033bbab74c9b9aee123db1c19afcf5

data/Changelog.md

@@ -0,0 +1,7 @@
+# 0.0.10
+
+Introduced the `user_attributes` option which takes care of passing visitor_id and custom attributes that will be required for Audience level bucketing.
+
+# 0.0.9
+
+Event dispatcher can now be passed as option.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    optimizely_server_side (0.0.9)
+    optimizely_server_side (0.0.10)
       activesupport (~> 4.2, >= 4.2.6)
       optimizely-sdk (~> 0.1.1)
 

data/Readme.md

@@ -58,11 +58,16 @@ end
 
 ```
 
-Config info
+_Config info_
 
-`config_endpoint` - This is the Datafile endpoint which returns JSON config. `PROJECT_ID` is a id of your  server side project at https://app.optimizely.com .
-`cache_expiry` - Time we want to keep the config cached in memory.
-`event_dispatcher` - Optimizely needs to track every visit. You can pass your own event dispatcher from here. Read [more](https://developers.optimizely.com/server/reference/index#event-dispatcher)
+- `config_endpoint` - This is the Datafile endpoint which returns JSON config. `PROJECT_ID` is a id of your  server side project at https://app.optimizely.com .
+- `cache_expiry` - Time we want to keep the config cached in memory.
+- `event_dispatcher` - Optimizely needs to track every visit. You can pass your own event dispatcher from here. Read [more](https://developers.optimizely.com/server/reference/index#event-dispatcher)
+- `user_attributes` - Everything related to user is passed from here. The must have key is `visitor_id`. In the same hash you can pass other other custom attributes. eq
+
+```
+config.user_attributes = {'visitor_id' => 1234, 'device_type' => 'iPhone'}
+```
 
 
 
@@ -84,7 +89,7 @@ class ApplicationController < ActionController::Base
     # This links the browser cookie for visitor_id to
     # OptimizelyServerSide
     OptimizelyServerSide.configure do |config|  
-        config.visitor_id = cookies[:visitor_id]
+        config.user_attributes = {'visitor_id' => cookies[:visitor_id]}
     end
   end
 
@@ -99,13 +104,13 @@ class ApplicationController < ActionController::Base
 <% experiment(EXPERIMENT_KEY) do |config| %>
 
   <% config.variation_one(VARIATION_ONE_KEY) do %>
-    <%= render partial: 'variation_one_experience' %> 
+    <%= render partial: 'variation_one_experience' %>
   <% end %>
 
   <% config.variation_default(VARIATION_DEFAULT_KEY, primary: true) do %>
     <%= render partial: 'variation_default_experience' %>
   <% end %>
-  
+
 <% end %>
 ```
 
@@ -151,7 +156,7 @@ You can call you own method names with `variation_` . Below i have `config.varia
   <% config.variation_pathetic_experience(VARIATION_DEFAULT_KEY, primary: true) do %>
     <%= render partial: 'variation_default_experience' %>
   <% end %>
-  
+
 <% end %>
 
 ```

data/lib/optimizely_server_side/configuration.rb

@@ -6,12 +6,13 @@ module OptimizelyServerSide
     # Configuration enables to open up the configuration of gem for the application.
     # config_endpoint: Optimizely config endpoint
     # cache_expiry: (In minutes) How long we want to cache the config.
-    attr_accessor :config_endpoint, :cache_expiry, :visitor_id, :logger,
+    attr_accessor :config_endpoint, :cache_expiry, :user_attributes, :logger,
       :event_dispatcher
 
     def initialize
       @config_endpoint  = 'http://foo.com'
       @cache_expiry     = 15
+      @user_attributes  = {}
     end
 
   end

data/lib/optimizely_server_side/experiment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OptimizelyServerSide
   class Experiment
 

data/lib/optimizely_server_side/helpers/support.rb

@@ -28,8 +28,8 @@ module OptimizelyServerSide
       OptimizelyServerSide::OptimizelySdk
       .project_instance(event_dispatcher: OptimizelyServerSide.configuration.event_dispatcher)
       .activate(experiment_key,
-                OptimizelyServerSide.configuration.visitor_id,
-                OptimizelyServerSide.configuration.logger)
+                OptimizelyServerSide.configuration.user_attributes['visitor_id'.freeze],
+                OptimizelyServerSide.configuration.user_attributes)
     end
 
   end

data/optimizely_server_side.gemspec

@@ -2,8 +2,8 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'optimizely_server_side'
-  s.version     = '0.0.9'
-  s.date        = '2016-08-24'
+  s.version     = '0.0.10'
+  s.date        = '2016-08-28'
   s.summary     = "Optimizely server side. A wrapper on top of optimizely's ruby sdk for easy caching of server side config "
   s.description = "Optimizely server side. A A/B test wrapper on top of optimizely's ruby sdk for easy caching of server side config and exposing few more utility helpers. Handling of fallbacks and marking primary experiments. "
   s.authors     = ["Ankit Gupta"]
@@ -20,5 +20,3 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'optimizely-sdk' , '~> 0.1.1'
   s.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.6'
 end
-
-

data/spec/optimizely_server_side/configuration_spec.rb

@@ -12,10 +12,10 @@ RSpec.describe OptimizelyServerSide::Configuration do
 
   end
 
-  describe '#visitor_id' do
+  describe '#user_attributes' do
 
-    it 'defaults to nil' do
-      expect(subject.visitor_id).to be_nil
+    it 'defaults to {}' do
+      expect(subject.user_attributes).to eq({})
     end
   end
 
@@ -23,7 +23,7 @@ RSpec.describe OptimizelyServerSide::Configuration do
   describe '#event_dispatcher' do
 
     it 'defaults to nil' do
-      expect(subject.visitor_id).to be_nil
+      expect(subject.event_dispatcher).to be_nil
     end
 
   end

data/spec/optimizely_server_side_spec.rb

@@ -23,8 +23,8 @@ RSpec.describe OptimizelyServerSide do
         expect(OptimizelyServerSide.configuration.cache_expiry).to eq(12)
       end
 
-      it 'has no visitor_id' do
-        expect(OptimizelyServerSide.configuration.visitor_id).to be_nil
+      it 'has empty user_attributes' do
+        expect(OptimizelyServerSide.configuration.user_attributes).to eq({})
       end
     end
 
@@ -41,7 +41,7 @@ RSpec.describe OptimizelyServerSide do
 
       it 'has config_endpoint' do
         OptimizelyServerSide.configure do |config|
-          config.visitor_id = '1234abcdef'
+          config.user_attributes = { visitor_id: '1234abcdef' }
         end
 
         expect(OptimizelyServerSide.configuration.config_endpoint).to eq('https://cdn.optimizely.com/json/5960232316.json')
@@ -51,8 +51,12 @@ RSpec.describe OptimizelyServerSide do
         expect(OptimizelyServerSide.configuration.cache_expiry).to eq(12)
       end
 
-      it 'has no visitor_id' do
-        expect(OptimizelyServerSide.configuration.visitor_id).to eq('1234abcdef')
+      it 'has user_attributes' do
+        expect(OptimizelyServerSide.configuration.user_attributes).to eq({visitor_id: '1234abcdef'})
+      end
+
+      it 'has a visitor_id' do
+        expect(OptimizelyServerSide.configuration.user_attributes[:visitor_id]).to eq('1234abcdef')
       end
 
       it 'has instance of event_dispatcher' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely_server_side
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Ankit Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -83,6 +83,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - Readme.md