vaegram 0.3.0

Telegram MTProto client library for users and bots
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
mod add_quick_reply_message;
mod check_quick_reply_shortcut;
mod create_business_chat_link;
mod delete_business_away_message;
mod delete_business_chat_link;
mod delete_business_greeting_message;
mod delete_business_intro;
mod delete_business_location;
mod delete_business_messages;
mod delete_business_opening_hours;
mod delete_business_story;
mod delete_quick_reply_messages;
mod delete_quick_reply_shortcut;
mod disable_peer_connected_bot;
mod edit_business_chat_link;
mod edit_business_story;
mod edit_quick_reply_message;
mod edit_quick_reply_shortcut;
mod get_business_account_star_balance;
mod get_business_chat_links;
mod get_business_connection;
mod get_connected_bots;
mod get_quick_replies;
mod get_quick_reply_messages;
mod post_business_story;
mod read_business_message;
mod remove_business_account_profile_photo;
mod remove_connected_bot;
mod reorder_quick_replies;
mod repost_business_story;
mod resolve_business_chat_link;
mod send_quick_reply_messages;
mod set_business_account_bio;
mod set_business_account_gift_settings;
mod set_business_account_name;
mod set_business_account_profile_photo;
mod set_business_account_username;
mod set_business_away_message;
mod set_business_greeting_message;
mod set_business_intro;
mod set_business_location;
mod set_business_opening_hours;
mod toggle_connected_bot_paused;
mod transfer_business_account_stars;
mod update_connected_bot;

pub use add_quick_reply_message::AddQuickReplyMessage;
pub use create_business_chat_link::CreateBusinessChatLink;
pub use edit_business_chat_link::EditBusinessChatLink;
pub use edit_business_story::EditBusinessStory;
pub use edit_quick_reply_message::EditQuickReplyMessage;
pub use get_quick_reply_messages::GetQuickReplyMessages;
pub use post_business_story::PostBusinessStory;
pub use repost_business_story::RepostBusinessStory;
pub use set_business_account_gift_settings::SetBusinessAccountGiftSettings;
pub use set_business_away_message::SetBusinessAwayMessage;
pub use set_business_location::SetBusinessLocation;

#[cfg(test)]
mod tests {
    use std::future::IntoFuture;

    use tokio::sync::mpsc::UnboundedReceiver;

    use crate::Client;
    use crate::errors::Error;
    use crate::raw::functions::{account, messages};
    use crate::raw::{Serializable, base, functions, types};
    use crate::types::{
        AcceptedGiftTypes, BusinessBotRights, BusinessOpeningHours, BusinessRecipients, InputStoryContent, QuickReply,
        Text, Upload,
    };

    async fn sent<F: IntoFuture>(rx: &mut UnboundedReceiver<Vec<u8>>, call: F) -> Vec<u8> {
        let _ = call.await;
        rx.try_recv().expect("no request sent")
    }

    #[tokio::test]
    async fn settings_requests() {
        let (client, mut rx) = Client::recording();
        let rx = &mut rx;

        let hours = BusinessOpeningHours::new("Europe/Berlin", [(540, 1020)]);
        let open = types::BusinessWeeklyOpen { start_minute: 540, end_minute: 1020 };
        let open = base::BusinessWeeklyOpen::BusinessWeeklyOpen(open);
        let work_hours =
            types::BusinessWorkHours { open_now: false, timezone_id: "Europe/Berlin".into(), weekly_open: vec![open] };
        let business_work_hours = Some(base::BusinessWorkHours::BusinessWorkHours(Box::new(work_hours)));
        let body = sent(rx, client.set_business_opening_hours(&hours)).await;
        assert_eq!(body, account::UpdateBusinessWorkHours { business_work_hours }.to_bytes());
        let body = sent(rx, client.delete_business_opening_hours()).await;
        assert_eq!(body, account::UpdateBusinessWorkHours { business_work_hours: None }.to_bytes());

        let body = sent(rx, client.set_business_location("Main St 1")).await;
        let address = Some("Main St 1".into());
        assert_eq!(body, account::UpdateBusinessLocation { geo_point: None, address }.to_bytes());
        let body = sent(rx, client.set_business_location("Main St 1").location(52.5, 13.4)).await;
        let point = types::InputGeoPoint { lat: 52.5, long: 13.4, accuracy_radius: None };
        let geo_point = Some(base::InputGeoPoint::InputGeoPoint(Box::new(point)));
        let address = Some("Main St 1".into());
        assert_eq!(body, account::UpdateBusinessLocation { geo_point, address }.to_bytes());
        let body = sent(rx, client.delete_business_intro()).await;
        assert_eq!(body, account::UpdateBusinessIntro { intro: None }.to_bytes());
        let body = sent(rx, client.reorder_quick_replies([2, 1])).await;
        assert_eq!(body, messages::ReorderQuickReplies { order: vec![2, 1] }.to_bytes());
    }

