bo4e-core 0.1.1

Core types for BO4E (Business Objects for Energy)
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

//! Signature (Unterschrift) component.

use serde::{Deserialize, Serialize};

use crate::traits::{Bo4eMeta, Bo4eObject};

/// Digital signature for contracts, offers, etc.
///
/// German: Unterschrift
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::Signature;
///
/// let signature = Signature {
///     name: Some("Max Mustermann".to_string()),
///     location: Some("Köln".to_string()),
///     date: Some("2024-01-15T10:30:00+01:00".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Signature {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Name of the signatory (Name)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,

    /// Location where the signature was made (Ort)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location: Option<String>,

    /// Date of the signature (Datum) - ISO 8601 datetime string
    #[serde(skip_serializing_if = "Option::is_none")]
    pub date: Option<String>,
}

impl Bo4eObject for Signature {
    fn type_name_german() -> &'static str {
        "Unterschrift"
    }

    fn type_name_english() -> &'static str {
        "Signature"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

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

    #[test]
    fn test_signature_default() {
        let sig = Signature::default();
        assert!(sig.name.is_none());
        assert!(sig.location.is_none());
        assert!(sig.date.is_none());
    }

    #[test]
    fn test_signature_serialize() {
        let sig = Signature {
            name: Some("Hans Schmidt".to_string()),
            location: Some("Berlin".to_string()),
            date: Some("2024-06-15T14:00:00+02:00".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&sig).unwrap();
        assert!(json.contains(r#""name":"Hans Schmidt""#));
        assert!(json.contains(r#""location":"Berlin""#));
        assert!(json.contains(r#""date":"2024-06-15T14:00:00+02:00""#));
    }

    #[test]
    fn test_signature_roundtrip() {
        let sig = Signature {
            meta: Bo4eMeta::with_type("Unterschrift"),
            name: Some("Erika Musterfrau".to_string()),
            location: Some("München".to_string()),
            date: Some("2024-03-20T09:15:00+01:00".to_string()),
        };

        let json = serde_json::to_string(&sig).unwrap();
        let parsed: Signature = serde_json::from_str(&json).unwrap();
        assert_eq!(sig, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(Signature::type_name_german(), "Unterschrift");
        assert_eq!(Signature::type_name_english(), "Signature");
    }
}