provident 0.2.1

Unofficial client for the Provident (MeterConnex) utility metering portal: meters, usage history, and reports
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

// SPDX-License-Identifier: GPL-3.0-only

use std::fmt;

use serde::Serialize;

/// Body sent by the site's `login.js`: `{"username", "password", "rememberMe"}`.
#[derive(Clone, PartialEq, Eq, Serialize, bon::Builder)]
#[serde(rename_all = "camelCase")]
pub struct ProcessLoginRequest {
    /// Login name.
    #[builder(into)]
    pub username: String,
    /// Account password; redacted from `Debug` output.
    #[builder(into)]
    pub password: String,
    /// Persistent auth cookie ("Remember me" checkbox).
    #[builder(default)]
    pub remember_me: bool,
}

/// Redacts `password`.
impl fmt::Debug for ProcessLoginRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ProcessLoginRequest")
            .field("username", &self.username)
            .field("password", &"<redacted>")
            .field("remember_me", &self.remember_me)
            .finish()
    }
}

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

    #[test]
    fn serializes_csharp_parameter_names() {
        let req = ProcessLoginRequest::builder()
            .username("u")
            .password("p")
            .build();
        assert_eq!(
            serde_json::to_value(&req).unwrap(),
            serde_json::json!({"username": "u", "password": "p", "rememberMe": false})
        );
    }

    #[test]
    fn debug_redacts_password() {
        let req = ProcessLoginRequest::builder()
            .username("u")
            .password("hunter2")
            .build();
        assert!(!format!("{req:?}").contains("hunter2"));
    }
}