caldir-core 0.16.0

Core library for caldir calendar storage, sync, and provider 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
136
137
138
139
140
141

mod params;

use crate::ProviderSlug;
use serde::{Deserialize, Serialize};

pub use params::RemoteConfigParams;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RemoteConfig {
    #[serde(rename = "provider")]
    provider_slug: ProviderSlug,

    #[serde(flatten)]
    params: RemoteConfigParams,
}

/// A remote config is always part of a calendar config
/// so it doesn't need its own ::load and ::write methods
impl RemoteConfig {
    pub fn new(provider_slug: ProviderSlug, params: RemoteConfigParams) -> Self {
        Self {
            provider_slug,
            params,
        }
    }

    pub fn provider_slug(&self) -> &ProviderSlug {
        &self.provider_slug
    }

    pub fn get(&self, key: &str) -> Option<&toml::Value> {
        self.params().get(key)
    }

    pub(crate) fn params(&self) -> &RemoteConfigParams {
        &self.params
    }

    /// Returns the account identifier for this remote, if present.
    ///
    /// Looks for a `{provider}_account` field in the config
    /// (e.g., `google_account`, `icloud_account`)
    /// Providers that have a concept of an account should include this field.
    /// Providers without accounts (e.g., plain CalDAV servers) can omit it.
    pub fn account_identifier(&self) -> Option<&str> {
        let key = format!("{}_account", self.provider_slug());
        self.params().get(&key).and_then(|v| v.as_str())
    }

    #[cfg(test)]
    fn from_toml(s: &str) -> Result<Self, toml::de::Error> {
        toml::from_str(s)
    }

    #[cfg(test)]
    fn to_toml(&self) -> Result<String, toml::ser::Error> {
        toml::to_string(self)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parses_provider_and_flattened_params() {
        let toml_str = r#"
provider = "hooli"
hooli_calendar_id = "abc@group.calendar.hooli.com"
hooli_account = "user@hmail.com"
"#;

        let remote_config = RemoteConfig::from_toml(toml_str).unwrap();

        assert_eq!(remote_config.provider_slug.to_string(), "hooli");
        assert_eq!(
            remote_config.get("hooli_account"),
            Some(&toml::Value::String("user@hmail.com".to_string()))
        );
        assert_eq!(
            remote_config.get("hooli_calendar_id"),
            Some(&toml::Value::String(
                "abc@group.calendar.hooli.com".to_string()
            ))
        );
    }

    #[test]
    fn parses_provider_with_no_params() {
        let remote_config = RemoteConfig::from_toml(r#"provider = "caldav""#).unwrap();

        assert_eq!(remote_config.provider_slug.to_string(), "caldav");
        assert!(remote_config.params().is_empty());
    }

    #[test]
    fn round_trip_preserves_provider_and_params() {
        let mut params = RemoteConfigParams::new();
        params.insert(
            "hooli_account".to_string(),
            toml::Value::String("user@hmail.com".to_string()),
        );
        params.insert(
            "hooli_calendar_id".to_string(),
            toml::Value::String("abc@group.calendar.hooli.com".to_string()),
        );

        let remote = RemoteConfig::new(ProviderSlug::from("hooli"), params);

        let serialized = remote.to_toml().unwrap();
        let parsed = RemoteConfig::from_toml(&serialized).unwrap();

        assert_eq!(parsed, remote);
    }

    #[test]
    fn account_identifier_returns_provider_account_field() {
        let toml_str = r#"
provider = "hooli"
hooli_account = "user@hmail.com"
"#;

        let remote_config = RemoteConfig::from_toml(toml_str).unwrap();

        assert_eq!(remote_config.account_identifier(), Some("user@hmail.com"));
    }

    #[test]
    fn account_identifier_returns_none_when_missing() {
        let remote_config = RemoteConfig::from_toml(r#"provider = "hooli""#).unwrap();

        assert_eq!(remote_config.account_identifier(), None);
    }

    #[test]
    fn missing_provider_errors() {
        let result = RemoteConfig::from_toml(r#"hooli_account = "user@hmail.com""#);

        assert!(result.is_err());
    }
}