tmflib 0.1.38

Interface library for processing TMF payloads
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

//! Related Party Module
//! # Description
//! This object provides a reference object to any of the party objects, specifically:
//! - [`Customer`]
//! - [`PartyRole`]
//! - [`Individual`]
//! - [`Organization`]

use serde::{Deserialize, Serialize};
use std::convert::From;

use crate::tmf629::customer::Customer;
#[cfg(all(feature = "tmf632", feature = "build-V4"))]
use crate::tmf632::individual_v4::Individual;
#[cfg(all(feature = "tmf632", feature = "build-V5"))]
use crate::tmf632::individual_v5::Individual;
#[cfg(all(feature = "tmf632", feature = "build-V4"))]
use crate::tmf632::organization_v4::{Organization, OrganizationRef};
#[cfg(all(feature = "tmf632", feature = "build-V5"))]
use crate::tmf632::organization_v5::{Organization, OrganizationRef};
#[cfg(feature = "tmf669")]
use crate::tmf669::party_role::PartyRole;
use crate::{HasId, HasName, Uri};

/// Reference to a Customer (TMF629) , Organisation or Individual (TMF632)
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RelatedParty {
    /// Unique Id of the referenced party
    pub id: String,
    /// HTML reference of the related party
    pub href: String,
    /// Name of the referenced party / customer
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Name referenced role
    #[serde(skip_serializing_if = "Option::is_none")]
    pub role: Option<String>,

    // META
    /// Base Type this type is derived from if creating sub-classes
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "@baseType")]
    pub base_type: Option<String>,
    /// Schema Definition of the sub-class (if required)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "@schemaLocation")]
    pub schema_location: Option<Uri>,
    /// Name for this Type when sub-classing
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "@type")]
    pub r#type: Option<String>,
    /// What type is this reference referring to?
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "@referredType")]
    pub referred_type: Option<String>,
}

impl From<&Customer> for RelatedParty {
    fn from(cust: &Customer) -> Self {
        RelatedParty {
            id: cust.get_id(),
            href: cust.get_href(),
            name: cust.name.clone(),
            role: Some(Customer::get_class()),
            base_type: Some(Customer::get_class()),
            referred_type: Some(Customer::get_class()),
            r#type: Some(Customer::get_class()),
            schema_location: None,
        }
    }
}

impl From<Organization> for RelatedParty {
    fn from(org: Organization) -> Self {
        RelatedParty {
            id: org.get_id(),
            href: org.get_href(),
            name: Some(org.get_name()),
            role: Some(Organization::get_class()),
            referred_type: Some(Organization::get_class()),
            base_type: Some(Organization::get_class()),
            r#type: Some(Organization::get_class()),
            schema_location: None,
        }
    }
}

impl From<&Organization> for RelatedParty {
    fn from(org: &Organization) -> Self {
        RelatedParty {
            id: org.get_id(),
            href: org.get_href(),
            name: Some(org.get_name()),
            role: Some(Organization::get_class()),
            referred_type: Some(Organization::get_class()),
            base_type: Some(Organization::get_class()),
            r#type: Some(Organization::get_class()),
            schema_location: None,
        }
    }
}

impl From<OrganizationRef> for RelatedParty {
    fn from(value: OrganizationRef) -> Self {
        RelatedParty {
            id: value.id.clone(),
            href: value.href.clone(),
            name: Some(value.name.clone()),
            role: Some(Organization::get_class()),
            referred_type: Some(Organization::get_class()),
            base_type: Some(Organization::get_class()),
            r#type: Some(Organization::get_class()),
            schema_location: None,
        }
    }
}

impl From<&Individual> for RelatedParty {
    fn from(value: &Individual) -> Self {
        RelatedParty {
            id: value.get_id(),
            href: value.get_href(),
            name: Some(value.get_name()),
            role: Some(Individual::get_class()),
            referred_type: Some(Individual::get_class()),
            base_type: Some(Individual::get_class()),
            r#type: Some(Individual::get_class()),
            schema_location: None,
        }
    }
}

