optimizely-sdk 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c74599de62f5c8f5f5dee2484384c5dc7c3de7e8
-  data.tar.gz: 53319f3eb1ab45bab9b609f8e901d5a78ecfb009
+  metadata.gz: c8eff682f4c4c99808f246f2828a4e34e276e54b
+  data.tar.gz: 1c4de8ae37ce421199a1d66ea67c5e9ba78e1c41
 SHA512:
-  metadata.gz: b90f7312495293123be649f29d14fdcf6f4497e3094b160ae7d424bd1e3807a0775971d47473e0cf9a835b48cd7a65ac9b7a22e10670e6c72ae82751e8e1043a
-  data.tar.gz: 478ce61817912292b29d2d9b08e6de617e30f400ef8d5e44f707036692f7d00acb96d409bc52dd0a6d323d15ba6d0c5cd056baab7ad93e439574bec8058b7709
+  metadata.gz: 32ad714501f8b55a48201653de322c2f47e33634d323bb653909307cfc289ceff833ba44508b823ecfe0a4ade94cae2aac8ecca5bd2d6ee350d1ec82977a2a69
+  data.tar.gz: 96297561d1ee0a395d35f8b9878ac71b2c097583442bf7327b01db773ef13b32a5aa223c288beeb10f1da75ff4d713baf511286a150bf5a38cd5ea5e5bf2c1cd

data/lib/optimizely.rb

@@ -1,5 +1,5 @@
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -37,11 +37,6 @@ module Optimizely
     attr_accessor :logger
     attr_accessor :error_handler
 
-    EVENT_BUILDERS_BY_VERSION = {
-      Optimizely::V1_CONFIG_VERSION => EventBuilderV1,
-      Optimizely::V2_CONFIG_VERSION => EventBuilderV2
-    }
-
     def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = nil, skip_json_validation = false)
       # Constructor for Projects.
       #
@@ -58,7 +53,7 @@ module Optimizely
       @event_dispatcher = event_dispatcher || EventDispatcher.new
 
       begin
-        validate_inputs(datafile, skip_json_validation)
+        validate_instantiation_options(datafile, skip_json_validation)
       rescue InvalidInputError => e
         @is_valid = false
         logger = SimpleLogger.new
@@ -75,14 +70,15 @@ module Optimizely
         return
       end
 
-      begin
-        @bucketer = Bucketer.new(@config)
-        @event_builder = EVENT_BUILDERS_BY_VERSION[@config.version].new(@config, @bucketer)
-      rescue
+      unless @config.parsing_succeeded?
         @is_valid = false
         logger = SimpleLogger.new
-        logger.log(Logger::ERROR, InvalidDatafileVersionError.new)
+        logger.log(Logger::ERROR, InvalidDatafileVersionError.new.message)
+        return
       end
+
+      @bucketer = Bucketer.new(@config)
+      @event_builder = EventBuilderV2.new(@config)
     end
 
     def activate(experiment_key, user_id, attributes = nil)
@@ -101,24 +97,15 @@ module Optimizely
         return nil
       end
 
-      if attributes && !attributes_valid?(attributes)
-        @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
-        return nil
-      end
-
-      unless preconditions_valid?(experiment_key, user_id, attributes)
-        @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
-        return nil
-      end
-
-      variation_id = @bucketer.bucket(experiment_key, user_id)
+      variation_key = get_variation(experiment_key, user_id, attributes)
 
-      if not variation_id
+      if variation_key.nil?
         @logger.log(Logger::INFO, "Not activating user '#{user_id}'.")
         return nil
       end
 
       # Create and dispatch impression event
