mgdelacroix/birthdaybot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
52 commits 1 branch 0 tags 80 KiB
Go 97.3%
Nix 1.8%
Makefile 0.9%
Find a file
Miguel de la Cruz 7dae3def51 Adds the GetYearsOld function to the templates
2023-07-10 23:27:18 +02:00
cmd/birthdaybot Adds logger config 2023-07-10 14:55:47 +02:00
model Adds a test for the birthday filename 2023-07-10 22:44:48 +02:00
notification Move get picture to a utils package so it can be reused 2023-07-10 23:09:25 +02:00
parser Add a test for the CSV parser and check errors on the read config 2023-06-30 09:51:34 +02:00
server Adds the GetYearsOld function to the templates 2023-07-10 23:27:18 +02:00
utils Move get picture to a utils package so it can be reused 2023-07-10 23:09:25 +02:00
.envrc Initial commit 2023-06-29 18:55:13 +02:00
.gitignore Restructures configuration for birthdays and adds pictures directory 2023-07-10 21:08:05 +02:00
.gitlab-ci.yml Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
birthdays.csv Create a sample birthday.csv file 2023-06-30 11:38:03 +02:00
example-config.yml Restructures configuration for birthdays and adds pictures directory 2023-07-10 21:08:05 +02:00
go.mod Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
go.sum Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
Makefile Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00
README.md Complete task on readme 2023-07-10 21:31:54 +02:00
sample.tmpl Adds templates to birthday message 2023-07-10 20:46:12 +02:00
shell.nix Adds go mock and generate make target and CI check 2023-07-10 12:29:25 +02:00

README.md

pipeline status

Birthday bot

A simple bot that notifies of birthdays, posting the contact information of the subject so you can reach them easily.

Configuration

There is an example configuration file that can be used as a base to create your own configuration, and there is a birthdays example CSV file to load the data.

Template file

The template can be configured using the birthday_template config parameter to point to the template file. The template uses the Go Template Format, and has the following properties available:

  • .Name: the name of the person whose birthday we're notifying.
  • .Email: the email of the person.
  • .Phone: the phone of the person, as a string.
  • .YearOfBirth: the year that the person was born, as number.
  • .MonthOfBirth: the month that the person was born, as number.
  • .DayOfBirth: the day that the person was born, as number.

Pictures

Alongside the notification for each birthday, the bot can send a picture for the person with the notification message. For this to happen, you need to put the pictures in a folder, and point the configuration to this folder using the property birthdays.pictures.

Each file should be named accordingly of the birthday it corresponds to. The naming schema is YEAR_MONTH_DAY_PHONE.png, so for a person born the 1st of July of 2020, with the phone 4567, the file name for their picture would be 2020_6_1_4567.png

Run the bot

To get help for the bot command, run:

$ ./birthdaybot -help
Usage of ./birthdaybot:
  -config string
        path to the configuration file (default "birthdaybot.yml")

To run the server with the development defaults, run:

$ make run

Roadmap

  • Create the bot scaffold
  • Define how to read the birthdays info
  • Add a logger instance to the config
  • Add config validation on server creation
  • Add options to the server
  • Pass logger to the server through an option
  • Configure logger through config (levels and such)
  • Reduce logger verbosity (through levels)
  • Add pictures to birthday notifications
  • Create a configurable template to fill with each notification
  • Create different message systems to use with the bot
    • Telegram
    • Email
    • Mattermost
  • Enjoy!