tmdb_api/movie/
search.rs

1use std::borrow::Cow;
2
3const PATH: &str = "/search/movie";
4
5/// Command to search for movies
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::movie::search::MovieSearch;
12///
13/// #[tokio::main]
14/// async fn main() {
15///     let client = Client::<ReqwestExecutor>::new("this-is-my-secret-token".into());
16///     let cmd = MovieSearch::new("die hard".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 MovieSearch {
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    /// ISO 3166-1 code to filter release region. Must be uppercase.
35    pub region: Option<String>,
36    pub year: Option<u16>,
37    pub primary_release_year: Option<u16>,
38}
39
40impl MovieSearch {
41    pub fn new(query: String) -> Self {
42        Self {
43            query,
44            language: None,
45            page: None,
46            include_adult: false,
47            region: None,
48            year: None,
49            primary_release_year: None,
50        }
51    }
52
53    pub fn with_language(mut self, value: Option<String>) -> Self {
54        self.language = value;
55        self
56    }
57
58    pub fn with_page(mut self, value: Option<u32>) -> Self {
59        self.page = value;
60        self
61    }
62
63    pub fn with_include_adult(mut self, value: bool) -> Self {
64        self.include_adult = value;
65        self
66    }
67
68    pub fn with_region(mut self, value: Option<String>) -> Self {
69        self.region = value;
70        self
71    }
72
73    pub fn with_year(mut self, value: Option<u16>) -> Self {
74        self.year = value;
75        self
76    }
77
78    pub fn with_primary_release_year(mut self, value: Option<u16>) -> Self {
79        self.primary_release_year = value;
80        self
81    }
82}
83
84impl crate::prelude::Command for MovieSearch {
85    type Output = crate::common::PaginatedResult<super::MovieShort>;
86
87    fn path(&self) -> Cow<'static, str> {
88        Cow::Borrowed(PATH)
89    }
90
91    fn params(&self) -> Vec<(&'static str, Cow<'_, str>)> {
92        let mut res = vec![("query", Cow::Borrowed(self.query.as_str()))];
93
94        if let Some(language) = self.language.as_ref() {
95            res.push(("language", Cow::Borrowed(language.as_str())));
96        }
97        if let Some(page) = self.page {
98            res.push(("page", Cow::Owned(page.to_string())));
99        }
100        if self.include_adult {
101            res.push(("include_adult", Cow::Borrowed("true")));
102        }
103        if let Some(region) = self.region.as_ref() {
104            res.push(("region", Cow::Borrowed(region.as_str())));
105        }
106        if let Some(year) = self.year {
107            res.push(("year", Cow::Owned(year.to_string())));
108        }
109        if let Some(primary_release_year) = self.primary_release_year {
110            res.push((
111                "primary_release_year",
112                Cow::Owned(primary_release_year.to_string()),
113            ));
114        }
115
116        res
117    }
118}
119
120#[cfg(test)]
121mod tests {
122    use super::MovieSearch;
123    use crate::client::Client;
124    use crate::client::reqwest::ReqwestExecutor;
125    use crate::prelude::Command;
126    use mockito::Matcher;
127
128    #[tokio::test]
129    async fn it_works() {
130        let mut server = mockito::Server::new_async().await;
131        let client = Client::<ReqwestExecutor>::builder()
132            .with_api_key("secret".into())
133            .with_base_url(server.url())
134            .build()
135            .unwrap();
136
137        let cmd = MovieSearch::new("Whatever".into());
138
139        let _m = server
140            .mock("GET", super::PATH)
141            .match_query(Matcher::AllOf(vec![
142                Matcher::UrlEncoded("api_key".into(), "secret".into()),
143                Matcher::UrlEncoded("query".into(), "Whatever".into()),
144            ]))
145            .with_status(200)
146            .with_header("content-type", "application/json")
147            .with_body(include_str!("../../assets/search-movie.json"))
148            .create_async()
149            .await;
150        let result = cmd.execute(&client).await.unwrap();
151        assert_eq!(result.page, 1);
152        assert!(!result.results.is_empty());
153        assert!(result.total_pages > 0);
154        assert!(result.total_results > 0);
155        let item = result.results.first().unwrap();
156        assert_eq!(item.inner.title, "RRRrrrr!!!");
157    }
158
159    #[tokio::test]
160    async fn invalid_api_key() {
161        let mut server = mockito::Server::new_async().await;
162        let client = Client::<ReqwestExecutor>::builder()
163            .with_api_key("secret".into())
164            .with_base_url(server.url())
165            .build()
166            .unwrap();
167
168        let cmd = MovieSearch::new("Whatever".into());
169
170        let _m = server
171            .mock("GET", super::PATH)
172            .match_query(Matcher::AllOf(vec![
173                Matcher::UrlEncoded("api_key".into(), "secret".into()),
174                Matcher::UrlEncoded("query".into(), "Whatever".into()),
175            ]))
176            .with_status(401)
177            .with_header("content-type", "application/json")
178            .with_body(include_str!("../../assets/invalid-api-key.json"))
179            .create_async()
180            .await;
181        let err = cmd.execute(&client).await.unwrap_err();
182        let server_err = err.as_server_error().unwrap();
183        assert_eq!(server_err.status_code, 7);
184    }
185
186    #[tokio::test]
187    async fn resource_not_found() {
188        let mut server = mockito::Server::new_async().await;
189        let client = Client::<ReqwestExecutor>::builder()
190            .with_api_key("secret".into())
191            .with_base_url(server.url())
192            .build()
193            .unwrap();
194
195        let cmd = MovieSearch::new("Whatever".into());
196
197        let _m = server
198            .mock("GET", super::PATH)
199            .match_query(Matcher::AllOf(vec![
200                Matcher::UrlEncoded("api_key".into(), "secret".into()),
201                Matcher::UrlEncoded("query".into(), "Whatever".into()),
202            ]))
203            .with_status(404)
204            .with_header("content-type", "application/json")
205            .with_body(include_str!("../../assets/resource-not-found.json"))
206            .create_async()
207            .await;
208        let err = cmd.execute(&client).await.unwrap_err();
209        let server_err = err.as_server_error().unwrap();
210        assert_eq!(server_err.status_code, 34);
211    }
212
213    #[tokio::test]
214    async fn validation_error() {
215        let mut server = mockito::Server::new_async().await;
216        let client = Client::<ReqwestExecutor>::builder()
217            .with_api_key("secret".into())
218            .with_base_url(server.url())
219            .build()
220            .unwrap();
221
222        let cmd = MovieSearch::new("".into());
223
224        let _m = server
225            .mock("GET", super::PATH)
226            .match_query(Matcher::AllOf(vec![
227                Matcher::UrlEncoded("api_key".into(), "secret".into()),
228                Matcher::UrlEncoded("query".into(), "".into()),
229            ]))
230            .with_status(422)
231            .with_header("content-type", "application/json")
232            .with_body(include_str!("../../assets/validation-error.json"))
233            .create_async()
234            .await;
235        let err = cmd.execute(&client).await.unwrap_err();
236        let validation_err = err.as_validation_error().unwrap();
237        assert_eq!(validation_err.errors.len(), 1);
238    }
239
240    // #[tokio::test]
241    // async fn premature_end_of_line() {
242    // let mut server = mockito::Server::new_async().await;
243    // let client = Client::<ReqwestExecutor>::builder().with_api_key("secret".into()).with_base_url(server.url()).build().unwrap();
244
245    //     let client = Client::<ReqwestExecutor>::new("secret".into()).with_base_url(mockito::server_url());
246    //     let cmd = MovieSearch::new("game of thrones".into());
247
248    //     let _m = mock("GET", super::PATH)
249    //         .match_query(Matcher::AllOf(vec![
250    //             Matcher::UrlEncoded("api_key".into(), "secret".into()),
251    //             Matcher::UrlEncoded("query".into(), "game of thrones".into()),
252    //         ]))
253    //         .with_status(200)
254    //         .with_header("content-type", "application/json;charset=utf-8")
255    //         .with_body(include_str!("../../assets/search-tv-decoding-error.json"))
256    //         .create_async().await;
257    //     let result = cmd.execute(&client).await.unwrap();
258    //     assert_eq!(result.page, 1);
259    // }
260}
261
262#[cfg(all(test, feature = "integration"))]
263mod integration_tests {
264    use super::MovieSearch;
265    use crate::client::Client;
266    use crate::client::reqwest::ReqwestExecutor;
267    use crate::prelude::Command;
268
269    #[tokio::test]
270    async fn search_rrrrrrr() {
271        let secret = std::env::var("TMDB_TOKEN_V3").unwrap();
272        let client = Client::<ReqwestExecutor>::new(secret);
273        let cmd = MovieSearch::new("Rrrrrrr".into());
274
275        let result = cmd.execute(&client).await.unwrap();
276        assert_eq!(result.page, 1);
277        assert_eq!(result.results.len(), 1);
278        assert_eq!(result.total_pages, 1);
279        assert_eq!(result.total_results, 1);
280        let item = result.results.first().unwrap();
281        assert_eq!(item.inner.title, "RRRrrrr!!!");
282    }
283
284    #[tokio::test]
285    async fn search_simpsons() {
286        let secret = std::env::var("TMDB_TOKEN_V3").unwrap();
287        let client = Client::<ReqwestExecutor>::new(secret);
288        let cmd = MovieSearch::new("simpsons".into());
289
290        let _result = cmd.execute(&client).await.unwrap();
291    }
292}
tmdb_api/movie/search.rs

tmdb_api/movie/
search.rs
