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
158
159
160
161
162
163
164

//! Offer (Angebot) business object.

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

use crate::com::{OfferVariant, TimePeriod};
use crate::enums::{Division, OfferStatus};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// An offer/quote for energy supply or services.
///
/// German: Angebot
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::Offer;
/// use bo4e_core::enums::{Division, OfferStatus};
///
/// let offer = Offer {
///     offer_number: Some("A-2024-001".to_string()),
///     status: Some(OfferStatus::Binding),
///     division: Some(Division::Electricity),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Offer {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Offer number (Angebotsnummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offer_number: Option<String>,

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

    /// Status of offer (Angebotsstatus)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<OfferStatus>,

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

    /// Date the offer was created (Angebotsdatum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offer_date: Option<DateTime<Utc>>,

    /// Date until which the offer is valid (Gueltig bis)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub valid_until: Option<DateTime<Utc>>,

    /// Delivery period (Lieferzeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delivery_period: Option<TimePeriod>,

    /// Offer variants (Angebotsvarianten)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub variants: Vec<OfferVariant>,

    /// Reference to the bidder/supplier (Anbieter)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bidder: Option<Box<super::BusinessPartner>>,

    /// Reference to the customer (Kunde)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub customer: Option<Box<super::BusinessPartner>>,

    /// Reference to associated tender (Ausschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tender_id: Option<String>,
}

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

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

    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_offer_creation() {
        let offer = Offer {
            offer_number: Some("A-2024-001".to_string()),
            status: Some(OfferStatus::Binding),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        assert_eq!(offer.status, Some(OfferStatus::Binding));
    }

    #[test]
    fn test_offer_with_variants() {
        let variant = OfferVariant {
            offer_status: Some(OfferStatus::NonBinding),
            parts_count: Some(3),
            ..Default::default()
        };

        let offer = Offer {
            offer_number: Some("A-2024-001".to_string()),
            variants: vec![variant],
            ..Default::default()
        };

        assert_eq!(offer.variants.len(), 1);
    }

    #[test]
    fn test_serialize() {
        let offer = Offer {
            meta: Bo4eMeta::with_type("Angebot"),
            offer_number: Some("A-123".to_string()),
            status: Some(OfferStatus::Binding),
            ..Default::default()
        };

        let json = serde_json::to_string(&offer).unwrap();
        assert!(json.contains(r#""offerNumber":"A-123""#));
    }

    #[test]
    fn test_roundtrip() {
        let offer = Offer {
            meta: Bo4eMeta::with_type("Angebot"),
            offer_number: Some("A-123".to_string()),
            description: Some("Test offer".to_string()),
            status: Some(OfferStatus::Binding),
            division: Some(Division::Electricity),
            ..Default::default()
        };

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

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