redmine_api/api/
trackers.rs

1//! Trackers Rest API Endpoint definitions
2//!
3//! [Redmine Documentation](https://www.redmine.org/projects/redmine/wiki/Rest_Trackers)
4//!
5//! - [x] all trackers endpoint
6
7use derive_builder::Builder;
8use reqwest::Method;
9use std::borrow::Cow;
10
11use crate::api::issue_statuses::IssueStatusEssentials;
12use crate::api::{Endpoint, ReturnsJsonResponse};
13
14/// a minimal type for Redmine trackers used in lists of trackers included in
15/// other Redmine objects (e.g. custom fields)
16#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
17pub struct TrackerEssentials {
18    /// numeric id
19    pub id: u64,
20    /// display name
21    pub name: String,
22}
23
24impl From<Tracker> for TrackerEssentials {
25    fn from(v: Tracker) -> Self {
26        TrackerEssentials {
27            id: v.id,
28            name: v.name,
29        }
30    }
31}
32
33impl From<&Tracker> for TrackerEssentials {
34    fn from(v: &Tracker) -> Self {
35        TrackerEssentials {
36            id: v.id,
37            name: v.name.to_owned(),
38        }
39    }
40}
41
42/// a type for tracker to use as an API return type
43///
44/// alternatively you can use your own type limited to the fields you need
45#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
46pub struct Tracker {
47    /// numeric id
48    pub id: u64,
49    /// display name
50    pub name: String,
51    /// default issue status
52    pub default_status: IssueStatusEssentials,
53    /// description
54    pub description: Option<String>,
55    /// standard fields enabled in this tracker (available in Redmine 5.0)
56    #[serde(skip_serializing_if = "Option::is_none")]
57    pub enabled_standard_fields: Option<Vec<String>>,
58}
59
60/// The endpoint for all trackers
61#[derive(Debug, Clone, Builder)]
62#[builder(setter(strip_option))]
63pub struct ListTrackers {}
64
65impl ReturnsJsonResponse for ListTrackers {}
66
67impl ListTrackers {
68    /// Create a builder for the endpoint.
69    #[must_use]
70    pub fn builder() -> ListTrackersBuilder {
71        ListTrackersBuilder::default()
72    }
73}
74
75impl Endpoint for ListTrackers {
76    fn method(&self) -> Method {
77        Method::GET
78    }
79
80    fn endpoint(&self) -> Cow<'static, str> {
81        "trackers.json".into()
82    }
83}
84
85/// helper struct for outer layers with a trackers field holding the inner data
86#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
87pub struct TrackersWrapper<T> {
88    /// to parse JSON with trackers key
89    pub trackers: Vec<T>,
90}
91
92#[cfg(test)]
93mod test {
94    use super::*;
95    use pretty_assertions::assert_eq;
96    use std::error::Error;
97    use tracing_test::traced_test;
98
99    #[traced_test]
100    #[test]
101    fn test_list_trackers_no_pagination() -> Result<(), Box<dyn Error>> {
102        dotenvy::dotenv()?;
103        let redmine = crate::api::Redmine::from_env()?;
104        let endpoint = ListTrackers::builder().build()?;
105        redmine.json_response_body::<_, TrackersWrapper<Tracker>>(&endpoint)?;
106        Ok(())
107    }
108
109    /// this tests if any of the results contain a field we are not deserializing
110    ///
111    /// this will only catch fields we missed if they are part of the response but
112    /// it is better than nothing
113    #[traced_test]
114    #[test]
115    fn test_completeness_tracker_type() -> Result<(), Box<dyn Error>> {
116        dotenvy::dotenv()?;
117        let redmine = crate::api::Redmine::from_env()?;
118        let endpoint = ListTrackers::builder().build()?;
119        let TrackersWrapper { trackers: values } =
120            redmine.json_response_body::<_, TrackersWrapper<serde_json::Value>>(&endpoint)?;
121        for value in values {
122            let o: Tracker = serde_json::from_value(value.clone())?;
123            let reserialized = serde_json::to_value(o)?;
124            assert_eq!(value, reserialized);
125        }
126        Ok(())
127    }
128}
redmine_api/api/trackers.rs

redmine_api/api/
trackers.rs
