optimizely-sdk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4e2928bce7afc40511832935bda9c4938e94c5e
-  data.tar.gz: 78d597c3b47fb1f7ba5be4263d71890c0b31dce4
+  metadata.gz: 78af637c6334c098627f0f83824494fb30fb0de4
+  data.tar.gz: d9d32f68014ec5866e521e274ac384fef1e22e81
 SHA512:
-  metadata.gz: 9877c72f05cbe15df3f9405f16d4815b060a7e7c440230031a9e777ffac45dbc6111b5c2b9e5132f0d548d1a1630e8bc424ebfb66b6954163169f7054cf0e1da
-  data.tar.gz: 179837929307a3a2ae1b12ad19bd43891458a371d797424ed062e6375398db78ec378526cefa43180f7ec45b360760ada8c2ae7ff03d4dfb430f739b2f31edd3
+  metadata.gz: 09fdf5e75b3fb050d43f627af4f81225d8bdd2ed0f10c89b8dfe8b485f1849b669497315645e54d7eb8fdcec7209892ebdb9a5a5af68805bd7f3873051738eb7
+  data.tar.gz: 1bd6b64f56ef37dc6c2c38af651fce3c967832da5cf22a05e67683befb0bd3aeaec61c441a8d4ca6a961b97a6654f1362a8d5ea1d4a63b568c55a0858ff72d15

data/lib/optimizely.rb

@@ -18,7 +18,7 @@ module Optimizely
     attr_accessor :logger
     attr_accessor :error_handler
 
-    def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil)
+    def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil, skip_json_validation = false)
       # Constructor for Projects.
       #
       # datafile - JSON string representing the project.
@@ -26,11 +26,12 @@ module Optimizely
       # logger - Optional param which provides a log method to log messages. By default nothing would be logged.
       # error_handler - Optional param which provides a handle_error method to handle exceptions.
       #                 By default all exceptions will be suppressed.
+      # skip_json_validation - Optional boolean param to skip JSON schema validation of the provided datafile.
 
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
       @event_dispatcher = event_dispatcher || EventDispatcher.new
-      validate_inputs(datafile)
+      validate_inputs(datafile, skip_json_validation)
 
       @config = ProjectConfig.new(datafile, @logger, @error_handler)
       @bucketer = Bucketer.new(@config)
@@ -172,8 +173,11 @@ module Optimizely
       true
     end
 
-    def validate_inputs(datafile)
-      raise InvalidDatafileError unless Helpers::Validator.datafile_valid?(datafile)
+    def validate_inputs(datafile, skip_json_validation)
+      unless skip_json_validation
+        raise InvalidDatafileError unless Helpers::Validator.datafile_valid?(datafile)
+      end
+
       raise InvalidLoggerError unless Helpers::Validator.logger_valid?(@logger)
       raise InvalidErrorHandlerError unless Helpers::Validator.error_handler_valid?(@error_handler)
       raise InvalidEventDispatcherError unless Helpers::Validator.event_dispatcher_valid?(@event_dispatcher)

data/lib/optimizely/helpers/constants.rb

@@ -10,6 +10,115 @@ module Optimizely
           'accountId' => {
             'type' => 'string'
           },
