tomassirio / listbot Goto Github PK

View Code? Open in Web Editor NEW

23.0 5.0 49.0 5.33 MB

ListBot is a Discord Bot which let's you create community lists on each channel.

Home Page: https://discord.io/siriobots

License: MIT License

JavaScript 90.46% Shell 9.22% Dockerfile 0.32%

hacktoberfest hacktoberfest2020 listbot discord-bot mongo docker hacktoberfest2021 hacktoberfest-accepted

listbot's Introduction

LISTBOT

ListBot is a relatively simple Discord Bot, written in Javascript to create Lists in every channel.

Let's add everything we need on a community list!

🎉 Inspiration

A couple of friends and me wanted to keep track of the movies we wanted to watch on our discord server, so I created ListBot to do that.

✅ Add ListBot to your Discord Server

By clicking here, you can authorize ListBot to be used in your server.

You can also check out our Discord server in which we discuss what we can add to the bot, possible bug fixes, we sometimes have fun and something else in here.

🔋 Usage

Once the bot is running and connected to your Discord channel and database you can use the following commands:

    * $add <component>: adds a component to the list
    * $multi-add <element> <element> - adds mutiple elements \in a list
    * $help: shows you a message with the available commands
    * $list: lists all the components \in the channel\'s list
    * $log: a log of the versions
    * $poll <active_time_in_minutes>: creates a poll on 5 random items of the list. If attribute is not supplied the poll has no limitation of time.
    * $random: gives you a random component from the list
    * $remove <component>: removes the desired component
    * $multi-remove <element> <element> - removes multiple elements \in a list
    * $remind <time_in_minutes> <component>: adds a component to the list and reminds you of it in n minutes

⭐ Getting started

💻 Installation

Learn how to create a Discord bot and get a valid token here.

💾 To get started locally, follow these instructions:

Clone to your local computer using git.
Make sure you have Node installed; see instructions here.
Make also sure that you have MongoDB installed; see instructions here.
Create a copy of the .env.example file named .env found in ./src/config/.env.example and replace the placeholders with your bot token and MongoDB credentials
Run npm install to install all dependencies
Run npm run dev to start your server as development environment or npm run start for production

🚢 Docker

For development, you can run ListBot using Docker and Docker Compose following these steps below:

Adjust .env with your bot token
Run docker-composer up -d. This will build all containers on the first run and will be placed in the background
If you want to see the logs, just type docker-compose logs -f or read all in Portainer
If you want to stop, run docker-compose down

The docker-compose.yml file contains:

Mongo-express: *For database manager**
Mongo: The database itself
Server: ListBot
Portainer: To monitor your container services, such as logs, restarts and more.
- You need to create a local user and password
- Next page you need to choose docker local environment and after that click connect

To connect on:

Portainer: localhost:9000
Mongo-express: localhost: 8081

🏗️ Contribution Guidelines:

All contributors must read and abide by our Contributor Code of Conduct
Visit the Contributing Page for full details on how to get started.

🎃 Contributors Hacktoberfest 2020:

_{Tomas Sirio}	_{Robert Groves}	_RazCrimson	_{Alexander Wilkinson}	_{Thomas Vincent}	_AldoTurmon
_Peipr	_{Javier Ledezma}	_{Ahmad Reza}	_{Pirooz Amirpour}	_Severin	_Luna
_JDOG787	_{Nathan Dawson}	_{Abhijay Jain}	_AkiaCode	_{Adham Mohamed}	_{Akshansh Rewariya}
_{CarlyRaeJepsenStan}	_{Manish Kumar Jha}	_{Simonarde Lima}	_{ValentC- MartC-n}	_Lyd	_{Aditya DS}
_Heyimalaap	_{Carolini Rodrigues}	_{DiC3genes Dauster}	_{Giuseppe Gangi}	_{Henrique Paulo Bonfim}	_{Igor Silva}

Add yours!

👤 Who Am I?

listbot's People

Contributors

Stargazers

Watchers

Forkers

psknayak manishkrjha simonardejr aditya-ds-1806 javleds alessandrordgs oatelaus abelfubu jonathonllopez jdog787 krithikasureshbabu ankitranjan9 hpbonfim jstruk arthur-merlin joy98 khai93 carolini28 phamducquanptit kojiadrianojr akiacode khushi2031 mhimanshu712 akshansh99 pushpinder107 racofernandez toshiuk jayeshmann toyamarodrigo alsuga virender31 peiprjs anontyro aaronzshey adhammo rgroves polykhel yat2k heyimalaap janipaasiluoto ggangix vitasenka aldotu feelzor casmbu traxero friktiny szym1 gitfev

