teleruby 1.5.1 → 1.5.4

data/lib/objects/chat_member.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===This object contains information about one member of a chat.
+class ChatMember
+  def initialize(mem) # :nodoc:
+    @memb = mem
+  end
+
+  # Information about the user.
+  # Return User object.
+  def user
+    User.new(@memb.user)
+  end
+
+  # The member's status in the chat. Can be +creator+, +administrator+,
+  # +member+, +restricted+, +left+ or +kicked+.
+  def status
+    @memb.status
+  end
+
+  # +Optional.+ Owner and administrators only. Custom title for this user.
+  # check if user is admin using #admin? before going to use this method,
+  # unless nil is returned.
+  def custom_title
+    @memb.custom_title
+  end
+
+  # +Optional.+ Restricted and kicked only. Date when restrictions will be
+  # lifted for this user; unix time.
+  # Check if user is restricted or kicked using #member? before going to use
+  # this method else if user is not kicked or restricted then nil is returned.
+  def until_date
+    @memb.until_date
+  end
+
+  # +Optional.+ Administrators only. True, if the bot is allowed to edit
+  # administrator privileges of that user.
+  def can_be_edited?
+    @memb.can_be_edited
+  end
+
+  # +Optional.+ Administrators only. True, if the administrator can post in
+  # the channel; channels only.
+  def can_post_messages?
+    @memb.can_post_messages
+  end
+
+  # +Optional.+ Administrators only. True, if the administrator can edit
+  # messages of other users and can pin messages; channels only.
+  def can_edit_messages?
+    @memb.can_edit_messages
+  end
+
+  # +Optional.+ Administrators only. True, if the administrator can delete
+  # messages of other users.
+  def can_delete_messages?
+    @memb.can_delete_messages
+  end
+
+  # +Optional.+ Administrators only. True, if the administrator can restrict,
+  # #ban_chat_member or #unban_chat_member s.
+  def can_restrict_members?
+    @memb.can_restrict_members
+  end
+
+  # +Optional.+ Administrators only. True, if the administrator can add new
+  # administrators with a subset of their own privileges or demote
+  # administrators that he has promoted, directly or indirectly
+  # (promoted by administrators that were appointed by the user)
+  def can_promote_members?
+    @memb.can_promote_members
+  end
+
+  # +Optional.+ Administrators and restricted only. True, if the user is
+  # allowed to change the chat title, photo and other settings.
+  def can_change_info?
+    @memb.can_change_info
+  end
+
+  # +Optional.+ Administrators and restricted only. True, if the user
+  # is allowed to invite new users to the chat.
+  def can_invite_users?
+    @memb.can_invite_users
+  end
+
+  # +Optional.+ Administrators and restricted only. True, if the user is
+  # allowed to pin messages; groups and supergroups only.
+  def can_pin_messages?
+    @memb.can_pin_messages
+  end
+
+  # +Optional.+ Restricted only. True, if the user is a member of the
+  # chat at the moment of the reques.
+  def member?
+    @memb.is_member
+  end
+
+  # +Optional+. Restricted only. True, if the user is allowed to send text
+  # messages, contacts, locations and venues.
+  def can_send_messages?
+    @memb.can_send_messages
+  end
+
+  # +Optional+. Restricted only. True, if the user is allowed to send
+  # audios, documents, photos, videos, video notes and voice notes.
+  def can_send_media_messages?
+    @memb.can_send_media_messages
+  end
+
+  # +Optional.+ Restricted only. True, if the user is allowed to send polls
+  def can_send_polls?
+    @memb.can_send_polls
+  end
+
+  # +Optional.+ Restricted only. True, if the user is allowed to send
+  # animations, games, stickers and use inline bots.
+  def can_send_other_messages?
+    @memb.can_send_other_messages
+  end
+
+  # +Optional.+ Restricted only. True, if the user is allowed to add
+  # web page previews to their messages.
+  def can_add_web_page_previews?
+    @memb.can_add_web_page_previews
+  end
+
+  # Returns true if user if left the chat. +NB:+ That does not mean it
+  # checks if user is a part of chat. Kicked != left
+  def left?
+    status.eql? 'left'
+  end
+
+  # Returns true if user is admin
+  def admin?
+    (status.eql? 'creator') or (status.eql? 'administrator')
+  end
+end

data/lib/objects/chat_permissions.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+##
+# +Monday+, +August+ +24+ +2020+ +EAT+
+# ===Describes actions that a non-administrator user is allowed to take in a chat.
+class ChatPermissions
+  def initialize(perm) # :nodoc:
+    @perm = perm
+  end
+
+  # +Optional+. True, if the user is allowed to send text messages, contacts,
+  # locations and venues.
+  def can_send_messages?
+    @perm.can_send_messages
+  end
+
+  # +Optional.+ True, if the user is allowed to send +audios+, +documents+,
+  # +photos,+ +videos+, +video_notes+ and +voice_notes,+ 
+  # implies can_send_messages.
+  def can_send_media_messages?
+    @perm.can_send_media_messages
+  end
+
+  # +Optional+. True, if the user is allowed to +send_polls+, implies
+  # +can_send_messages?+
+  def can_send_polls?
+    @perm.can_send_polls
+  end
+
+  # +Optional.+ True, if the user is allowed to send animations, games
+  # stickers and use inline bots, implies can_send_media_messages
+  def can_send_other_messages?
+    @perm.can_send_other_messages
+  end
+
+  # +Optional.+ True, if the user is allowed to add web page previews to
+  # their messages, implies +can_send_media_messages?+
+  def can_add_web_page_previews?
+    @perm.can_add_web_page_previews
+  end
+
+  # +Optional.+ True, if the user is allowed to change the chat title,
+  # photo and other settings. Ignored in public supergroups.
+  def can_change_info?
+    @perm.can_change_info
+  end
+
+  # +Optional.+ True, if the user is allowed to invite new users to the chat.
+  def can_invite_users?
+    @perm.can_invite_users
+  end
+
+  # +Optional.+ True, if the user is allowed to pin messages.
+  # Ignored in public supergroups.
+  def can_pin_messages?
+    @perm.can_pin_messages
+  end
+end

data/lib/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/objects/chosen_inline_result.rb

@@ -0,0 +1,43 @@
+#!/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
+    return Location.new(lcation) if lcation
+
+    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/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/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/objects/document.rb

@@ -0,0 +1,27 @@
+#!/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
+    return PhotoSize.new(data) if data
+
+    false
+  end
+end

data/lib/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/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
+    if t_ent.empty?
+      return false
+    end
+
+    ary = []
+    t_ent.each do |ent|
+      ary << MessageEntity.new(ent)
+    end
+    ary
+  end
+
+  # Photo that will be displayed in the game message in chats.
+  def photo
+    poto = @game.photo
+    if poto.empty?
+      return false
+    end
+
+    ary = []
+    poto.each do |p|
+      ary << PhotoSize.new(p)
+    end
+    ary
+  end
+end