+          'groups' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'object',
+              'properties' => {
+                'id' => {
+                  'type' => 'string'
+                },
+                'policy' => {
+                  'type' => 'string'
+                },
+                'trafficAllocation' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'object',
+                    'properties' => {
+                      'entityId' => {
+                        'type' => 'string'
+                      },
+                      'endOfRange' => {
+                        'type' => 'integer'
+                      }
+                    },
+                    'required' => [
+                      'entityId',
+                      'endOfRange'
+                    ]
+                  }
+                },
+                'experiments' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'object',
+                    'properties' => {
+                      'id' => {
+                        'type' => 'string'
+                      },
+                      'key' => {
+                        'type' => 'string'
+                      },
+                      'status' => {
+                        'type' => 'string'
+                      },
+                      'variations' => {
+                        'type' => 'array',
+                        'items' => {
+                          'type' => 'object',
+                          'properties' => {
+                            'id' => {
+                              'type' => 'string'
+                            },
+                            'key' => {
+                              'type' => 'string'
+                            }
+                          },
+                          'required' => [
+                            'id',
+                            'key'
+                          ]
+                        }
+                      },
+                      'trafficAllocation' => {
+                        'type' => 'array',
+                        'items' => {
+                          'type' => 'object',
+                          'properties' => {
+                            'entityId' => {
+                              'type' => 'string'
+                            },
+                            'endOfRange' => {
+                              'type' => 'integer'
+                            }
+                          },
+                          'required' => [
+                            'entityId',
+                            'endOfRange'
+                          ]
+                        }
+                      },
+                      'audienceIds' => {
+                        'type' => 'array',
+                        'items' => {
+                          'type' => 'string'
+                        }
+                      },
+                      'forcedVariations' => {
+                        'type' => 'object'
+                      }
+                    },
+                    'required' => [
+                      'id',
+                      'key',
+                      'status',
+                      'variations',
+                      'trafficAllocation',
+                      'audienceIds',
+                      'forcedVariations'
+                    ]
+                  }
+                }
+              },
+              'required' => [
+                'id',
+                'policy',
+                'trafficAllocation',
+                'experiments'
+              ]
+            }
+          },
           'experiments' => {
             'type' => 'array',
             'items' => {
@@ -21,6 +130,9 @@ module Optimizely
                 'key' => {
                   'type' => 'string'
                 },
+                'status' => {
+                  'type' => 'string'
+                },
                 'variations' => {
                   'type' => 'array',
                   'items' => {
@@ -57,9 +169,6 @@ module Optimizely
                     ]
                   }
                 },
-                'percentageIncluded' => {
-                  'type' => 'integer'
-                },
                 'audienceIds' => {
                   'type' => 'array',
                   'items' => {
@@ -75,9 +184,9 @@ module Optimizely
                 'key',
                 'variations',
                 'trafficAllocation',
-                'percentageIncluded',
                 'audienceIds',
-                'forcedVariations'
+                'forcedVariations',
+                'status'
               ]
             }
           },
@@ -162,6 +271,7 @@ module Optimizely
           'accountId',
           'experiments',
           'events',
+          'groups',
           'audiences',
           'dimensions',
           'version',

data/lib/optimizely/version.rb

@@ -1,3 +1,3 @@
 module Optimizely
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'.freeze
 end

data/lib/start.rb

