/telegrammer

Lightweight Ruby client for the Telegram's Bot API

Primary LanguageRubyMIT LicenseMIT

Gem Version Code Climate Inline docs ![Gitter](https://badges.gitter.im/Join Chat.svg)

Telegrammer

Ruby client for the Telegram's Bot API. Compliant with the version 2016-01-20 of the API.

Installation

Add this line to your application's Gemfile:

gem 'telegrammer'

And then execute:

$ bundle

Usage

First you'll need to register your bot and get an API token. To do that you have to talk with the @BotFather. Learn more about this here.

After getting your token, you can do things like this:

require 'telegrammer'

bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')

bot.get_updates do |message|
  puts "In chat #{message.chat.id}, @#{message.from.username} said: #{message.text}"
  bot.send_message(chat_id: message.chat.id, text: "You said: #{message.text}")

  # Here you can also process message text to detect user commands
  # To learn more about commands, see https://core.telegram.org/bots#commands
end

This gem currently supports all operations exposed by the Telegram's Bot API. All the classes and methods are documented with examples, so please check the documentation. Also you can check the the wiki, where you'll find more info about topics like setting webhooks for your bot.

Contributing

  1. Fork it: https://github.com/mayoral/telegrammer/fork
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request