telegramAPI 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4d4ed6e7f6b6e7bab1bd1fccfe9ba95db51ed19
-  data.tar.gz: fdd8295ba7c49a574ccf848fcaceaa5ce0529288
+  metadata.gz: 0fc39dcbfb6e5779994efe355d537f07dc9bc13a
+  data.tar.gz: 86afed760ceda0247d43085e157f10260efde302
 SHA512:
-  metadata.gz: b5001ef8a7d75604c7e7e03e6f8c069451b50d284928ac630ae35ea0a841846de17b9fd53172f4a3f03f387a35430db6cc4f76bc857edca5b09effc314c17198
-  data.tar.gz: 860db86abaf052d0722ebe85899d586457f22e8f611526211e759c4c4b7ca1986949f880591a10754911b8a5b2ccaea97df294a771d17090f4bcafe0f58e8d85
+  metadata.gz: 8a2829f16b4634493f653c3aa6e04d555fbd439a9e2bb2ac43ddcd23f53cded4160e09c5eea91601c3e0fa3b3a2512295e365fcd9dbe2c4ae3924b7fcb965abc
+  data.tar.gz: 536686e959139a08c2b5f075eb8cb8f92aa1c0865fa1f347af93f975e7c6d6c5c92a5eb6194ea2a471006f47e9d40c8758c2d8de581bff04e22494bb6d12be8f

data/README.md

