mtproto 0.0.13 → 0.0.15

data/lib/mtproto/tl/objects/set_bot_commands.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module MTProto
+  module TL
+    class SetBotCommands
+      include Binary
+
+      CONSTRUCTOR = 0x0517165a
+      BOT_COMMAND_SCOPE_DEFAULT = 0x2f6cb2ab
+      BOT_COMMAND = 0xc27ac8c7
+
+      # commands: array of { command:, description: }
+      def initialize(commands:, lang_code: '')
+        @commands = commands
+        @lang_code = lang_code
+      end
+
+      def serialize
+        result = u32_b(CONSTRUCTOR)
+        result += u32_b(BOT_COMMAND_SCOPE_DEFAULT)
+        result += serialize_tl_string(@lang_code)
+        result += u32_b(Constructors::VECTOR)
+        result += u32_b(@commands.size)
+        @commands.each do |cmd|
+          result += u32_b(BOT_COMMAND)
+          result += serialize_tl_string(cmd[:command])
+          result += serialize_tl_string(cmd[:description])
+        end
+        result
+      end
+
+      private
+
+      def serialize_tl_string(str)
+        bytes = str.to_s.encode('UTF-8').bytes
+        length = bytes.length
+        if length <= 253
+          [length] + bytes + padding(length + 1)
+        else
+          [254] + u32_b(length)[0, 3] + bytes + padding(length + 4)
+        end
+      end
+
+      def padding(current_length)
+        pad_length = (4 - (current_length % 4)) % 4
+        [0] * pad_length
+      end
+    end
+  end
+end

data/lib/mtproto/tl/objects/set_bot_info.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MTProto
+  module TL
+    class SetBotInfo
+      include Binary
+
+      CONSTRUCTOR = 0x10cf3123
+      INPUT_USER = 0xf21158c6
+      INPUT_USER_SELF = 0xf7c1b13f
+
+      # bot: { id:, access_hash: } or { type: :self } (nil = the calling bot)
+      def initialize(bot: nil, lang_code: '', name: nil, about: nil, description: nil)
+        @bot = bot
+        @lang_code = lang_code
+        @name = name
+        @about = about
+        @description = description
+      end
+
+      def serialize
+        flags = 0
+        flags |= (1 << 2) if @bot
+        flags |= (1 << 3) if @name
+        flags |= (1 << 0) if @about
+        flags |= (1 << 1) if @description
+
+        result = u32_b(CONSTRUCTOR)
+        result += u32_b(flags)
+        result += serialize_input_user(@bot) if @bot
+        result += serialize_tl_string(@lang_code)
+        result += serialize_tl_string(@name) if @name
+        result += serialize_tl_string(@about) if @about
+        result += serialize_tl_string(@description) if @description
+        result
+      end
+
+      private
+
+      def serialize_input_user(user)
+        if user[:type] == :self
+          u32_b(INPUT_USER_SELF)
+        else
+          u32_b(INPUT_USER) + u64_b(user[:id]) + u64_b(user[:access_hash] || 0)
+        end
+      end
+
+      def serialize_tl_string(str)
+        bytes = str.to_s.encode('UTF-8').bytes
+        length = bytes.length
+        if length <= 253
+          [length] + bytes + padding(length + 1)
+        else
+          [254] + u32_b(length)[0, 3] + bytes + padding(length + 4)
+        end
+      end
+
+      def padding(current_length)
+        pad_length = (4 - (current_length % 4)) % 4
+        [0] * pad_length
+      end
+    end
+  end
+end

data/lib/mtproto/tl/objects/set_client_dh_params.rb

@@ -16,7 +16,7 @@ module MTProto
         @encrypted_data = encrypted_data
       end
 
-      def body
+      def serialize
         result = u32_b(Constructors::SET_CLIENT_DH_PARAMS)
         result += @nonce.bytes
         result += @server_nonce.bytes

data/lib/mtproto/tl/objects/sign_in.rb

@@ -13,7 +13,7 @@ module MTProto
         @phone_code = phone_code
       end
 
-      def body
+      def serialize
         flags = 1 << 0
 
         u32_b(Constructors::AUTH_SIGN_IN) +

