gitlab 0.1900.0

Gitlab API client.
Documentation 
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

// 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 std::borrow::Cow;

use derive_builder::Builder;

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

/// Edit a custom attribute for a user.
///
/// Creates or updates a custom attribute for the specified user.
#[derive(Debug, Clone, Builder)]
pub struct EditCustomAttribute<'a> {
    /// The ID of the user.
    #[builder(setter(into))]
    user: NameOrId<'a>,
    /// The key of the custom attribute.
    #[builder(setter(into))]
    key: Cow<'a, str>,
    /// The value of the custom attribute.
    #[builder(setter(into))]
    value: Cow<'a, str>,
}

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

impl<'a> Endpoint for EditCustomAttribute<'a> {
    fn method(&self) -> Method {
        Method::PUT
    }

    fn endpoint(&self) -> Cow<'static, str> {
        format!("users/{}/custom_attributes/{}", self.user, self.key).into()
    }

    fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
        let mut params = FormParams::default();
        params.push("value", &self.value);
        params.into_body()
    }
}

#[cfg(test)]
mod tests {
    use crate::api::users::custom_attributes::{
        EditCustomAttribute, EditCustomAttributeBuilderError,
    };
    use crate::api::{self, Query};
    use crate::test::client::{ExpectedUrl, SingleTestClient};
    use http::Method;

    #[test]
    fn user_is_needed() {
        let err = EditCustomAttribute::builder()
            .key("test")
            .value("value")
            .build()
            .unwrap_err();
        crate::test::assert_missing_field!(err, EditCustomAttributeBuilderError, "user");
    }

    #[test]
    fn key_is_needed() {
        let err = EditCustomAttribute::builder()
            .user(1)
            .value("value")
            .build()
            .unwrap_err();
        crate::test::assert_missing_field!(err, EditCustomAttributeBuilderError, "key");
    }

    #[test]
    fn value_is_needed() {
        let err = EditCustomAttribute::builder()
            .user(1)
            .key("test")
            .build()
            .unwrap_err();
        crate::test::assert_missing_field!(err, EditCustomAttributeBuilderError, "value");
    }

    #[test]
    fn user_key_value_are_sufficient() {
        EditCustomAttribute::builder()
            .user(1)
            .key("test")
            .value("value")
            .build()
            .unwrap();
    }

    #[test]
    fn endpoint() {
        let endpoint = ExpectedUrl::builder()
            .method(Method::PUT)
            .endpoint("users/user/custom_attributes/test")
            .content_type("application/x-www-form-urlencoded")
            .body_str("value=value")
            .build()
            .unwrap();
        let client = SingleTestClient::new_raw(endpoint, "");

        let endpoint = EditCustomAttribute::builder()
            .user("user")
            .key("test")
            .value("value")
            .build()
            .unwrap();
        api::ignore(endpoint).query(&client).unwrap();
    }
}