@@ -41,6 +41,35 @@ puts "But you can call me @#{bot['username']}"
 
 Here you can use the Telegram official [documentation](https://core.telegram.org/bots/api#available-methods)
 
+## List of methods available
+
+Every method has a optional parameter. See the Send Custom Keyboard example for more.
+
+ * ```getUpdates()```
+ * ```getMe()```
+ * ```sendMessage(chat_id, text)```
+ * ```forwardMessage(chat_id, from_chat_id, message_id)```
+ * ```sendPhoto(chat_id, path)```
+ * ```sendAudio(chat_id, path)```
+ * ```sendDocument(chat_id, path)```
+ * ```sendStickerFromFile(chat_id, path)```
+ * ```sendSticker(chat_id, sticker_id)```
+ * ```sendVideo(chat_id, path)```
+ * ```sendVoice(chat_id, path)```
+ * ```sendLocation(chat_id, latitude, longitude)```
+ * ```sendVenue(chat_id, latitude, longitude, title, address)```
+ * ```sendContact(chat_id, phone_number, first_name)```
+ * ```sendChatAction(chat_id, action)```
+ * ```getUserProfilePhotos(user_id)```
+ * ```getFile(file_id)```
+ * ```kickChatMember(chat_id, user_id)```
+ * ```leaveChat(chat_id)```
+ * ```unbanChatMember(chat_id, user_id)```
+ * ```getChat(chat_id)```
+ * ```getChatAdministrators(chat_id)```
+ * ```getChatMembersCount(chat_id)```
+ * ```getChatMember(chat_id, user_id)```
+
 ## Examples
 
 ### Echo Server
@@ -60,17 +89,17 @@ end
 ### Send Media
 
 ```ruby
-api.sendSticker m.message.chat.id, sticker_id
+api.sendSticker m['message']['chat']['id'], sticker_id
 
-api.sendPhoto m.message.chat.id, "/home/path-of-image/image.jpg"
+api.sendPhoto m['message']['chat']['id'], "/home/path-of-image/image.jpg"
 
-api.sendDocument m.message.chat.id, "/home/path-of-document/doc.gif"
+api.sendDocument m['message']['chat']['id'], "/home/path-of-document/doc.gif"
 
-api.sendAudio m.message.chat.id, "/home/path-of-audio/audio.opus"
+api.sendAudio m['message']['chat']['id'], "/home/path-of-audio/audio.opus"
 
-api.sendVideo m.message.chat.id, "/home/path-of-video/video.mp4"
+api.sendVideo m['message']['chat']['id'], "/home/path-of-video/video.mp4"
 
-api.sendLocation m.message.chat.id, 45.462781, 9.177732
+api.sendLocation m['message']['chat']['id'], 45.462781, 9.177732
 ```
 **Note:** According to Telegram, each audio must be encoded in **Ogg OPUS**, and each video must be encoded in **mp4**.
 
@@ -91,3 +120,4 @@ markup = {
 
 api.sendMessage m['message']['chat']['id'], "Am I sexy?", {"reply_markup"=>markup}
 ```
+

data/lib/telegramAPI.rb

@@ -3,7 +3,6 @@ require 'net/http'
 require 'net/https'
 require 'uri'
 require 'rest-client'
-require 'ostruct'
 
 # This library provides an easy way to access to the Telegram Bot API
 # Author:: Benedetto Nespoli
@@ -32,11 +31,11 @@ class TelegramAPI
     params.each do |param| p << param.join("=") end
     params_s = "?#{p.join("&")}" if p.length!=0
 
-    JSON.parse(RestClient.get(@@core+@token+"/"+api+params_s).body)
+    JSON.parse(RestClient.get(@@core+@token+"/"+api+params_s).body)["result"]
   end
 
   def post api, name, path, to, options={}
-    JSON.parse(RestClient.post(@@core+@token+api, {name=>File.new(path,'rb'), :chat_id=>to.to_s}.merge(parse_hash(options))).body, object_class: OpenStruct)["result"]
+    JSON.parse(RestClient.post(@@core+@token+api, {name=>File.new(path,'rb'), :chat_id=>to.to_s}.merge(parse_hash(options))).body)["result"]
   end
 
   def getUpdates options={"timeout"=>0, "limit"=>100}
@@ -54,11 +53,11 @@ class TelegramAPI
     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)))["result"]
+    self.query("sendMessage", {:chat_id=>to.to_s, :text=>URI::encode(text)}.merge(parse_hash(options)))
   end
 
   def forwardMessage to, from, msg
-    self.query("forwardMessage", {"chat_id"=>to, "from_chat_id"=>from, "message_id"=>msg})["result"]
+    self.query("forwardMessage", {:chat_id=>to, :from_chat_id=>from, :message_id=>msg})
   end
 
   def sendPhoto to, path, options={}
@@ -69,72 +68,77 @@ class TelegramAPI
     self.post "/sendAudio", :audio, path, to, options
   end
 
-  # Send a general document (file, image, audio)
-  # @param (see #sendPhoto)
-  # @return (see #sendPhoto)
   def sendDocument to, path, options={}
     self.post "/sendDocument", :document, path, to, options
   end
 
-  # Send a Sticker from File
-  # @param (see #sendPhoto)
-  # @return (see #sendSticker)
   def sendStickerFromFile to, path, options={}
     self.post "/sendSticker", :sticker, path, to, options
   end
 
-  # Send a Sticker through its ID
-  # @param to (see #sendPhoto)
-  # @param id [Integer] the ID of the sticker to send
-  # @param options (see #sendPhoto)
-  # @return (see #sendPhoto)
   def sendSticker to, id, options={}
-    JSON.parse(RestClient.post(@@core+@token+"/sendSticker", {:sticker=>id, :chat_id=>to.to_s}.merge(parse_hash(options))).body)["result"]
+    RestClient.post(@@core+@token+"/sendSticker", {:sticker=>id, :chat_id=>to.to_s}.merge(parse_hash(options))).body
   end
 
-  # Send a video file in mp4 format of max 50MB
-  # @param (see #sendPhoto)
-  # @return (see #sendPhoto)
   def sendVideo to, path, options={}
     self.post "/sendVideo", :video, path, to, options
   end
-  
-  # Send a location
-  # @param to (see #sendPhoto)
-  # @param lat [Float] Latitude
-  # @param long [Float] Longitude
-  # @param options (see #sendPhoto)
-  # @return (see #sendPhoto)
+
+  def sendVoice to, path, options={}
+    self.post "/sendVoice", :voice, path, to, options
+  end
+
   def sendLocation to, lat, long, options={}
-    self.query("sendLocation", {"chat_id"=>to, "latitude"=>lat, "longitude"=>long}.merge(parse_hash(options)))["result"]
+    self.query("sendLocation", {:chat_id=>to, :latitude=>lat, :longitude=>long}.merge(parse_hash(options)))
+  end
+  
+  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
+  
+  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
 
-  # Send a Chat Action
-  # @param to (see #sendPhoto)
-  # @param act [String] One of: typing, upload_photo, record_video, record_audio, upload_audio, upload_document, find_location
+  # act is one between: typing, upload_photo, record_video, record_audio, upload_audio, upload_document, find_location
   def sendChatAction to, act
-    self.query "sendChatAction", {"chat_id"=>to, "action"=>act}
+    self.query "sendChatAction", {:chat_id=>to, :action=>act}
   end
 
-  # Get a list of user profile photos, in up to 4 sizes each
-  # @param id [Integer] ID user whom getting the photos
-  # @param options (see #sendPhoto)
-  # @return [UserProfilePhotos]
   def getUserProfilePhotos id, options={}
-    self.query("getUserProfilePhotos", {"user_id"=>id}.merge(parse_hash(options)))["result"]
+    self.query("getUserProfilePhotos", {:user_id=>id}.merge(parse_hash(options)))
+  end
+  
+  def getFile file_id
+    self.query("getFile", {:file_id=>file_id})
   end
   
-  # Kick the user user_id from the chat chat_id
-  # @param chat_id [Integer or String] ID of the chat, or @publicname
-  # @param user_id [Integer] ID of the user to kick
   def kickChatMember chat_id, user_id
-    self.query "kickChatMember", {"chat_id"=>chat_id, "user_id"=>user_id}
+    self.query("kickChatMember", {:chat_id=>chat_id, :user_id=>user_id})
+  end
+  
+  def leaveChat chat_id
+    self.query("leaveChat", {:chat_id=>chat_id})
   end
   
-  # Unban user_id from chat_id
-  # see kickChatMember
   def unbanChatMember chat_id, user_id
-    self.query "unbanChatMember", {"chat_id"=>chat_id, "user_id"=>user_id}
+    self.query("unbanChatMember", {:chat_id=>chat_id, :user_id=>user_id})
+  end
+  
+  def getChat chat_id
+    self.query("getChat", {:chat_id=>chat_id})
+  end
+  
+  def getChatAdministrators chat_id
+    self.query("getChatAdministrators", {:chat_id=>chat_id})
+  end
+  
+  def getChatMembersCount chat_id
+    self.query("getChatMembersCount", {:chat_id=>chat_id})
+  end
+  
+  def getChatMember chat_id, user_id
+    self.query("getChatMember", {:chat_id=>chat_id, :user_id=>user_id})
   end
 
   protected :query, :parse_hash, :post

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegramAPI
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Benedetto Nespoli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.3
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.3