+      variation_id = @config.get_variation_id_from_key(experiment_key, variation_key)
       impression_event = @event_builder.create_impression_event(experiment_key, variation_id, user_id, attributes)
       @logger.log(Logger::INFO,
                   'Dispatching impression event to URL %s with params %s.' % [impression_event.url,
@@ -129,7 +116,7 @@ module Optimizely
         @logger.log(Logger::ERROR, "Unable to dispatch impression event. Error: #{e}")
       end
 
-      @config.get_variation_key_from_id(experiment_key, variation_id)
+      variation_key
     end
 
     def get_variation(experiment_key, user_id, attributes = nil)
@@ -148,24 +135,34 @@ module Optimizely
         return nil
       end
 
-      if attributes && !attributes_valid?(attributes)
+      unless preconditions_valid?(experiment_key, attributes)
         @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
         return nil
       end
 
-      unless preconditions_valid?(experiment_key, user_id, attributes)
-        @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
+      variation_id = @bucketer.get_forced_variation_id(experiment_key, user_id)
+
+      unless variation_id.nil?
+        return @config.get_variation_key_from_id(experiment_key, variation_id)
+      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}'.")
         return nil
       end
 
       variation_id = @bucketer.bucket(experiment_key, user_id)
-      @config.get_variation_key_from_id(experiment_key, variation_id)
+      unless variation_id.nil?
+        return @config.get_variation_key_from_id(experiment_key, variation_id)
+      end
+      nil
     end
 
     def track(event_key, user_id, attributes = nil, event_tags = nil)
       # Send conversion event to Optimizely.
       #
-      # event_key - Goal key representing the event which needs to be recorded.
+      # 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.
@@ -183,34 +180,26 @@ module Optimizely
         @logger.log(Logger::WARN, 'Event value is deprecated in track call. Use event tags to pass in revenue value instead.')
       end
 
-      return nil if attributes && !attributes_valid?(attributes)
-      return nil if event_tags && !event_tags_valid?(event_tags)
+      return nil unless user_inputs_valid?(attributes, event_tags)
 
-      experiment_ids = @config.get_experiment_ids_for_goal(event_key)
+      experiment_ids = @config.get_experiment_ids_for_event(event_key)
       if experiment_ids.empty?
         @config.logger.log(Logger::INFO, "Not tracking user '#{user_id}'.")
         return nil
       end
 
       # Filter out experiments that are not running or that do not include the user in audience conditions
-      valid_experiment_keys = []
-      experiment_ids.each do |experiment_id|
-        experiment_key = @config.experiment_id_map[experiment_id]['key']
-        unless preconditions_valid?(experiment_key, user_id, attributes)
-          @config.logger.log(Logger::INFO, "Not tracking user '#{user_id}' for experiment '#{experiment_key}'.")
-          next
-        end
-        valid_experiment_keys.push(experiment_key)
-      end
+
+      experiment_variation_map = get_valid_experiments_for_event(event_key, user_id, attributes)
 
       # Don't track events without valid experiments attached
-      if valid_experiment_keys.empty?
+      if experiment_variation_map.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_tags, valid_experiment_keys)
+                                                                event_tags, experiment_variation_map)
       @logger.log(Logger::INFO,
                   'Dispatching conversion event to URL %s with params %s.' % [conversion_event.url,
                                                                               conversion_event.params])
@@ -223,7 +212,35 @@ module Optimizely
 
     private
 
-    def preconditions_valid?(experiment_key, user_id, attributes)
+    def get_valid_experiments_for_event(event_key, user_id, attributes)
+      # Get the experiments that we should be tracking for the given event.
+      #
+      # event_key - Event key representing the event which needs to be recorded.
+      # user_id - String ID for user.
+      # attributes - Map of attributes of the user.
+      #
+      # Returns Map where each object contains the ID of the experiment to track and the ID of the variation the user
+      # is bucketed into.
+
+      valid_experiments = {}
+      experiment_ids = @config.get_experiment_ids_for_event(event_key)
+      experiment_ids.each do |experiment_id|
+        experiment_key = @config.get_experiment_key(experiment_id)
+        variation_key = get_variation(experiment_key, user_id, attributes)
+
+        if variation_key.nil?
+          @logger.log(Logger::INFO, "Not tracking user '#{user_id}' for experiment '#{experiment_key}'.")
+          next
+        end
+
+        variation_id = @config.get_variation_id_from_key(experiment_key, variation_key)
+        valid_experiments[experiment_id] = variation_id
+      end
+
+      valid_experiments
+    end
+
+    def preconditions_valid?(experiment_key, attributes = nil, event_tags = nil)
       # Validates preconditions for bucketing a user.
       #
       # experiment_key - String key for an experiment.
