feat: Add event_batch datamodels.

Author: mjamal@folio3.com

optimizely/event/__init__.py

@@ -0,0 +1,12 @@
+# Copyright 2019, 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

optimizely/event/entity/__init__.py

@@ -0,0 +1,12 @@
+# Copyright 2019, 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

optimizely/event/entity/conversion_event.py

@@ -0,0 +1,25 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from .user_event import UserEvent
+
+
+class ConversionEvent(UserEvent):
+  """ Class representing Conversion Event. """
+
+  def __init__(self, event_context, event, user_id, visitor_attributes, event_tags, bot_filtering=None):
+    self.event_context = event_context
+    self.event = event
+    self.user_id = user_id
+    self.visitor_attributes = visitor_attributes
+    self.event_tags = event_tags
+    self.bot_filtering = bot_filtering

optimizely/event/entity/decision.py

@@ -0,0 +1,19 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class Decision(object):
+  def __init__(self, compaign_id, experiment_id, variation_id):
+    self.campaign_id = compaign_id
+    self.experiment_id = experiment_id
+    self.variation_id = variation_id

optimizely/event/entity/event_batch.py

@@ -0,0 +1,25 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class EventBatch(object):
+  def __init__(self, account_id, project_id, revision, client_name, client_version,
+               anonymize_ip, enrich_decisions, visitors=None):
+    self.account_id = account_id
+    self.project_id = project_id
+    self.revision = revision
+    self.client_name = client_name
+    self.client_version = client_version
+    self.anonymize_ip = anonymize_ip
+    self.enrich_decisions = enrich_decisions
+    self.visitors = visitors

optimizely/event/entity/event_context.py

@@ -0,0 +1,27 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from .. import version
+
+SDK_VERSION = 'python-sdk'
+
+
+class EventContext(object):
+  """ Class respresenting Event Context. """
+
+  def __init__(self, account_id, project_id, revision, anonymize_ip):
+    self.account_id = account_id
+    self.project_id = project_id
+    self.revision = revision
+    self.client_name = SDK_VERSION
+    self.client_version = version.__version__
+    self.anonymize_ip = anonymize_ip

optimizely/event/entity/impression_event.py

@@ -0,0 +1,25 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from .user_event import UserEvent
+
+
+class ImpressionEvent(UserEvent):
+  """ Class representing Impression Event. """
+
+  def __init__(self, event_context, user_id, experiment, visitor_attributes, variation, bot_filtering=None):
+    self.event_context = event_context
+    self.user_id = user_id
+    self.experiment = experiment
+    self.visitor_attributes = visitor_attributes
+    self.variation = variation
+    self.bot_filtering = bot_filtering

optimizely/event/entity/snapshot.py

@@ -0,0 +1,18 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class Snapshot(object):
+  def __init__(self, events, decisions=None):
+    self.events = events
+    self.decisions = decisions

optimizely/event/entity/snapshot_event.py

@@ -0,0 +1,25 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class SnapshotEvent(object):
+  """ Class representing Snapshot Event. """
+
+  def __init__(self, entity_id, uuid, key, timestamp, revenue=None, value=None, tags=None):
+    self.entity_id = entity_id
+    self.uuid = uuid
+    self.key = key
+    self.timestamp = timestamp
+    self.revenue = revenue
+    self.value = value
+    self.tags = tags

optimizely/event/entity/user_event.py

@@ -0,0 +1,29 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import time
+import uuid
+
+
+class UserEvent(object):
+  """ Class respresenting Event Context. """
+
+  def __init__(self, event_context):
+    self.event_context = event_context
+    self.uuid = self._get_uuid()
+    self.timestamp = self._get_time()
+
+  def _get_time(self):
+    return int(round(time.time() * 1000))
+
+  def _get_uuid(self):
+    return str(uuid.uuid4())

optimizely/event/entity/visitor.py

@@ -0,0 +1,19 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class Visitor(object):
+  def __init__(self, snapshots, attributes, visitor_id):
+    self.snapshots = snapshots
+    self.attributes = attributes
+    self.visitor_id = visitor_id

optimizely/event/entity/visitor_attribute.py

@@ -0,0 +1,20 @@
+# Copyright 2019 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
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+class VisitorAttribute(object):
+  def __init__(self, entity_id, key, event_type, value):
+    self.entity_id = entity_id
+    self.key = key
+    self.type = event_type
+    self.value = value