Merge pull request #53 from adobe-apiplatform/v2

merge in changes for 2.7 release

Author: adobeDan

HISTORY.md

@@ -100,9 +100,9 @@ Enhancement release:
 * (No Issue)
     * Read the wall clock to return an accurate "total time" in the `UnavailableError` (and associated logging).
 
-### Version 2.6
+### Version 2.6, 2.7
 
-Bug fix release:
+Bug fix releases: The first fix attempt had problems, the second is better.
 
 * [Issue 50](https://github.com/adobe-apiplatform/umapi-client.py/issues/50)
     * Unicode input for email produced error strings that were incorrectly encoded, so clients crashed trying to use them.

tests/test_connections.py

@@ -32,10 +32,10 @@
 
 def test_remote_status_success():
     with mock.patch("umapi_client.connection.requests.Session.get") as mock_get:
-        mock_get.return_value = MockResponse(200, body={"build": "2559", "version": "2.1.54", "state":"LIVE"})
+        mock_get.return_value = MockResponse(200, body={"build": "2559", "version": "2.1.54", "state": "LIVE"})
         conn = Connection(**mock_connection_params)
         _, remote_status = conn.status(remote=True)
-        assert remote_status == {"endpoint": "https://test/", "build": "2559", "version": "2.1.54", "state":"LIVE"}
+        assert remote_status == {"endpoint": "https://test/", "build": "2559", "version": "2.1.54", "state": "LIVE"}
 
 
 def test_remote_status_failure():
@@ -53,6 +53,7 @@ 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/"))
@@ -64,6 +65,7 @@ def test_ua_string():
     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/"))
@@ -73,6 +75,7 @@ def test_ua_string_additional():
     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:
         mock_get.return_value = MockResponse(200, body=["test", "body"])

tests/test_functional.py

@@ -21,8 +21,10 @@
 # SOFTWARE.
 
 import pytest
+import six
 
 from conftest import mock_connection_params
+from umapi_client import ArgumentError
 from umapi_client import Connection
 from umapi_client import IdentityTypes, GroupTypes, RoleTypes
 from umapi_client import UserAction, UserGroupAction
@@ -49,8 +51,15 @@ def test_user_adobeid_unicode():
 
 
 def test_user_adobeid_unicode_error_unicode_dot_above():
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError) as excinfo:
         UserAction(email=u"lwałę[email protected]")
+    assert excinfo.type == ArgumentError
+    if six.PY2:
+        assert excinfo.match(u"lwałę[email protected]".encode('utf8'))
+        with pytest.raises(ValueError) as excinfo:
+            UserAction(email=u"lwałę[email protected]".encode('utf8'))
+        assert excinfo.type == ArgumentError
+        assert excinfo.match(u"lwałę[email protected]".encode('utf8'))
 
 
 def test_user_adobeid_unicode_error_trailing_dot():

tests/test_legacy.py

@@ -36,6 +36,7 @@
 retry_response = MockResponse(429, headers={"Retry-After": "1"})
 not_found_response = MockResponse(404, text="404 Object Not Found")
 
+
 @mock.patch('umapi_client.legacy.requests.Session.get', return_value=success_response)
 def test_list_users_success(_):
     """Test Users List - SUCCESS"""
@@ -173,7 +174,10 @@ def test_action_obj_multi():
         remove=["product3"]
     )
     assert json.dumps(action.wire_dict(), sort_keys=True) == \
-           '{"do": [{"addAdobeID": {"email": "[email protected]"}}, {"add": {"product": ["product1", "product2"]}}, {"remove": {"product": ["product3"]}}], "user": "[email protected]"}'
+           '{"do": [{"addAdobeID": {"email": "[email protected]"}}, ' \
+                   '{"add": {"product": ["product1", "product2"]}}, ' \
+                   '{"remove": {"product": ["product3"]}}], ' \
+            '"user": "[email protected]"}'
 
 
 def test_action_obj_requestid():

tests/test_live.py

@@ -78,6 +78,7 @@ def test_list_users(config):
             break
     logging.info("Found %d users.", user_count)
 
