149 lines
4.7 KiB
Python
149 lines
4.7 KiB
Python
|
"""
|
||
|
|
subject.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
|
||
|
|
"""
|
||
|
|
|
||
|
|
SUPPORTED_PLATFORMS = set(["pc", "tv", "mob", "cnsl", "iot", "web", "srv", "app"])
|
||
|
|
DEFAULT_PLATFORM = "pc"
|
||
|
|
|
||
|
|
|
||
|
|
class Subject(object):
|
||
|
|
"""
|
||
|
|
Class for an event subject, where we view events as of the form
|
||
|
|
|
||
|
|
(Subject) -> (Verb) -> (Object)
|
||
|
|
"""
|
||
|
|
def __init__(self):
|
||
|
|
|
||
|
|
self.standard_nv_pairs = {"p": DEFAULT_PLATFORM}
|
||
|
|
|
||
|
|
def set_platform(self, value):
|
||
|
|
"""
|
||
|
|
:param value: One of ["pc", "tv", "mob", "cnsl", "iot", "web", "srv", "app"]
|
||
|
|
:type value: supported_platform
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["p"] = value
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_user_id(self, user_id):
|
||
|
|
"""
|
||
|
|
:param user_id: User ID
|
||
|
|
:type user_id: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["uid"] = user_id
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_screen_resolution(self, width, height):
|
||
|
|
"""
|
||
|
|
:param width: Width of the screen
|
||
|
|
:param height: Height of the screen
|
||
|
|
:type width: int,>0
|
||
|
|
:type height: int,>0
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["res"] = "".join([str(width), "x", str(height)])
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_viewport(self, width, height):
|
||
|
|
"""
|
||
|
|
:param width: Width of the viewport
|
||
|
|
:param height: Height of the viewport
|
||
|
|
:type width: int,>0
|
||
|
|
:type height: int,>0
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["vp"] = "".join([str(width), "x", str(height)])
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_color_depth(self, depth):
|
||
|
|
"""
|
||
|
|
:param depth: Depth of the color on the screen
|
||
|
|
:type depth: int
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["cd"] = depth
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_timezone(self, timezone):
|
||
|
|
"""
|
||
|
|
:param timezone: Timezone as a string
|
||
|
|
:type timezone: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["tz"] = timezone
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_lang(self, lang):
|
||
|
|
"""
|
||
|
|
Set language.
|
||
|
|
|
||
|
|
:param lang: Language the application is set to
|
||
|
|
:type lang: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["lang"] = lang
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_domain_user_id(self, duid):
|
||
|
|
"""
|
||
|
|
Set the domain user ID
|
||
|
|
|
||
|
|
:param duid: Domain user ID
|
||
|
|
:type duid: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["duid"] = duid
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_ip_address(self, ip):
|
||
|
|
"""
|
||
|
|
Set the domain user ID
|
||
|
|
|
||
|
|
:param ip: IP address
|
||
|
|
:type ip: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["ip"] = ip
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_useragent(self, ua):
|
||
|
|
"""
|
||
|
|
Set the user agent
|
||
|
|
|
||
|
|
:param ua: User agent
|
||
|
|
:type ua: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["ua"] = ua
|
||
|
|
return self
|
||
|
|
|
||
|
|
def set_network_user_id(self, nuid):
|
||
|
|
"""
|
||
|
|
Set the network user ID field
|
||
|
|
This overwrites the nuid field set by the collector
|
||
|
|
|
||
|
|
:param nuid: Network user ID
|
||
|
|
:type nuid: string
|
||
|
|
:rtype: subject
|
||
|
|
"""
|
||
|
|
self.standard_nv_pairs["tnuid"] = nuid
|
||
|
|
return self
|