Tourmaline – Telegram Bot Framework For Crystal

Telegram Bot (and hopefully soon Client) API framework for Crystal. Based heavily off of Telegraf this Crystal implementation allows your Telegram bot to be written in a language that’s both beautiful and fast. Benchmarks coming soon.If you want to extend your bot by using NLP, see my other library Cadmium.InstallationAdd this to your application’s shard.yml:dependencies: tourmaline: github: watzon/tourmaline version: ~> 0.7.0UsageBasic usagerequire “tourmaline/bot"alias TGBot = Tourmaline::Botbot =["API_KEY"])bot.command(["start", "help"]) do |message| text = "Echo bot is a sample bot created with the Tourmaline bot framework." bot.send_message(, text)endbot.command("echo") do |message, params| text = params.join(" ") bot.send_message(, text)endbot.pollListening for eventsTourmaline has a number of events that you can listen for (the same events as Telegraf actually). The full list of events is as can be found in the do |update| text = update.message.not_nil!.text.not_nil! puts "TEXT: #{text}"endAdding middlewareMiddleware can be created by extending the Tourmaline::Bot::Middleware class. All middleware classes need to have a call(update : Update) method. The middleware will be called on every update.class MyMiddleware < TGBot::Middleware # All middlware include a reference to the parent bot. # @bot : Tourmaline::Bot::Client def call(update : Update) if message = update.message if user = message.from_user if text = message.text puts "#{user.first_name}: #{text}" end end end endendbot.use MyMiddlewareWebhooksUsing webhooks is easy, even locally if you use the package.# bot.pollbot.set_webhook("")bot.serve("", 3400)# or with ngrok.crrequire "ngrok"Ngrok.start({ addr: "" }) do |ngrok| bot.set_webhook(ngrok.ngrok_url_https) bot.serve("", 3400)endPaymentsYou can now accept payments with your Tourmaline app! First make sure you follow the setup instructions here so that your bot is prepared to handle payments. Then just use the send_invoice, answer_shipping_query, and answer_pre_checkout_query methods to send invoices and accept"buy") do |message, params| bot.send_invoice(, "Sample Invoice", "This is a test...", "123344232323", "YOUR_PROVIDER_TOKEN", "test1", "USD", bot.labeled_prices([{label: "Sample", amount: 299}, {label: "Another", amount: 369}]).to_json )endGamesAbility to create and run games with your Tourmaline Bot is a recent feature that hasn't been tested yet. Please use the issue tracker if you experience problems.Kemal MiddlewareTourmaline provides middleware for Kemal, just in case you want to use Kemal as the server.require "kemal"require "tourmaline/kemal/tourmaline_handler"require "./your_bot"add_handler bot:, url: "", path: "/bot-webhook/#{ENV["TGBOT_API_KEY"]}")Kemal.runNote: Telegram won't send webhook requests to non-ssl domains. This means that you need to be running your kemal server with ssl enabled. For local development this can be a pain, but it is made much easier with currently supports the following features:Bot API Implementation examplesEasy command syntaxRobust middleware systemStandard API queriesStickersInline modeLong pollingWebhooksPaymentsGamesClient API (in development)If you want a new feature feel free to submit an issue or open a pull request.ContributingFork it ( )Create your feature branch (git checkout -b my-new-feature)Commit your changes (git commit -am 'Add some feature')Push to the branch (git push origin my-new-feature)Create a new Pull RequestContributorswatzon Chris Watson - creator, maintainerDownload Tourmaline