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.

There are as well some functions available to be used:

getYearsOld: receives the year that a user was born, and returns how old the user is getting.

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
Add some endpoints
- Health endpoint
- Next birthday endpoint
- Birthday list endpoint
Create different message systems to use with the bot
- Telegram
- Email
- Mattermost
Enjoy!

2.7 KiB Raw Blame History