optimizely-sdk 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50614c45e6266670a008909d27b7baf89d443500
-  data.tar.gz: 89c89c31817a26ef93d516d19f406c12be5617f2
+  metadata.gz: 0fde3ad17097c2d63569bade1f3e4095bd8b8d36
+  data.tar.gz: ac971b0cff7db95a591b742a19cc9e9b82e6016d
 SHA512:
-  metadata.gz: 8e443c5554673b3c209d3a8d85135d843db8e417df827a14d414f954f5eb3bbd70804163d948f48beb1174e909427761fd8e19acf77e2c7d7879fbe2dfcca013
-  data.tar.gz: 52e4ec4502499c9a831590ec0557fd418e09e0b89d2c1f11b786d6685cf8533cdf9820937bfa66778f627f8612ab2a45ac1044be79827c83b49ff4efcc942fcf
+  metadata.gz: d6cfdff4bef0344791fea78458ef57d7aa81e7de2fdaf3eb843e8ae6196f72766f0257bdef37a00feeae802390fd6016e8db96e2b90d5484fbd0d2317a94bdb4
+  data.tar.gz: f721214b5c3e6a71fb1ef21609d5180e232720ad201fca0c31b2baf62c925a76aea13c4c75ea9bdb312f2bb1ec555f93b6067e31fe931df4843b95db230c6655

data/lib/optimizely.rb

@@ -31,28 +31,22 @@ require_relative 'optimizely/project_config'
 
 module Optimizely
   class Project
-    # Boolean representing if the instance represents a usable Optimizely Project
-    attr_reader :is_valid
-
-    attr_reader :config
-    attr_reader :decision_service
-    attr_reader :error_handler
-    attr_reader :event_builder
-    attr_reader :event_dispatcher
-    attr_reader :logger
     attr_reader :notification_center
+    # @api no-doc
+    attr_reader :is_valid, :config, :decision_service, :error_handler,
+                :event_builder, :event_dispatcher, :logger
+
+    # Constructor for Projects.
+    #
+    # @param datafile - JSON string representing the project.
+    # @param event_dispatcher - Provides a dispatch_event method which if given a URL and params sends a request to it.
+    # @param logger - Optional component which provides a log method to log messages. By default nothing would be logged.
+    # @param error_handler - Optional component which provides a handle_error method to handle exceptions.
+    #                 By default all exceptions will be suppressed.
+    # @param user_profile_service - Optional component which provides methods to store and retreive user profiles.
+    # @param skip_json_validation - Optional boolean param to skip JSON schema validation of the provided datafile.
 
     def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil, skip_json_validation = false, user_profile_service = nil)
-      # Constructor for Projects.
-      #
-      # datafile - JSON string representing the project.
-      # event_dispatcher - Provides a dispatch_event method which if given a URL and params sends a request to it.
-      # logger - Optional component which provides a log method to log messages. By default nothing would be logged.
-      # error_handler - Optional component which provides a handle_error method to handle exceptions.
-      #                 By default all exceptions will be suppressed.
-      # user_profile_service - Optional component which provides methods to store and retreive user profiles.
-      # 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
@@ -70,35 +64,31 @@ module Optimizely
 
       begin
         @config = ProjectConfig.new(datafile, @logger, @error_handler)
-      rescue
+      rescue StandardError => e
         @is_valid = false
         @logger = SimpleLogger.new
-        @logger.log(Logger::ERROR, InvalidInputError.new('datafile').message)
-        return
-      end
-
-      unless @config.parsing_succeeded?
-        @is_valid = false
-        @logger = SimpleLogger.new
-        @logger.log(Logger::ERROR, InvalidDatafileVersionError.new.message)
+        error_msg = e.class == InvalidDatafileVersionError ? e.message : InvalidInputError.new('datafile').message
+        error_to_handle = e.class == InvalidDatafileVersionError ? InvalidDatafileVersionError : InvalidInputError
+        @logger.log(Logger::ERROR, error_msg)
+        @error_handler.handle_error error_to_handle
         return
       end
 
       @decision_service = DecisionService.new(@config, @user_profile_service)
-      @event_builder = EventBuilder.new(@config, logger)
+      @event_builder = EventBuilder.new(@config, @logger)
       @notification_center = NotificationCenter.new(@logger, @error_handler)
     end
 
