Deprecating v1 event builder (#42)

Author: aliabbasrizvi

optimizely/event_builder.py

@@ -99,163 +99,7 @@ def _add_common_params(self, user_id, attributes):
     self._add_time()
 
 
-class EventBuilderV1(BaseEventBuilder):
-  """ Class which encapsulates methods to build events for tracking
-  impressions and conversions using the old endpoint. """
-
-  # Attribute mapping format
-  ATTRIBUTE_PARAM_FORMAT = '{segment_prefix}{segment_id}'
-  # Experiment mapping format
-  EXPERIMENT_PARAM_FORMAT = '{experiment_prefix}{experiment_id}'
-  # Event API format
-  OFFLINE_API_PATH = 'https://{project_id}.log.optimizely.com/event'
-
-
-  class EventParams(object):
-    ACCOUNT_ID = 'd'
-    PROJECT_ID = 'a'
-    EXPERIMENT_PREFIX = 'x'
-    GOAL_ID = 'g'
-    GOAL_NAME = 'n'
-    END_USER_ID = 'u'
-    EVENT_VALUE = 'v'
-    SEGMENT_PREFIX = 's'
-    SOURCE = 'src'
-    TIME = 'time'
-
-  def _add_attributes(self, attributes):
-    """ Add attribute(s) information to the event.
-
-    Args:
-      attributes: Dict representing user attributes and values which need to be recorded.
-    """
-
-    if not attributes:
-      return
-
-    for attribute_key in attributes.keys():
-      attribute_value = attributes.get(attribute_key)
-      # Omit falsy attribute values
-      if attribute_value:
-        attribute = self.config.get_attribute(attribute_key)
-        if attribute:
-          self.params[self.ATTRIBUTE_PARAM_FORMAT.format(
-            segment_prefix=self.EventParams.SEGMENT_PREFIX, segment_id=attribute.segmentId)] = attribute_value
-
-  def _add_source(self):
-    """ Add source information to the event. """
-
-    self.params[self.EventParams.SOURCE] = 'python-sdk-{version}'.format(version=version.__version__)
-
-  def _add_time(self):
-    """ Add time information to the event. """
-
-    self.params[self.EventParams.TIME] = int(time.time())
-
-  def _add_impression_goal(self, experiment):
-    """ Add impression goal information to the event.
-
-    Args:
-      experiment: Object representing experiment being activated.
-    """
-
-    # For tracking impressions, goal ID is set equal to experiment ID of experiment being activated
-    self.params[self.EventParams.GOAL_ID] = experiment.id
-    self.params[self.EventParams.GOAL_NAME] = 'visitor-event'
-
-  def _add_experiment(self, experiment, variation_id):
-    """ Add experiment to variation mapping to the impression event.
-
-    Args:
-      experiment: Object representing experiment being activated.
-      variation_id: ID for variation which would be presented to user.
-    """
-
-    self.params[self.EXPERIMENT_PARAM_FORMAT.format(experiment_prefix=self.EventParams.EXPERIMENT_PREFIX,
-                                                    experiment_id=experiment.id)] = variation_id
-
-  def _add_experiment_variation_params(self, user_id, valid_experiments):
-    """ Maps experiment and corresponding variation as parameters to be used in the event tracking call.
-
-    Args:
-      user_id: ID for user.
-      valid_experiments: List of tuples representing valid experiments for the event.
-    """
-
-    for experiment in valid_experiments:
-      variation = self.bucketer.bucket(experiment, user_id)
-      if variation:
-        self.params[self.EXPERIMENT_PARAM_FORMAT.format(experiment_prefix=self.EventParams.EXPERIMENT_PREFIX,
-                                                        experiment_id=experiment.id)] = variation.id
-
-  def _add_conversion_goal(self, event_key, event_value):
-    """ Add conversion goal information to the event.
-
-    Args:
-      event_key: Event key representing the event which needs to be recorded.
-      event_value: Value associated with the event. Can be used to represent revenue in cents.
-    """
-
-    event = self.config.get_event(event_key)
-
-    if not event:
-      return
-
-    event_ids = event.id
-
-    if event_value:
-      event_ids = '{goal_id},{revenue_goal_id}'.format(goal_id=event.id,
-                                                       revenue_goal_id=self.config.get_revenue_goal().id)
-      self.params[self.EventParams.EVENT_VALUE] = event_value
-
-    self.params[self.EventParams.GOAL_ID] = event_ids
-    self.params[self.EventParams.GOAL_NAME] = event_key
-
-  def create_impression_event(self, experiment, variation_id, user_id, attributes):
-    """ Create impression Event to be sent to the logging endpoint.
-
-    Args:
-      experiment: Object representing 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: Dict representing user attributes and values which need to be recorded.
-
-    Returns:
-      Event object encapsulating the impression event.
-    """
-
-    self.params = {}
-    self._add_common_params(user_id, attributes)
-    self._add_impression_goal(experiment)
-    self._add_experiment(experiment, variation_id)
-    return Event(self.OFFLINE_API_PATH.format(project_id=self.params[self.EventParams.PROJECT_ID]),
-                 self.params)
-
-  def create_conversion_event(self, event_key, user_id, attributes, event_tags, valid_experiments):
-    """ Create conversion Event to be sent to the logging endpoint.
-
-    Args:
-      event_key: Event key representing the event which needs to be recorded.
-      user_id: ID for user.
-      attributes: Dict representing user attributes and values.
-      event_tags: Dict representing metadata associated with the event.
-      valid_experiments: List of tuples representing valid experiments for the event.
-
-    Returns:
-      Event object encapsulating the conversion event.
-    """
-
-    event_value = event_tag_utils.get_revenue_value(event_tags)
-
-    self.params = {}
-    self._add_common_params(user_id, attributes)
-    self._add_conversion_goal(event_key, event_value)
-    self._add_experiment_variation_params(user_id, valid_experiments)
-    return Event(self.OFFLINE_API_PATH.format(project_id=self.params[self.EventParams.PROJECT_ID]),
-                 self.params)
-
-
-class EventBuilderV2(BaseEventBuilder):
+class EventBuilder(BaseEventBuilder):
   """ Class which encapsulates methods to build events for tracking 
   impressions and conversions using the new endpoints. """
 
@@ -454,9 +298,7 @@ def get_event_builder(config, bucketer):
   """
 
   config_version = config.get_version()
-  if config_version == project_config.V1_CONFIG_VERSION:
-    return EventBuilderV1(config, bucketer)
   if config_version == project_config.V2_CONFIG_VERSION:
-    return EventBuilderV2(config, bucketer)
+    return EventBuilder(config, bucketer)
 
   raise exceptions.InvalidInputException(enums.Errors.UNSUPPORTED_DATAFILE_VERSION)

tests/base.py

@@ -1,4 +1,4 @@
-# Copyright 2016, Optimizely
+# Copyright 2016-2017, Optimizely
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -17,123 +17,7 @@
 from optimizely import optimizely
 
 
-class BaseTestV1(unittest.TestCase):
-
-  def setUp(self):
-    self.config_dict = {
-      'revision': '42',
-      'version': '1',
-      'events': [{
-        'key': 'test_event',
-        'experimentIds': ['111127'],
-        'id': '111095'
-      }, {
-        'key': 'Total Revenue',
-        'experimentIds': ['111127'],
-        'id': '111096'
-      }],
-      'experiments': [{
-        'key': 'test_experiment',
-        'status': 'Running',
-        'forcedVariations': {
-          'user_1': 'control',
-          'user_2': 'control'
-        },
-        'audienceIds': ['11154'],
-        'trafficAllocation': [{
-          'entityId': '111128',
-          'endOfRange': 4000
-        }, {
-          'entityId': '111129',
-          'endOfRange': 9000
-        }],
-        'id': '111127',
-        'variations': [{
-          'key': 'control',
-          'id': '111128'
-        }, {
-          'key': 'variation',
-          'id': '111129'
-        }]
-      }],
-      'groups': [{
-        'id': '19228',
-        'policy': 'random',
-        'experiments': [{
-          'id': '32222',
-          'key': 'group_exp_1',
-          'status': 'Running',
-          'audienceIds': [],
-          'variations': [{
-            'key': 'group_exp_1_control',
-            'id': '28901'
-          }, {
-            'key': 'group_exp_1_variation',
-            'id': '28902'
-          }],
-          'forcedVariations': {
-            'user_1': 'group_exp_1_control',
-            'user_2': 'group_exp_1_control'
-          },
-          'trafficAllocation': [{
-            'entityId': '28901',
-            'endOfRange': 3000
-          }, {
-            'entityId': '28902',
-            'endOfRange': 9000
-          }]
-        }, {
-          'id': '32223',
-          'key': 'group_exp_2',
-          'status': 'Running',
-          'audienceIds': [],
-          'variations': [{
-            'key': 'group_exp_2_control',
-            'id': '28905'
-          }, {
-            'key': 'group_exp_2_variation',
-            'id': '28906'
-          }],
-          'forcedVariations': {
-            'user_1': 'group_exp_2_control',
-            'user_2': 'group_exp_2_control'
-          },
-          'trafficAllocation': [{
-            'entityId': '28905',
-            'endOfRange': 8000
-          }, {
-            'entityId': '28906',
-            'endOfRange': 10000
-          }]
-        }],
-        'trafficAllocation': [{
-          'entityId': '32222',
-          "endOfRange": 3000
-        }, {
-          'entityId': '32223',
-          'endOfRange': 7500
-        }]
-      }],
-      'accountId': '12001',
-      'dimensions': [{
-        'key': 'test_attribute',
-        'id': '111094',
-        'segmentId': '11133'
-      }],
-      'audiences': [{
-        'name': 'Test attribute users',
-        'conditions': '["and", ["or", ["or", '
-                      '{"name": "test_attribute", "type": "custom_dimension", "value": "test_value"}]]]',
-        'id': '11154'
-      }],
-      'projectId': '111001'
-    }
-
-    self.optimizely = optimizely.Optimizely(json.dumps(self.config_dict))
-    self.project_config = self.optimizely.config
-
-
-class BaseTestV2(unittest.TestCase):
+class BaseTest(unittest.TestCase):
 
   def setUp(self):
     self.config_dict = {

tests/helpers_tests/test_audience.py

@@ -1,4 +1,4 @@
-# Copyright 2016, Optimizely
+# Copyright 2016-2017, Optimizely
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -17,7 +17,7 @@
 from optimizely.helpers import audience
 
 
-class AudienceTest(base.BaseTestV1):
+class AudienceTest(base.BaseTest):
 
   def test_is_match__audience_condition_matches(self):
     """ Test that is_match returns True when audience conditions are met. """

tests/helpers_tests/test_condition.py

@@ -1,4 +1,4 @@
-# Copyright 2016, Optimizely
+# Copyright 2016-2017, Optimizely
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -18,10 +18,10 @@
 from tests import base
 
 
-class ConditionEvaluatorTests(base.BaseTestV1):
+class ConditionEvaluatorTests(base.BaseTest):
 
   def setUp(self):
-    base.BaseTestV1.setUp(self)
+    base.BaseTest.setUp(self)
     self.condition_structure, self.condition_list = condition_helper.loads(
       self.config_dict['audiences'][0]['conditions']
     )
@@ -111,7 +111,7 @@ def test_evaluate__returns_false(self):
     self.assertFalse(self.condition_evaluator.evaluate(condition_structure))
 
 
-class ConditionDecoderTests(base.BaseTestV1):
+class ConditionDecoderTests(base.BaseTest):
 
   def test_loads(self):
     """ Test that loads correctly sets condition structure and list. """

tests/helpers_tests/test_experiment.py

@@ -1,4 +1,4 @@
-# Copyright 2016, Optimizely
+# Copyright 2016-2017, Optimizely
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -18,7 +18,7 @@
 from optimizely.helpers import experiment
 
 
-class ExperimentTest(base.BaseTestV1):
+class ExperimentTest(base.BaseTest):
 
   def test_is_experiment_running__status_running(self):
     """ Test that is_experiment_running returns True when experiment has Running status. """

tests/helpers_tests/test_validator.py

@@ -21,7 +21,7 @@
 from tests import base
 
 
-class ValidatorTest(base.BaseTestV1):
+class ValidatorTest(base.BaseTest):
 
   def test_is_datafile_valid__returns_true(self):
     """ Test that valid datafile returns True. """
@@ -102,7 +102,7 @@ def test_are_event_tags_valid__returns_false(self):
     self.assertFalse(validator.are_event_tags_valid(42))
 
 
-class DatafileV2ValidationTests(base.BaseTestV2):
+class DatafileValidationTests(base.BaseTest):
 
   def test_is_datafile_valid__returns_true(self):
     """ Test that valid datafile returns True. """