mwbot 0.7.1

A MediaWiki bot framework
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

// SPDX-FileCopyrightText: 2023 Misato Kano <me@mirror-kt.dev>
// SPDX-License-Identifier: GPL-3.0-or-later
//! Generator to get user contributions
//!
//! See the [`UserContribs`] type documentation for specifics.
use super::{Generator, ParamValue};
use crate::{Bot, Result};
use mwapi_responses::query;
use mwtimestamp::Timestamp;

#[query(
    list = "usercontribs",
    ucprop = "ids|title|timestamp|comment|flags|tags"
)]
pub struct UserContribsResponse {}

/// List a user's contributions.
///
/// See [API documentation](https://www.mediawiki.org/wiki/API:Usercontribs) for more details.
#[derive(Generator)]
#[params(
    list = "usercontribs",
    uclimit = "max",
    ucprop = "ids|title|timestamp|comment|flags|tags"
)]
#[generator(
    return_type = "UserContribsResponseItem",
    response_type = "UserContribsResponse",
    transform_fn = "transform"
)]
pub struct UserContribs {
    #[param("ucstart")]
    start: Option<Timestamp>,
    #[param("ucend")]
    end: Option<Timestamp>,
    #[param("ucuser")]
    users: Option<Vec<String>>,
    #[param("ucuserids")]
    user_ids: Option<Vec<u64>>,
    #[param("ucuserprefix")]
    user_prefix: Option<String>,
    #[param("uciprange")]
    user_ip_range: Option<String>,
    #[param("ucdir")]
    dir: Option<Direction>,
    #[param("ucnamespace")]
    namespaces: Option<Vec<u32>>,
    #[param("ucshow")]
    filter: Option<Vec<String>>,
    #[param("uctag")]
    tags: Option<Vec<String>>,
}

fn transform(
    _bot: &Bot,
    item: UserContribsResponseItem,
) -> Result<UserContribsResponseItem> {
    Ok(item)
}

pub enum Direction {
    Newer,
    Older,
}

impl ParamValue for Direction {
    fn stringify(&self) -> String {
        match self {
            Self::Newer => "newer",
            Self::Older => "older",
        }
        .to_string()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::tests::testwp;
    use chrono::{TimeZone, Utc};

    #[tokio::test]
    async fn test_user_contrib() {
        let bot = testwp().await;
        let datetime = Utc.with_ymd_and_hms(2023, 5, 29, 3, 25, 6).unwrap();
        let gen = UserContribs::new()
            .users(vec!["Legoktm".to_string()])
            .start(datetime)
            .end(datetime);

        let mut logs = gen.generate(&bot);

        let log = logs.recv().await.unwrap().unwrap();

        assert_eq!(log.user, "Legoktm");
        assert_eq!(*log.timestamp, datetime);
        assert_eq!(log.title, "User:Legoktm/masto-collab");
        assert_eq!(log.revid, 571687);

        assert!(logs.recv().await.is_none());
    }
}