-    def activate(experiment_key, user_id, attributes = nil)
-      # Buckets visitor and sends impression event to Optimizely.
-      #
-      # experiment_key - Experiment which needs to be activated.
-      # user_id - String ID for user.
-      # 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, if user is not in experiment, or if datafile is invalid.
+    # Buckets visitor and sends impression event to Optimizely.
+    #
+    # @param experiment_key - Experiment which needs to be activated.
+    # @param user_id - String ID for user.
+    # @param attributes - Hash representing user attributes and values to be recorded.
+    #
+    # @return [Variation Key] representing the variation the user will be bucketed in.
+    # @return [nil] if experiment is not Running, if user is not in experiment, or if datafile is invalid.
 
+    def activate(experiment_key, user_id, attributes = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('activate').message)
         return nil
@@ -125,16 +115,16 @@ module Optimizely
       variation_key
     end
 
-    def get_variation(experiment_key, user_id, attributes = nil)
-      # Gets variation where visitor will be bucketed.
-      #
-      # experiment_key - Experiment for which visitor variation needs to be determined.
-      # user_id - String ID for user.
-      # attributes - Hash representing user attributes.
-      #
-      # Returns variation key where visitor will be bucketed.
-      # Returns nil if experiment is not Running, if user is not in experiment, or if datafile is invalid.
+    # Gets variation where visitor will be bucketed.
+    #
+    # @param experiment_key - Experiment for which visitor variation needs to be determined.
+    # @param user_id - String ID for user.
+    # @param attributes - Hash representing user attributes.
+    #
+    # @return [variation key] where visitor will be bucketed.
+    # @return [nil] if experiment is not Running, if user is not in experiment, or if datafile is invalid.
 
+    def get_variation(experiment_key, user_id, attributes = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('get_variation').message)
         return nil
@@ -161,27 +151,27 @@ module Optimizely
       nil
     end
 
-    def set_forced_variation(experiment_key, user_id, variation_key)
-      # Force a user into a variation for a given experiment.
-      #
-      # experiment_key - String - key identifying the experiment.
-      # user_id - String - The user ID to be used for bucketing.
-      # variation_key - The variation key specifies the variation which the user will
-      #   be forced into. If nil, then clear the existing experiment-to-variation mapping.
-      #
-      # Returns - Boolean - indicates if the set completed successfully.
+    # Force a user into a variation for a given experiment.
+    #
+    # @param experiment_key - String - key identifying the experiment.
+    # @param user_id - String - The user ID to be used for bucketing.
+    # @param variation_key - The variation key specifies the variation which the user will
+    #   be forced into. If nil, then clear the existing experiment-to-variation mapping.
+    #
+    # @return [Boolean] indicates if the set completed successfully.
 
+    def set_forced_variation(experiment_key, user_id, variation_key)
       @config.set_forced_variation(experiment_key, user_id, variation_key)
     end
 
-    def get_forced_variation(experiment_key, user_id)
-      # Gets the forced variation for a given user and experiment.
-      #
-      # experiment_key - String - Key identifying the experiment.
-      # user_id - String - The user ID to be used for bucketing.
-      #
-      # Returns String|nil The forced variation key.
+    # Gets the forced variation for a given user and experiment.
+    #
+    # @param experiment_key - String - Key identifying the experiment.
+    # @param user_id - String - The user ID to be used for bucketing.
+    #
+    # @return [String] The forced variation key.
 
+    def get_forced_variation(experiment_key, user_id)
       forced_variation_key = nil
       forced_variation = @config.get_forced_variation(experiment_key, user_id)
       forced_variation_key = forced_variation['key'] if forced_variation
@@ -189,14 +179,14 @@ module Optimizely
       forced_variation_key
     end
 
-    def track(event_key, user_id, attributes = nil, event_tags = nil)
-      # Send conversion event to Optimizely.
-      #
-      # event_key - Event key representing the event which needs to be recorded.
-      # user_id - String ID for user.
-      # attributes - Hash representing visitor attributes and values which need to be recorded.
-      # event_tags - Hash representing metadata associated with the event.
+    # Send conversion event to Optimizely.
+    #
+    # @param event_key - Event key representing the event which needs to be recorded.
+    # @param user_id - String ID for user.
+    # @param attributes - Hash representing visitor attributes and values which need to be recorded.
+    # @param event_tags - Hash representing metadata associated with the event.
 
