ghost-io-api 0.2.0

Strongly-typed, async Rust client for the Ghost CMS Content and Admin APIs
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

//! Settings model for Ghost API.
//!
//! The Ghost Content API exposes a read-only subset of site settings via the
//! `/ghost/api/content/settings/` endpoint.
//!
//! # Example
//!
//! ```
//! use ghost_io_api::models::settings::Settings;
//!
//! let settings = Settings {
//!     title: Some("My Blog".to_string()),
//!     description: Some("A blog about things".to_string()),
//!     ..Default::default()
//! };
//!
//! assert_eq!(settings.title.as_deref(), Some("My Blog"));
//! ```

use serde::{Deserialize, Serialize};

/// A navigation item in the site menu.
///
/// # Example
///
/// ```
/// use ghost_io_api::models::settings::NavItem;
/// use serde_json::json;
///
/// let json = json!({ "label": "Home", "url": "/" });
/// let item: NavItem = serde_json::from_value(json).unwrap();
/// assert_eq!(item.label, "Home");
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct NavItem {
    /// Display label.
    pub label: String,
    /// Link URL.
    pub url: String,
}

/// Site-wide settings returned by the Ghost Content API.
///
/// All fields are optional because the API may omit fields that have not been
/// configured by the site owner.
///
/// # Example
///
/// ```
/// use ghost_io_api::models::settings::Settings;
/// use serde_json::json;
///
/// let json = json!({
///     "title": "Ghost",
///     "description": "The professional publishing platform",
///     "logo": "https://example.com/logo.png",
///     "lang": "en",
///     "timezone": "Etc/UTC",
///     "navigation": [
///         { "label": "Home", "url": "/" },
///         { "label": "About", "url": "/about/" }
///     ]
/// });
///
/// let settings: Settings = serde_json::from_value(json).unwrap();
/// assert_eq!(settings.title.as_deref(), Some("Ghost"));
/// assert_eq!(settings.navigation.len(), 2);
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct Settings {
    /// Site title.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Site description / tagline.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Logo image URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub logo: Option<String>,
    /// Site icon URL (favicon).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub icon: Option<String>,
    /// Accent colour hex code (e.g. `"#ff0095"`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub accent_color: Option<String>,
    /// Cover image URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cover_image: Option<String>,
    /// Facebook page URL or username.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub facebook: Option<String>,
    /// Twitter handle (without `@`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub twitter: Option<String>,
    /// Site locale/language code, e.g. `"en"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lang: Option<String>,
    /// Site timezone, e.g. `"Etc/UTC"`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// Code injected into `<head>` site-wide.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub codeinjection_head: Option<String>,
    /// Code injected at the end of `<body>` site-wide.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub codeinjection_foot: Option<String>,
    /// Primary navigation items.
    #[serde(default)]
    pub navigation: Vec<NavItem>,
    /// Secondary navigation items.
    #[serde(default)]
    pub secondary_navigation: Vec<NavItem>,
    /// OG image URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub og_image: Option<String>,
    /// OG title.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub og_title: Option<String>,
    /// OG description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub og_description: Option<String>,
    /// Twitter card image URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub twitter_image: Option<String>,
    /// Twitter card title.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub twitter_title: Option<String>,
    /// Twitter card description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub twitter_description: Option<String>,
    /// Meta title override.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub meta_title: Option<String>,
    /// Meta description override.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub meta_description: Option<String>,
    /// Members support email address.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub members_support_address: Option<String>,
    /// Canonical site URL.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
}

impl Settings {
    /// Returns `true` if the site has a logo configured.
    ///
    /// # Example
    ///
    /// ```
    /// use ghost_io_api::models::settings::Settings;
    ///
    /// let s = Settings { logo: Some("https://example.com/logo.png".to_string()), ..Default::default() };
    /// assert!(s.has_logo());
    ///
    /// let empty = Settings::default();
    /// assert!(!empty.has_logo());
    /// ```
    pub fn has_logo(&self) -> bool {
        self.logo.is_some()
    }

    /// Returns the number of primary navigation items.
    ///
    /// # Example
    ///
    /// ```
    /// use ghost_io_api::models::settings::{Settings, NavItem};
    ///
    /// let s = Settings {
    ///     navigation: vec![
    ///         NavItem { label: "Home".to_string(), url: "/".to_string() },
    ///     ],
    ///     ..Default::default()
    /// };
    /// assert_eq!(s.nav_count(), 1);
    /// ```
    pub fn nav_count(&self) -> usize {
        self.navigation.len()
    }
}

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

    #[test]
    fn test_nav_item_deserialization() {
        let json = json!({ "label": "Home", "url": "/" });
        let item: NavItem = serde_json::from_value(json).unwrap();
        assert_eq!(item.label, "Home");
        assert_eq!(item.url, "/");
    }

    #[test]
    fn test_settings_minimal_deserialization() {
        let json = json!({ "title": "My Blog" });
        let settings: Settings = serde_json::from_value(json).unwrap();
        assert_eq!(settings.title, Some("My Blog".to_string()));
        assert!(settings.navigation.is_empty());
    }

    #[test]
    fn test_settings_full_deserialization() {
        let json = json!({
            "title": "Ghost",
            "description": "Platform",
            "logo": "https://example.com/logo.png",
            "icon": "https://example.com/icon.png",
            "accent_color": "#ff0095",
            "cover_image": "https://example.com/cover.jpg",
            "facebook": "ghostorg",
            "twitter": "@Ghost",
            "lang": "en",
            "timezone": "Etc/UTC",
            "navigation": [
                { "label": "Home", "url": "/" },
                { "label": "About", "url": "/about/" }
            ],
            "secondary_navigation": [],
            "url": "https://example.com/"
        });
        let settings: Settings = serde_json::from_value(json).unwrap();
        assert_eq!(settings.title.as_deref(), Some("Ghost"));
        assert_eq!(settings.lang.as_deref(), Some("en"));
        assert_eq!(settings.navigation.len(), 2);
        assert_eq!(settings.navigation[0].label, "Home");
        assert!(settings.has_logo());
        assert_eq!(settings.nav_count(), 2);
    }

    #[test]
    fn test_settings_empty_navigation_default() {
        let settings = Settings::default();
        assert!(settings.navigation.is_empty());
        assert_eq!(settings.nav_count(), 0);
    }

    #[test]
    fn test_has_logo_true() {
        let s = Settings {
            logo: Some("https://example.com/logo.png".to_string()),
            ..Default::default()
        };
        assert!(s.has_logo());
    }

    #[test]
    fn test_has_logo_false() {
        assert!(!Settings::default().has_logo());
    }

    #[test]
    fn test_settings_serialization_skips_none() {
        let s = Settings {
            title: Some("T".to_string()),
            ..Default::default()
        };
        let json = serde_json::to_value(&s).unwrap();
        let obj = json.as_object().unwrap();
        assert!(!obj.contains_key("logo"));
        assert!(!obj.contains_key("twitter"));
    }

    #[test]
    fn test_settings_clone_eq() {
        let s = Settings {
            title: Some("Blog".to_string()),
            lang: Some("en".to_string()),
            ..Default::default()
        };
        assert_eq!(s, s.clone());
    }

    #[test]
    fn test_nav_item_clone_eq() {
        let item = NavItem {
            label: "Home".to_string(),
            url: "/".to_string(),
        };
        assert_eq!(item, item.clone());
    }

    #[test]
    fn test_nav_item_default() {
        let item = NavItem::default();
        assert!(item.label.is_empty());
        assert!(item.url.is_empty());
    }
}