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

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

pub(crate) type NoType = super::NoTitlesOrGenerator;

/// Internal data container for `action=checktoken` parameters.
#[derive(Debug, Clone, Default)]
pub struct ActionApiChecktokenData {
    token_type: Option<String>,
    token: Option<String>,
    maxtokenage: Option<u64>,
}

impl ActionApiData for ActionApiChecktokenData {}

impl ActionApiChecktokenData {
    pub(crate) fn params(&self) -> HashMap<String, String> {
        let mut params = HashMap::new();
        params.insert("action".to_string(), "checktoken".to_string());
        if let Some(t) = &self.token_type {
            params.insert("type".to_string(), t.clone());
        }
        Self::add_str(&self.token, "token", &mut params);
        if let Some(age) = self.maxtokenage {
            params.insert("maxtokenage".to_string(), age.to_string());
        }
        params
    }
}

/// Builder for `action=checktoken`. Call `.token_type()` to set the required token type, making it runnable.
#[derive(Debug, Clone)]
pub struct ActionApiChecktokenBuilder<T> {
    _phantom: PhantomData<T>,
    pub(crate) data: ActionApiChecktokenData,
}

impl<T> ActionApiChecktokenBuilder<T> {
    /// The token to check (`token`).
    pub fn token<S: AsRef<str>>(mut self, token: S) -> Self {
        self.data.token = Some(token.as_ref().to_string());
        self
    }

    /// Maximum acceptable token age in seconds (`maxtokenage`).
    pub fn maxtokenage(mut self, maxtokenage: u64) -> Self {
        self.data.maxtokenage = Some(maxtokenage);
        self
    }
}

impl ActionApiChecktokenBuilder<NoType> {
    /// Creates a new builder with default values.
    pub fn new() -> Self {
        Self {
            _phantom: PhantomData,
            data: ActionApiChecktokenData::default(),
        }
    }

    /// Type of token being validated, e.g. `"csrf"` (`type`).
    pub fn token_type<S: AsRef<str>>(
        mut self,
        token_type: S,
    ) -> ActionApiChecktokenBuilder<Runnable> {
        self.data.token_type = Some(token_type.as_ref().to_string());
        ActionApiChecktokenBuilder {
            _phantom: PhantomData,
            data: self.data,
        }
    }
}

impl ActionApiRunnable for ActionApiChecktokenBuilder<Runnable> {
    fn params(&self) -> HashMap<String, String> {
        self.data.params()
    }
}

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

    fn new_builder() -> ActionApiChecktokenBuilder<NoType> {
        ActionApiChecktokenBuilder::new()
    }

    #[test]
    fn token_type_set() {
        let params = new_builder().token_type("csrf").data.params();
        assert_eq!(params["type"], "csrf");
    }

    #[test]
    fn token_set() {
        let params = new_builder()
            .token("abc+\\")
            .token_type("csrf")
            .data
            .params();
        assert_eq!(params["token"], "abc+\\");
    }

    #[test]
    fn maxtokenage_set() {
        let params = new_builder()
            .maxtokenage(3600)
            .token_type("csrf")
            .data
            .params();
        assert_eq!(params["maxtokenage"], "3600");
    }

    #[test]
    fn default_maxtokenage_absent() {
        let params = new_builder().token_type("csrf").data.params();
        assert!(!params.contains_key("maxtokenage"));
    }

    #[test]
    fn action_is_checktoken() {
        let params = new_builder().token_type("csrf").data.params();
        assert_eq!(params["action"], "checktoken");
    }
}