chrisvdg / scrumtime Goto Github PK

Use Go modules instead of Go dep

In succession of #19

Implement message delete for slack.
At the very least message that it's not implemented.

Update the cron library and test the behavior

I think the current version only supports the quartz-scheduler format while the newer version is either the Linux cron format (I guess this is more widely known) or can support both.

config section of the readme is outdated

• Make printing of sent messages only in verbose output
• Print scheduled messages on startup
• Add other useful logging

No tests have been added as logic from this project itself is quite limited, it's mostly API interaction, but as features will be added the need to testing will rise.

• Check and define where tests can be added and add them
• Setup automated testing (e.g: travis)
  • Add deploy part to push binaries to release
• Nice to have: add test coverage, test pass badges in the readme

Cleanup unneeded files with go mod tidy

Either find a way for the container using the scrumtime image to use the timezone of the host and/or document a way to set/change it.

To keep the chat cleaner add an option to clean the scheduled message up after a configured/default timeout.

If this feature is configured, after the message has been sent, start a go routine that counts down until the timeout has been reached and sent an API call to the chat platform to delete the message.

If the bot gets restarted while a timeout goroutine is running, it may prevent that message from being cleaned up, for this FR this is acceptable.

Would be really cool to add a Gopher Mascot to this project.

Currently open requests:

• egonelbre/gophers#12

Allow empty messengers in a schedule, this would allow a message to be muted later on when adding the webhook or quickly comment out the messengers in the config to manually mute a message that might be used again later.

Could be done together with #7

Add option to disable link preview on a message (with links)

for telegram:
https://core.telegram.org/bots/api#editmessagetext

• Create docker file for the project
• Adds docs how to start it with config

Telegram part of #6

In the telegram we could use the GetUpdatesChan method of the bot api, this should prevent us from opening and publicly exposing a port for receiving callbacks on updates.

We could add a flag to the bot config to enable listening for updates.

The bot receives an update when in a chat the bot is in, a message starts with /
We can make all commands for the scrumbot start with /scrumbot , remove it from the command and pass it to functions that may not be telegram specific to process the command.
For slack we could make the bot listen for the bot being mentioned and remove the mention tag to process the command.

In the config create a list of messenger configs.
In the message configs make it reference to the messenger configs to make messengers more easily reusable.

This is an issue to track all issues/features related to implement the first version being able to interact with the config through the chat.
If working on one or more of the features in this issue, please create a separate issue for it and reference it here. Check the feature when it is merged in master.

Implement for:

• Telegram (#15)
• Slack

Features to add with this functionality:

• Help with available commands
• List scheduled messages for the chat
• Disable next (or define a date/datetime for it skip, e.g. skip a legal holiday in advance) scheduled message(s) and be able to re-enable them

Roadmap (Can de pushed to a later release):

• Edit messages
• Edit schedules
• Add new schedules (scrumbot can be added to a new chat and from there users can configure now schedules without messing with the config)

Add support for following platforms:

• gitter
• mattermost

Feel free to suggest platforms in the comment of this issue

The app config now consist of 2 top level parts: messengers for the chat platform api configs and schedules for the messages.
First idea was to rename schedules to a more logical messages but this can easy be mistaken with messengers.

Todo:

• Update App struct and usage
• Update documentation (readme)

Replace the current logging which is just using fmt.Print with a more advanced logging lib.

Suggestions:

• logrus
• zerolog