telegram-bot-ruby 1.0.0 → 2.1.0

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class TextQuote < Base
+        attribute :text, Types::String
+        attribute? :entities, Types::Array.of(MessageEntity)
+        attribute :position, Types::Integer
+        attribute? :is_manual, Types::True
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      TransactionPartner = (
+        TransactionPartnerUser |
+        TransactionPartnerFragment |
+        TransactionPartnerTelegramAds |
+        TransactionPartnerTelegramApi |
+        TransactionPartnerOther
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class TransactionPartnerFragment < Base
+        attribute :type, Types::String.constrained(eql: 'fragment').default('fragment')
+        attribute? :withdrawal_state, RevenueWithdrawalState
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class TransactionPartnerUser < Base
+        attribute :type, Types::String.constrained(eql: 'user').default('user')
+        attribute :user, User
+        attribute? :invoice_payload, Types::String
+        attribute? :subscription_period, Types::Integer
+        attribute? :paid_media, Types::Array.of(PaidMedia)
+        attribute? :paid_media_payload, Types::String
+        attribute? :gift, Gift
+      end
+    end
+  end
+end

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

@@ -9,16 +9,25 @@ module Telegram
         attribute? :edited_message, Message
         attribute? :channel_post, Message
         attribute? :edited_channel_post, Message
+        attribute? :business_connection, BusinessConnection
+        attribute? :business_message, Message
+        attribute? :edited_business_message, Message
+        attribute? :deleted_business_messages, BusinessMessagesDeleted
+        attribute? :message_reaction, MessageReactionUpdated
+        attribute? :message_reaction_count, MessageReactionCountUpdated
         attribute? :inline_query, InlineQuery
         attribute? :chosen_inline_result, ChosenInlineResult
         attribute? :callback_query, CallbackQuery
         attribute? :shipping_query, ShippingQuery
         attribute? :pre_checkout_query, PreCheckoutQuery
+        attribute? :purchased_paid_media, PaidMediaPurchased
         attribute? :poll, Poll
         attribute? :poll_answer, PollAnswer
         attribute? :my_chat_member, ChatMemberUpdated
         attribute? :chat_member, ChatMemberUpdated
         attribute? :chat_join_request, ChatJoinRequest
+        attribute? :chat_boost, ChatBoostUpdated
+        attribute? :removed_chat_boost, ChatBoostRemoved
 
         def current_message
           @current_message ||=

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

@@ -10,11 +10,13 @@ module Telegram
         attribute? :last_name, Types::String
         attribute? :username, Types::String
         attribute? :language_code, Types::String
-        attribute? :is_premium, Types::Bool
-        attribute? :added_to_attachment_menu, Types::Bool
+        attribute? :is_premium, Types::True
+        attribute? :added_to_attachment_menu, Types::True
         attribute? :can_join_groups, Types::Bool
         attribute? :can_read_all_group_messages, Types::Bool
         attribute? :supports_inline_queries, Types::Bool
+        attribute? :can_connect_to_business, Types::Bool
+        attribute? :has_main_web_app, Types::Bool
       end
     end
   end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class UserChatBoosts < Base
+        attribute :boosts, Types::Array.of(ChatBoost)
+      end
+    end
+  end
+end

data/lib/telegram/bot/types/{user_shared.rb → users_shared.rb}

@@ -3,9 +3,9 @@
 module Telegram
   module Bot
     module Types
-      class UserShared < Base
+      class UsersShared < Base
         attribute :request_id, Types::Integer
-        attribute :user_id, Types::Integer
+        attribute :users, Types::Array.of(SharedUser)
       end
     end
   end

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

@@ -9,7 +9,7 @@ module Telegram
         attribute :width, Types::Integer
         attribute :height, Types::Integer
         attribute :duration, Types::Integer
-        attribute? :thumb, PhotoSize
+        attribute? :thumbnail, PhotoSize
         attribute? :file_name, Types::String
         attribute? :mime_type, Types::String
         attribute? :file_size, Types::Integer

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

@@ -8,7 +8,7 @@ module Telegram
         attribute :file_unique_id, Types::String
         attribute :length, Types::Integer
         attribute :duration, Types::Integer
-        attribute? :thumb, PhotoSize
+        attribute? :thumbnail, PhotoSize
         attribute? :file_size, Types::Integer
       end
     end

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

@@ -12,7 +12,7 @@ module Telegram
         attribute? :last_error_message, Types::String
         attribute? :last_synchronization_error_date, Types::Integer
         attribute? :max_connections, Types::Integer
-        attribute? :allowed_updates, Types::Array.of(String)
+        attribute? :allowed_updates, Types::Array.of(Types::String)
       end
     end
   end

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

@@ -4,6 +4,9 @@ module Telegram
   module Bot
     module Types
       class WriteAccessAllowed < Base
+        attribute? :from_request, Types::Bool
+        attribute? :web_app_name, Types::String
+        attribute? :from_attachment_menu, Types::Bool
       end
     end
   end

data/lib/telegram/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Telegram
   module Bot
-    VERSION = '1.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/telegram/bot.rb

@@ -25,5 +25,6 @@ end
 
 loader = Zeitwerk::Loader.new
 loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.inflector.inflect('endpoints' => 'ENDPOINTS')
 loader.push_dir("#{__dir__}/bot", namespace: Telegram::Bot)
 loader.setup

data/rakelib/parse_schema.rake

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'openapi3_parser'
+
+desc 'Parse types from public json, should be up to date https://github.com/ark0f/tg-bot-api'
+task :parse_schema do
+  document = Openapi3Parser.load_url('https://ark0f.github.io/tg-bot-api/openapi.json')
+
+  result = document.components.schemas.to_h do |type_name, schema|
+    type_schema = schema.properties.to_h do |property_name, property_schema|
+      attribute = { type: parse_initial_type(property_schema, property_name) }
+
+      unless property_schema.any_of.nil?
+        attribute[:type] = property_schema.any_of.map { |item| property_schema.name || item.name || item.type }.uniq
+      end
+
+      # Input File is literally just a string for our purpose
+      attribute[:type]&.delete('InputFile')
+      attribute[:type] = attribute[:type].join if attribute[:type]&.length == 1
+
+      attribute[:required] = true if required_keys(schema).include?(property_name)
+
+      # getting required values from the description, no values in json 😔
+      required_value = property_schema.description&.match(/always “(.+)”|must be \*(.+)\*/)
+      attribute[:required_value] = (required_value[1] || required_value[2]).delete('\\') if required_value
+
+      # for some reason every property's minLength is 0 by default, probably parser bug, had to ignore that
+      attribute[:min_size] = property_schema[:minLength] if property_schema[:minLength] != 0
+      attribute[:max_size] = property_schema[:maxLength] if property_schema[:maxLength]
+
+      attribute[:items] = property_schema.items.type if property_schema&.items
+      if property_schema&.type == 'array' && property_schema&.items&.type.nil?
+        attribute[:items] = property_schema&.items&.name
+      end
+
+      attribute[:items] = property_schema.items.name if property_schema&.items&.type == 'object'
+
+      # array of arrays
+      if property_schema&.items&.type == 'array'
+        attribute[:items] = { type: 'array', items: property_schema.items.items.name }
+      end
+
+      attribute = apply_default_schema(attribute, property_schema)
+      [property_name, attribute]
+    end
+
+    # find empty classes
+    type_schema[:type] = schema.any_of.map(&:name) if schema.properties.empty? && schema.any_of
+    [type_name, type_schema]
+  end
+
+  # Input File is literally just a string for our purpose
+  File.write "#{__dir__}/../utility/type_attributes.json", JSON.pretty_generate(result.except('InputFile'))
+end
+
+def required_keys(schema)
+  schema.required.to_a || []
+end
+
+def apply_default_schema(attribute, property_schema)
+  attribute[:default] = property_schema.default unless property_schema.default.nil?
+  # previous line would have been enough, but had to check the description due to issue: https://github.com/kevindew/openapi3_parser/issues/28
+  attribute[:default] = false if property_schema.description&.include?('Defaults to *false*')
+  attribute
+end
+
+def parse_initial_type(property_schema, property_name)
+  case property_schema.type
+  when nil then property_name.capitalize.gsub(/_(\w)/) { Regexp.last_match(1).upcase }
+  when 'object' then property_schema.name
+  else property_schema.type
+  end
+end

data/rakelib/rebuild_types.rake

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'erb'
+DRY_TYPES = %w[string integer float decimal array hash symbol boolean date date_time time range].freeze
+
+desc 'Rebuild types'
+task :rebuild_types do
+  types = JSON.parse(File.read("#{__dir__}/../utility/type_attributes.json"), symbolize_names: true)
+
+  types.each_pair do |name, attributes|
+    next build_empty_type(name, attributes) if attributes[:type].instance_of?(Array)
+
+    attributes.each_pair do |attr_name, properties|
+      attributes[attr_name][:type] = add_module_types(properties[:type]) unless properties[:type].is_a?(Array)
+      if properties[:type].is_a?(Array)
+        attributes[attr_name][:type] = properties[:type].map do |type|
+          add_module_types(type)
+        end.join(' | ')
+      end
+
+      if properties[:items].instance_of?(String)
+        attributes[attr_name][:type] += ".of(#{add_module_types(properties[:items])})"
+      elsif properties[:items] && properties[:items][:type] == 'array'
+        attributes[attr_name][:type] += ".of(Types::Array.of(#{properties[:items][:items]}))"
+      end
+      original_type = properties[:type]
+
+      attributes = apply_required(attributes, attr_name, properties, original_type)
+      attributes = apply_min_max(attributes, attr_name, properties)
+      attributes = apply_default(attributes, attr_name, properties, original_type)
+
+      attributes[attr_name][:type] = 'Types::True' if attributes[attr_name][:type] == 'Types::Boolean.default(true)'
+      attributes[attr_name][:type] = attributes[attr_name][:type].gsub('Types::Boolean', 'Types::Bool')
+    end
+
+    File.write "#{__dir__}/../lib/telegram/bot/types/#{underscore(name)}.rb",
+               ERB.new(File.read("#{__dir__}/../utility/type.erb")).result(binding).gsub("      \n", '')
+  end
+end
+
+def build_empty_type(name, attributes)
+  attributes = attributes[:type].join(" |\n        ")
+  File.write "#{__dir__}/../lib/telegram/bot/types/#{underscore(name)}.rb",
+             ERB.new(File.read("#{__dir__}/../utility/empty_type.erb")).result(binding).gsub("      \n", '')
+end
+
+def apply_default(attributes, attr_name, properties, original_type)
+  return attributes if properties[:default].nil?
+
+  attributes[attr_name][:type] += ".default(#{typecast(original_type,
+                                                       properties[:default])})"
+  attributes
+end
+
+def apply_required(attributes, attr_name, properties, original_type)
+  return attributes unless properties[:required_value]
+
+  attributes[attr_name][:type] += ".constrained(eql: #{typecast(original_type,
+                                                                properties[:required_value])})"
+  attributes
+end
+
+def apply_min_max(attributes, attr_name, properties)
+  return attributes unless properties[:min_size] || properties[:max_size]
+
+  constrain = '.constrained(minmax)'
+  constrain = properties[:min_size] ? constrain.gsub('min', "min_size: #{properties[:min_size]}, ") : ''
+  constrain = constrain.gsub('max', "max_size: #{properties[:max_size]}") if properties[:max_size]
+  attributes[attr_name][:type] += constrain
+  attributes
+end
+
+def add_module_types(type)
+  return 'Types::Float' if type == 'number'
+
+  DRY_TYPES.include?(type) ? "Types::#{type.capitalize}" : type
+end
+
+def underscore(camel_cased_word)
+  camel_cased_word.to_s.gsub('::', '/')
+                  .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                  .tr('-', '_')
+                  .downcase
+end
+
+def typecast(type, obj)
+  type == 'Types::String' ? "'#{obj}'" : obj
+end

data/telegram-bot-ruby.gemspec

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'telegram/bot/version'
+require_relative 'lib/telegram/bot/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'telegram-bot-ruby'

data/utility/empty_type.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      <%= name %> = (
+        <%= attributes %>
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

data/utility/type.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class <%= name %> < Base
+      <% attributes.each_pair do |name, properties| %>
+        <%= "#{properties[:required] ? 'attribute' : 'attribute?'} :#{name}, #{properties[:type]}" %>
+      <% end %>
+      end
+    end
+  end
+end