optimizely-sdk 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 388b7be07d59d027ef5f08ebce2fa43d62be0513
-  data.tar.gz: 0288d19e852dce6a860ceac8c35c6b508ed3363a
+  metadata.gz: 9905095aba19bd32c9a64d53e412c8d0caa101fd
+  data.tar.gz: 4d5103f57b0371c91f17fe45cad9faeebf903ba6
 SHA512:
-  metadata.gz: 02cd29fbf79181021dae6d19aae905e4304dc8ce6d338e7d1df2e2086fd7d381b65232ed188f41ef005a1afaefa6de610d195162b144e7c6eccd05b084f9be9f
-  data.tar.gz: 281090b33e4e89c8ea7a32276d259a307fa9a3001ce532cc8b373a70d7cc70ec19d7e62c52a360e29e1bbabb5f44786739d05214d276558c5d0b060772ab5488
+  metadata.gz: 9e049b70cd0548306b2721fcf9c494a8552b6a4c47c9efac4fb4b1f1dfda77e00ff2d5166a75dddc634cf20773ca9bb88591d6a7161596c1e2a0da42025dba7d
+  data.tar.gz: 62de64edcce2328c1b59dcb5cdedb067362f1cd85a8218d5554af1d77f06face671d0cf5b99218d00374654333ac538104b7134e192d75707a8138e530c8ad0d

data/lib/optimizely.rb

@@ -11,6 +11,10 @@ require_relative 'optimizely/project_config'
 
 module Optimizely
   class Project
+
+    # Boolean representing if the instance represents a usable Optimizely Project
+    attr_reader   :is_valid
+
     attr_accessor :config
     attr_accessor :bucketer
     attr_accessor :event_builder
@@ -33,14 +37,37 @@ module Optimizely
       #                 By default all exceptions will be suppressed.
       # skip_json_validation - Optional boolean param to skip JSON schema validation of the provided datafile.
 
+      @is_valid = true
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
       @event_dispatcher = event_dispatcher || EventDispatcher.new
-      validate_inputs(datafile, skip_json_validation)
 
-      @config = ProjectConfig.new(datafile, @logger, @error_handler)
-      @bucketer = Bucketer.new(@config)
-      @event_builder = EVENT_BUILDERS_BY_VERSION[@config.version].new(@config, @bucketer)
+      begin
+        validate_inputs(datafile, skip_json_validation)
+      rescue InvalidInputError => e
+        @is_valid = false
+        logger = SimpleLogger.new
+        logger.log(Logger::ERROR, e.message)
+        return
+      end
+
+      begin
+        @config = ProjectConfig.new(datafile, @logger, @error_handler)
+      rescue
+        @is_valid = false
+        logger = SimpleLogger.new
+        logger.log(Logger::ERROR, InvalidInputError.new('datafile').message)
+        return
+      end
+
+      begin
+        @bucketer = Bucketer.new(@config)
+        @event_builder = EVENT_BUILDERS_BY_VERSION[@config.version].new(@config, @bucketer)
+      rescue
+        @is_valid = false
+        logger = SimpleLogger.new
+        logger.log(Logger::ERROR, InvalidDatafileVersionError.new)
+      end
     end
 
     def activate(experiment_key, user_id, attributes = nil)
@@ -51,7 +78,13 @@ module Optimizely
       # attributes - Hash representing user attributes and values to be recorded.
       #
       # Returns variation key representing the variation the user will be bucketed in.
-      # Returns nil if experiment is not Running or if user is not in experiment.
+      # Returns nil if experiment is not Running, if user is not in experiment, or if datafile is invalid.
+
+      unless @is_valid
+        logger = SimpleLogger.new
+        logger.log(Logger::ERROR, InvalidDatafileError.new('activate').message)
+        return nil
+      end
 
       if attributes && !attributes_valid?(attributes)
         @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
@@ -75,7 +108,11 @@ module Optimizely
       @logger.log(Logger::INFO,
                   'Dispatching impression event to URL %s with params %s.' % [impression_event.url,
                                                                               impression_event.params])
-      @event_dispatcher.dispatch_event(impression_event)
+      begin
+        @event_dispatcher.dispatch_event(impression_event)
+      rescue => e
+        @logger.log(Logger::ERROR, "Unable to dispatch impression event. Error: #{e}")
+      end
 
       @config.get_variation_key_from_id(experiment_key, variation_id)
     end
