Solves #109, extended User-Agent data

Author: petecj2

webexteamssdk/api/__init__.py

@@ -47,6 +47,7 @@
 from .team_memberships import TeamMembershipsAPI
 from .teams import TeamsAPI
 from .webhooks import WebhooksAPI
+import os
 
 
 class WebexTeamsAPI(object):
@@ -68,7 +69,9 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                  client_secret=None,
                  oauth_code=None,
                  redirect_uri=None,
-                 proxies=None):
+                 proxies=None,
+                 be_geo_id=None,
+                 caller=None):
         """Create a new WebexTeamsAPI object.
 
         An access token must be used when interacting with the Webex Teams API.
@@ -112,6 +115,12 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                 OAuth process.
             proxies(dict): Dictionary of proxies passed on to the requests
                 session.
+            be_geo_id(basestring): Optional partner identifier for API usage
+                tracking.  Defaults to checking for a BE_GEO_ID environment
+                variable.
+            caller(basestring): Optional  identifier for API usage tracking.
+                Defaults to checking for a WEBEX_PYTHON_SDK_CALLER environment
+                variable.
 
         Returns:
             WebexTeamsAPI: A new WebexTeamsAPI object.
@@ -131,6 +140,8 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
         check_type(oauth_code, basestring, optional=True)
         check_type(redirect_uri, basestring, optional=True)
         check_type(proxies, dict, optional=True)
+        check_type(be_geo_id, basestring, optional=True)
+        check_type(caller, basestring, optional=True)
 
         access_token = access_token or WEBEX_TEAMS_ACCESS_TOKEN
 
@@ -150,6 +161,10 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
                 redirect_uri=redirect_uri
             ).access_token
 
+        # Set optional API metrics tracking variables from env vars if there
+        be_geo_id = be_geo_id or os.environ.get('BE_GEO_ID')
+        caller = caller or os.environ.get('WEBEX_PYTHON_SDK_CALLER')
+
         # If an access token hasn't been provided as a parameter, environment
         # variable, or obtained via an OAuth exchange raise an error.
         if not access_token:
@@ -168,7 +183,9 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
             base_url=base_url,
             single_request_timeout=single_request_timeout,
             wait_on_rate_limit=wait_on_rate_limit,
-            proxies=proxies
+            proxies=proxies,
+            be_geo_id=be_geo_id,
+            caller=caller
         )
 
         # API wrappers

webexteamssdk/restsession.py

@@ -39,6 +39,10 @@
 from builtins import *
 
 import requests
+import urllib
+import platform
+import sys
+import json
 from past.builtins import basestring
 
 from .config import DEFAULT_SINGLE_REQUEST_TIMEOUT, DEFAULT_WAIT_ON_RATE_LIMIT
@@ -48,6 +52,7 @@
     check_response_code, check_type, extract_and_parse_json, validate_base_url,
 )
 
+from webexteamssdk._version import get_versions
 
 # Helper Functions
 def _fix_next_url(next_url):
@@ -100,7 +105,9 @@ class RestSession(object):
     def __init__(self, access_token, base_url,
                  single_request_timeout=DEFAULT_SINGLE_REQUEST_TIMEOUT,
                  wait_on_rate_limit=DEFAULT_WAIT_ON_RATE_LIMIT,
-                 proxies=None):
+                 proxies=None,
+                 be_geo_id=None,
+                 caller=None):
         """Initialize a new RestSession object.
 
         Args:
@@ -114,6 +121,12 @@ def __init__(self, access_token, base_url,
                 handling.
             proxies(dict): Dictionary of proxies passed on to the requests
                 session.
+            be_geo_id(basestring): Optional partner identifier for API usage
+                tracking.  Defaults to checking for a BE_GEO_ID environment
+                variable.
+            caller(basestring): Optional  identifier for API usage tracking.
+                Defaults to checking for a WEBEX_PYTHON_SDK_CALLER environment
+                variable.
 
         Raises:
             TypeError: If the parameter types are incorrect.
@@ -139,9 +152,60 @@ def __init__(self, access_token, base_url,
         if proxies is not None:
             self._req_session.proxies.update(proxies)
 
+        # Build a User-Agent header
+        ua_base = 'python-webexteams/' + get_versions()['version'] + ' '
+
+        # Generate extended portion of the User-Agent
+        ua_ext = {}
+
+        # Mimic pip system data collection per
+        # https://github.com/pypa/pip/blob/master/src/pip/_internal/network/session.py
+        ua_ext['implementation'] = {
+            "name": platform.python_implementation(),
+        }
+
+        if ua_ext["implementation"]["name"] == 'CPython':
+            ua_ext["implementation"]["version"] = platform.python_version()
+        elif ua_ext["implementation"]["name"] == 'PyPy':
+            if sys.pypy_version_info.releaselevel == 'final':
+                pypy_version_info = sys.pypy_version_info[:3]
+            else:
+                pypy_version_info = sys.pypy_version_info
+            ua_ext["implementation"]["version"] = ".".join(
+                [str(x) for x in pypy_version_info]
+            )
+        elif ua_ext["implementation"]["name"] == 'Jython':
+            ua_ext["implementation"]["version"] = platform.python_version()
+        elif ua_ext["implementation"]["name"] == 'IronPython':
+            ua_ext["implementation"]["version"] = platform.python_version()
+
+        if sys.platform.startswith("darwin") and platform.mac_ver()[0]:
+            dist = {"name": "macOS", "version": platform.mac_ver()[0]}
+            ua_ext["distro"] = dist
+
+        if platform.system():
+            ua_ext.setdefault("system", {})["name"] = platform.system()
+
+        if platform.release():
+            ua_ext.setdefault("system", {})["release"] = platform.release()
+
+        if platform.machine():
+            ua_ext["cpu"] = platform.machine()
+
+        if be_geo_id:
+            ua_ext["be_geo_id"] = be_geo_id
+
+        if caller:
+            ua_ext["caller"] = caller
+
+        # Override the default requests User-Agent but not other headers
+        new_ua = ua_base + urllib.parse.quote(json.dumps(ua_ext))
+        self._req_session.headers['User-Agent'] = new_ua
+
         # Update the headers of the `requests` session
         self.update_headers({'Authorization': 'Bearer ' + access_token,
                              'Content-type': 'application/json;charset=utf-8'})
+        print(self._req_session.headers)
 
     @property
     def base_url(self):