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
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! Tariff info (Tarifinfo) business object.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::com::{EnergyMix, PriceGuarantee, TariffRestriction, TimePeriod};
use crate::enums::{CustomerType, Division};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// Tariff information/overview.
///
/// Provides summary information about a tariff without the full details.
///
/// German: Tarifinfo
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::TariffInfo;
/// use bo4e_core::enums::{CustomerType, Division};
///
/// let tariff_info = TariffInfo {
///     tariff_name: Some("Oekostrom Basis".to_string()),
///     division: Some(Division::Electricity),
///     customer_type: Some(CustomerType::Household),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TariffInfo {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Tariff name (Tarifname)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tariff_name: Option<String>,

    /// Tariff description (Tarifbeschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Energy division (Sparte)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub division: Option<Division>,

    /// Target customer type (Kundentyp)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer_type: Option<CustomerType>,

    /// Website URL for tariff information (Website)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,

    /// Validity period (Gueltigkeitszeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validity_period: Option<TimePeriod>,

    /// Start date of tariff availability (Angebotsdatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub available_from: Option<DateTime<Utc>>,

    /// End date of tariff availability (Enddatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub available_until: Option<DateTime<Utc>>,

    /// Energy mix composition (Energiemix)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub energy_mix: Option<EnergyMix>,

    /// Price guarantee (Preisgarantie)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price_guarantee: Option<PriceGuarantee>,

    /// Tariff restrictions (Tarifeinschraenkungen)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub restrictions: Vec<TariffRestriction>,

    /// Provider/supplier
    #[serde(skip_serializing_if = "Option::is_none")]
    pub supplier: Option<Box<super::BusinessPartner>>,
}

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

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

    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_tariff_info_creation() {
        let tariff_info = TariffInfo {
            tariff_name: Some("Oekostrom Basis".to_string()),
            division: Some(Division::Electricity),
            customer_type: Some(CustomerType::Household),
            website: Some("https://example.com/tariff".to_string()),
            ..Default::default()
        };

        assert_eq!(tariff_info.tariff_name, Some("Oekostrom Basis".to_string()));
        assert_eq!(tariff_info.customer_type, Some(CustomerType::Household));
    }

    #[test]
    fn test_serialize() {
        let tariff_info = TariffInfo {
            meta: Bo4eMeta::with_type("Tarifinfo"),
            tariff_name: Some("Green Energy".to_string()),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        let json = serde_json::to_string(&tariff_info).unwrap();
        assert!(json.contains(r#""tariffName":"Green Energy""#));
        assert!(json.contains(r#""_typ":"Tarifinfo""#));
    }

    #[test]
    fn test_roundtrip() {
        let tariff_info = TariffInfo {
            meta: Bo4eMeta::with_type("Tarifinfo"),
            tariff_name: Some("Test Tariff".to_string()),
            description: Some("A test tariff info".to_string()),
            division: Some(Division::Gas),
            customer_type: Some(CustomerType::Commercial),
            website: Some("https://test.com".to_string()),
            ..Default::default()
        };

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

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