@@ -1,6 +1,131 @@
-require "./optimizely.rb"
-require 'json'
-require 'httparty'
-# conf = '{"projectId": "53020", "events": [{"key": "Total Revenue", "id": "5641834680287232", "experimentIds": ["53033"]}], "experiments": [], "dimensions": [], "audiences": [], "revision": "5", "groups": [{"policy": "random", "id": "53025", "experiments": [{"variations": [{"key": "BLAH_1", "id": "53027"}, {"key": "BLAH_2", "id": "53028"}], "trafficAllocation": [{"endOfRange": 5000, "entityId": "53027"}, {"endOfRange": 10000, "entityId": "53028"}], "forcedVariations": {}, "audienceIds": [], "percentageIncluded": 3000, "status": "Running", "key": "exp_1", "id": "53026"}, {"variations": [{"key": "BLAH_1", "id": "53034"}, {"key": "BLAH_2", "id": "53035"}], "trafficAllocation": [{"endOfRange": 3000, "entityId": "53034"}, {"endOfRange": 10000, "entityId": "53035"}], "forcedVariations": {}, "audienceIds": [], "percentageIncluded": 4000, "status": "Running", "key": "exp_2", "id": "53033"}], "trafficAllocation": [{"endOfRange": 3000, "entityId": "53026"}, {"endOfRange": 7000, "entityId": "53033"}]}], "accountId": "23001", "version": "1"}'
-conf = HTTParty.get('https://cdn.optimizely.com/json/6377970066.json').body
-@optly = Optimizely::Project.new(conf, nil, Optimizely::SimpleLogger.new)
+require './optimizely'
+require 'benchmark'
+
+class PerformanceTests
+  @error_handler = Optimizely::NoOpErrorHandler.new
+  @logger = Optimizely::NoOpLogger.new
+
+  def self.test_initialize(testdata, optly)
+    Optimizely::Project.new(testdata)
+  end
+
+  def self.test_initialize_logger(testdata, optly)
+    Optimizely::Project.new(testdata, nil, @logger)
+  end
+
+  def self.test_initialize_logger_and_error_handler(testdata, optly)
+    Optimizely::Project.new(testdata, nil, @logger, @error_handler)
+  end
+
+  def self.test_initialize_no_schema_validation(testdata, optly)
+    Optimizely::Project.new(testdata, nil, nil, nil, true)
+  end
+
+  def self.test_initialize_logger_no_schema_validation(testdata, optly)
+    Optimizely::Project.new(testdata, nil, @logger, nil, true)
+  end
+
+  def self.test_initialize_error_handler_no_schema_validation(testdata, optly)
+    Optimizely::Project.new(testdata, nil, nil, @error_handler, true)
+  end
+
+  def self.test_initialize_logger_error_handler_no_schema_validation(testdata, optly)
+    Optimizely::Project.new(testdata, nil, @logger, @error_handler, true)
+  end
+
+  def self.test_initialize_error_handler_no_schema_validation(testdata, optly)
+    Optimizely::Project.new(testdata, nil, nil, @error_handler, true)
+  end
+
+  def self.test_activate(testdata, optly)
+    optly.activate('testExperiment2', 'optimizely_user')
+  end
+
+  def self.test_activate_with_attributes(testdata, optly)
+    optly.activate('testExperimentWithFirefoxAudience', 'optimizely_user', {'browser_type' => 'firefox'})
+  end
+
+  def self.test_activate_with_forced_variation(testdata, optly)
+    optly.activate('testExperiment2', 'variation_user')
+  end
+
+  def self.test_activate_grouped_exp(testdata, optly)
+    optly.activate('mutex_exp2', 'optimizely_user')
+  end
+
+  def self.test_activate_grouped_exp_with_attributes(testdata, optly)
+    optly.activate('mutex_exp1', 'optimizely_user', {'browser_type' => 'firefox'})
+  end
+
+  def self.test_get_variation(testdata, optly)
+    optly.get_variation('testExperiment2', 'optimizely_user')
+  end
+
+  def self.test_get_variation_with_attributes(testdata, optly)
+    optly.get_variation('testExperimentWithFirefoxAudience', 'optimizely_user', {'browser_type' => 'firefox'})
+  end
+
+  def self.test_get_variation_with_forced_variation(testdata, optly)
+    optly.get_variation('testExperiment2', 'variation_user')
+  end
+
+  def self.test_get_variation_grouped_exp(testdata, optly)
+    optly.get_variation('mutex_exp2', 'optimizely_user')
+  end
+
+  def self.test_get_variation_grouped_exp_with_attributes(testdata, optly)
+    optly.get_variation('mutex_exp1', 'optimizely_user')
+  end
+
+  def self.test_track(testdata, optly)
+    optly.track('testEvent', 'optimizely_user')
+  end
+
+  def self.test_track_with_attributes(testdata, optly)
+    optly.track('testEventWithAudiences' 'optimizely_user', {'browser_type' => 'firefox'})
+  end
+
+  def self.test_track_with_revenue(testdata, optly)
+    optly.track('testEvent', 'optimizely_user', nil, 666)
+  end
+
+  def self.test_track_with_attributes_and_revenue(testdata, optly)
+    optly.track('testEventWithAudiences', 'optimizely_user', {'browser_type' => 'firefox'}, 666)
+  end
+
+  def self.test_track_grouped_exp(testdata, optly)
+    optly.track('testEventWithMultipleGroupedExperiments', 'optimizely_user')
+  end
+
+  def self.test_track_grouped_exp_with_attributes(testdata, optly)
+    optly.track('testEventWithMultipleExperiments', 'optimizely_user', {'browser_type' => 'firefox'})
+  end
+
+  def self.test_track_grouped_exp_with_revenue(testdata, optly)
+    optly.track('testEventWithMultipleGroupedExperiments', 'optimizely_user', nil, 666)
+  end
+
+  def self.test_track_grouped_exp_with_attributes_and_revenue(testdata, optly)
+    optly.track('testEventWithMultipleExperiments', 'optimizely_user', {'browser_type' => 'firefox'}, 666)
+  end
+end
+
+def run_tests
+  testdata10 = File.read('testdata_10.json')
+  testdata25 = File.read('testdata_25.json')
+  testdata50 = File.read('testdata_50.json')
+  optly10 = Optimizely::Project.new(testdata10)
+  optly25 = Optimizely::Project.new(testdata25)
+  optly50 = Optimizely::Project.new(testdata50)
+
+  tests = PerformanceTests.methods(false)
+  tests.each do |test|
+    puts '', test
+    Benchmark.bmbm do |x|
+      x.report('10 exps') { PerformanceTests.send(test, testdata10, optly10) }
+      x.report('25 exps') { PerformanceTests.send(test, testdata25, optly25) }
+      x.report('50 exps') { PerformanceTests.send(test, testdata50, optly50) }
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Delikat
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,10 +110,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.2
-description: A Ruby SDK for Optimizely's server-side testing, which is currently in
-  private beta.
+description: A Ruby SDK for Optimizely's server-side testing product, which is currently
+  in private beta.
 email:
-- server-side-testing@optimizely.com
+- developers@optimizely.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Optimizely's testing framework