Issue-729 admin conversations restrict access API (#754)

Author: Kian Attari

integration_tests/web/test_admin_conversations_restrictAccess.py

@@ -0,0 +1,104 @@
+import asyncio
+import logging
+import os
+import time
+import unittest
+
+from integration_tests.env_variable_names import SLACK_SDK_TEST_GRID_WORKSPACE_ADMIN_USER_TOKEN, \
+    SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN, \
+    SLACK_SDK_TEST_GRID_IDP_USERGROUP_ID, SLACK_SDK_TEST_GRID_TEAM_ID
+from integration_tests.helpers import async_test
+from slack import WebClient
+
+
+class TestWebClient(unittest.TestCase):
+    """Runs integration tests with real Slack API"""
+
+    def setUp(self):
+        self.logger = logging.getLogger(__name__)
+        self.org_admin_token = os.environ[SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN]
+        self.sync_client: WebClient = WebClient(
+            token=self.org_admin_token,
+            run_async=False,
+            loop=asyncio.new_event_loop()
+        )
+        self.async_client: WebClient = WebClient(token=self.org_admin_token, run_async=True)
+
+        self.team_id = os.environ[SLACK_SDK_TEST_GRID_TEAM_ID]
+        self.idp_group_id = os.environ[SLACK_SDK_TEST_GRID_IDP_USERGROUP_ID]
+
+        if not hasattr(self, "channel_id"):
+            team_admin_token = os.environ[SLACK_SDK_TEST_GRID_WORKSPACE_ADMIN_USER_TOKEN]
+            client = WebClient(token=team_admin_token)
+            # Only fetching private channels since admin.conversations.restrictAccess methods do not work for public channels
+            convs = client.conversations_list(exclude_archived=True, limit=100, types="private_channel")
+            self.channel_id = next((c["id"] for c in convs["channels"] if c["name"] != "general"), None)
+            if self.channel_id is None:
+                millis = int(round(time.time() * 1000))
+                channel_name = f"private-test-channel-{millis}"
+                self.channel_id = client.conversations_create(
+                    name=channel_name,
+                    is_private=True,
+                )["channel"]["id"]
+
+    def tearDown(self):
+        pass
+
+    def test_sync(self):
+        client = self.sync_client
+
+        add_group = client.admin_conversations_restrictAccess_addGroup(
+            channel_id=self.channel_id,
+            group_id=self.idp_group_id,
+            team_id=self.team_id
+        )
+        self.assertIsNotNone(add_group)
+        # To avoid rate limiting errors
+        time.sleep(10)
+
+        list_groups = client.admin_conversations_restrictAccess_listGroups(
+            team_id=self.team_id,
+            channel_id=self.channel_id
+        )
+        self.assertIsNotNone(list_groups)
+        # To avoid rate limiting errors
+        time.sleep(10)
+
+        remove_group = client.admin_conversations_restrictAccess_removeGroup(
+            channel_id=self.channel_id,
+            group_id=self.idp_group_id,
+            team_id=self.team_id
+        )
+        self.assertIsNotNone(remove_group)
+        # To avoid rate limiting errors
+        time.sleep(20)
+
+    @async_test
+    async def test_async(self):
+        client = self.async_client
+
+        add_group = await client.admin_conversations_restrictAccess_addGroup(
+            channel_id=self.channel_id,
+            group_id=self.idp_group_id,
+            team_id=self.team_id
+        )
+        self.assertIsNotNone(add_group)
+        # To avoid rate limiting errors
+        await asyncio.sleep(10)
+
+        list_groups = await client.admin_conversations_restrictAccess_listGroups(
+            team_id=self.team_id,
+            channel_id=self.channel_id
+        )
+        self.assertIsNotNone(list_groups)
+        # To avoid rate limiting errors
+        await asyncio.sleep(10)
+
+        remove_group = await client.admin_conversations_restrictAccess_removeGroup(
+            channel_id=self.channel_id,
+            group_id=self.idp_group_id,
+            team_id=self.team_id
+        )
+        self.assertIsNotNone(remove_group)
+        # To avoid rate limiting errors
+        await asyncio.sleep(20)

slack/web/base_client.py

@@ -686,7 +686,13 @@ def _update_call_participants(kwargs, users: Union[str, List[Dict[str, str]]]):
 
 
 # https://api.slack.com/changelog/2020-01-deprecating-antecedents-to-the-conversations-api
-deprecated_method_prefixes_2020_01 = ["channels.", "groups.", "im.", "mpim."]
+deprecated_method_prefixes_2020_01 = [
+    "channels.",
+    "groups.",
+    "im.",
+    "mpim.",
+    "admin.conversations.whitelist.",
+]
 
 
 def show_2020_01_deprecation(method_name: str):

slack/web/client.py

@@ -109,6 +109,36 @@ def admin_apps_restricted_list(self, **kwargs) -> Union[Future, SlackResponse]:
             "admin.apps.restricted.list", http_verb="GET", params=kwargs
         )
 
