rs-plugin-common-interfaces 0.31.0

Common description for plugin creation
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

use crate::domain::{
    other_ids::OtherIds,
    rs_ids::{ApplyRsIds, RsIds},
    tools::rating_serializer,
};
use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Episode {
    pub serie: String,
    pub season: u32,
    pub number: u32,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub abs: Option<u32>,

    pub name: Option<String>,
    pub overview: Option<String>,

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

    #[serde(skip_serializing_if = "Option::is_none")]
    pub airdate: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub duration: Option<u64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub imdb: Option<String>,
    pub slug: Option<String>,
    pub tmdb: Option<u64>,
    pub trakt: Option<u64>,
    pub tvdb: Option<u64>,
    pub otherids: Option<OtherIds>,

    #[serde(serialize_with = "rating_serializer")]
    pub imdb_rating: Option<f32>,
    pub imdb_votes: Option<u64>,
    #[serde(serialize_with = "rating_serializer")]
    pub trakt_rating: Option<f32>,
    pub trakt_votes: Option<u64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub watched: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub progress: Option<u64>,

    #[serde(default)]
    pub modified: u64,
    #[serde(default)]
    pub added: u64,

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

impl Episode {
    pub fn id(&self) -> String {
        format!("{}x{}x{}", self.serie, self.season, self.number)
    }
}

impl From<Episode> for RsIds {
    fn from(value: Episode) -> Self {
        let id = value.id();
        let mut ids = RsIds {
            trakt: value.trakt,
            slug: value.slug,
            tvdb: value.tvdb,
            imdb: value.imdb,
            tmdb: value.tmdb,
            other_ids: value.otherids,
            ..Default::default()
        };
        if ids.try_add(id.clone()).is_err() {
            ids.redseat = Some(id);
        }
        ids
    }
}

impl ApplyRsIds for Episode {
    fn apply_rs_ids(&mut self, ids: &RsIds) {
        if let Some(trakt) = ids.trakt {
            self.trakt = Some(trakt);
        }
        if let Some(slug) = ids.slug.as_ref() {
            self.slug = Some(slug.clone());
        }
        if let Some(tvdb) = ids.tvdb {
            self.tvdb = Some(tvdb);
        }
        if let Some(imdb) = ids.imdb.as_ref() {
            self.imdb = Some(imdb.clone());
        }
        if let Some(tmdb) = ids.tmdb {
            self.tmdb = Some(tmdb);
        }
        if let Some(other_ids) = ids.other_ids.as_ref() {
            self.otherids = Some(other_ids.clone());
        }
    }
}

#[cfg(test)]
mod tests {
    use super::Episode;
    use crate::domain::{
        other_ids::OtherIds,
        rs_ids::{ApplyRsIds, RsIds},
    };
    use serde_json::json;

    #[test]
    fn episode_otherids_serializes_as_array_and_rejects_string() {
        let episode = Episode {
            serie: "serie-1".to_string(),
            season: 1,
            number: 1,
            otherids: Some(OtherIds(vec!["tvmaze:ep-1".to_string()])),
            ..Default::default()
        };
        let value = serde_json::to_value(&episode).unwrap();
        assert_eq!(value.get("otherids"), Some(&json!(["tvmaze:ep-1"])));

        let parsed: Episode = serde_json::from_value(json!({
            "serie": "serie-1",
            "season": 1,
            "number": 1,
            "otherids": ["foo:bar"]
        }))
        .unwrap();
        assert_eq!(parsed.otherids, Some(OtherIds(vec!["foo:bar".to_string()])));

        let invalid = serde_json::from_value::<Episode>(json!({
            "serie": "serie-1",
            "season": 1,
            "number": 1,
            "otherids": "foo:bar"
        }));
        assert!(invalid.is_err());
    }

    #[test]
    fn episode_apply_rs_ids_updates_only_present_values() {
        let mut episode = Episode {
            serie: "serie".to_string(),
            season: 1,
            number: 1,
            tmdb: Some(22),
            ..Default::default()
        };
        let ids = RsIds {
            trakt: Some(55),
            tvdb: Some(66),
            imdb: Some("tt0000066".to_string()),
            slug: Some("episode-slug".to_string()),
            other_ids: Some(OtherIds(vec!["tvmaze:ep-1".to_string()])),
            ..Default::default()
        };

        episode.apply_rs_ids(&ids);

        assert_eq!(episode.trakt, Some(55));
        assert_eq!(episode.tvdb, Some(66));
        assert_eq!(episode.imdb.as_deref(), Some("tt0000066"));
        assert_eq!(episode.slug.as_deref(), Some("episode-slug"));
        assert_eq!(episode.tmdb, Some(22));
        assert_eq!(
            episode.otherids,
            Some(OtherIds(vec!["tvmaze:ep-1".to_string()]))
        );
    }
}