gitlab/api/groups/members/
add.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 chrono::NaiveDate;
8use derive_builder::Builder;
9
10use crate::api::common::{AccessLevel, NameOrId};
11use crate::api::endpoint_prelude::*;
12use crate::api::ParamValue;
13
14/// Tasks users may be assigned upon addition to a group.
15#[derive(Debug, Clone, Copy, PartialEq, Eq)]
16#[non_exhaustive]
17pub enum GroupInviteTasksToBeDone {
18    /// Request to focus on CI tasks.
19    Ci,
20    /// Request to focus on coding tasks.
21    Code,
22    /// Request to focus on issues.
23    Issues,
24}
25
26impl GroupInviteTasksToBeDone {
27    /// The tasks as a query parameter.
28    fn as_str(self) -> &'static str {
29        match self {
30            GroupInviteTasksToBeDone::Ci => "ci",
31            GroupInviteTasksToBeDone::Code => "code",
32            GroupInviteTasksToBeDone::Issues => "issues",
33        }
34    }
35}
36
37impl ParamValue<'static> for GroupInviteTasksToBeDone {
38    fn as_value(&self) -> Cow<'static, str> {
39        self.as_str().into()
40    }
41}
42
43/// Add a user as a member of a group.
44#[derive(Debug, Builder, Clone)]
45#[builder(setter(strip_option))]
46pub struct AddGroupMember<'a> {
47    /// The group to add the user to.
48    #[builder(setter(into))]
49    group: NameOrId<'a>,
50    /// The user to add to the group.
51    #[builder(setter(into))]
52    user: NameOrId<'a>,
53    /// The access level for the user in the group.
54    access_level: AccessLevel,
55
56    /// When the user's access expires.
57    #[builder(default)]
58    expires_at: Option<NaiveDate>,
59    /// The source of the invitation.
60    #[builder(setter(into), default)]
61    invite_source: Option<Cow<'a, str>>,
62    /// ID of a custom role to assign to the member.
63    #[builder(default)]
64    member_role_id: Option<u64>,
65}
66
67impl<'a> AddGroupMember<'a> {
68    /// Create a builder for the endpoint.
69    pub fn builder() -> AddGroupMemberBuilder<'a> {
70        AddGroupMemberBuilder::default()
71    }
72}
73
74impl Endpoint for AddGroupMember<'_> {
75    fn method(&self) -> Method {
76        Method::POST
77    }
78
79    fn endpoint(&self) -> Cow<'static, str> {
80        format!("groups/{}/members", self.group).into()
81    }
82
83    fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
84        let mut params = FormParams::default();
85
86        params
87            .push("access_level", self.access_level.as_u64())
88            .push_opt("expires_at", self.expires_at)
89            .push_opt("invite_source", self.invite_source.as_ref())
90            .push_opt("member_role_id", self.member_role_id);
91
92        match &self.user {
93            NameOrId::Name(name) => params.push("username", name),
94            NameOrId::Id(id) => params.push("user_id", *id),
95        };
96
97        params.into_body()
98    }
99}
100
101#[cfg(test)]
102mod tests {
103    use chrono::NaiveDate;
104    use http::Method;
105
106    use crate::api::common::AccessLevel;
107    use crate::api::groups::members::{
108        AddGroupMember, AddGroupMemberBuilderError, GroupInviteTasksToBeDone,
109    };
110    use crate::api::{self, Query};
111    use crate::test::client::{ExpectedUrl, SingleTestClient};
112
113    #[test]
114    fn group_invite_tasks_as_str() {
115        let items = &[
116            (GroupInviteTasksToBeDone::Ci, "ci"),
117            (GroupInviteTasksToBeDone::Code, "code"),
118            (GroupInviteTasksToBeDone::Issues, "issues"),
119        ];
120
121        for (i, s) in items {
122            assert_eq!(i.as_str(), *s);
123        }
124    }
125
126    #[test]
127    fn all_parameters_are_needed() {
128        let err = AddGroupMember::builder().build().unwrap_err();
129        crate::test::assert_missing_field!(err, AddGroupMemberBuilderError, "group");
130    }
131
132    #[test]
133    fn group_is_necessary() {
134        let err = AddGroupMember::builder()
135            .user(1)
136            .access_level(AccessLevel::Developer)
137            .build()
138            .unwrap_err();
139        crate::test::assert_missing_field!(err, AddGroupMemberBuilderError, "group");
140    }
141
142    #[test]
143    fn user_is_necessary() {
144        let err = AddGroupMember::builder()
145            .group(1)
146            .access_level(AccessLevel::Developer)
147            .build()
148            .unwrap_err();
149        crate::test::assert_missing_field!(err, AddGroupMemberBuilderError, "user");
150    }
151
152    #[test]
153    fn access_level_is_necessary() {
154        let err = AddGroupMember::builder()
155            .group(1)
156            .user("name")
157            .build()
158            .unwrap_err();
159        crate::test::assert_missing_field!(err, AddGroupMemberBuilderError, "access_level");
160    }
161
162    #[test]
163    fn sufficient_parameters() {
164        AddGroupMember::builder()
165            .group("group")
166            .user(1)
167            .access_level(AccessLevel::Developer)
168            .build()
169            .unwrap();
170    }
171
172    #[test]
173    fn endpoint() {
174        let endpoint = ExpectedUrl::builder()
175            .method(Method::POST)
176            .endpoint("groups/group%2Fsubgroup/members")
177            .content_type("application/x-www-form-urlencoded")
178            .body_str(concat!("access_level=30", "&user_id=1"))
179            .build()
180            .unwrap();
181        let client = SingleTestClient::new_raw(endpoint, "");
182
183        let endpoint = AddGroupMember::builder()
184            .group("group/subgroup")
185            .user(1)
186            .access_level(AccessLevel::Developer)
187            .build()
188            .unwrap();
189        api::ignore(endpoint).query(&client).unwrap();
190    }
191
192    #[test]
193    fn endpoint_username() {
194        let endpoint = ExpectedUrl::builder()
195            .method(Method::POST)
196            .endpoint("groups/group%2Fsubgroup/members")
197            .content_type("application/x-www-form-urlencoded")
198            .body_str(concat!("access_level=30", "&username=uname"))
199            .build()
200            .unwrap();
201        let client = SingleTestClient::new_raw(endpoint, "");
202
203        let endpoint = AddGroupMember::builder()
204            .group("group/subgroup")
205            .user("uname")
206            .access_level(AccessLevel::Developer)
207            .build()
208            .unwrap();
209        api::ignore(endpoint).query(&client).unwrap();
210    }
211
212    #[test]
213    fn endpoint_expires_at() {
214        let endpoint = ExpectedUrl::builder()
215            .method(Method::POST)
216            .endpoint("groups/group%2Fsubgroup/members")
217            .content_type("application/x-www-form-urlencoded")
218            .body_str(concat!(
219                "access_level=30",
220                "&expires_at=2020-01-01",
221                "&user_id=1",
222            ))
223            .build()
224            .unwrap();
225        let client = SingleTestClient::new_raw(endpoint, "");
226
227        let endpoint = AddGroupMember::builder()
228            .group("group/subgroup")
229            .user(1)
230            .access_level(AccessLevel::Developer)
231            .expires_at(NaiveDate::from_ymd_opt(2020, 1, 1).unwrap())
232            .build()
233            .unwrap();
234        api::ignore(endpoint).query(&client).unwrap();
235    }
236
237    #[test]
238    fn endpoint_invite_source() {
239        let endpoint = ExpectedUrl::builder()
240            .method(Method::POST)
241            .endpoint("groups/group%2Fsubgroup/members")
242            .content_type("application/x-www-form-urlencoded")
243            .body_str(concat!(
244                "access_level=30",
245                "&invite_source=tuesday",
246                "&user_id=1",
247            ))
248            .build()
249            .unwrap();
250        let client = SingleTestClient::new_raw(endpoint, "");
251
252        let endpoint = AddGroupMember::builder()
253            .group("group/subgroup")
254            .user(1)
255            .access_level(AccessLevel::Developer)
256            .invite_source("tuesday")
257            .build()
258            .unwrap();
259        api::ignore(endpoint).query(&client).unwrap();
260    }
261
262    #[test]
263    fn endpoint_member_role_id() {
264        let endpoint = ExpectedUrl::builder()
265            .method(Method::POST)
266            .endpoint("groups/group%2Fsubgroup/members")
267            .content_type("application/x-www-form-urlencoded")
268            .body_str(concat!(
269                "access_level=30",
270                "&member_role_id=14",
271                "&user_id=1",
272            ))
273            .build()
274            .unwrap();
275        let client = SingleTestClient::new_raw(endpoint, "");
276
277        let endpoint = AddGroupMember::builder()
278            .group("group/subgroup")
279            .user(1)
280            .access_level(AccessLevel::Developer)
281            .member_role_id(14)
282            .build()
283            .unwrap();
284        api::ignore(endpoint).query(&client).unwrap();
285    }
286}
gitlab/api/groups/members/add.rs

gitlab/api/groups/members/
add.rs
