tmdb_api/tvshow/
search.rs

1use std::borrow::Cow;
2
3const PATH: &str = "/search/tv";
4
5/// Command to search for tvshows
6///
7/// ```rust
8/// use tmdb_api::prelude::Command;
9/// use tmdb_api::client::Client;
10/// use tmdb_api::client::reqwest::ReqwestExecutor;
11/// use tmdb_api::tvshow::search::TVShowSearch;
12///
13/// #[tokio::main]
14/// async fn main() {
15///     let client = Client::<ReqwestExecutor>::new("this-is-my-secret-token".into());
16///     let cmd = TVShowSearch::new("simpsons".into());
17///     let result = cmd.execute(&client).await;
18///     match result {
19///         Ok(res) => println!("found: {:#?}", res),
20///         Err(err) => eprintln!("error: {:?}", err),
21///     };
22/// }
23/// ```
24#[derive(Clone, Debug, Default)]
25pub struct TVShowSearch {
26    /// Text query to search.
27    pub query: String,
28    /// ISO 639-1 value to display translated data for the fields that support it.
29    pub language: Option<String>,
30    /// Which page to query.
31    pub page: Option<u32>,
32    /// Whether to include adult (pornography) content in the results.
33    pub include_adult: bool,
34    pub first_air_date_year: Option<u16>,
35}
36
37impl TVShowSearch {
38    pub fn new(query: String) -> Self {
39        Self {
40            query,
41            language: None,
42            page: None,
43            include_adult: false,
44            first_air_date_year: None,
45        }
46    }
47
48    pub fn with_language(mut self, value: Option<String>) -> Self {
49        self.language = value;
50        self
51    }
52
53    pub fn with_page(mut self, value: Option<u32>) -> Self {
54        self.page = value;
55        self
56    }
57
58    pub fn with_include_adult(mut self, value: bool) -> Self {
59        self.include_adult = value;
60        self
61    }
62
63    pub fn with_first_air_date_year(mut self, value: Option<u16>) -> Self {
64        self.first_air_date_year = value;
65        self
66    }
67}
68
69impl crate::prelude::Command for TVShowSearch {
70    type Output = crate::common::PaginatedResult<super::TVShowShort>;
71
72    fn path(&self) -> Cow<'static, str> {
73        Cow::Borrowed(PATH)
74    }
75
76    fn params(&self) -> Vec<(&'static str, Cow<'_, str>)> {
77        let mut res = vec![("query", Cow::Borrowed(self.query.as_str()))];
78
79        if let Some(language) = self.language.as_ref() {
80            res.push(("language", Cow::Borrowed(language.as_str())));
81        }
82        if let Some(page) = self.page {
83            res.push(("page", Cow::Owned(page.to_string())));
84        }
85        if self.include_adult {
86            res.push(("include_adult", Cow::Borrowed("true")));
87        }
88        if let Some(first_air_date_year) = self.first_air_date_year {
89            res.push((
90                "first_air_date_year",
91                Cow::Owned(first_air_date_year.to_string()),
92            ));
93        }
94
95        res
96    }
97}
98
99#[cfg(test)]
100mod tests {
101    use super::TVShowSearch;
102    use crate::client::Client;
103    use crate::client::reqwest::ReqwestExecutor;
104    use crate::prelude::Command;
105    use mockito::Matcher;
106
107    #[tokio::test]
108    async fn it_works() {
109        let mut server = mockito::Server::new_async().await;
110        let client = Client::<ReqwestExecutor>::builder()
111            .with_api_key("secret".into())
112            .with_base_url(server.url())
113            .build()
114            .unwrap();
115
116        let cmd = TVShowSearch::new("Whatever".into());
117
118        let _m = server
119            .mock("GET", super::PATH)
120            .match_query(Matcher::AllOf(vec![
121                Matcher::UrlEncoded("api_key".into(), "secret".into()),
122                Matcher::UrlEncoded("query".into(), "Whatever".into()),
123            ]))
124            .with_status(200)
125            .with_header("content-type", "application/json")
126            .with_body(include_str!("../../assets/search-tv.json"))
127            .create_async()
128            .await;
129        let result = cmd.execute(&client).await.unwrap();
130        assert_eq!(result.page, 1);
131        assert!(!result.results.is_empty());
132        assert!(result.total_pages > 0);
133        assert!(result.total_results > 0);
134        let item = result.results.first().unwrap();
135        assert_eq!(item.inner.name, "Game of Thrones");
136    }
137
138    /// Refering to issue https://github.com/jdrouet/tmdb-api/issues/25
139    #[tokio::test]
140    async fn fix_issue_25() {
141        let mut server = mockito::Server::new_async().await;
142        let client = Client::<ReqwestExecutor>::builder()
143            .with_api_key("secret".into())
144            .with_base_url(server.url())
145            .build()
146            .unwrap();
147
148        let cmd = TVShowSearch::new("rick and morty".into());
149
150        let _m = server
151            .mock("GET", super::PATH)
152            .match_query(Matcher::AllOf(vec![
153                Matcher::UrlEncoded("api_key".into(), "secret".into()),
154                Matcher::UrlEncoded("query".into(), "rick and morty".into()),
155            ]))
156            .with_status(200)
157            .with_header("content-type", "application/json")
158            .with_body(include_str!("../../assets/search-tv-rick-and-morty.json"))
159            .create_async()
160            .await;
161        let result = cmd.execute(&client).await.unwrap();
162        assert_eq!(result.page, 1);
163        assert_eq!(result.total_pages, 1);
164        assert_eq!(result.total_results, 2);
165        let item = result.results.first().unwrap();
166        assert_eq!(item.inner.name, "Rick and Morty");
167    }
168
169    #[tokio::test]
170    async fn invalid_api_key() {
171        let mut server = mockito::Server::new_async().await;
172        let client = Client::<ReqwestExecutor>::builder()
173            .with_api_key("secret".into())
174            .with_base_url(server.url())
175            .build()
176            .unwrap();
177
178        let cmd = TVShowSearch::new("Whatever".into());
179
180        let _m = server
181            .mock("GET", super::PATH)
182            .match_query(Matcher::AllOf(vec![
183                Matcher::UrlEncoded("api_key".into(), "secret".into()),
184                Matcher::UrlEncoded("query".into(), "Whatever".into()),
185            ]))
186            .with_status(401)
187            .with_header("content-type", "application/json")
188            .with_body(include_str!("../../assets/invalid-api-key.json"))
189            .create_async()
190            .await;
191        let err = cmd.execute(&client).await.unwrap_err();
192        let server_err = err.as_server_error().unwrap();
193        assert_eq!(server_err.status_code, 7);
194    }
195
196    #[tokio::test]
197    async fn resource_not_found() {
198        let mut server = mockito::Server::new_async().await;
199        let client = Client::<ReqwestExecutor>::builder()
200            .with_api_key("secret".into())
201            .with_base_url(server.url())
202            .build()
203            .unwrap();
204
205        let cmd = TVShowSearch::new("Whatever".into());
206
207        let _m = server
208            .mock("GET", super::PATH)
209            .match_query(Matcher::AllOf(vec![
210                Matcher::UrlEncoded("api_key".into(), "secret".into()),
211                Matcher::UrlEncoded("query".into(), "Whatever".into()),
212            ]))
213            .with_status(404)
214            .with_header("content-type", "application/json")
215            .with_body(include_str!("../../assets/resource-not-found.json"))
216            .create_async()
217            .await;
218        let err = cmd.execute(&client).await.unwrap_err();
219        let server_err = err.as_server_error().unwrap();
220        assert_eq!(server_err.status_code, 34);
221    }
222}
223
224#[cfg(all(test, feature = "integration"))]
225mod integration_tests {
226    use super::TVShowSearch;
227    use crate::client::Client;
228    use crate::client::reqwest::ReqwestExecutor;
229    use crate::prelude::Command;
230
231    #[tokio::test]
232    async fn search_simpsons() {
233        let secret = std::env::var("TMDB_TOKEN_V3").unwrap();
234        let client = Client::<ReqwestExecutor>::new(secret);
235        let cmd = TVShowSearch::new("simpsons".into());
236
237        let result = cmd.execute(&client).await.unwrap();
238        assert_eq!(result.page, 1);
239        assert!(result.results.len() > 1);
240        assert!(result.total_pages > 0);
241        assert!(result.total_results > 1);
242        let item = result.results.first().unwrap();
243        assert_eq!(item.inner.name, "The Simpsons");
244    }
245}
tmdb_api/tvshow/search.rs

tmdb_api/tvshow/
search.rs
