Release version 1.0.0 (#14)

* Add CLA to CONTRIBUTING (#11)

* Improve exception handling (#10)

* Properly handle attributes not in V1 datafiles (#12)

* Bump version to 1.0.0

* Update gemspec

Author: delikat

CHANGELOG

@@ -1,3 +1,11 @@
+-------------------------------------------------------------------------------
+1.0.0
+* Introduce support for Full Stack projects in Optimizely X with no breaking changes from previous version.
+* Introduce more graceful exception handling in instantiation and core methods.
+* Update whitelisting to take precedence over audience condition evaluation.
+* Fix bug activating/tracking with an attribute not in the datafile.
+-------------------------------------------------------------------------------
+
 -------------------------------------------------------------------------------
 0.1.2
 * Add support for V2 datafile and event endpoint.

CONTRIBUTING.md

@@ -1,13 +1,13 @@
 #Contributing to the Optimizely Ruby SDK
-We welcome contributions and feedback! Please read the [README](README.md) to set up your development environment, then read the guidelines below for information on submitting your code.
+We welcome contributions and feedback! All contributors must sign our [Contributor License Agreement (CLA)](https://docs.google.com/a/optimizely.com/forms/d/e/1FAIpQLSf9cbouWptIpMgukAKZZOIAhafvjFCV8hS00XJLWQnWDFtwtA/viewform) to be eligible to contribute. Please read the [README](README.md) to set up your development environment, then read the guidelines below for information on submitting your code.
 
 ##Development process
 
-1. Create a branch off of `master`: `git checkout -b YOUR_NAME/branch_name`.
+1. Create a branch off of `devel`: `git checkout -b YOUR_NAME/branch_name`.
 2. Commit your changes. Make sure to add tests!
 3. `git push` your changes to GitHub.
-4. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `master`.
-5. Open a pull request from `YOUR_NAME/branch_name` to `master`.
+4. Make sure that all unit tests are passing and that there are no merge conflicts between your branch and `devel`.
+5. Open a pull request from `YOUR_NAME/branch_name` to `devel`.
 6. A repository maintainer will review your pull request and, if all goes well, merge it!
 
 ##Pull request acceptance criteria

README.md

@@ -1,6 +1,6 @@
 #Optimizely Ruby SDK
 
-This repository houses the Ruby SDK for Optimizely's server-side testing product, which is currently in private beta.
+This repository houses the Ruby SDK for Optimizely's Full Stack product.
 
 ##Getting Started
 
@@ -13,7 +13,7 @@ gem install optimizely-sdk
 ```
 
 ###Using the SDK
-See the Optimizely server-side testing [developer documentation](http://developers.optimizely.com/server/reference/index.html) to learn how to set up your first custom project and use the SDK. **Please note that you must be a member of the private server-side testing beta to create custom projects and use this SDK.**
+See the Optimizely Full Stack [developer documentation](http://developers.optimizely.com/server/reference/index.html) to learn how to set up your first Full Stack project and use the SDK.
 
 ##Development
 

lib/optimizely.rb

@@ -11,6 +11,10 @@
 
 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 @@ def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = n
       #                 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 @@ def activate(experiment_key, user_id, attributes = nil)
       # 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 @@ def activate(experiment_key, user_id, attributes = nil)
       @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 @@ def get_variation(experiment_key, user_id, attributes = nil)
       # 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 @@ def track(event_key, user_id, attributes = nil, event_value = nil)
       # 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 @@ def track(event_key, user_id, attributes = nil, event_value = nil)
       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,7 +210,7 @@ def preconditions_valid?(experiment_key, user_id, attributes)
       # 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
 
@@ -166,7 +220,7 @@ def preconditions_valid?(experiment_key, user_id, attributes)
 
       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
 
@@ -184,12 +238,12 @@ def attributes_valid?(attributes)
 
     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

lib/optimizely/event_builder.rb

@@ -274,7 +274,10 @@ def add_attributes(attributes)
       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

lib/optimizely/exceptions.rb

@@ -25,59 +25,51 @@ def initialize(msg = 'Attributes provided are in an invalid format.')
     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

lib/optimizely/project_config.rb

@@ -139,7 +139,7 @@ def get_experiment_ids_for_goal(goal_key)
       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,14 @@ def get_attribute_id(attribute_key)
       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
       #

lib/optimizely/version.rb

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

optimizely-sdk.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["developers@optimizely.com"]
 
   spec.summary       = "Ruby SDK for Optimizely's testing framework"
-  spec.description   = "A Ruby SDK for Optimizely's server-side testing product, which is currently in private beta."
+  spec.description   = "A Ruby SDK for Optimizely's Full Stack testing product."
   spec.homepage      = "https://www.optimizely.com/"
   spec.license       = "Apache-2.0"
 

spec/project_config_spec.rb

@@ -300,7 +300,7 @@
 
     describe 'get_experiment_ids_for_goal' do
       it 'should raise an error when provided goal key is invalid' do
-        expect { config.get_experiment_ids_for_goal('invalid_key') }.to raise_error(Optimizely::InvalidGoalError)
+        expect { config.get_experiment_ids_for_goal('invalid_key') }.to raise_error(Optimizely::InvalidEventError)
       end
     end