Merge pull request #54 from BeelanMX/develop

Add CFE BOT

Author: wolftrax5

.gitignore

@@ -104,4 +104,5 @@ dist
 .tern-port
 
 
-pictures/
+assets/*
+!assets/.gitkeep

CFEScraping/index.js

@@ -0,0 +1 @@
+worker:  node index.js

Procfile

@@ -16,11 +16,47 @@ $ yarn install
 # Run the app
 $ yarn start
 ```
+## How to use Discord Bot
+
+### Requirements
+
+1. Discord Bot Token **[Guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)**
+2. Discord.js v12.0.0
+3. Node.js v14.0.0 or newer
+
+Follow the provided guide to create your own bot aplication from the page **[Discord Developer Portal](https://discord.com/developers/applications)**.
+After you cloned this repository and installed all the necessary dependecies, you'll need to create an `.env` file in the root of repository using the structure shown in the env.sample of this repository. 
+You can use the prefix that you like the most.
+
+(⚠️ **Note: Never commit or share your token or api keys publicly** ⚠️)
+
+
+```sh
+
+#To run the bot
+$ node index.js
+
+```
+
 
 ## Node
 
 This application is created using [Node14](https://nodejs.org/dist/latest-v14.x/docs/api/)
 
+## Puppeteer with Node & linux
+
+We are using the library [Puppeteer v10.1.0](https://pptr.dev/#?product=Puppeteer&version=v10.1.0)
+To run in linux or WSL2 need install chromium-browser
+
+```
+#!/bin/bash
+$ sudo apt-get update
+$ sudo apt-get install chromium-browser
+$ sudo apt-get install -y libgbm-dev
+```
+
+if there is some issues there are some reference [here](https://stackoverflow.com/a/65497048/7351895), [here](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#chrome-is-downloaded-but-fails-to-launch-on-nodejs-14)
+
 ### VsCode Extensions
 
 Name: [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

README.md

@@ -0,0 +1,57 @@
+'use strict';
+
+const Validation = require('../utils/validator');
+const myValidator = new Validation();
+const sendMessage = require('../utils/sendTableMessage');
+const Scrapper = require('../webScraping/cfeScrapper');
+
+/**
+ * Main function of the command
+ * @param { Message } message Channel to send the data
+ * @arg { searchItems } args Searching parameters
+ * @return { void }
+ */
+async function execute(message, args) {
+  if (!args || args.length === 0) {
+    return message.channel.send('The command needs a searching parameter.');
+  }
+  const route = `./assets/cfe_${args.join('').toLowerCase()}.json`;
+  args = args.join(' ');
+  const executeScrapper = myValidator.isFileLastUpdateIn(route);
+  if (!executeScrapper) {
+    message.reply('Is needed execute the scrapper, executing...');
+
+    try {
+      const cfeScrapper = new Scrapper(args);
+      // Show how many data has been obtained
+      cfeScrapper.printPercentage = (percentage) => {
+        message.reply(`Loading data ${percentage.toString()} %`);
+      };
+      const scrap = await cfeScrapper.doScraping(route);
+      if (scrap === false) {
+        // There's no data available
+        message.reply(`There's no data available with ${args}`);
+        return;
+      }
+    } catch (error) {
+      message.reply(`An error in the execution...${error}`);
+    }
+  } else {
+    // If the file exists and was created in the lasts 20hr
+    message.reply('Is not needed execute the scrapper');
+  }
+
+  // Send a message with the data obtained
+  const tableMessage = sendMessage.jsonToEmbedMessage(route);
+  for (let i = 0; i < tableMessage.length; i++) {
+    message.reply(tableMessage[i]);
+  }
+  message.reply('That is all the data I found');
+}
+
+module.exports = {
+  name: 'cfe',
+  description: 'Get searching parameters from the user.',
+  cooldown: 3,
+  execute,
+};

assets/.gitkeep

