Merge pull request #39 from gfirem/cli-version-header

Appended the new versions to the User-Agent Header

Author: synedra

akamai/edgegrid/edgegrid.py

@@ -28,6 +28,7 @@
 import base64
 import re
 import sys
+import os
 from requests.auth import AuthBase
 from time import gmtime, strftime
 
@@ -159,6 +160,29 @@ def make_content_hash(self, r):
         logger.debug("content hash is '%s'", content_hash)
         return content_hash
 
+    def get_header_versions(self, header=None):
+        if header is None:
+            header = {}
+
+        version_header = ''
+        akamai_cli = os.getenv('AKAMAI_CLI')
+        akamai_cli_version = os.getenv('AKAMAI_CLI_VERSION')
+        if akamai_cli and akamai_cli_version:
+            version_header += " AkamaiCLI/" + akamai_cli_version
+
+        akamai_cli_command = os.getenv('AKAMAI_CLI_COMMAND')
+        akamai_cli_command_version = os.getenv('AKAMAI_CLI_COMMAND_VERSION')
+        if akamai_cli_command and akamai_cli_command_version:
+            version_header += " AkamaiCLI-" + akamai_cli_command + "/" + akamai_cli_command_version
+
+        if version_header != '':
+            if 'User-Agent' not in header:
+                header['User-Agent'] = version_header.strip()
+            else:
+                header['User-Agent'] += version_header
+
+        return header
+
     def make_data_to_sign(self, r, auth_header):
         parsed_url = urlparse(r.url)
 
@@ -167,6 +191,8 @@ def make_data_to_sign(self, r, auth_header):
         else:
             netloc = parsed_url.netloc
 
+        self.get_header_versions(r.headers)
+
         data_to_sign = '\t'.join([
             r.method,
             parsed_url.scheme,

akamai/edgegrid/test/test_edgegrid.py

@@ -145,6 +145,42 @@ def test_edgerc_headers(self):
         auth = EdgeGridAuth.from_edgerc(os.path.join(mydir, 'sample_edgerc'), 'headers')
         self.assertEqual(auth.headers_to_sign, ['x-mything1', 'x-mything2'])
 
+    def test_get_header_versions(self):
+        auth = EdgeGridAuth.from_edgerc(os.path.join(mydir, 'sample_edgerc'), 'headers')
+        header = auth.get_header_versions()
+        self.assertFalse('user-agent' in header)
+
+        header = auth.get_header_versions({'User-Agent': 'testvalue'})
+        self.assertTrue('User-Agent' in header)
+
+        os.environ["AKAMAI_CLI"] = '1.0.0'
+        os.environ["AKAMAI_CLI_VERSION"] = '1.0.0'
+
+        header = auth.get_header_versions()
+        self.assertTrue('User-Agent' in header)
+        self.assertEqual(header['User-Agent'], ' AkamaiCLI/1.0.0')
+
+        os.environ["AKAMAI_CLI_COMMAND"] = '1.0.0'
+        os.environ["AKAMAI_CLI_COMMAND_VERSION"] = '1.0.0'
+
+        header = auth.get_header_versions()
+        self.assertTrue('User-Agent' in header)
+        self.assertEqual(header['User-Agent'], ' AkamaiCLI/1.0.0 AkamaiCLI-1.0.0/1.0.0')
+
+        header = auth.get_header_versions({'User-Agent': 'testvalue'})
+        self.assertTrue('User-Agent' in header)
+        self.assertEqual(header['User-Agent'], 'testvalue AkamaiCLI/1.0.0 AkamaiCLI-1.0.0/1.0.0')
+
+        del os.environ['AKAMAI_CLI']
+        del os.environ['AKAMAI_CLI_VERSION']
+        del os.environ['AKAMAI_CLI_COMMAND']
+        del os.environ['AKAMAI_CLI_COMMAND_VERSION']
+
+        self.assertFalse('AKAMAI_CLI' in os.environ)
+        self.assertFalse('AKAMAI_CLI_VERSION' in os.environ)
+        self.assertFalse('AKAMAI_CLI_COMMAND' in os.environ)
+        self.assertFalse('AKAMAI_CLI_COMMAND_VERSION' in os.environ)
+
     def test_edgerc_from_object(self):
         auth = EdgeGridAuth.from_edgerc(EdgeRc(os.path.join(mydir, 'sample_edgerc')))
         self.assertEqual(auth.client_token, 'xxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx')
@@ -214,6 +250,7 @@ def suite():
     suite.addTest(EGSimpleTest('test_edgerc_broken'))
     suite.addTest(EGSimpleTest('test_edgerc_unparseable'))
     suite.addTest(EGSimpleTest('test_edgerc_headers'))
+    suite.addTest(EGSimpleTest('test_get_header_versions'))
     suite.addTest(EGSimpleTest('test_edgerc_from_object'))
 
     return suite