teleruby 1.5.1 → 1.5.4

data/lib/teleruby/objects/chat_photo.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===This object represents a chat photo.
+class ChatPhoto
+  def initialize(photo) # :nodoc:
+    @photo = photo
+  end
+
+  # File identifier of small (160x160) chat photo. This file_id can be used
+  # only for photo download and only for as long as the photo is not changed.
+  def small_file_id
+    @photo.small_file_id
+  end
+
+  # Unique file identifier of small (160x160) chat photo, which is supposed
+  # to be the same over time and for different bots.
+  # Can't be used to download or reuse the file.
+  def small_file_unique_id
+    @photo.small_file_unique_id
+  end
+
+  # File identifier of big (640x640) chat photo. This file_id can be used
+  # only for photo download and only for as long as the photo is not changed.
+  def big_file_id
+    @photo.big_file_id
+  end
+
+  # Unique file identifier of big (640x640) chat photo, which is supposed
+  # to be the same over time and for different bots.
+  # Can't be used to download or reuse the file.
+  def big_file_unique_id
+    @photo.big_file_unique_id
+  end
+end

data/lib/teleruby/objects/chosen_inline_result.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+require_relative 'location'
+
+# ===Represents a result of an inline query that was chosen by the user
+# ====and sent to their chat partner.
+class ChoseInlineResult
+  def initialize(result) # :nodoc:
+    @result = result
+  end
+
+  # The unique identifier for the result that was chosen.
+  def result_id
+    @result.result_id
+  end
+
+  # The user that chose the result.
+  def from
+    User.new(@result.from)
+  end
+
+  # +Optional+. Sender location, only for bots that require user location.
+  def location
+    lcation = @result.location
+    unless lcation.nil?
+      return Location.new(lcation)
+    end
+  
+    false
+  end
+
+  # +Optional.+ Identifier of the sent inline message. Available only if
+  # there is an inline keyboard attached to the message. Will be also 
+  # received in callback queries and can be used to edit the message.
+  def inline_message_id
+    @result.inline_message_id
+  end
+
+  # The query that was used to obtain the result.
+  def query
+    @result.query
+  end
+end

data/lib/teleruby/objects/contact.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===This object represents a phone contact.
+class Contact
+  def initialize(conta) # :nodoc:
+    @conta = conta
+    freeze
+  end
+
+  # Contact's phone number.
+  def phone_number
+    @conta.phone_number
+  end
+
+  # Contact's first name
+  def first_name
+    @conta.first_name
+  end
+
+  # +Optional+. Contact's last name
+  def last_name
+    @conta.last_name
+  end
+
+  # +Optional+. Contact's user identifier in Telegram
+  def user_id
+    @conta.user_id
+  end
+
+  # +Optional.+ Additional data about the contact in the form of a vCard
+  def vcard
+    @conta.vcard
+  end
+end

data/lib/teleruby/objects/dice.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+# +Sunday+, +August+ +23+ +2020+ +EAT+
+
+# ===This object represents an animated emoji that displays a random value.
+class Dice
+  def initialize(dice) # :nodoc:
+    @dice = dice
+  end
+
+  # Emoji on which the dice throw animation is based.
+  def emoji
+    @dice.emoji
+  end
+
+  # Value of the dice
+  def value
+    @dice.value
+  end
+end

data/lib/teleruby/objects/document.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'same/common_2'
+require_relative 'photo_size'
+
+# +Sunday+, +August+ +23+ +2020+
+
+# ===This object represents a general file (as opposed to Photo, Voice messages and Audio files).
+# Extend Common2 clas.
+class Document < Common2
+  def initialize(obj) # :nodoc:
+    super(obj)
+  end
+
+  # +Optional+. Original filename as defined by sender.
+  def file_name
+    @obj.file_name
+  end
+
+  def thumb
+    data = @obj.file_name
+    unless data.nil?
+      return PhotoSize.new(data)
+    end
+
+    false
+  end
+end

data/lib/teleruby/objects/file.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday+, +August+ +24+ +2020+
+# ===This object represents a file ready to be downloaded.
+class TFile
+  def initialize(file) # :nodoc:
+    @file = file
+  end
+
+  # Identifier for this file, which can be used to download or reuse the file.
+  def file_id
+    @file.file_id
+  end
+
+  # Unique identifier for this file, which is supposed to be the same over
+  # time and for different bots. Can't be used to download or reuse the file.
+  def file_unique_id
+    @file.file_unique_id
+  end
+
+  # +Optional+. File size, if known.
+  def file_size
+    @file.file_size
+  end
+
+  # +Optional+. File path.
+  def file_path
+    @file.file_path
+  end
+end

data/lib/teleruby/objects/game.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'animation'
+require_relative 'photo_size'
+require_relative 'message_entity'
+
+# This object represents a game. Use BotFather to create and edit games,
+# their short names will act as unique identifiers.
+class Game
+  def initialize(game) # :nodoc:
+    @game = game
+  end
+
+  # Title of the game.
+  def title
+    @game.title
+  end
+
+  # Description of the game.
+  def description
+    @game.description
+  end
+
+  # +Optional.+ Brief description of the game or high scores included in
+  # the game message.
+  def text
+    @game.text
+  end
+
+  # +Optional+. Animation that will be displayed in the game message in
+  # chats. Upload via BotFather
+  def animation
+    @game.animation
+  end
+
+  # +Optional+. Special entities that appear in text, such as usernames,
+  # URLs, bot commands, etc.
+  def text_entities
+    t_ent = @game.text_entities
+    ary_ent = []
+    unless t_ent.empty?
+      t_ent.each do |ent|
+        ary_ent << MessageEntity.new(ent)
+      end
+      return ary_ent
+    end
+ 
+    false
+  end
+
+  # Photo that will be displayed in the game message in chats.
+  def photo
+    poto = @game.photo
+    ary_poto = []
+    unless poto.empty?
+      poto.each do |p|
+        ary_poto << PhotoSize.new(p)
+      end
+      return ary_poto
+    end
+
+    false
+  end
+end

