Merge pull request CloudBotIRC#121 from linuxdaemon/gonzobot+hook-tests

Add basic tests for plugin hook registrations

Author: edwardslabs

.travis.yml

@@ -7,7 +7,7 @@ python:
 
 install:
   - "sudo apt-get update -q"
-  - "sudo apt-get install -y python3-lxml"
+  - "sudo apt-get install -y python3-lxml libenchant-dev"
   - "pip install -r ./travis/requirements.txt"
 
 script:

plugins/badwords.py

@@ -20,7 +20,7 @@
 @hook.on_start()
 @hook.command("loadbad", permissions=["badwords"], autohelp=False)
 def load_bad(db):
-    """Should run on start of bot to load the existing words into the regex"""
+    """- Should run on start of bot to load the existing words into the regex"""
     global badword_re, blacklist, black_re
     words = db.execute("select word from badwords").fetchall()
     out = ""
@@ -31,9 +31,9 @@ def load_bad(db):
     badwords_re = re.compile(black_re, re.IGNORECASE)
 
 
-@hook.command("addbad", permissions=["badwords"], autohelp=False)
+@hook.command("addbad", permissions=["badwords"])
 def add_bad(text, nick, db, conn):
-    """adds a bad word to the auto kick list must specify a channel with each word"""
+    """<word> <channel> - adds a bad word to the auto kick list must specify a channel with each word"""
     global blacklist, black_re, blacklist
     word = text.split(' ')[0].lower()
     channel = text.split(' ')[1].lower()
@@ -62,9 +62,9 @@ def add_bad(text, nick, db, conn):
                 channel)
 
 
-@hook.command("rmbad", "delbad", permissions=["badwords"], autohelp=False)
+@hook.command("rmbad", "delbad", permissions=["badwords"])
 def del_bad(text, db, conn):
-    """removes the specified word from the specified channels bad word list"""
+    """<word> <channel> - removes the specified word from the specified channels bad word list"""
     global blacklist, black_re, blacklist
     word = text.split(' ')[0].lower()
     if not (text.split(' ')[1] or text.split(' ')[1]('#')):
@@ -82,9 +82,9 @@ def del_bad(text, db, conn):
         newlist)
 
 
-@hook.command("listbad", permissions=["badwords"], autohelp=False)
+@hook.command("listbad", permissions=["badwords"])
 def list_bad(text, db):
-    """Returns a list of bad words specify a channel to see words for a particular channel"""
+    """<channel> - Returns a list of bad words specify a channel to see words for a particular channel"""
     text = text.split(' ')[0].lower()
     out = ""
     if not text.startswith('#'):

plugins/bible.py

@@ -2,14 +2,15 @@
 
 from cloudbot import hook
 
+
 @hook.command("bible", "passage", singlethread=True)
 def bible(text, reply):
-    """Prints the specified passage from the Bible"""
+    """<passage> - Prints the specified passage from the Bible"""
     passage = text.strip()
     params = {
-        'passage':passage,
-        'formatting':'plain',
-        'type':'json'
+        'passage': passage,
+        'formatting': 'plain',
+        'type': 'json'
     }
     try:
         r = requests.get("https://labs.bible.org/api", params=params)

plugins/books.py

@@ -16,7 +16,7 @@ def load_key(bot):
 
 @hook.command("books", "gbooks")
 def books(text, reply):
-    """books <query> -- Searches Google Books for <query>."""
+    """<query> - Searches Google Books for <query>."""
     if not dev_key:
         return "This command requires a Google Developers Console API key."
 

plugins/cats.py

@@ -17,7 +17,7 @@ def get_data(url, reply, bot, params=None):
 
 @hook.command(autohelp=False)
 def cats(reply, bot):
-    """gets a fucking fact about cats."""
+    """- gets a fucking fact about cats."""
     r = get_data('https://catfact.ninja/fact', reply, bot, params={'max_length': 100})
     json = r.json()
     response = json['facts']
@@ -26,6 +26,6 @@ def cats(reply, bot):
 
 @hook.command(autohelp=False)
 def catgifs(reply, bot):
-    """gets a fucking cat gif."""
+    """- gets a fucking cat gif."""
     r = get_data("http://marume.herokuapp.com/random.gif", reply, bot)
     return "OMG A CAT GIF: {}".format(r.url)

plugins/chatbot.py

@@ -9,7 +9,7 @@ def get_key(bot):
 
 @hook.command("ask", "gonzo", "gonzobot", "cleverbot", "cb")
 def chitchat(text):
-    """chat with cleverbot.com"""
+    """<text> - chat with cleverbot.com"""
     if not api_key:
         return "Please add an API key from http://www.cleverbot.com/api to enable this feature."
     return cb.say(text)

plugins/core/check_conn.py

@@ -7,7 +7,7 @@
 
 @hook.command(autohelp=False, permissions=["botcontrol"])
 def conncheck(nick, bot, notice):
-    """This command is an effort to make the bot reconnect to a network if it has been disconnected."""
+    """- This command is an effort to make the bot reconnect to a network if it has been disconnected."""
     # For each irc network return a notice on the connection state and send a message from
     # each connection to the nick that used the command.
     for conn in bot.connections:

plugins/core/help.py

@@ -62,13 +62,13 @@ def help_command(text, chan, conn, bot, notice, message, has_permission):
             commands.append(command)
 
         # list of lines to send to the user
