Merge pull request #40 from adobe-apiplatform/v2

Fix #38: allow client to give key data directly

Author: adobeDan

.travis.yml

@@ -3,6 +3,7 @@ python:
 - 2.7
 - 3.4
 - 3.5
+- 3.6
 install:
 - pip install --upgrade pip setuptools wheel
 - pip install -r requirements.txt
@@ -16,6 +17,6 @@ deploy:
     secure: nqS9f74jOJZnZ7FqhwpChvP4MlslIF14StxxdYrMuKs0fh6Bcz8O5DROBiEEs9OvM3+cbPkmfkg7PKkZQx4UQTQzYCPKV85YegrQW2WRcwwW3ik6NB5AELphjx3RBMA61p827m7V4vHW67j70+ITDG1joKBNzj7XfQPNma4LtBAxNPsNP9sHaZsWAUAnBvDZ9m7s3mPp2x3t+f9klxaurW7V6NvrjB47r9ln5Ry2JWxHBPKBjJ4XgVVYVQF4HmyrOzszH6xYUVS1KY6S6RUeOl8u/PwSWh3/QH0TvNmVzuZgU/dZxF0JEJbFZvh6+tVNaCcCGYlF+bXkPKbeMEnnPPvaI1RHuUbplPhNWRjVSksAJsznbvYseSg/e7yGJ6ghpsVAySqamMzrpH+U2OJ09czxv3boo9zJm/WWwg069OYkKWyUpNdjgiz0mgYb4KfVak0qhVy3qtbxju4RdCRnxIM2TXF+G/nkUpgtoSFgydgVpMbU2hjj8nonPgesWthFs9KlZocW1epyGySUVvcOcp4KuSvxS3njmA0+knWkAnCvFv7ynCkx7V7CNZvMo49HSMxNGfEs+d12MGIbfqYpIa1van8m4ApOuZ8RhVQq0ZLxVyuORqIDrG1PO7Gg/FFn4objp7e850lBML5ruoMqTmr5FFNSSBXfO/3NQa7l9RM=
   on:
     tags: true
-    python: "3.5"
+    python: "3.6"
     repo: adobe-apiplatform/umapi-client.py
     all_branches: true

HISTORY.md

@@ -52,3 +52,13 @@ Enhancement release:
     * return a new BatchError that has caught exceptions and batch statistics
 * (No Issue)
     * allow User Sync config key names in the connection `auth_dict`
+
+### Version 2.3
+
+Enhancement release:
+
+* [Issue 38](https://github.com/adobe-apiplatform/umapi-client.py/issues/38)
+    * accept private_key_data instead private_key_file
+    * document all accepted `auth_dict` keys
+* (No Issue)
+    * certify for Python 3.6

setup.py

@@ -37,6 +37,7 @@
           'Programming Language :: Python :: 2.7',
           'Programming Language :: Python :: 3.4',
           'Programming Language :: Python :: 3.5',
+          'Programming Language :: Python :: 3.6',
           'License :: OSI Approved :: MIT License',
           'Intended Audience :: Developers',
           'Intended Audience :: System Administrators',

tests/test_live.py

@@ -41,16 +41,26 @@
 @pytest.fixture(scope="module")
 def config():
     with open(config_file_name, "r") as f:
-        config = yaml.load(f)
-    creds = config["test_org"]
+        conf_dict = yaml.load(f)
+    creds = conf_dict["test_org"]
     conn = umapi_client.Connection(org_id=creds["org_id"], auth_dict=creds)
-    return conn, config
+    return conn, conf_dict
 
 
-def test_status(config):
-    conn, _ = config
-    _, status = conn.status(remote=True)
-    logging.info("Server status is %s", status)
+def test_conn_and_status(config):
+    # first create conn using key file, as usual
+    conn1, params = config
+    _, status = conn1.status(remote=True)
+    logging.info("Server connection from key file, status is %s", status)
+    assert status["state"] == "LIVE"
+    # next create conn using key data
+    creds = params["test_org"]
+    key_file = creds.pop("private_key_file")
+    with open(key_file) as f:
+        creds["private_key_data"] = f.read()
+    conn2 = umapi_client.Connection(org_id=creds["org_id"], auth_dict=creds)
+    _, status = conn2.status(remote=True)
+    logging.info("Server connection from key data, status is %s", status)
     assert status["state"] == "LIVE"
 
 
@@ -63,8 +73,8 @@ def test_list_users(config):
         if re.match(r".*@adobe.com$", str(email).lower()):
             assert str(user["type"]) == "adobeID"
         user_count += 1
-        if user_count >= 2000:
-            logging.info("Quitting enumeration after 2000 users.")
+        if user_count >= 600:
+            logging.info("Quitting enumeration after 600 users.")
             break
     logging.info("Found %d users.", user_count)
 

umapi_client/connection.py

@@ -26,6 +26,7 @@
 from time import time, sleep, gmtime, strftime
 
 import requests
+import six
 import six.moves.urllib.parse as urlparse
 
 from .auth import JWT, Auth, AccessRequest
@@ -69,7 +70,12 @@ def __init__(self,
         :param tech_acct_id: string technical account ID from Adobe.IO integration data
         :param api_key: string api_key from Adobe.IO integration data
         :param client_secret: string client secret from Adobe.IO integration data
+        and one of:
         :param private_key_file: path to local private key file that matches Adobe.IO public key for integration
+        or:
+        :param private_key_data: the contents of the private_key_file (PEM format)
+        (NOTE: for compatibility with User Sync config files, the key names priv_key_path and tech_acct
+         are accepted as aliases for private_key_file and tech_acct_id, respectively.)
 
         Optional connection parameters (defaults are for Adobe production):
         :param ims_host: the IMS host which will exchange your JWT for an access token
@@ -121,14 +127,18 @@ def __init__(self,
         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,
+                  tech_acct_id=None, api_key=None, client_secret=None,
+                  private_key_file=None, private_key_data=None,
                   **kwargs):
         tech_acct_id = tech_acct_id or kwargs.get("tech_acct")
         private_key_file = private_key_file or kwargs.get("priv_key_path")
-        if not (tech_acct_id and api_key and client_secret and private_key_file):
+        if not (tech_acct_id and api_key and client_secret and (private_key_data or private_key_file)):
             raise ValueError("Connector create: not all required auth parameters were supplied; please see docs")
-        with open(private_key_file, 'r') as private_key_stream:
-            jwt = JWT(self.org_id, tech_acct_id, ims_host, api_key, private_key_stream)
+        if private_key_data:
+            jwt = JWT(self.org_id, tech_acct_id, ims_host, api_key, six.StringIO(private_key_data))
+        else:
+            with open(private_key_file, 'r') as private_key_stream:
+                jwt = JWT(self.org_id, tech_acct_id, ims_host, api_key, private_key_stream)
         token = AccessRequest("https://" + ims_host + ims_endpoint_jwt, api_key, client_secret, jwt())
         return Auth(api_key, token())
 

umapi_client/version.py

@@ -18,4 +18,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-__version__ = "2.2"
+__version__ = "2.3"