Add collaborator methods (#97)

* Add collaborator methods

* Add test coverage

* revert syntax change

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

Co-authored-by: Abhishek Jain <[email protected]>

Co-authored-by: Abhishek Jain <[email protected]>

Author: Joonpark13

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

@@ -513,6 +513,20 @@ CompletableFuture<Response> put(final String path, final String data) {
     return call(request);
   }
 
+  /**
+   * Make a HTTP PUT request for the given path with provided JSON body.
+   *
+   * @param path relative to the Github base url
+   * @param data request body as stringified JSON
+   * @param clazz class to cast response as
+   * @return response body as String
+   */
+  <T> CompletableFuture<T> put(final String path, final String data, final Class<T> clazz) {
+    return put(path, data)
+        .thenApply(
+            response -> json().fromJsonUncheckedNotNull(responseBodyUnchecked(response), clazz));
+  }
+
   /**
    * Make an http PATCH request for the given path with provided JSON body.
    *

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

@@ -45,6 +45,7 @@
 import com.spotify.github.v3.repos.FolderContent;
 import com.spotify.github.v3.repos.Languages;
 import com.spotify.github.v3.repos.Repository;
+import com.spotify.github.v3.repos.RepositoryInvitation;
 import com.spotify.github.v3.repos.Status;
 import com.spotify.github.v3.repos.requests.AuthenticatedUserRepositoriesFilter;
 import com.spotify.github.v3.repos.requests.RepositoryCreateStatus;
@@ -86,7 +87,7 @@ public class RepositoryClient {
   private static final String FORK_TEMPLATE = "/repos/%s/%s/forks";
   private static final String LIST_REPOSITORY_TEMPLATE = "/orgs/%s/repos";
   private static final String LIST_REPOSITORIES_FOR_AUTHENTICATED_USER = "/user/repos";
-  private static final String IS_USER_COLLABORATOR_OF_REPO = "/repos/%s/%s/collaborators/%s";
+  private static final String REPOSITORY_COLLABORATOR = "/repos/%s/%s/collaborators/%s";
   private final String owner;
   private final String repo;
   private final GitHubClient github;
@@ -182,10 +183,20 @@ public Iterator<AsyncPage<Repository>> listAuthenticatedUserRepositories(
    * @return boolean indicating if user is collaborator
    */
   public CompletableFuture<Boolean> isCollaborator(final String user) {
-    final String path = String.format(IS_USER_COLLABORATOR_OF_REPO, owner, repo, user);
+    final String path = String.format(REPOSITORY_COLLABORATOR, owner, repo, user);
     return github.request(path).thenApply(response -> response.code() == NO_CONTENT);
   }
 
+  public CompletableFuture<RepositoryInvitation> addCollaborator(final String user) {
+    final String path = String.format(REPOSITORY_COLLABORATOR, owner, repo, user);
+    return github.put(path, "", RepositoryInvitation.class);
+  }
+
+  public CompletableFuture<Void> removeCollaborator(final String user) {
+    final String path = String.format(REPOSITORY_COLLABORATOR, owner, repo, user);
+    return github.delete(path).thenAccept(IGNORE_RESPONSE_CONSUMER);
+  }
+
   /**
    * Create a webhook.
    *

src/main/java/com/spotify/github/v3/repos/RepositoryInvitation.java

@@ -0,0 +1,72 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2022 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.repos;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.spotify.github.GithubStyle;
+import com.spotify.github.v3.User;
+import java.net.URI;
+import java.time.ZonedDateTime;
+import java.util.Optional;
+import javax.annotation.Nullable;
+import org.immutables.value.Value;
+
+/** Collaborator Invitation resource */
+@Value.Immutable
+@GithubStyle
+@JsonSerialize(as = ImmutableRepositoryInvitation.class)
+@JsonDeserialize(as = ImmutableRepositoryInvitation.class)
+public interface RepositoryInvitation {
+
+  /** Unique identifier of the repository invitation */
+  Integer id();
+
+  /** Node ID */
+  String nodeId();
+
+  /** The repository that the invitee is being invited to */
+  Repository repository();
+
+  /** The user that is receiving the invite */
+  @Nullable
+  User invitee();
+
+  /** The user that sent the invite */
+  @Nullable
+  User inviter();
+
+  /** The permission associated with the invitation */
+  String permissions();
+
+  /** Date when invite was created */
+  ZonedDateTime createdAt();
+
+  /** Whether or not the invitation has expired */
+  @Nullable
+  Optional<Boolean> expired();
+
+  /** API URL */
+  URI url();
+
+  /** HTML URL */
+  URI htmlUrl();
+}

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

@@ -20,17 +20,22 @@
 
 package com.spotify.github.v3.clients;
 
+import static com.google.common.io.Resources.getResource;
+import static java.nio.charset.Charset.defaultCharset;
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
 import static org.junit.Assert.fail;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.*;
 
+import com.google.common.io.Resources;
 import com.spotify.github.Tracer;
 import com.spotify.github.v3.exceptions.ReadOnlyRepositoryException;
 import com.spotify.github.v3.exceptions.RequestNotOkException;
 import com.spotify.github.v3.repos.CommitItem;
+import com.spotify.github.v3.repos.RepositoryInvitation;
+import java.io.IOException;
 import java.net.URI;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
@@ -53,6 +58,10 @@ public class GitHubClientTest {
   private OkHttpClient client;
   private Tracer tracer = mock(Tracer.class);
 
+  private static String getFixture(String resource) throws IOException {
+    return Resources.toString(getResource(GitHubClientTest.class, resource), defaultCharset());
+  }
+
   @Before
   public void setUp() {
     client = mock(OkHttpClient.class);
@@ -138,4 +147,34 @@ public void testRequestNotOkException() throws Throwable {
       assertThat(e1.getRawMessage(), containsString("Merge Conflict"));
     }
   }
+
+  @Test
+  public void testPutConvertsToClass() throws Throwable {
+    final Call call = mock(Call.class);
+    final ArgumentCaptor<Callback> callbackCapture = ArgumentCaptor.forClass(Callback.class);
+    doNothing().when(call).enqueue(callbackCapture.capture());
+
+    final ArgumentCaptor<Request> requestCapture = ArgumentCaptor.forClass(Request.class);
+    when(client.newCall(requestCapture.capture())).thenReturn(call);
+
+    final Response response =
+        new okhttp3.Response.Builder()
+            .code(200)
+            .body(
+                ResponseBody.create(
+                    MediaType.get("application/json"), getFixture("repository_invitation.json")))
+            .message("")
+            .protocol(Protocol.HTTP_1_1)
+            .request(new Request.Builder().url("http://localhost/").build())
+            .build();
+
+    CompletableFuture<RepositoryInvitation> future = github.put("collaborators/", "",
+        RepositoryInvitation.class);
+    callbackCapture.getValue().onResponse(call, response);
+
+    RepositoryInvitation invitation = future.get();
+    assertThat(requestCapture.getValue().method(), is("PUT"));
+    assertThat(requestCapture.getValue().url().toString(), is("http://bogus/collaborators/"));
+    assertThat(invitation.id(), is(1));
+  }
 }

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

@@ -7,9 +7,9 @@
  * 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.
@@ -23,8 +23,8 @@
 import static com.google.common.io.Resources.getResource;
 import static com.spotify.github.FixtureHelper.loadFixture;
 import static com.spotify.github.v3.UserTest.assertUser;
-import static com.spotify.github.v3.clients.GitHubClient.LIST_COMMIT_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_BRANCHES;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_COMMIT_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_FOLDERCONTENT_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_PR_TYPE_REFERENCE;
 import static com.spotify.github.v3.clients.GitHubClient.LIST_REPOSITORY;
@@ -33,6 +33,7 @@
 import static java.lang.String.format;
 import static java.nio.charset.Charset.defaultCharset;
 import static java.util.concurrent.CompletableFuture.completedFuture;
+import static java.util.stream.StreamSupport.stream;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
 import static org.junit.Assert.assertFalse;
@@ -41,7 +42,6 @@
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
-import static java.util.stream.StreamSupport.stream;
 
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Lists;
@@ -59,6 +59,7 @@
 import com.spotify.github.v3.repos.Content;
 import com.spotify.github.v3.repos.FolderContent;
 import com.spotify.github.v3.repos.Repository;
+import com.spotify.github.v3.repos.RepositoryInvitation;
 import com.spotify.github.v3.repos.RepositoryTest;
 import com.spotify.github.v3.repos.Status;
 import com.spotify.github.v3.repos.requests.ImmutableAuthenticatedUserRepositoriesFilter;
@@ -76,6 +77,7 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
 import org.powermock.core.classloader.annotations.PrepareForTest;
 import org.powermock.modules.junit4.PowerMockRunner;
 
@@ -160,6 +162,35 @@ public void isNotCollaborator() throws Exception {
     assertFalse(isCollaborator);
   }
 
+  @Test
+  public void addCollaborator() throws Exception {
+    final CompletableFuture<RepositoryInvitation> fixture =
+        completedFuture(json.fromJson(getFixture("repository_invitation.json"), RepositoryInvitation.class));
+    when(github.put("/repos/someowner/somerepo/collaborators/user", "", RepositoryInvitation.class)).thenReturn(fixture);
+
+    final RepositoryInvitation repoInvite = repoClient.addCollaborator("user").get();
+
+    assertThat(repoInvite.id(), is(1));
+    assertThat(repoInvite.nodeId(), is("MDEwOlJlcG9zaXRvcnkxMjk2MjY5"));
+    assertThat(repoInvite.repository().id(), is(1296269));
+    assertUser(repoInvite.repository().owner());
+    assertUser(repoInvite.invitee());
+    assertUser(repoInvite.inviter());
+    assertThat(repoInvite.permissions(), is("write"));
+  }
+
+  @Test
+  public void removeCollaborator() throws Exception {
+    CompletableFuture<Response> response = completedFuture(mock(Response.class));
+    final ArgumentCaptor<String> capture = ArgumentCaptor.forClass(String.class);
+    when(github.delete(capture.capture())).thenReturn(response);
+
+    CompletableFuture<Void> deleteResponse = repoClient.removeCollaborator("user");
+    deleteResponse.get();
+
+    assertThat(capture.getValue(), is("/repos/someowner/somerepo/collaborators/user"));
+  }
+
   @Test
   public void listCommits() throws Exception {
     final CompletableFuture<List<CommitItem>> fixture =