Remove V1 code (#39)

Author: onufryk

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.
@@ -38,7 +38,6 @@ class Project
     attr_accessor :error_handler
 
     EVENT_BUILDERS_BY_VERSION = {
-      Optimizely::V1_CONFIG_VERSION => EventBuilderV1,
       Optimizely::V2_CONFIG_VERSION => EventBuilderV2
     }
 
@@ -75,14 +74,15 @@ def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = n
         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 = EVENT_BUILDERS_BY_VERSION[@config.version].new(@config, @bucketer)
     end
 
     def activate(experiment_key, user_id, attributes = nil)

lib/optimizely/event_builder.rb

@@ -234,162 +234,4 @@ def add_time
       @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

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 @@ def initialize(aborted_method)
   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