bots: Add command-based default commands.

Author: neiljp

zulip_bots/zulip_bots/bots/xkcd/xkcd.py

@@ -3,6 +3,8 @@
 import logging
 import requests
 
+from collections import OrderedDict
+
 XKCD_TEMPLATE_URL = 'https://xkcd.com/%s/info.0.json'
 LATEST_XKCD_URL = 'https://xkcd.com/info.0.json'
 
@@ -18,6 +20,11 @@ class XkcdHandler(object):
         'name': 'XKCD',
         'description': 'Fetches comic strips from https://xkcd.com.',
         'default_commands_enabled': True,
+        'commands': OrderedDict([
+                ('latest', "Show the latest comic strip"),
+                ('random', "Show a random comic strip"),
+                ('<comic id>', "Show a comic strip with a specific 'comic id'"),
+        ])  # NOTE: help not listed here, so default command used
     }
 
     def usage(self):

zulip_bots/zulip_bots/lib.py

@@ -198,16 +198,41 @@ def default_about_response():
         if bot_details['description'] == "":
             return "**{name}**".format(**bot_details)
         return "**{name}**: {description}".format(**bot_details)
+
+    def default_commands_response():
+        return "**Commands**: {} {}".format(
+            " ".join(name for name in command_defaults if name),
+            " ".join(name for name in bot_details['commands'] if name))
+
+    def commands_list():
+        return ("\n".join("**{}** - {}".format(name, options[1])
+                          for name, options in command_defaults.items() if name) +
+                "\n" +
+                "\n".join("**{}** - {}".format(name, description)
+                          for name, description in bot_details['commands'].items() if name))
+
+    def default_help_response():
+        return "{}\n{}\n{}".format(default_about_response(),
+                                   message_handler.usage(), commands_list())
         # FIXME Add boilerplate text above, to include eg. how to mention bot?
         # FIXME Should usage be included?
 
     command_defaults = OrderedDict([  # Variable definition required for callbacks above
         ('', (default_empty_response, "[BLANK MESSAGE NOT SHOWN]")),
         ('about', (default_about_response, "The type and use of this bot")),
         ('usage', ((lambda: message_handler.usage(), "Bot-provided usage text"))),
+        ('commands', (default_commands_response, "A short list of supported commands")),
+        ('help', (default_help_response, "This help text")),
     ])
     return command_defaults
 
+def updated_default_commands(default_commands, bot_details):
+    if not bot_details['default_commands_enabled']:
+        return OrderedDict()
+    exclude_list = bot_details['commands'] or ('commands', 'help')
+    return OrderedDict((name, option) for name, option in default_commands.items()
+                       if name not in exclude_list)
+
 def run_message_handler_for_bot(lib_module, quiet, config_file, bot_name):
     # type: (Any, bool, str) -> Any
     #
@@ -231,16 +256,17 @@ def run_message_handler_for_bot(lib_module, quiet, config_file, bot_name):
     bot_details = {
         'name': bot_name.capitalize(),
         'description': "",
+#        'commands': {},
         'default_commands_enabled': True,
     }
     bot_details.update(getattr(lib_module.handler_class, 'META', {}))
 
     # Initialise default commands, then override & sync with bot_details
     default_commands = setup_default_commands(bot_details, message_handler)
-    if bot_details['default_commands_enabled']:
-        updated_defaults = default_commands
-    else:
-        updated_defaults = OrderedDict()
+    updated_defaults = updated_default_commands(default_commands, bot_details)
+    # Update bot_details if updated_defaults is empty
+    if len(updated_defaults) == 0:
+        bot_details['default_commands_enabled'] = False
 
     if not quiet:
         print("Running {} Bot:".format(bot_details['name']))