data/lib/mtproto/tl/objects/update.rb

@@ -10,7 +10,7 @@ module MTProto
         @text = text
       end
 
-      def self.parse(bytes)
+      def self.deserialize(bytes)
         constructor_id = bytes[0, 4].unpack1('L<')
         type = type_name(constructor_id)
 

data/lib/mtproto/tl/objects/update_short.rb

@@ -10,9 +10,9 @@ module MTProto
         @date = date
       end
 
-      def self.parse(bytes)
+      def self.deserialize(bytes)
         date = bytes[-4, 4].unpack1('l<')
-        update = Update.parse(bytes[4...-4])
+        update = Update.deserialize(bytes[4...-4])
         new(update, date)
       end
     end

data/lib/mtproto/tl/objects/update_short_message.rb

@@ -23,7 +23,7 @@ module MTProto
         flags & (1 << 4) != 0
       end
 
-      def self.parse(bytes)
+      def self.deserialize(bytes)
         offset = 4 # skip constructor
         flags = bytes[offset, 4].unpack1('L<')
         offset += 4

data/lib/mtproto/tl/objects/update_short_sent_message.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MTProto
+  module TL
+    class UpdateShortSentMessage
+      attr_reader :flags, :id, :pts, :pts_count, :date
+
+      def initialize(flags:, id:, pts:, pts_count:, date:)
+        @flags = flags
+        @id = id
+        @pts = pts
+        @pts_count = pts_count
+        @date = date
+      end
+
+      def out?
+        flags & (1 << 1) != 0
+      end
+
+      def self.deserialize(bytes)
+        offset = 4 # skip constructor
+        flags = bytes[offset, 4].unpack1('L<')
+        offset += 4
+        id = bytes[offset, 4].unpack1('l<')
+        offset += 4
+        pts = bytes[offset, 4].unpack1('l<')
+        offset += 4
+        pts_count = bytes[offset, 4].unpack1('l<')
+        offset += 4
+        date = bytes[offset, 4].unpack1('l<')
+
+        new(flags: flags, id: id, pts: pts, pts_count: pts_count, date: date)
+      end
+    end
+  end
+end

data/lib/mtproto/tl/objects/update_username.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MTProto
+  module TL
+    class UpdateUsername
+      include Binary
+
+      CONSTRUCTOR = 0x3e0bdd7c
+
+      def initialize(username:)
+        @username = username
+      end
+
+      def serialize
+        result = u32_b(CONSTRUCTOR)
+        result += serialize_tl_string(@username)
+        result
+      end
+
+      private
+
+      def serialize_tl_string(str)
+        bytes = str.encode('UTF-8').bytes
+        length = bytes.length
+
+        if length <= 253
+          [length] + bytes + padding(length + 1)
+        else
+          [254] + u32_b(length)[0, 3] + bytes + padding(length + 4)
+        end
+      end
+
+      def padding(current_length)
+        pad_length = (4 - (current_length % 4)) % 4
+        [0] * pad_length
+      end
+    end
+  end
+end

data/lib/mtproto/tl/objects/updates_difference.rb

@@ -1,28 +1,31 @@
 # frozen_string_literal: true
 
 require_relative '../schema'
+require_relative 'dialogs'
 
 module MTProto
   module TL
     class UpdatesDifference
-      attr_reader :type, :date, :seq, :new_messages, :pts, :state
+      attr_reader :type, :date, :seq, :new_messages, :pts, :state, :chats, :users
 
       SCHEMA_PATH = File.expand_path('../../../../data/tl-schema.json', __dir__)
 
-      def initialize(type:, date: nil, seq: nil, new_messages: [], pts: nil, state: nil)
+      def initialize(type:, date: nil, seq: nil, new_messages: [], pts: nil, state: nil, chats: [], users: [])
         @type = type
         @date = date
         @seq = seq
         @new_messages = new_messages
         @pts = pts
         @state = state
+        @chats = chats
+        @users = users
       end
 
       def self.schema
         @schema ||= Schema.new(SCHEMA_PATH)
       end
 
-      def self.parse(data)
+      def self.deserialize(data)
         constructor = data[0, 4].unpack1('L<')
 
         case constructor
