roles are long-deprecated

Author: adorton-adobe

tests/test_connections.py

@@ -30,7 +30,7 @@
 
 from umapi_client import Connection
 from umapi_client import ArgumentError, UnavailableError, ServerError, RequestError
-from umapi_client import UserAction, GroupTypes, IdentityTypes, RoleTypes, UserGroupAction
+from umapi_client import UserAction, GroupTypes, IdentityTypes, UserGroupAction
 from umapi_client import __version__ as umapi_version
 from umapi_client.auth import JWTAuth
 
@@ -456,15 +456,6 @@ def test_split_add_user():
                                 'user': 'user@example.com'}
 
 
-def test_split_role_assignment():
-    group_prefix = "G"
-    add_groups = [group_prefix+str(n+1) for n in range(0, 25)]
-    user = UserAction(id_type=IdentityTypes.enterpriseID, email="user@example.com")
-    user.add_role(groups=add_groups, role_type=RoleTypes.admin)
-    assert user.maybe_split_groups(10) is True
-    assert len(user.commands) == 3
-
-
 def test_no_group_split():
     """
     maybe_split should return false if nothing was split

tests/test_functional.py

@@ -25,7 +25,7 @@
 from conftest import MockResponse
 from umapi_client import ArgumentError, RequestError
 from umapi_client import Connection
-from umapi_client import IdentityTypes, GroupTypes, RoleTypes
+from umapi_client import IdentityTypes, GroupTypes
 from umapi_client import UserAction, UserGroupAction
 from umapi_client import UsersQuery
 
@@ -299,33 +299,6 @@ def test_remove_from_groups_federatedid_all_error():
         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_unicode():
-    user = UserAction(id_type=IdentityTypes.enterpriseID, email="dbrotsky@o.on-the-side.net")
-    user.add_role(groups=[u"người quản lý"])
-    assert user.wire_dict() == {"do": [{"addRoles": {"admin": [u"người quản lý"]}}],
-                                "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"], role_type="productAdmin")
-    assert user.wire_dict() == {"do": [{"removeRoles": {"productAdmin": ["Photoshop", "Illustrator"]}}],
-                                "user": "dbrotsky@o.on-the-side.net"}
-
-
 def test_remove_from_organization_federatedid():
     user = UserAction(id_type=IdentityTypes.federatedID, email="dbrotsky@k.on-the-side.net")
     user.remove_from_organization()

umapi_client/__init__.py

@@ -22,7 +22,7 @@
 from .auth import JWTAuth, OAuthS2S
 from .connection import Connection
 from .error import BatchError, ClientError, RequestError, ServerError, UnavailableError, ArgumentError
-from .functional import IdentityTypes, GroupTypes, RoleTypes, IfAlreadyExistsOptions
+from .functional import IdentityTypes, GroupTypes, IfAlreadyExistsOptions
 from .functional import UserAction, UserQuery, UsersQuery
 from .functional import UserGroupAction, UserGroupsQuery, GroupsQuery
 from .version import __version__

umapi_client/api.py

@@ -134,7 +134,7 @@ def maybe_split_groups(self, max_groups):
         split_commands = []
         # return True if we split at least once
         maybe_split = False
-        valid_step_keys = ['add', 'addRoles', 'remove']
+        valid_step_keys = ['add', 'remove']
         for command in self.commands:
             # commands are assumed to contain a single key
             step_key, step_args = next(iter(command.items()))

umapi_client/functional.py

@@ -39,11 +39,6 @@ class GroupTypes(Enum):
     group = 4
 
 
-class RoleTypes(Enum):
-    admin = 1
-    productAdmin = 2
-
-
 class IfAlreadyExistsOptions(Enum):
     ignoreIfAlreadyExists = 1
     updateIfAlreadyExists = 2
@@ -151,7 +146,7 @@ def add_to_groups(self, groups=None, all_groups=False, group_type=None):
         :param groups: list of group names the user should be added to
         :param all_groups: a boolean meaning add to all (don't specify groups or group_type in this case)
         :param group_type: the type of group (defaults to "group")
-        :return: the User, so you can do User(...).add_to_groups(...).add_role(...)
+        :return: the User, so you can do User(...).add_to_groups(...).???()
         """
         if all_groups:
             if groups or group_type:
@@ -175,7 +170,7 @@ def remove_from_groups(self, groups=None, all_groups=False, group_type=None):
         :param groups: list of group names the user should be removed from
         :param all_groups: a boolean meaning remove from all (don't specify groups or group_type in this case)
         :param group_type: the type of group (defaults to "group")
-        :return: the User, so you can do User(...).remove_from_groups(...).add_role(...)
+        :return: the User, so you can do User(...).remove_from_groups(...).???(...)
         """
         if all_groups:
             if groups or group_type:
@@ -193,38 +188,6 @@ def remove_from_groups(self, groups=None, all_groups=False, group_type=None):
             glist = {group_type.name: [group for group in groups]}
         return self.append(remove=glist)
 
-    def add_role(self, groups=None, role_type=RoleTypes.admin):
-        """
-        Make user have a role (typically PLC admin) with respect to some PLC groups.
-        :param groups: list of group names the user should have this role for
-        :param role_type: the role (defaults to "admin")
-        :return: the User, so you can do User(...).add_role(...).add_to_groups(...)
-        """
-        if not groups:
-            raise ArgumentError("You must specify groups to which to add the role for this user")
-        if role_type in RoleTypes.__members__:
-            role_type = RoleTypes[role_type]
-        if role_type not in RoleTypes:
-            raise ArgumentError("You must specify a RoleType value for argument role_type")
-        glist = {role_type.name: [group for group in groups]}
-        return self.append(addRoles=glist)
-
-    def remove_role(self, groups=None, role_type=RoleTypes.admin):
-        """
-        Remove user from a role (typically admin) of some groups.
-        :param groups: list of group names the user should NOT have this role for
-        :param role_type: the type of role (defaults to "admin")
-        :return: the User, so you can do User(...).remove_role(...).remove_from_groups(...)
-        """
-        if not groups:
-            raise ArgumentError("You must specify groups from which to remove the role for this user")
-        if role_type in RoleTypes.__members__:
-            role_type = RoleTypes[role_type]
-        if role_type not in RoleTypes:
-            raise ArgumentError("You must specify a RoleType value for argument role_type")
-        glist = {role_type.name: [group for group in groups]}
-        return self.append(removeRoles=glist)
-
     def remove_from_organization(self, delete_account=False):
         """
         Remove a user from the organization's list of visible users.  Optionally also delete the account.