ring-client 0.1.3

A Rust client for interfacing with Ring home security devices.
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

use std::fmt::{Display, Formatter};

/// The Operating System to identify as when beginning a session.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[allow(missing_docs)]
pub enum OperatingSystem {
    Android,
    Ios,
}

impl OperatingSystem {
    #[must_use]
    pub(crate) const fn get_client_id(self) -> &'static str {
        match self {
            Self::Android => "ring_official_android",
            Self::Ios => "ring_official_ios",
        }
    }

    #[must_use]
    pub(crate) const fn get_user_agent(self) -> &'static str {
        match self {
            Self::Android => "android:com.ringapp",
            Self::Ios => "ios:com.ringapp",
        }
    }
}

impl Display for OperatingSystem {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Android => f.write_str("android"),
            Self::Ios => f.write_str("ios"),
        }
    }
}

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

    #[test]
    fn test_android() {
        assert_eq!(
            OperatingSystem::Android.get_client_id(),
            "ring_official_android"
        );
        assert_eq!(
            OperatingSystem::Android.get_user_agent(),
            "android:com.ringapp"
        );
    }

    #[test]
    fn test_ios() {
        assert_eq!(OperatingSystem::Ios.get_client_id(), "ring_official_ios");
        assert_eq!(OperatingSystem::Ios.get_user_agent(), "ios:com.ringapp");
    }
}