telegramAPI 1.0.17 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5589020558870cc7d0fa94427583ebb5292fc846
-  data.tar.gz: 469c987170dc46d74f169733f2521fc04e85b10c
+  metadata.gz: a4d4ed6e7f6b6e7bab1bd1fccfe9ba95db51ed19
+  data.tar.gz: fdd8295ba7c49a574ccf848fcaceaa5ce0529288
 SHA512:
-  metadata.gz: c192f745daf67b3b8f1bc261b744f72edf439662f57dae2c48f0b501b4ad397b46e1893184bc54425eef50f771ec53ad0224b5f7a2abb08784c379ee3691405e
-  data.tar.gz: 060ebad3d8aab1df3a2c62c5a018fffb6c9c78c7036b350f375f469e96796a8aa877cb789856e36e083c7ea217f487cafa278181104bd95789a5bfcb1156fbc3
+  metadata.gz: b5001ef8a7d75604c7e7e03e6f8c069451b50d284928ac630ae35ea0a841846de17b9fd53172f4a3f03f387a35430db6cc4f76bc857edca5b09effc314c17198
+  data.tar.gz: 860db86abaf052d0722ebe85899d586457f22e8f611526211e759c4c4b7ca1986949f880591a10754911b8a5b2ccaea97df294a771d17090f4bcafe0f58e8d85

data/README.md

@@ -33,14 +33,13 @@ require 'telegramAPI'
 token = "******"
 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}"
+puts "I'm bot #{bot['first_name']} with id #{bot['id']}"
+puts "But you can call me @#{bot['username']}"
 ```
 
 ## Documentation
 
-Here you can find the complete [documentation](https://cdn.rawgit.com/bennesp/telegramAPI/master/doc/TelegramAPI.html)
-
+Here you can use the Telegram official [documentation](https://core.telegram.org/bots/api#available-methods)
 
 ## Examples
 
@@ -53,7 +52,7 @@ while true do
   # Get last messages if there are, or wait 180 seconds for new messages
   u=api.getUpdates({"timeout"=>180})
   u.each do |m|
-    api.sendMessage(m.message.chat.id, m.message.text)
+    api.sendMessage(m['message']['chat']['id'], m['message']['text'])
   end
 end
 ```
@@ -90,5 +89,5 @@ markup = {
   # "hide_keyboard"=>true
 }
 
