whmcs 0.1.1

Rust client for the WHMCS API
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

use serde::{Deserialize, Serialize};

use crate::models::{deserialize_whmcs_bool, users::UserId};

#[derive(Debug, Serialize, Default)]
/// Parameters for validating a login on [`validate_login`](crate::WhmcsClient::validate_login).
pub struct ValidateLoginParams {
    /// User Email Address
    pub email: String,
    /// Password to validate
    #[serde(rename = "password2")]
    pub password: String,
}

impl ValidateLoginParams {
    /// User Email Address
    #[must_use]
    pub fn email(mut self, email: impl Into<String>) -> Self {
        self.email = email.into();
        self
    }

    /// Password to validate
    #[must_use]
    pub fn password(mut self, password: impl Into<String>) -> Self {
        self.password = password.into();
        self
    }
}

#[derive(Debug, Deserialize)]
#[non_exhaustive]
/// Response from [`validate_login`](crate::WhmcsClient::validate_login).
pub struct ValidateLoginResponse {
    /// User ID
    #[serde(rename = "userid")]
    pub user_id: UserId,
    /// Login session token - returned if Two-Factor Authentication is not required for the account
    #[serde(rename = "passwordhash")]
    pub session_token: Option<String>,
    /// True if Two-Factor Authentication is enabled for the given account
    #[serde(
        rename = "twoFactorEnabled",
        deserialize_with = "deserialize_whmcs_bool"
    )]
    pub two_factor_enabled: bool,
}

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

    #[test]
    fn validate_login_params_serializes_password2() {
        let p = ValidateLoginParams::default()
            .email("u@example.com")
            .password("secret");
        let v = serde_json::to_value(&p).unwrap();
        assert_eq!(v["email"], "u@example.com");
        assert_eq!(v["password2"], "secret");
    }

    #[test]
    fn validate_login_response_deserializes() {
        let json = r#"{
            "userid": 99,
            "passwordhash": "abc",
            "twoFactorEnabled": false
        }"#;
        let r: ValidateLoginResponse = serde_json::from_str(json).unwrap();
        assert_eq!(r.user_id, UserId::new(99));
        assert_eq!(r.session_token.as_deref(), Some("abc"));
        assert!(!r.two_factor_enabled);
    }
}