@@ -41,6 +44,11 @@ module MTProto
       MESSAGE_CONSTRUCTOR = Constructors::MESSAGE
       MESSAGE_SERVICE = 0x7a800e0a
       MESSAGE_EMPTY = 0x90a6ca84
+      MESSAGE_REPLY_HEADER = 0x6917560b
+      MEDIA_PHOTO = 0x695150d7
+      MEDIA_DOCUMENT = 0x52d8ccd9
+      UPDATE_NEW_MESSAGE = 0x1f2b0afd
+      UPDATE_NEW_CHANNEL_MESSAGE = 0x62ba04d9
 
       class << self
         private
@@ -53,24 +61,48 @@ module MTProto
           )
         end
 
-        # updates.difference: new_messages new_encrypted_messages other_updates chats users state
+        # updates.difference: new_messages new_encrypted_messages other_updates chats users state.
+        # Channel/supergroup messages arrive in other_updates as
+        # updateNewChannelMessage (not in new_messages), so we mine those too; and
+        # chats/users carry the peers' access_hashes for the bot's peer cache.
         def parse_difference(data, constructor)
           offset = 4
 
           messages, offset = parse_messages_vector(data, offset)
           offset = schema.skip_vector(data, offset) # new_encrypted_messages
-          offset = schema.skip_vector(data, offset) # other_updates
-          offset = schema.skip_vector(data, offset) # chats
-          offset = schema.skip_vector(data, offset) # users
-          state = UpdatesState.parse(data[offset..])
+          other_messages, offset = parse_other_updates(data, offset)
+          chats, offset = Dialogs.chats_at(data, offset)
+          users, offset = Dialogs.users_at(data, offset)
+          state = UpdatesState.deserialize(data[offset..])
 
           new(
             type: constructor == Constructors::UPDATES_DIFFERENCE ? :difference : :slice,
-            new_messages: messages,
-            state: state
+            new_messages: messages + other_messages,
+            chats: chats, users: users, state: state
           )
         end
 
+        # other_updates: Vector<Update>. Mine the message-bearing updates
+        # (updateNewMessage / updateNewChannelMessage — each is the update ctor,
+        # then an inner Message, then pts/pts_count); advance the rest via schema.
+        def parse_other_updates(data, offset)
+          offset += 4 # vector constructor
+          count = data[offset, 4].unpack1('L<')
+          offset += 4
+
+          messages = []
+          count.times do
+            ctor = data[offset, 4].unpack1('L<')
+            if [UPDATE_NEW_MESSAGE, UPDATE_NEW_CHANNEL_MESSAGE].include?(ctor)
+              inner_off = offset + 4
+              msg = extract_message(data, inner_off, data[inner_off, 4].unpack1('L<'))
+              messages << msg if msg
+            end
+            offset = schema.skip(data, offset)
+          end
+          [messages, offset]
+        end
+
         def parse_messages_vector(data, offset)
           offset += 4 # vector constructor
           count = data[offset, 4].unpack1('L<')
@@ -97,20 +129,30 @@ module MTProto
           id = data[offset, 4].unpack1('l<')
           offset += 4
 
-          offset = schema.skip(data, offset) if flags.anybits?(1 << 8) # from_id (Peer)
+          from_type = from_id = nil
+          from_type, from_id, offset = parse_peer(data, offset) if flags.anybits?(1 << 8) # from_id (Peer)
           offset += 4 if flags.anybits?(1 << 29) # from_boosts_applied
           peer_type, peer_id, offset = parse_peer(data, offset)
           offset = schema.skip(data, offset) if flags.anybits?(1 << 28) # saved_peer_id
           offset = schema.skip(data, offset) if flags.anybits?(1 << 2) # fwd_from
           offset += 8 if flags.anybits?(1 << 11) # via_bot_id
           offset += 8 if flags2.anybits?(1 << 0) # via_business_bot_id
-          offset = schema.skip(data, offset) if flags.anybits?(1 << 3) # reply_to
+
+          is_reply = false
+          reply_to_msg_id = nil
+          if flags.anybits?(1 << 3) # reply_to
+            reply_to_msg_id, is_reply = parse_reply_to(data, offset)
+            offset = schema.skip(data, offset)
+          end
 
           date = data[offset, 4].unpack1('L<')
           offset += 4
