telegram-bot-ruby 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b61e5af1f53cd133496f945bc7642b2a79e12a1d2be92faca3e45246b51dba5
-  data.tar.gz: de0024292072dfa7dcc74ffa6c66ba4e30d470652bcdcd5d9b193a8cea66f420
+  metadata.gz: c61ae37c189075bf4c60779805815a0eab30f6e06869338741657599a390641c
+  data.tar.gz: ebd700271cbc71e7a1e609936e5e6b01bd37eb6190b90266fe9490be77b62138
 SHA512:
-  metadata.gz: dab03a9d65d7582dce03bb6f5a8aea981a507f8011e2e618264177182c132c4fda82d1fc80da0590d3196e07e145e586c665af1fa8e9fd5fdfbcd8c36439bad2
-  data.tar.gz: 1b165086c50ee02e77298c575712551462c58bdb3f963a70ab823d2c9cffffdf23551af8caa3ad484e47bca3d89505f5656ae05c15648b37e6e84cc73e308011
+  metadata.gz: 1bc5e6853d97f71863ce7f9010f7a6ee948c37adcaa2f0eeb100f1915d73736c4631c1f6c2d36ec189378f10a6a09186bd4b535dc37b267d8d6f324efbbd8d26
+  data.tar.gz: 9e196f0e2709bd705324777f1bd47e0301b407be3a0567ac23f181225d9d1b6e038e787cff2fbac4e5a408446efcd38856d45990d955f76b32d50ff1a606d90f

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.2.0
+
+### Added
+
+- [Bot API 8.1](https://core.telegram.org/bots/api-changelog#october-31-2024) [#319](https://github.com/atipugin/telegram-bot-ruby/pull/319)
+
+## 2.1.0
+
+### Added
+
+- [Bot API 8.0](https://core.telegram.org/bots/api#november-17-2024) (thx [@seorgiy](https://github.com/seorgiy))
+
 ## 2.0.0
 
 ### Added

data/Gemfile

@@ -12,7 +12,11 @@ gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.4'
 gem 'vcr', '~> 6.0'
 
-gem 'rubocop', '~> 1.54.1'
+gem 'rubocop', '~> 1.66.1'
 gem 'rubocop-performance', '~> 1.18'
 gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec', '~> 2.22.0'
+gem 'rubocop-rspec', '~> 3.1.0'
+
+group :development do
+  gem 'openapi3_parser', '~> 0.9.2'
+end

data/README.md

@@ -29,7 +29,7 @@ Please make sure it doesn't break your existing code before upgrading to 1.0.
 Add following line to your Gemfile:
 
 ```ruby
-gem 'telegram-bot-ruby', '~> 1.0'
+gem 'telegram-bot-ruby', '~> 2.1'
 ```
 
 And then execute:

data/Rakefile

@@ -15,48 +15,3 @@ end
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
-
-desc 'Dump type definitions from docs to YAML'
-task :dump_type_attributes do
-  require_relative 'lib/telegram/bot'
-  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)
-
-  next_type_element_names = %w[table h4]
-
-  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 next_type_element_names.include?(element.name)
-    end
-
-    attributes = element.xpath('.//tbody//tr').map do |el|
-      cells = el.children.select { |c| c.name == 'td' }
-      {
-        'name' => cells[0].text,
-        'type' => cells[1].text,
-        'required' => !cells[2].text.start_with?('Optional.'),
-        'required_value' =>
-          cells[2].text.match(/^.+, (?:must be (?<found_type>\w+)|always “(?<found_type>\w+)”)$/)&.[](:found_type)
-      }.compact
-    end
-
-    [type, attributes]
-  end
-
-  # Write everything to fixture file
-  File.write "#{__dir__}/spec/support/type_attributes.yml", result.to_yaml
-end

data/lib/telegram/bot/api/endpoints.rb

@@ -33,7 +33,7 @@ module Telegram
         'restrictChatMember' => Types::Bool,
         'promoteChatMember' => Types::Bool,
         'leaveChat' => Types::Bool,
-        'getChat' => Types::Chat,
+        'getChat' => Types::ChatFullInfo,
         'getChatAdministrators' => Types::Array.of(Types::ChatMember),
         'exportChatInviteLink' => Types::String,
         'setChatPhoto' => Types::Bool,
@@ -107,7 +107,17 @@ module Telegram
         'setMyDescription' => Types::Bool,
         'getMyDescription' => Types::BotDescription,
         'setMyShortDescription' => Types::Bool,
-        'getMyShortDescription' => Types::BotShortDescription
+        'getMyShortDescription' => Types::BotShortDescription,
+        'refundStarPayment' => Types::Bool,
+        'getStarTransactions' => Types::StarTransactions,
+        'sendPaidMedia' => Types::Message,
+        'createChatSubscriptionInviteLink' => Types::ChatInviteLink,
+        'editChatSubscriptionInviteLink' => Types::ChatInviteLink,
+        'getAvailableGifts' => Types::Gifts,
+        'sendGift' => Types::Bool,
+        'savePreparedInlineMessage' => Types::PreparedInlineMessage,
+        'editUserStarSubscription' => Types::Bool,
+        'setUserEmojiStatus' => Types::Bool
       }.freeze
     end
   end

