gitlab/api/projects/issues/awards/
award.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 award on an issue within a project.
13#[derive(Debug, Builder, Clone)]
14pub struct IssueAward<'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    /// The ID of the award.
21    award: u64,
22}
23
24impl<'a> IssueAward<'a> {
25    /// Create a builder for the endpoint.
26    pub fn builder() -> IssueAwardBuilder<'a> {
27        IssueAwardBuilder::default()
28    }
29}
30
31impl Endpoint for IssueAward<'_> {
32    fn method(&self) -> Method {
33        Method::GET
34    }
35
36    fn endpoint(&self) -> Cow<'static, str> {
37        format!(
38            "projects/{}/issues/{}/award_emoji/{}",
39            self.project, self.issue, self.award,
40        )
41        .into()
42    }
43}
44
45#[cfg(test)]
46mod tests {
47    use crate::api::projects::issues::awards::{IssueAward, IssueAwardBuilderError};
48    use crate::api::{self, Query};
49    use crate::test::client::{ExpectedUrl, SingleTestClient};
50
51    #[test]
52    fn project_issue_and_award_are_necessary() {
53        let err = IssueAward::builder().build().unwrap_err();
54        crate::test::assert_missing_field!(err, IssueAwardBuilderError, "project");
55    }
56
57    #[test]
58    fn project_is_necessary() {
59        let err = IssueAward::builder().issue(1).award(1).build().unwrap_err();
60        crate::test::assert_missing_field!(err, IssueAwardBuilderError, "project");
61    }
62
63    #[test]
64    fn issue_is_necessary() {
65        let err = IssueAward::builder()
66            .project(1)
67            .award(1)
68            .build()
69            .unwrap_err();
70        crate::test::assert_missing_field!(err, IssueAwardBuilderError, "issue");
71    }
72
73    #[test]
74    fn award_is_necessary() {
75        let err = IssueAward::builder()
76            .project(1)
77            .issue(1)
78            .build()
79            .unwrap_err();
80        crate::test::assert_missing_field!(err, IssueAwardBuilderError, "award");
81    }
82
83    #[test]
84    fn project_issue_and_award_are_sufficient() {
85        IssueAward::builder()
86            .project(1)
87            .issue(1)
88            .award(1)
89            .build()
90            .unwrap();
91    }
92
93    #[test]
94    fn endpoint() {
95        let endpoint = ExpectedUrl::builder()
96            .endpoint("projects/simple%2Fproject/issues/1/award_emoji/2")
97            .build()
98            .unwrap();
99        let client = SingleTestClient::new_raw(endpoint, "");
100
101        let endpoint = IssueAward::builder()
102            .project("simple/project")
103            .issue(1)
104            .award(2)
105            .build()
106            .unwrap();
107        api::ignore(endpoint).query(&client).unwrap();
108    }
109}