telers 1.0.0-beta.2

An asynchronous framework for Telegram Bot API written in Rust
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
use super::{Filter, FilterResult};
use crate::{types::User as UserType, Request};

use std::{borrow::Cow, convert::Infallible};

/// Filter for checking the user.
/// This filter checks if the user username, first name, last name, language code or ID is equal to one of the specified.
/// # Notes
/// This filter checks user data step by step using the logical operator `or`,
/// so if at least one check is successful, the filter will return the value `true`.
#[derive(Debug, Clone)]
pub struct User {
    /// List of usernames of the users
    usernames: Vec<Cow<'static, str>>,
    /// List of first names of the users
    first_names: Vec<Cow<'static, str>>,
    /// List of last names of the users
    last_names: Vec<Cow<'static, str>>,
    /// List of language codes of the users
    language_codes: Vec<Cow<'static, str>>,
    /// List of user IDs of the users
    ids: Vec<i64>,
}

impl User {
    /// Creates a new [`User`] filter
    /// # Arguments
    /// * `usernames` - List of usernames of the users
    /// * `first_names` - List of first names of the users
    /// * `last_names` - List of last names of the users
    /// * `language_codes` - List of language codes of the users
    /// * `ids` - List of user IDs of the users
    /// # Notes
    /// This filter checks user data step by step using the logical operator `or`,
    /// so if at least one check is successful, the filter will return the value `true`.
    pub fn new<T, I1, C, I2, S, I3, E, I4, I5>(
        usernames: I1,
        first_names: I2,
        last_names: I3,
        language_codes: I4,
        ids: I5,
    ) -> Self
    where
        T: Into<Cow<'static, str>>,
        I1: IntoIterator<Item = T>,
        C: Into<Cow<'static, str>>,
        I2: IntoIterator<Item = C>,
        S: Into<Cow<'static, str>>,
        I3: IntoIterator<Item = S>,
        E: Into<Cow<'static, str>>,
        I4: IntoIterator<Item = E>,
        I5: IntoIterator<Item = i64>,
    {
        Self {
            usernames: usernames.into_iter().map(Into::into).collect(),
            first_names: first_names.into_iter().map(Into::into).collect(),
            last_names: last_names.into_iter().map(Into::into).collect(),
            language_codes: language_codes.into_iter().map(Into::into).collect(),
            ids: ids.into_iter().collect(),
        }
    }

    /// Creates a new [`User`] filter with a single username
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn username(val: impl Into<Cow<'static, str>>) -> Self {
        Self::builder().username(val).build()
    }

    /// Creates a new [`User`] filter with a list of usernames
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn usernames<T, I>(val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self::builder().usernames(val).build()
    }

    /// Creates a new [`User`] filter with a single first name
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn first_name(val: impl Into<Cow<'static, str>>) -> Self {
        Self::builder().first_name(val).build()
    }

    /// Creates a new [`User`] filter with a list of first names
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn first_names<T, I>(val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self::builder().first_names(val).build()
    }

    /// Creates a new [`User`] filter with a single last name
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn last_name(val: impl Into<Cow<'static, str>>) -> Self {
        Self::builder().last_name(val).build()
    }

    /// Creates a new [`User`] filter with a list of last names
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn last_names<T, I>(val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self::builder().last_names(val).build()
    }

    /// Creates a new [`User`] filter with a single language code
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn language_code(val: impl Into<Cow<'static, str>>) -> Self {
        Self::builder().language_code(val).build()
    }

    /// Creates a new [`User`] filter with a list of language codes
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn language_codes<T, I>(val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self::builder().language_codes(val).build()
    }

    /// Creates a new [`User`] filter with a single user ID
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn id(val: i64) -> Self {
        Self::builder().id(val).build()
    }

    /// Creates a new [`User`] filter with a list of user IDs
    /// # Notes
    /// This method is just a shortcut to create a filter using the builder
    #[inline]
    #[must_use]
    pub fn ids(val: impl IntoIterator<Item = i64>) -> Self {
        Self::builder().ids(val).build()
    }

    #[inline]
    #[must_use]
    pub fn builder() -> Builder {
        Builder::default()
    }
}

#[derive(Debug, Default, Clone)]
pub struct Builder {
    usernames: Vec<Cow<'static, str>>,
    first_names: Vec<Cow<'static, str>>,
    last_names: Vec<Cow<'static, str>>,
    language_codes: Vec<Cow<'static, str>>,
    ids: Vec<i64>,
}

impl Builder {
    #[must_use]
    pub fn username(self, val: impl Into<Cow<'static, str>>) -> Self {
        Self {
            usernames: self.usernames.into_iter().chain(Some(val.into())).collect(),
            ..self
        }
    }