    #[tokio::test]
    async fn quick_replies_are_parsed() {
        let reply = types::QuickReply { shortcut_id: 4, shortcut: "hello".into(), top_message: 9, count: 2 };
        let replies = types::messages::QuickReplies {
            quick_replies: vec![base::QuickReply::QuickReply(Box::new(reply))],
            messages: Vec::new(),
            chats: Vec::new(),
            users: Vec::new(),
        };
        let answer = base::messages::QuickReplies::QuickReplies(Box::new(replies)).to_bytes();
        let (client, _rx) = Client::scripted(vec![Ok(answer)]);
        let expected = QuickReply { shortcut_id: 4, shortcut: "hello".into(), top_message: 9, count: 2 };
        assert_eq!(client.get_quick_replies().await.unwrap(), [expected]);
    }

    fn refused<T>(result: Result<T, Error>) -> bool {
        matches!(result, Err(Error::InvalidArgument(_)))
    }

    fn recording_client() -> (Client, UnboundedReceiver<Vec<u8>>) {
        let (client, rx) = Client::recording();
        let user = types::InputPeerUser { user_id: 42, access_hash: 7 };
        client.0.peers.lock().unwrap().insert(42, base::InputPeer::InputPeerUser(Box::new(user)));
        (client, rx)
    }

    fn everyone() -> BusinessRecipients {
        BusinessRecipients::new().existing_chats(true)
    }

