Class: TelegramAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/telegramAPI.rb

Overview

This library provides an easy way to access to the Telegram Bot API

Author

Benedetto Nespoli

License

MIT

Constant Summary collapse

@@core = 
"https://api.telegram.org/bot"

Instance Method Summary collapse

Constructor Details

#initialize(token) ⇒ TelegramAPI

Returns a new instance of TelegramAPI.



14
15
16
17
 
# File 'lib/telegramAPI.rb', line 14

def initialize token
  @token = token
  @last_update = 0
end

Instance Method Details

#forwardMessage(to, from, msg) ⇒ Object 



62
63
64
 
# File 'lib/telegramAPI.rb', line 62

def forwardMessage to, from, msg
  self.query("forwardMessage", {:chat_id=>to, :from_chat_id=>from, :message_id=>msg})
end

#getChat(chat_id) ⇒ Object 



131
132
133
 
# File 'lib/telegramAPI.rb', line 131

def getChat chat_id
  self.query("getChat", {:chat_id=>chat_id})
end

#getChatAdministrators(chat_id) ⇒ Object 



135
136
137
 
# File 'lib/telegramAPI.rb', line 135

def getChatAdministrators chat_id
  self.query("getChatAdministrators", {:chat_id=>chat_id})
end

#getChatMember(chat_id, user_id) ⇒ Object 



143
144
145
 
# File 'lib/telegramAPI.rb', line 143

def getChatMember chat_id, user_id
  self.query("getChatMember", {:chat_id=>chat_id, :user_id=>user_id})
end

#getChatMembersCount(chat_id) ⇒ Object 



139
140
141
 
# File 'lib/telegramAPI.rb', line 139

def getChatMembersCount chat_id
  self.query("getChatMembersCount", {:chat_id=>chat_id})
end

#getFile(file_id) ⇒ Object 



115
116
117
 
# File 'lib/telegramAPI.rb', line 115

def getFile file_id
  self.query("getFile", {:file_id=>file_id})
end

#getMe ⇒ Object 



51
52
53
 
# File 'lib/telegramAPI.rb', line 51

def getMe
  self.query("getMe")
end

#getUpdates(options = {"timeout"=>0, "limit"=>100}) ⇒ Object 



47
48
49
 
# File 'lib/telegramAPI.rb', line 47

def getUpdates options={"timeout"=>0, "limit"=>100}
  self.query("getUpdates", {"offset"=>@last_update.to_s}.merge(parse_hash(options)))
end

#getUserProfilePhotos(id, options = {}) ⇒ Object 



111
112
113
 
# File 'lib/telegramAPI.rb', line 111

def getUserProfilePhotos id, options={}
  self.query("getUserProfilePhotos", {:user_id=>id}.merge(parse_hash(options)))
end

#kickChatMember(chat_id, user_id) ⇒ Object 



119
120
121
 
# File 'lib/telegramAPI.rb', line 119

def kickChatMember chat_id, user_id
  self.query("kickChatMember", {:chat_id=>chat_id, :user_id=>user_id})
end

#leaveChat(chat_id) ⇒ Object 



123
124
125
 
# File 'lib/telegramAPI.rb', line 123

def leaveChat chat_id
  self.query("leaveChat", {:chat_id=>chat_id})
end

#sendAudio(to, path, options = {}) ⇒ Object 



70
71
72
 
# File 'lib/telegramAPI.rb', line 70

def sendAudio to, path, options={}
  self.post("/sendAudio", :audio, path, to, options)
end

#sendChatAction(to, act) ⇒ Object

act is one between: typing, upload_photo, record_video, record_audio, upload_audio, upload_document, find_location



107
108
109
 
# File 'lib/telegramAPI.rb', line 107

def sendChatAction to, act
  self.query("sendChatAction", {:chat_id=>to, :action=>act})
end

#sendContact(to, phone_number, first_name, options = {}) ⇒ Object 



102
103
104
 
# File 'lib/telegramAPI.rb', line 102

def sendContact to, phone_number, first_name, options={}
  self.query("sendContact", {:chat_id=>to, :phone_number=>phone_number, :first_name=>first_name}.merge(parse_hash(options)))
end

#sendDocument(to, path, options = {}) ⇒ Object 



74
75
76
 
# File 'lib/telegramAPI.rb', line 74

def sendDocument to, path, options={}
  self.post("/sendDocument", :document, path, to, options)
end

#sendLocation(to, lat, long, options = {}) ⇒ Object 



94
95
96
 
# File 'lib/telegramAPI.rb', line 94

def sendLocation to, lat, long, options={}
  self.query("sendLocation", {:chat_id=>to, :latitude=>lat, :longitude=>long}.merge(parse_hash(options)))
end

#sendMessage(to, text, options = {}) ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/telegramAPI.rb', line 55

def sendMessage to, text, options={}
  if options.has_key?"reply_markup" then
    options["reply_markup"]=options["reply_markup"].to_json
  end
  self.query("sendMessage", {:chat_id=>to.to_s, :text=>URI::encode(text)}.merge(parse_hash(options)))
end

#sendPhoto(to, path, options = {}) ⇒ Object 



66
67
68
 
# File 'lib/telegramAPI.rb', line 66

def sendPhoto to, path, options={}
  self.post("/sendPhoto", :photo, path, to, options)
end

#sendSticker(to, id, options = {}) ⇒ Object 



82
83
84
 
# File 'lib/telegramAPI.rb', line 82

def sendSticker to, id, options={}
  RestClient.post(@@core+@token+"/sendSticker", {:sticker=>id, :chat_id=>to.to_s}.merge(parse_hash(options))).body
end

#sendStickerFromFile(to, path, options = {}) ⇒ Object 



78
79
80
 
# File 'lib/telegramAPI.rb', line 78

def sendStickerFromFile to, path, options={}
  self.post("/sendSticker", :sticker, path, to, options)
end

#sendVenue(to, lat, long, title, address, options = {}) ⇒ Object 



98
99
100
 
# File 'lib/telegramAPI.rb', line 98

def sendVenue to, lat, long, title, address, options={}
  self.query("sendVenue", {:chat_id=>to, :latitude=>lat, :longitude=>long, :title=>title, :address=>address}.merge(parse_hash(options)))
end

#sendVideo(to, path, options = {}) ⇒ Object 



86
87
88
 
# File 'lib/telegramAPI.rb', line 86

def sendVideo to, path, options={}
  self.post("/sendVideo", :video, path, to, options)
end

#sendVoice(to, path, options = {}) ⇒ Object 



90
91
92
 
# File 'lib/telegramAPI.rb', line 90

def sendVoice to, path, options={}
  self.post("/sendVoice", :voice, path, to, options)
end

#setWebhook(url) ⇒ Object 



43
44
45
 
# File 'lib/telegramAPI.rb', line 43

def setWebhook url
  self.query("setWebhook", {"url"=>URI::encode(url)})
end

#unbanChatMember(chat_id, user_id) ⇒ Object 



127
128
129
 
# File 'lib/telegramAPI.rb', line 127

def unbanChatMember chat_id, user_id
  self.query("unbanChatMember", {:chat_id=>chat_id, :user_id=>user_id})
end