    #[must_use]
    pub fn usernames<T, I>(self, val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self {
            usernames: self
                .usernames
                .into_iter()
                .chain(val.into_iter().map(Into::into))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn first_name(self, val: impl Into<Cow<'static, str>>) -> Self {
        Self {
            first_names: self
                .first_names
                .into_iter()
                .chain(Some(val.into()))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn first_names<T, I>(self, val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self {
            first_names: self
                .first_names
                .into_iter()
                .chain(val.into_iter().map(Into::into))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn last_name(self, val: impl Into<Cow<'static, str>>) -> Self {
        Self {
            last_names: self
                .last_names
                .into_iter()
                .chain(Some(val.into()))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn last_names<T, I>(self, val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self {
            last_names: self
                .last_names
                .into_iter()
                .chain(val.into_iter().map(Into::into))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn language_code(self, val: impl Into<Cow<'static, str>>) -> Self {
        Self {
            language_codes: self
                .language_codes
                .into_iter()
                .chain(Some(val.into()))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn language_codes<T, I>(self, val: I) -> Self
    where
        T: Into<Cow<'static, str>>,
        I: IntoIterator<Item = T>,
    {
        Self {
            language_codes: self
                .language_codes
                .into_iter()
                .chain(val.into_iter().map(Into::into))
                .collect(),
            ..self
        }
    }

    #[must_use]
    pub fn id(self, val: i64) -> Self {
        Self {
            ids: self.ids.into_iter().chain(Some(val)).collect(),
            ..self
        }
    }

    #[must_use]
    pub fn ids(self, val: impl IntoIterator<Item = i64>) -> Self {
        Self {
            ids: self.ids.into_iter().chain(val).collect(),
            ..self
        }
    }

    #[inline]
    #[must_use]
    pub fn build(self) -> User {
        User::new(
            self.usernames,
            self.first_names,
            self.last_names,
            self.language_codes,
            self.ids,
        )
    }
}

impl User {
    #[must_use]
    pub fn validate_username(&self, username: &str) -> bool {
        self.usernames
            .iter()
            .any(|allowed_username| allowed_username.as_ref() == username)
    }

    #[must_use]
    pub fn validate_first_name(&self, first_name: &str) -> bool {
        self.first_names
            .iter()
            .any(|allowed_first_name| allowed_first_name.as_ref() == first_name)
    }

    #[must_use]
    pub fn validate_last_name(&self, last_name: &str) -> bool {
        self.last_names
            .iter()
            .any(|allowed_last_name| allowed_last_name.as_ref() == last_name)
    }

    #[must_use]
    pub fn validate_language_code(&self, language_code: &str) -> bool {
        self.language_codes
            .iter()
            .any(|allowed_language_code| allowed_language_code.as_ref() == language_code)
    }

    #[must_use]
    pub fn validate_id(&self, id: i64) -> bool {
        self.ids.contains(&id)
    }

    #[must_use]
    pub fn validate(&self, user: &UserType) -> bool {
        user.username
            .as_deref()
            .is_some_and(|username| self.validate_username(username))
            || self.validate_id(user.id)
            || self.validate_first_name(&user.first_name)
            || user
                .last_name
                .as_deref()
                .is_some_and(|last_name| self.validate_last_name(last_name))
            || user
                .language_code
                .as_deref()
                .is_some_and(|language_code| self.validate_language_code(language_code))
    }
}

impl<Client> Filter<Client> for User
where
    Client: Send + Sync + 'static,
{
    type Error = Infallible;

    async fn check(&mut self, request: &mut Request<Client>) -> FilterResult<Self::Error> {
        Ok(match request.update.from() {
            Some(user) => self.validate(user),
            None => false,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_validate_username() {
        let user = User::username("test");

        assert!(user.validate_username("test"));
        assert!(!user.validate_username("test2"));

        let user = User::usernames(["test", "test2"]);

        assert!(user.validate_username("test"));
        assert!(user.validate_username("test2"));
    }

    #[test]
    fn test_validate_first_name() {
        let user = User::first_name("test");

        assert!(user.validate_first_name("test"));
        assert!(!user.validate_first_name("test2"));

        let user = User::first_names(["test", "test2"]);

        assert!(user.validate_first_name("test"));
        assert!(user.validate_first_name("test2"));
    }

    #[test]
    fn test_validate_last_name() {
        let user = User::last_name("test");

        assert!(user.validate_last_name("test"));
        assert!(!user.validate_last_name("test2"));

        let user = User::last_names(["test", "test2"]);

        assert!(user.validate_last_name("test"));
        assert!(user.validate_last_name("test2"));
    }

    #[test]
    fn test_validate_language_code() {
        let user = User::language_code("test");

        assert!(user.validate_language_code("test"));
        assert!(!user.validate_language_code("test2"));

        let user = User::language_codes(["test", "test2"]);

        assert!(user.validate_language_code("test"));
        assert!(user.validate_language_code("test2"));
    }

    #[test]
    fn test_validate_id() {
        let user = User::id(1);

        assert!(user.validate_id(1));
        assert!(!user.validate_id(2));

        let user = User::ids([1, 2]);

        assert!(user.validate_id(1));
        assert!(user.validate_id(2));
    }
}