Merge pull request #26 from adobe-apiplatform/v2

adobeDan · web-flow · commit 4bfa16b1a872 · 2017-01-13T17:50:22.000-08:00
Merge v2 release into master
diff --git a/docs/usage-instructions-v2.md b/docs/usage-instructions-v2.md
@@ -226,7 +226,7 @@ users from user groups and product configuration groups.  Because each
 operation specifier returns the user, it's easy to chain the together:
 
 ```python
-user2.add_group(groups=["Photoshop", "Illustrator"]).remove_group(groups=["CC All Apps"])
+user2.add_to_groups(groups=["Photoshop", "Illustrator"]).remove_from_groups(groups=["CC All Apps"])
 ```
 
 The details of all the possible commands are specified in the code,
diff --git a/setup.py b/setup.py
@@ -21,7 +21,7 @@
 from setuptools import setup, find_packages
 
 setup(name='umapi-client',
-      version='2.0rc2',
+      version='2.0',
       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 '
diff --git a/tests/test_connections.py b/tests/test_connections.py
@@ -26,7 +26,7 @@
 import requests
 
 from conftest import mock_connection_params, MockResponse
-from umapi_client import Connection, UnavailableError, ServerError, RequestError, ClientError
+from umapi_client import Connection, UnavailableError, ServerError, RequestError
 
 
 def test_remote_status_success():
diff --git a/tests/test_functional.py b/tests/test_functional.py
@@ -20,18 +20,20 @@
 
 import pytest
 
-from umapi_client import IdentityTypes
-from umapi_client import UserAction
+from umapi_client import IdentityTypes, GroupTypes, RoleTypes
+from umapi_client import UserAction, UserGroupAction
 
 
 def test_user_emptyid():
     with pytest.raises(ValueError):
-        user = UserAction(id_type=IdentityTypes.federatedID)
+        UserAction(id_type=IdentityTypes.federatedID)
 
 
 def test_user_adobeid():
     user = UserAction(email="dbrotsky@adobe.com")
-    assert user.wire_dict() == {"do": [], "user": "dbrotsky@adobe.com"}
+    assert user.wire_dict() == {"do": [],
+                                "user": "dbrotsky@adobe.com",
+                                "useAdobeID": True}
 
 
 def test_user_enterpriseid():
@@ -41,7 +43,7 @@ def test_user_enterpriseid():
 
 def test_user_enterpriseid_username():
     with pytest.raises(ValueError):
-        user = UserAction(id_type=IdentityTypes.enterpriseID, username="dbrotsky", domain="o.on-the-side.net")
+        UserAction(id_type=IdentityTypes.enterpriseID, username="dbrotsky", domain="o.on-the-side.net")
 
 
 def test_user_federatedid():
@@ -58,7 +60,8 @@ def test_create_user_adobeid():
     user = UserAction(email="dbrotsky@adobe.com")
     user.create()
     assert user.wire_dict() == {"do": [{"addAdobeID": {"email": "dbrotsky@adobe.com"}}],
-                                "user": "dbrotsky@adobe.com"}
+                                "user": "dbrotsky@adobe.com",
+                                "useAdobeID": True}
 
 
 def test_create_user_adobeid_country():
@@ -95,7 +98,7 @@ def test_create_user_federatedid_username():
 
 
 def test_create_user_federatedid_username_email():
