telegram-bot-ruby 0.22.0 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8030abc5a162f5722c34de4e39f57dfd7f772799b52c6c9f343222bd096ba13
-  data.tar.gz: 1b76a2b67b4843d2441ffed6f2b464fafee7dda4ebe2479517574bc6bd58779e
+  metadata.gz: 6149f85b75abd46b546aac32fbe88da43e4a414bcaabb6ea05d213681d136460
+  data.tar.gz: 88ae56d90f1e50883034d5433d3636f2feddc2ec31826466de31e23d61e2edfa
 SHA512:
-  metadata.gz: be56c3408f95d8767939d973fd1b91c0cd990ec4c7119c5d868e3af5e6662a5f884109006713f0eabf231fa7e0816c85b221574bf12f9439a06c368dabc96943
-  data.tar.gz: 2737d5f9fb49fbb08343b632eaab7a7e61f25c27665424c25d4a4e54e1986ddc82b627a7018565da35a65968bc42e2b7098da0b5c7702db2fc10b8f459a233ed
+  metadata.gz: c44671c55c2dcc30b15aef63d02351775a69ae2e73ed738e74ea97c469217b17f4e0581e5300dc4280b1dda36ce1ed4d2191ee9d824491935aaa09f1e1fcefbf
+  data.tar.gz: e7c37c40f7f2dc9d86618a18b8e17e91a75f03632c60a8e075b78ce890d7c093501f3a4366b583b9cd3b85715bd06468cedc1472f5a153565ca132e5c97fe8d1

data/.env.sample

@@ -0,0 +1,2 @@
+BOT_API_ENV=test
+BOT_API_TOKEN=

data/.gitignore

@@ -1,5 +1,6 @@
 Gemfile.lock
 
 .bundle/
+.env
 pkg/
 vendor/bundle/

data/.rubocop.yml

@@ -15,9 +15,10 @@ Style/FrozenStringLiteralComment:
     - bin/console
 
 Metrics/BlockLength:
-  IgnoredMethods:
+  AllowedMethods:
     - context
     - describe
