Skip to main content

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