oparl-types 0.1.0

Type definitions for the OParl protocol
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

// SPDX-FileCopyrightText: Politik im Blick developers
// SPDX-FileCopyrightText: Wolfgang Silbermayr <wolfgang@silbermayr.at>
//
// SPDX-License-Identifier: AGPL-3.0-or-later OR EUPL-1.2

use url::Url;

use crate::{
    namespace::ConsultationNamespaceUrl, AgendaItemId, ConsultationId, DateTime, Keyword,
    MeetingId, OrganizationId, PaperId,
};

#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Consultation {
    pub id: ConsultationId,

    #[serde(rename = "type")]
    pub namespace: ConsultationNamespaceUrl,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub paper: Option<PaperId>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub agenda_item: Option<AgendaItemId>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meeting: Option<MeetingId>,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub organization: Vec<OrganizationId>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub authoritative: Option<bool>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub role: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub license: Option<Url>,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub keyword: Vec<Keyword>,

    pub created: DateTime,

    pub modified: DateTime,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub web: Option<Url>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub deleted: Option<bool>,
}

#[cfg(test)]
mod serde_tests {
    use super::Consultation;
    use crate::namespace::ConsultationNamespaceUrl;

    use pretty_assertions::assert_eq;
    use serde_json::json;
    use time::macros::datetime;

    fn example_consultation() -> Consultation {
        Consultation {
            id: "https://oparl.example.org/consultation/47594"
                .parse()
                .expect("value must be parseable as id"),
            namespace: ConsultationNamespaceUrl::Identifier,
            paper: Some(
                "https://oparl.example.org/paper/749"
                    .parse()
                    .expect("value must be parseable as url"),
            ),
            agenda_item: Some(
                "https://oparl.example.org/agendaitem/15569"
                    .parse()
                    .expect("value must be parseable as url"),
            ),
            meeting: Some(
                "https://oparl.example.org/meeting/243"
                    .parse()
                    .expect("value must be parseable as url"),
            ),
            organization: vec!["https://oparl.example.org/organization/96"
                .parse()
                .expect("value must be parseable as url")],
            authoritative: Some(false),
            role: Some("Beschlussfassung".into()),
            license: None,
            keyword: vec![],
            created: datetime!(2012-01-08 14:05:27 +01:00).into(),
            modified: datetime!(2012-01-08 14:05:27 +01:00).into(),
            web: None,
            deleted: None,
        }
    }

    fn example_consultation_json() -> serde_json::Value {
        json!({
            "id": "https://oparl.example.org/consultation/47594",
            "type": "https://schema.oparl.org/1.1/Consultation",
            "paper": "https://oparl.example.org/paper/749",
            "agendaItem": "https://oparl.example.org/agendaitem/15569",
            "meeting": "https://oparl.example.org/meeting/243",
            "organization": [
                "https://oparl.example.org/organization/96"
            ],
            "authoritative": false,
            "role": "Beschlussfassung",
            "created": "2012-01-08T14:05:27+01:00",
            "modified": "2012-01-08T14:05:27+01:00"
        })
    }

    #[test]
    fn serialize() {
        assert_eq!(json!(example_consultation()), example_consultation_json());
    }

    #[test]
    fn deserialize_good() {
        let deserialized: Consultation = serde_json::from_value(example_consultation_json())
            .expect("value must be deserializable as Consultation");
        assert_eq!(deserialized, example_consultation());
    }

    #[test]
    fn deserialize_bad() {
        assert!(serde_json::from_value::<Consultation>(json!("xyzabcd")).is_err());
        assert!(serde_json::from_value::<Consultation>(json!(true)).is_err());
        assert!(serde_json::from_value::<Consultation>(json!(123)).is_err());
    }
}