-          message_text, = read_tl_string(data, offset)
+          message_text, offset = read_tl_string(data, offset)
+          media = flags.anybits?(1 << 9) ? parse_media(data, offset) : nil
 
-          { id: id, date: date, message: message_text, peer_type: peer_type, peer_id: peer_id }
+          { id: id, date: date, message: message_text, peer_type: peer_type, peer_id: peer_id,
+            from_type: from_type, from_id: from_id, out: flags.anybits?(1 << 1),
+            media: media, is_reply: is_reply, reply_to_msg_id: reply_to_msg_id }
         end
 
         def parse_peer(data, offset)
@@ -129,6 +171,43 @@ module MTProto
           end
         end
 
+        # messageReplyHeader: ctor, flags, reply_to_msg_id:flags.4?int (first payload
+        # field). A plain message in a forum topic carries this header (forum_topic
+        # flags.3) but is a reply only when it targets a message in the topic
+        # (reply_to_top_id flags.1). => [reply_to_msg_id, is_reply]
+        def parse_reply_to(data, offset)
+          return [nil, false] unless data[offset, 4].unpack1('L<') == MESSAGE_REPLY_HEADER
+
+          io = offset + 4
+          flags = data[io, 4].unpack1('L<')
+          io += 4
+          forum_topic = flags.anybits?(1 << 3)
+          msg_id = flags.anybits?(1 << 4) ? data[io, 4].unpack1('l<') : nil
+          [msg_id, forum_topic ? flags.anybits?(1 << 1) : true]
+        rescue StandardError
+          [nil, false]
+        end
+
+        # Classify message media into :photo / :video / :audio / :document, or nil.
+        def parse_media(data, offset)
+          case data[offset, 4].unpack1('L<')
+          when MEDIA_PHOTO
+            :photo
+          when MEDIA_DOCUMENT
+            document_kind(data[offset + 4, 4].unpack1('L<'))
+          end
+        rescue StandardError
+          nil
+        end
+
+        # messageMediaDocument flags: video flags.6 / round flags.7 / voice flags.8.
+        def document_kind(flags)
+          return :video if flags.anybits?(1 << 6) || flags.anybits?(1 << 7)
+          return :audio if flags.anybits?(1 << 8)
+
+          :document
+        end
+
         def read_tl_string(data, offset)
           first_byte = data.getbyte(offset)
           if first_byte == 254

data/lib/mtproto/tl/objects/updates_state.rb

@@ -13,7 +13,7 @@ module MTProto
         @unread_count = unread_count
       end
 
-      def self.parse(data)
+      def self.deserialize(data)
         constructor = data[0, 4].unpack1('L<')
         raise UnexpectedConstructorError, constructor unless constructor == Constructors::UPDATES_STATE
 

data/lib/mtproto/tl/objects/upload_profile_photo.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module MTProto
+  module TL
+    class UploadProfilePhoto
+      include Binary
+
+      CONSTRUCTOR = 0x0388a3b5
+      INPUT_USER = 0xf21158c6
+      INPUT_USER_SELF = 0xf7c1b13f
+      INPUT_FILE = 0xf52ff27f
+
+      # bot: { id:, access_hash: } or { type: :self }; nil targets the calling bot
+      # file: { id:, parts:, name:, md5_checksum: }
+      def initialize(file:, bot: nil)
+        @bot = bot
+        @file = file
+      end
+
+      def serialize
+        flags = (1 << 0) # file
+        flags |= (1 << 5) if @bot
+
+        result = u32_b(CONSTRUCTOR)
+        result += u32_b(flags)
+        result += serialize_input_user(@bot) if @bot
+        result += serialize_input_file(@file)
+        result
+      end
+
+      private
+
+      def serialize_input_user(user)
+        if user[:type] == :self
+          u32_b(INPUT_USER_SELF)
+        else
+          u32_b(INPUT_USER) + u64_b(user[:id]) + u64_b(user[:access_hash] || 0)
+        end
+      end
+
+      def serialize_input_file(file)
+        u32_b(INPUT_FILE) +
+          u64_b(file[:id]) +
+          u32_b(file[:parts]) +
+          serialize_tl_string(file[:name].to_s) +
+          serialize_tl_string(file[:md5_checksum].to_s)
+      end
+
+      def serialize_tl_string(str)
+        bytes = str.encode('UTF-8').bytes
+        length = bytes.length
+        if length <= 253
+          [length] + bytes + padding(length + 1)
+        else
+          [254] + u32_b(length)[0, 3] + bytes + padding(length + 4)
+        end
+      end
+
+      def padding(current_length)
+        pad_length = (4 - (current_length % 4)) % 4
+        [0] * pad_length
+      end
+    end
+  end
+end