@@ -0,0 +1,55 @@
+/* eslint-disable indent */
+const prefix = process.env.PREFIX;
+
+module.exports = {
+  name: 'help',
+  description: 'List all of my commands or info about a specific command.',
+  aliases: ['commands'],
+  usage: '[command name]',
+  cooldown: 5,
+  execute(message, args) {
+    const data = [];
+    // eslint-disable-next-line object-curly-spacing
+    const { commands } = message.client;
+
+    if (!args.length) {
+      // eslint-disable-next-line quotes
+      data.push("Here's a list of all my commands:");
+      data.push(commands.map((command) => command.name).join(', '));
+      data.push(
+        // eslint-disable-next-line max-len
+        `\nYou can send \`${prefix}help [command name]\` to get info on a specific command.`,
+      );
+
+      // eslint-disable-next-line object-curly-spacing
+      return message.channel.send(data, { split: true });
+    }
+
+    const name = args[0].toLowerCase();
+    const command =
+      commands.get(name) ||
+      commands.find((c) => c.aliases && c.aliases.includes(name));
+
+    if (!command) {
+      // eslint-disable-next-line quotes
+      return message.reply("That's not a valid command.");
+    }
+
+    data.push(`**Name:** ${command.name}`);
+
+    if (command.aliases) {
+      data.push(`**Aliases:** ${command.aliases.join(', ')}`);
+    }
+    if (command.description) {
+      data.push(`**Description:** ${command.description}`);
+    }
+    if (command.usage) {
+      data.push(`**Usage:** ${prefix}${command.name} ${command.usage}`);
+    }
+
+    data.push(`**Cooldown:** ${command.cooldown || 3} second(s)`);
+
+    // eslint-disable-next-line object-curly-spacing
+    message.channel.send(data, { split: true });
+  },
+};

commands/cfe.js

@@ -0,0 +1,2 @@
+TOKEN=
+PREFIX=

commands/help.js

@@ -1,12 +1,96 @@
-try {
-    const OpenBrowser = require('./cfeScraping/index.js');
+/* eslint-disable indent */
+'use strict';
+// we're gonna use strict mode in all
 
-    'use strict';
-    // we're gonna use strict  mode in all
+require('dotenv').config();
 
-    console.log('Hello Message');
-    OpenBrowser.OpenBrowser();
+const fs = require('fs');
+const Discord = require('discord.js');
+const cooldowns = new Map();
+// eslint-disable-next-line object-curly-spacing
+const { Client, Collection, Intents } = require('discord.js');
+const client = new Client({
+  intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES],
+});
+// Assign the value "!" to the constant prefix, which you will use as the
+// bot prefix.
+const prefix = process.env.PREFIX;
 
-} catch (err) {
-    console.error('An error have been occurred:', err);
-}
+client.commands = new Collection();
+
+const commandFiles = fs
+  .readdirSync('./commands')
+  .filter((file) => file.endsWith('.js'));
+
+for (const file of commandFiles) {
+  const command = require(`./commands/${file}`);
+  // Set a new item in the Collection
+  // With the key as the command name and the value as the exported module
+  client.commands.set(command.name, command);
+}
+
+client.on('ready', readyDiscord);
+
+/**
+ * Verify if the bot is connected
+ */
+function readyDiscord() {
+  console.log('Ready');
+}
+
+// Check if the content of the message that the bot is processing starts with
+// the prefix you set and if it doesn't stop processing
+// eslint-disable-next-line space-before-function-paren
+client.on('message', function (message) {
+  if (message.author.bot) return;
+  if (!message.content.startsWith(prefix)) return;
+
+  // Convert the rest of the message to a command name and any arguments that
+  // may exist in the message.
+  const args = message.content.slice(prefix.length).trim().split(/ +/);
+  const commandName = args.shift().toLowerCase();
+
+  if (!client.commands.has(commandName)) return;
+  const command = client.commands.get(commandName);
+
+  // If cooldowns map doesn't have a command.name key then create one.
+  if (!cooldowns.has(command.name)) {
+    cooldowns.set(command.name, new Discord.Collection());
+  }
+
+  const currentTime = Date.now();
+  const timeStamps = cooldowns.get(command.name);
+  const cooldownAmount = command.cooldowns * 1000;
+
+  // If time_stamps has a key with the author's id then check the
+  // expiration time to send a message to a user.
+  if (timeStamps.has(message.author.id)) {
+    const expirationTime = timeStamps.get(message.author.id) + cooldownAmount;
+
+    if (currentTime < expirationTime) {
+      const timeLeft = (expirationTime - currentTime) / 1000;
+
+      return message.reply(
+        `Please wait ${timeLeft.toFixed(1)} more seconds before using ${
+          command.name
+          // eslint-disable-next-line comma-dangle
+        }`
+      );
+    }
+  }
+
+  // If the author's id is not in timeStamps then add them with the current
+  // time.
+  timeStamps.set(message.author.id, currentTime);
+  // Delete the user's id once the cooldown is over.
+  setTimeout(() => timeStamps.delete(message.author.id), cooldownAmount);
+
+  try {
+    command.execute(message, args);
+  } catch (error) {
+    console.error(error);
+    message.reply('Error trying to execute that command.');
+  }
+});
+
+client.login(process.env.TOKEN);