Skip to main content

gitlab/api/projects/issues/awards/
awards.rs

1// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
2// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
3// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
4// option. This file may not be copied, modified, or distributed
5// except according to those terms.
6
7use derive_builder::Builder;
8
9use crate::api::common::NameOrId;
10use crate::api::endpoint_prelude::*;
11
12/// Query for awards on an issue within a project.
13#[derive(Debug, Builder, Clone)]
14pub struct IssueAwards<'a> {
15    /// The project to query for the issue.
16    #[builder(setter(into))]
17    project: NameOrId<'a>,
18    /// The ID of the issue.
19    issue: u64,
20}
21
22impl<'a> IssueAwards<'a> {
23    /// Create a builder for the endpoint.
24    pub fn builder() -> IssueAwardsBuilder<'a> {
25        IssueAwardsBuilder::default()
26    }
27}
28
29impl Endpoint for IssueAwards<'_> {
30    fn method(&self) -> Method {
31        Method::GET
32    }
33
34    fn endpoint(&self) -> Cow<'static, str> {
35        format!(
36            "projects/{}/issues/{}/award_emoji",
37            self.project, self.issue,
38        )
39        .into()
40    }
41}
42
43impl Pageable for IssueAwards<'_> {}
44
45#[cfg(test)]
46mod tests {
47    use crate::api::projects::issues::awards::{IssueAwards, IssueAwardsBuilderError};
48    use crate::api::{self, Query};
49    use crate::test::client::{ExpectedUrl, SingleTestClient};
50
51    #[test]
52    fn project_and_issue_are_necessary() {
53        let err = IssueAwards::builder().build().unwrap_err();
54        crate::test::assert_missing_field!(err, IssueAwardsBuilderError, "project");
55    }
56
57    #[test]
58    fn project_is_necessary() {
59        let err = IssueAwards::builder().issue(1).build().unwrap_err();
60        crate::test::assert_missing_field!(err, IssueAwardsBuilderError, "project");
61    }
62
63    #[test]
64    fn issue_is_necessary() {
65        let err = IssueAwards::builder().project(1).build().unwrap_err();
66        crate::test::assert_missing_field!(err, IssueAwardsBuilderError, "issue");
67    }
68
69    #[test]
70    fn project_and_issue_are_sufficient() {
71        IssueAwards::builder().project(1).issue(1).build().unwrap();
72    }
73
74    #[test]
75    fn endpoint() {
76        let endpoint = ExpectedUrl::builder()
77            .endpoint("projects/simple%2Fproject/issues/1/award_emoji")
78            .build()
79            .unwrap();
80        let client = SingleTestClient::new_raw(endpoint, "");
81
82        let endpoint = IssueAwards::builder()
83            .project("simple/project")
84            .issue(1)
85            .build()
86            .unwrap();
87        api::ignore(endpoint).query(&client).unwrap();
88    }
89}