data/lib/telegram/bot/client.rb

@@ -35,7 +35,7 @@ module Telegram
           yield handle_update(update)
         end
       rescue Faraday::TimeoutError, Faraday::ConnectionFailed
-        retry
+        retry if @running
       end
 
       def handle_update(update)

data/lib/telegram/bot/exceptions/response_error.rb

@@ -9,7 +9,7 @@ module Telegram
         def initialize(response:)
           @response = response
 
-          super "Telegram API has returned the error. (#{data.map { |k, v| %(#{k}: #{v.inspect}) }.join(', ')})"
+          super("Telegram API has returned the error. (#{data.map { |k, v| %(#{k}: #{v.inspect}) }.join(', ')})")
         end
 
         def error_code

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class AffiliateInfo < Base
+        attribute? :affiliate_user, User
+        attribute? :affiliate_chat, Chat
+        attribute :commission_per_mille, Types::Integer
+        attribute :amount, Types::Integer
+        attribute? :nanostar_amount, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      BackgroundFill = (
+        BackgroundFillSolid |
+        BackgroundFillGradient |
+        BackgroundFillFreeformGradient
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundFillFreeformGradient < Base
+        attribute :type, Types::String.constrained(eql: 'freeform_gradient').default('freeform_gradient')
+        attribute :colors, Types::Array.of(Types::Integer)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundFillGradient < Base
+        attribute :type, Types::String.constrained(eql: 'gradient').default('gradient')
+        attribute :top_color, Types::Integer
+        attribute :bottom_color, Types::Integer
+        attribute :rotation_angle, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundFillSolid < Base
+        attribute :type, Types::String.constrained(eql: 'solid').default('solid')
+        attribute :color, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      BackgroundType = (
+        BackgroundTypeFill |
+        BackgroundTypeWallpaper |
+        BackgroundTypePattern |
+        BackgroundTypeChatTheme
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundTypeChatTheme < Base
+        attribute :type, Types::String.constrained(eql: 'chat_theme').default('chat_theme')
+        attribute :theme_name, Types::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundTypeFill < Base
+        attribute :type, Types::String.constrained(eql: 'fill').default('fill')
+        attribute :fill, BackgroundFill
+        attribute :dark_theme_dimming, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundTypePattern < Base
+        attribute :type, Types::String.constrained(eql: 'pattern').default('pattern')
+        attribute :document, Document
+        attribute :fill, BackgroundFill
+        attribute :intensity, Types::Integer
+        attribute? :is_inverted, Types::True
+        attribute? :is_moving, Types::True
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BackgroundTypeWallpaper < Base
+        attribute :type, Types::String.constrained(eql: 'wallpaper').default('wallpaper')
+        attribute :document, Document
+        attribute :dark_theme_dimming, Types::Integer
+        attribute? :is_blurred, Types::True
+        attribute? :is_moving, Types::True
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class Birthdate < Base
+        attribute :day, Types::Integer
+        attribute :month, Types::Integer
+        attribute? :year, Types::Integer
+      end
+    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, Types::String
-        attribute :description, Types::String
+        attribute :command, Types::String.constrained(min_size: 1, max_size: 32)
+        attribute :description, Types::String.constrained(min_size: 1, max_size: 256)
       end
     end
   end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      BotCommandScope = (
+        BotCommandScopeDefault |
+        BotCommandScopeAllPrivateChats |
+        BotCommandScopeAllGroupChats |
+        BotCommandScopeAllChatAdministrators |
+        BotCommandScopeChat |
+        BotCommandScopeChatAdministrators |
+        BotCommandScopeChatMember
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BusinessConnection < Base
+        attribute :id, Types::String
+        attribute :user, User
+        attribute :user_chat_id, Types::Integer
+        attribute :date, Types::Integer
+        attribute :can_reply, Types::Bool
+        attribute :is_enabled, Types::Bool
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BusinessIntro < Base
+        attribute? :title, Types::String
+        attribute? :message, Types::String
+        attribute? :sticker, Sticker
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BusinessLocation < Base
+        attribute :address, Types::String
+        attribute? :location, Location
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BusinessMessagesDeleted < Base
+        attribute :business_connection_id, Types::String
+        attribute :chat, Chat
+        attribute :message_ids, Types::Array.of(Types::Integer)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BusinessOpeningHours < Base
+        attribute :time_zone_name, Types::String
+        attribute :opening_hours, Types::Array.of(BusinessOpeningHoursInterval)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class BusinessOpeningHoursInterval < Base
+        attribute :opening_minute, Types::Integer
+        attribute :closing_minute, Types::Integer
+      end
+    end
+  end
+end

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

@@ -11,34 +11,6 @@ module Telegram
         attribute? :first_name, Types::String
         attribute? :last_name, Types::String
         attribute? :is_forum, Types::True
-        attribute? :photo, ChatPhoto
-        attribute? :active_usernames, Types::Array.of(Types::String)
-        attribute? :available_reactions, Types::Array.of(ReactionType)
-        attribute? :accent_color_id, Types::Integer
-        attribute? :background_custom_emoji_id, Types::String
-        attribute? :profile_accent_color_id, Types::Integer
-        attribute? :profile_background_custom_emoji_id, Types::String
-        attribute? :emoji_status_custom_emoji_id, Types::String
-        attribute? :emoji_status_expiration_date, Types::Integer
-        attribute? :bio, Types::String
-        attribute? :has_private_forwards, Types::True
-        attribute? :has_restricted_voice_and_video_messages, Types::True
-        attribute? :join_to_send_messages, Types::True
-        attribute? :join_by_request, Types::True
-        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_aggressive_anti_spam_enabled, Types::True
-        attribute? :has_hidden_members, Types::True
-        attribute? :has_protected_content, Types::True
-        attribute? :has_visible_history, Types::True
-        attribute? :sticker_set_name, Types::String
-        attribute? :can_set_sticker_set, Types::True
-        attribute? :linked_chat_id, Types::Integer
-        attribute? :location, ChatLocation
       end
     end
   end

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

@@ -12,12 +12,12 @@ module Telegram
         attribute :can_promote_members, Types::Bool
         attribute :can_change_info, Types::Bool
         attribute :can_invite_users, Types::Bool
+        attribute :can_post_stories, Types::Bool
+        attribute :can_edit_stories, Types::Bool
+        attribute :can_delete_stories, Types::Bool
         attribute? :can_post_messages, Types::Bool
         attribute? :can_edit_messages, Types::Bool
         attribute? :can_pin_messages, Types::Bool
-        attribute? :can_post_stories, Types::Bool
-        attribute? :can_edit_stories, Types::Bool
-        attribute? :can_delete_stories, Types::Bool
         attribute? :can_manage_topics, Types::Bool
       end
     end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ChatBackground < Base
+        attribute :type, BackgroundType
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ChatBoostAdded < Base
+        attribute :boost_count, Types::Integer
+      end
+    end
+  end
+end

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

@@ -3,11 +3,14 @@
 module Telegram
   module Bot
     module Types
-      ChatBoostSource = ( # rubocop:disable Naming/ConstantName
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      ChatBoostSource = (
         ChatBoostSourcePremium |
         ChatBoostSourceGiftCode |
         ChatBoostSourceGiveaway
       )
+      # rubocop:enable Naming/ConstantName
     end
   end
 end

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

@@ -7,6 +7,7 @@ module Telegram
         attribute :source, Types::String.constrained(eql: 'giveaway').default('giveaway')
         attribute :giveaway_message_id, Types::Integer
         attribute? :user, User
+        attribute? :prize_star_count, Types::Integer
         attribute? :is_unclaimed, Types::True
       end
     end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ChatFullInfo < 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::True
+        attribute :accent_color_id, Types::Integer
+        attribute :max_reaction_count, Types::Integer
+        attribute? :photo, ChatPhoto
+        attribute? :active_usernames, Types::Array.of(Types::String)
+        attribute? :birthdate, Birthdate
+        attribute? :business_intro, BusinessIntro
+        attribute? :business_location, BusinessLocation
+        attribute? :business_opening_hours, BusinessOpeningHours
+        attribute? :personal_chat, Chat
+        attribute? :available_reactions, Types::Array.of(ReactionType)
+        attribute? :background_custom_emoji_id, Types::String
+        attribute? :profile_accent_color_id, Types::Integer
+        attribute? :profile_background_custom_emoji_id, Types::String
+        attribute? :emoji_status_custom_emoji_id, Types::String
+        attribute? :emoji_status_expiration_date, Types::Integer
+        attribute? :bio, Types::String
+        attribute? :has_private_forwards, Types::True
+        attribute? :has_restricted_voice_and_video_messages, Types::True
+        attribute? :join_to_send_messages, Types::True
+        attribute? :join_by_request, Types::True
+        attribute? :description, Types::String
+        attribute? :invite_link, Types::String
+        attribute? :pinned_message, Message
+        attribute? :permissions, ChatPermissions
+        attribute? :can_send_paid_media, Types::True
+        attribute? :slow_mode_delay, Types::Integer
+        attribute? :unrestrict_boost_count, Types::Integer
+        attribute? :message_auto_delete_time, Types::Integer
+        attribute? :has_aggressive_anti_spam_enabled, Types::True
+        attribute? :has_hidden_members, Types::True
+        attribute? :has_protected_content, Types::True
+        attribute? :has_visible_history, Types::True
+        attribute? :sticker_set_name, Types::String
+        attribute? :can_set_sticker_set, Types::True
+        attribute? :custom_emoji_sticker_set_name, Types::String
+        attribute? :linked_chat_id, Types::Integer
+        attribute? :location, ChatLocation
+      end
+    end
+  end
+end

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

@@ -13,6 +13,8 @@ module Telegram
         attribute? :expire_date, Types::Integer
         attribute? :member_limit, Types::Integer
         attribute? :pending_join_request_count, Types::Integer
+        attribute? :subscription_period, Types::Integer
+        attribute? :subscription_price, Types::Integer
       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, Types::String
+        attribute :address, Types::String.constrained(min_size: 1, max_size: 64)
       end
     end
   end

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

@@ -6,12 +6,12 @@ module Telegram
       ## Just for classes consistency
       # rubocop:disable Naming/ConstantName
       ChatMember = (
+        ChatMemberOwner |
         ChatMemberAdministrator |
-        ChatMemberBanned |
-        ChatMemberLeft |
         ChatMemberMember |
-        ChatMemberOwner |
-        ChatMemberRestricted
+        ChatMemberRestricted |
+        ChatMemberLeft |
+        ChatMemberBanned
       )
       # rubocop:enable Naming/ConstantName
     end

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

@@ -15,12 +15,12 @@ module Telegram
         attribute :can_promote_members, Types::Bool
         attribute :can_change_info, Types::Bool
         attribute :can_invite_users, Types::Bool
+        attribute :can_post_stories, Types::Bool
+        attribute :can_edit_stories, Types::Bool
+        attribute :can_delete_stories, Types::Bool
         attribute? :can_post_messages, Types::Bool
         attribute? :can_edit_messages, Types::Bool
         attribute? :can_pin_messages, Types::Bool
-        attribute? :can_post_stories, Types::Bool
-        attribute? :can_edit_stories, Types::Bool
-        attribute? :can_delete_stories, Types::Bool
         attribute? :can_manage_topics, Types::Bool
         attribute? :custom_title, Types::String
       end