oembed-rs 0.0.8

Retrieve oEmbed data from a URL
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

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// An oEmbed provider
///
/// See the [oembed spec](https://oembed.com/#section7.1) for more information
#[derive(Debug, Deserialize)]
pub struct Provider {
    pub provider_name: String,
    pub provider_url: String,
    pub endpoints: Vec<Endpoint>,
}

/// An oEmbed provider endpoint
#[derive(Debug, Deserialize)]
pub struct Endpoint {
    #[serde(default)]
    pub schemes: Vec<String>,
    pub url: String,
    #[serde(default)]
    pub discovery: bool,
}

/// Represents one of the oEmbed data types
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(tag = "type")]
pub enum EmbedType {
    /// Photo type
    ///
    /// See section 2.3.4.1. of the [oembed spec](https://oembed.com) for more information
    #[serde(rename = "photo")]
    Photo(Photo),
    /// Video type
    ///
    /// See section 2.3.4.2. of the [oembed spec](https://oembed.com) for more information
    #[serde(rename = "video")]
    Video(Video),
    /// Link type
    ///
    /// See section 2.3.4.3. of the [oembed spec](https://oembed.com) for more information
    #[serde(rename = "link")]
    Link,
    /// Rich type
    ///
    /// See section 2.3.4.4. of the [oembed spec](https://oembed.com) for more information
    #[serde(rename = "rich")]
    Rich(Rich),
}

/// Video type
///
/// See section 2.3.4.2. of the [oembed spec](https://oembed.com) for more information
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct Video {
    pub html: String,
    pub width: Option<i32>,
    pub height: Option<i32>,
}

/// Photo type
///
/// See section 2.3.4.1. of the [oembed spec](https://oembed.com) for more information
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct Photo {
    pub url: String,
    pub width: Option<i32>,
    pub height: Option<i32>,
}

/// Rich type
///
/// See section 2.3.4.4. of the [oembed spec](https://oembed.com) for more information
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct Rich {
    pub html: String,
    pub width: Option<i32>,
    pub height: Option<i32>,
}

/// oEmbed response
///
/// See the [oembed spec](https://oembed.com/#section2.3) for more information
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[derive(Debug, Serialize, Deserialize, PartialEq)]
pub struct EmbedResponse {
    #[serde(flatten)]
    pub oembed_type: EmbedType,
    pub version: String,
    pub title: Option<String>,
    pub author_name: Option<String>,
    pub author_url: Option<String>,
    pub provider_name: Option<String>,
    pub provider_url: Option<String>,
    pub cache_age: Option<String>,
    pub thumbnail_url: Option<String>,
    pub thumbnail_width: Option<i32>,
    pub thumbnail_height: Option<i32>,
    #[serde(flatten)]
    pub extra: HashMap<String, Value>,
}

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

    #[test]
    fn test_photo() {
        let input = r#"{
            "type": "photo",
            "version": "1.0",
            "title": "photo",
            "width": 100,
            "height": 50,
            "url": "https://example.com/photo.jpg"
        }"#;
        let response: EmbedResponse = serde_json::from_str(input).unwrap();

        assert_eq!(response.title, Some("photo".to_string()));
        assert_eq!(
            response.oembed_type,
            EmbedType::Photo(Photo {
                url: "https://example.com/photo.jpg".to_string(),
                width: Some(100),
                height: Some(50)
            })
        )
    }
}