mediawiki 0.5.1

A MediaWiki client library
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

use super::{ActionApiData, ActionApiRunnable};
use std::collections::HashMap;

/// Internal data container for `meta=siteinfo` parameters.
#[derive(Debug, Clone, Default)]
pub struct ActionApiMetaSiteinfoData {
    siprop: Option<Vec<String>>,
    sifilteriw: Option<String>,
    sishowalldb: bool,
    sinumberingroup: bool,
    siinlanguagecode: Option<String>,
}

impl ActionApiData for ActionApiMetaSiteinfoData {}

impl ActionApiMetaSiteinfoData {
    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        Self::add_vec(&self.siprop, "siprop", &mut params);
        Self::add_str(&self.sifilteriw, "sifilteriw", &mut params);
        Self::add_boolean(self.sishowalldb, "sishowalldb", &mut params);
        Self::add_boolean(self.sinumberingroup, "sinumberingroup", &mut params);
        Self::add_str(&self.siinlanguagecode, "siinlanguagecode", &mut params);
        params
    }
}

/// Builder for `meta=siteinfo` — returns general site information.
#[derive(Debug, Clone)]
pub struct ActionApiMetaSiteinfoBuilder {
    pub(crate) data: ActionApiMetaSiteinfoData,
}

impl ActionApiMetaSiteinfoBuilder {
    pub(crate) fn new() -> Self {
        Self {
            data: ActionApiMetaSiteinfoData::default(),
        }
    }

    /// Which information to get (`siprop`).
    pub fn siprop<S: Into<String> + Clone>(mut self, siprop: &[S]) -> Self {
        self.data.siprop = Some(siprop.iter().map(|s| s.clone().into()).collect());
        self
    }

    /// Filter interwiki prefixes (`sifilteriw`).
    pub fn sifilteriw<S: AsRef<str>>(mut self, sifilteriw: S) -> Self {
        self.data.sifilteriw = Some(sifilteriw.as_ref().to_string());
        self
    }

    /// Show all databases in the server lag list (`sishowalldb`).
    pub fn sishowalldb(mut self, sishowalldb: bool) -> Self {
        self.data.sishowalldb = sishowalldb;
        self
    }

    /// List the number of users in user groups (`sinumberingroup`).
    pub fn sinumberingroup(mut self, sinumberingroup: bool) -> Self {
        self.data.sinumberingroup = sinumberingroup;
        self
    }

    /// Return localised language names in this language (`siinlanguagecode`).
    pub fn siinlanguagecode<S: AsRef<str>>(mut self, siinlanguagecode: S) -> Self {
        self.data.siinlanguagecode = Some(siinlanguagecode.as_ref().to_string());
        self
    }
}

impl ActionApiRunnable for ActionApiMetaSiteinfoBuilder {
    fn params(&self) -> HashMap<String, String> {
        let mut ret = self.data.params();
        ret.insert("action".to_string(), "query".to_string());
        ret.insert("meta".to_string(), "siteinfo".to_string());
        ret
    }
}

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

    fn new_builder() -> ActionApiMetaSiteinfoBuilder {
        ActionApiMetaSiteinfoBuilder::new()
    }

    #[test]
    fn default_siprop_absent() {
        let params = new_builder().data.params();
        assert!(!params.contains_key("siprop"));
    }

    #[test]
    fn siprop_set() {
        let params = new_builder().siprop(&["general", "namespaces"]).data.params();
        assert_eq!(params["siprop"], "general|namespaces");
    }

    #[test]
    fn sifilteriw_set() {
        let params = new_builder().sifilteriw("local").data.params();
        assert_eq!(params["sifilteriw"], "local");
    }

    #[test]
    fn sishowalldb_flag() {
        let params = new_builder().sishowalldb(true).data.params();
        assert_eq!(params["sishowalldb"], "");
    }

    #[test]
    fn sinumberingroup_flag() {
        let params = new_builder().sinumberingroup(true).data.params();
        assert_eq!(params["sinumberingroup"], "");
    }

    #[test]
    fn siinlanguagecode_set() {
        let params = new_builder().siinlanguagecode("de").data.params();
        assert_eq!(params["siinlanguagecode"], "de");
    }

    #[test]
    fn runnable_params_contain_action_meta() {
        let params = ActionApiRunnable::params(&new_builder());
        assert_eq!(params["action"], "query");
        assert_eq!(params["meta"], "siteinfo");
    }
}