+    def track(event_key, user_id, attributes = nil, event_tags = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('track').message)
         return nil
@@ -244,17 +234,18 @@ module Optimizely
       nil
     end
 
+    # Determine whether a feature is enabled.
+    # Sends an impression event if the user is bucketed into an experiment using the feature.
+    #
+    # @param feature_flag_key - String unique key of the feature.
+    # @param user_id - String ID of the user.
+    # @param attributes - Hash representing visitor attributes and values which need to be recorded.
+    #
+    # @return [True] if the feature is enabled.
+    # @return [False] if the feature is disabled.
+    # @return [False] if the feature is not found.
+
     def is_feature_enabled(feature_flag_key, user_id, attributes = nil)
-      # Determine whether a feature is enabled.
-      # Sends an impression event if the user is bucketed into an experiment using the feature.
-      #
-      # feature_flag_key - String unique key of the feature.
-      # userId - String ID of the user.
-      # attributes - Hash representing visitor attributes and values which need to be recorded.
-      #
-      # Returns True if the feature is enabled.
-      #         False if the feature is disabled.
-      #         False if the feature is not found.
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('is_feature_enabled').message)
         return false
@@ -300,14 +291,13 @@ module Optimizely
       end
     end
 
+    # Gets keys of all feature flags which are enabled for the user.
+    #
+    # @param user_id -  ID for user.
+    # @param attributes - Dict representing user attributes.
+    # @return [feature flag keys] A List of feature flag keys that are enabled for the user.
+
     def get_enabled_features(user_id, attributes = nil)
-      # Gets keys of all feature flags which are enabled for the user.
-      # Args:
-      #   user_id: ID for user.
-      #   attributes: Dict representing user attributes.
-      # Returns:
-      #   A List of feature flag keys that are enabled for the user.
-      #
       enabled_features = []
 
       unless @is_valid
@@ -327,17 +317,17 @@ module Optimizely
       enabled_features
     end
 
-    def get_feature_variable_string(feature_flag_key, variable_key, user_id, attributes = nil)
-      # Get the String value of the specified variable in the feature flag.
-      #
-      # feature_flag_key - String key of feature flag the variable belongs to
-      # variable_key - String key of variable for which we are getting the string value
-      # user_id - String user ID
-      # attributes - Hash representing visitor attributes and values which need to be recorded.
-      #
-      # Returns the string variable value.
-      # Returns nil if the feature flag or variable are not found.
+    # Get the String value of the specified variable in the feature flag.
+    #
+    # @param feature_flag_key - String key of feature flag the variable belongs to
+    # @param variable_key - String key of variable for which we are getting the string value
+    # @param user_id - String user ID
+    # @param attributes - Hash representing visitor attributes and values which need to be recorded.
+    #
+    # @return [String] the string variable value.
+    # @return [nil] if the feature flag or variable are not found.
 
+    def get_feature_variable_string(feature_flag_key, variable_key, user_id, attributes = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('get_feature_variable_string').message)
         return nil
@@ -354,17 +344,17 @@ module Optimizely
       variable_value
     end
 
-    def get_feature_variable_boolean(feature_flag_key, variable_key, user_id, attributes = nil)
-      # Get the Boolean value of the specified variable in the feature flag.
-      #
-      # feature_flag_key - String key of feature flag the variable belongs to
-      # variable_key - String key of variable for which we are getting the string value
-      # user_id - String user ID
-      # attributes - Hash representing visitor attributes and values which need to be recorded.
-      #
-      # Returns the boolean variable value.
-      # Returns nil if the feature flag or variable are not found.
+    # Get the Boolean value of the specified variable in the feature flag.
+    #
+    # @param feature_flag_key - String key of feature flag the variable belongs to
+    # @param variable_key - String key of variable for which we are getting the string value
+    # @param user_id - String user ID
+    # @param attributes - Hash representing visitor attributes and values which need to be recorded.
+    #
+    # @return [Boolean] the boolean variable value.
+    # @return [nil] if the feature flag or variable are not found.
 
