finish the local testing: this fixes #10 completely.

Now we just need some live testing of the functional stuff and we are at beta1.

Author: brotskydotcom

tests/test_functional.py

@@ -0,0 +1,190 @@
+# Copyright (c) 2016 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.
+
+import pytest
+
+from umapi_client import IdentityTypes
+from umapi_client import UserAction
+
+
+def test_user_adobeid():
+    user = UserAction(email="[email protected]")
+    assert user.wire_dict() == {"do": [], "user": "[email protected]"}
+
+
+def test_user_enterpriseid():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="[email protected]")
+    assert user.wire_dict() == {"do": [], "user": "[email protected]"}
+
+
+def test_user_enterpriseid_username():
+    with pytest.raises(ValueError):
+        user = UserAction(id_type=IdentityTypes.enterpriseID, username="dbrotsky", domain="o.on-the-side.net")
+
+
+def test_user_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    assert user.wire_dict() == {"do": [], "user": "[email protected]"}
+
+
+def test_user_federatedid_username():
+    user = UserAction(id_type=IdentityTypes.federatedID, username="dbrotsky", domain="k.on-the-side.net")
+    assert user.wire_dict() == {"do": [], "user": "dbrotsky", "domain": "k.on-the-side.net"}
+
+
+def test_create_user_adobeid():
+    user = UserAction(email="[email protected]")
+    user.create()
+    assert user.wire_dict() == {"do": [{"addAdobeID": {"email": "[email protected]"}}],
+                                "user": "[email protected]"}
+
+
+def test_create_user_adobeid_country():
+    user = UserAction(email="[email protected]")
+    with pytest.raises(ValueError):
+        user.create(country="US")
+
+
+def test_create_user_enterpriseid():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="[email protected]")
+    user.create(first_name="Daniel", last_name="Brotsky")
+    assert user.wire_dict() == {"do": [{"createEnterpriseID": {"email": "[email protected]",
+                                                               "firstName": "Daniel", "lastName": "Brotsky",
+                                                               "country": "UD"}}],
+                                "user": "[email protected]"}
+
+
+def test_create_user_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.create(first_name="Daniel", last_name="Brotsky", country="US")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "[email protected]",
+                                                              "firstName": "Daniel", "lastName": "Brotsky",
+                                                              "country": "US"}}],
+                                "user": "[email protected]"}
+
+
+def test_create_user_federatedid_username():
+    user = UserAction(id_type=IdentityTypes.federatedID, username="dbrotsky", domain="k.on-the-side.net")
+    user.create(first_name="Daniel", last_name="Brotsky", country="US", email="[email protected]")
+    assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "[email protected]",
+                                                              "firstName": "Daniel", "lastName": "Brotsky",
+                                                              "country": "US"}}],
+                                "user": "dbrotsky", "domain": "k.on-the-side.net"}
+
+
+def test_create_user_federatedid_username_mismatch():
+    user = UserAction(id_type=IdentityTypes.federatedID, username="dbrotsky", domain="k.on-the-side.net")
+    with pytest.raises(ValueError):
+        user.create(first_name="Daniel", last_name="Brotsky", country="US", email="[email protected]")
+
+
+def test_update_user_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.update(first_name="Johnny", last_name="Danger")
+    assert user.wire_dict() == {"do": [{"update": {"firstName": "Johnny", "lastName": "Danger"}}],
+                                "user": "[email protected]"}
+
+
+def test_update_user_enterpriseid_username():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="[email protected]")
+    with pytest.raises(ValueError):
+        user.update(username="dbrotsky1")
+
+
+def test_update_user_federatedid_username():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.update(username="dbrotsky1")
+    assert user.wire_dict() == {"do": [{"update": {"username": "dbrotsky1"}}],
+                                "user": "[email protected]"}
+
+
+def test_add_product_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.add_group(groups=["Photoshop", "Illustrator"])
+    assert user.wire_dict() == {"do": [{"add": {"product": ["Photoshop", "Illustrator"]}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_product_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.remove_group(groups=["Photoshop", "Illustrator"])
+    assert user.wire_dict() == {"do": [{"remove": {"product": ["Photoshop", "Illustrator"]}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_product_federatedid_all():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.remove_group(all_groups=True)
+    assert user.wire_dict() == {"do": [{"remove": "all"}],
+                                "user": "[email protected]"}
+
+
+def test_add_role_enterpriseid():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="[email protected]")
+    user.add_role(groups=["Photoshop", "Illustrator"])
+    assert user.wire_dict() == {"do": [{"addRoles": {"admin": ["Photoshop", "Illustrator"]}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_role_enterpriseid():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="[email protected]")
+    user.remove_role(groups=["Photoshop", "Illustrator"])
+    assert user.wire_dict() == {"do": [{"removeRoles": {"admin": ["Photoshop", "Illustrator"]}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_from_organization_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.remove_from_organization()
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_from_organization_adobeid():
+    user = UserAction(id_type=IdentityTypes.adobeID, email="[email protected]")
+    user.remove_from_organization()
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_from_organization_delete_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
+    user.remove_from_organization(delete_account=True)
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {"removedDomain": "k.on-the-side.net"}}],
+                                "user": "[email protected]"}
+
+
+def test_remove_from_organization_delete_adobeid():
+    user = UserAction(id_type=IdentityTypes.adobeID, email="[email protected]")
+    with pytest.raises(ValueError):
+        user.remove_from_organization(delete_account=True)
+
+
+def test_delete_account_enterpriseid():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="[email protected]")
+    user.delete_account()
+    assert user.wire_dict() == {"do": [{"removeFromDomain": {"domain": "o.on-the-side.net"}}],
+                                "user": "[email protected]"}
+
+
+def test_delete_account_adobeid():
+    user = UserAction(id_type=IdentityTypes.adobeID, email="[email protected]")
+    with pytest.raises(ValueError):
+        user.delete_account()

umapi_client/__init__.py

@@ -20,6 +20,7 @@
 
 from .connection import Connection
 from .api import Action, QuerySingle, QueryMultiple
-from .users import UserAction, UserQuery, UsersQuery, IdentityTypes, GroupTypes, RoleTypes, IfAlreadyExistsOptions
-from .groups import GroupsQuery
 from .error import ClientError, RequestError, ServerError, UnavailableError
+from .functional import IdentityTypes, GroupTypes, RoleTypes, IfAlreadyExistsOptions
+from .functional import UserAction, UserQuery, UsersQuery
+from .functional import GroupsQuery

umapi_client/connection.py

@@ -81,7 +81,7 @@ def __init__(self,
         :param retry_random_delay: The max random delay to add on each exponential backoff retry
 
         Additional keywords are allowed to make it easy to pass a big dictionary with other values
-        :param kwargs:
+        :param kwargs: any keywords passed that we ignore.
         """
         self.org_id = str(org_id)
         self.endpoint = user_management_endpoint
@@ -133,7 +133,6 @@ def status(self, remote=False):
         as well as data about version and build.  The server data is
         cached, unless the remote flag is specified.
 
-        :param local: whether to include the local status in the return
         :param remote: whether to query the server for its latest status
         :return: tuple of status dicts: (local, server).
         """
@@ -359,6 +358,7 @@ def call():
                 return requests.get(self.endpoint + path, auth=self.auth, timeout=self.timeout)
 
         total_time = wait_time = 0
+        result = None
         for num_attempts in range(1, self.retry_max_attempts + 1):
             if wait_time > 0:
                 sleep(wait_time)
@@ -368,7 +368,7 @@ def call():
                 result = call()
             except requests.Timeout:
                 total_time += int(self.timeout)
-                raise UnavailableError(num_attempts, total_time, None)
+                raise UnavailableError(num_attempts, total_time, result)
             if result.status_code == 200:
                 return result
             elif result.status_code in [429, 502, 503, 504]: