Minor bot & command updates

Co-authored-by: David Tso <davidtso1219@gmail.com>

Author: madhavarshney

README.md

@@ -32,6 +32,16 @@ Install [`Python 3.7+`](https://www.python.org/) and [`poetry`](https://python-p
 poetry install
 ```
 
+### Configuration
+
+Create a file called `.env` with the following content:
+
+```env
+BOT_TOKEN=<discord bot token>
+BOT_OWNERS=<comma separated Discord user IDs>
+BOT_PREFIX=<command prefix>
+```
+
 ### Start
 
 Run the following command to start both bots:

bots/js/commands/find.js

@@ -5,6 +5,7 @@ const fetch = require('node-fetch')
 
 const { API_URL } = require('../config')
 const getUsage = require('../utils/getUsage')
+const replaceCampusNames = require('../utils/replaceCampusNames')
 
 // const days = ['M', 'T', 'W', 'Th', 'F', 'S', 'U']
 const days = ['M', 'T', 'W', 'R', 'F', 'S', 'U']
@@ -86,19 +87,15 @@ class FindCommand extends Command {
     }
 
     exec(message, args) {
-        console.log(
-            `Find: ${message.author.username}#${message.author.discriminator}`,
-            args
-        )
-
-        args.campus && (args.campus = args.campus.toLowerCase())
+        args.campus &&
+            (args.campus = replaceCampusNames(args.campus.toLowerCase()))
         args.dept && (args.dept = args.dept.toUpperCase())
         args.course && (args.course = args.course.toUpperCase())
 
         args.term && (args.term = args.term.toLowerCase())
 
         if (!args.term && !args.year) {
-            args.term = 'spring'
+            args.term = 'fall'
             args.year = 2021
         }
 

bots/js/commands/help.js

@@ -16,6 +16,30 @@ const EXTERNAL_COMMANDS = [
             ],
         },
     },
