Merge pull request #118 from TotallyNotRobots/gonzobot+join-keys

Add support for channel keys

Author: linuxdaemon

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Add Python 3.8 to testing matrix
+- Add support for channel keys (#95)
 ### Changed
 - Refactor tests to remove dependency on mock library
 - Change link_announcer.py to only warn on connection errors

cloudbot/client.py

@@ -162,10 +162,11 @@ def set_nick(self, nick):
         """
         raise NotImplementedError
 
-    def join(self, channel):
+    def join(self, channel, key=None):
         """
         Joins a given channel
         :type channel: str
+        :type key: str
         """
         raise NotImplementedError
 

cloudbot/clients/irc.py

@@ -238,8 +238,12 @@ def notice(self, target, text):
     def set_nick(self, nick):
         self.cmd("NICK", nick)
 
-    def join(self, channel):
-        self.send("JOIN {}".format(channel))
+    def join(self, channel, key=None):
+        if key:
+            self.cmd("JOIN", channel, key)
+        else:
+            self.cmd("JOIN", channel)
+
         if channel not in self.channels:
             self.channels.append(channel)
 

plugins/admin_bot.py

@@ -232,17 +232,26 @@ async def restart(text, bot):
 
 @hook.command(permissions=["botcontrol", "snoonetstaff"])
 async def join(text, conn, nick, notice, admin_log):
-    """<channel> - joins <channel>
+    """<channel> [key] - joins <channel> with the optional [key]
 
     :type text: str
     :type conn: cloudbot.client.Client
+    :type nick: str
     """
-    for target in text.split():
-        if not target.startswith("#"):
-            target = "#{}".format(target)
-        admin_log("{} used JOIN to make me join {}.".format(nick, target))
-        notice("Attempting to join {}...".format(target))
-        conn.join(target)
+    parts = text.split(None, 1)
+    target = parts.pop(0)
+
+    if parts:
+        key = parts.pop(0)
+    else:
+        key = None
+
+    if not target.startswith("#"):
+        target = "#{}".format(target)
+
+    admin_log("{} used JOIN to make me join {}.".format(nick, target))
+    notice("Attempting to join {}...".format(target))
+    conn.join(target, key)
 
 
 def parse_targets(text, chan):

tests/plugin_tests/test_admin_bot.py

@@ -0,0 +1,36 @@
+import asyncio
+from unittest.mock import MagicMock
+
+import pytest
+
+from cloudbot.event import CommandEvent
+from cloudbot.util import async_util
+from plugins import admin_bot
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize('input_text,chan,key', [
+    ('#channel key', '#channel', 'key'),
+    ('channel key', '#channel', 'key'),
+    ('#channel', '#channel', None),
+    ('channel', '#channel', None),
+])
+async def test_join(input_text, chan, key):
+    conn = MagicMock()
+    conn.config = {}
+    conn.bot = None
+
+    event = CommandEvent(
+        text=input_text,
+        cmd_prefix='.',
+        triggered_command='join',
+        hook=MagicMock(),
+        bot=conn.bot,
+        conn=conn,
+        channel='#foo',
+        nick='foobaruser',
+    )
+
+    await async_util.run_func_with_args(asyncio.get_event_loop(), admin_bot.join, event)
+
+    event.conn.join.assert_called_with(chan, key)