https://github.com/telegram-bot-rb/telegram_bot_app
Example Rails 5 Telegram bot app
https://github.com/telegram-bot-rb/telegram_bot_app
Last synced: 3 months ago
JSON representation
Example Rails 5 Telegram bot app
- Host: GitHub
- URL: https://github.com/telegram-bot-rb/telegram_bot_app
- Owner: telegram-bot-rb
- Created: 2016-05-15T14:42:08.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-12-12T00:55:45.000Z (7 months ago)
- Last Synced: 2025-03-29T23:08:15.179Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 103 KB
- Stars: 97
- Watchers: 5
- Forks: 36
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example telegram bot app
This app uses [telegram-bot](https://github.com/telegram-bot-rb/telegram-bot) gem.
Want to see the [bot code](https://github.com/telegram-bot-rb/telegram_bot_app/blob/master/app/controllers/telegram_webhooks_controller.rb)
first?
Explore separate commits to check evolution of code.
Want a clean setup instead?
Here is [app teamplate](https://github.com/telegram-bot-rb/rails_template) to help you.
## Commands
- `/start` - Greeting.
- `/help`
- `/memo %text%` - Saves text to session.
- `/remind_me` - Replies with text from session.
- `/keyboard` - Simple keyboard.
- `/inline_keyboard` - Inline keyboard example.
- Inline queries. Enable it in [@BotFather](https://telegram.me/BotFather),
and your're ready to try 'em.
- `/last_chosen_inline_result` - Your last chosen inline result
(Enable feedback with sending `/setinlinefeedback`
to [@BotFather](https://telegram.me/BotFather)).
## Setup
- Create bot with [@BotFather](https://telegram.me/BotFather) `unless has_test_bot?`
- Clone repo.
- run `./bin/setup`.
- Update `config/secrets.yml` with your bot's token.
## Run
### Development
```
bin/rake telegram:bot:poller
```
### Production
One way is just to run poller. You don't need anything else, just check
your production secrets & configs. But there is better way: use webhooks.
__You may want to use different token: after you setup the webhook,
you need to unset it to run development poller again.__
First you need to setup the webhook. There is rake task for it,
but you're free to set it manually with API call.
To use rake task you need to set host in `routes.default_url_options`
for production environment (`config.routes` for Rails < 5).
There is already such line in the repo in `production.rb`.
Uncomment it, change the values, and you're ready for:
```
bin/rake telegram:bot:set_webhook RAILS_ENV=production
```
Now deploy your app in any way you like. You don't need run anything special for bot,
but `rails server` as usual. Your rails app will receive webhooks and bypass them
to bot's controller.
By default session is configured to use FileStore at `Rails.root.join('tmp', 'session_store')`.
To use it in production make sure to share this folder between releases
(ex., add to list shared of shared folders in capistrano).
Read more about different session stores in
[original readme](https://github.com/telegram-bot-rb/telegram-bot#session).
### Testing
```
bin/rspec
```
## Advanced
### Async mode
- Uncomment `async: true` in `secrets.yml`.
- Run and check the logs out.
- More info about [async mode](https://github.com/telegram-bot-rb/telegram-bot#async-mode).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/telegram-bot-rb/telegram_bot_app.