Feature/spooktober picture command

.eslintrc.js

@@ -15,7 +15,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['lang/*.js'],
+      files: ['app/lang/*.js'],
       rules: {
         'require-jsdoc': 'off',
       },

.github/workflows/build-bot.yml

@@ -0,0 +1,23 @@
+name: Build Workflow
+on:
+  push:
+    branches:
+        - main
+jobs:
+  job_one:
+    name: Build and push docker images
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build docker-image
+        env:
+          DOCKER_USER: ${{ secrets.DOCKER_USER }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+        run: |
+          docker login -u $DOCKER_USER -p $DOCKER_PASSWORD
+          docker build -f ./docker/spooky-node/DockerfileProd --build-arg NODE_VERSION=12.18.2 -t spookybot/spookybot:latest -t spookybot/spookybot:${{github.run_number}} .
+          docker push spookybot/spookybot:${{github.run_number}}
+          docker push spookybot/spookybot:latest
+          docker logout
+
+

.github/workflows/deploy-bot.yml

@@ -0,0 +1,24 @@
+name: Deployment Workflow
+on:
+  workflow_dispatch:
+    inputs:
+      tags:
+        description: 'Tag'
+jobs:
+  deploy_prod_bot:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: appleboy/ssh-action@master
+        name: deploy to prod
+        with:
+          host: ${{ secrets.SSH_IP }}
+          port: ${{ secrets.SSH_PORT }}
+          username: spookybot
+          key: ${{ secrets.SSH_KEY }}
+          script: |
+            docker login -u ${{ secrets.DOCKER_USER  }} -p ${{ secrets.DOCKER_PASSWORD }}
+            docker pull spookybot/spookybot:latest
+            docker-compose -f /home/spookybot/docker-compose.yml down -v
+            docker-compose -f /home/spookybot/docker-compose.yml up -d
+            docker logout
+

.gitignore

@@ -15,13 +15,15 @@ jspm_packages/
 
 # Optional eslint cache
 .eslintcache
+.eslintrc.js
 
 # Yarn Integrity file
 .yarn-integrity
 
 # config file
-config.json
-
+app/config/config.json
 # IDE
 .idea
 *.iml
+
+

Makefile

@@ -0,0 +1,14 @@
+DOCKERCOMPOSE_DEV=-f docker-compose.dev.yml
+
+
+.PHONY: build_dev_image
+build_dev_image:
+	docker build -f ./docker/spooky-node/DockerfileDev -t spookybot:dev .
+
+.PHONY: startup_dev
+startup_dev:
+	docker-compose ${DOCKERCOMPOSE_DEV} up -d
+
+.PHONY: stop_dev
+stop_dev:
+	docker-compose ${DOCKERCOMPOSE_DEV} down -v

README.md

@@ -18,7 +18,7 @@ You just need to click on [this link](https://discord.com/oauth2/authorize?clien
 
 You can add languages to the robot so that it is translated and accessible to everyone!
 
-To do this, nothing could be simpler, just copy the file `./lang/en.js` then rename it following the [ISO 639-1 nomenclature](http://www.mathguide.de/info/tools/languagecode.html).
+To do this, nothing could be simpler, just copy the file `./app/lang/en.js` then rename it following the [ISO 639-1 nomenclature](http://www.mathguide.de/info/tools/languagecode.html).
 Then you just need to modify the file as you wish. For the translation to be set up on the robot, do not hesitate to open a pull request by [following this guide](https://github.com/LucasCtrl/spookyBot/blob/main/README.md#-contributing).
 
 To react to a word, you need two elements in the translation file: the word and the emoji with which it will react.
@@ -34,10 +34,11 @@ You can see that the `emoji` element is an emoji, but you can also use a custom
 
 ## 💻 Testing locally
 1. Create a bot [on the Discord developer portal](https://discord.com/developers/applications),
-2. Create a webhook on your own discord server [by folloing this tutorial](https://docs.gitlab.com/ee/user/project/integrations/discord_notifications.html),
-3. Copy the `config.example.json` from the project to `config.json` and fill in the gaps with the information from the bot and the webhook. The first token is on the bot page accessed from the side of the Discord Developer Portal, and the webook information is found on the page when you navigate to the webhook url,
+2. Create a webhook on your own discord server [by following this tutorial](https://docs.gitlab.com/ee/user/project/integrations/discord_notifications.html),
+3. Copy the `./app/config/config.example.json` from the project to `./app/config/config.json` and fill in the gaps with the information from the bot and the webhook. The first token is on the bot page accessed from the side of the Discord Developer Portal, and the webook information is found on the page when you navigate to the webhook url,
 4. Invite your dev bot to your server by [following this url](https://discord.com/oauth2/authorize?client_id=761568927188123669&scope=bot&permissions=1141124160), replacing the client id with your bot's client id (found on it's general information page), and the permissions with the Permission Integer created in the Developer Portal as you select permissions for your bot,
-5. Once these steps are setup, simply run `yarn install` and `npm run dev` from the terminal in the root directory of the repo,
+5. Once these steps are setup, simply run `make startup_dev` from the terminal in the root directory of the repo,
+5.1 If you want to install node modules you could just add it into your local package.json and run the `make build_dev_image` after that you need to recreate the container.
 6. Test the bot is connected by running `<your-prefix>help` to get a list of commands, and then initialize the DB by running `<your-prefix>emitgc`. It should then respond with "Join <your-server> with <#> users,
 7. Test that the bot reacts to comments by typing one of the words in `lang/<your-lang>.js`. The bot should respond with an emoji!
 

commands/Configuration/setlang.js → app/commands/Configuration/setlang.js

@@ -1,11 +1,13 @@
 const { MessageEmbed } = require('discord.js')
-const { prefix, colors } = require('../../config.json')
+const { prefix, colors } = require('../../config/config.json')
 
 const { readdirSync } = require('fs')
 const { resolve } = require('path')
 
 const { changeLang } = require('../../models/servers')
 
+const ISOCode = require('../../utils/languageCode')
+
 module.exports = {
   config: {
     command: 'setlang',
@@ -40,18 +42,22 @@ module.exports = {
       changeLang(message.guild.id, args[0])
     } else {
       // The language doesn't exist
-      let messageContent = ['The requested language does not exist, please choose a language from this list:']
-      availableLang.forEach((lang) => messageContent.push(`- **${lang}**`))
+      let messageContent = [
+        'The requested language does not exist, please choose a language from this list: (the bold part)',
+      ]
+      availableLang.forEach((lang) => messageContent.push(`- **${lang}**: ${ISOCode.find((l) => l.code == lang).name}`))
 
       const embed = new MessageEmbed()
         .setColor(colors.primary)
         .setDescription(messageContent)
-        .setFooter('This message will be deleted automatically')
+        .setFooter(
+          "If you can't find your language, don't hesitate to contact us by using the command boo!support | This message will be deleted automatically"
+        )
 
       message.channel.send(embed).then((m) => {
         setTimeout(() => {
           m.delete()
-        }, 10000)
+        }, 20000)
       })
     }
   },

commands/Info/help.js → app/commands/Info/help.js

@@ -1,6 +1,6 @@
 const { MessageEmbed } = require('discord.js')
-const { prefix, colors } = require('../../config.json')
-const { version } = require('../../package.json')
+const { prefix, colors } = require('../../config/config.json')
+const { version } = require('../../../package.json')
 
 module.exports = {
   config: {

commands/Info/invite.js → app/commands/Info/invite.js

@@ -1,5 +1,5 @@
 const { MessageEmbed } = require('discord.js')
-const { prefix, colors } = require('../../config.json')
+const { prefix, colors } = require('../../config/config.json')
 
 module.exports = {
   config: {

commands/Info/ping.js → app/commands/Info/ping.js

@@ -1,5 +1,5 @@
 const { MessageEmbed } = require('discord.js')
-const { prefix, colors } = require('../../config.json')
+const { prefix, colors } = require('../../config/config.json')
 
 module.exports = {
   config: {

app/commands/Info/stats.js

@@ -0,0 +1,32 @@
+const { MessageEmbed } = require('discord.js')
+const { prefix, colors } = require('../../config/config.json')
+
+module.exports = {
+  config: {
+    command: 'stats',
+    name: 'Stat',
+    description: 'Give you some statistics about the bot',
+    usage: `${prefix}stats`,
+    displayHelp: true,
+  },
+
+  run: async (bot, message, args) => {
+    const memoryStats = process.memoryUsage()
+
+    const embed = new MessageEmbed()
+      .setColor(colors.primary)
+      .setAuthor(`Stats - ${bot.user.username}`, bot.user.avatarURL({ dynamic: true }))
+      .addField('Number of servers ¬', bot.guilds.cache.size.toLocaleString(), true)
+      .addField(
+        'Number of users ¬',
+        bot.guilds.cache.reduce((mem, g) => (mem += g.memberCount), 0),
+        true
+      )
+      .addField('Number of emojis ¬', bot.emojis.cache.size, true)
+      .addField('Number of channels ¬', bot.channels.cache.size, true)
+      .addField('Memory usage ¬', `${Math.ceil(memoryStats.heapUsed / 1048576)} Mo`, true)
+      .setFooter(`Requested by ${message.author.username}`, message.author.avatarURL({ dynamic: true }))
+
+    message.channel.send(embed)
+  },
+}

commands/Info/support.js → app/commands/Info/support.js

@@ -1,5 +1,5 @@
 const { MessageEmbed } = require('discord.js')
-const { prefix, colors } = require('../../config.json')
+const { prefix, colors } = require('../../config/config.json')
 
 module.exports = {
   config: {

app/commands/Info/vote.js

@@ -0,0 +1,23 @@
+const { MessageEmbed } = require('discord.js')
+const { prefix, colors } = require('../../config/config.json')
+
+module.exports = {
+  config: {
+    command: 'vote',
+    name: 'Vote',
+    description: 'Vote for the bot',
+    usage: `${prefix}vote`,
+    displayHelp: true,
+  },
+
+  run: async (bot, message, args) => {
+    const embed = new MessageEmbed()
+      .setColor(colors.primary)
+      .setAuthor('Support server', bot.user.avatarURL())
+      .setDescription(
+        'You can vote for the bot by clicking on the following link: [https://discordbotlist.com/bots/spookybot/upvote](https://discordbotlist.com/bots/spookybot/upvote)'
+      )
+
+    message.channel.send(embed)
+  },
+}

commands/Sound/playsound.js → app/commands/Sound/playsound.js

@@ -1,15 +1,16 @@
-const { prefix } = require('../../config.json')
+const { MessageEmbed } = require('discord.js')
+const { prefix } = require('../../config/config.json')
 const { readdirSync } = require('fs')
 const { resolve } = require('path')
 
 module.exports = {
   config: {
     name: 'Boo Sound',
     usage: `${prefix}booh`,
-    description: 'Display this menu',
+    description: 'Joins your voice channel and scares you',
     command: 'booh',
     aliases: ['buh', 'scare'],
-    displayHelp: false,
+    displayHelp: true,
   },
 
   run: async (bot, message, args) => {
@@ -27,7 +28,15 @@ module.exports = {
         connection.voice.channel.leave()
       })
     } else {
-      message.author.send('How can I scare your companions without you beeing present in the voice channel?')
+      const embed = new MessageEmbed()
+        .setTitle('How can I scare your companions without you beeing present in the voice channel?')
+        .setColor(colors.primary)
+
+      message.channel.send(embed).then((m) => {
+        setTimeout(() => {
+          m.delete()
+        }, 5000)
+      })
     }
   },
 }

app/commands/Text/trickortreat.js

@@ -0,0 +1,76 @@
+const { MessageEmbed } = require('discord.js')
+const { prefix, colors } = require('../../config/config.json')
+
+const { treat, trick, createTrickOrTreat, getTrickOrTreat } = require('../../models/trickortreats')
+
+const isToday = (someDate) => {
+  const today = new Date()
+  const currentDate = new Date(Date.parse(someDate))
+
+  return (
+    currentDate.getDate() == today.getDate() &&
+    currentDate.getMonth() == today.getMonth() &&
+    currentDate.getFullYear() == today.getFullYear()
+  )
+}
+
+module.exports = {
+  config: {
+    name: 'Trick or Treat',
+    usage: `${prefix}trickortreat`,
+    description: 'Gives you candy or scares you 😈',
+    command: 'trickortreat',
+    aliases: ['tot'],
+    displayHelp: true,
+  },
+
+  run: async (bot, message, args) => {
+    let trickOrTreat = await getTrickOrTreat(message.author.id)
+
+    if (!trickOrTreat) {
+      await createTrickOrTreat(message.author.id)
+      trickOrTreat = await getTrickOrTreat(message.author.id)
+    }
+
+    if (!trickOrTreat.lastPlayed || !isToday(trickOrTreat.lastPlayed)) {
+      if (Math.random() >= 0.5) {
+        trickOrTreat = await trick(message.author.id)
+
+        let embed = await new MessageEmbed()
+          .setTitle(':smiling_imp: Oh no!, You have been tricked!')
+          .setColor(colors.info)
+          .setDescription('Better luck tomorrow!')
+          .addField(':candy: Candys', trickOrTreat.treats, true)
+          .addField(':smiling_imp: Tricks', trickOrTreat.tricks, true)
+          .setFooter(message.author.username, message.author.avatarURL({ dynamic: true }))
+          .setTimestamp(new Date())
+
+        await message.channel.send(embed)
+      } else {
+        trickOrTreat = await treat(message.author.id)
+
+        let embed = await new MessageEmbed()
+          .setTitle(':candy: Sweet, sweet candy!')
+          .setColor(colors.error)
+          .setDescription('There will be more candy up for grabs tomorrow!')
+          .addField(':candy: Candys', trickOrTreat.treats, true)
+          .addField(':smiling_imp: Tricks', trickOrTreat.tricks, true)
+          .setFooter(message.author.username, message.author.avatarURL({ dynamic: true }))
+          .setTimestamp(new Date())
+
+        await message.channel.send(embed)
+      }
+    } else {
+      const embed = new MessageEmbed()
+        .setTitle('It looks like you have already played today.')
+        .setColor(colors.primary)
+        .setDescription('There will be more candy up for grabs tomorrow!')
+        .addField(':candy: Candys', trickOrTreat.treats, true)
+        .addField(':smiling_imp: Tricks', trickOrTreat.tricks, true)
+        .setFooter(message.author.username, message.author.avatarURL({ dynamic: true }))
+        .setTimestamp(new Date())
+
+      message.channel.send(embed)
+    }
+  },
+}

app/config/config.example.json

@@ -0,0 +1,21 @@
+{
+  "token": "",
+  "prefix": "boo!",
+  "webhook": {
+    "id": "",
+    "token": ""
+  },
+  "colors": {
+    "primary": "#FF6403",
+    "success": "#2ECC71",
+    "error": "#E74C3C",
+    "info": "#7C5398"
+  },
+  "reddit": {
+    "userAgent": "SpookyBot, a Discord bot to celebrate Halloween",
+    "clientId": "",
+    "clientSecret": "",
+    "refreshToken": ""
+  }
+}
+

core.js → app/core.js

@@ -1,6 +1,6 @@
 const { Client, Collection, WebhookClient } = require('discord.js')
 
-const { token, webhook } = require('./config.json')
+const { token, webhook } = require('./config/config.json')
 
 const bot = new Client()
 

db/servers.json → app/db/servers.json

@@ -1,3 +1,3 @@
 {
   "servers": []
-}
+}