bo4e-core 0.2.0

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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

//! Contact method (Kontaktweg) component.

use serde::{Deserialize, Serialize};

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

/// Method of contact (email, phone, etc.).
///
/// Used to represent contact information for a person within business objects.
///
/// German: Kontaktweg
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::ContactMethod;
/// use bo4e_core::enums::ContactType;
///
/// let contact = ContactMethod {
///     contact_type: Some(ContactType::Email),
///     contact_value: Some("info@example.com".to_string()),
///     is_preferred: Some(true),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "Kontaktweg"))]
#[serde(rename_all = "camelCase")]
pub struct ContactMethod {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Type of contact (Kontaktart)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "kontaktart"))]
    pub contact_type: Option<ContactType>,

    /// Contact value - phone number, email address, etc. (Kontaktwert)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "kontaktwert"))]
    pub contact_value: Option<String>,

    /// Description/specification, e.g., "direct line", "switchboard" (Beschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "beschreibung"))]
    pub description: Option<String>,

    /// Whether this is the preferred contact method (IstBevorzugterKontaktweg)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "istBevorzugterKontaktweg"))]
    pub is_preferred: Option<bool>,
}

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

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

    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_contact_method_default() {
        let contact = ContactMethod::default();
        assert!(contact.contact_type.is_none());
        assert!(contact.contact_value.is_none());
        assert!(contact.is_preferred.is_none());
    }

    #[test]
    fn test_email_contact() {
        let contact = ContactMethod {
            contact_type: Some(ContactType::Email),
            contact_value: Some("test@example.com".to_string()),
            is_preferred: Some(true),
            ..Default::default()
        };

        let json = serde_json::to_string(&contact).unwrap();
        assert!(json.contains(r#""contactType":"E_MAIL""#));
        assert!(json.contains(r#""contactValue":"test@example.com""#));
        assert!(json.contains(r#""isPreferred":true"#));

        let parsed: ContactMethod = serde_json::from_str(&json).unwrap();
        assert_eq!(contact, parsed);
    }

    #[test]
    fn test_phone_contact() {
        let contact = ContactMethod {
            contact_type: Some(ContactType::Phone),
            contact_value: Some("+49 221 1234567".to_string()),
            description: Some("Direct line".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&contact).unwrap();
        assert!(json.contains(r#""contactType":"TELEFON""#));
        assert!(json.contains(r#""description":"Direct line""#));

        let parsed: ContactMethod = serde_json::from_str(&json).unwrap();
        assert_eq!(contact, parsed);
    }

    #[test]
    fn test_contact_method_roundtrip() {
        let contact = ContactMethod {
            meta: Bo4eMeta::with_type("Kontaktweg"),
            contact_type: Some(ContactType::Fax),
            contact_value: Some("+49 221 1234568".to_string()),
            description: Some("Fax number".to_string()),
            is_preferred: Some(false),
        };

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

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