provident 0.3.0

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

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

use serde::Deserialize;

/// Outcome of a rates login attempt; the site answers `{"response": "ok"|"no", ...}`.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub struct RatesLoginResponse {
    /// `"ok"` when the location id was accepted.
    pub response: String,
    /// User-facing message; `"Invalid login."` on failure, empty on success.
    #[serde(default)]
    pub message: String,
}

impl RatesLoginResponse {
    /// `true` when the rates site accepted the credentials.
    pub fn accepted(&self) -> bool {
        self.response == "ok"
    }
}
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn decodes_observed_payloads() {
        let ok: RatesLoginResponse =
            serde_json::from_str(r#"{"response":"ok","message":"","error":0}"#).unwrap();
        assert!(ok.accepted());
        let no: RatesLoginResponse =
            serde_json::from_str(r#"{"response":"no","message":"Invalid login.","error":0}"#)
                .unwrap();
        assert!(!no.accepted());
        assert_eq!(no.message, "Invalid login.");
    }
}