added User-Agent support to help debug calls - should have been done on day zero - oh well

Author: mahtin

CloudFlare/cloudflare.py

@@ -5,7 +5,7 @@
 import requests
 
 from logger import Logger
-from utils import sanitize_secrets
+from utils import user_agent, sanitize_secrets
 from read_configs import read_configs
 from api_v4 import api_v4
 from api_extras import api_extras
@@ -27,6 +27,7 @@ def __init__(self, email, token, certtoken, base_url, debug, raw):
             self.certtoken = certtoken
             self.base_url = base_url
             self.raw = raw
+            self.user_agent = user_agent()
 
             if debug:
                 self.logger = Logger(debug).getLogger()
@@ -42,6 +43,7 @@ def call_with_no_auth(self, method,
             """ Cloudflare v4 API"""
 
             headers = {
+                'User-Agent': self.user_agent,
                 'Content-Type': 'application/json'
             }
             return self._call(method, headers,
@@ -60,6 +62,7 @@ def call_with_auth(self, method,
             if self.email is '' or self.token is '':
                 raise CloudFlareAPIError(0, 'no email and/or token defined')
             headers = {
+                'User-Agent': self.user_agent,
                 'X-Auth-Email': self.email,
                 'X-Auth-Key': self.token,
                 'Content-Type': 'application/json'
@@ -80,6 +83,7 @@ def call_with_certauth(self, method,
             if self.certtoken is '' or self.certtoken is None:
                 raise CloudFlareAPIError(0, 'no cert token defined')
             headers = {
+                'User-Agent': self.user_agent,
                 'X-Auth-User-Service-Key': self.certtoken,
                 'Content-Type': 'application/json'
             }

CloudFlare/utils.py

@@ -1,5 +1,18 @@
 """ misc utilities  for Cloudflare API"""
 
+import sys
+import requests
+from __init__ import __version__
+
+def user_agent():
+    """ misc utilities  for Cloudflare API"""
+    # the default User-Agent is something like 'python-requests/2.11.1'
+    # this additional data helps support @ Cloudflare help customers
+    return ('python-cloudflare/' + __version__ + '/' +
+            'python-requests/' + str(requests.__version__) + '/' +
+            'python/' + '.'.join(map(str, sys.version_info[:3]))
+           )
+
 def sanitize_secrets(secrets):
     """ misc utilities  for Cloudflare API"""
     redacted_phrase = 'REDACTED'