+    - task
 
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.23.0
+
+- Rename `Telegram::Bot.configuration` options:
+  - `timeout` to `connection_timeout`
+  - `open_timeout` to `connection_open_timeout`
+- Fix issue with missing default value for long-polling timeout
+
 ## 0.21.0
 
 - Implement [Bot API 6.1](https://core.telegram.org/bots/api#june-20-2022)

data/README.md

@@ -18,13 +18,13 @@ gem 'telegram-bot-ruby'
 And then execute:
 
 ```shell
-$ bundle
+bundle
 ```
 
 Or install it system-wide:
 
 ```shell
-$ gem install telegram-bot-ruby
+gem install telegram-bot-ruby
 ```
 
 ## Usage
@@ -50,8 +50,13 @@ end
 
 Note that `bot.api` object implements [Telegram Bot API methods](https://core.telegram.org/bots/api#available-methods) as is. So you can invoke any method inside the block without any problems. All methods are available in both *snake_case* and *camelCase* notations.
 
-If you need to start a bot on development mode you have to pass `enviroment: :test` <br>
-example: `Telegram::Bot::Client.run(token, enviroment: :test)` 
+If you need to start a bot in development mode you have to pass `environment: :test`:
+
+```ruby
+Telegram::Bot::Client.run(token, environment: :test) do |bot|
+  # ...
+end
+```
 
 Same thing about `message` object - it implements [Message](https://core.telegram.org/bots/api#message) spec, so you always know what to expect from it.
 
@@ -80,8 +85,13 @@ bot.listen do |message|
     question = 'London is a capital of which country?'
     # See more: https://core.telegram.org/bots/api#replykeyboardmarkup
     answers =
-      Telegram::Bot::Types::ReplyKeyboardMarkup
-      .new(keyboard: [%w(A B), %w(C D)], one_time_keyboard: true)
+        Telegram::Bot::Types::ReplyKeyboardMarkup.new(
+          keyboard: [
+            [{ text: 'A' }, { text: 'B' }],
+            [{ text: 'C' }, { text: 'D' }]
+          ],
+          one_time_keyboard: true
+        )
     bot.api.send_message(chat_id: message.chat.id, text: question, reply_markup: answers)
   when '/stop'
     # See more: https://core.telegram.org/bots/api#replykeyboardremove
@@ -95,10 +105,10 @@ Furthermore, you can ask user to share location or phone number using `KeyboardB
 
 ```ruby
 bot.listen do |message|
-  kb = [
+  kb = [[
     Telegram::Bot::Types::KeyboardButton.new(text: 'Give me your phone number', request_contact: true),
     Telegram::Bot::Types::KeyboardButton.new(text: 'Show me your location', request_location: true)
-  ]
+  ]]
   markup = Telegram::Bot::Types::ReplyKeyboardMarkup.new(keyboard: kb)
   bot.api.send_message(chat_id: message.chat.id, text: 'Hey!', reply_markup: markup)
 end
@@ -117,11 +127,11 @@ bot.listen do |message|
       bot.api.send_message(chat_id: message.from.id, text: "Don't touch me!")
     end
   when Telegram::Bot::Types::Message
-    kb = [
+    kb = [[
       Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Go to Google', url: 'https://google.com'),
       Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Touch me', callback_data: 'touch'),
       Telegram::Bot::Types::InlineKeyboardButton.new(text: 'Switch to inline', switch_inline_query: 'some text')
-    ]
+    ]]
     markup = Telegram::Bot::Types::InlineKeyboardMarkup.new(inline_keyboard: kb)
     bot.api.send_message(chat_id: message.chat.id, text: 'Make a choice', reply_markup: markup)
   end
@@ -137,8 +147,8 @@ bot.listen do |message|
   case message
   when Telegram::Bot::Types::InlineQuery
     results = [
-      [1, 'First article', 'Very interesting text goes here.'],
-      [2, 'Second article', 'Another interesting text here.']
+      ['1', 'First article', 'Very interesting text goes here.'],
+      ['2', 'Second article', 'Another interesting text here.']
     ].map do |arr|
       Telegram::Bot::Types::InlineQueryResultArticle.new(
         id: arr[0],
@@ -166,7 +176,8 @@ Your bot can even upload files ([photos](https://core.telegram.org/bots/api#send
 bot.listen do |message|
   case message.text
   when '/photo'
-    bot.api.send_photo(chat_id: message.chat.id, photo: Faraday::UploadIO.new('~/Desktop/jennifer.jpg', 'image/jpeg'))
+    path_to_photo = File.expand_path('~/Desktop/jennifer.jpg')
+    bot.api.send_photo(chat_id: message.chat.id, photo: Faraday::UploadIO.new(path_to_photo, 'image/jpeg'))
   end
 end
 ```
@@ -199,6 +210,7 @@ end
 ## Boilerplates
 
 If you don't know how to setup database for your bot or how to use it with different languages here are some boilerplates which can help you to start faster:
+
 - [Ruby Telegram Bot boilerplate](https://github.com/telegram-bots/ruby-telegram-bot-boilerplate)
 
 ## Contributing

data/Rakefile

@@ -15,3 +15,46 @@ end
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc 'Dump type definitions from docs to YAML'
+task :dump_type_attributes do
+  require File.expand_path('lib/telegram/bot', __dir__)
+  require 'nokogiri'
+  require 'open-uri'
+  require 'yaml'
+
+  # Preload every type we have
+  Zeitwerk::Loader.eager_load_all
+  types = Telegram::Bot::Types::Base.descendants.map { |c| c.name.split('::').last }
+
+  # Fetch and parse docs
+  doc = Nokogiri::HTML(URI.open('https://core.telegram.org/bots/api').read)
+
+  result = types.to_h do |type|
+    # This is very hacky but working way to find table containing attributes for
+    # given type. Basic idea is to find heading with type and then iterate until
+    # we find table with attributes or next heading (because sometimes type
+    # doesn't have any attributes).
+    element = doc.at_xpath(%{//h4[text() = "#{type}"]})
+    loop do
+      element = element.next_element
+      break if %w[table h4].include?(element.name)
+    end
+
+    attributes = element.xpath('.//tbody//tr').map do |el|
+      cells = el.children.select { |c| c.name == 'td' }
+      {
+        'name' => cells[0].text,
+        'required' => !cells[2].text.start_with?('Optional.')
+      }
+    end
+
+    [type, attributes]
+  end
+
+  # Write everything to fixture file
+  File.write(
+    File.expand_path('spec/fixtures/type_attributes.yml', __dir__),
+    result.to_yaml
+  )
+end

data/lib/telegram/bot/api.rb

@@ -99,8 +99,8 @@ module Telegram
           faraday.request :multipart
           faraday.request :url_encoded
           faraday.adapter Telegram::Bot.configuration.adapter
-          faraday.options.timeout = Telegram::Bot.configuration.timeout
-          faraday.options.open_timeout = Telegram::Bot.configuration.open_timeout
+          faraday.options.timeout = Telegram::Bot.configuration.connection_timeout
+          faraday.options.open_timeout = Telegram::Bot.configuration.connection_open_timeout
         end
       end
     end

data/lib/telegram/bot/client.rb

@@ -52,6 +52,7 @@ module Telegram
       def default_options
         {
           offset: 0,
+          timeout: 20,
           logger: NullLogger.new,
           url: 'https://api.telegram.org',
           environment: :production

data/lib/telegram/bot/configuration.rb

@@ -3,12 +3,12 @@
 module Telegram
   module Bot
     class Configuration
-      attr_accessor :adapter, :open_timeout, :timeout
+      attr_accessor :adapter, :connection_open_timeout, :connection_timeout
 
       def initialize
         @adapter = Faraday.default_adapter
-        @open_timeout = 20
-        @timeout = 20
+        @connection_open_timeout = 20
+        @connection_timeout = 20
       end
     end
   end

data/lib/telegram/bot/types/animation.rb

@@ -4,15 +4,15 @@ module Telegram
   module Bot
     module Types
       class Animation < Base
-        attribute :file_id, String
-        attribute :file_unique_id, String
-        attribute :width, Integer
-        attribute :height, Integer
-        attribute :duration, Integer
-        attribute :thumb, PhotoSize
-        attribute :file_name, String
-        attribute :mime_type, String
-        attribute :file_size, Integer
+        attribute :file_id, Types::String
+        attribute :file_unique_id, Types::String
+        attribute :width, Types::Integer
+        attribute :height, Types::Integer
+        attribute :duration, Types::Integer
+        attribute? :thumb, PhotoSize
+        attribute? :file_name, Types::String
+        attribute? :mime_type, Types::String
+        attribute? :file_size, Types::Integer
       end
     end
   end

data/lib/telegram/bot/types/audio.rb

@@ -4,15 +4,15 @@ module Telegram
   module Bot
     module Types
       class Audio < Base
-        attribute :file_id, String
-        attribute :file_unique_id, String
-        attribute :duration, Integer
-        attribute :performer, String
-        attribute :title, String
-        attribute :file_name, String
-        attribute :mime_type, String
-        attribute :file_size, Integer
-        attribute :thumb, PhotoSize
+        attribute :file_id, Types::String
+        attribute :file_unique_id, Types::String
+        attribute :duration, Types::Integer
+        attribute? :performer, Types::String
+        attribute? :title, Types::String
+        attribute? :file_name, Types::String
+        attribute? :mime_type, Types::String
+        attribute? :file_size, Types::Integer
+        attribute? :thumb, PhotoSize
       end
     end
   end

data/lib/telegram/bot/types/base.rb

@@ -3,10 +3,11 @@
 module Telegram
   module Bot
     module Types
-      class Base
-        include Virtus.model
+      class Base < Dry::Struct
         include Compactable
         include PatternMatching
+
+        transform_keys(&:to_sym)
       end
     end
   end

data/lib/telegram/bot/types/bot_command.rb

@@ -4,8 +4,8 @@ module Telegram
   module Bot
     module Types
       class BotCommand < Base
-        attribute :command, String
-        attribute :description, String
+        attribute :command, Types::String
+        attribute :description, Types::String
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_all_chat_administrators.rb

@@ -4,7 +4,7 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeAllChatAdministrators < Base
-        attribute :type, String, default: 'all_chat_administrators'
+        attribute :type, Types::String.default('all_chat_administrators')
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_all_group_chats.rb

@@ -4,7 +4,7 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeAllGroupChats < Base
-        attribute :type, String, default: 'all_group_chats'
+        attribute :type, Types::String.default('all_group_chats')
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_all_private_chats.rb

@@ -4,7 +4,7 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeAllPrivateChats < Base
-        attribute :type, String, default: 'all_private_chats'
+        attribute :type, Types::String.default('all_private_chats')
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_chat.rb

@@ -4,8 +4,8 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeChat < Base
-        attribute :type, String, default: 'chat'
-        attribute :chat_id, String
+        attribute :type, Types::String.default('chat')
+        attribute :chat_id, Types::String
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_chat_administrators.rb

@@ -4,8 +4,8 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeChatAdministrators < Base
-        attribute :type, String, default: 'chat_administrators'
-        attribute :chat_id, String
+        attribute :type, Types::String.default('chat_administrators')
+        attribute :chat_id, Types::String
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_chat_member.rb

@@ -4,9 +4,9 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeChatMember < Base
-        attribute :type, String, default: 'chat_member'
-        attribute :chat_id, String
-        attribute :user_id, Integer
+        attribute :type, Types::String.default('chat_member')
+        attribute :chat_id, Types::String
+        attribute :user_id, Types::Integer
       end
     end
   end

data/lib/telegram/bot/types/bot_command_scope_default.rb

@@ -4,7 +4,7 @@ module Telegram
   module Bot
     module Types
       class BotCommandScopeDefault < Base
-        attribute :type, String, default: 'default'
+        attribute :type, Types::String.default('default')
       end
     end
   end

data/lib/telegram/bot/types/callback_query.rb

@@ -4,13 +4,13 @@ module Telegram
   module Bot
     module Types
       class CallbackQuery < Base
-        attribute :id, String
+        attribute :id, Types::String
         attribute :from, User
-        attribute :message, Message
-        attribute :inline_message_id, String
-        attribute :chat_instance, String
-        attribute :data, String
-        attribute :game_short_name, String
+        attribute? :message, Message
+        attribute? :inline_message_id, Types::String
+        attribute :chat_instance, Types::String
+        attribute? :data, Types::String
+        attribute? :game_short_name, Types::String
       end
     end
   end

data/lib/telegram/bot/types/chat.rb

@@ -3,34 +3,33 @@
 module Telegram
   module Bot
     module Types
-      class Chat
-        include Virtus.model(finalize: false)
-        include Compactable
-        include PatternMatching
-
-        attribute :id, Integer
-        attribute :type, String
-        attribute :title, String
-        attribute :username, String
-        attribute :first_name, String
-        attribute :last_name, String
-        attribute :photo, ChatPhoto
-        attribute :bio, String
-        attribute :has_private_forwards, Boolean
-        attribute :has_restricted_voice_and_video_messages, Boolean
-        attribute :join_to_send_messages, Boolean
-        attribute :join_by_request, Boolean
-        attribute :description, String
-        attribute :invite_link, String
-        attribute :pinned_message, 'Telegram::Bot::Types::Message'
-        attribute :permissions, ChatPermissions
-        attribute :slow_mode_delay, Integer
-        attribute :message_auto_delete_time, Integer
-        attribute :has_protected_content, Boolean
-        attribute :sticker_set_name, String
-        attribute :can_set_sticker_set, Boolean
-        attribute :linked_chat_id, Integer
-        attribute :location, ChatLocation
+      class Chat < Base
+        attribute :id, Types::Integer
+        attribute :type, Types::String
+        attribute? :title, Types::String
+        attribute? :username, Types::String
+        attribute? :first_name, Types::String
+        attribute? :last_name, Types::String
+        attribute? :is_forum, Types::Bool
+        attribute? :photo, ChatPhoto
+        attribute? :active_usernames, Types::Array.of(Types::String)
+        attribute? :emoji_status_custom_emoji_id, Types::String
+        attribute? :bio, Types::String
+        attribute? :has_private_forwards, Types::Bool
+        attribute? :has_restricted_voice_and_video_messages, Types::Bool
+        attribute? :join_to_send_messages, Types::Bool
+        attribute? :join_by_request, Types::Bool
+        attribute? :description, Types::String
+        attribute? :invite_link, Types::String
+        attribute? :pinned_message, Message
+        attribute? :permissions, ChatPermissions
+        attribute? :slow_mode_delay, Types::Integer
+        attribute? :message_auto_delete_time, Types::Integer
+        attribute? :has_protected_content, Types::Bool
+        attribute? :sticker_set_name, Types::String
+        attribute? :can_set_sticker_set, Types::Bool
+        attribute? :linked_chat_id, Types::Integer
+        attribute? :location, ChatLocation
       end
     end
   end

data/lib/telegram/bot/types/chat_administrator_rights.rb

@@ -3,18 +3,19 @@
 module Telegram
   module Bot
     module Types
-      class ChatAdministratorRight < Base
-        attribute :is_anonymous, Boolean
-        attribute :can_manage_chat, Boolean
-        attribute :can_delete_messages, Boolean
-        attribute :can_manage_video_chats, Boolean
-        attribute :can_restrict_members, Boolean
-        attribute :can_promote_members, Boolean
-        attribute :can_change_info, Boolean
-        attribute :can_invite_users, Boolean
-        attribute :can_post_messages, Boolean
-        attribute :can_edit_messages, Boolean
-        attribute :can_pin_messages, Boolean
+      class ChatAdministratorRights < Base
+        attribute :is_anonymous, Types::Bool
+        attribute :can_manage_chat, Types::Bool
+        attribute :can_delete_messages, Types::Bool
+        attribute :can_manage_video_chats, Types::Bool
+        attribute :can_restrict_members, Types::Bool
+        attribute :can_promote_members, Types::Bool
+        attribute :can_change_info, Types::Bool
+        attribute :can_invite_users, Types::Bool
+        attribute? :can_post_messages, Types::Bool
+        attribute? :can_edit_messages, Types::Bool
+        attribute? :can_pin_messages, Types::Bool
+        attribute? :can_manage_topics, Types::Bool
       end
     end
   end

data/lib/telegram/bot/types/chat_invite_link.rb

@@ -4,15 +4,15 @@ module Telegram
   module Bot
     module Types
       class ChatInviteLink < Base
-        attribute :invite_link, String
+        attribute :invite_link, Types::String
         attribute :creator, User
-        attribute :creates_join_request, Boolean
-        attribute :is_primary, Boolean
-        attribute :is_revoked, Boolean
-        attribute :name, String
-        attribute :expire_date, Integer
-        attribute :member_limit, Integer
-        attribute :pending_join_request_count, Integer
+        attribute :creates_join_request, Types::Bool
+        attribute :is_primary, Types::Bool
+        attribute :is_revoked, Types::Bool
+        attribute? :name, Types::String
+        attribute? :expire_date, Types::Integer
+        attribute? :member_limit, Types::Integer
+        attribute? :pending_join_request_count, Types::Integer
       end
     end
   end

data/lib/telegram/bot/types/chat_join_request.rb

@@ -6,9 +6,9 @@ module Telegram
       class ChatJoinRequest < Base
         attribute :chat, Chat
         attribute :from, User
-        attribute :date, Integer
-        attribute :bio, String
-        attribute :invite_link, ChatInviteLink
+        attribute :date, Types::Integer
+        attribute? :bio, Types::String
+        attribute? :invite_link, ChatInviteLink
       end
     end
   end

data/lib/telegram/bot/types/chat_location.rb

@@ -5,7 +5,7 @@ module Telegram
     module Types
       class ChatLocation < Base
         attribute :location, Location
-        attribute :address, String
+        attribute :address, Types::String
       end
     end
   end

data/lib/telegram/bot/types/chat_member.rb

@@ -4,28 +4,6 @@ module Telegram
   module Bot
     module Types
       class ChatMember < Base
-        attribute :user, User
-        attribute :status, String
-        attribute :custom_title, String
-        attribute :is_anonymous, Boolean
-        attribute :can_be_edited, Boolean
-        attribute :can_manage_chat, Boolean
-        attribute :can_post_messages, Boolean
-        attribute :can_edit_messages, Boolean
-        attribute :can_delete_messages, Boolean
-        attribute :can_manage_video_chats, Boolean
-        attribute :can_restrict_members, Boolean
-        attribute :can_promote_members, Boolean
-        attribute :can_change_info, Boolean
-        attribute :can_invite_users, Boolean
-        attribute :can_pin_messages, Boolean
-        attribute :is_member, Boolean
-        attribute :can_send_messages, Boolean
-        attribute :can_send_media_messages, Boolean
-        attribute :can_send_polls, Boolean
-        attribute :can_send_other_messages, Boolean
-        attribute :can_add_web_page_previews, Boolean
-        attribute :until_date, Integer
       end
     end
   end

data/lib/telegram/bot/types/chat_member_administrator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ChatMemberAdministrator < ChatMember
+        attribute :status, Types::String
+        attribute :user, User
+        attribute :can_be_edited, Types::Bool
+        attribute :is_anonymous, Types::Bool
+        attribute :can_manage_chat, Types::Bool
+        attribute :can_delete_messages, Types::Bool
+        attribute :can_manage_video_chats, Types::Bool
+        attribute :can_restrict_members, Types::Bool
+        attribute :can_promote_members, Types::Bool
+        attribute :can_change_info, Types::Bool
+        attribute :can_invite_users, Types::Bool
+        attribute? :can_post_messages, Types::Bool
+        attribute? :can_edit_messages, Types::Integer
+        attribute? :can_pin_messages, Types::Integer
+        attribute? :can_manage_topics, Types::Integer
+        attribute? :custom_title, Types::String
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/chat_member_banned.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ChatMemberBanned < ChatMember
+        attribute :status, Types::String
+        attribute :user, User
+        attribute :until_date, Types::Integer
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/chat_member_left.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ChatMemberLeft < ChatMember
+        attribute :status, Types::String
+        attribute :user, User
+      end
+    end
+  end
+end