95 lines
3.0 KiB
Python
95 lines
3.0 KiB
Python
|
"""
|
||
|
|
payload.py
|
||
|
|
|
||
|
|
Copyright (c) 2013-2014 Snowplow Analytics Ltd. All rights reserved.
|
||
|
|
|
||
|
|
This program is licensed to you under the Apache License Version 2.0,
|
||
|
|
and you may not use this file except in compliance with the Apache License
|
||
|
|
Version 2.0. You may obtain a copy of the Apache License Version 2.0 at
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0.
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing,
|
||
|
|
software distributed under the Apache License Version 2.0 is distributed on
|
||
|
|
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
||
|
|
express or implied. See the Apache License Version 2.0 for the specific
|
||
|
|
language governing permissions and limitations there under.
|
||
|
|
|
||
|
|
Authors: Anuj More, Alex Dean, Fred Blundun
|
||
|
|
Copyright: Copyright (c) 2013-2014 Snowplow Analytics Ltd
|
||
|
|
License: Apache License Version 2.0
|
||
|
|
"""
|
||
|
|
|
||
|
|
import random
|
||
|
|
import time
|
||
|
|
import json
|
||
|
|
import base64
|
||
|
|
|
||
|
|
|
||
|
|
class Payload:
|
||
|
|
|
||
|
|
def __init__(self, dict_=None):
|
||
|
|
"""
|
||
|
|
Constructor
|
||
|
|
"""
|
||
|
|
|
||
|
|
self.nv_pairs = {}
|
||
|
|
|
||
|
|
if dict_ is not None:
|
||
|
|
for f in dict_:
|
||
|
|
self.nv_pairs[f] = dict_[f]
|
||
|
|
|
||
|
|
|
||
|
|
"""
|
||
|
|
Methods to add to the payload
|
||
|
|
"""
|
||
|
|
|
||
|
|
def add(self, name, value):
|
||
|
|
"""
|
||
|
|
Add a name value pair to the Payload object
|
||
|
|
"""
|
||
|
|
if not (value == "" or value is None):
|
||
|
|
self.nv_pairs[name] = value
|
||
|
|
|
||
|
|
def add_dict(self, dict_, base64=False):
|
||
|
|
"""
|
||
|
|
Add a dict of name value pairs to the Payload object
|
||
|
|
|
||
|
|
:param dict_: Dictionary to be added to the Payload
|
||
|
|
:type dict_: dict(string:*)
|
||
|
|
"""
|
||
|
|
for f in dict_:
|
||
|
|
self.add(f, dict_[f])
|
||
|
|
|
||
|
|
def add_json(self, dict_, encode_base64, type_when_encoded, type_when_not_encoded):
|
||
|
|
"""
|
||
|
|
Add an encoded or unencoded JSON to the payload
|
||
|
|
|
||
|
|
:param dict_: Custom context for the event
|
||
|
|
:type dict_: dict(string:*) | None
|
||
|
|
:param encode_base64: If the payload is base64 encoded
|
||
|
|
:type encode_base64: bool
|
||
|
|
:param type_when_encoded: Name of the field when encode_base64 is set
|
||
|
|
:type type_when_encoded: string
|
||
|
|
:param type_when_not_encoded: Name of the field when encode_base64 is not set
|
||
|
|
:type type_when_not_encoded: string
|
||
|
|
"""
|
||
|
|
|
||
|
|
if dict_ is not None and dict_ != {}:
|
||
|
|
|
||
|
|
json_dict = json.dumps(dict_, ensure_ascii=False)
|
||
|
|
|
||
|
|
if encode_base64:
|
||
|
|
encoded_dict = base64.urlsafe_b64encode(json_dict.encode("ascii"))
|
||
|
|
if not isinstance(encoded_dict, str):
|
||
|
|
encoded_dict = encoded_dict.decode("utf-8")
|
||
|
|
self.add(type_when_encoded, encoded_dict)
|
||
|
|
|
||
|
|
else:
|
||
|
|
self.add(type_when_not_encoded, json_dict)
|
||
|
|
|
||
|
|
def get(self):
|
||
|
|
"""
|
||
|
|
Returns the context dictionary from the Payload object
|
||
|
|
"""
|
||
|
|
return self.nv_pairs
|