+    {
+        id: 'ucstats',
+        aliases: ['ucstats'],
+        description: {
+            text: 'Search UC Transfer Stats',
+            usage: 'ucx for target major',
+            examples: [
+                { name: '', cmd: 'ucb for bio' },
+                { name: '', cmd: 'ucla for comp sci' },
+            ],
+        },
+    },
+    {
+        id: 'grade',
+        aliases: ['grade'],
+        description: {
+            text: 'Search grade distributions at Foothill College.',
+            usage: 'professor for subject [course]',
+            examples: [
+                { name: '', cmd: 'allison herman for everything' },
+                { name: '', cmd: 'cascarano for phys 4a' },
+            ],
+        },
+    },
 ]
 
 class HelpCommand extends Command {
@@ -41,6 +65,8 @@ class HelpCommand extends Command {
             .setFooter('Hope you enjoy!')
 
         const addCommandToHelp = (command) => {
+            if (command.description.hidden) return
+
             let description = command.description.text || 'No description'
 
             description +=

bots/js/commands/rate.js

@@ -3,6 +3,7 @@ const Discord = require('discord.js')
 const fetch = require('node-fetch')
 
 const getUsage = require('../utils/getUsage')
+const replaceCampusNames = require('../utils/replaceCampusNames')
 
 function getRMPUrl(campus, q) {
     let schoolName, schoolId
@@ -129,7 +130,7 @@ class RateCommand extends Command {
             return
         }
 
-        args.campus = args.campus.toLowerCase()
+        args.campus = replaceCampusNames(args.campus.toLowerCase())
 
         if (!['fh', 'da'].includes(args.campus)) {
             message.util.send(
@@ -171,10 +172,8 @@ class RateCommand extends Command {
             others.length &&
             `*Also found:* ${others
                 .map(
-                    (prof) =>
-                        `${prof['teacherfullname_s']} (${
-                            prof['averageratingscore_rf'] || '?'
-                        })`
+                    ({ teacherfullname_s, averageratingscore_rf }) =>
+                        `${teacherfullname_s} (${averageratingscore_rf || '?'})`
                 )
                 .join(', ')}`
 

bots/js/commands/reload.js

@@ -0,0 +1,58 @@
+const { Command } = require('discord-akairo')
+
+class ReloadCommand extends Command {
+    constructor() {
+        super('reload-js', {
+            aliases: ['reload-js', 'rjs'],
+            description: {
+                hidden: true,
+                text: 'Reload a command handler',
+                usage: '<command>',
+            },
+            args: [
+                {
+                    id: 'command',
+                    type: 'string',
+                    default: 'all',
+                },
+            ],
+            ownerOnly: true,
+            category: 'owner',
+        })
+    }
+
+    exec(message, args) {
+        if (args.command == 'all') {
+            this.handler.reloadAll()
+            return message.channel.send(
+                `Reloaded ${
+                    Array.from(this.handler.modules).length
+                } command(s)!`
+            )
+        }
+
+        try {
+            this.handler.reload(args.command)
+            return message.util.send(`Reloaded command ${args.command}!`)
+        } catch {
+            try {
+                const category = this.handler.categories
+                    .map((c) => c)
+                    .filter((c) => c == args.command)[0]
+                category.reloadAll()
+
+                return message.util.send(
+                    `Reloaded category ${args.command}!\nReloaded ${
+                        Array.from(category).length
+                    } command(s)!`
+                )
+            } catch (e) {
+                return message.util.send(
+                    `"${args.command}" is not a valid category/command ID!`
+                )
+            }
+        }
+    }
+}
+
+module.exports = ReloadCommand

bots/js/listeners/commandStarted.js

@@ -0,0 +1,18 @@
+const { Listener } = require('discord-akairo')
+
+class CommandStartedListener extends Listener {
+    constructor() {
+        super('commandStarted', {
+            emitter: 'commandHandler',
+            event: 'commandStarted',
+        })
+    }
+
+    exec(message, command) {
+        console.log(
+            `[cmd] ${message.author.tag} invoked "${command.id}" with "${message.content}"`
+        )
+    }
+}
+
+module.exports = CommandStartedListener

bots/js/utils/replaceCampusNames.js

@@ -0,0 +1,10 @@
+const replacements = {
+    foothill: 'fh',
+    'de-anza': 'da',
+    'de anza': 'da',
+    deanza: 'da',
+}
+
+const replaceCampusNames = (name) => replacements[name] || name
+
+module.exports = replaceCampusNames

bots/py/bot.py

@@ -1,19 +1,10 @@
 from os import getenv
-from discord.ext import commands
+from discord.ext.commands import Bot
 from dotenv import load_dotenv
 
 load_dotenv()
 
-
-class Bot(commands.Bot):
-    def before_invoke(self, ctx):
-        print(
-            f'[command] "{ctx.author}" invoked "{ctx.command.name}" with "{ctx.message.content}"'
-        )
-
-
-client = Bot(command_prefix=getenv("BOT_PREFIX", "?"))
-
+bot = Bot(command_prefix=getenv("BOT_PREFIX", "?"))
 extensions = [
     "commands.admin",
     "commands.assist",
@@ -24,8 +15,14 @@ def before_invoke(self, ctx):
     "commands.grade",
 ]
 
+@bot.before_invoke
+async def before_invoke(ctx):
+    print(
+        f'[cmd] {ctx.author} invoked "{ctx.command.name}" with "{ctx.message.content}"'
+    )
+
 if __name__ == "__main__":
-    client.remove_command("help")
+    bot.remove_command("help")
     for extension in extensions:
-        client.load_extension(extension)
-    client.run(getenv("BOT_TOKEN"))
+        bot.load_extension(extension)
+    bot.run(getenv("BOT_TOKEN"))

bots/py/commands/admin.py

@@ -36,6 +36,12 @@ async def reload(self, ctx, ext_name: str = ""):
         except commands.errors.ExtensionNotLoaded:
             await ctx.send("Extension not loaded")
 
+    @commands.command()
+    async def stats(self, ctx):
+        server_list = '\n'.join([guild.name for guild in self.bot.guilds])
+
+        await ctx.send(f"__**Servers**__\n{server_list}")
+
 
 def setup(bot):
     bot.add_cog(Admin(bot))

bots/py/commands/assist.py

@@ -1,14 +1,11 @@
 import requests
-import asyncio
 import discord
 
 from discord.ext import commands
 
 from college import College
 from major import Major
-from emojis import emojis, numeric_emojis, num_emojis
-from page import Page
-from utils import pad_z
+from emojis import emojis
 from selection import select
 
 url = "https://assist.org/api/institutions"