Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4ndv/rubogram
Rubogram is a small Faraday-based library to communicate with Telegram Bot API
https://github.com/4ndv/rubogram
bot faraday telegram telegram-bot-api
Last synced: 15 days ago
JSON representation
Rubogram is a small Faraday-based library to communicate with Telegram Bot API
- Host: GitHub
- URL: https://github.com/4ndv/rubogram
- Owner: 4ndv
- License: mit
- Created: 2017-01-01T07:22:24.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-22T06:51:08.000Z (almost 6 years ago)
- Last Synced: 2024-11-12T04:16:10.192Z (2 months ago)
- Topics: bot, faraday, telegram, telegram-bot-api
- Language: Ruby
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-telegram-bots - rubogram - Tiny ruby wrapper for Telegram Bot API (Libraries / Ruby)
README
# Rubogram
[](https://travis-ci.org/4ndv/rubogram)
[](https://coveralls.io/github/4ndv/rubogram?branch=master)
Rubogram is a small Faraday-based library to communicate with Telegram Bot API
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rubogram'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install rubogram
## Usage
At first, require rubogram in your application like this:
```ruby
require 'rubogram'
```
Create client with your token (you can obtain one [here](https://telegram.me/BotFather)):
```ruby
client = Rubogram::Client.new 'TOKENHERE'
```
And then make your requests like this:
```ruby
resp = client.send_message chat_id: '123', text: 'hello, machine world!'
```
So, as you can see `sendMessage` became `send_message` because of ruby guidelines(tm). But you can also use it like `client.sendMessage`, just like in the telegram docs.
Also you can use `call` method:
```ruby
resp = client.call 'sendMessage', chat_id: '123', text: 'Hello!'
```
You can see parsed response of all requests like this. Resp contains full Faraday response:
```ruby
resp.body
```
Note that in case of errors, exception will be raised, so don't forget to handle it
## Options
Rubogram Client has some options you can set, here's full list:
```ruby
client = Rubogram::Client.new 'TOKENHERE', adapter: Faraday.default_adapter, logging: true, raise_errors: true
```
Where:
`adapter` - faraday adapter, look into faraday docs for more of them
`logging` - true/false, enables/disables logging
`raise_errors` - true/false, enables/disables error raising. If you disable this, you can check successfullness of request by verifying `ok` field in the parsed body
## TODO
* Write specs
* Write examples
## Development
After checking out the repo, run `bin/setup` to install dependencies.
To run tests you must specify two environment variables: `TOKEN` with your bot token and `CHATID` with YOUR id.
Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/4ndv/rubogram. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).