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

use crate::client::api::RingApi;
use crate::client::authentication::{Credentials, RingAuth, Tokens};
use std::sync::Arc;
use tokio::sync::RwLock;

mod api;
mod wrapper;

/// Support for the Ring Authentication flow.
pub mod authentication;

pub use api::device;
pub use api::location;
pub use api::session;
pub use api::ticket;

pub use api::ApiError;
pub use authentication::AuthenticationError;

/// Client used to authenticate and interact with Ring.
#[derive(Debug)]
pub struct Client {
    user: RwLock<Option<Credentials>>,
    tokens: RwLock<Option<Arc<Tokens>>>,
    auth: RingAuth,
    api: RingApi,
    display_name: String,
    system_id: String,
}

impl Client {
    /// Create a new client.
    ///
    /// The system ID is used by Ring to identify the client on subsequent logins, and should be
    /// predictable and consistent per device.
    #[must_use]
    pub fn new(
        display_name: &str,
        system_id: &str,
        operating_system: crate::helper::OperatingSystem,
    ) -> Self {
        Self {
            user: RwLock::new(None),
            tokens: RwLock::new(None),
            auth: RingAuth::new(operating_system),
            api: RingApi::new(operating_system),
            display_name: display_name.to_string(),
            system_id: system_id.to_string(),
        }
    }
}