initial raffle bot

Author: briancohan

README.md

@@ -0,0 +1,5 @@
+# PyRVA Bots
+
+Bot | Service | Description
+---|---|---
+raffle-bot | Discord | Monitor text channels to help with raffles

raffle-bot/README.md

@@ -0,0 +1,28 @@
+# Raffle Bot
+
+When PyRVA has something to raffle off.
+This bot monitors all channels and tracks who wants to enter the raffle.
+
+## Entering a Raffle
+
+To enter the raffle, members have to enter `pick me` or `select me` in any text channel.
+The key text is case-insensitive and may have additional text (eg. `You should PICK ME!!!!`).
+Admins are not eligible to win, so their submissions are ignored.
+Submissions are stored in a set to prevent duplicate entries.
+
+## Selecting a Winner
+
+To select a winner, an admin can type `pick winner` or `select winner`.
+A winner is selected, their submission is removed from the list, and their victory is announced.
+
+## Running the Bot
+
+You must have access to the bot's authentication token.
+The bot runs locally on a machine and must be spun up for meetings.
+
+Python 3.9 does not quite work due to the async, so this bot runs on Python 3.8.
+To run the bot, type
+
+```
+python raffle_bot.py
+```

raffle-bot/raffle_bot.py

@@ -0,0 +1,64 @@
+import os
+import random
+
+from dotenv import load_dotenv
+import discord
+load_dotenv()
+
+
+client = discord.Client()
+submissions = set()
+entry_keys = [
+    'pick me',
+    'select me',
+]
+selection_keys = [
+    'pick winner',
+    'select winner',
+]
+
+
+def response(msg: str, author: str, admin: bool) -> str:
+    """Determine appropriate action to take.
+
+    msg: text of incomming message from discord
+    author: the name of the user sending the message
+    admin: is the user sending the message an admin
+    """
+    if not admin and any([key in msg.lower() for key in entry_keys]):
+        if author in submissions:
+            return f'No worries, {author}, we already got you 😉'
+        else:
+            submissions.add(author)
+            return f'Good Luck, {author}!'
+
+    if admin and any([key in msg.lower() for key in selection_keys]):
+        if submissions:
+            winner = random.choice(list(submissions))
+            submissions.remove(winner)
+            return f'Congratulations {winner}! 🎉'
+        else:
+            return 'Looks like there is nobody to win'
+
+
+@client.event
+async def on_ready():
+    print(f'raffle-bot is online!')
+
+
+@client.event
+async def on_message(message):
+    if message.author == client.user:
+        return
+
+    msg = response(
+        msg=message.content,
+        author=str(message.author).split("#")[0],
+        admin=message.author.guild_permissions.administrator,
+    )
+    print(msg)
+    await message.channel.send(msg)
+
+
+if __name__ == '__main__':
+    client.run(os.getenv('TOKEN'))

raffle-bot/test_raffle_bot.py

@@ -0,0 +1,80 @@
+import raffle_bot
+
+
+def test_admin_says_pick_me():
+    raffle_bot.submissions = set()
+
+    msg = raffle_bot.response(
+        msg='pick me',
+        author='admin',
+        admin=True,
+    )
+
+    assert raffle_bot.submissions == set()
+    assert msg is None
+
+
+def test_user_says_pick_me():
+    raffle_bot.submissions = set()
+
+    msg = raffle_bot.response(
+        msg='pick me',
+        author='user',
+        admin=False,
+    )
+
+    assert raffle_bot.submissions == {'user'}
+    assert 'good luck' in msg.lower()
+
+
+def test_user_already_submitted():
+    raffle_bot.submissions = {'user'}
+
+    msg = raffle_bot.response(
+        msg='pick me',
+        author='user',
+        admin=False,
+    )
+
+    assert raffle_bot.submissions == {'user'}
+    assert 'no worries' in msg.lower()
+
+
+def test_user_picks_winner():
+    raffle_bot.submissions = {'user'}
+
+    msg = raffle_bot.response(
+        msg='pick winner',
+        author='user',
+        admin=False,
+    )
+
+    assert raffle_bot.submissions == {'user'}
+    assert msg is None
+
+
+def test_admin_picks_winner_with_entries():
+    raffle_bot.submissions = {'user'}
+
+    msg = raffle_bot.response(
+        msg='pick winner',
+        author='admin',
+        admin=True,
+    )
+
+    assert raffle_bot.submissions == set()
+    assert 'congratulations' in msg.lower()
+    assert 'user' in msg
+
+
+def test_admin_picks_winner_without_entries():
+    raffle_bot.submissions = set()
+
+    msg = raffle_bot.response(
+        msg='pick winner',
+        author='admin',
+        admin=True,
+    )
+
+    assert raffle_bot.submissions == set()
+    assert 'nobody' in msg.lower()

requirements.txt

@@ -0,0 +1,3 @@
+python-dotenv==0.15.0
+discord.py==1.5.1
+pytest==6.2.1