redmine_api/api/
my_account.rs

1//! My Account Rest API Endpoint definitions
2//!
3//! [Redmine Documentation](https://www.redmine.org/projects/redmine/wiki/Rest_MyAccount)
4//!
5//! - [x] my account endpoint
6
7use derive_builder::Builder;
8use reqwest::Method;
9use std::borrow::Cow;
10
11use crate::api::custom_fields::CustomFieldEssentialsWithValue;
12use crate::api::{Endpoint, ReturnsJsonResponse};
13
14/// a type for my account to use as an API return type
15///
16/// alternatively you can use your own type limited to the fields you need
17#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
18pub struct MyAccount {
19    /// numeric id
20    pub id: u64,
21    /// login name
22    pub login: String,
23    /// is this user an admin
24    pub admin: bool,
25    /// user's firstname
26    pub firstname: String,
27    /// user's lastname
28    pub lastname: String,
29    /// primary email of the user
30    #[serde(default, skip_serializing_if = "Option::is_none")]
31    pub mail: Option<String>,
32    /// The time when this user was created
33    #[serde(
34        serialize_with = "crate::api::serialize_rfc3339",
35        deserialize_with = "crate::api::deserialize_rfc3339"
36    )]
37    pub created_on: time::OffsetDateTime,
38    /// the time when this user last logged in
39    #[serde(
40        serialize_with = "crate::api::serialize_optional_rfc3339",
41        deserialize_with = "crate::api::deserialize_optional_rfc3339"
42    )]
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub last_login_on: Option<time::OffsetDateTime>,
45    /// the user's API key
46    pub api_key: String,
47    /// custom fields with values
48    #[serde(default, skip_serializing_if = "Option::is_none")]
49    pub custom_fields: Option<Vec<CustomFieldEssentialsWithValue>>,
50}
51
52/// The endpoint to retrieve the current user's my account settings/data
53#[derive(Debug, Clone, Builder)]
54#[builder(setter(strip_option))]
55pub struct GetMyAccount {}
56
57impl ReturnsJsonResponse for GetMyAccount {}
58
59impl GetMyAccount {
60    /// Create a builder for the endpoint.
61    #[must_use]
62    pub fn builder() -> GetMyAccountBuilder {
63        GetMyAccountBuilder::default()
64    }
65}
66
67impl Endpoint for GetMyAccount {
68    fn method(&self) -> Method {
69        Method::GET
70    }
71
72    fn endpoint(&self) -> Cow<'static, str> {
73        "my/account.json".into()
74    }
75}
76
77#[cfg(test)]
78mod test {
79    use super::*;
80    use crate::api::users::UserWrapper;
81    use pretty_assertions::assert_eq;
82    use std::error::Error;
83    use tracing_test::traced_test;
84
85    #[traced_test]
86    #[test]
87    fn test_get_my_account() -> Result<(), Box<dyn Error>> {
88        dotenvy::dotenv()?;
89        let redmine = crate::api::Redmine::from_env()?;
90        let endpoint = GetMyAccount::builder().build()?;
91        redmine.json_response_body::<_, UserWrapper<MyAccount>>(&endpoint)?;
92        Ok(())
93    }
94
95    /// this tests if any of the results contain a field we are not deserializing
96    ///
97    /// this will only catch fields we missed if they are part of the response but
98    /// it is better than nothing
99    #[traced_test]
100    #[test]
101    fn test_completeness_my_account_type() -> Result<(), Box<dyn Error>> {
102        dotenvy::dotenv()?;
103        let redmine = crate::api::Redmine::from_env()?;
104        let endpoint = GetMyAccount::builder().build()?;
105        let UserWrapper { user: value } =
106            redmine.json_response_body::<_, UserWrapper<serde_json::Value>>(&endpoint)?;
107        let o: MyAccount = serde_json::from_value(value.clone())?;
108        let reserialized = serde_json::to_value(o)?;
109        assert_eq!(value, reserialized);
110        Ok(())
111    }
112}
redmine_api/api/my_account.rs

redmine_api/api/
my_account.rs
