Add user client to allow for suspending/unsuspending users (#172)

* Add user client to allow for suspending/unsuspending users

* Change signature of suspend/unsuspend method to boolean return value

Author: dennisgranath

src/main/java/com/spotify/github/v3/clients/GitHubClient.java

@@ -396,6 +396,10 @@ public OrganisationClient createOrganisationClient(final String org) {
     return OrganisationClient.create(this, org);
   }
 
+  public UserClient createUserClient() {
+    return UserClient.create(this);
+  }
+
   Json json() {
     return json;
   }

src/main/java/com/spotify/github/v3/clients/UserClient.java

@@ -0,0 +1,68 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2024 Spotify AB
+ * --
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -/-/-
+ */
+
+package com.spotify.github.v3.clients;
+
+import com.spotify.github.v3.user.requests.SuspensionReason;
+import java.util.concurrent.CompletableFuture;
+
+public class UserClient {
+
+  public static final int NO_CONTENT = 204;
+  private final GitHubClient github;
+
+  private static final String SUSPEND_USER_TEMPLATE = "/users/%s/suspended";
+
+  UserClient(final GitHubClient github) {
+    this.github = github;
+  }
+
+  static UserClient create(final GitHubClient github) {
+    return new UserClient(github);
+  }
+
+  /**
+   * Suspend a user.
+   *
+   * @param username username of the user to suspend
+   * @return a CompletableFuture that indicates success or failure
+   */
+  public CompletableFuture<Boolean> suspendUser(
+      final String username, final SuspensionReason reason) {
+    final String path = String.format(SUSPEND_USER_TEMPLATE, username);
+    return github
+        .put(path, github.json().toJsonUnchecked(reason))
+        .thenApply(resp -> resp.code() == NO_CONTENT);
+  }
+
+  /**
+   * Unsuspend a user.
+   *
+   * @param username username of the user to unsuspend
+   * @return a CompletableFuture that indicates success or failure
+   */
+  public CompletableFuture<Boolean> unSuspendUser(
+      final String username, final SuspensionReason reason) {
+    final String path = String.format(SUSPEND_USER_TEMPLATE, username);
+    return github
+        .delete(path, github.json().toJsonUnchecked(reason))
+        .thenApply(resp -> resp.code() == NO_CONTENT);
+  }
+}

src/main/java/com/spotify/github/v3/user/requests/SuspensionReason.java

@@ -0,0 +1,34 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2024 Spotify AB
+ * --
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -/-/-
+ */
+package com.spotify.github.v3.user.requests;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.spotify.github.GithubStyle;
+import org.immutables.value.Value;
+
+@Value.Immutable
+@GithubStyle
+@JsonSerialize(as = ImmutableSuspensionReason.class)
+@JsonDeserialize(as = ImmutableSuspensionReason.class)
+public interface SuspensionReason {
+
+    String reason();
+}

src/test/java/com/spotify/github/v3/clients/UserClientTest.java

@@ -0,0 +1,84 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2024 Spotify AB
+ * --
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -/-/-
+ */
+package com.spotify.github.v3.clients;
+
+import static java.util.concurrent.CompletableFuture.completedFuture;
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import com.spotify.github.jackson.Json;
+import com.spotify.github.v3.user.requests.ImmutableSuspensionReason;
+import java.util.concurrent.CompletableFuture;
+import okhttp3.Response;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+public class UserClientTest {
+
+    private GitHubClient github;
+    private UserClient userClient;
+
+    @BeforeEach
+    public void setUp() {
+        github = mock(GitHubClient.class);
+        userClient = new UserClient(github);
+        Json json = Json.create();
+        when(github.json()).thenReturn(json);
+    }
+
+    @Test
+    public void testSuspendUserSuccess() throws Exception {
+        Response response = mock(Response.class);
+        when(response.code()).thenReturn(204);
+        when(github.put(eq("/users/username/suspended"), any())).thenReturn(completedFuture(response));
+        final CompletableFuture<Boolean> result = userClient.suspendUser("username", ImmutableSuspensionReason.builder().reason("That's why").build());
+        assertTrue(result.get());
+    }
+
+    @Test
+    public void testSuspendUserFailure() throws Exception {
+        Response response = mock(Response.class);
+        when(response.code()).thenReturn(403);
+        when(github.put(eq("/users/username/suspended"), any())).thenReturn(completedFuture(response));
+        final CompletableFuture<Boolean> result = userClient.suspendUser("username", ImmutableSuspensionReason.builder().reason("That's why").build());
+        assertFalse(result.get());
+    }
+
+    @Test
+    public void testUnSuspendUserSuccess() throws Exception {
+        Response response = mock(Response.class);
+        when(response.code()).thenReturn(204);
+        when(github.delete(eq("/users/username/suspended"), any())).thenReturn(completedFuture(response));
+        final CompletableFuture<Boolean> result = userClient.unSuspendUser("username", ImmutableSuspensionReason.builder().reason("That's why").build());
+        assertTrue(result.get());
+    }
+
+    @Test
+    public void testUnSuspendUserFailure() throws Exception {
+        Response response = mock(Response.class);
+        when(response.code()).thenReturn(403);
+        when(github.delete(eq("/users/username/suspended"), any())).thenReturn(completedFuture(response));
+        final CompletableFuture<Boolean> result = userClient.unSuspendUser("username", ImmutableSuspensionReason.builder().reason("That's why").build());
+        assertFalse(result.get());
+    }
+}