+    def get_feature_variable_boolean(feature_flag_key, variable_key, user_id, attributes = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('get_feature_variable_boolean').message)
         return nil
@@ -381,17 +371,17 @@ module Optimizely
       variable_value
     end
 
-    def get_feature_variable_double(feature_flag_key, variable_key, user_id, attributes = nil)
-      # Get the Double value of the specified variable in the feature flag.
-      #
-      # feature_flag_key - String key of feature flag the variable belongs to
-      # variable_key - String key of variable for which we are getting the string value
-      # user_id - String user ID
-      # attributes - Hash representing visitor attributes and values which need to be recorded.
-      #
-      # Returns the double variable value.
-      # Returns nil if the feature flag or variable are not found.
+    # Get the Double value of the specified variable in the feature flag.
+    #
+    # @param feature_flag_key - String key of feature flag the variable belongs to
+    # @param variable_key - String key of variable for which we are getting the string value
+    # @param user_id - String user ID
+    # @param attributes - Hash representing visitor attributes and values which need to be recorded.
+    #
+    # @return [Boolean] the double variable value.
+    # @return [nil] if the feature flag or variable are not found.
 
+    def get_feature_variable_double(feature_flag_key, variable_key, user_id, attributes = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('get_feature_variable_double').message)
         return nil
@@ -408,22 +398,21 @@ module Optimizely
       variable_value
     end
 
-    def get_feature_variable_integer(feature_flag_key, variable_key, user_id, attributes = nil)
-      # Get the Integer value of the specified variable in the feature flag.
-      #
-      # feature_flag_key - String key of feature flag the variable belongs to
-      # variable_key - String key of variable for which we are getting the string value
-      # user_id - String user ID
-      # attributes - Hash representing visitor attributes and values which need to be recorded.
-      #
-      # Returns the integer variable value.
-      # Returns nil if the feature flag or variable are not found.
+    # Get the Integer value of the specified variable in the feature flag.
+    #
+    # @param feature_flag_key - String key of feature flag the variable belongs to
+    # @param variable_key - String key of variable for which we are getting the string value
+    # @param user_id - String user ID
+    # @param attributes - Hash representing visitor attributes and values which need to be recorded.
+    #
+    # @return [Integer] variable value.
+    # @return [nil] if the feature flag or variable are not found.
 
+    def get_feature_variable_integer(feature_flag_key, variable_key, user_id, attributes = nil)
       unless @is_valid
         @logger.log(Logger::ERROR, InvalidDatafileError.new('get_feature_variable_integer').message)
         return nil
       end