listbot's Issues

Add a Multi Remove command

The Remove command let's you remove only one element to the list. Add a MultiRemove command that lets you remove more than one on a single command

[FEATURE] Refactor for a clear, single-source of configuration for the bot.

Is your feature request related to a problem? Please describe.
This is more of a code refactoring request than a feature request. The use of process.env is sprinkled throughout the ListBot code base instead of utilizing the main config object (from src/config/index.js).

Describe the solution you'd like
It would be better if all configuration for the bot was accessed through the main config object instead of using process.env. This makes all possible settings/configuration for the bot "knowable" by reading through the config file settings (i.e. no need to search for usages of process.env in the code to see what can/should be set in the .env file or external environment variables).

This refactoring would need the following:

Find all usages of process.env and, where possible, update them so that the setting value is using the corresponding property from the main config object.
If it is not possible to update the use of process.env to come from the main config file, document the reason why and include a section explaining how the setting should be set in an environemnet variable and what the setting controls in the src/config/.env.example file.
Ensure all settings/config are documented in the .env.example file

Add your user to the contribution list in the Readme

Easy for beginners. This is all about lists in the end

Remove the .env file from the project

As a good practice, we use to add the .env file to the git repository, this is because the .env file use to have confidential information about the server and connection.

If we want to preserve the possible entries, we should create a .env.example file which has the requires structure.

Add the possibility of having Roles on the bot

Mostly for users and admin purposes

[BUG] Poll Command - Bot does not handle polls with less than 5 options in the list correctly.

Describe the bug
When a poll is started and the list has less than 5 items, the bot provides all 5 reacts for voting.

To Reproduce
Steps to reproduce the behavior:

Make sure your list has less than 5 items in it (1 - 4 items)
Send a poll command like $poll 1
You'll see that when the bot creates the poll message, it creates all 5 initial reacts for voting, when it should stop at the number of items being voted on.

Expected behavior
When a poll is started and the list has less than 5 items, the bot provides should only provide a number of reacts equal to the number of items being voted on. (e.g. if only two items in list, initial reacts should be: 1️⃣ & 2️⃣; for 3 items 1️⃣, 2️⃣, 3️⃣; etc.)

Screenshots
Here you can see a 1 minute poll run in a channel where there are only two items available in the list, yet the bot supplies all 5 reacts for voting, when it should only have two so that it matches the number of items being voted on.

The removemany command should be renamed to multi-remove

[Encryption] We need to encrypt the data saved to MongoDb

Data is private. We need to encrypt the Discord channels, users, and elements added to the list when we are saving them to the Db instance.

A next issue will add a secret key for the Hash function

[BUG] Poll is broken

2020-10-15T12:29:17.044062+00:00 app[worker.1]: /app/src/commands/poll.js:127
2020-10-15T12:29:17.044089+00:00 app[worker.1]: }
2020-10-15T12:29:17.044089+00:00 app[worker.1]: ^
2020-10-15T12:29:17.044089+00:00 app[worker.1]:
2020-10-15T12:29:17.044090+00:00 app[worker.1]: SyntaxError: Unexpected token '}'
2020-10-15T12:29:17.044091+00:00 app[worker.1]: at wrapSafe (internal/modules/cjs/loader.js:979:16)
2020-10-15T12:29:17.044091+00:00 app[worker.1]: at Module._compile (internal/modules/cjs/loader.js:1027:27)
2020-10-15T12:29:17.044138+00:00 app[worker.1]: at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
2020-10-15T12:29:17.044139+00:00 app[worker.1]: at Module.load (internal/modules/cjs/loader.js:928:32)
2020-10-15T12:29:17.044140+00:00 app[worker.1]: at Function.Module._load (internal/modules/cjs/loader.js:769:14)
2020-10-15T12:29:17.044140+00:00 app[worker.1]: at Module.require (internal/modules/cjs/loader.js:952:19)
2020-10-15T12:29:17.044140+00:00 app[worker.1]: at require (internal/modules/cjs/helpers.js:88:18)
2020-10-15T12:29:17.044141+00:00 app[worker.1]: at module.exports (/app/src/handlers/command.js:12:22)
2020-10-15T12:29:17.044141+00:00 app[worker.1]: at /app/src/index.js:16:37
2020-10-15T12:29:17.044141+00:00 app[worker.1]: at Array.forEach ()
2020-10-15T12:29:17.044142+00:00 app[worker.1]: at Object. (/app/src/index.js:14:14)
2020-10-15T12:29:17.044142+00:00 app[worker.1]: at Module._compile (internal/modules/cjs/loader.js:1063:30)
2020-10-15T12:29:17.044142+00:00 app[worker.1]: at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
2020-10-15T12:29:17.044142+00:00 app[worker.1]: at Module.load (internal/modules/cjs/loader.js:928:32)
2020-10-15T12:29:17.044143+00:00 app[worker.1]: at Function.Module._load (internal/modules/cjs/loader.js:769:14)
2020-10-15T12:29:17.044149+00:00 app[worker.1]: at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
2020-10-15T12:29:17.117259+00:00 heroku[worker.1]: Process exited with status 1