@@ -88,7 +125,13 @@ module Optimizely
       # attributes - Hash representing user attributes.
       #
       # Returns variation key where visitor will be bucketed.
-      # Returns nil if experiment is not Running or if user is not in experiment.
+      # Returns nil if experiment is not Running, if user is not in experiment, or if datafile is invalid.
+
+      unless @is_valid
+        logger = SimpleLogger.new
+        logger.log(Logger::ERROR, InvalidDatafileError.new('get_variation').message)
+        return nil
+      end
 
       if attributes && !attributes_valid?(attributes)
         @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
@@ -112,7 +155,11 @@ module Optimizely
       # attributes - Hash representing visitor attributes and values which need to be recorded.
       # event_value - Value associated with the event. Can be used to represent revenue in cents.
 
-      # Create and dispatch conversion event
+      unless @is_valid
+        logger = SimpleLogger.new
+        logger.log(Logger::ERROR, InvalidDatafileError.new('track').message)
+        return nil
+      end
 
       return nil if attributes && !attributes_valid?(attributes)
 
@@ -134,14 +181,21 @@ module Optimizely
       end
 
       # Don't track events without valid experiments attached
-      return if valid_experiment_keys.empty?
+      if valid_experiment_keys.empty?
+        @logger.log(Logger::INFO, "There are no valid experiments for event '#{event_key}' to track.")
+        return nil
+      end
 
       conversion_event = @event_builder.create_conversion_event(event_key, user_id, attributes,
                                                                 event_value, valid_experiment_keys)
       @logger.log(Logger::INFO,
                   'Dispatching conversion event to URL %s with params %s.' % [conversion_event.url,
                                                                               conversion_event.params])
-      @event_dispatcher.dispatch_event(conversion_event)
+      begin
+        @event_dispatcher.dispatch_event(conversion_event)
+      rescue => e
+        @logger.log(Logger::ERROR, "Unable to dispatch conversion event. Error: #{e}")
+      end
     end
 
     private
@@ -156,13 +210,17 @@ module Optimizely
       # Returns boolean representing whether all preconditions are valid.
 
       unless @config.experiment_running?(experiment_key)
-        @logger.log(Logger::INFO, "Experiment '#{experiment_key} is not running.")
+        @logger.log(Logger::INFO, "Experiment '#{experiment_key}' is not running.")
         return false
       end
 
+      if @config.user_in_forced_variation?(experiment_key, user_id)
+        return true
+      end
+
       unless Audience.user_in_experiment?(@config, experiment_key, attributes)
         @logger.log(Logger::INFO,
-                    "User '#{user_id} does not meet the conditions to be in experiment '#{experiment_key}.")
+                    "User '#{user_id}' does not meet the conditions to be in experiment '#{experiment_key}'.")
         return false
       end
 
@@ -180,12 +238,12 @@ module Optimizely
 
     def validate_inputs(datafile, skip_json_validation)
       unless skip_json_validation
-        raise InvalidDatafileError unless Helpers::Validator.datafile_valid?(datafile)
+        raise InvalidInputError.new('datafile') 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)
+      raise InvalidInputError.new('logger') unless Helpers::Validator.logger_valid?(@logger)
+      raise InvalidInputError.new('error_handler') unless Helpers::Validator.error_handler_valid?(@error_handler)
+      raise InvalidInputError.new('event_dispatcher') unless Helpers::Validator.event_dispatcher_valid?(@event_dispatcher)
     end
   end
 end

data/lib/optimizely/event_builder.rb

@@ -274,7 +274,10 @@ module Optimizely
       attributes.keys.each do |attribute_key|
         attribute_value = attributes[attribute_key]
         next unless attribute_value
-        segment_id = @config.attribute_key_map[attribute_key]['segmentId']
+
+        # Skip attributes not in the datafile
+        segment_id = @config.get_segment_id(attribute_key)
+        next unless segment_id
         segment_param = sprintf(ATTRIBUTE_PARAM_FORMAT,
                                 segment_prefix: Params::SEGMENT_PREFIX, segment_id: segment_id)
         params[segment_param] = attribute_value

data/lib/optimizely/exceptions.rb

@@ -25,59 +25,51 @@ module Optimizely
     end
   end
 