data/lib/teleruby/objects/inline_query.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+require_relative 'location'
+
+# This object represents an incoming inline query. When the user sends
+# an empty query, your bot could return some default or trending results.
+class InlineQuery
+  def initialize(query) # :nodoc:
+    @query = query
+  end
+
+  # Unique identifier for this query
+  def id
+    @query.id
+  end
+
+  # Sender.
+  # User object
+  def from
+    User.new(@query.from)
+  end
+
+  # +Optional+. Sender location, only for bots that request user location,
+  def location
+    lcation = @query.location
+    unless lcation.nil?
+      return Location.new(lcation)
+    end
+
+    false
+  end
+
+  # Text of the query (up to 256 characters)
+  def query
+    @query.query
+  end
+
+  # Offset of the results to be returned, can be controlled by the bot.
+  def offset
+    @query.offset
+  end
+end

data/lib/teleruby/objects/inlinekeyboardbutton.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+# ===This object represents one button of an inline keyboard.
+# You must use exactly one of the optional fields.
+class InlineKeyboardButton
+  def initialize(button) # :nodoc:
+    @button = button
+  end
+
+  # Label text on the button.
+  def text
+    @button.text
+  end
+
+  # +Optional+. HTTP or tg:// url to be opened when button is pressed
+  def url
+    @button.url
+  end
+
+  # +Optional+. An HTTP URL used to automatically authorize the user.
+  # Can be used as a replacement for the Telegram 
+  # {Login Widget.}[https://core.telegram.org/widgets/login]
+  def login_url
+    @button.login_url
+  end
+
+  # +Optional+. Data to be sent in a CallbackQuery to the bot when
+  # button is pressed, 1-64 bytes.
+  def callback_data
+    @button.callback_data
+  end
+
+  # +Optional+. If set, pressing the button will prompt the user to
+  # select one of their chats, open that chat and insert the bot's
+  # username and the specified inline query in the input field.
+  # Can be empty, in which case just the bot's username will be inserted.
+  def switch_inline_query
+    @button.switch_inline_query
+  end
+
+  # +Optional.+ If set, pressing the button will insert the bot's username
+  # and the specified inline query in the current chat's input field.
+  # Can be empty, in which case only the bot's username will be inserted.
+  def switch_inline_query_current_chat
+    @button.switch_inline_query_current_chat
+  end
+
+  # +Optional+. Description of the game that will be launched when the
+  # user presses the button.
+  def callback_game
+    @button.callback_game
+  end
+
+  # +Optional+. Specify True, to send a Pay button.
+  def pay?
+    @button.pay
+  end
+end

data/lib/teleruby/objects/inlinekeyboardmarkup.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'inlinekeyboardbutton'
+
+# This object represents an inline keyboard that appears
+# right next to the message it belongs to.
+class InlineKeyboardMarkup
+  def initialize(mup) # :nodoc:
+    @mup = mup
+  end
+
+  # Array of button rows, each represented by an Array of
+  # InlineKeyboardButton objects.
+  def inline_keyboard
+    data = @mup.inline_keyboard
+    unless data.empty?
+      ary = []
+      data.each do |e|
+        ary2 = []
+        e.each do |f|
+          ary2 << InlineKeyboardButton.new(f)
+        end
+        ary << ary2
+      end
+      return ary
+    end
+
+    false
+  end
+end

data/lib/teleruby/objects/location.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===This object represents a point on the map
+class Location
+  def initialize(location) # :nodoc:
+    @loc = location
+  end
+
+  # Longitude as defined by sender.
+  def longitude
+    @loc.longitude
+  end
+
+  # Latitude as defined by sender.
+  def latitude
+    @loc.latitude
+  end
+end

data/lib/teleruby/objects/mask_position.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+# This object describes the position on faces where a mask should be
+# placed by default.
+class MaskPosition
+  def initialize(pos) # :nodoc:
+    @pos = pos
+  end
+
+  # The part of the face relative to which the mask should be placed.
+  # One of “forehead”, “eyes”, “mouth”, or “chin”.
+  def point
+    @pos.point
+  end
+
+  # Shift by X-axis measured in widths of the mask scaled to the face size,
+  # from left to right. For example, choosing -1.0 will place mask just to
+  # the left of the default mask position.
+  def x_shift
+    @pos.x_shift
+  end
+
+  # Shift by Y-axis measured in heights of the mask scaled to the face size,
+  # from top to bottom. For example, 1.0 will place the mask just below the
+  # default mask position.
+  def y_shift
+    @pos.y_shift
+  end
+
+  # Mask scaling coefficient. For example, 2.0 means double size.
+  def scale
+    @pos.scale
+  end
+end