@@ -232,18 +249,29 @@ module Optimizely
       #
       # Returns boolean representing whether all preconditions are valid.
 
+      return false unless user_inputs_valid?(attributes, event_tags)
+
       unless @config.experiment_running?(experiment_key)
         @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
+      true
+    end
+
+    def user_inputs_valid?(attributes = nil, event_tags = nil)
+      # Helper method to validate user inputs.
+      #
+      # attributes - Dict representing user attributes.
+      # event_tags - Dict representing metadata associated with an event.
+      #
+      # Returns boolean True if inputs are valid. False otherwise.
+
+      if !attributes.nil? && !attributes_valid?(attributes)
+        return false
       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}'.")
+      if !event_tags.nil? && !event_tags_valid?(event_tags)
         return false
       end
 
@@ -268,7 +296,7 @@ module Optimizely
       true
     end
 
-    def validate_inputs(datafile, skip_json_validation)
+    def validate_instantiation_options(datafile, skip_json_validation)
       unless skip_json_validation
         raise InvalidInputError.new('datafile') unless Helpers::Validator.datafile_valid?(datafile)
       end

data/lib/optimizely/bucketer.rb

@@ -1,5 +1,5 @@
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -43,23 +43,6 @@ module Optimizely
       #
       # Returns String variation ID in which visitor with ID user_id has been placed. Nil if no variation.
 
-      # handle forced variations if applicable
-      forced_variations = @config.get_forced_variations(experiment_key)
-      forced_variation_key = forced_variations[user_id]
-      if forced_variation_key
-        forced_variation_id = @config.get_variation_id_from_key(experiment_key, forced_variation_key)
-        if forced_variation_id
-          @config.logger.log(Logger::INFO, "User '#{user_id}' is forced in variation '#{forced_variation_key}'.")
-          return forced_variation_id
-        else
-          @config.logger.log(
-            Logger::INFO,
-            "Variation key '#{forced_variation_key}' is not in datafile. Not activating user '#{user_id}'."
-          )
-          return nil
-        end
-      end
-
       # check if experiment is in a group; if so, check if user is bucketed into specified experiment
       experiment_id = @config.get_experiment_id(experiment_key)
       group_id = @config.get_experiment_group_id(experiment_key)
@@ -118,6 +101,36 @@ module Optimizely
       nil
     end
 
+    def get_forced_variation_id(experiment_key, user_id)
+      # Determine if a user is forced into a variation for the given experiment and return the id of that variation.
+      #
+      # experiment_key - Key representing the experiment for which user is to be bucketed.
+      # user_id - ID for the user.
+      #
+      # Returns variation ID in which the user with ID user_id is forced into. Nil if no variation.
+
+      forced_variations = @config.get_forced_variations(experiment_key)
+
+      return nil unless forced_variations
+
+      forced_variation_key = forced_variations[user_id]
+
+      return nil unless forced_variation_key
+
+      forced_variation_id = @config.get_variation_id_from_key(experiment_key, forced_variation_key)
+
+      unless forced_variation_id
+        @config.logger.log(
+          Logger::INFO,
+          "Variation key '#{forced_variation_key}' is not in datafile. Not activating user '#{user_id}'."
+        )
+        return nil
+      end
+
+      @config.logger.log(Logger::INFO, "User '#{user_id}' is forced in variation '#{forced_variation_key}'.")
+      forced_variation_id
+    end
+
     private
 
     def find_bucket(bucket_value, traffic_allocations)

