tmdb_api/movie/
popular.rs

1use std::borrow::Cow;
2
3use crate::common::PaginatedResult;
4
5/// Get a list of the current popular movies on TMDB. This list updates daily.
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::popular::MoviePopular;
12///
13/// #[tokio::main]
14/// async fn main() {
15///     let client = Client::<ReqwestExecutor>::new("this-is-my-secret-token".into());
16///     let result = MoviePopular::default().execute(&client).await;
17///     match result {
18///         Ok(res) => println!("found: {:#?}", res),
19///         Err(err) => eprintln!("error: {:?}", err),
20///     };
21/// }
22/// ```
23#[derive(Clone, Debug, Default)]
24pub struct MoviePopular {
25    /// ISO 639-1 value to display translated data for the fields that support it.
26    pub language: Option<String>,
27    /// Specify which page to query.
28    pub page: Option<u32>,
29    /// Specify a ISO 3166-1 code to filter release dates. Must be uppercase.
30    pub region: Option<String>,
31}
32
33impl MoviePopular {
34    pub fn with_language(mut self, value: Option<String>) -> Self {
35        self.language = value;
36        self
37    }
38
39    pub fn with_page(mut self, value: Option<u32>) -> Self {
40        self.page = value;
41        self
42    }
43
44    pub fn with_region(mut self, value: Option<String>) -> Self {
45        self.region = value;
46        self
47    }
48}
49
50impl crate::prelude::Command for MoviePopular {
51    type Output = PaginatedResult<super::MovieShort>;
52
53    fn path(&self) -> Cow<'static, str> {
54        Cow::Borrowed("/movie/popular")
55    }
56
57    fn params(&self) -> Vec<(&'static str, Cow<'_, str>)> {
58        let mut res = Vec::new();
59        if let Some(ref language) = self.language {
60            res.push(("language", Cow::Borrowed(language.as_str())))
61        }
62        if let Some(ref page) = self.page {
63            res.push(("page", Cow::Owned(page.to_string())))
64        }
65        if let Some(ref region) = self.region {
66            res.push(("region", Cow::Borrowed(region.as_str())))
67        }
68        res
69    }
70}
71
72#[cfg(test)]
73mod tests {
74    use super::MoviePopular;
75    use crate::client::Client;
76    use crate::client::reqwest::ReqwestExecutor;
77    use crate::prelude::Command;
78    use mockito::Matcher;
79
80    #[tokio::test]
81    async fn it_works() {
82        let mut server = mockito::Server::new_async().await;
83        let client = Client::<ReqwestExecutor>::builder()
84            .with_api_key("secret".into())
85            .with_base_url(server.url())
86            .build()
87            .unwrap();
88
89        let _m = server
90            .mock("GET", "/movie/popular")
91            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
92            .with_status(200)
93            .with_header("content-type", "application/json")
94            .with_body(include_str!("../../assets/movie-popular.json"))
95            .create_async()
96            .await;
97
98        let result = MoviePopular::default().execute(&client).await.unwrap();
99        assert_eq!(result.page, 1);
100    }
101
102    #[tokio::test]
103    async fn invalid_api_key() {
104        let mut server = mockito::Server::new_async().await;
105        let client = Client::<ReqwestExecutor>::builder()
106            .with_api_key("secret".into())
107            .with_base_url(server.url())
108            .build()
109            .unwrap();
110
111        let _m = server
112            .mock("GET", "/movie/popular")
113            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
114            .with_status(401)
115            .with_header("content-type", "application/json")
116            .with_body(include_str!("../../assets/invalid-api-key.json"))
117            .create_async()
118            .await;
119
120        let err = MoviePopular::default().execute(&client).await.unwrap_err();
121        let server_err = err.as_server_error().unwrap();
122        assert_eq!(server_err.status_code, 7);
123    }
124
125    #[tokio::test]
126    async fn resource_not_found() {
127        let mut server = mockito::Server::new_async().await;
128        let client = Client::<ReqwestExecutor>::builder()
129            .with_api_key("secret".into())
130            .with_base_url(server.url())
131            .build()
132            .unwrap();
133
134        let _m = server
135            .mock("GET", "/movie/popular")
136            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
137            .with_status(404)
138            .with_header("content-type", "application/json")
139            .with_body(include_str!("../../assets/resource-not-found.json"))
140            .create_async()
141            .await;
142
143        let err = MoviePopular::default().execute(&client).await.unwrap_err();
144        let server_err = err.as_server_error().unwrap();
145        assert_eq!(server_err.status_code, 34);
146    }
147}
148
149#[cfg(all(test, feature = "integration"))]
150mod integration_tests {
151    use super::MoviePopular;
152    use crate::client::Client;
153    use crate::client::reqwest::ReqwestExecutor;
154    use crate::prelude::Command;
155
156    #[tokio::test]
157    async fn execute() {
158        let secret = std::env::var("TMDB_TOKEN_V3").unwrap();
159        let client = Client::<ReqwestExecutor>::new(secret);
160
161        let _result = MoviePopular::default().execute(&client).await.unwrap();
162    }
163}
tmdb_api/movie/popular.rs

tmdb_api/movie/
popular.rs
