Merge pull request #55 from akamai/release/1.2.0

Release/1.2.0

Author: robertolopezlopez

HISTORY.rst

@@ -3,6 +3,17 @@
 History
 -------
 
+1.2.0 (2021-08-10)
+++++++++++++++++++
+
+* Bug fixes
+    - `GH#48 <https://github.com/akamai/AkamaiOPEN-edgegrid-python/issues/48>`_ and `GH#50 <https://github.com/akamai/AkamaiOPEN-edgegrid-python/issues/50>`_ issues: recognize the `~` tilde character as home directory alias
+    - `GH#36 <https://github.com/akamai/AkamaiOPEN-edgegrid-python/issues/36>`_, `GH#44 <https://github.com/akamai/AkamaiOPEN-edgegrid-python/issues/44>`_ and `GH#53 <https://github.com/akamai/AkamaiOPEN-edgegrid-python/issues/53>`_ issues: add missing test resource files to PyPI package
+    - `GH#41 <https://github.com/akamai/AkamaiOPEN-edgegrid-python/issues/41>`_: require PyOpenSSL >= v19.0.0 to avoid old OS packages
+
+* Improvements
+    - better Python 2 and Python 3 documentation and related setup.py tags
+
 1.1.0 (2017-09-11)
 ++++++++++++++++++
 

MANIFEST.in

@@ -1 +1 @@
-include README.rst LICENSE requirements.txt akamai/edgegrid/test/testdata.json
+include README.rst LICENSE requirements.txt akamai/edgegrid/test/testdata.json akamai/edgegrid/test/sample_edgerc akamai/edgegrid/test/edgerc_that_doesnt_parse

README.rst

@@ -9,7 +9,7 @@ visit the `Akamai {OPEN} Developer Community`_.
 
     >>> import requests
     >>> from akamai.edgegrid import EdgeGridAuth
