mhome-artifact-api 1.2.0

Storage-independent artifact references shared by mHome runtimes
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use std::fmt;

use base64::{engine::general_purpose::STANDARD, Engine as _};
use serde::{Deserialize, Serialize};

use crate::{ArtifactKind, ArtifactReference};

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct PutArtifactRequest {
    pub kind: ArtifactKind,
    pub mime_type: String,
    pub data_base64: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub duration_millis: Option<u64>,
}

impl PutArtifactRequest {
    pub fn decode(&self) -> Result<Vec<u8>, PutArtifactValidationError> {
        if self.mime_type.trim() != self.mime_type || self.mime_type.is_empty() {
            return Err(invalid("artifact put MIME type is invalid"));
        }
        match self.kind {
            ArtifactKind::Image if !self.mime_type.starts_with("image/") => {
                return Err(invalid("artifact put image MIME type is invalid"));
            }
            ArtifactKind::Audio if !self.mime_type.starts_with("audio/") => {
                return Err(invalid("artifact put audio MIME type is invalid"));
            }
            ArtifactKind::Video if !self.mime_type.starts_with("video/") => {
                return Err(invalid("artifact put video MIME type is invalid"));
            }
            ArtifactKind::File if self.mime_type.starts_with("video/") => {
                return Err(invalid("video artifacts are not supported"));
            }
            _ => {}
        }
        if !matches!(self.kind, ArtifactKind::Audio | ArtifactKind::Video)
            && self.duration_millis.is_some()
        {
            return Err(invalid(
                "artifact put duration is only valid for audio or video",
            ));
        }
        if self.duration_millis == Some(0) {
            return Err(invalid("artifact put duration is invalid"));
        }
        let bytes = STANDARD
            .decode(&self.data_base64)
            .map_err(|_| invalid("artifact put content is invalid base64"))?;
        if bytes.is_empty() {
            return Err(invalid("artifact put content is empty"));
        }
        Ok(bytes)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct PutArtifactResponse {
    pub uri: String,
    pub kind: ArtifactKind,
    pub mime_type: String,
    pub size_bytes: u64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub width: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub height: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub duration_millis: Option<u64>,
}

impl PutArtifactResponse {
    pub fn validate(&self) -> Result<ArtifactReference, PutArtifactValidationError> {
        let reference = ArtifactReference::parse(&self.uri)
            .map_err(|_| invalid("artifact put URI is invalid"))?;
        let metadata = reference.metadata();
        if self.kind != metadata.kind()
            || self.mime_type != metadata.mime_type()
            || self.size_bytes != metadata.size_bytes()
            || self.width != metadata.width()
            || self.height != metadata.height()
            || self.duration_millis != metadata.duration_millis()
        {
            return Err(invalid(
                "artifact put metadata does not match its canonical reference",
            ));
        }
        Ok(reference)
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PutArtifactValidationError(&'static str);

impl fmt::Display for PutArtifactValidationError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.0)
    }
}

impl std::error::Error for PutArtifactValidationError {}

fn invalid(message: &'static str) -> PutArtifactValidationError {
    PutArtifactValidationError(message)
}

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

    #[test]
    fn request_rejects_kind_mime_mismatch() {
        let request = PutArtifactRequest {
            kind: ArtifactKind::Audio,
            mime_type: "image/png".to_string(),
            data_base64: "eA==".to_string(),
            duration_millis: None,
        };
        assert!(request.decode().is_err());
    }
}