telegram_bot_开源项目-程序员客栈

❌❌❌❌❌❌❌❌

DeprecationNotice

Pleaseconsiderusingtourmalineinstead

I'lltrytokeepthislibrarycompatiblewiththefutureversionsofCrystal,buttourmalineisawelldesignedandmaintainedlibrarywhichissuperiorineverywaywhilesharingthesamebasics,thusIdon'tseeanyvalueinimplementingthesameimprovementsandfragmentingthecommunity

Bugfixesarestillwelcomed

❌❌❌❌❌❌❌❌

TelegramBot

TelegramBotAPI(3.2)wrapperforCrystal

Currentfeatures

apimethodsandtypes:

basicmessagetypesstickersinlinemodepaymentsgames

gettingupdates:

longpollingwebhooks

additionalfeatures:

white&blacklistscommandhandlerUsage

CreateyourbotbyinheritingfromTelegramBot::Bot.

Commands

DefinewhichcommandsyourbothandlesviathecmdmethodintheCmdHandlermodule.Forexample,respondworldto/helloandperformsimplecalculationwith/add:

require"telegram_bot"classMyBot<TelegramBot::BotincludeTelegramBot::CmdHandlerdefinitializesuper("MyBot",TOKEN)cmd"hello"do|msg|replymsg,"world!"end#/add57=>12cmd"add"do|msg,params|replymsg,"#{params[0].to_i+params[1].to_i}"endendendmy_bot=MyBot.newmy_bot.pollingLoggingMyBot::Log.level=:debugMyBot::Log.backend=::Log::IOBackend.newmy_bot=MyBot.newmy_bot.pollingCustomhandlers

OverrideanyofthefollowinghandlemethodstohandleTelegramupdates,beitmessages,inlinequeries,choseninlineresultsorcallbackqueries:

defhandle(message:Message)defhandle(inline_query:InlineQuery)defhandle(chosen_inline_result:ChosenInlineResult)defhandle(callback_query:CallbackQuery)defhandle_edited(message:Message)defhandle_channel_post(message:Message)defhandle_edited_channel_post(message:Message)

Forexample,toechoallmessagessenttothebot:

classEchoBot<TelegramBot::Botdefhandle(message:Message)iftext=message.textreplymessage,textendendendEchoBot.new.polling

Ortoanswerinlinequerieswithalistofarticles:

classInlineBot<TelegramBot::Botdefhandle(inline_query:TelegramBot::InlineQuery)results=Array(TelegramBot::InlineQueryResult).newcontent=InputTextMessageContent.new"Articledetails"results<<TelegramBot::InlineQueryResultArticle.new("article/1","Myfirstarticle",content)answer_inline_query(inline_query.id,results)endendInlineBot.new.polling

RemembertoenableinlinemodeinBotFathertosupportinlinequeries.

Webhooks

AlltheexamplesaboveusethegetUpdatesmethod,constantlypollingTelegramfornewupdates,byinvokingthepollingmethodonthebot.

AnotheroptionistousethesetWebhookmethodtotellTelegramwheretoPOSTanyupdatesforyourbot.NotethatyoumustuseHTTPSinthisendpointforTelegramtowork,andyoucanuseaself-signedcertificate,whichyoucanprovideaspartofthesetWebhookmethod:

#Certificatehasthecontentsofthecertificate,notthepathtoitbot.set_webhook(url,certificate)

AfterinvokingsetWebhook,haveyourbotstartanHTTPSserverwiththeservecommand:

bot.serve("0.0.0.0",443,"path/to/ssl/certificate","path/to/ssl/key")

IfyourunyourbotbehindaproxythatperformsSSLoffloading(ietheproxypresentsthecertificatetoTelegram,andthenforwardstherequesttoyourappusingplainHTTP),youmayskipthelasttwoparameters,andthebotwilllistenforHTTPrequestsinsteadofHTTPS.

Whenrunningyourbotinservemode,thebotwillfavourexecutinganymethodsbysendingaresponseaspartoftheTelegramrequest,ratherthanexecutinganewrequest.

White/blacklists

Howeverit'snotpartoftheAPIyoucansetblackorwhitelistsinthebot'sconstructortofilteryourusersbyusername.

whitelist:ifuserisnotpresentonthelist(ordoesn'thaveusername)themessagewon'tbehandled

blacklist:ifuserispresentonthelistthemessagewon'tbehandled

Installation

Addthistoyourapplication'sshard.yml:

dependencies:telegram_bot:github:hangyas/telegram_botContributing

Contributingisverywelcomed!

Forkit(https://github.com/hangyas/TelegramBot/fork)Createyourfeaturebranch(gitcheckout-bmy-new-feature)Commityourchanges(gitcommit-am'Addsomefeature')Pushtothebranch(gitpushoriginmy-new-feature)CreateanewPullRequestContributorshangyasKrisztiánÁdám-creator,maintainer

telegram_bot开源项目

作品详情

重点城市程序员兼职推荐

重点岗位程序员兼职推荐