data/lib/optimizely/event_builder.rb

@@ -42,12 +42,10 @@ module Optimizely
 
   class BaseEventBuilder
     attr_reader :config
-    attr_reader :bucketer
     attr_accessor :params
 
-    def initialize(config, bucketer)
+    def initialize(config)
       @config = config
-      @bucketer = bucketer
       @params = {}
     end
 
@@ -90,14 +88,14 @@ module Optimizely
       Event.new(:post, IMPRESSION_EVENT_ENDPOINT, @params, POST_HEADERS)
     end
 
-    def create_conversion_event(event_key, user_id, attributes, event_tags, experiment_keys)
+    def create_conversion_event(event_key, user_id, attributes, event_tags, experiment_variation_map)
       # Create conversion Event to be sent to the logging endpoint.
       #
       # event_key - Event key representing the event which needs to be recorded.
       # user_id - ID for user.
       # attributes - Hash representing user attributes and values which need to be recorded.
       # event_tags - Hash representing metadata associated with the event.
-      # experiment_keys - Array of valid experiment keys for the event
+      # experiment_variation_map - Map of experiment ID to the ID of the variation that the user is bucketed into.
       #
       # Returns event hash encapsulating the conversion event.
 
@@ -105,7 +103,7 @@ module Optimizely
       add_common_params(user_id, attributes)
       add_conversion_event(event_key)
       add_event_tags(event_tags)
-      add_layer_states(user_id, experiment_keys)
+      add_layer_states(experiment_variation_map)
       Event.new(:post, CONVERSION_EVENT_ENDPOINT, @params, POST_HEADERS)
     end
 
@@ -206,14 +204,16 @@ module Optimizely
       @params['eventName'] = event_name
     end
 
-    def add_layer_states(user_id, experiment_keys)
+    def add_layer_states(experiments_map)
+      # Add layer states information to the event.
+      #
+      # experiments_map - Hash with experiment ID as a key and variation ID as a value.
+
       @params['layerStates'] = []
 
