oparl-types 0.8.5

Type definitions for the OParl protocol
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

// SPDX-FileCopyrightText: Politik im Blick developers
// SPDX-FileCopyrightText: Wolfgang Silbermayr <wolfgang@silbermayr.at>
//
// SPDX-License-Identifier: AGPL-3.0-or-later OR EUPL-1.2

use std::fmt::Display;

use crate::namespace::ErrorNamespaceUrl;

#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Error {
    #[serde(rename = "type")]
    pub namespace: ErrorNamespaceUrl,

    pub message: String,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub debug: Option<String>,

    #[serde(default, flatten)]
    pub extensions: serde_json::Map<String, serde_json::Value>,
}

impl Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.message.fmt(f)
    }
}

impl Error {
    pub fn not_found(kind: String) -> Self {
        Self {
            namespace: ErrorNamespaceUrl::Identifier,
            message: format!("not found: {kind}"),
            debug: None,
            extensions: Default::default(),
        }
    }

    pub fn internal_server_error(description: String) -> Self {
        Self {
            namespace: ErrorNamespaceUrl::Identifier,
            message: format!("internal server error: {description}"),
            debug: None,
            extensions: Default::default(),
        }
    }
}

#[cfg(test)]
mod serde_tests {
    use pretty_assertions::assert_eq;
    use serde_json::json;

    use super::Error;
    use crate::namespace::ErrorNamespaceUrl;

    fn example_error() -> Error {
        Error {
            namespace: ErrorNamespaceUrl::Identifier,
            message: "Something went wrong".into(),
            debug: Some("Could not connect to database".into()),
            extensions: serde_json::Map::new(),
        }
    }

    fn example_error_json() -> serde_json::Value {
        json!(        {
            "type": "https://schema.oparl.org/1.1/Error",
            "message": "Something went wrong",
            "debug": "Could not connect to database",
        })
    }

    #[test]
    fn serialize() {
        assert_eq!(json!(example_error()), example_error_json());
    }

    #[test]
    fn deserialize_good() {
        let deserialized: Error = serde_json::from_value(example_error_json())
            .expect("value must be deserializable as Error");
        assert_eq!(deserialized, example_error());
    }

    #[test]
    fn deserialize_bad() {
        assert!(serde_json::from_value::<Error>(json!("xyzabcd")).is_err());
        assert!(serde_json::from_value::<Error>(json!(true)).is_err());
        assert!(serde_json::from_value::<Error>(json!(123)).is_err());
    }
}