Bug on mongoose

(node:48710) UnhandledPromiseRejectionWarning: MongooseServerSelectionError: Could not connect to any servers in your MongoDB Atlas cluster. One common reason is that you're trying to access the database from an IP that isn't whitelisted. Make sure your current IP address is on your Atlas cluster's IP whitelist: https://docs.atlas.mongodb.com/security-whitelist/
at NativeConnection.Connection.openUri (/Users/tomassirio/Bots/DiscordBot/node_modules/mongoose/lib/connection.js:800:32)
at /Users/tomassirio/Bots/DiscordBot/node_modules/mongoose/lib/index.js:341:10
at /Users/tomassirio/Bots/DiscordBot/node_modules/mongoose/lib/helpers/promiseOrCallback.js:31:5
at new Promise ()
at promiseOrCallback (/Users/tomassirio/Bots/DiscordBot/node_modules/mongoose/lib/helpers/promiseOrCallback.js:30:10)
at Mongoose.connect (/Users/tomassirio/Bots/DiscordBot/node_modules/mongoose/lib/index.js:340:10)
at _callee$ (/Users/tomassirio/Bots/DiscordBot/build/utils/mongoose.js:55:31)
at tryCatch (/Users/tomassirio/Bots/DiscordBot/node_modules/regenerator-runtime/runtime.js:63:40)
at Generator.invoke [as _invoke] (/Users/tomassirio/Bots/DiscordBot/node_modules/regenerator-runtime/runtime.js:293:22)
at Generator.next (/Users/tomassirio/Bots/DiscordBot/node_modules/regenerator-runtime/runtime.js:118:21)
at asyncGeneratorStep (/Users/tomassirio/Bots/DiscordBot/build/utils/mongoose.js:3:103)
at _next (/Users/tomassirio/Bots/DiscordBot/build/utils/mongoose.js:5:194)
at /Users/tomassirio/Bots/DiscordBot/build/utils/mongoose.js:5:364
at new Promise ()
at Object. (/Users/tomassirio/Bots/DiscordBot/build/utils/mongoose.js:5:97)
at Object.init (/Users/tomassirio/Bots/DiscordBot/build/utils/mongoose.js:69:20)
(Use node --trace-warnings ... to show where the warning was created)
(node:48710) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag --unhandled-rejections=strict (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:48710) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

[FEATURE] The embedded messages look kind of sloppy

That's the list command right now. Every notification on the bot shows a similar message. It would look really nice if we could get a message like the queue on groovy

Example:

<list element>                        <author>

<list element>                        <author>

.....
n)

[BUG] $Ping command is shutting down the bot

