Addes message service

Author: gaker

botbot_plugins/base.py

@@ -4,6 +4,15 @@
 
 import fakeredis
 
+class PrivateMessage(object):
+    """
+    A holder object for sending a private message.
+    This is used in botbot.apps.plugins.runner
+    """
+    def __init__(self, nick, msg):
+        self.nick = nick
+        self.msg = msg
+
 
 class BasePlugin(object):
     "All plugins inherit this class"
@@ -44,6 +53,14 @@ def retrieve(self, key):
             value = unicode(value, 'utf-8')
         return value
 
+    def delete(self, key):
+        """Deletes a stored `key`
+
+        DEL: http://redis.io/commands/del
+        """
+        ukey = self._unique_key(key)
+        return self.app.storage.delete(ukey) == 1
+
     def incr(self, key):
         """Increments counter specified by `key`. If necessary, creates
         counter and initializes to 0.
@@ -61,8 +78,11 @@ class DummyLine(object):
     def __init__(self, packet):
         self.text = packet['text']
         self.full_text = packet['text']
-        self.user = 'repl_user'
+        self.user = packet.get('User', 'repl_user')
+        self._channel_name = packet.get('Channel', '#dummy-channel')
         self.is_direct_message = self.check_direct_message()
+        self._command = packet.get('Command', 'PRIVMSG')
+        self._is_message = self._command == 'PRIVMSG'
 
     def check_direct_message(self):
         """Are you addressing the bot?"""
@@ -71,6 +91,18 @@ def check_direct_message(self):
             return True
         return False
 
+    def __str__(self):
+        return self.full_text
+
+    def __repr__(self):
+        return str(self)
+
+
+class DummyPrivateMessage(object):
+    def __init__(self, nick, msg):
+        self.nick = nick
+        self.msg = msg
+
 
 REPL_INTRO = """
 #########################
@@ -101,6 +133,7 @@ def __init__(self, *args, **kwargs):
         self.storage = fakeredis.FakeStrictRedis()
         self.messages_router = {}
         self.mentions_router = {}
+        self.firehose_router = {}
         self.plugin_configs = {}
         if 'test_plugin' in kwargs:
             self.test_mode = True
@@ -120,7 +153,7 @@ def register(self, plugin):
             attr = getattr(plugin, key)
             if (not key.startswith('__') and
                     getattr(attr, 'route_rule', None) and
-                    attr.route_rule[0] in ('messages', 'mentions')):
+                    attr.route_rule[0] in ('messages', 'mentions', 'firehose')):
                 self.output('Route {}: {} ({}, {})'.format(attr.route_rule[0],
                                                            plugin.slug, key,
                                                            attr.route_rule[1]))
@@ -140,12 +173,16 @@ def set_config(self, plugin_slug, fields_dict):
         """Manually set a plugin config. Used for testing"""
         self.plugin_configs[plugin_slug].fields.update(fields_dict)
 
-    def respond(self, text):
+    def respond(self, text, **kwargs):
         """Listens for incoming messages"""
         if text.startswith('!!'):
             return self.do_config(text)
         self.responses = []
-        line = DummyLine({'text': text})
+
+        packet = {'text': text}
+        packet.update(kwargs)
+
+        line = DummyLine(packet)
         self.dispatch(line)
         if self.test_mode:
             return self.responses
@@ -183,6 +220,8 @@ def dispatch(self, line):
         if line.is_direct_message:
             self.check_routes_for_matches(line, self.mentions_router)
 
+        self.check_routes_for_matches(line, self.firehose_router)
+
     def check_routes_for_matches(self, line, router):
         """Checks if line matches the routes' rules and calls functions"""
         for _, route_list in router.items():
@@ -191,7 +230,11 @@ def check_routes_for_matches(self, line, router):
                 if match:
                     response = func(line, **match.groupdict())
                     if response:
-                        self.responses.append(response)
-                        self.output('[o__o]: ' + response)
+                        if isinstance(response, PrivateMessage):
+                            self.responses.append(response.msg)
+                            self.output('[o__o]: ' + response.msg)
+                        else:
+                            self.responses.append(response)
+                            self.output('[o__o]: ' + response)
 
 app = DummyApp()

botbot_plugins/plugins/message_service.py

@@ -0,0 +1,59 @@
+"""
+Message service plugin
+"""
+import json
+from ..base import BasePlugin, PrivateMessage
+from ..decorators import listens_to_mentions
+
+
+class Plugin(BasePlugin):
+    """
+    I can leave messages for users who are offline. To have me send
+    a message to your colleague `MrTaubyPants` on your behalf when he
+    comes online, ask me in this format:
+
+        {{ nick }}: message MrTaubyPants Message you want to leave.
+    """
+
+    slug = 'message_service'
+
+    def find_message(self, line):
+        """
+        Find any messages for a user after they have logged in.
+        """
+        if line._command == "JOIN":
+            messages = self.retrieve(line.user)
+            if messages:
+                self.delete(line.user)
+                messages = json.loads(messages)
+                if hasattr(line, '_channel_name'):
+                    out = "Beep BEEP! You received the following messages in {0} when you were offline.".format(
+                        line._channel_name)
+                else:
+                    out = "You received the following messages when you were offline."
+                for message in messages:
+                    out += "\n{0}".format(message)
+                return PrivateMessage(line.user, out)
+
+    find_message.route_rule = ('firehose', ur'(.*)')
+
+    @listens_to_mentions(r'^message\s+(?P<nick>[\w\-_]+)\s+(?P<message>.*)$')
+    def store_message(self, line, nick, message):
+        """
+        Store a message
+        """
+        message = "From {0} '{1}'".format(
+            line.user, message)
+        # does the user have any messages waiting?
+        messages = self.retrieve(nick)
+        if not messages:
+            messages = set()
+        else:
+            messages = set(json.loads(messages))
+
+        messages.add(message)
+        messages = list(messages)
+        self.store(nick, json.dumps(messages))
+        return u"{0}, I will tell {1} when they appear online.".format(
+            line.user, nick)
+

botbot_plugins/tests/test_message_service.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+"""
+Message service tests
+"""
+import pytest
+from botbot_plugins.base import DummyApp
+from botbot_plugins.plugins import message_service
+
+
+@pytest.fixture
+def app():
+    return DummyApp(test_plugin=message_service.Plugin())
+
+
+def test_remember(app):
+    """
+    [d__d]: message user foobar
+    """
+    responses = app.respond(r'@message george Are you going to the meeting?')
+    assert responses == [u'repl_user, I will tell george when they appear online.']
+
+
+def test_remind_user(app):
+    """
+    The user should be messaged when joining the channel
+    """
+    responses = app.respond(r'@message george Are you going to the meeting?')
+    assert responses == [u'repl_user, I will tell george when they appear online.']
+
+    responses = app.respond('george joined the channel', **{
+        'Command': 'JOIN',
+        'User': 'george'})
+    assert responses == ["Beep BEEP! You received the following messages in #dummy-channel when you were offline.\nFrom repl_user 'Are you going to the meeting?'"]
+
+def test_multiple_reminders(app):
+    """
+    Multiple reminders should work too.
+    """
+    responses = app.respond(r'@message george Are you going to the meeting?')
+    responses = app.respond(r'@message george I think I will be going.')
+
+    responses = app.respond('george joined the channel', **{
+        'Command': 'JOIN',
+        'User': 'george'})
+    assert responses == ["Beep BEEP! You received the following messages in #dummy-channel when you were offline.\nFrom repl_user 'I think I will be going.'\nFrom repl_user 'Are you going to the meeting?'"]
+
+