simkl 0.1.0

Library to build queries for SIMKL and decoding JSON responses using Serde
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

use crate::{API_URL, Extended, anime::AnimeGenre, movie::MovieGenre, show::TvGenre};

pub struct FindByFilePayload {
    // Try to find the file from the filename, example:
    /// `Were.The.Fugawis.S01E01E02.WS.DSR.x264-NY2.mkv`
    pub file: String,
    /// Some filenames consist of 2 or more parts. If you want to get info about second part for example you can pass 2 to this parameter
    pub part: Option<u8>,
}

/// Find by file URL, use `FindByFilePayload` with this
pub const FIND_BY_FILE_URL: &str = "https://api.simkl.com/search/file";

/// Struct used to build the payload of a search by ID
#[derive(Default, Debug, Clone, PartialEq)]
pub struct IdLookup {
    pub simkl: Option<u32>,
    pub hulu: Option<u32>,
    pub netflix: Option<u32>,
    pub mal: Option<u32>,
    pub tvdb: Option<u32>,
    pub tmdb: Option<u32>,
    pub imdb: Option<String>,
    pub anidb: Option<u32>,
    pub crunchyroll: Option<u32>,
    pub anilist: Option<u32>,
    pub kitsu: Option<u32>,
    pub livechart: Option<u32>,
    pub anisearch: Option<u32>,
    pub animeplanet: Option<u32>,
    pub traktslug: Option<String>,
    pub letterboxd: Option<String>,
    /// Possible values are: show, movie
    pub r#type: Option<String>,
    /// TV show, anime, or movie title. If this title has more then 1 item then null will be returned, add more fields
    /// to narrow down the search to 1 item(such as type,year etc.). Example: `The Walking Dead`.
    pub title: Option<String>,
    pub year: Option<u16>,
}