+    def admin_conversations_restrictAccess_addGroup(
+        self, **kwargs
+    ) -> Union[Future, SlackResponse]:
+        """Add an allowlist of IDP groups for accessing a channel."""
+        return self.api_call(
+            "admin.conversations.restrictAccess.addGroup",
+            http_verb="GET",
+            params=kwargs,
+        )
+
+    def admin_conversations_restrictAccess_listGroups(
+        self, **kwargs
+    ) -> Union[Future, SlackResponse]:
+        """List all IDP Groups linked to a channel."""
+        return self.api_call(
+            "admin.conversations.restrictAccess.listGroups",
+            http_verb="GET",
+            params=kwargs,
+        )
+
+    def admin_conversations_restrictAccess_removeGroup(
+        self, **kwargs
+    ) -> Union[Future, SlackResponse]:
+        """Remove a linked IDP group linked from a private channel."""
+        return self.api_call(
+            "admin.conversations.restrictAccess.removeGroup",
+            http_verb="GET",
+            params=kwargs,
+        )
+
     def admin_conversations_setTeams(self, **kwargs) -> Union[Future, SlackResponse]:
         """Set the workspaces in an Enterprise grid org that connect to a channel."""
         return self.api_call("admin.conversations.setTeams", json=kwargs)
@@ -930,6 +960,18 @@ def conversations_list(self, **kwargs) -> Union[Future, SlackResponse]:
         """Lists all channels in a Slack team."""
         return self.api_call("conversations.list", http_verb="GET", params=kwargs)
 
+    def conversations_mark(
+        self, *, channel: str, ts: str, **kwargs
+    ) -> Union[Future, SlackResponse]:
+        """Sets the read cursor in a channel.
+
+        Args:
+            channel (str): Channel or conversation to set the read cursor for e.g. 'C1234567890'
+            ts (str): Unique identifier of message to mark as most recently seen in the convo e.g. '1593473566.000200'
+        """
+        kwargs.update({"channel": channel, "ts": ts})
+        return self.api_call("conversations.mark", json=kwargs)
+
     def conversations_members(
         self, *, channel: str, **kwargs
     ) -> Union[Future, SlackResponse]:

tests/web/test_web_client_coverage.py

@@ -8,9 +8,9 @@
 
 
 class TestWebClientCoverage(unittest.TestCase):
-    # 196 endpoints as of May 28, 2020
+    # 205 endpoints as of July 16, 2020
     # Can be fetched by running `var methodNames = [].slice.call(document.getElementsByClassName('bold')).map(e => e.text);console.log(methodNames.toString());console.log(methodNames.length);` on https://api.slack.com/methods
-    all_api_methods = "admin.apps.approve,admin.apps.restrict,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.conversations.setTeams,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.reset,api.test,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,apps.uninstall,auth.revoke,auth.test,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split(
+    all_api_methods = "admin.apps.approve,admin.apps.restrict,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.conversations.restrictAccess.addGroup,admin.conversations.restrictAccess.listGroups,admin.conversations.restrictAccess.removeGroup,admin.conversations.setTeams,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.addTeams,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.reset,api.test,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,apps.uninstall,auth.revoke,auth.test,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.archive,conversations.close,conversations.create,conversations.history,conversations.info,conversations.invite,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.mark,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,admin.conversations.whitelist.add,admin.conversations.whitelist.listGroupsLinkedToChannel,admin.conversations.whitelist.remove,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split(
         ","
     )
 
@@ -26,6 +26,11 @@ def setUp(self):
                 "oauth.v2.access",
                 "oauth.token",
                 "users.setActive",
+                "admin.conversations.whitelist.add",  # deprecated
+                "admin.conversations.whitelist.listGroupsLinkedToChannel",  # deprecated
+                "admin.conversations.whitelist.remove",  # deprecated
+                "admin.usergroups.addTeams",  # TODO
+                "calls.participants.remove",  # TODO
             ]:
                 continue
             self.api_methods_to_call.append(api_method)
@@ -198,6 +203,8 @@ def test_coverage(self):
                     self.api_methods_to_call.remove(method(channel="C123", user="U123")["method"])
                 elif method_name == "conversations_leave":
                     self.api_methods_to_call.remove(method(channel="C123")["method"])
+                elif method_name == "conversations_mark":
+                    self.api_methods_to_call.remove(method(channel="C123", ts="123.123")["method"])
                 elif method_name == "conversations_members":
                     self.api_methods_to_call.remove(method(channel="C123")["method"])
                 elif method_name == "conversations_rename":