-    >>> from urlparse import urljoin
+    >>> from urllib.parse import urljoin
     >>> baseurl = 'https://akaa-WWWWWWWWWWWW.luna.akamaiapis.net/'
     >>> s = requests.Session()
     >>> s.auth = EdgeGridAuth(
@@ -31,7 +31,7 @@ Alternatively, your program can read the credentials from an .edgerc file.
 
     >>> import requests
     >>> from akamai.edgegrid import EdgeGridAuth, EdgeRc
-    >>> from urlparse import urljoin
+    >>> from urllib.parse import urljoin
 
     >>> edgerc = EdgeRc('~/.edgerc')
     >>> section = 'default'
@@ -47,34 +47,50 @@ Alternatively, your program can read the credentials from an .edgerc file.
     Oakbrook, IL, United States
     ...
 
+If you intend to run the above examples with Python 2.7, remember that urljoin is contained in a different package:
+
+.. code-block:: pycon
+
+    >>> from urlparse import urljoin
+
 .. _`requests`: http://docs.python-requests.org
 .. _`Akamai {OPEN} Edgegrid authentication`: https://developer.akamai.com/introduction/Client_Auth.html
 .. _`Akamai {OPEN} Developer Community`: https://developer.akamai.com
 
 Installation
 ------------
 
-Pre-requisite
--------------
-If you are installing on a Linux based distribution, you will need to install the developer libraries for python, ssl and a ffi. On Ubuntu based systems, you will need to do the following:
+**Prerequisite**
+
+For Linux-based distribution, install the developer libraries for Python, SSL and FFI. For example, on Debian-based systems, run:
+
+.. code-block:: bash
+
+    $ sudo apt-get install ibssl-dev libffi-dev python-dev
+
+**To install from pip**
+
+If you are planning to use Python 2, upgrade pip to version 20.3.4, which is the most recent and last version that supports Python 2. Run:"
 
 .. code-block:: bash
-    $ sudo apt-get install ibssl-dev libffi-dev python-dev 
 
+	$ pip install --upgrade 'pip<21.0'
 
-To install from pip:
+To proceed with the installation:
 
 .. code-block:: bash
 
     $ pip install edgegrid-python
 
-To install from sources:
+**To install from sources**
 
 .. code-block:: bash
 
     $ python setup.py install
 
-To run tests:
+**To run tests**
+
+Both Python 2 and Python 3 are supported. This example uses Python 2.7. Run:
 
 .. code-block:: bash
 
@@ -83,6 +99,23 @@ To run tests:
     $ pip install -r requirements.txt
     $ python -m unittest discover
 
+For Python 3.3 or newer, replace the `virtualenv` module with `venv`. Run:
+
+.. code-block:: bash
+
+    $ python3 -m venv venv
+    $ . venv/bin/activate
+    $ pip install -r requirements.txt
+    $ python -m unittest discover
+
+Creating your own .edgerc
+----------
+
+#. Copy the `akamai/edgegrid/test/sample_edgerc` file to your home directory and rename as `.edgerc`.
+#. Edit the copied file and provide your own credentials. For more information on creating an `.edgerc` file, see `Get started  with APIs`_.
+
+.. _`Get started  with APIs`: https://developer.akamai.com/api/getting-started#edgercfile
+
 Contribute
 ----------
 
@@ -100,7 +133,7 @@ Jonathan Landis
 License
 -------
 
-   Copyright 2015 Akamai Technologies, Inc. All rights reserved. 
+   Copyright 2021 Akamai Technologies, Inc. All rights reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

akamai/edgegrid/__init__.py

@@ -2,8 +2,8 @@
 akamai.edgegrid
 ~~~~~~~~~~~~~~~
 
-This library provides an authentication handler for Requests that implements the 
-Akamai {OPEN} EdgeGrid client authentication protocol as 
+This library provides an authentication handler for Requests that implements the
+Akamai {OPEN} EdgeGrid client authentication protocol as
 specified by https://developer.akamai.com/introduction/Client_Auth.html.
 For more information visit https://developer.akamai.com.
 
@@ -32,16 +32,17 @@
 
 from .edgegrid import EdgeGridAuth
 from .edgerc import EdgeRc
-__all__=['EdgeGridAuth', 'EdgeRc']
+__all__ = ['EdgeGridAuth', 'EdgeRc']
 
 __title__ = 'edgegrid-python'
 __version__ = '1.1'
 __author__ = 'Jonathan Landis <[email protected]>'
+__maintainer__ = 'Akamai Developer Experience team <[email protected]>'
 __license__ = 'Apache 2.0'
-__copyright__ = 'Copyright 2014 Akamai Technologies'
+__copyright__ = 'Copyright 2021 Akamai Technologies'
 
-# Copyright 2014 Akamai Technologies, Inc. All Rights Reserved
-# 
+# Copyright 2021 Akamai Technologies, Inc. All Rights Reserved
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

akamai/edgegrid/edgegrid.py

@@ -3,11 +3,12 @@
 # EdgeGrid requests Auth handler
 #
 # Original author: Jonathan Landis <[email protected]>
+# Package maintainer: Akamai Developer Experience team <[email protected]>
 #
 # For more information visit https://developer.akamai.com
 
-# Copyright 2014 Akamai Technologies, Inc. All Rights Reserved
-# 
+# Copyright 2021 Akamai Technologies, Inc. All Rights Reserved
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -20,7 +21,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import requests
 import logging
 import uuid
 import hashlib
@@ -34,33 +34,41 @@
 
 if sys.version_info[0] >= 3:
     # python3
-    from urllib.parse import urlparse, parse_qsl, urlunparse
+    from urllib.parse import urlparse
 else:
     # python2.7
-    from urlparse import urlparse, parse_qsl, urlunparse
+    from urlparse import urlparse
     import urllib3.contrib.pyopenssl
     urllib3.contrib.pyopenssl.inject_into_urllib3()
 
 logger = logging.getLogger(__name__)
 
-__all__=['EdgeGridAuth']
+__all__ = ['EdgeGridAuth']
+
 
 def eg_timestamp():
     return strftime('%Y%m%dT%H:%M:%S+0000', gmtime())
 
+
 def new_nonce():
     return uuid.uuid4()
 
+
 def base64_hmac_sha256(data, key):
     return base64.b64encode(
-        hmac.new(key.encode('utf8'), data.encode('utf8'), hashlib.sha256).digest()
+        hmac.new(
+            key.encode('utf8'),
+            data.encode('utf8'),
+            hashlib.sha256).digest()
     ).decode('utf8')
 
+
 def base64_sha256(data):
     if isinstance(data, str):
         data = data.encode('utf8')
     return base64.b64encode(hashlib.sha256(data).digest()).decode('utf8')
 
+
 class EdgeGridAuth(AuthBase):
     """A Requests authentication handler that provides Akamai {OPEN} EdgeGrid support.
 
@@ -76,15 +84,15 @@ class EdgeGridAuth(AuthBase):
 
     """
 
-    def __init__(self, client_token, client_secret, access_token, 
+    def __init__(self, client_token, client_secret, access_token,
                  headers_to_sign=None, max_body=131072):
-        """Initialize authentication using the given parameters from the Luna Manage APIs
+        """Initialize authentication using the given parameters from the Akamai OPEN APIs
            Interface:
 
         :param client_token: Client token provided by "Credentials" ui
         :param client_secret: Client secret provided by "Credentials" ui
         :param access_token: Access token provided by "Authorizations" ui
-        :param headers_to_sign: An ordered list header names that will be included in 
+        :param headers_to_sign: An ordered list header names that will be included in
             the signature.  This will be provided by specific APIs. (default [])
         :param max_body: Maximum content body size for POST requests. This will be provided by
             specific APIs. (default 131072)
@@ -94,7 +102,7 @@ def __init__(self, client_token, client_secret, access_token,
         self.client_secret = client_secret
         self.access_token = access_token
         if headers_to_sign:
-            self.headers_to_sign = [ h.lower() for h in headers_to_sign ]
+            self.headers_to_sign = [h.lower() for h in headers_to_sign]
         else:
             self.headers_to_sign = []
         self.max_body = max_body
@@ -103,15 +111,15 @@ def __init__(self, client_token, client_secret, access_token,
 
     @staticmethod
     def from_edgerc(rcinput, section='default'):
-        """Returns an EdgeGridAuth object from the configuration from the given section of the 
+        """Returns an EdgeGridAuth object from the configuration from the given section of the
            given edgerc file.
 
-        :param filename: path to the edgerc file
-        :param section: the section to use (this is the [bracketed] part of the edgerc, 
+        :param rcinput: EdgeRc instance or path to the edgerc file
+        :param section: the section to use (this is the [bracketed] part of the edgerc,
             default is 'default')
 
         """
-        from .edgerc import EdgeRc 
+        from .edgerc import EdgeRc
         if isinstance(rcinput, EdgeRc):
             rc = rcinput
         else:
@@ -149,11 +157,13 @@ def make_content_hash(self, r):
             logger.debug("signing content: %s", prepared_body)
             if len(prepared_body) > self.max_body:
                 logger.debug(
-                    "data length %d is larger than maximum %d", 
+                    "data length %d is larger than maximum %d",
                     len(prepared_body), self.max_body
                 )
                 prepared_body = prepared_body[0:self.max_body]
-                logger.debug("data truncated to %d for computing the hash", len(prepared_body))
+                logger.debug(
+                    "data truncated to %d for computing the hash",
+                    len(prepared_body))
 
             content_hash = base64_sha256(prepared_body)
 
@@ -173,7 +183,8 @@ def get_header_versions(self, header=None):
         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
+            version_header += " AkamaiCLI-" + akamai_cli_command + \
+                "/" + akamai_cli_command_version
 
         if version_header != '':
             if 'User-Agent' not in header:
@@ -186,7 +197,7 @@ def get_header_versions(self, header=None):
     def make_data_to_sign(self, r, auth_header):
         parsed_url = urlparse(r.url)
 
-        if (r.headers.get('Host', False)):
+        if r.headers.get('Host', False):
             netloc = r.headers['Host']
         else:
             netloc = parsed_url.netloc
@@ -197,8 +208,10 @@ def make_data_to_sign(self, r, auth_header):
             r.method,
             parsed_url.scheme,
             netloc,
-            # Note: relative URL constraints are handled by requests when it sets up 'r'
-            parsed_url.path + ('?' + parsed_url.query if parsed_url.query else ""),
+            # Note: relative URL constraints are handled by requests when it
+            # sets up 'r'
+            parsed_url.path + \
+            ('?' + parsed_url.query if parsed_url.query else ""),
             self.canonicalize_headers(r),
             self.make_content_hash(r),
             auth_header
@@ -208,7 +221,7 @@ def make_data_to_sign(self, r, auth_header):
 
     def sign_request(self, r, timestamp, auth_header):
         return base64_hmac_sha256(
-            self.make_data_to_sign(r, auth_header), 
+            self.make_data_to_sign(r, auth_header),
             self.make_signing_key(timestamp)
         )
 
@@ -219,7 +232,8 @@ def make_auth_header(self, r, timestamp, nonce):
             ('timestamp', timestamp),
             ('nonce', nonce),
         ]
-        auth_header = "EG1-HMAC-SHA256 " + ';'.join([ "%s=%s" % kvp for kvp in kvps ]) + ';'
+        auth_header = "EG1-HMAC-SHA256 " + \
+            ';'.join(["%s=%s" % kvp for kvp in kvps]) + ';'
         logger.debug('unsigned authorization header: %s', auth_header)
 
         signed_auth_header = auth_header + \

akamai/edgegrid/edgerc.py

@@ -2,8 +2,8 @@
 #
 # support for .edgerc file format
 #
-# Copyright 2014 Akamai Technologies, Inc. All Rights Reserved
-# 
+# Copyright 2021 Akamai Technologies, Inc. All Rights Reserved
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -18,6 +18,7 @@
 
 import logging
 import sys
+from os.path import expanduser
 
 if sys.version_info[0] >= 3:
     # python3
@@ -29,12 +30,19 @@
 
 logger = logging.getLogger(__name__)
 
+
 class EdgeRc(ConfigParser):
     def __init__(self, filename):
-        ConfigParser.__init__(self, {'client_token': '', 'client_secret':'', 'host':'', 'access_token':'','max_body': '131072', 'headers_to_sign': 'None'})
+        ConfigParser.__init__(self,
+                              {'client_token': '',
+                               'client_secret': '',
+                               'host': '',
+                               'access_token': '',
+                               'max_body': '131072',
+                               'headers_to_sign': 'None'})
         logger.debug("loading edgerc from %s", filename)
 
-        self.read(filename)
+        self.read(expanduser(filename))
 
         logger.debug("successfully loaded edgerc")