-      experiment_keys.each do |experiment_key|
-        variation_id = @bucketer.bucket(experiment_key, user_id)
-        experiment_id = @config.experiment_key_map[experiment_key]['id']
+      experiments_map.each do |experiment_id, variation_id|
         layer_state = {
-          'layerId' => @config.experiment_key_map[experiment_key]['layerId'],
+          'layerId' => @config.experiment_id_map[experiment_id]['layerId'],
           'decision' => {
             'variationId' => variation_id,
             'experimentId' => experiment_id,
@@ -234,162 +234,4 @@ module Optimizely
       @params['timestamp'] = (Time.now.to_f * 1000).to_i
     end
   end
-
-  class EventBuilderV1 < BaseEventBuilder
-    # Class which encapsulates methods to build events for tracking impressions and conversions.
-
-    # Attribute mapping format
-    ATTRIBUTE_PARAM_FORMAT = '%{segment_prefix}%{segment_id}'
-
-    # Experiment mapping format
-    EXPERIMENT_PARAM_FORMAT = '%{experiment_prefix}%{experiment_id}'
-
-    # Event endpoint path
-    OFFLINE_API_PATH = 'https://%{project_id}.log.optimizely.com/event'
-
-    def create_impression_event(experiment_key, variation_id, user_id, attributes)
-      # Create conversion Event to be sent to the logging endpoint.
-      #
-      # experiment_key - Experiment for which impression needs to be recorded.
-      # variation_id - ID for variation which would be presented to user.
-      # user_id - ID for user.
-      # attributes - Hash representing user attributes and values which need to be recorded.
-      #
-      # Returns event hash encapsulating the impression event.
-
-      @params = {}
-      add_common_params(user_id, attributes)
-      add_impression_goal(experiment_key)
-      add_experiment(experiment_key, variation_id)
-      Event.new(:get, sprintf(OFFLINE_API_PATH, project_id: @params[Params::PROJECT_ID]), @params, {})
-    end
-
-    def create_conversion_event(event_key, user_id, attributes, event_tags, experiment_keys)
-      # Create conversion Event to be sent to the logging endpoint.
-      #
-      # event_key - Goal key representing the event which needs to be recorded.
-      # user_id - ID for user.
-      # attributes - Hash representing user attributes and values which need to be recorded.
-      # event_tags - Hash representing metadata associated with the event.
-      # experiment_keys - Array of valid experiment keys for the goal
-      #
-      # Returns event hash encapsulating the conversion event.
-
-      @params = {}
-
-      event_value = Helpers::EventTagUtils.get_revenue_value(event_tags)
-
-      add_common_params(user_id, attributes)
-      add_conversion_goal(event_key, event_value)
-      add_experiment_variation_params(user_id, experiment_keys)
-      Event.new(:get, sprintf(OFFLINE_API_PATH, project_id: @params[Params::PROJECT_ID]), @params, {})
-    end
-
-    private
-
-    def add_project_id
-      # Add project ID to the event.
-
-      @params[Params::PROJECT_ID] = @config.project_id
-    end
-
-    def add_account_id
-      # Add account ID to the event.
-
-      @params[Params::ACCOUNT_ID] = @config.account_id
-    end
-
-    def add_user_id(user_id)
-      # Add user ID to the event.
-
-      @params[Params::END_USER_ID] = user_id
-    end
-
-    def add_attributes(attributes)
-      # Add attribute(s) information to the event.
-      #
-      # attributes - Hash representing user attributes and values which need to be recorded.
-
-      return if attributes.nil?
-
-      attributes.keys.each do |attribute_key|
-        attribute_value = attributes[attribute_key]
-        next unless attribute_value
-
-        # 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
-      end
-    end
-
-    def add_source
-      # Add source information to the event.
-
-      @params[Params::SOURCE] = sprintf('ruby-sdk-%{version}', version: VERSION)
-    end
-
-    def add_time
-      # Add time information to the event.
-
-      @params[Params::TIME] = Time.now.strftime('%s').to_i
-    end
-
-    def add_impression_goal(experiment_key)
-      # Add impression goal information to the event.
-      #
-      # experiment_key - Experiment which is being activated.
-
-      # For tracking impressions, goal ID is set equal to experiment ID of experiment being activated.
-      @params[Params::GOAL_ID] = @config.get_experiment_id(experiment_key)
-      @params[Params::GOAL_NAME] = 'visitor-event'
-    end
-
-    def add_experiment(experiment_key, variation_id)
-      # Add experiment to variation mapping to the impression event.
-      #
-      # experiment_key - Experiment which is being activated.
-      # variation_id - ID for variation which would be presented to user.
-
-      experiment_id = @config.get_experiment_id(experiment_key)
-      experiment_param = sprintf(EXPERIMENT_PARAM_FORMAT,
-                                 experiment_prefix: Params::EXPERIMENT_PREFIX, experiment_id: experiment_id)
-      @params[experiment_param] = variation_id
-    end
-
-    def add_experiment_variation_params(user_id, experiment_keys)
-      # Maps experiment and corresponding variation as parameters to be used in the event tracking call.
-      #
-      # user_id - ID for user.
-      # experiment_keys - Array of valid experiment keys for the goal
-
-      experiment_keys.each do |experiment_key|
-        variation_id = @bucketer.bucket(experiment_key, user_id)
-        experiment_id = @config.experiment_key_map[experiment_key]['id']
-        experiment_param = sprintf(EXPERIMENT_PARAM_FORMAT,
-                                   experiment_prefix: Params::EXPERIMENT_PREFIX, experiment_id: experiment_id)
-        @params[experiment_param] = variation_id
-      end
-    end
-
-    def add_conversion_goal(event_key, event_value)
-      # Add conversion goal information to the event.
-      #
-      # event_key - Goal key representing the event which needs to be recorded.
-      # event_value - Value associated with the event. Can be used to represent revenue in cents.
-
-      goal_id = @config.event_key_map[event_key]['id']
-      event_ids = goal_id
-
-      if event_value
-        event_ids = sprintf('%{goal_id},%{revenue_id}', goal_id: goal_id, revenue_id: @config.get_revenue_goal_id)
-        @params[Params::EVENT_VALUE] = event_value
-      end
-
-      @params[Params::GOAL_ID] = event_ids
-      @params[Params::GOAL_NAME] = event_key
-    end
-  end
 end

data/lib/optimizely/exceptions.rb

@@ -1,5 +1,5 @@
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -83,7 +83,7 @@ module Optimizely
   class InvalidDatafileVersionError < Error
     # Raised when a datafile with an unsupported version is provided
 
-    def initialize(msg = 'Provided datafile is an unsupported version.')
+    def initialize(msg = 'Provided datafile is an unsupported version. Please use SDK version 1.1.2 or earlier for datafile version 1.')
       super
     end
   end

data/lib/optimizely/helpers/constants.rb

@@ -1,5 +1,5 @@
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -16,283 +16,6 @@
 module Optimizely
   module Helpers
     module Constants
-      JSON_SCHEMA_V1 = {
-        'type' => 'object',
-        'properties' => {
-          'projectId' => {
-            'type' => 'string'
-          },
-          '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' => {
-              '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',
-                'variations',
-                'trafficAllocation',
-                'audienceIds',
-                'forcedVariations',
-                'status',
-              ]
-            }
-          },
-          'events' => {
-            'type' => 'array',
-            'items' => {
-              'type' => 'object',
-              'properties' => {
-                'key' => {
-                  'type' => 'string'
-                },
-                'experimentIds' => {
-                  'type' => 'array',
-                  'items' => {
-                    'type' => 'string'
-                  }
-                },
-                'id' => {
-                  'type' => 'string'
-                }
-              },
-              'required' => [
-                'key',
-                'experimentIds',
-                'id'
-              ]
-            }
-          },
-          'audiences' => {
-            'type' => 'array',
-            'items' => {
-              'type' => 'object',
-              'properties' => {
-                'id' => {
-                  'type' => 'string'
-                },
-                'name' => {
-                  'type' => 'string'
-                },
-                'conditions' => {
-                  'type' => 'string'
-                }
-              },
-              'required' => [
-                'id',
-                'name',
-                'conditions'
-              ]
-            }
-          },
-          'dimensions' => {
-            'type' => 'array',
-            'items' => {
-              'type' => 'object',
-              'properties' => {
-                'id' => {
-                  'type' => 'string'
-                },
-                'key' => {
-                  'type' => 'string'
-                },
-                'segmentId' => {
-                  'type' => 'string'
-                }
-              },
-              'required' => [
-                'id',
-                'key',
-                'segmentId'
-              ]
-            }
-          },
-          'version' => {
-            'type' => 'string'
-          },
-          'revision' => {
-            'type' => 'string'
-          }
-        },
-        'required' => [
-          'projectId',
-          'accountId',
-          'experiments',
-          'events',
-          'groups',
-          'audiences',
-          'dimensions',
-          'version',
-          'revision'
-        ]
-      }
 
       JSON_SCHEMA_V2 = {
         'type' => 'object',

data/lib/optimizely/helpers/validator.rb

@@ -1,5 +1,5 @@
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -55,13 +55,7 @@ module Optimizely
           return false
         end
 
-        version = datafile['version']
-
-        if version == Optimizely::V1_CONFIG_VERSION
-          JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V1, datafile)
-        else
-          JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V2, datafile)
-        end
+        JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V2, datafile)
       end
 
       def error_handler_valid?(error_handler)