-
       variable_value = get_feature_variable_for_type(
         feature_flag_key,
         variable_key,

data/lib/optimizely/event_builder.rb

@@ -153,7 +153,7 @@ module Optimizely
 
       event_params = get_common_params(user_id, attributes)
       conversion_params = get_conversion_params(event_key, event_tags, experiment_variation_map)
-      event_params[:visitors][0][:snapshots] = conversion_params
+      event_params[:visitors][0][:snapshots] = [conversion_params]
 
       Event.new(:post, ENDPOINT, event_params, POST_HEADERS)
     end
@@ -195,43 +195,38 @@ module Optimizely
       # event_tags -               +Hash+ Values associated with the event.
       # experiment_variation_map - +Hash+ Map of experiment IDs to bucketed variation IDs
       #
-      # Returns +Hash+ Impression event params
-
-      conversion_event_params = []
+      # Returns +Hash+ Conversion event params
 
+      single_snapshot = {}
+      single_snapshot[:decisions] = []
       experiment_variation_map.each do |experiment_id, variation_id|
-        single_snapshot = {
-          decisions: [{
-            campaign_id: @config.experiment_id_map[experiment_id]['layerId'],
-            experiment_id: experiment_id,
-            variation_id: variation_id
-          }],
-          events: []
-        }
-
-        event_object = {
-          entity_id: @config.event_key_map[event_key]['id'],
-          timestamp: create_timestamp,
-          uuid: create_uuid,
-          key: event_key
-        }
-
-        if event_tags
-          revenue_value = Helpers::EventTagUtils.get_revenue_value(event_tags, @logger)
-          event_object[:revenue] = revenue_value if revenue_value
+        next unless variation_id
+        single_snapshot[:decisions].push(
+          campaign_id: @config.experiment_id_map[experiment_id]['layerId'],
+          experiment_id: experiment_id,
+          variation_id: variation_id
+        )
+      end
 
-          numeric_value = Helpers::EventTagUtils.get_numeric_value(event_tags, @logger)
-          event_object[:value] = numeric_value if numeric_value
+      event_object = {
+        entity_id: @config.event_key_map[event_key]['id'],
+        timestamp: create_timestamp,
+        uuid: create_uuid,
+        key: event_key
+      }
 
-          event_object[:tags] = event_tags
-        end
+      if event_tags
+        revenue_value = Helpers::EventTagUtils.get_revenue_value(event_tags, @logger)
+        event_object[:revenue] = revenue_value if revenue_value
 
-        single_snapshot[:events] = [event_object]
+        numeric_value = Helpers::EventTagUtils.get_numeric_value(event_tags, @logger)
+        event_object[:value] = numeric_value if numeric_value
 
-        conversion_event_params.push(single_snapshot)
+        event_object[:tags] = event_tags unless event_tags.empty?
       end
 
-      conversion_event_params
+      single_snapshot[:events] = [event_object]
+      single_snapshot
     end
 
     def create_timestamp

data/lib/optimizely/event_dispatcher.rb

@@ -25,13 +25,13 @@ module Optimizely
   end
 
   class EventDispatcher
+    # @api constants
     REQUEST_TIMEOUT = 10
 
+    # Dispatch the event being represented by the Event object.
+    #
+    # @param event - Event object
     def dispatch_event(event)
-      # Dispatch the event being represented by the Event object.
-      #
-      # event - Event object
-
       if event.http_verb == :get
         begin
           HTTParty.get(event.url, headers: event.headers, query: event.params, timeout: REQUEST_TIMEOUT)

data/lib/optimizely/exceptions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-2018, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -85,9 +85,8 @@ module Optimizely
   class InvalidDatafileVersionError < Error
     # Raised when a datafile with an unsupported version is provided
 
-    def initialize(msg = 'Provided datafile is an unsupported version. Please use SDK version 1.1.2 or earlier '\
-                  'for datafile version 1.')
-      super
+    def initialize(version)
+      super("This version of the Ruby SDK does not support the given datafile version: #{version}.")
     end
   end
 

data/lib/optimizely/helpers/constants.rb

@@ -321,6 +321,12 @@ module Optimizely
         'BUCKETING_ID' => '$opt_bucketing_id',
         'USER_AGENT' => '$opt_user_agent'
       }.freeze
+
+      SUPPORTED_VERSIONS = {
+        'v2' => '2',
+        'v3' => '3',
+        'v4' => '4'
+      }.freeze
     end
   end
 end

data/lib/optimizely/notification_center.rb

@@ -17,8 +17,8 @@
 #
 module Optimizely
   class NotificationCenter
