Merge pull request #31 from adobe-apiplatform/v2

merge release 2.0.2 to master

Author: adobeDan

HISTORY.md

@@ -0,0 +1,23 @@
+# Version 2.0
+
+First release with functional wrapper and built-in throttling/batching.
+
+### Version 2.0.1
+
+Fast-follow bug fix release:
+
+* [Issue 27](https://github.com/adobe-apiplatform/umapi-client.py/issues/27)
+    * Update parameter names were incorrect.
+    * Test mode wasn't working.
+* [Issue 28](https://github.com/adobe-apiplatform/umapi-client.py/issues/28)
+    * Reuse exisiting open connections across calls.
+
+### Version 2.0.2
+
+Enhancement release:
+
+* [Issue 30](https://github.com/adobe-apiplatform/umapi-client.py/issues/30)
+    * Add control of user-agent header.
+* (No Issue)
+    * Add this HISTORY.md file to summarize releases
+    * Add version.py file to synchronize version between setup and module.

setup.py

@@ -20,8 +20,12 @@
 
 from setuptools import setup, find_packages
 
+version_namespace = {}
+with open('umapi_client/version.py') as f:
+    exec(f.read(), version_namespace)
+
 setup(name='umapi-client',
-      version='2.0.1',
+      version=version_namespace['__version__'],
       description='Client for the User Management API (UMAPI) from Adobe - see https://adobe.ly/2h1pHgV',
       long_description=('The User Management API (aka the UMAPI) is an Adobe-hosted network service '
                         'which provides Adobe Enterprise customers the ability to manage their users.  This '

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/__init__.py

@@ -24,3 +24,4 @@
 from .functional import IdentityTypes, GroupTypes, RoleTypes, IfAlreadyExistsOptions
 from .functional import UserAction, UserQuery, UsersQuery
 from .functional import UserGroupAction, GroupsQuery
+from .version import __version__

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,

umapi_client/version.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2016-2017 Adobe Systems Incorporated.  All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+__version__ = "2.0.2"