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 



59
60
61
 
# File 'lib/telegramAPI.rb', line 59

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

#getChat(chat_id) ⇒ Object 



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

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

#getChatAdministrators(chat_id) ⇒ Object 



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

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

#getChatMember(chat_id, user_id) ⇒ Object 



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

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

#getChatMembersCount(chat_id) ⇒ Object 



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

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

#getFile(file_id) ⇒ Object 



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

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

#getMe ⇒ Object 



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

def getMe
  self.query("getMe")
end

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



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

def getUpdates options={"timeout"=>0, "limit"=>100}
  r=self.query "getUpdates", {"offset"=>@last_update.to_s}.merge(parse_hash(options))
  if r['ok']!=true then return nil end
  if r['result'][-1]!=nil then @last_update=r['result'][-1]['update_id']+1 end
  return r['result']
end

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



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

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

#kickChatMember(chat_id, user_id) ⇒ Object 



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

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

#leaveChat(chat_id) ⇒ Object 



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

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

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



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

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



104
105
106
 
# File 'lib/telegramAPI.rb', line 104

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

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



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

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 



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

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

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



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

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 



52
53
54
55
56
57
 
# File 'lib/telegramAPI.rb', line 52

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 



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

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

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



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

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 



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

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

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



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

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 



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

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

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



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

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

#unbanChatMember(chat_id, user_id) ⇒ Object 



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

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