-        lines = formatting.chunk_str("Here's a list of commands you can use: " + ", ". join(commands))
+        lines = formatting.chunk_str("Here's a list of commands you can use: " + ", ".join(commands))
 
         for line in lines:
             if chan[:1] == "#":
                 notice(line)
             else:
-                #This is an user in this case.
+                # This is an user in this case.
                 message(line)
         notice("For detailed help, use {}help <command>, without the brackets.".format(conn.config["command_prefix"]))
 
@@ -114,11 +114,11 @@ def cmdinfo(text, bot, notice, event):
 
 @hook.command(permissions=["botcontrol"], autohelp=False)
 def generatehelp(conn, bot, notice, has_permission):
-    """Dumps a list of commands with their help text to the docs directory formatted using markdown."""
+    """- Dumps a list of commands with their help text to the docs directory formatted using markdown."""
     message = "{} Command list\n".format(conn.nick)
     message += "------\n"
     for plugin in sorted(set(bot.plugin_manager.commands.values()), key=attrgetter("name")):
-    # use set to remove duplicate commands (from multiple aliases), and sorted to sort by name
+        # use set to remove duplicate commands (from multiple aliases), and sorted to sort by name
         command = plugin.name
         aliases = ""
         doc = bot.plugin_manager.commands[command].doc
@@ -133,8 +133,8 @@ def generatehelp(conn, bot, notice, has_permission):
                 aliases += alias + ", "
         aliases = aliases[:-2]
         if doc:
-            doc = doc.replace("<","&lt;").replace(">","&gt;") \
-                .replace("[", "&lt;").replace("]","&gt;")
+            doc = doc.replace("<", "&lt;").replace(">", "&gt;") \
+                .replace("[", "&lt;").replace("]", "&gt;")
             if aliases:
                 message += "**{} ({}):** {}\n\n".format(command, aliases, doc)
             else:
@@ -146,10 +146,10 @@ def generatehelp(conn, bot, notice, has_permission):
             message = message[:-2]
             message += " ( *Permission required:* {})\n\n".format(permission)
     # toss the markdown text into a paste
-    #out = web.paste(message.encode('utf-8'), ext="md")
+    # out = web.paste(message.encode('utf-8'), ext="md")
     docs = os.path.join(os.path.abspath(os.path.curdir), "docs")
     docs = os.path.join(docs, "user")
     f = open(os.path.join(docs, "commands.md"), 'w')
     f.write(message)
     f.close()
-    return #out
+    return  # out

plugins/dig.py

@@ -5,7 +5,7 @@
 
 @hook.command
 def dig(text, nick, notice):
-    """.dig <domain> <recordtype> returns a list of records for the specified domain valid record types are A, NS, TXT, and MX. If a record type is not chosen A will be the default."""
+    """<domain> <recordtype> - returns a list of records for the specified domain valid record types are A, NS, TXT, and MX. If a record type is not chosen A will be the default."""
     args = text.split()
     domain = args.pop(0)
 

plugins/dogpile.py

@@ -1,17 +1,22 @@
-import requests
 import random
 import re
 from urllib import parse
+
+import requests
 from bs4 import BeautifulSoup
+
 from cloudbot import hook
 
 search_url = "http://dogpile.com/search"
 
-HEADERS = {'User-Agent': 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus Build/IMM76B) AppleWebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.133 Mobile Safari/535.19'}
+HEADERS = {
+    'User-Agent': 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus Build/IMM76B) AppleWebKit/535.19 (KHTML, like Gecko) Chrome/18.0.1025.133 Mobile Safari/535.19'
+}
+
 
 @hook.command("dpis", "gis")
 def dogpileimage(text):
-    """Uses the dogpile search engine to search for images."""
+    """<query> - Uses the dogpile search engine to search for images."""
     image_url = search_url + "/images"
     params = {'q': " ".join(text.split())}
     r = requests.get(image_url, params=params, headers=HEADERS)
@@ -20,18 +25,21 @@ def dogpileimage(text):
     data = soup.find_all("script")[6].string
     link_re = re.compile('"url":"(.*?)",')
     linklist = link_re.findall(data)
-    #linklist = soup.find('div', id="webResults").find_all('a', {'class':'resultThumbnailLink'})
+    # linklist = soup.find('div', id="webResults").find_all('a', {'class':'resultThumbnailLink'})
     image = parse.unquote(parse.unquote(random.choice(linklist)).split('ru=')[1].split('&')[0])
     return image
 
+
 @hook.command("dp", "g", "dogpile")
 def dogpile(text):
-    """Uses the dogpile search engine to find shit on the web."""
+    """<query> - Uses the dogpile search engine to find shit on the web."""
     web_url = search_url + "/web"
-    params = {'q':" ".join(text.split())}
+    params = {'q': " ".join(text.split())}
     r = requests.get(web_url, params=params, headers=HEADERS)
     r.raise_for_status()
     soup = BeautifulSoup(r.content)
-    result_url = parse.unquote(parse.unquote(soup.find('div', id="webResults").find_all('a', {'class':'resultDisplayUrl'})[0]['href']).split('ru=')[1].split('&')[0])
-    result_description = soup.find('div', id="webResults").find_all('div', {'class':'resultDescription'})[0].text
+    result_url = parse.unquote(
+        parse.unquote(soup.find('div', id="webResults").find_all('a', {'class': 'resultDisplayUrl'})[0]['href']).split(
+            'ru=')[1].split('&')[0])
+    result_description = soup.find('div', id="webResults").find_all('div', {'class': 'resultDescription'})[0].text
     return "{} -- \x02{}\x02".format(result_url, result_description)