/// See: <https://engage.tmforum.org/discussion/role-in-relatedparty?ReturnUrl=%2fcommunities%2fcommunity-home%2fdigestviewer%3fcommunitykey%3dd543b8ba-9d3a-4121-85ce-5b68e6c31ce5>
/// Create a [RelatedParty] reference from a reference to [crate::tmf669::party_role::PartyRole]
impl From<&PartyRole> for RelatedParty {
    fn from(value: &PartyRole) -> Self {
        RelatedParty {
            id: value.get_id(),
            href: value.get_href(),
            name: None,
            role: value.name.clone(),
            referred_type: Some(PartyRole::get_class()),
            base_type: Some(PartyRole::get_class()),
            r#type: Some(PartyRole::get_class()),
            schema_location: None,
        }
    }
}

#[cfg(test)]
mod test {
    use super::RelatedParty;
    use crate::tmf629::customer::Customer;
    #[cfg(all(feature = "tmf632", feature = "build-V4"))]
    use crate::tmf632::organization_v4::Organization;
    #[cfg(all(feature = "tmf632", feature = "build-V4"))]
    use crate::tmf632::organization_v4::OrganizationRef;
    #[cfg(all(feature = "tmf632", feature = "build-V5"))]
    use crate::tmf632::organization_v5::Organization;
    #[cfg(all(feature = "tmf632", feature = "build-V5"))]
    use crate::tmf632::organization_v5::OrganizationRef;
    use crate::tmf669::party_role::PartyRole;
    use crate::{HasId, HasName};

    const ORG_NAME: &str = "An Organisation";
    const ROLE_NAME: &str = "A Role";

    #[test]
    fn test_related_party_from_customer_id() {
        let org = Organization::new(ORG_NAME);
        let cust = Customer::new(org);
        let party = RelatedParty::from(&cust);
        assert_eq!(cust.id.unwrap(), party.id);
    }
    #[test]
    fn test_related_party_from_customer_href() {
        let org = Organization::new(ORG_NAME);
        let cust = Customer::new(org);
        let party = RelatedParty::from(&cust);
        assert_eq!(cust.href.unwrap(), party.href);
    }
    #[test]
    fn test_related_party_from_customer_name() {
        let org = Organization::new(ORG_NAME);
        let cust = Customer::new(org);
        let party = RelatedParty::from(&cust);
        assert_eq!(cust.name, party.name);
    }
    #[test]
    fn test_related_party_from_customer_role() {
        let org = Organization::new(ORG_NAME);
        let cust = Customer::new(org);
        let party = RelatedParty::from(&cust);
        assert_eq!(party.role.unwrap(), Customer::get_class());
    }
    #[test]
    fn test_related_party_from_customer_referred() {
        let org = Organization::new(ORG_NAME);
        let cust = Customer::new(org);
        let party = RelatedParty::from(&cust);

        assert_eq!(party.referred_type.unwrap(), Customer::get_class());
    }

    #[test]
    fn test_related_party_from_organization() {
        let org = Organization::new(ORG_NAME);

        let party = RelatedParty::from(&org);

        assert_eq!(org.name, party.name);
        assert_eq!(org.id.unwrap(), party.id);
        assert_eq!(org.href.unwrap(), party.href);
    }

    #[test]
    fn test_related_party_from_organization_ref() {
        let org = Organization::new(ORG_NAME);
        let org_ref = OrganizationRef::from(org);

        let party = RelatedParty::from(org_ref.clone());

        assert_eq!(org_ref.name, party.name.unwrap());
        assert_eq!(org_ref.id, party.id);
        assert_eq!(org_ref.href, party.href);
    }

    #[test]
    fn test_relatedparty_from_partyrole() {
        let party = Organization::new(ORG_NAME);
        let role = PartyRole::new(ROLE_NAME, RelatedParty::from(party.clone()));

        let new_party = RelatedParty::from(&role);

        assert_eq!(new_party.id, role.get_id());
        assert_eq!(new_party.role.is_some(), true);
        assert_eq!(new_party.role.unwrap(), role.get_name());
        assert_eq!(new_party.referred_type.is_some(), true);
        assert_eq!(new_party.referred_type.unwrap(), PartyRole::get_class());
    }
}