-    user = UserAction(id_type=IdentityTypes.federatedID,username="dbrotsky", domain="k.on-the-side.net",
+    user = UserAction(id_type=IdentityTypes.federatedID, username="dbrotsky", domain="k.on-the-side.net",
                       email="dbrotsky@k.on-the-side.net")
     user.create(first_name="Daniel", last_name="Brotsky", country="US")
     assert user.wire_dict() == {"do": [{"createFederatedID": {"email": "dbrotsky@k.on-the-side.net",
@@ -131,38 +134,77 @@ def test_update_user_federatedid_username():
                                 "user": "dbrotsky@k.on-the-side.net"}
 
 
-def test_add_product_federatedid():
+def test_add_org_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
+    user.add_to_groups()
+    assert user.wire_dict() == {"do": [{"add": {"product": []}}],
+                                "user": "dbrotsky@k.on-the-side.net"}
+
+
+def test_add_products_federatedid():
     user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
-    user.add_group(groups=["Photoshop", "Illustrator"])
+    user.add_to_groups(groups=["Photoshop", "Illustrator"])
     assert user.wire_dict() == {"do": [{"add": {"product": ["Photoshop", "Illustrator"]}}],
                                 "user": "dbrotsky@k.on-the-side.net"}
 
 
-def test_remove_product_federatedid():
+def test_add_to_groups_federatedid_all():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
+    user.add_to_groups(all_groups=True)
+    assert user.wire_dict() == {"do": [{"add": "all"}],
+                                "user": "dbrotsky@k.on-the-side.net"}
+
+
+def test_add_to_groups_federatedid_all_error():
+    user = UserAction(id_type="federatedID", email="dbrotsky@k.on-the-side.net")
+    with pytest.raises(ValueError):
+        user.add_to_groups(all_groups=True, groups=["Photoshop"])
+
+
+def test_add_to_usergroups_federatedid():
+    user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
+    user.add_to_groups(groups=["Photoshop", "Illustrator"], group_type=GroupTypes.usergroup)
+    assert user.wire_dict() == {"do": [{"add": {"usergroup": ["Photoshop", "Illustrator"]}}],
+                                "user": "dbrotsky@k.on-the-side.net"}
+
+
+def test_remove_from_products_federatedid():
     user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
-    user.remove_group(groups=["Photoshop", "Illustrator"])
+    user.remove_from_groups(groups=["Photoshop", "Illustrator"], group_type="product")
     assert user.wire_dict() == {"do": [{"remove": {"product": ["Photoshop", "Illustrator"]}}],
                                 "user": "dbrotsky@k.on-the-side.net"}
 
 
-def test_remove_product_federatedid_all():
+def test_remove_from_groups_federatedid_all():
     user = UserAction(id_type='federatedID', email="dbrotsky@k.on-the-side.net")
-    user.remove_group(all_groups=True)
+    user.remove_from_groups(all_groups=True)
     assert user.wire_dict() == {"do": [{"remove": "all"}],
                                 "user": "dbrotsky@k.on-the-side.net"}
 
 
+def test_remove_from_groups_federatedid_all_error():
+    user = UserAction(id_type='federatedID', email="dbrotsky@k.on-the-side.net")
+    with pytest.raises(ValueError):
+        user.remove_from_groups(all_groups=True, group_type="usergroup")
+
+
 def test_add_role_enterpriseid():
     user = UserAction(id_type=IdentityTypes.enterpriseID, email="dbrotsky@o.on-the-side.net")
     user.add_role(groups=["Photoshop", "Illustrator"])
     assert user.wire_dict() == {"do": [{"addRoles": {"admin": ["Photoshop", "Illustrator"]}}],
                                 "user": "dbrotsky@o.on-the-side.net"}
 
 
+def test_add_role_enterpriseid_error():
+    user = UserAction(id_type=IdentityTypes.enterpriseID, email="dbrotsky@o.on-the-side.net")
+    with pytest.raises(ValueError):
+        user.add_role(groups=[], role_type=RoleTypes.admin)
+
+
 def test_remove_role_enterpriseid():
     user = UserAction(id_type='enterpriseID', email="dbrotsky@o.on-the-side.net")
-    user.remove_role(groups=["Photoshop", "Illustrator"])
-    assert user.wire_dict() == {"do": [{"removeRoles": {"admin": ["Photoshop", "Illustrator"]}}],
+    user.remove_role(groups=["Photoshop", "Illustrator"], role_type="productAdmin")
+    assert user.wire_dict() == {"do": [{"removeRoles": {"productAdmin": ["Photoshop", "Illustrator"]}}],
                                 "user": "dbrotsky@o.on-the-side.net"}
 
 
@@ -177,13 +219,14 @@ def test_remove_from_organization_adobeid():
     user = UserAction(id_type='adobeID', email="dbrotsky@adobe.com")
     user.remove_from_organization()
     assert user.wire_dict() == {"do": [{"removeFromOrg": {}}],
-                                "user": "dbrotsky@adobe.com"}
+                                "user": "dbrotsky@adobe.com",
+                                "useAdobeID": True}
 
 
 def test_remove_from_organization_delete_federatedid():
     user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
     user.remove_from_organization(delete_account=True)
-    assert user.wire_dict() == {"do": [{"removeFromOrg": {"removedDomain": "k.on-the-side.net"}}],
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {}}, {"removeFromDomain": {}}],
                                 "user": "dbrotsky@k.on-the-side.net"}
 
 
@@ -196,11 +239,77 @@ def test_remove_from_organization_delete_adobeid():
 def test_delete_account_enterpriseid():
     user = UserAction(id_type=IdentityTypes.enterpriseID, email="dbrotsky@o.on-the-side.net")
     user.delete_account()
-    assert user.wire_dict() == {"do": [{"removeFromDomain": {"domain": "o.on-the-side.net"}}],
+    assert user.wire_dict() == {"do": [{"removeFromDomain": {}}],
                                 "user": "dbrotsky@o.on-the-side.net"}
 
 
 def test_delete_account_adobeid():
     user = UserAction(id_type=IdentityTypes.adobeID, email="dbrotsky@adobe.com")
     with pytest.raises(ValueError):
         user.delete_account()
+
+
+def test_add_to_products():
+    group = UserGroupAction(group_name="SampleUsers")
+    group.add_to_products(products=["Photoshop", "Illustrator"])
+    assert group.wire_dict() == {"do": [{"add": {"product": ["Photoshop", "Illustrator"]}}],
+                                 "usergroup": "SampleUsers"}
+
+
+def test_add_to_products_all():
+    group = UserGroupAction(group_name="SampleUsers")
+    group.add_to_products(all_products=True)
+    assert group.wire_dict() == {"do": [{"add": "all"}],
+                                 "usergroup": "SampleUsers"}
+
+
+def test_add_to_products_all_error():
+    group = UserGroupAction(group_name="SampleUsers")
+    with pytest.raises(ValueError):
+        group.add_to_products(all_products=True, products=["Photoshop"])
+
+
+def test_remove_from_products():
+    group = UserGroupAction(group_name="SampleUsers")
+    group.remove_from_products(products=["Photoshop", "Illustrator"])
+    assert group.wire_dict() == {"do": [{"remove": {"product": ["Photoshop", "Illustrator"]}}],
+                                 "usergroup": "SampleUsers"}
+
+
+def test_remove_from_products_all():
+    group = UserGroupAction(group_name="SampleUsers")
+    group.remove_from_products(all_products=True)
+    assert group.wire_dict() == {"do": [{"remove": "all"}],
+                                 "usergroup": "SampleUsers"}
+
+
+def test_remove_from_products_all_error():
+    group = UserGroupAction(group_name="SampleUsers")
+    with pytest.raises(ValueError):
+        group.remove_from_products(all_products=True, products=["Photoshop"])
+
+
+def test_add_users():
+    group = UserGroupAction(group_name="SampleUsers")
+    group.add_users(users=["user1@example.com", "user2@mydomain.net"])
+    assert group.wire_dict() == {"do": [{"add": {"user": ["user1@example.com", "user2@mydomain.net"]}}],
+                                 "usergroup": "SampleUsers"}
+
+
+def test_add_users_error():
+    group = UserGroupAction(group_name="SampleUsers")
+    with pytest.raises(ValueError):
+        group.add_users(users=[])
+
+
+def test_remove_users():
+    group = UserGroupAction(group_name="SampleUsers")
+    group.remove_users(users=["user1@example.com", "user2@mydomain.net"])
+    assert group.wire_dict() == {"do": [{"remove": {"user": ["user1@example.com", "user2@mydomain.net"]}}],
+                                 "usergroup": "SampleUsers"}
+
+
+def test_remove_users_error():
+    group = UserGroupAction(group_name="SampleUsers")
+    with pytest.raises(ValueError):
+        group.remove_users(users=[])
diff --git a/umapi_client/__init__.py b/umapi_client/__init__.py
@@ -23,4 +23,4 @@
 from .error import ClientError, RequestError, ServerError, UnavailableError
 from .functional import IdentityTypes, GroupTypes, RoleTypes, IfAlreadyExistsOptions
 from .functional import UserAction, UserQuery, UsersQuery
-from .functional import GroupsQuery
+from .functional import UserGroupAction, GroupsQuery
diff --git a/umapi_client/api.py b/umapi_client/api.py
@@ -18,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import re
-
 import six
 
 from .connection import Connection
@@ -49,14 +47,14 @@ def split(self, max_commands):
         :param max_commands: max number of commands allowed in any action
         :return: the list of commands created from this one
         """
-        prior = Action(**self.frame)
-        prior.commands = list(self.commands)
-        self.split_actions = [prior]
-        while len(prior.commands) > max_commands:
-            next = Action(**self.frame)
-            prior.commands, next.commands = prior.commands[0:max_commands], prior.commands[max_commands:]
-            self.split_actions.append(next)
-            prior = next
+        a_prior = Action(**self.frame)
+        a_prior.commands = list(self.commands)
+        self.split_actions = [a_prior]
+        while len(a_prior.commands) > max_commands:
+            a_next = Action(**self.frame)
+            a_prior.commands, a_next.commands = a_prior.commands[0:max_commands], a_prior.commands[max_commands:]
+            self.split_actions.append(a_next)
+            a_prior = a_next
         return self.split_actions
 
     def wire_dict(self):
diff --git a/umapi_client/connection.py b/umapi_client/connection.py
@@ -41,9 +41,9 @@ def __init__(self,
                  org_id,
                  auth_dict=None,
                  auth=None,
-                 ims_host='ims-na1.adobelogin.com',
-                 ims_endpoint_jwt='/ims/exchange/jwt/',
-                 user_management_endpoint='https://usermanagement.adobe.io/v2/usermanagement',
+                 ims_host="ims-na1.adobelogin.com",
+                 ims_endpoint_jwt="/ims/exchange/jwt/",
+                 user_management_endpoint="https://usermanagement.adobe.io/v2/usermanagement",
                  test_mode=False,
                  logger=logging.getLogger("umapi_client"),
                  retry_max_attempts=4,
@@ -79,6 +79,9 @@ def __init__(self,
         :param retry_max_attempts: How many times to retry on temporary errors
         :param retry_first_delay: The time to delay first retry (grows exponentially from there)
         :param retry_random_delay: The max random delay to add on each exponential backoff retry
+        :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
 
         Additional keywords are allowed to make it easy to pass a big dictionary with other values
         :param kwargs: any keywords passed that we ignore.
@@ -90,7 +93,7 @@ def __init__(self,
         self.retry_max_attempts = retry_max_attempts
         self.retry_first_delay = retry_first_delay
         self.retry_random_delay = retry_random_delay
-        self.timeout = float(timeout_seconds) if float(timeout_seconds) > 0.0 else 60.0
+        self.timeout = float(timeout_seconds) if timeout_seconds and float(timeout_seconds) > 0.0 else None
         self.throttle_actions = max(int(throttle_actions), 1)
         self.throttle_commands = max(int(throttle_commands), 1)
         self.action_queue = []
diff --git a/umapi_client/functional.py b/umapi_client/functional.py
