tmdb_api/tvshow/
similar.rs

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

tmdb_api/tvshow/
similar.rs