-  class InvalidDatafileError < Error
-    # Raised when an invalid datafile is provided
-
-    def initialize(msg = 'Provided datafile is in an invalid format.')
-      super
-    end
-  end
-
-  class InvalidErrorHandlerError < Error
-    # Raised when an invalid error handler is provided
+  class InvalidExperimentError < Error
+    # Raised when an invalid experiment key is provided
 
-    def initialize(msg = 'Provided error_handler is in an invalid format.')
+    def initialize(msg = 'Provided experiment is not in datafile.')
       super
     end
   end
 
-  class InvalidEventDispatcherError < Error
-    # Raised when an invalid event dispatcher is provided
+  class InvalidEventError < Error
+    # Raised when an invalid event key is provided
 
-    def initialize(msg = 'Provided event_dispatcher is in an invalid format.')
+    def initialize(msg = 'Provided event is not in datafile.')
       super
     end
   end
 
-  class InvalidExperimentError < Error
-    # Raised when an invalid experiment key is provided
+  class InvalidVariationError < Error
+    # Raised when an invalid variation key or ID is provided
 
-    def initialize(msg = 'Provided experiment is not in datafile.')
+    def initialize(msg = 'Provided variation is not in datafile.')
       super
     end
   end
 
-  class InvalidGoalError < Error
-    # Raised when an invalid event key is provided
+  class InvalidDatafileError < Error
+    # Raised when a public method fails due to an invalid datafile
 
-    def initialize(msg = 'Provided event is not in datafile.')
-      super
+    def initialize(aborted_method)
+      super("Provided datafile is in an invalid format. Aborting #{aborted_method}.")
     end
   end
 
-  class InvalidLoggerError < Error
-    # Raised when an invalid logger is provided
+  class InvalidDatafileVersionError < Error
+    # Raised when a datafile with an unsupported version is provided
 
-    def initialize(msg = 'Provided logger is in an invalid format.')
+    def initialize(msg = 'Provided datafile is an unsupported version.')
       super
     end
   end
 
-  class InvalidVariationError < Error
-    # Raised when an invalid variation key or ID is provided
+  class InvalidInputError < Error
+    # Abstract error raised when an invalid input is provided during Project instantiation
 
-    def initialize(msg = 'Provided variation is not in datafile.')
-      super
+    def initialize(type)
+      super("Provided #{type} is in an invalid format.")
     end
   end
 end

data/lib/optimizely/project_config.rb

@@ -139,7 +139,7 @@ module Optimizely
       goal = @event_key_map[goal_key]
       return goal['experimentIds'] if goal
       @logger.log Logger::ERROR, "Event '#{goal_key}' is not in datafile."
-      @error_handler.handle_error InvalidGoalError
+      @error_handler.handle_error InvalidEventError
       []
     end
 
@@ -257,6 +257,27 @@ module Optimizely
       nil
     end
 
+    def get_segment_id(attribute_key)
+      attribute = @attribute_key_map[attribute_key]
+      return attribute['segmentId'] if attribute
+      @logger.log Logger::ERROR, "Attribute key '#{attribute_key}' is not in datafile."
+      @error_handler.handle_error InvalidAttributeError
+      nil
+    end
+
+    def user_in_forced_variation?(experiment_key, user_id)
+      # Determines if a given user is in a forced variation
+      #
+      # experiment_key - String experiment key
+      # user_id - String user ID
+      #
+      # Returns true if user is in a forced variation
+
+      forced_variations = get_forced_variations(experiment_key)
+      return forced_variations.include?(user_id) if forced_variations
+      false
+    end
+
     private
 
     def generate_key_map(array, key)

data/lib/optimizely/version.rb

@@ -1,3 +1,3 @@
 module Optimizely
-  VERSION = '0.1.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/start.rb

@@ -0,0 +1,3 @@
+require 'optimizely'
+@df = HTTParty.get('https://cdn.optimizely.com/json/7566680716.json').body
+@o = Optimizely::Project.new(@df, nil, Optimizely::SimpleLogger.new)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Delikat
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,8 +110,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.2
-description: A Ruby SDK for Optimizely's server-side testing product, which is currently
-  in private beta.
+description: A Ruby SDK for Optimizely's Full Stack product.
 email:
 - developers@optimizely.com
 executables: []
@@ -133,6 +132,7 @@ files:
 - lib/optimizely/params.rb
 - lib/optimizely/project_config.rb
 - lib/optimizely/version.rb
+- lib/start.rb
 homepage: https://www.optimizely.com/
 licenses:
 - Apache-2.0