data/lib/mtproto/tl/objects/users.rb

@@ -6,7 +6,7 @@ module MTProto
       User = Struct.new(:id, :access_hash, :first_name, :last_name, :username, :phone, :flags, :flags2,
         keyword_init: true)
 
-      def self.parse(data)
+      def self.deserialize(data)
         constructor = data[0, 4].unpack1('L<')
         raise "Expected Vector constructor, got 0x#{constructor.to_s(16)}" unless constructor == Constructors::VECTOR
 

data/lib/mtproto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MTProto
-  VERSION = '0.0.13'
+  VERSION = '0.0.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtproto
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Artem Levenkov
@@ -49,8 +49,10 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".ruby-version"
+- FUTURE.md
 - Rakefile
 - data/tl-schema.json
+- docs/test_architecture_level1.md
 - ext/aes_ige/aes_ige.c
 - ext/aes_ige/extconf.rb
 - ext/factorization/extconf.rb
@@ -62,6 +64,7 @@ files:
 - lib/mtproto/client/api.rb
 - lib/mtproto/client/api/check_password.rb
 - lib/mtproto/client/api/export_login_token.rb
+- lib/mtproto/client/api/get_contacts.rb
 - lib/mtproto/client/api/get_dialogs.rb
 - lib/mtproto/client/api/get_history.rb
 - lib/mtproto/client/api/get_updates_difference.rb
@@ -69,6 +72,7 @@ files:
 - lib/mtproto/client/api/get_users.rb
 - lib/mtproto/client/api/import_login_token.rb
 - lib/mtproto/client/api/send_code.rb
+- lib/mtproto/client/api/send_message.rb
 - lib/mtproto/client/api/sign_in.rb
 - lib/mtproto/client/rpc.rb
 - lib/mtproto/client/rpc/response.rb
@@ -92,44 +96,86 @@ files:
 - lib/mtproto/tl/object.rb
 - lib/mtproto/tl/objects/account_password.rb
 - lib/mtproto/tl/objects/authorization.rb
+- lib/mtproto/tl/objects/channels_create_channel.rb
+- lib/mtproto/tl/objects/channels_delete_messages.rb
+- lib/mtproto/tl/objects/channels_delete_participant_history.rb
+- lib/mtproto/tl/objects/channels_edit_banned.rb
+- lib/mtproto/tl/objects/channels_get_messages.rb
+- lib/mtproto/tl/objects/channels_get_participant.rb
+- lib/mtproto/tl/objects/channels_join_channel.rb
+- lib/mtproto/tl/objects/channels_leave_channel.rb
+- lib/mtproto/tl/objects/channels_report_spam.rb
 - lib/mtproto/tl/objects/check_password.rb
 - lib/mtproto/tl/objects/client_dh_inner_data.rb
+- lib/mtproto/tl/objects/contacts.rb
+- lib/mtproto/tl/objects/create_bot.rb
+- lib/mtproto/tl/objects/delete_messages.rb
 - lib/mtproto/tl/objects/dh_gen_response.rb
 - lib/mtproto/tl/objects/dialogs.rb
+- lib/mtproto/tl/objects/edit_access_settings.rb
+- lib/mtproto/tl/objects/edit_message.rb
+- lib/mtproto/tl/objects/export_bot_token.rb
 - lib/mtproto/tl/objects/export_login_token.rb