2020-10-09T14:31:08.410764+00:00 app[worker.1]: /app/src/commands/ping.js:17
2020-10-09T14:31:08.410783+00:00 app[worker.1]: } catch (error) {
2020-10-09T14:31:08.410784+00:00 app[worker.1]: ^^^^^
2020-10-09T14:31:08.410784+00:00 app[worker.1]:
2020-10-09T14:31:08.410785+00:00 app[worker.1]: SyntaxError: Unexpected token 'catch'
2020-10-09T14:31:08.410785+00:00 app[worker.1]: at compileFunction ()
2020-10-09T14:31:08.410786+00:00 app[worker.1]: at wrapSafe (internal/modules/cjs/loader.js:931:16)
2020-10-09T14:31:08.410786+00:00 app[worker.1]: at Module._compile (internal/modules/cjs/loader.js:979:27)
2020-10-09T14:31:08.410786+00:00 app[worker.1]: at Object.Module._extensions..js (internal/modules/cjs/loader.js:1035:10)
2020-10-09T14:31:08.410787+00:00 app[worker.1]: at Module.load (internal/modules/cjs/loader.js:879:32)
2020-10-09T14:31:08.410787+00:00 app[worker.1]: at Function.Module._load (internal/modules/cjs/loader.js:724:14)
2020-10-09T14:31:08.410787+00:00 app[worker.1]: at Module.require (internal/modules/cjs/loader.js:903:19)
2020-10-09T14:31:08.410788+00:00 app[worker.1]: at require (internal/modules/cjs/helpers.js:74:18)
2020-10-09T14:31:08.410788+00:00 app[worker.1]: at module.exports (/app/src/handlers/command.js:10:16)
2020-10-09T14:31:08.410788+00:00 app[worker.1]: at /app/src/index.js:15:37
2020-10-09T14:31:08.410789+00:00 app[worker.1]: at Array.forEach ()
2020-10-09T14:31:08.410789+00:00 app[worker.1]: at Object. (/app/src/index.js:14:13)
2020-10-09T14:31:08.410789+00:00 app[worker.1]: at Module._compile (internal/modules/cjs/loader.js:1015:30)
2020-10-09T14:31:08.410790+00:00 app[worker.1]: at Object.Module._extensions..js (internal/modules/cjs/loader.js:1035:10)
2020-10-09T14:31:08.410790+00:00 app[worker.1]: at Module.load (internal/modules/cjs/loader.js:879:32)
2020-10-09T14:31:08.410790+00:00 app[worker.1]: at Function.Module._load (internal/modules/cjs/loader.js:724:14)
2020-10-09T14:31:08.529644+00:00 heroku[worker.1]: Process exited with status 1

[BUG] The help command has an undefined row

Third row

Add a command that only Admins can use $promote

The command should check if the user calling it is an Admin. It should receive as parameter a user (fe: $promote @tomassirio).

The person that adds ListBot to a server should be the first admin

The Poll command has a bug on the polling results

Basically the poll never shows the results given the votes on the emojis

Command refactor

The bot is really sloppy since it was a hobby project. If you want to change something or make something look better, then give it a try

[BUG] Poll Command - Bot does not provide the initial emoji reacts when poll has no end time.

Describe the bug
When a poll is started the bot should announce the poll via a message and create the initial reacts that are to be used for voting on that message. Currently, when a poll with no time limit is created the initial reacts are not created.

To Reproduce
Steps to reproduce the behavior:

enter $poll without specifying a time parameter or use zero, $poll 0
The bot creates the poll message, but the initial reacts (1️⃣2️⃣3️⃣4️⃣5️⃣) do not appear under the poll for voting.

Expected behavior
After the poll command is issued, the bot should announce the poll and create the initial reacts that are used to vote, regardless of if the bot has a time duration associated with it.

Screenshots
Here is what a poll without a time parameter looks like currently. Notice there are no reacts available for voting

This is what a poll with a time parameter supplied looks like. Notice the bot supplied the initial reacts that are to be used for voting.

Add a command for the Konami Code

I was thinking that it could be added as an exception on the add command or add many.

But it could be whatever you feel up to

The docker-compose file needs updating

As stated by @medusalix:

It was a real pain getting the bot to work correctly. The env_file directive in the docker-compose.yaml doesn't make any sense, as dotenv wants to read from a .env file which doesn't exist in the container. Adding a corresponding volume entry fixed that.
The devMongoUrl should point to the local mongo docker container in my opinion. Makes it way easier to test things without having to create a MongoDB Atlas account.

[FEATURE] Add a validation so that can every user can vote only once

[BUG] Remove Unused Code

Describe the bug
It seems that after some of the refactoring that's been performed recently, the code in src/commands/info/commands.js is no longer in use. It makes sense to delete this file from the repo.

[Encryption] Create a secret key for the hashing encryption

The Command table on the Bot BootUp shows commands that are not there anymore (removemany, addmany)

Take them off

$log command has a wrong path to the CHANGELOG file

change from ../CHANGELOG to ../../CHANGELOG

Add tests for the repo

This repo is getting popular, what do you think if we create a suite of tests to ensure that the incoming pull request does not broke anything?

The Contributors badge is broken (doesn't count correctly)

I created that badge using Shields.io Think you can fix it?

Format the list command output

The list command output looks kind of bad. See if you can make it any better

Improve the project setup

I have noticed that the project require some extra steps to be executed in local environments, as well, as some good practices that we could implement in here.

I have created a PR with 3 main changes:

Add a .env.example file to store the constants of the project, this will allow you to have your own copy of .env file with your personal information.
Remove node_modules from the git repository, since it could be easilly installes by running the npm install or yarn install command, also, the node_modules is the bigger in all the project.
Create a USE_DOCKER_FOR_DEVELOP environment constant, which will change the manual change of the database connection.

The PR with this changes is this one: #15

[BUG] $remind command needs a validation that arguments are being passed

[BUG] $ping command is still faulty.

(node:4) UnhandledPromiseRejectionWarning: ReferenceError: client is not defined
2020-10-09T23:33:01.843042+00:00 app[worker.1]: at Object.execute (/app/src/commands/ping.js:11:45)
2020-10-09T23:33:01.843044+00:00 app[worker.1]: at processTicksAndRejections (internal/process/task_queues.js:97:5)
2020-10-09T23:33:01.843137+00:00 app[worker.1]: (node:4) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag --unhandled-rejections=strict (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
2020-10-09T23:33:01.847679+00:00 app[worker.1]: (node:4) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
That was the issue with ping

That was the issue with ping in heroku's log

In the $remind command, the element should be deleted after the time is up. Also it should show a notification for the reminded element

Comes from issue #76

[BUG] The devMongoURL string is broken

As apointed by @rgroves:

Also, it looks like the code base is in a somewhat broken state. I had to modify src\commands\polls.js to remove an error and modify the devMongoUrl connection string in src\config\index.js. (Note: I was not using Docker)

Wrap the code to be compatible with node 6

Latest features of NodeJS, also known as EcmaScript 2017 and above, won't work in older versions than Node 8.0, in order to run scripts with all the features available, we should wrap the code using babel and polyfill.

The idea is the follwoing:

Move all the javascript files to the src directory.
Install babel and polyfill as dependencies of the project.
For development proposes no changes will needed.
For deployment, we should change the script with the following changes:
1. The environment should forced to be production in order to connect with the real mognodb parameters.
2. The src directory should be transpiled into the build directory using babel an polyfill.

[FEATURE] Create a script to encrypt the existing data on the Database

The bot needs to follow a convention

@medusalix:

The project should really follow a consistent code style: Semicolons/no semicolons, double quotes/single quotes, let for constant variables, etc... I'd suggest using a combination of Prettier and ESLint. Makes contributing so much easier.

My suggestions would be: No semicolons, single quotes and let for variables.
However, i'm not an experienced Node.js developer. So any suggestions, such as Prettier and ESLint as stated before will be considered

[ENCRYPTION] Integrate the encrypt.js file as a middleware to optimize project

Add a Multi Add command to the Bot

The Add command let's you add only one element to the list. Add a MultiAdd command that lets you add more than one on a single command

[BUG] $remind command takes string as time when no number supplied

Discord Server now Available!

It's added on the Readme. You can join here

It's still barebones but we might make it harder, better, faster, stronger

Fatal exception when list command is called and there is no collection or record created

If you try to use this bot in discord, after install the application with the bot, if you try to execute the list command it thros a fatal exception and stops the server service:

In order to reproduce this:

Create a discord application.
Create a bot for the application.
Install the application in one discord server.
Execute the $list command.

[BUG] Fix the linting checks for the github actions module

As appointed by @rgroves:

It also looks like linting checks may have been modified or added, because it looks like files that weren't part of my PR changes are failing checks. Let me know how to proceed or if this is fine. Thanks!

Add $remind functionality to list of commands

Hi @tomassirio, I liked your project and added locally a $remind command so the bot in Discord can remind you of a certain element after n minutes.
If you like it I can pull it for your review. :)

Create a CHANGELOG file and modify the $log command to feed from the Changelog file

See what you can add to the readme file

README.md is missing time option for polling command

Polling command accepts a time element for the polling but that is not documented inside the README.md.
Better documentation suggested.

[Admins] Add a $demote user

Same as de $promote command. This command should check if the user calling it is an admin. Removes the admin role of the user passed as parameter (if this user was an admin before, of course)

$list command should show the element where the user is and viceversa

Right now the format looks something line:

i - bold(authorName)
Message

it should look:

i - bold(Message)
authorName