telegramAPI 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf59e092f4b48681343b6e8141146e4fc12fcd42
-  data.tar.gz: 1d57c5ae51722ed541fe5269b9524e979e1dafbf
+  metadata.gz: 533ace198fb97babf39504545d1e05142a95ab28
+  data.tar.gz: 9ba7f63de0c468d69b868673e593c1c289157536
 SHA512:
-  metadata.gz: 0f9386146372a702adbf658e78d0a2ddc2d80e913c5e42caf083ee30a8bd84c303c97781a3c32191a306007fcd43ba76e000ea94c379d8318e3e063f65f3e923
-  data.tar.gz: f81bf7b70bb806b63822c79cef72d64be62b6fee98068737e53a9b7ddc1fcbef9aa23784e78268541832543f44a02b74767f9fa1a29bd7e7b6e2c55c0da99031
+  metadata.gz: 2030bcbf930947303a459b60464d0984b73416b43bf8951cc57631c0fbd17b5107d357cac0dc1f868c96c4a2bd4820319b5d1a213bc705d28694c64c24655054
+  data.tar.gz: 6279be9813e5e94d511e9f5b3c04b1ff45e42daa2f5b884a07901be8c02feae5976cba8c4ef670645ad9c6e6ab05e296857edf5e18af2d078c74acc563c51441

data/README.md

@@ -31,17 +31,69 @@ To test your access token, you can use the *getMe* method
 require 'telegramAPI'
 
 token = "******"
-api = TelegramAPI.new token
-bot = api.getMe
+api = TelegramAPI.new(token)
+bot = api.getMe()
 puts "I'm bot #{bot['first_name']} with id #{bot['id']}"
 puts "But you can call me @#{bot['username']}"
 ```
 
+## Getting Updates
+
+There are two ways of getting updates from Telegram.
+The first one is the simpliest, but less powerful: **getUpdates**
+
+### 1. getUpdates
+
+```ruby
+require 'telegramAPI'
+
+token = "******"
+api = TelegramAPI.new(token)
+while true do
+  updates = api.getUpdates({"timeout"=>180})
+  updates.each do |update|
+    usr = update['message']['chat']['username'] || "unknown"
+    puts "Received update from @#{usr}"
+  end
+end
+```
+
+### 2. setWebhook
+
+Using setWebhook is not so complicated, but you need a web server with https support enabled (for example: Openshift or Heroku)
+
+In the example below I will use Sinatra framework for the Web Server.
+
+```ruby
+require 'telegramAPI'
+require 'sinatra'
+require 'json'
+
+token = "******"
+api = TelegramAPI.new token
+
+post "/#{token}" do
+  status 200
+  # Get Telegram Data
+  request.body.rewind
+  data = JSON.parse(request.body.read)
+  
+  # Output data on stdout
+  p data
+  # Return an empty json, to say "ok" to Telegram
+  "{}"
+end
+
+r = api.setWebhook("https://YOUR_URL/#{token}").to_json
+puts "setWebhook Result: #{r}" 
+```
+
+
 ## Documentation
 
-Here you can use the Telegram official [documentation](https://core.telegram.org/bots/api#available-methods)
+You can use the Telegram official [documentation](https://core.telegram.org/bots/api#available-methods)
 
-## List of methods available
+## List of available methods
 
 Every method has a optional parameter. See the Send Custom Keyboard example for more.
 

data/lib/telegramAPI.rb

@@ -32,17 +32,20 @@ class TelegramAPI
     params_s = "?#{p.join("&")}" if p.length!=0
 
     r = JSON.parse(RestClient.get(@@core+@token+"/"+api+params_s).body)
-    if r['ok']!=true then return nil end
-    if r['result'][-1]!=nil then @last_update=r['result'][-1]['update_id']+1 end
+    if r['result'].class==Array and r['result'][-1]!=nil then @last_update=r['result'][-1]['update_id']+1 end
     return r["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)["result"]
   end
+  
+  def setWebhook url
+    self.query("setWebhook", {"url"=>URI::encode(url)})
+  end
 
   def getUpdates options={"timeout"=>0, "limit"=>100}
-    self.query "getUpdates", {"offset"=>@last_update.to_s}.merge(parse_hash(options))
+    self.query("getUpdates", {"offset"=>@last_update.to_s}.merge(parse_hash(options)))
   end
 
   def getMe
@@ -61,19 +64,19 @@ class TelegramAPI
   end
 
   def sendPhoto to, path, options={}
-    self.post "/sendPhoto", :photo, path, to, options
+    self.post("/sendPhoto", :photo, path, to, options)
   end
 
   def sendAudio to, path, options={}
-    self.post "/sendAudio", :audio, path, to, options
+    self.post("/sendAudio", :audio, path, to, options)
   end
 
   def sendDocument to, path, options={}
-    self.post "/sendDocument", :document, path, to, options
+    self.post("/sendDocument", :document, path, to, options)
   end
 
   def sendStickerFromFile to, path, options={}
-    self.post "/sendSticker", :sticker, path, to, options
+    self.post("/sendSticker", :sticker, path, to, options)
   end
 
   def sendSticker to, id, options={}
@@ -81,11 +84,11 @@ class TelegramAPI
   end
 
   def sendVideo to, path, options={}
-    self.post "/sendVideo", :video, path, to, options
+    self.post("/sendVideo", :video, path, to, options)
   end
 
   def sendVoice to, path, options={}
-    self.post "/sendVoice", :voice, path, to, options
+    self.post("/sendVoice", :voice, path, to, options)
   end
 
   def sendLocation to, lat, long, options={}
@@ -102,7 +105,7 @@ class TelegramAPI
 
   # 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
 
   def getUserProfilePhotos id, options={}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telegramAPI
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Benedetto Nespoli