+
 def test_list_groups(config):
     conn, params = config
     groups = umapi_client.GroupsQuery(connection=conn)
@@ -93,6 +94,7 @@ def test_list_groups(config):
     group_count_2 = len(groups.all_results())
     assert group_count == group_count_2
 
+
 def test_get_user(config):
     conn, params = config
     user_query = umapi_client.UserQuery(conn, params["test_user"]["email"])
@@ -101,6 +103,7 @@ def test_get_user(config):
     for k, v in six.iteritems(params["test_user"]):
         assert user[k].lower() == v.lower()
 
+
 def test_rename_user(config):
     conn, params = config
     user = umapi_client.UserAction(id_type=params["test_user"]["type"],

umapi_client/__init__.py

@@ -18,9 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from .connection import Connection
 from .api import Action, QuerySingle, QueryMultiple
-from .error import BatchError, ClientError, RequestError, ServerError, UnavailableError
+from .connection import Connection
+from .error import BatchError, ClientError, RequestError, ServerError, UnavailableError, ArgumentError
 from .functional import IdentityTypes, GroupTypes, RoleTypes, IfAlreadyExistsOptions
 from .functional import UserAction, UserQuery, UsersQuery
 from .functional import UserGroupAction, GroupsQuery

umapi_client/auth.py

@@ -21,7 +21,7 @@
 import datetime as dt
 import time
 
-import jwt      # package name is PyJWT in setup
+import jwt  # package name is PyJWT in setup
 import requests
 import six.moves.urllib.parse as urlparse
 

umapi_client/connection.py

@@ -30,7 +30,7 @@
 import six.moves.urllib.parse as urlparse
 
 from .auth import JWT, Auth, AccessRequest
-from .error import BatchError, UnavailableError, ClientError, RequestError, ServerError
+from .error import BatchError, UnavailableError, ClientError, RequestError, ServerError, ArgumentError
 from .version import __version__ as umapi_version
 
 
@@ -119,7 +119,7 @@ def __init__(self,
         elif auth_dict:
             self.auth = self._get_auth(ims_host=ims_host, ims_endpoint_jwt=ims_endpoint_jwt, **auth_dict)
         else:
-            raise ValueError("Connector create: either auth (an Auth object) or auth_dict (a dictionary) is required")
+            raise ArgumentError("Connector create: either auth (an Auth object) or auth_dict (a dict) is required")
         self.session = requests.Session()
         ua_string = "umapi-client/" + umapi_version + " Python/" + python_version() + " (" + platform_version() + ")"
         if user_agent and user_agent.strip():
@@ -133,7 +133,7 @@ def _get_auth(self, ims_host, ims_endpoint_jwt,
         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_data or private_key_file)):
-            raise ValueError("Connector create: not all required auth parameters were supplied; please see docs")
+            raise ArgumentError("Connector create: not all required auth parameters were supplied; please see docs")
         if private_key_data:
             jwt = JWT(self.org_id, tech_acct_id, ims_host, api_key, six.StringIO(private_key_data))
         else:
@@ -196,7 +196,7 @@ def query_single(self, object_type, url_params, query_params=None):
         query_type = object_type + "s"  # poor man's plural
         query_path = "/organizations/{}/{}".format(self.org_id, query_type)
         for component in url_params if url_params else []:
-            query_path += "/" + urlparse.quote(component)
+            query_path += "/" + urlparse.quote(component, safe='/@')
         if query_params: query_path += "?" + urlparse.urlencode(query_params)
         try:
             result = self.make_call(query_path)

umapi_client/error.py

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+import six
+
 
 class UnavailableError(Exception):
     def __init__(self, attempts, seconds, result):
@@ -52,3 +54,10 @@ def __init__(self, causes, queued, sent, completed):
         Exception.__init__(self, prefix + tail)
         self.causes = causes
         self.statistics = (queued, sent, completed)
+
+
+class ArgumentError(ValueError):
+    def __init__(self, message):
+        if six.PY2 and isinstance(message, unicode):
+            message = message.encode('utf8')
+        ValueError.__init__(self, message)