Merge pull request #118 from LanceMaverick/dashboard-enhancements

Added toJSON methods to Commands and Beards.

beards/postcats/__init__.py

@@ -1,44 +1,49 @@
-#show spacecats test plugin
+# show spacecats test plugin
 # Adapted from work by LanceMaverick
+from os.path import basename
 import random
 import logging
 from urllib.request import urlopen
-import telepot
-import telepot.aio
 from skybeard.beards import BeardChatHandler
 from skybeard.predicates import regex_predicate
-from skybeard.decorators import admin
+
 
 class PostCats(BeardChatHandler):
     __userhelp__ = """
     Say give me spacecats or show me spacecats if you want
     to, well, see cats in space."""
 
+    __commands__ = [
+        (regex_predicate('(give|show) me spacecats'), 'send_cat',
+         "Sends a spacecat image"),
+    ]
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.register_command(
-            regex_predicate('(give|show) me spacecats'), self.send_cat)
-
+
     async def send_cat(self, msg):
-        cat_photos= [
-                'http://i.imgur.com/bJ043fy.jpg',
-                'http://i.imgur.com/iFDXD5L.gif',
-                'http://i.imgur.com/6r3cMsl.gif',
-                'http://i.imgur.com/JpM5jcX.jpg',
-                'http://i.imgur.com/r7swEJv.jpg',
-                'http://i.imgur.com/vLVbiKu.jpg',
-                'http://i.imgur.com/Yy0TCXA.jpg',
-                'http://i.imgur.com/2eV7kmq.gif',
-                'http://i.imgur.com/rnA769W.jpg',
-                'http://i.imgur.com/08mxOAK.jpg',
-		'http://i.imgur.com/Ct5GsQn.jpg',
-                ]
+        cat_photos = [
+            'http://i.imgur.com/bJ043fy.jpg',
+            'http://i.imgur.com/iFDXD5L.gif',
+            'http://i.imgur.com/6r3cMsl.gif',
+            'http://i.imgur.com/JpM5jcX.jpg',
+            'http://i.imgur.com/r7swEJv.jpg',
+            'http://i.imgur.com/vLVbiKu.jpg',
+            'http://i.imgur.com/Yy0TCXA.jpg',
+            'http://i.imgur.com/2eV7kmq.gif',
+            'http://i.imgur.com/rnA769W.jpg',
+            'http://i.imgur.com/08mxOAK.jpg',
+            'http://i.imgur.com/Ct5GsQn.jpg',
+        ]
 
         try:
             choice = random.choice(cat_photos)
-            await self.sender.sendPhoto((choice.split("/")[-1], urlopen(choice)))
+            await self.sender.sendChatAction('upload_photo')
+            await self.sender.sendPhoto(
+                (basename(choice), urlopen(choice)))
         except Exception as e:
             logging.error(e)
             await self.sender.sendPhoto(
                 ("cat_photo.jpg",
                  urlopen('http://cdn.meme.am/instances/500x/55452028.jpg')))
+            raise e

skybeard/beards.py

@@ -31,6 +31,18 @@ def __init__(self, pred, coro, hlp=None):
         self.coro = coro
         self.hlp = hlp
 
+    def toJSON(self):
+        try:
+            return {
+                "predicate": self.pred.toJSON(),
+                "help": self.hlp,
+            }
+        except AttributeError:
+            return {
+                "predicate": "(unserializable)",
+                "help": self.hlp,
+            }
+
 
 class SlashCommand(object):
     """Holds information to determine whether a telegram command was sent."""
@@ -40,6 +52,12 @@ def __init__(self, cmd, coro, hlp=None):
         self.coro = coro
         self.hlp = hlp
 
+    def toJSON(self):
+        return {
+            "command": "/"+self.cmd,
+            "help": self.hlp
+        }
+
 def create_command(cmd_or_pred, coro, hlp=None):
     """Creates a Command or SlashCommand object as appropriate.
 
@@ -168,6 +186,16 @@ async def get_username(self):
 
         return type(self)._username
 
+    @classmethod
+    def toJSON(cls):
+        # Not a coroutine because it's useful to use this in list
+        # comprehensions
+        return {
+            "name": cls.__name__,
+            "commands": [c.toJSON() for c in cls.__commands__],
+            "userhelp": cls.__userhelp__
+        }
+
     def __init__(self, *args, **kwargs):
         self._instance_commands = []
         super().__init__(*args, **kwargs)
@@ -289,7 +317,7 @@ async def on_chat_message(self, msg):
 
 @app.add_route('/loadedBeards', methods=['GET'])
 async def loaded_beards(request):
-    return web.json_response([str(x) for x in Beard.beards])
+    return web.json_response([b.toJSON() for b in Beard.beards])
 
 
 @app.add_route('/availableCommands', methods=['GET'])

skybeard/predicates.py

@@ -1,3 +1,4 @@
+import types
 import logging
 import re
 
@@ -7,20 +8,28 @@
 def regex_predicate(pattern, lower=False):
     """Returns a predicate function which returns True if pattern is matched.
         if lower == True, the text will be made lower case."""
+
+    if lower:
+        compiled_pattern = re.compile(pattern, re.IGNORECASE)
+    else:
+        compiled_pattern = re.compile(pattern)
+
     def retfunc(chat_handler, msg):
         try:
-            if lower:
-                text = msg['text'].lower()
-            else:
-                text = msg['text']
+            text = msg['text']
             logger.debug("Matching regex: '{}' in '{}'".format(
                 pattern, text))
-            retmatch = re.match(pattern, text)
+            retmatch = compiled_pattern.match(text)
             logger.debug("Match: {}".format(retmatch))
             return retmatch
         except KeyError:
             return False
 
+    def _toJSON(self):
+        return str(compiled_pattern)
+
+    retfunc.toJSON = types.MethodType(_toJSON, retfunc)
+
     return retfunc