20ec590e87
Introducing Option functions. Options are meant to provide an extendable way of instanciating a Notifier with a set of options. Currently, only Enable()/Disable() are supported. WithOptions() alters an already instanciated Notifier and NewWithOptions() returns a new Notifier instance that was initialized with the given options. Options are passed in as a variadic list, thus, they're "optional".. no pun intended. Calling New() results in an internal call to NewWithOptions() without options passed, which again results in a default Notifier being returned. |
||
|---|---|---|
| .github | ||
| assets | ||
| service | ||
| .cliff.toml | ||
| .codacy.yml | ||
| .editorconfig | ||
| .gitignore | ||
| .golangci.yml | ||
| .kodiak.toml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| notifier.go | ||
| notify.go | ||
| README.md | ||
| renovate.json | ||
| SECURITY.md | ||
| send.go | ||
| use.go | ||
A dead simple Go library for sending notifications to various messaging services.
About
Notify was born out of my own need to have my API servers running in production be able to notify me when critical errors occur. Of course, Notify can be used for any other purpose as well. The library is kept as simple as possible for quick integration and ease of use.
Disclaimer
Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. See license for more.
Spamming through the use of this library may get you permanently banned on most supported platforms.
Since Notify is highly dependent on the consistency of the supported external services and the corresponding latest client libraries, we cannot guarantee its reliability nor its consistency, and therefore you should probably not use or rely on Notify in critical scenarios.
Install
go get -u github.com/nikoksr/notify
Example usage
// Create a telegram service. Ignoring error for demo simplicity.
telegramService, _ := telegram.New("your_telegram_api_token")
// Passing a telegram chat id as receiver for our messages.
// Basically where should our message be sent?
telegramService.AddReceivers(-1234567890)
// Tell our notifier to use the telegram service. You can repeat the above process
// for as many services as you like and just tell the notifier to use them.
// Inspired by http middlewares used in higher level libraries.
notify.UseServices(telegramService)
// Send a test message.
_ = notify.Send(
context.Background(),
"Subject/Title",
"The actual message - Hello, you awesome gophers! :)",
)
Supported services
Please create feature requests for missing services (see #3 for example)
Logo
The logo was made by the amazing MariaLetta.
Contributing
Contributions, issues and feature requests are very welcome! Feel free to check issues page. Please also take a look at the contribution guidelines.
Show your support
Give a ⭐️ if you like this project!