Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beverlyroadgoose/fuse
A Go library for developing Telegram bots.
https://github.com/beverlyroadgoose/fuse
telegram telegram-bot telegram-bot-api
Last synced: about 2 months ago
JSON representation
A Go library for developing Telegram bots.
- Host: GitHub
- URL: https://github.com/beverlyroadgoose/fuse
- Owner: beverlyRoadGoose
- License: mit
- Created: 2022-02-24T16:35:08.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-03-04T09:25:54.000Z (10 months ago)
- Last Synced: 2024-10-21T15:55:40.058Z (2 months ago)
- Topics: telegram, telegram-bot, telegram-bot-api
- Language: Go
- Homepage: https://fuse.heytobi.dev
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://godoc.org//heytobi.dev/fuse)
[](https://github.com/beverlyRoadGoose/fuse/actions/workflows/ci.yaml)
[](https://goreportcard.com/report/heytobi.dev/fuse)
[](https://codecov.io/gh/beverlyRoadGoose/fuse)
[](https://github.com/beverlyRoadGoose/fuse/releases)
Fuse is a Go library for developing [Telegram](https://telegram.org/) bots, using the [Telegram Bot API](https://core.telegram.org/bots/api).
⚠️ I'm developing this for use in a hobby project, In the initial phase I'm only adding features as needed in the main
project. Overtime I'll aim to cover much of what the Telegram API provides. This also means some things might initially
be experimental and breaking changes are possible.
## Installation
```console
you@pc:~$ go get -u heytobi.dev/fuse
```
## Current Features
✔️ Register Webhooks
✔️ Receive updates through Webhooks
✔️ Receive updates through polling
✔️ Send Messages
✔️ Supports Local Bot API Servers
## Usage
### Getting Updates through long polling
#### Steps
1. Initialize a Bot
2. Register command handlers
3. Start polling for updates
```go
httpClient := &http.Client{}
config := &telegram.Config{
Token: "",
UpdateMethod: telegram.UpdateMethodGetUpdates,
PollingIntervalMS: 1000,
PollingTimeout: 30,
PollingUpdatesLimit: 100,
}
poller, err := telegram.NewPoller(telegramConfig, httpClient)
if err != nil {
return nil, errors.New("failed to initialize telegram poller")
}
bot, err := telegram.NewBot(telegramConfig, httpClient)
if err != nil {
return nil, errors.New("failed to initialize telegram instance")
}
bot = bot.WithPoller(poller)
bot.RegisterHandler("/start", func(ctx context.Context, update *telegram.Update) {
result, err := bot.Send(telegram.SendMessageRequest{
ChatID: update.Message.Chat.ID,
Text: " ¯\_(ツ)_/¯",
})
if err != nil {
log.Error("failed to send telegram message")
}
if !result.Successful {
log.Warn(fmt.Sprintf("failed to send telegram message: %s", result.Description))
}
})
bot.Start() // start listening for updates.
```
### Getting Updates through a Webhook
#### Steps
1. Initialize a Bot
2. Register a Webhook
3. Register command handlers
4. Call the process update method directly whenever your webhook is invoked
```go
httpClient := &http.Client{}
config := &telegram.Config{
Token: "",
UpdateMethod: telegram.UpdateMethodWebhook,
}
bot, err := telegram.Init(config, httpClient)
if err != nil {
log.Fatal("failed to initialize telegram bot")
}
bot.RegisterWebhook(telegram.Webhook{url: "mywebhook.com/notify"})
if err != nil {
log.Fatal("failed to register webhook")
}
bot.RegisterHandler("/start", func(ctx context.Context, update *telegram.Update) {
result, err := bot.Send(telegram.SendMessageRequest{
ChatID: update.Message.Chat.ID,
Text: " ¯\_(ツ)_/¯",
})
if err != nil {
log.Error("failed to send telegram message")
}
if !result.Successful {
log.Warn(fmt.Sprintf("failed to send telegram message: %s", result.Description))
}
})
// In your webhook http handler:
bot.ProcessUpdate(Update{}) // the update parameter should be deserialized from the request body.
```
### Using a Local Bot API Server
If you are [running a Local Bot API Server](https://core.telegram.org/bots/api#using-a-local-bot-api-server), you can
specify the host and the port (if applicable) using the fields exposed in the config struct:
```go
config := &telegram.Config{
BotApiServer: "https://localserver.net",
BotApiServerPort: 1234,
}
```
### Documentation
The full documentation with examples is available at [fuse.heytobi.dev](https://fuse.heytobi.dev/)
## License
```
MIT License
Copyright (c) 2022 Oluwatobi Adeyinka
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```