tmdb_api/people/
details.rs

1use std::borrow::Cow;
2
3/// Command to get the details of a person
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::people::details::PersonDetails;
10///
11/// #[tokio::main]
12/// async fn main() {
13///     let client = Client::<ReqwestExecutor>::new("this-is-my-secret-token".into());
14///     let cmd = PersonDetails::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 PersonDetails {
24    /// ID of the person
25    pub person_id: u64,
26    /// ISO 639-1 value to display translated data for the fields that support it.
27    pub language: Option<String>,
28}
29
30impl PersonDetails {
31    pub fn new(person_id: u64) -> Self {
32        Self {
33            person_id,
34            language: None,
35        }
36    }
37
38    pub fn with_language(mut self, value: Option<String>) -> Self {
39        self.language = value;
40        self
41    }
42}
43
44impl crate::prelude::Command for PersonDetails {
45    type Output = super::Person;
46
47    fn path(&self) -> Cow<'static, str> {
48        Cow::Owned(format!("/person/{}", self.person_id))
49    }
50
51    fn params(&self) -> Vec<(&'static str, Cow<'_, str>)> {
52        if let Some(language) = self.language.as_ref() {
53            vec![("language", Cow::Borrowed(language.as_str()))]
54        } else {
55            Vec::new()
56        }
57    }
58}
59
60#[cfg(test)]
61mod tests {
62    use mockito::Matcher;
63
64    use crate::client::Client;
65    use crate::client::reqwest::ReqwestExecutor;
66    use crate::prelude::Command;
67
68    use super::PersonDetails;
69
70    #[tokio::test]
71    async fn it_works() {
72        let mut server = mockito::Server::new_async().await;
73        let client = Client::<ReqwestExecutor>::builder()
74            .with_api_key("secret".into())
75            .with_base_url(server.url())
76            .build()
77            .unwrap();
78
79        let _m = server
80            .mock("GET", "/person/287")
81            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
82            .with_status(200)
83            .with_header("content-type", "application/json")
84            .with_body(include_str!("../../assets/person-details.json"))
85            .create_async()
86            .await;
87
88        let result = PersonDetails::new(287).execute(&client).await.unwrap();
89        assert_eq!(result.inner.id, 287);
90    }
91
92    #[tokio::test]
93    async fn invalid_api_key() {
94        let mut server = mockito::Server::new_async().await;
95        let client = Client::<ReqwestExecutor>::builder()
96            .with_api_key("secret".into())
97            .with_base_url(server.url())
98            .build()
99            .unwrap();
100
101        let _m = server
102            .mock("GET", "/person/287")
103            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
104            .with_status(401)
105            .with_header("content-type", "application/json")
106            .with_body(include_str!("../../assets/invalid-api-key.json"))
107            .create_async()
108            .await;
109
110        let err = PersonDetails::new(287).execute(&client).await.unwrap_err();
111        let server_err = err.as_server_error().unwrap();
112        assert_eq!(server_err.status_code, 7);
113    }
114
115    #[tokio::test]
116    async fn resource_not_found() {
117        let mut server = mockito::Server::new_async().await;
118        let client = Client::<ReqwestExecutor>::builder()
119            .with_api_key("secret".into())
120            .with_base_url(server.url())
121            .build()
122            .unwrap();
123
124        let _m = server
125            .mock("GET", "/person/287")
126            .match_query(Matcher::UrlEncoded("api_key".into(), "secret".into()))
127            .with_status(404)
128            .with_header("content-type", "application/json")
129            .with_body(include_str!("../../assets/resource-not-found.json"))
130            .create_async()
131            .await;
132
133        let err = PersonDetails::new(287).execute(&client).await.unwrap_err();
134        let server_err = err.as_server_error().unwrap();
135        assert_eq!(server_err.status_code, 34);
136    }
137}
138
139#[cfg(all(test, feature = "integration"))]
140mod integration_tests {
141    use crate::client::Client;
142    use crate::client::reqwest::ReqwestExecutor;
143    use crate::prelude::Command;
144
145    use super::PersonDetails;
146
147    #[tokio::test]
148    async fn execute() {
149        let secret = std::env::var("TMDB_TOKEN_V3").unwrap();
150        let client = Client::<ReqwestExecutor>::new(secret);
151
152        for id in [287, 4017570] {
153            let result = PersonDetails::new(id).execute(&client).await.unwrap();
154            assert_eq!(result.inner.id, id);
155        }
156    }
157}