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