This repository has been archived on 2022-11-03. You can view files and clone it, but cannot push or open issues or pull requests.
MatterBot/README.md

117 lines
5.1 KiB
Markdown
Raw Normal View History

2021-12-03 10:29:32 +01:00
# matter_bot
2022-01-04 18:18:04 +01:00
Au début, `matter_bot` devait être un bot qui fait le pont entre Discord et Mattermost.
2022-01-05 02:38:31 +01:00
Malheureusement, je n'ai pas réussi à recevoir les messages depuis Mattermost...
MAIS, tout ce qui est du côté de Discord devrait fonctionner proprement.
2022-01-04 18:18:04 +01:00
J'ai laissé tout ce que j'ai commencé pour Mattermost, il faut donc quand-même renseigner
les variables demandés ci-dessous pour pouvoir lancer le bot.
2021-12-03 10:29:32 +01:00
## Pré-requis
`openssl` requis par [`mattermost_api`](https://github.com/Celeo/mattermost_api)
2021-12-10 16:50:20 +01:00
```bash
sudo apt install libssl-dev
```
2021-12-21 10:32:33 +01:00
`.env` placé dans la racine du projet qui contient ses différentes variables :
2021-12-03 10:29:32 +01:00
```
2022-01-06 19:20:52 +01:00
TOKEN_DISCORD=votre_token_ici # OBLIGATOIRE | Token Discord
2022-01-06 18:38:45 +01:00
TOKEN_MATTERMOST=votre_token_ici # OBLIGATOIRE? | Pas besoin de token si vous mettez un combo pseudo/mot-de-passe
2022-01-06 19:20:52 +01:00
PSEUDO_MATTERMOST=votre_pseudo_ici # OBLIGATOIRE? | Pas besoin de pseudo si un token est renseigné
MDP_MATTERMOST=votre_mot-de-passe_ici # OBLIGATOIRE? | Pas besoin de mot de passe si un token est renseigné
2022-01-06 18:38:45 +01:00
# -> Si les 2 méthode de connexion pour Mattermost sont renseignées (token et pseudo/mot-de-passe), le bot ne se lancera pas.
2022-01-06 19:20:52 +01:00
URL_MATTERMOST=url_instance_mattermost_ici # OBLIGATOIRE | Ex: https://talk.up8.edu
SALON_MATTERMOST=nom_du_salon # OBLIGATOIRE | Ex: off-topic
EQUIPE_MATTERMOST=nom_de_lequipe # FACULTATIF | Ex: etudiant-es
2022-01-06 18:38:45 +01:00
# -> Va permettre d'afficher les informations d'une équipe à chaque démarrage du bot.
PREFIX=votre_prefix_ici # OBLIGATOIRE | Commun aux deux bots, par défaut: `ç`
2021-12-03 10:48:11 +01:00
```
2022-01-06 18:38:45 +01:00
---
### Intégrations
2022-01-04 18:18:04 +01:00
#### Mattermost
Dans le cas ou vous optez pour le token, vous devez ajouter un bot, pour ce faire (d'après la [documentation officielle](https://developers.mattermost.com/integrate/admin-guide/admin-bot-accounts/)) :
2022-01-05 02:38:31 +01:00
- Cliquez sur les 9 carrés en haut à gauche
- Integrations
- Bot Accounts
- Add Bot Account
- Remplissez les champs
2022-01-03 11:30:56 +01:00
- Cochez la case `post:all` pour être sur qu'il n'y aura pas de problèmes de permission (facultatif)
- Create Bot Account
2021-12-21 11:15:07 +01:00
- Dans la page suivante, vous aurez votre token d'accès
2022-01-04 18:21:50 +01:00
#### Discord
2022-01-06 18:38:45 +01:00
Pour obtenir un token pour le bot Discord, il y a ce [tuto fait pour la librairie Javascript](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot) qui explique bien.
2022-01-04 18:21:50 +01:00
2021-12-21 10:14:59 +01:00
---
### Tests en local
En local, j'ai utilisé Docker pour héberger mon instance de Mattermost et pouvoir faire des tests, voici le docker-compose que j'ai utilisé :
2021-12-21 10:15:33 +01:00
```docker
2021-12-21 10:14:59 +01:00
version: "2"
services:
mattermost:
image: mattermost/mattermost-preview:latest # version preview parce que c'est juste pour testé
container_name: Mattermost
ports:
- 8065:8065 # cf. documentation officielle : https://docs.mattermost.com/install/setting-up-local-machine-using-docker.html
restart: unless-stopped
```
2021-12-21 09:34:43 +01:00
---
### Sources
2021-12-21 10:05:47 +01:00
- [Documentation `mattermost_api`](https://docs.rs/mattermost_api/0.1.0/mattermost_api/) (utilisé pour communiquer avec Mattermost)
- `tokio` (utilisé car `mattermost_api` est `async`)
2022-01-06 18:38:45 +01:00
- `serde` (utilisé pour ma structure de salon [j'ai fait comme `mattermost_api`])
- `serde_json` (utilisé pour gérer le format `json`)
2022-01-03 11:33:33 +01:00
- [Documentation `chrono`](https://rust-lang-nursery.github.io/rust-cookbook/datetime/parse.html) (utilisé pour l'analyse des timestamps)
2022-01-04 18:18:04 +01:00
- [Documentation `serenity`](https://docs.rs/serenity/latest/serenity/client/trait.EventHandler.html) (utilisé pour communiquer avec Discord)
2022-01-04 18:23:15 +01:00
- Je me suis aidé de mes [réponses aux rustlings](https://code.up8.edu/Anri/2021-rustlings/-/tree/reponses/exercises) pour me rafraîchir la mémoire sur certains points
- [Documentation de l'`API Mattermost`](https://api.mattermost.com/) (évidemment pour savoir comment Mattermost fonctionne)
2021-12-21 09:34:43 +01:00
2021-12-21 09:26:03 +01:00
---
2022-01-03 10:20:21 +01:00
### Estimation du temps de build
2022-01-05 02:38:31 +01:00
Sur ma machine (WSL), le temps de build est d'environ une minute.
2022-01-03 10:20:21 +01:00
2022-01-07 14:54:50 +01:00
- `time cargo build` :
2022-01-03 10:20:21 +01:00
```
________________________________________________________
2022-01-05 01:44:12 +01:00
Executed in 53.25 secs fish external
usr time 229.21 secs 134.00 micros 229.21 secs
sys time 19.56 secs 149.00 micros 19.56 secs
2022-01-03 10:20:21 +01:00
```
2022-01-07 14:54:50 +01:00
- `cargo bench`
```
Finished bench [optimized] target(s) in 1m 00s
```
2022-01-06 18:38:45 +01:00
---
2022-01-05 01:43:19 +01:00
### Résumé
Beaucoup de blabla, au final, qu'est ce qui fonctionne ?
- [x] Pont Discord -> Mattermost
- [ ] Pont Mattermost -> Discord
- [x] Commandes Discord
- [ ] Commandes Mattermost
Cependant, je pense avoir fait 50% du travail pour le pont Mattermost, il manque, je pense, une implémentation du websocket de la part
2022-01-05 02:38:31 +01:00
du [responsable de `mattermost_api`](https://github.com/Celeo). J'ai essayé de le faire moi-même mais pas réussi.
2022-01-05 01:43:19 +01:00
2022-01-06 18:38:45 +01:00
---
### Exécution
```
git clone git@code.up8.edu:Anri/matter_bot.git matter_bot_akennel
cd matter_bot_akennel
# Créez et complétez le .env
cargo run
```
2022-01-05 02:28:45 +01:00
<div align="center">
<img src="assets/demonstration.gif" alt="Exemple d'utilisation de matter_bot" width="1000" />
</div>
2022-01-05 02:23:56 +01:00
2022-01-03 10:20:21 +01:00
---
2022-01-04 18:23:15 +01:00
*Projet ne fonctionne pas avec l'instance de la Fac, car son Mattermost se connecte via Gitlab et (je crois?) aucune librairie ne supporte ceci en Rust.*