mhome-core-api 1.10.0

Shared wire types and service contracts for the mHome core
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

use serde::{Deserialize, Serialize};

pub const VERSION: &str = crate::node::V1;
pub const STATUS: &str = "settings/status";
pub const UPDATE: &str = "settings/update";
pub const REVERT: &str = "settings/revert";
pub const RETRY: &str = "settings/retry";
pub const CHANGED_TARGET: &str = "/node/settings/changed";

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct StatusRequest {}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct UpdateRequest<T> {
    pub idempotency_key: String,
    pub section: String,
    pub expected_revision: u64,
    pub value: T,
}

impl<T> UpdateRequest<T> {
    pub fn new(idempotency_key: String, section: String, expected_revision: u64, value: T) -> Self {
        Self {
            idempotency_key,
            section,
            expected_revision,
            value,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct SectionCommandRequest {
    pub idempotency_key: String,
    pub section: String,
    pub expected_revision: u64,
}

impl SectionCommandRequest {
    pub fn new(idempotency_key: String, section: String, expected_revision: u64) -> Self {
        Self {
            idempotency_key,
            section,
            expected_revision,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct ChangedEvent {
    pub version: String,
    pub node_id: String,
    pub node_type: String,
    pub event_seq: u64,
    pub section: String,
    pub revision: u64,
}

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

    #[test]
    fn changed_event_accepts_additive_fields_without_internal_identity() {
        let event = serde_json::from_value::<ChangedEvent>(serde_json::json!({
            "version": "v1",
            "nodeId": "camera-1",
            "nodeType": "camera",
            "eventSeq": 7,
            "section": "recognition",
            "revision": 3,
            "futureField": true
        }))
        .unwrap();
        assert_eq!(event.node_id, "camera-1");
    }
}