Sirbot: Add /admin & /snippet slack command

Author: ovv

pyslackersweb/sirbot/__init__.py

@@ -1,6 +1,6 @@
 from aiohttp import web
 
-from .views import routes
+from pyslackersweb.sirbot.views import readthedocs, slack
 
 
 async def app_factory() -> web.Application:
@@ -11,5 +11,6 @@ async def app_factory() -> web.Application:
         scheduler=None,  # populated via parent app signal
     )
 
-    sirbot.add_routes(routes)
+    readthedocs.add_routes(sirbot.router)
+    slack.add_routes(sirbot.router)
     return sirbot

pyslackersweb/sirbot/settings.py

@@ -2,6 +2,8 @@
 
 # production
 READTHEDOCS_NOTIFICATION_CHANNEL = "community_projects"
+SLACK_TEAM_ID = os.environ.get("SLACK_TEAM_ID")
+SLACK_VERIFICATION_TOKEN = os.environ.get("SLACK_VERIFICATION_TOKEN")
 
 # Development
 if os.environ.get("PLATFORM_BRANCH") != "master":

pyslackersweb/sirbot/views.py renamed to pyslackersweb/sirbot/views/readthedocs.py

@@ -5,15 +5,15 @@
 from slack.events import Message
 
 from pyslackersweb.util.log import ContextAwareLoggerAdapter
-
-from . import settings
+from pyslackersweb.sirbot import settings
 
 logger = ContextAwareLoggerAdapter(logging.getLogger(__name__))
 
-routes = web.RouteTableDef()
+
+def add_routes(router):
+    router.add_view("/readthedocs", ReadTheDocsView)
 
 
-@routes.view("/readthedocs", name="readthedocs")
 class ReadTheDocsView(web.View):
     async def post(self):
         payload = await self.request.json()

pyslackersweb/sirbot/views/slack/__init__.py

@@ -0,0 +1,28 @@
+import slack.commands
+
+from aiohttp import web
+
+from pyslackersweb.sirbot import settings
+
+from . import commands
+
+
+def add_routes(router: web.UrlDispatcher) -> None:
+    router.add_view("/slack/commands", SlackCommandsView)
+
+
+class SlackCommandsView(web.View):
+    router = slack.commands.Router()
+    router.register("/admin", commands.admin)
+    router.register("/snippet", commands.snippet)
+
+    async def post(self) -> web.Response:
+        payload = await self.request.json()
+        cmd = slack.commands.Command(
+            payload,
+            verification_token=settings.SLACK_VERIFICATION_TOKEN,
+            team_id=settings.SLACK_TEAM_ID,
+        )
+        for handler in self.router.dispatch(cmd):
+            await handler(self.request, cmd)
+        return web.Response(status=200)

pyslackersweb/sirbot/views/slack/commands.py

@@ -0,0 +1,60 @@
+import logging
+
+from aiohttp import web
+from slack import methods
+from slack import commands
+from slack.events import Message
+
+from pyslackersweb.util.log import ContextAwareLoggerAdapter
+
+logger = ContextAwareLoggerAdapter(logging.getLogger(__name__))
+
+
+async def admin(request: web.Request, command: commands.Command) -> None:
+    data = {
+        "trigger_id": command["trigger_id"],
+        "dialog": {
+            "callback_id": "tell_admin",
+            "title": "Message the admin team",
+            "elements": [
+                {
+                    "label": "Message",
+                    "name": "message",
+                    "type": "textarea",
+                    "value": command["text"],
+                }
+            ],
+        },
+    }
+    await request.app["slack_client"].query(url=methods.DIALOG_OPEN, data=data)
+
+
+async def snippet(request: web.Request, command: commands.Command) -> None:
+    """Post a message to the current channel about using snippets and backticks to visually
+    format code."""
+    response = Message()
+    response["channel"] = command["channel_id"]
+    response["unfurl_links"] = False
+
+    response["text"] = (
+        "Please use the snippet feature, or backticks, when sharing code. \n"
+        "To include a snippet, click the :paperclip: on the left and hover over "
+        "`Create new...` then select `Code or text snippet`.\n"
+        "By wrapping the text/code with backticks (`) you get:\n"
+        "`text formatted like this`\n"
+        "By wrapping a multiple line block with three backticks (```) you can get:\n"
+    )
+
+    await request.app["slack_client"].query(url=methods.CHAT_POST_MESSAGE, data=response)
+
+    response["text"] = (
+        "```\n"
+        "A multiline codeblock\nwhich is great for short snippets!\n"
+        "```\n"
+        "For more information on snippets, click "
+        "<https://get.slack.help/hc/en-us/articles/204145658-Create-a-snippet|here>.\n"
+        "For more information on inline code formatting with backticks click "
+        "<https://get.slack.help/hc/en-us/articles/202288908-Format-your-messages#inline-code|here>."
+    )
+
+    await request.app["slack_client"].query(url=methods.CHAT_POST_MESSAGE, data=response)

tests/test_sirbot.py

@@ -1,3 +1,5 @@
+import json
+
 from slack import methods
 
 from pyslackersweb.sirbot import settings
@@ -8,7 +10,7 @@ async def test_readthedocs_notification(client):
     assert r.status == 200
 
     # Assert we send a message to slack
-    client.app["slack_client"]._request.assert_called_once()
+    assert client.app["slack_client"]._request.call_count == 1
     assert methods.CHAT_POST_MESSAGE.value[0] in client.app["slack_client"]._request.call_args.args
     assert (
         settings.READTHEDOCS_NOTIFICATION_CHANNEL
@@ -22,3 +24,38 @@ async def test_readthedocs_notification_missing_name(client):
 
     # Assert we did not send a message to slack
     assert not client.app["slack_client"]._request.called
+
+
+async def test_slack_admin_command(client):
+    payload = {
+        "command": "/admin",
+        "trigger_id": "TEST-TRIGGER-ID",
+        "channel_id": "TEST-CHANNEL-ID",
+        "text": "TEST-TEXT",
+    }
+    r = await client.post("/bot/slack/commands", json=payload)
+    assert r.status == 200
+    assert client.app["slack_client"]._request.call_count == 1
+    assert methods.DIALOG_OPEN.value[0] in client.app["slack_client"]._request.call_args.args
+
+    data = json.loads(client.app["slack_client"]._request.call_args.args[3])
+    assert data["trigger_id"] == "TEST-TRIGGER-ID"
+    assert data["dialog"]["callback_id"] == "tell_admin"
+
+
+async def test_slack_snippet_command(client):
+    payload = {
+        "command": "/snippet",
+        "trigger_id": "TEST-TRIGGER-ID",
+        "channel_id": "TEST-CHANNEL-ID",
+        "text": "TEST-TEXT",
+    }
+    r = await client.post("/bot/slack/commands", json=payload)
+    assert r.status == 200
+
+    assert client.app["slack_client"]._request.call_count == 2
+
+    for call in client.app["slack_client"]._request.calls:
+        assert methods.CHAT_POST_MESSAGE.value[0] in call.args
+        data = json.loads(call.args[3])
+        assert data["channel_id"] == "TEST-CHANNEL-ID"