-    attr_reader :notifications
-    attr_reader :notification_id
+    # @api no-doc
+    attr_reader :notifications, :notification_id
 
     NOTIFICATION_TYPES = {
       ACTIVATE: 'ACTIVATE: experiment, user_id, attributes, variation, event',
@@ -33,18 +33,15 @@ module Optimizely
       @error_handler = error_handler
     end
 
-    def add_notification_listener(notification_type, notification_callback)
-      # Adds notification callback to the notification center
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-      #  notification_callback: function to call when the event is sent
-
-      # Returns:
-      #  notification ID used to remove the notification
+    # Adds notification callback to the notification center
+    #
+    # @param notification_type -  One of the constants in NOTIFICATION_TYPES
+    # @param notification_callback -  Function to call when the event is sent
+    #
+    # @return [notification ID] Used to remove the notification
 
+    def add_notification_listener(notification_type, notification_callback)
       return nil unless notification_type_valid?(notification_type)
-
       unless notification_callback
         @logger.log Logger::ERROR, 'Callback can not be empty.'
         return nil
@@ -64,13 +61,13 @@ module Optimizely
       notification_id
     end
 
-    def remove_notification_listener(notification_id)
-      # Removes previously added notification callback
+    # Removes previously added notification callback
+    #
+    # @param notification_id
+    #
+    # @return [Boolean] The function returns true if found and removed, false otherwise
 
-      # Args:
-      #  notification_id:
-      # Returns:
-      #  The function returns true if found and removed, false otherwise
+    def remove_notification_listener(notification_id)
       unless notification_id
         @logger.log Logger::ERROR, 'Notification ID can not be empty.'
         return nil
@@ -114,13 +111,14 @@ module Optimizely
       @notifications.each_key { |key| @notifications[key] = [] }
     end
 
+    # Sends off the notification for the specific event.  Uses var args to pass in a
+    # arbitrary list of parameters according to which notification type was sent
+    #
+    # @param notification_type - one of the constants in NOTIFICATION_TYPES
+    # @param args - list of arguments to the callback
+    #
+    # @api no-doc
     def send_notifications(notification_type, *args)
-      # Sends off the notification for the specific event.  Uses var args to pass in a
-      # arbitrary list of parameters according to which notification type was sent
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-      #  args: list of arguments to the callback
       return nil unless notification_type_valid?(notification_type)
 
       @notifications[notification_type].each do |notification|

data/lib/optimizely/project_config.rb

@@ -19,10 +19,6 @@ require_relative 'helpers/constants'
 require_relative 'helpers/validator'
 
 module Optimizely
-  V1_CONFIG_VERSION = '1'
-
-  UNSUPPORTED_VERSIONS = [V1_CONFIG_VERSION].freeze
-
   class ProjectConfig
     # Representation of the Optimizely project config.
     RUNNING_EXPERIMENT_STATUS = ['Running'].freeze
@@ -39,7 +35,6 @@ module Optimizely
     attr_reader :experiments
     attr_reader :feature_flags
     attr_reader :groups
-    attr_reader :parsing_succeeded
     attr_reader :project_id
     # Boolean - denotes if Optimizely should remove the last block of visitors' IP address before storing event data
     attr_reader :anonymize_ip
@@ -75,12 +70,11 @@ module Optimizely
 
       config = JSON.parse(datafile)
 
-      @parsing_succeeded = false
       @error_handler = error_handler
       @logger = logger
       @version = config['version']
 
-      return if UNSUPPORTED_VERSIONS.include?(@version)
+      raise InvalidDatafileVersionError, @version unless Helpers::Constants::SUPPORTED_VERSIONS.value?(@version)
 
       @account_id = config['accountId']
       @attributes = config.fetch('attributes', [])
@@ -147,7 +141,6 @@ module Optimizely
       @feature_flag_key_map.each do |key, feature_flag|
         @feature_variable_key_map[key] = generate_key_map(feature_flag['variables'], 'key')
       end
-      @parsing_succeeded = true
     end
 
     def experiment_running?(experiment)
@@ -389,14 +382,6 @@ module Optimizely
       nil
     end
 
-    def parsing_succeeded?
-      # Helper method to determine if parsing the datafile was successful.
-      #
-      # Returns Boolean depending on whether parsing the datafile succeeded or not.
-
-      @parsing_succeeded
-    end
-
     def variation_id_exists?(experiment_id, variation_id)
       # Determines if a given experiment ID / variation ID pair exists in the datafile
       #

data/lib/optimizely/user_profile_service.rb

@@ -21,18 +21,15 @@ module Optimizely
     # Class encapsulating user profile service functionality.
     # Override with your own implementation for storing and retrieving user profiles.
 
-    def lookup(user_id)
-      # Retrieve the Hash user profile associated with a given user ID.
-      #
-      # user_id - String user ID
-      #
-      # Returns Hash user profile.
-    end
+    # Retrieve the Hash user profile associated with a given user ID.
+    #
+    # @param user_id - String user ID
+    # @return [Hash] user profile.
+    def lookup(user_id); end
 
-    def save(user_profile)
-      # Saves a given user profile.
-      #
-      # user_profile - Hash user profile.
-    end
+    # Saves a given user profile.
+    #
+    # @param user_profile - Hash user profile.
+    def save(user_profile); end
   end
 end

data/lib/optimizely/version.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.58.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.58.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement