teleruby 1.5.1 → 1.5.4

data/lib/api/set_apis.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative '../core_api'
+
+##
+# Solomon Boloshe(Lee Crey)
+# Friday, August 21 2020 06:35:33 PM +0300
+
+module Telegram
+  module SetApis # rubocop:disable Metrics/ModuleLength
+    include CoreApi
+    # Use this method to set a custom title for an administrator
+    # in a supergroup promoted by the bot.
+    def set_cutom_title(chat_id, user_id, title)
+      if chat_id.to_i.negative?
+        raise BadRequestError, 'can\' set custom title for private chat'
+      end
+      hash = { chat_id: chat_id, user_id: user_id, custom_title: title }
+      response = http_post('setChatAdministratorCustomTitle', hash)
+      unless response.ok # rubocop:disable Style/IfUnlessModifier
+        raise PermissionError, response.description
+      end
+      response.result
+    end
+
+    def set_chat_permissions(chat_id, permissions)
+      unless chat_id.to_i.negative?
+        raise BadRequestError, 'can\' set permissions for private chat'
+      end
+      hash = { chat_id: chat_id, permissions: permissions }
+      response = http_post('setChatPermissions', hash)
+      unless response.ok # rubocop:disable Style/IfUnlessModifier
+        raise PermissionError, response.description
+      end
+      response.result
+    end
+
+    # Use this method to set a new profile photo for the chat.
+    # Photos can't be changed for private chats.
+    def set_chat_photo(chat_id, file)
+      unless chat_id.to_i.negative?
+        fail BadRequestError, 'can\'t set photo for private chat'
+      end
+      hash = { chat_id: chat_id, photo: file }
+      data = http_post('setChatPhoto', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise PermissionError, data.description
+      end
+      data.result
+    end
+
+    # Use this method to change the title of a chat.
+    # Titles can't be changed for private chats.
+    def set_chat_title(chat_id, title)
+      unless chat_id.to_i.negative?
+        raise BadRequestError, 'can\'t set chat title for private'
+      end
+
+      hash = { chat_id: chat_id, title: title.to_s }
+      data = http_post('setChatTitle', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise PermissionError, data.description
+      end
+
+      data.result
+    end
+
+    # Use this method to change the description of a group,
+    # a supergroup or a channel.
+    def set_chat_description(chat_id, description)
+      unless chat_id.to_i.negative?
+        raise BadRequestError, 'can\'t set description for private chat'
+      end
+
+      hash = { chat_id: chat_id, description: description }
+      data = http_post('setChatDescription', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise PermissionError, data.description
+      end
+
+      data.result
+    end
+
+    # Use this method to set a new group sticker set for a supergroup.
+    def set_chat_sticker_set(chat_id, set_name)
+      hash = { chat_id: chat_id, set_name: set_name }
+      data = http_post('setChatStickerSet', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise StandardError, data.description
+      end
+      data.result
+    end
+
+    # Use this method to change the list of the bot's commands.
+    def set_my_command(command)
+      hash = { command: command }
+      data = http_post('setMyCommand', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise TokenError, data.description
+      end
+      data.result
+    end
+
+    # Use this method to move a sticker in a set created by the bot
+    # to a specific position. position must be int value
+    def set_sticker_position_in_the_set(sticker, position)
+      hash = { sticker: sticker, position: position }
+      data = http_post('setStickerPositionInTheSet', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise Error, data.description
+      end
+      data.result
+    end
+
+    # Use this method to set the thumbnail of a sticker set.
+    def set_sticker_set_thumb(name, user_id, params = {})
+      hash = { name: name, user_id: user_id }.merge!(params)
+      data = http_post('setStickerSetThumb', hash)
+      unless data.ok # rubocop:disable Style/IfUnlessModifier
+        raise Error, data.description
+      end
+      data.result
+    end
+
+    def set_webhook(url, params = {})
+      raise NotImplementedError, 'not implemented'
+    end
+  end
+end

data/lib/core_api.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+
+require 'faraday'
+require 'json'
+require_relative 'objects/all'
+
+module Telegram
+  class Error < StandardError; end
+
+  # Raise when chat_id, and user_id are incorrect,
+  class IdError < Error; end
+
+  # Raise when bot token is incorrect.
+  class TokenError < Error; end
+
+  # Raise when bot has not appropriate admin right in supergroups.
+  class PermissionError < Error; end
+
+  # Raise when one of optional parameters is incorrect and telegram
+  # unalbe to do the requested operation.
+  class TelegramError < Error; end
+
+  class FatalError < Error; end
+  class BadRequestError < Error; end
+  class UndefinedMethod < Error; end
+
+  module CoreApi
+    @@base_uri = %q{https://api.telegram.org/bot}
+    @@file_uri = %q{https://api.telegram.org/file/bot} # to download files
+
+    def http_get(method, params = {})
+      body = Faraday.post(@@base_uri + @token + '/' + method, params).body
+      JSON.parse(body)
+    end
+
+    def http_post(method, params = {})
+      body = Faraday.post(@@base_uri + @token + '/' + method, params).body
+      JSON.parse(body)
+    end
+  end
+end

data/lib/objects/all.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby
+# frozen_string_literal: false
+
+# :nodoc:
+
+require_relative 'poll'
+require_relative 'location'
+require_relative 'venue'
+require_relative 'chat'
+require_relative 'bot_command'
+require_relative 'chat_permissions'
+require_relative 'chat_photo'
+require_relative 'callback_query'
+require_relative 'file'
+require_relative 'user_profile_photos'
+require_relative 'poll_answer'
+require_relative 'poll_option'
+require_relative 'dice'
+require_relative 'contact'
+require_relative 'voice'
+require_relative 'video'
+require_relative 'audio'
+require_relative 'photo_size'
+require_relative 'document'
+require_relative 'video_note'
+require_relative 'user'
+require_relative 'message_entity'
+require_relative 'chat_member'
+require_relative 'update'
+require_relative 'chosen_inline_result'
+require_relative 'sticker'
+require_relative 'game'
+require_relative 'inline_query'
+require_relative 'shipping_query'
+require_relative 'mask_position'
+require_relative 'shipping_address'
+require_relative 'pre_checkout_query'
+require_relative 'order_info'
+require_relative 'message'
+require_relative 'animation'
+require_relative 'inlinekeyboardbutton'
+require_relative 'inlinekeyboardmarkup'

data/lib/objects/animation.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require_relative 'photo_size'
+require_relative 'same/common'
+
+##
+# +Sunday+, +August+ +23+ +2020+
+# ===This object represents an animation file.
+# (GIF or H.264/MPEG-4 AVC video without sound).
+class Animation < Common
+  def initialize(obj) # :nodoc:
+    super(obj)
+    freeze
+  end
+
+  # Duration of the video in seconds as defined by sender.
+  def duration
+    @obj.duration
+  end
+
+  # +Optional+. Original animation filename as defined by sender.
+  def file_name
+    @obj.file_name
+  end
+
+  # +Optional.+ MIME type of the file as defined by sender.
+  def mime_type
+    @obj.mime_type
+  end
+
+  def thumb
+    data = @obj.thumb
+    return PhotoSize.new(data) if data
+
+    false
+  end
+end

data/lib/objects/audio.rb

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

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

@@ -0,0 +1,64 @@
+#!/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
+    return Message.new(data) if data
+
+    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/objects/chat.rb

@@ -0,0 +1,158 @@
+#!/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
+    return ChatPhoto.new(data) if data
+
+    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
+    return Message.new(data) if data
+
+    false
+  end
+
+  # +Optional.+ Default chat member permissions, for +groups+ and
+  # +supergroups+. Returns ChatPermissions object.
+  def permissions
+    data = @chat.permissions
+    return ChatPermissions.new(data) if data
+
+    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 ? true : false
+  end
+end