telegram-bot-ruby 2.0.0 → 2.1.0

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

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

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class PaidMediaPreview < Base
+        attribute :type, Types::String.constrained(eql: 'preview').default('preview')
+        attribute? :width, Types::Integer
+        attribute? :height, Types::Integer
+        attribute? :duration, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class PaidMediaPurchased < Base
+        attribute :from, User
+        attribute :paid_media_payload, Types::String
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      PassportElementError = (
+        PassportElementErrorDataField |
+        PassportElementErrorFrontSide |
+        PassportElementErrorReverseSide |
+        PassportElementErrorSelfie |
+        PassportElementErrorFile |
+        PassportElementErrorFiles |
+        PassportElementErrorTranslationFile |
+        PassportElementErrorTranslationFiles |
+        PassportElementErrorUnspecified
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

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

@@ -5,7 +5,8 @@ module Telegram
     module Types
       class Poll < Base
         attribute :id, Types::String
-        attribute :question, Types::String
+        attribute :question, Types::String.constrained(min_size: 1, max_size: 300)
+        attribute? :question_entities, Types::Array.of(MessageEntity)
         attribute :options, Types::Array.of(PollOption)
         attribute :total_voter_count, Types::Integer
         attribute :is_closed, Types::Bool

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

@@ -4,7 +4,8 @@ module Telegram
   module Bot
     module Types
       class PollOption < Base
-        attribute :text, Types::String
+        attribute :text, Types::String.constrained(min_size: 1, max_size: 100)
+        attribute? :text_entities, Types::Array.of(MessageEntity)
         attribute :voter_count, Types::Integer
       end
     end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class PreparedInlineMessage < Base
+        attribute :id, Types::String
+        attribute :expiration_date, Types::Integer
+      end
+    end
+  end
+end

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

@@ -3,10 +3,14 @@
 module Telegram
   module Bot
     module Types
-      ReactionType = ( # rubocop:disable Naming/ConstantName
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      ReactionType = (
         ReactionTypeEmoji |
-        ReactionTypeCustomEmoji
+        ReactionTypeCustomEmoji |
+        ReactionTypePaid
       )
+      # rubocop:enable Naming/ConstantName
     end
   end
 end

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

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class RefundedPayment < Base
+        attribute :currency, Types::String.constrained(eql: 'XTR').default('XTR')
+        attribute :total_amount, Types::Integer
+        attribute :invoice_payload, Types::String
+        attribute :telegram_payment_charge_id, Types::String
+        attribute? :provider_payment_charge_id, Types::String
+      end
+    end
+  end
+end

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

@@ -8,8 +8,8 @@ module Telegram
         attribute? :is_persistent, Types::Bool.default(false)
         attribute? :resize_keyboard, Types::Bool.default(false)
         attribute? :one_time_keyboard, Types::Bool.default(false)
-        attribute? :input_field_placeholder, Types::String
-        attribute? :selective, Types::Bool.default(false)
+        attribute? :input_field_placeholder, Types::String.constrained(min_size: 1, max_size: 64)
+        attribute? :selective, Types::Bool
 
         def to_compact_hash
           hsh = super

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

@@ -5,7 +5,7 @@ module Telegram
     module Types
       class ReplyKeyboardRemove < Base
         attribute :remove_keyboard, Types::True
-        attribute? :selective, Types::Bool.default(false)
+        attribute? :selective, Types::Bool
       end
     end
   end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class ResponseParameters < Base
+        attribute? :migrate_to_chat_id, Types::Integer
+        attribute? :retry_after, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      ## Just for classes consistency
+      # rubocop:disable Naming/ConstantName
+      RevenueWithdrawalState = (
+        RevenueWithdrawalStatePending |
+        RevenueWithdrawalStateSucceeded |
+        RevenueWithdrawalStateFailed
+      )
+      # rubocop:enable Naming/ConstantName
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class RevenueWithdrawalStateSucceeded < Base
+        attribute :type, Types::String.constrained(eql: 'succeeded').default('succeeded')
+        attribute :date, Types::Integer
+        attribute :url, Types::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class SharedUser < Base
+        attribute :user_id, Types::Integer
+        attribute? :first_name, Types::String
+        attribute? :last_name, Types::String
+        attribute? :username, Types::String
+        attribute? :photo, Types::Array.of(PhotoSize)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Telegram
+  module Bot
+    module Types
+      class StarTransaction < Base
+        attribute :id, Types::String
+        attribute :amount, Types::Integer
+        attribute :date, Types::Integer
+        attribute? :source, TransactionPartner
+        attribute? :receiver, TransactionPartner
+      end
+    end
+  end
+end

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

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

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

@@ -7,8 +7,6 @@ module Telegram
         attribute :name, Types::String
         attribute :title, Types::String
         attribute :sticker_type, Types::String
-        attribute :is_animated, Types::Bool
-        attribute :is_video, Types::Bool
         attribute :stickers, Types::Array.of(Sticker)
         attribute? :thumbnail, PhotoSize
       end

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

@@ -3,7 +3,10 @@
 module Telegram
   module Bot
     module Types
-      class Story < Base; end
+      class Story < Base
+        attribute :chat, Chat
+        attribute :id, Types::Integer
+      end
     end
   end
 end

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

@@ -7,6 +7,9 @@ module Telegram
         attribute :currency, Types::String
         attribute :total_amount, Types::Integer
         attribute :invoice_payload, Types::String
+        attribute? :subscription_expiration_date, Types::Integer
+        attribute? :is_recurring, Types::True
+        attribute? :is_first_recurring, Types::True
         attribute? :shipping_option_id, Types::String
         attribute? :order_info, OrderInfo
         attribute :telegram_payment_charge_id, Types::String

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,6 +9,10 @@ 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
@@ -16,6 +20,7 @@ module Telegram
         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

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

@@ -15,6 +15,8 @@ module Telegram
         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/users_shared.rb

@@ -5,7 +5,7 @@ module Telegram
     module Types
       class UsersShared < Base
         attribute :request_id, Types::Integer
-        attribute :user_ids, Types::Array.of(Types::Integer)
+        attribute :users, Types::Array.of(SharedUser)
       end
     end
   end

data/lib/telegram/bot/version.rb

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

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/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