pub fn get_search_by_id_request(payload: IdLookup, client_id: String) -> String {
    let mut result = String::from(API_URL);
    result.push_str("/search/id?client_id=");
    result.push_str(&client_id);
    if let Some(id) = payload.simkl {
        result.push_str("&simkl=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.hulu {
        result.push_str("&hulu=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.netflix {
        result.push_str("&netflix=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.mal {
        result.push_str("&mal=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.tvdb {
        result.push_str("&tvdb=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.tmdb {
        result.push_str("&tmdb=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.imdb {
        result.push_str("&imdb=");
        result.push_str(&id);
    }
    if let Some(id) = payload.anidb {
        result.push_str("&anidb=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.crunchyroll {
        result.push_str("&crunchyroll=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.anilist {
        result.push_str("&anilist=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.kitsu {
        result.push_str("&kitsu=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.livechart {
        result.push_str("&livechart=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.anisearch {
        result.push_str("&anisearch=");
        result.push_str(&id.to_string());
    }
    if let Some(id) = payload.animeplanet {
        result.push_str("&animeplanet=");
        result.push_str(&id.to_string());
    }
    if let Some(ref slug) = payload.traktslug {
        result.push_str("&traktslug=");
        result.push_str(slug);
    }
    if let Some(ref slug) = payload.letterboxd {
        result.push_str("&letterboxd=");
        result.push_str(slug);
    }
    if let Some(t) = payload.r#type {
        result.push_str("&type=");
        result.push_str(&t);
    }
    if let Some(t) = payload.title {
        result.push_str("&title=");
        result.push_str(&t);
    }
    if let Some(y) = payload.year {
        result.push_str("&year=");
        result.push_str(&y.to_string());
    }
    result
}

/// Search items by title, sorted by relevance (what people search most). This method will respond with
/// `StandardMediaObject` + additional fields if `extended` parameter passed.
///
/// For `movies` or `anime` with movie type, tmdb id points to the movies section on TMDB site, otherwise to the TV
/// section.
///
/// Items with `endpoint_type = anime` has additional anime `type` key, see possible values for the `anime_type` key in
/// `StandardMediaObject`.
///
/// Page limit is 20, max items per page is 50.
pub fn get_search_request(
    // Possible values are `tv`, `anime` or `movie`
    r#type: Option<String>,
    _extended: Option<Extended>,
    client_id: String,
    // A search term or a URL pointing to media.
    //
    // When using URLs, type can be any, not required to be correct one.
    //
    // Type is required for text keywords.
    //
    // Examples: `john wick`, `john wick 2014`, `https://www.imdb.com/title/tt2911666/`, `https://letterboxd.com/film/john-wick/`
    q: String,
) -> String {
    let mut result = String::from(API_URL);
    result.push_str("/search/");
    if let Some(ref t) = r#type {
        result.push_str(t);
    }
    result.push_str("?client_id=");
    result.push_str(&client_id);
    result.push_str("&q=");
    result.push_str(&q);
    result
}

pub struct FindRandomPayload {
    pub service: String,
    pub r#type: crate::MediaType, // tv , anime , movie
    pub movie_genre: MovieGenre,
    pub tv_genre: TvGenre,
    pub anime_genre: AnimeGenre,
    /// Max value is 10. Random search for TV Shows and Movies will be performed using IMDB ratings. Anime are based on
    /// MAL ratings.
    ///
    /// Example: `5`. Default: `1`.
    pub rating_from: u8,
    /// Example: `10`
    pub rating_to: u8,
    /// Maximum rank allowed. Example: `2000`.
    pub rank_limit: u32,
    pub year_from: Option<u16>,
    pub year_to: Option<u16>,
    pub limit: u16,
}

impl FindRandomPayload {
    pub fn to_url_param(&self) -> String {
        let mut result = String::new();
        result.push_str("&service=");
        result.push_str(&self.service);
        // Spec type values for random search are "tv", "anime", "movie"
        result.push_str("&type=");
        result.push_str(match self.r#type {
            crate::MediaType::Movie => "movie",
            crate::MediaType::Show => "tv",
            crate::MediaType::Anime => "anime",
            // Random search does not support episode-level filtering; fall back to tv.
            crate::MediaType::Episode => "tv",
        });
        // Append genre based on the media type.
        result.push_str("&genre=");
        result.push_str(match self.r#type {
            crate::MediaType::Movie => self.movie_genre.as_str(),
            crate::MediaType::Anime => self.anime_genre.as_str(),
            crate::MediaType::Show | crate::MediaType::Episode => self.tv_genre.as_str(),
        });

        if let Some(y) = self.year_from {
            result.push_str("&year_from=");
            result.push_str(&y.to_string());
        }
        if let Some(y) = self.year_to {
            result.push_str("&year_to=");
            result.push_str(&y.to_string());
        }
        result.push_str("&rating_from=");
        result.push_str(&self.rating_from.to_string());
        result.push_str("&rating_to=");
        result.push_str(&self.rating_to.to_string());
        result.push_str("&rank_limit=");
        result.push_str(&self.rank_limit.to_string());
        result.push_str("&limit=");
        result.push_str(&self.limit.to_string());
        result
    }
}

/// if you want to find random item based on your filters. If Token is passed, wacthed items will be excluded.
///
/// Examples:
/// * `https://api.simkl.com/search/random?service=simkl&type=tv&genre=comedy&rating_from=5&rating_to=10&year_from=2004&year_to=2010&limit=10&client_id=***`
/// * `https://api.simkl.com/search/random/netflix/?rating_from=5&rating_to=10&year_from=2008&year_to=2015&genre=science-fiction&client_id=***`
/// * `https://api.simkl.com/search/random/?rating_from=5&rating_to=10&year_from=2008&year_to=2015&genre=science-fiction&client_id=***`
pub fn get_find_random_request(payload: FindRandomPayload, client_id: String) -> String {
    let mut result = String::from(API_URL);
    result.push_str("/search/random/?client_id=");
    result.push_str(&client_id);
    // result.push('&');
    result.push_str(&payload.to_url_param());
    result
}

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

    #[test]
    fn test_id_request() {
        let payload = IdLookup {
            simkl: Some(123),
            ..Default::default()
        };
        let client_id = String::from("azerty123456");
        assert_eq!(
            get_search_by_id_request(payload.clone(), client_id),
            "https://api.simkl.com/search/id?client_id=azerty123456&simkl=123"
        );
    }
}