    #[tokio::test]
    async fn a_location_needs_a_short_address_and_real_coordinates() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.set_business_location("").await));
        assert!(refused(client.set_business_location("x".repeat(97)).await));
        assert!(refused(client.set_business_location("Main St 1").location(91.0, 0.0).await));
        assert!(refused(client.set_business_location("Main St 1").location(0.0, f64::NAN).await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn a_greeting_waits_a_whole_number_of_weeks() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.set_business_greeting_message(1, &everyone(), 10).await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn greetings_and_away_messages_take_no_excluded_users() {
        let (client, mut rx) = recording_client();
        let excluding = everyone().exclude_users([42]);
        assert!(refused(client.set_business_greeting_message(1, &excluding, 7).await));
        assert!(refused(client.set_business_away_message(1, &excluding).await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn a_connected_bot_needs_a_recipient() {
        let (client, mut rx) = recording_client();
        let nobody = BusinessRecipients::default();
        assert!(refused(client.update_connected_bot(42, BusinessBotRights::default(), &nobody).await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn every_private_chat_but_some_is_a_selection() {
        let (client, mut rx) = recording_client();
        let user = types::InputPeerUser { user_id: 7, access_hash: 1 };
        client.0.peers.lock().unwrap().insert(7, base::InputPeer::InputPeerUser(Box::new(user)));
        let rights = BusinessBotRights::new().can_reply(true);
        let all_but_7 = BusinessRecipients::new().exclude_selected(true).exclude_users([7]);
        let body = sent(&mut rx, client.update_connected_bot(42, rights, &all_but_7)).await;
        let input_user =
            |user_id, access_hash| base::InputUser::InputUser(Box::new(types::InputUser { user_id, access_hash }));
        let recipients = types::InputBusinessBotRecipients {
            existing_chats: false,
            new_chats: false,
            contacts: false,
            non_contacts: false,
            exclude_selected: true,
            users: None,
            exclude_users: Some(vec![input_user(7, 1)]),
        };
        let expected = account::UpdateConnectedBot {
            deleted: false,
            rights: Some(rights.write()),
            bot: input_user(42, 7),
            recipients: base::InputBusinessBotRecipients::InputBusinessBotRecipients(Box::new(recipients)),
        };
        assert_eq!(body, expected.to_bytes());
    }

    #[tokio::test]
    async fn business_stories_fetch_the_connection_once() {
        let connection = types::BotBusinessConnection {
            disabled: false,
            connection_id: "c".into(),
            user_id: 42,
            dc_id: 2,
            date: 1,
            rights: None,
        };
        let connection = base::BotBusinessConnection::BotBusinessConnection(Box::new(connection));
        let update =
            base::Update::UpdateBotBusinessConnect(Box::new(types::UpdateBotBusinessConnect { connection, qts: 0 }));
        let connected = base::Updates::UpdateShort(Box::new(types::UpdateShort { update, date: 0 })).to_bytes();
        let replies = vec![Ok(connected), Ok(vec![1_i32].to_bytes()), Ok(vec![2_i32].to_bytes())];
        let (client, mut rx) = Client::scripted(replies);
        let user = types::InputPeerUser { user_id: 42, access_hash: 7 };
        client.0.peers.lock().unwrap().insert(42, base::InputPeer::InputPeerUser(Box::new(user)));
        client.delete_business_story("c", 1).await.unwrap();
        client.delete_business_story("c", 2).await.unwrap();
        let fetch = account::GetBotBusinessConnection { connection_id: "c".into() }.to_bytes();
        let bodies: Vec<_> = std::iter::from_fn(|| rx.try_recv().ok()).collect();
        assert_eq!(bodies.iter().filter(|body| **body == fetch).count(), 1);
        assert_eq!(bodies.len(), 3);
    }

    #[tokio::test]
    async fn deleting_no_quick_reply_messages_is_refused() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.delete_quick_reply_messages(1, &[]).await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn reordering_no_quick_replies_is_refused() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.reorder_quick_replies([]).await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn a_quick_reply_shortcut_needs_a_name() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.edit_quick_reply_shortcut(1, "").await));
        assert!(refused(client.check_quick_reply_shortcut("").await));
        assert!(refused(client.add_quick_reply_message("", "hi").await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn reading_no_quick_reply_messages_is_refused() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.get_quick_reply_messages(4).message_ids([]).await));
        assert!(rx.try_recv().is_err());
    }

    fn quick_reply_raw(id: i32, text: &str) -> base::Message {
        let mut message = crate::types::Message::bare(id, crate::utils::get_peer(42), 1);
        (message.out, message.message, message.quick_reply_shortcut_id) = (true, text.into(), Some(4));
        base::Message::Message(Box::new(message))
    }

    fn quick_reply_answer(updates: Vec<base::Update>) -> Vec<u8> {
        let updates = types::Updates { updates, users: Vec::new(), chats: Vec::new(), date: 1, seq: 0 };
        base::Updates::Updates(Box::new(updates)).to_bytes()
    }

    #[tokio::test]
    async fn quick_reply_messages_are_read() {
        let found = types::messages::Messages {
            messages: vec![quick_reply_raw(9, "hi"), quick_reply_raw(10, "bye")],
            topics: Vec::new(),
            chats: Vec::new(),
            users: Vec::new(),
        };
        let answer = base::messages::Messages::Messages(Box::new(found)).to_bytes();
        let (client, mut rx) = Client::scripted(vec![Ok(answer.clone()), Ok(answer)]);

        let all = client.get_quick_reply_messages(4).await.unwrap();
        let request = messages::GetQuickReplyMessages { shortcut_id: 4, id: None, hash: 0 };
        assert_eq!(rx.try_recv().unwrap(), request.to_bytes());
        let read = |m: &crate::types::Message| (m.id, m.text().to_owned(), m.quick_reply_shortcut_id());
        let expected = [(9, "hi".to_owned(), Some(4)), (10, "bye".to_owned(), Some(4))];
        assert_eq!(all.iter().map(read).collect::<Vec<_>>(), expected);

        let _ = client.get_quick_reply_messages(4).message_ids([9, 10]).await.unwrap();
        let request = messages::GetQuickReplyMessages { shortcut_id: 4, id: Some(vec![9, 10]), hash: 0 };
        assert_eq!(rx.try_recv().unwrap(), request.to_bytes());
    }

    #[tokio::test]
    async fn adding_a_quick_reply_message_sends_it_to_the_shortcut_name() {
        let reply = types::QuickReply { shortcut_id: 4, shortcut: "hello".into(), top_message: 9, count: 1 };
        let created = types::UpdateNewQuickReply { quick_reply: base::QuickReply::QuickReply(Box::new(reply)) };
        let added = types::UpdateQuickReplyMessage { message: quick_reply_raw(9, "hi") };
        let answer = quick_reply_answer(vec![
            base::Update::UpdateNewQuickReply(Box::new(created)),
            base::Update::UpdateQuickReplyMessage(Box::new(added)),
        ]);
        let (client, mut rx) = Client::scripted(vec![Ok(answer)]);
        let message = client.add_quick_reply_message("hello", "<b>hi</b>").html().await.unwrap();
        assert_eq!((message.id, message.text(), message.quick_reply_shortcut_id()), (9, "hi", Some(4)));

        let bold = base::MessageEntity::MessageEntityBold(types::MessageEntityBold { offset: 0, length: 2 });
        let shortcut = Box::new(types::InputQuickReplyShortcut { shortcut: "hello".into() });
        let request = messages::SendMessage {
            no_webpage: false,
            silent: false,
            background: false,
            clear_draft: false,
            noforwards: false,
            update_stickersets_order: false,
            invert_media: false,
            allow_paid_floodskip: false,
            peer: base::InputPeer::InputPeerSelf,
            reply_to: None,
            message: "hi".into(),
            random_id: 0,
            reply_markup: None,
            entities: Some(vec![bold]),
            schedule_date: None,
            schedule_repeat_period: None,
            send_as: None,
            quick_reply_shortcut: Some(base::InputQuickReplyShortcut::InputQuickReplyShortcut(shortcut)),
            effect: None,
            allow_paid_stars: None,
            suggested_post: None,
            rich_message: None,
        }
        .to_bytes();
        let mut body = rx.try_recv().unwrap();
        // random_id is random: it follows the constructor, the flags, inputPeerSelf and the text.
        let at = 12 + String::from("hi").to_bytes().len();
        body[at..at + 8].fill(0);
        assert_eq!(body, request);
    }

    #[tokio::test]
    async fn editing_a_quick_reply_message_names_its_shortcut() {
        let edited = types::UpdateQuickReplyMessage { message: quick_reply_raw(9, "hey") };
        let answer = quick_reply_answer(vec![base::Update::UpdateQuickReplyMessage(Box::new(edited))]);
        let (client, mut rx) = Client::scripted(vec![Ok(answer)]);
        let message = client.edit_quick_reply_message(4, 9, "hey").await.unwrap();
        assert_eq!((message.id, message.text(), message.quick_reply_shortcut_id()), (9, "hey", Some(4)));

        let request = messages::EditMessage {
            no_webpage: false,
            invert_media: false,
            peer: base::InputPeer::InputPeerSelf,
            id: 9,
            message: Some("hey".into()),
            media: None,
            reply_markup: None,
            entities: None,
            schedule_date: None,
            schedule_repeat_period: None,
            quick_reply_shortcut_id: Some(4),
            rich_message: None,
        };
        assert_eq!(rx.try_recv().unwrap(), request.to_bytes());
    }

    #[tokio::test]
    async fn a_quick_reply_answer_without_the_message_fails() {
        let (client, _rx) = Client::scripted(vec![Ok(quick_reply_answer(Vec::new()))]);
        assert!(matches!(client.edit_quick_reply_message(4, 9, "hey").await, Err(Error::Unexpected(_))));
    }

    #[tokio::test]
    async fn a_chat_link_call_needs_its_slug() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.delete_business_chat_link("").await));
        assert!(refused(client.resolve_business_chat_link("").await));
        assert!(refused(client.edit_business_chat_link("", "hi").await));
        assert!(rx.try_recv().is_err());
    }

    fn privacy(display_gifts_button: bool, accepted: Option<AcceptedGiftTypes>) -> base::GlobalPrivacySettings {
        base::GlobalPrivacySettings::GlobalPrivacySettings(Box::new(types::GlobalPrivacySettings {
            archive_and_mute_new_noncontact_peers: false,
            keep_archived_unmuted: false,
            keep_archived_folders: false,
            hide_read_marks: true,
            new_noncontact_peers_require_premium: false,
            display_gifts_button,
            noncontact_peers_paid_stars: Some(25),
            disallowed_gifts: accepted.map(AcceptedGiftTypes::write),
        }))
    }

    #[tokio::test]
    async fn gift_settings_change_only_what_is_set() {
        let current = privacy(true, None);
        let no_unique = AcceptedGiftTypes::new().unique_gifts(false);
        let cases = [
            (Some(false), None, privacy(false, None)),
            (None, Some(no_unique), privacy(true, Some(no_unique))),
            (Some(false), Some(no_unique), privacy(false, Some(no_unique))),
        ];
        for (show_gift_button, accepted, settings) in cases {
            let (client, mut rx) = Client::scripted(vec![Ok(current.to_bytes())]);
            client.0.caches.know_business("c", 7, 2);
            let mut request = client.set_business_account_gift_settings("c");
            if let Some(show) = show_gift_button {
                request = request.show_gift_button(show);
            }
            if let Some(accepted) = accepted {
                request = request.accepted_gift_types(accepted);
            }
            let _ = request.await;
            let get = account::GetGlobalPrivacySettings {};
            let get = functions::InvokeWithBusinessConnection { connection_id: "c".into(), query: get };
            assert_eq!(rx.try_recv().unwrap(), get.to_bytes());
            let set = account::SetGlobalPrivacySettings { settings };
            let set = functions::InvokeWithBusinessConnection { connection_id: "c".into(), query: set };
            assert_eq!(rx.try_recv().unwrap(), set.to_bytes());
        }
    }

    #[tokio::test]
    async fn gift_settings_with_nothing_to_change_are_refused() {
        let (client, mut rx) = recording_client();
        assert!(refused(client.set_business_account_gift_settings("c").await));
        assert!(rx.try_recv().is_err());
    }

    #[tokio::test]
    async fn a_built_story_caption_keeps_its_entities() {
        let connection = types::BotBusinessConnection {
            disabled: false,
            connection_id: "c".into(),
            user_id: 42,
            dc_id: 2,
            date: 1,
            rights: None,
        };
        let connection = base::BotBusinessConnection::BotBusinessConnection(Box::new(connection));
        let update = types::UpdateBotBusinessConnect { connection, qts: 0 };
        let update = base::Update::UpdateBotBusinessConnect(Box::new(update));
        let connected = base::Updates::UpdateShort(Box::new(types::UpdateShort { update, date: 0 })).to_bytes();
        let bold = vec![base::MessageEntity::MessageEntityBold(types::MessageEntityBold { offset: 0, length: 2 })];
        let mut caption = String::from("hi").to_bytes();
        caption.extend(bold.to_bytes());
        for edit in [true, false] {
            let (client, mut rx) = Client::scripted(vec![Ok(connected.clone()), Ok(true.to_bytes())]);
            let user = types::InputPeerUser { user_id: 42, access_hash: 7 };
            client.0.peers.lock().unwrap().insert(42, base::InputPeer::InputPeerUser(Box::new(user)));
            let photo = InputStoryContent::photo(Upload::bytes("a.jpg", b"x"));
            let text = Text::new().bold("hi");
            let _ = if edit {
                client.edit_business_story("c", 1, photo).caption(text).await
            } else {
                client.post_business_story("c", photo, 86400).caption(text).await
            };
            let bodies: Vec<_> = std::iter::from_fn(|| rx.try_recv().ok()).collect();
            assert!(bodies.iter().any(|body| body.windows(caption.len()).any(|w| w == caption)), "edit: {edit}");
        }
    }
}