data/lib/optimizely/project_config.rb

@@ -1,5 +1,5 @@
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-2017, 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.
@@ -20,6 +20,9 @@ module Optimizely
   V1_CONFIG_VERSION = '1'
   V2_CONFIG_VERSION = '2'
 
+  SUPPORTED_VERSIONS = [V2_CONFIG_VERSION]
+  UNSUPPORTED_VERSIONS = [V1_CONFIG_VERSION]
+
   class ProjectConfig
     # Representation of the Optimizely project config.
 
@@ -32,6 +35,7 @@ module Optimizely
     attr_reader :error_handler
     attr_reader :logger
 
+    attr_reader :parsing_succeeded
     attr_reader :version
     attr_reader :account_id
     attr_reader :project_id
@@ -59,16 +63,18 @@ module Optimizely
 
       config = JSON.load(datafile)
 
+      @parsing_succeeded = false
       @error_handler = error_handler
       @logger = logger
       @version = config['version']
+
+      if UNSUPPORTED_VERSIONS.include?(@version)
+        return
+      end
+
       @account_id = config['accountId']
       @project_id = config['projectId']
-      if @version == V1_CONFIG_VERSION
-        @attributes = config['dimensions']
-      else
-        @attributes = config['attributes']
-      end
+      @attributes = config['attributes']
       @events = config['events']
       @experiments = config['experiments']
       @revision = config['revision']
