provident 0.3.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

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

use serde::{Deserialize, Serialize};

use crate::models::aspnet::JsonString;

/// `d` is the result serialized into a JSON string: `"{ \"success\": false, \"msg\": \"…\" }"`.
pub type ProcessLoginResponse = JsonString<ProcessLoginResult>;

/// Outcome of a login attempt.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ProcessLoginResult {
    /// `true` when the credentials were accepted.
    pub success: bool,
    /// User-facing reason on failure (e.g. `"Invalid Username or Password"`). Only observed on
    /// failure, so treated as optional.
    #[serde(default)]
    pub msg: Option<String>,
}

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

    #[test]
    fn decodes_observed_failure_payload() {
        // Observed `d` for unknown credentials (note the inner JSON is a string).
        let res: ProcessLoginResponse = serde_json::from_str(
            r#""{ \"success\": false, \"msg\": \"Invalid Username or Password\"  }""#,
        )
        .unwrap();
        assert_eq!(
            res.into_inner(),
            ProcessLoginResult {
                success: false,
                msg: Some("Invalid Username or Password".into()),
            }
        );
    }

    #[test]
    fn msg_is_optional() {
        let res: ProcessLoginResponse = serde_json::from_str(r#""{\"success\": true}""#).unwrap();
        assert!(res.success && res.msg.is_none());
    }
}