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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use derive_builder::Builder;

use crate::api::common::NameOrId;
use crate::api::endpoint_prelude::*;

/// Query for awards on an issue within a project.
#[derive(Debug, Builder, Clone)]
pub struct IssueAwards<'a> {
    /// The project to query for the issue.
    #[builder(setter(into))]
    project: NameOrId<'a>,
    /// The ID of the issue.
    issue: u64,
}

impl<'a> IssueAwards<'a> {
    /// Create a builder for the endpoint.
    pub fn builder() -> IssueAwardsBuilder<'a> {
        IssueAwardsBuilder::default()
    }
}

impl Endpoint for IssueAwards<'_> {
    fn method(&self) -> Method {
        Method::GET
    }

    fn endpoint(&self) -> Cow<'static, str> {
        format!(
            "projects/{}/issues/{}/award_emoji",
            self.project, self.issue,
        )
        .into()
    }
}

impl Pageable for IssueAwards<'_> {}

#[cfg(test)]
mod tests {
    use crate::api::projects::issues::awards::{IssueAwards, IssueAwardsBuilderError};
    use crate::api::{self, Query};
    use crate::test::client::{ExpectedUrl, SingleTestClient};

    #[test]
    fn project_and_issue_are_necessary() {
        let err = IssueAwards::builder().build().unwrap_err();
        crate::test::assert_missing_field!(err, IssueAwardsBuilderError, "project");
    }

    #[test]
    fn project_is_necessary() {
        let err = IssueAwards::builder().issue(1).build().unwrap_err();
        crate::test::assert_missing_field!(err, IssueAwardsBuilderError, "project");
    }

    #[test]
    fn issue_is_necessary() {
        let err = IssueAwards::builder().project(1).build().unwrap_err();
        crate::test::assert_missing_field!(err, IssueAwardsBuilderError, "issue");
    }

    #[test]
    fn project_and_issue_are_sufficient() {
        IssueAwards::builder().project(1).issue(1).build().unwrap();
    }

    #[test]
    fn endpoint() {
        let endpoint = ExpectedUrl::builder()
            .endpoint("projects/simple%2Fproject/issues/1/award_emoji")
            .build()
            .unwrap();
        let client = SingleTestClient::new_raw(endpoint, "");

        let endpoint = IssueAwards::builder()
            .project("simple/project")
            .issue(1)
            .build()
            .unwrap();
        api::ignore(endpoint).query(&client).unwrap();
    }
}