+- lib/mtproto/tl/objects/exported_bot_token.rb
+- lib/mtproto/tl/objects/forward_messages.rb
+- lib/mtproto/tl/objects/get_access_settings.rb
+- lib/mtproto/tl/objects/get_channel_difference.rb
 - lib/mtproto/tl/objects/get_config.rb
+- lib/mtproto/tl/objects/get_contacts.rb
 - lib/mtproto/tl/objects/get_dialogs.rb
 - lib/mtproto/tl/objects/get_difference.rb
+- lib/mtproto/tl/objects/get_file.rb
+- lib/mtproto/tl/objects/get_full_channel.rb
+- lib/mtproto/tl/objects/get_full_user.rb
 - lib/mtproto/tl/objects/get_history.rb
+- lib/mtproto/tl/objects/get_messages_reactions.rb
 - lib/mtproto/tl/objects/get_password.rb
 - lib/mtproto/tl/objects/get_state.rb
 - lib/mtproto/tl/objects/get_users.rb
 - lib/mtproto/tl/objects/gzip_packed.rb
 - lib/mtproto/tl/objects/help_config.rb
+- lib/mtproto/tl/objects/import_bot_authorization.rb
 - lib/mtproto/tl/objects/import_login_token.rb
 - lib/mtproto/tl/objects/init_connection.rb
+- lib/mtproto/tl/objects/input_keyboard_button_request_peer.rb
+- lib/mtproto/tl/objects/invite_to_channel.rb
 - lib/mtproto/tl/objects/invoke_with_layer.rb
 - lib/mtproto/tl/objects/login_token.rb
 - lib/mtproto/tl/objects/message.rb
 - lib/mtproto/tl/objects/messages.rb
+- lib/mtproto/tl/objects/messages_get_messages.rb
 - lib/mtproto/tl/objects/msg_container.rb
 - lib/mtproto/tl/objects/new_session_created.rb
 - lib/mtproto/tl/objects/pq_inner_data.rb
+- lib/mtproto/tl/objects/raw_response.rb
+- lib/mtproto/tl/objects/reply_keyboard_markup.rb
 - lib/mtproto/tl/objects/req_dh_params.rb
 - lib/mtproto/tl/objects/req_pq_multi.rb
+- lib/mtproto/tl/objects/request_peer_type_create_bot.rb
 - lib/mtproto/tl/objects/res_pq.rb
+- lib/mtproto/tl/objects/resolve_username.rb
 - lib/mtproto/tl/objects/rpc_error.rb
+- lib/mtproto/tl/objects/save_file_part.rb
+- lib/mtproto/tl/objects/send_bot_requested_peer.rb
 - lib/mtproto/tl/objects/send_code.rb
+- lib/mtproto/tl/objects/send_media.rb
+- lib/mtproto/tl/objects/send_message.rb
+- lib/mtproto/tl/objects/send_reaction.rb
 - lib/mtproto/tl/objects/sent_code.rb
 - lib/mtproto/tl/objects/server_dh_inner_data.rb
 - lib/mtproto/tl/objects/server_dh_params.rb
+- lib/mtproto/tl/objects/set_bot_commands.rb
+- lib/mtproto/tl/objects/set_bot_info.rb
 - lib/mtproto/tl/objects/set_client_dh_params.rb
 - lib/mtproto/tl/objects/sign_in.rb
 - lib/mtproto/tl/objects/update.rb
 - lib/mtproto/tl/objects/update_short.rb
 - lib/mtproto/tl/objects/update_short_message.rb
+- lib/mtproto/tl/objects/update_short_sent_message.rb
+- lib/mtproto/tl/objects/update_username.rb
 - lib/mtproto/tl/objects/updates_difference.rb
 - lib/mtproto/tl/objects/updates_state.rb
+- lib/mtproto/tl/objects/upload_profile_photo.rb
 - lib/mtproto/tl/objects/users.rb
 - lib/mtproto/tl/schema.rb
 - lib/mtproto/transport/abridged_packet_codec.rb
@@ -151,6 +197,8 @@ metadata:
 rdoc_options: []
 require_paths:
 - lib
+- ext/aes_ige
+- ext/factorization
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="