feat: Slack sink

CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+Version 0.1.16 - 2021-MM-DD
+===========================
+
+- New sink: send messages to Slack channel
+
 Version 0.1.15 - 2021-06-03
 ===========================
 

setup.cfg

@@ -73,6 +73,7 @@ install_requires =
     tuyapy==0.1.4
     twilio>=6.58.0,<7
     jinja2>=2.11.3,<3
+    slack_sdk>=3.7.0,<4
 
 
 [options.packages.find]
@@ -126,6 +127,7 @@ senor_octopus.plugins =
     sink.log = senor_octopus.sinks.log:log
     sink.mqtt = senor_octopus.sinks.mqtt:mqtt
     sink.pushover = senor_octopus.sinks.pushover:pushover
+    sink.slack = senor_octopus.sinks.slack:slack
     sink.sms = senor_octopus.sinks.sms:sms
     sink.tuya = senor_octopus.sinks.tuya:tuya
     sink.db.postgresql = senor_octopus.sinks.db.postgresql:postgresql

src/senor_octopus/sinks/slack.py

@@ -0,0 +1,32 @@
+import logging
+
+from senor_octopus.types import Stream
+from slack_sdk import WebClient
+
+_logger = logging.getLogger(__name__)
+
+
+async def slack(
+    stream: Stream,
+    token: str,
+    channel: str,
+) -> None:
+    """
+    Send events as messages to a Slack channel.
+
+    This sink can be used to send events to a Slack channel.
+    The value of the event is sent as the message; its name
+    is ignored.
+
+    Parameters
+    ----------
+    stream
+        The incoming stream of events
+    token
+        The authentication token for the bot
+    channel
+        The Slack channel ID
+    """
+    client = WebClient(token=token)
+    async for event in stream:  # pragma: no cover
+        client.chat_postMessage(channel=channel, text=str(event["value"]))

tests/sinks/test_slack.py

@@ -0,0 +1,20 @@
+import random
+
+import pytest
+from senor_octopus.sinks.slack import slack
+from senor_octopus.sources.rand import rand
+
+
+@pytest.mark.asyncio
+async def test_slack(mocker) -> None:
+    WebClient = mocker.patch("senor_octopus.sinks.slack.WebClient")
+    client = WebClient.return_value
+
+    random.seed(42)
+
+    await slack(rand(1), "XXX", "C0123456789")
+
+    client.chat_postMessage.assert_called_with(
+        channel="C0123456789",
+        text="0.6394267984578837",
+    )

tests/sinks/test_sms.py

@@ -6,7 +6,7 @@
 
 
 @pytest.mark.asyncio
-async def test_pushover(mocker) -> None:
+async def test_sms(mocker) -> None:
     Client = mocker.patch("senor_octopus.sinks.sms.Client")
     client = Client.return_value