tmdb_api/movie/
popular.rs

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

tmdb_api/movie/
popular.rs
