teleruby 1.5.1 → 1.5.4

data/lib/teleruby/objects/audio.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'same/common_2'
+require_relative 'photo_size'
+
+##
+# +Monday,+ +August+ +24+ +2020+
+# ===This object represents an audio file to be treated as music by the Telegram clients.
+class Audio < Common2
+  def initialize(audio) # :nodoc:
+    super(audio)
+  end
+
+  # Duration of the audio in seconds as defined by sender.
+  def duration
+    @obj.duration
+  end
+
+  # +Optional.+ Performer of the audio as defined by sender or by audio tags.
+  def performer
+    @obj.performer
+  end
+
+  # +Optional+. Title of the audio as defined by sender or by audio tags
+  def title
+    @obj.title
+  end
+
+  # +Optional.+ Thumbnail of the album cover to which the music file belongs.
+  def thumb
+    data = @obj.thumb
+    unless data.nil?
+      return PhotoSize.new(data)
+    end
+
+    false
+  end
+end

data/lib/teleruby/objects/bot_command.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+# +Saturday+, +August+ +22+ +2020+ +EAT+
+
+# ===This object represents a bot command
+
+class BotCommand
+  def initialize(bot) # :nodoc:
+    @bot = bot
+    freeze
+  end
+
+  # Text of the command, 1-32 characters. Can contain only lowercase
+  # English letters, digits and underscores.
+  def command
+    @bot.command
+  end
+
+  # Description of the command, 3-256 characters.
+  def description
+    @bot.description
+  end
+end

data/lib/teleruby/objects/callback_query.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'user'
+require_relative 'message'
+
+##
+# +Monday+, +August+ +24+ +2020+
+# ===This object represents an incoming callback query from a callback button in an inline keyboard.
+# If the button that originated the query was
+# attached to a message sent by the bot, the field message will be present.
+# If the button was attached to a message sent via the bot (in inline mode),
+# the field inline_message_id will be present. Exactly one of the fields data
+# or game_short_name will be present.
+class CallbackQuery
+  def initialize(query) # :nodoc:
+    @query = query
+  end
+
+  # Unique identifier for this query.
+  def id
+    @query.id
+  end
+
+  # Sender. Returns User object
+  def from
+    User.new(@query.from)
+  end
+
+  # +Optional+. Message with the callback button that originated the query.
+  # Note that message content and message date will not be available if
+  # the message is too old.
+  def message
+    data = @query.message
+    unless data.nil?
+      return Message.new(data)
+    end
+
+    false
+  end
+
+  # +Optional.+ Identifier of the message sent via the bot in inline mode,
+  # that originated the query.
+  def inline_message_id
+    @query.inline_message_id
+  end
+
+  # Global identifier, uniquely corresponding to the chat to which the
+  # message with the callback button was sent. Useful for high scores
+  # in games.
+  def chat_instance
+    @query.chat_instance
+  end
+
+  # +Optional.+ Data associated with the callback button. Be aware that
+  # a bad client can send arbitrary data in this field.
+  def data
+    @query.data
+  end
+
+  # +Optional.+ Short name of a Game to be returned, serves as the unique
+  # identifier for the game
+  def game_short_name
+    @query.game_short_name
+  end
+end

data/lib/teleruby/objects/chat.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'chat_permissions'
+require_relative 'message'
+require_relative 'chat_photo'
+
+# +Sunday+, +August+ +23+ +2020+ +EAT+
+
+# ===This object represents a chat.
+class Chat
+  def initialize(chat) # :nodoc:
+    @chat = chat
+  end
+
+  # Unique identifier for this chat.
+  def id
+    @chat.id
+  end
+
+  # Type of chat, can be either +private+, +group+,
+  # +supergroup+ or +channel+.
+  def type
+    @chat.type
+  end
+
+  # +Optional+. *Title*, for +supergroups+, +channels+ and +group+ chats.
+  def title
+    @chat.title
+  end
+
+  # +Optional+. *Username*, for +private+ chats, +supergroups+ and
+  # +channels+ if available else nil is returned.
+  def username
+    @chat.username
+  end
+
+  # Returns true if chat type is private else false is returned.
+  def private?
+    type.eql? 'private'
+  end
+
+  # Returns true if chat type is supergroup else false is returned.
+  def supergroup?
+    type.eql? 'supergroup'
+  end
+
+  # Returns true if chat type is channel else false is returned.
+  def channel?
+    type.eql? 'channel'
+  end
+
+  # Returns true if chat has title else false is returned.
+  def has_title?
+    title.nil?
+  end
+end
+
+# ====Returned only for private chat
+# It extends from Chat class.
+class PrivateChat < Chat
+  def initialize(chat) # :nodoc:
+    super(chat)
+  end
+
+  # +Optional+. First name of the other party in a +private+ chat.
+  def first_name
+    @chat.first_name
+  end
+
+  # +Optional.+ Last name of the other party in a +private+ chat.
+  def last_name
+    @chat.last_name
+  end
+end
+
+# ==== This object is returned only in get_chat methods
+# It extends from Chat class.
+class GetChat < Chat
+  def initialize(chat) # :nodoc:
+    super(chat)
+  end
+
+  # +Optional+. Returns ChatPhoto if available else false is returned.
+  def photo
+    data = @chat.photo
+    unless data.nil?
+      return ChatPhoto.new(data)
+    end
+
+    false
+  end
+
+  # +Optional.+ Description, for +groups+, +supergroups+ and +channel+
+  # chats.
+  def description
+    @chat.description
+  end
+
+  # +Optional.+ Chat invite link, for +groups+, +supergroups+ and +channel+
+  # chats. Each administrator in a chat generates their own invite links,
+  # so the bot must first generate the link using +export_chat_link.+
+  def invite_link
+    @chat.invite_link
+  end
+
+  # +Optional+. Pinned message, for +groups+, +supergroups+ and +channels.+
+  # Returns Message object.
+  def pinned_message
+    data = @chat.pinned_message
+    unless data.nil?
+      return Message.new(data)
+    end
+
+    false
+  end
+
+  # +Optional.+ Default chat member permissions, for +groups+ and
+  # +supergroups+. Returns ChatPermissions object.
+  def permissions
+    data = @chat.permissions
+    unless data.nil?
+      return ChatPermissions.new(data)
+    end
+
+    false
+  end
+
+  # +Optional.+ For +supergroups,+ the minimum allowed delay between
+  # consecutive messages sent by each unpriviledged user.
+  def slow_mode_delay
+    @chat.slow_mode_delay
+  end
+
+  # +Optional.+ For +supergroups,+ name of group sticker set.
+  def sticker_set_name
+    @chat.sticker_set_name
+  end
+
+  # +Optional.+ True, if the bot can change the group sticker set.
+  def can_set_sticker_set?
+    @chat.can_set_sticker_set
+  end
+
+  # Returns true if photo is set to chat else false is returned.
+  def has_photo?
+    photo ? true : false
+  end
+
+  # Returns true if description is set to chat else false is returned.
+  def has_description?
+    description.nil?
+  end
+
+  # Returns true if message is pinned in chat else false is returned.
+  def pinned_message?
+    pinned_message ? true : false
+  end
+
+  # Returns true if slow mode delay is set in chat.
+  def slow_mode_delay_set?
+    slow_mode_delay.nil?
+  end
+end

data/lib/teleruby/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') || (status.eql? 'administrator')
+  end
+end

data/lib/teleruby/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