-api.sendMessage m.message.chat.id, "Am I sexy?", {"reply_markup"=>markup}
+api.sendMessage m['message']['chat']['id'], "Am I sexy?", {"reply_markup"=>markup}
 ```

data/lib/telegramAPI.rb

@@ -1,10 +1,9 @@
-require 'open-uri'
 require 'json'
 require 'net/http'
 require 'net/https'
 require 'uri'
-require 'rest_client'
-require 'telegramObjects'
+require 'rest-client'
+require 'ostruct'
 
 # This library provides an easy way to access to the Telegram Bot API
 # Author:: Benedetto Nespoli
@@ -13,9 +12,6 @@ require 'telegramObjects'
 class TelegramAPI
   @@core = "https://api.telegram.org/bot"
 
-  # Create a new instance of TelegramAPI
-  #
-  # @param token [String] the access token, obtained thanks to {https://telegram.me/botfather @BotFather} on Telegram.
   def initialize token
     @token = token
     @last_update = 0
@@ -36,63 +32,39 @@ class TelegramAPI
     params.each do |param| p << param.join("=") end
     params_s = "?#{p.join("&")}" if p.length!=0
 
-    JSON.parse(open(@@core+@token+"/"+api+params_s).read)
+    JSON.parse(RestClient.get(@@core+@token+"/"+api+params_s).body)
   end
 
   def post api, name, path, to, options={}
-    Message.new JSON.parse(RestClient.post(@@core+@token+api, {name=>File.new(path,'rb'), :chat_id=>to.to_s}.merge(parse_hash(options))).body)["result"]
+    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"]
   end
 
-  # Provide information about the bot itself
-  # @return [User] Information about the bot
-  def getMe
-    User.new self.query("getMe")
-  end
-
-  # Get last updates, including last received messages
-  # @param options [Hash<String, String>] Optional settings
-  # @return [Array<Update>] List of all updates
   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
-    up=ArrayOf.new(r['result'],Update).to_a
-    if up[-1]!=nil then @last_update=up[-1].update_id+1 end
-    return up
+    if r['result'][-1]!=nil then @last_update=r['result'][-1]['update_id']+1 end
+    return r['result']
+  end
+
+  def getMe
+    self.query("getMe")
   end
 
-  # Send a message to the user with id +to+, with the text +text+
-  # @param to [Integer] chat_id to which send the message. Usually message.chat.id
-  # @param text [String] The text to send
-  # @param options (see #getUpdates)
-  # @return [Message] Message with the Photo sent
   def sendMessage to, text, options={}
     if options.has_key?"reply_markup" then
       options["reply_markup"]=options["reply_markup"].to_json
     end
-    Message.new 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)))["result"]
   end
 
-  # Send a message as forwarded
-  # @param to (see #sendMessage)
-  # @param from [Integer] chat_id of the original message.
-  # @param msg [Integer] The message_id of the original message
-  # @return (see #sendPhoto)
   def forwardMessage to, from, msg
-    Message.new 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})["result"]
   end
 
-  # Send a local file containing a photo
-  # @param to (see #sendMessage)
-  # @param path [String] The path of the file to send
-  # @param options (see #sendMessage)
-  # @return (see #sendMessage)
   def sendPhoto to, path, options={}
     self.post "/sendPhoto", :photo, path, to, options
   end
 
-  # Send an audio file in Ogg OPUS format of max 50MB
-  # @param (see #sendPhoto)
-  # @return (see #sendPhoto)
   def sendAudio to, path, options={}
     self.post "/sendAudio", :audio, path, to, options
   end
@@ -117,7 +89,7 @@ class TelegramAPI
   # @param options (see #sendPhoto)
   # @return (see #sendPhoto)
   def sendSticker to, id, options={}
-    Message.new JSON.parse(RestClient.post(@@core+@token+"/sendSticker", {:sticker=>id, :chat_id=>to.to_s}.merge(parse_hash(options))).body)["result"]
+    JSON.parse(RestClient.post(@@core+@token+"/sendSticker", {:sticker=>id, :chat_id=>to.to_s}.merge(parse_hash(options))).body)["result"]
   end
 
   # Send a video file in mp4 format of max 50MB
@@ -134,7 +106,7 @@ class TelegramAPI
   # @param options (see #sendPhoto)
   # @return (see #sendPhoto)
   def sendLocation to, lat, long, options={}
-    Message.new 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)))["result"]
   end
 
   # Send a Chat Action
@@ -149,7 +121,7 @@ class TelegramAPI
   # @param options (see #sendPhoto)
   # @return [UserProfilePhotos]
   def getUserProfilePhotos id, options={}
-    UserProfilePhotos.new self.query("getUserProfilePhotos", {"user_id"=>id}.merge(parse_hash(options)))["result"]
+    self.query("getUserProfilePhotos", {"user_id"=>id}.merge(parse_hash(options)))["result"]
   end
   
   # Kick the user user_id from the chat chat_id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telegramAPI
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: '1.1'
 platform: ruby
 authors:
 - Benedetto Nespoli
@@ -30,7 +30,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.3
-description: A lightweight Ruby API for Telegram Bots
+description: A lightweight wrapper in Ruby for Telegram API Bots
 email: benedetto.nespoli@gmail.com
 executables: []
 extensions: []
@@ -38,7 +38,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/telegramAPI.rb
-- lib/telegramObjects.rb
 homepage: https://github.com/bennesp/telegramAPI
 licenses:
 - MIT
@@ -62,5 +61,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Telegram API for Bots
+summary: Telegram API Wrapper for Bots
 test_files: []

data/lib/telegramObjects.rb

@@ -1,215 +0,0 @@
-class Update
-  attr_accessor :update_id, :message
-  def initialize json
-    return if !json
-    @update_id = json["update_id"]
-    @message = Message.new json["message"]
-  end
-end
-
-# Object describing a Bot or User
-class User
-  attr_accessor :id, :first_name, :last_name, :username
-  def initialize json
-    return if !json
-    @id = json["id"]
-    @first_name = json["first_name"]
-    @last_name = json["last_name"]
-    @username = json["username"]
-  end
-end
-
-# Object describing a Chat Group
-class GroupChat
-  attr_accessor :id, :title
-  def initialize json
-    return if !json
-    @id = json["id"]
-    @title = json["title"]
-  end
-end
-
-class ArrayOf
-  attr_accessor :array, :type
-  def initialize ar, cl
-    return if !ar
-    @array = []
-    @type = cl
-    ar.each do |e|
-      @array<<cl.new(e)
-    end
-  end
-
-  def to_a
-    @array
-  end
-end
-
-# Object describing a Message
-class Message
-  attr_accessor :message_id, :from, :date, :chat, :forward_from, :forward_date,
-    :reply_to_message, :text, :audio, :document, :photo, :voice, :sticker, :video,
-    :contact, :location, :new_chat_participant, :left_chat_participant,
-    :new_chat_title, :new_chat_photo, :delete_chat_photo, :group_chat_create
-
-  def initialize json
-    return if !json
-    @message_id = json["message_id"]
-    @from = User.new json["from"]
-    @date = json["date"]
-    @chat = !json["chat"] ? nil : (json["chat"].has_key?("title") ? GroupChat.new(json["chat"]) : User.new(json["chat"]))
-    @forward_from = User.new json["forward_from"]
-    @forward_date = json["forward_date"]
-    @reply_to_message = Message.new json["reply_to_message"]
-    @text = json["text"]
-    @audio = Audio.new json["audio"]
-    @document = Document.new json["document"]
-    @photo = ArrayOf.new(json["photo"], PhotoSize).to_a
-    @voice = Voice.new json["voice"]
-    @sticker = Sticker.new json["sticker"]
-    @video = Video.new json["video"]
-    @contact = Contact.new json["contact"]
-    @location = Location.new json["location"]
-    @new_chat_participant = User.new json["new_chat_participant"]
-    @left_chat_participant = User.new json["left_chat_participant"]
-    @new_chat_title = json["new_chat_title"]
-    @new_chat_photo = ArrayOf.new(json["new_chat_photo"],PhotoSize).to_a
-    @delete_chat_photo = json["delete_chat_photo"]
-    @group_chat_create = json["group_chat_create"]
-  end
-end
-
-# Object Describing a Photo or Sticker
-class PhotoSize
-  attr_accessor :file_id, :width, :height, :file_size
-  def initialize json
-    return if !json
-    @file_id = json["file_id"]
-    @width = json["width"]
-    @height = json["height"]
-    @file_size = json["file_size"]
-  end
-end
-
-class Audio
-  attr_accessor :file_id, :duration, :mime_type, :file_size
-  def initialize json
-    return if !json
-    @file_id = json["file_id"]
-    @duration = json["duration"]
-    @mime_type = json["mime_type"]
-    @file_size = json["file_size"]
-  end
-end
-
-class Document
-  attr_accessor :file_id, :thumb, :file_name, :mime_type, :file_size
-  def initialize json
-    return if !json
-    @file_id = json["file_id"]
-    @thumb = PhotoSize.new json["thumb"]
-    @file_name = json["file_name"]
-    @mime_type = json["mime_type"]
-    @file_size = json["file_size"]
-  end
-end
-
-class Voice
-  attr_accessor :file_id, :duration, :mime_type, :file_size
-  def initialize json
-    return if !json
-    @file_id = json["file_id"]
-    @duration = json["duration"]
-    @mime_type = json["mime_type"]
-    @file_size = json["file_size"]
-  end
-end
-
-class Sticker
-  attr_accessor :file_id, :width, :height, :thumb, :file_size
-  def initialize json
-    return if !json
-    @file_id = json["file_id"]
-    @width = json["width"]
-    @height = json["height"]
-    @thumb = PhotoSize.new json["thumb"]
-    @file_size = json["file_size"]
-  end
-end
-
-class Video
-  attr_accessor :file_id, :width, :height, :duration, :thumb, :mime_type, :file_size, :caption
-  def initialize json
-    return if !json
-    @file_id = json["file_id"]
-    @width = json["width"]
-    @height = json["height"]
-    @duration = json["duration"]
-    @thumb = PhotoSize.new json["thumb"]
-    @mime_type = json["mime_type"]
-    @file_size = json["file_size"]
-    @caption = json["caption"]
-  end
-end
-
-class Contact
-  attr_accessor :phone_number, :first_name, :last_name, :user_id
-  def initialize json
-    return if !json
-    @phone_number = json["phone_number"]
-    @first_name = json["first_name"]
-    @last_name = json["last_name"]
-    @user_id = json["user_id"]
-  end
-end
-
-class Location
-  attr_accessor :latitude, :longitude
-  def initialize json
-    return if !json
-    @latitude = json["latitude"]
-    @longitude = json["longitude"]
-  end
-end
-
-# Object describing a list of photos in up to 4 sizes each
-class UserProfilePhotos
-  attr_accessor :total_count, :photos
-  def initialize json
-    return if !json
-    @total_count = json["total_count"]
-    @photos = []
-    json["photos"].each do |p|
-      @photos<<ArrayOf.new(p, PhotoSize).to_a
-    end
-  end
-end
-
-class ReplyKeyboardMarkup
-  attr_accessor :keyboard, :resize_keyboard, :one_time_keyboard, :selective
-  def initialize json
-    return if !json
-    @keyboard = json["keyboard"]
-    @resize_keyboard = json["resize_keyboard"]
-    @one_time_keyboard = json["one_time_keyboard"]
-    @selective = json["selective"]
-  end
-end
-
-class ReplyKeyboardHide
-  attr_accessor :hide_keyboard, :selective
-  def initialize json
-    return if !json
-    @hide_keyboard = json["hide_keyboard"]
-    @selective = json["selective"]
-  end
-end
-
-class ForceReply
-  attr_accessor :force_reply, :selective
-  def initialize json
-    return if !json
-    @force_reply = json["force_reply"]
-    @selective = json["selective"]
-  end
-end