@@ -95,6 +101,7 @@ module Optimizely
         @variation_id_map[key] = generate_key_map(variations, 'id')
         @variation_key_map[key] = generate_key_map(variations, 'key')
       end
+      @parsing_succeeded = true
     end
 
     def experiment_running?(experiment_key)
@@ -124,36 +131,30 @@ module Optimizely
       nil
     end
 
-    def get_goal_keys
-      # Retrieves all goals in the project except 'Total Revenue'
+    def get_experiment_key(experiment_id)
+      # Retrieves experiment key for a given ID.
       #
-      # Returns array of all goal keys except 'Total Revenue'
-
-      goal_keys = @event_key_map.keys
-      goal_keys.delete(REVENUE_GOAL_KEY) if goal_keys.include?(REVENUE_GOAL_KEY)
-      goal_keys
-    end
-
-    def get_revenue_goal_id
-      # Get ID of the revenue goal for the project
+      # experiment_id - String ID representing the experiment.
       #
-      # Returns revenue goal ID
+      # Returns String key.
 
-      revenue_goal = @event_key_map[REVENUE_GOAL_KEY]
-      return revenue_goal['id'] if revenue_goal
+      experiment = @experiment_id_map[experiment_id]
+      return experiment['key'] unless experiment.nil?
+      @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError
       nil
     end
 
-    def get_experiment_ids_for_goal(goal_key)
-      # Get experiment IDs for the provided goal key.
+    def get_experiment_ids_for_event(event_key)
+      # Get experiment IDs for the provided event key.
       #
-      # goal_key - Goal key for which experiment IDs are to be retrieved.
+      # event_key - Event key for which experiment IDs are to be retrieved.
       #
-      # Returns array of all experiment IDs for the goal.
+      # Returns array of all experiment IDs for the event.
 
-      goal = @event_key_map[goal_key]
-      return goal['experimentIds'] if goal
-      @logger.log Logger::ERROR, "Event '#{goal_key}' is not in datafile."
+      event = @event_key_map[event_key]
+      return event['experimentIds'] if event
+      @logger.log Logger::ERROR, "Event '#{event_key}' is not in datafile."
       @error_handler.handle_error InvalidEventError
       []
     end
@@ -272,14 +273,6 @@ 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
       #
@@ -293,6 +286,14 @@ module Optimizely
       false
     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
+
     private
 
     def generate_key_map(array, key)

data/lib/optimizely/version.rb

@@ -14,5 +14,5 @@
 #    limitations under the License.
 #
 module Optimizely
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Delikat
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Optimizely's testing framework