Fix #30: add user-agent header and control thereof.

Author: brotskydotcom

tests/test_connections.py

@@ -27,6 +27,7 @@
 
 from conftest import mock_connection_params, MockResponse
 from umapi_client import Connection, UnavailableError, ServerError, RequestError
+from umapi_client import __version__ as umapi_version
 
 
 def test_remote_status_success():
@@ -52,6 +53,25 @@ def test_remote_status_timeout():
         _, remote_status = conn.status(remote=True)
         assert remote_status["status"].startswith("Unreachable")
 
+def test_ua_string():
+    conn = Connection(**mock_connection_params)
+    req = conn.session.prepare_request(requests.Request('GET', "http://test.com/"))
+    ua_header = req.headers.get("User-Agent")
+    assert ua_header.startswith("umapi-client/" + umapi_version)
+    assert " Python" in ua_header
+    req = conn.session.prepare_request(requests.Request('POST', "http://test.com/", data="This is a test"))
+    ua_header = req.headers.get("User-Agent")
+    assert ua_header.startswith("umapi-client/" + umapi_version)
+    assert " Python" in ua_header
+
+def test_ua_string_additional():
+    conn = Connection(user_agent="additional/1.0", **mock_connection_params)
+    req = conn.session.prepare_request(requests.Request('GET', "http://test.com/"))
+    ua_header = req.headers.get("User-Agent")
+    assert ua_header.startswith("additional/1.0 umapi-client/" + umapi_version)
+    req = conn.session.prepare_request(requests.Request('POST', "http://test.com/", data="This is a test"))
+    ua_header = req.headers.get("User-Agent")
+    assert ua_header.startswith("additional/1.0 umapi-client/" + umapi_version)
 
 def test_get_success():
     with mock.patch("umapi_client.connection.requests.Session.get") as mock_get:

umapi_client/connection.py

@@ -21,6 +21,7 @@
 import json
 import logging
 from email.utils import parsedate_tz, mktime_tz
+from platform import python_version, version as platform_version
 from random import randint
 from time import time, sleep, gmtime, strftime
 
@@ -29,6 +30,7 @@
 
 from .auth import JWT, Auth, AccessRequest
 from .error import UnavailableError, ClientError, RequestError, ServerError
+from .version import __version__ as umapi_version
 
 
 class Connection:
@@ -52,6 +54,7 @@ def __init__(self,
                  timeout_seconds=60.0,
                  throttle_actions=10,
                  throttle_commands=10,
+                 user_agent=None,
                  **kwargs):
         """
         Open a connection for the given parameters that has the given options.
@@ -82,6 +85,7 @@ def __init__(self,
         :param timeout_seconds: How many seconds to wait for server response (default=60, <= 0 or None means forever)
         :param throttle_actions: Max number of actions to pack into a single call
         :param throttle_commands: Max number of commands allowed in a single action
+        :param user_agent: (optional) string to use as User-Agent header (umapi-client/version data will be added)
 
         Additional keywords are allowed to make it easy to pass a big dictionary with other values
         :param kwargs: any keywords passed that we ignore.
@@ -111,6 +115,10 @@ def __init__(self,
         else:
             raise ValueError("Connector create: either auth (an Auth object) or auth_dict (a dictionary) is required")
         self.session = requests.Session()
+        ua_string = "umapi-client/" + umapi_version + " Python/" + python_version() + " (" + platform_version() + ")"
+        if user_agent and user_agent.strip():
+            ua_string = user_agent.strip() + " " + ua_string
+        self.session.headers["User-Agent"] = ua_string
 
     def _get_auth(self, ims_host, ims_endpoint_jwt,
                   tech_acct_id=None, api_key=None, client_secret=None, private_key_file=None,