tmdb_api/tvshow/
images.rs

1use std::borrow::Cow;
2
3use crate::common::image::Image;
4
5/// Get the images that belong to a show.
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::images::TVShowImages;
12///
13/// #[tokio::main]
14/// async fn main() {
15///     let client = Client::<ReqwestExecutor>::new("this-is-my-secret-token".into());
16///     let cmd = TVShowImages::new(1);
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 TVShowImages {
26    /// ID of the show
27    pub tvshow_id: u64,
28    /// ISO 639-1 value to display translated data for the fields that support it.
29    pub language: Option<String>,
30}
31
32impl TVShowImages {
33    pub fn new(tvshow_id: u64) -> Self {
34        Self {
35            tvshow_id,
36            language: None,
37        }
38    }
39
40    pub fn with_language(mut self, value: Option<String>) -> Self {
41        self.language = value;
42        self
43    }
44}
45
46#[derive(Debug, Deserialize, Serialize)]
47pub struct TVShowImagesResult {
48    pub id: u64,
49    pub backdrops: Vec<Image>,
50    pub posters: Vec<Image>,
51    pub logos: Vec<Image>,
52}
53
54impl crate::prelude::Command for TVShowImages {
55    type Output = TVShowImagesResult;
56
57    fn path(&self) -> Cow<'static, str> {
58        Cow::Owned(format!("/tv/{}/images", self.tvshow_id))
59    }
60
61    fn params(&self) -> Vec<(&'static str, Cow<'_, str>)> {
62        if let Some(ref language) = self.language {
63            vec![("language", Cow::Borrowed(language))]
64        } else {
65            Vec::new()
66        }
67    }
68}
69
70#[cfg(test)]
71mod tests {
72    use super::TVShowImages;
73    use crate::client::Client;
74    use crate::client::reqwest::ReqwestExecutor;
75    use crate::prelude::Command;
76    use mockito::Matcher;
77
78    #[tokio::test]
79    async fn it_works() {
80        let mut server = mockito::Server::new_async().await;
81        let client = Client::<ReqwestExecutor>::builder()
82            .with_api_key("secret".into())
83            .with_base_url(server.url())
84            .build()
85            .unwrap();
86
87        let cmd = TVShowImages::new(550);
88
89        let _m = server
90            .mock("GET", "/tv/550/images")
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/tv-images.json"))
95            .create_async()
96            .await;
97        let result = cmd.execute(&client).await.unwrap();
98        assert_eq!(result.id, 550);
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 cmd = TVShowImages::new(42);
111
112        let _m = server
113            .mock("GET", "/tv/42/images")
114            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
115            .with_status(401)
116            .with_header("content-type", "application/json")
117            .with_body(include_str!("../../assets/invalid-api-key.json"))
118            .create_async()
119            .await;
120        let err = cmd.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 cmd = TVShowImages::new(42);
135
136        let _m = server
137            .mock("GET", "/tv/42/images")
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        let err = cmd.execute(&client).await.unwrap_err();
145        let server_err = err.as_server_error().unwrap();
146        assert_eq!(server_err.status_code, 34);
147    }
148}
149
150#[cfg(all(test, feature = "integration"))]
151mod integration_tests {
152    use super::TVShowImages;
153    use crate::client::Client;
154    use crate::client::reqwest::ReqwestExecutor;
155    use crate::prelude::Command;
156
157    #[tokio::test]
158    async fn execute() {
159        let secret = std::env::var("TMDB_TOKEN_V3").unwrap();
160        let client = Client::<ReqwestExecutor>::new(secret);
161        let cmd = TVShowImages::new(550);
162
163        let result = cmd.execute(&client).await.unwrap();
164        assert_eq!(result.id, 550);
165    }
166}