Merge branch 'master' into fix/fix-breaking-change

Author: Abhi347

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>github-client</artifactId>
-    <version>0.4.5-SNAPSHOT</version>
+    <version>0.4.8-SNAPSHOT</version>
 
     <parent>
         <groupId>com.spotify</groupId>
@@ -67,7 +67,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <project.build.outputTimestamp>1745843688</project.build.outputTimestamp>
+        <project.build.outputTimestamp>1749016319</project.build.outputTimestamp>
         <spotbugs.excludeFilterFile>spotbugsexclude.xml</spotbugs.excludeFilterFile>
         <checkstyle.violationSeverity>error</checkstyle.violationSeverity>
         <checkstyle.config.location>checkstyle.xml</checkstyle.config.location>

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

@@ -20,33 +20,41 @@
 
 package com.spotify.github.v3.clients;
 
-import static com.spotify.github.v3.clients.GitHubClient.IGNORE_RESPONSE_CONSUMER;
-import static com.spotify.github.v3.clients.GitHubClient.LIST_COMMIT_TYPE_REFERENCE;
-import static com.spotify.github.v3.clients.GitHubClient.LIST_PR_TYPE_REFERENCE;
-import static com.spotify.github.v3.clients.GitHubClient.LIST_REVIEW_REQUEST_TYPE_REFERENCE;
-import static com.spotify.github.v3.clients.GitHubClient.LIST_REVIEW_TYPE_REFERENCE;
-import static java.util.Objects.isNull;
-
-import com.google.common.base.Strings;
-import com.google.common.collect.ImmutableMap;
-import com.spotify.github.async.AsyncPage;
-import com.spotify.github.v3.prs.*;
-import com.spotify.github.v3.prs.requests.PullRequestCreate;
-import com.spotify.github.v3.prs.requests.PullRequestParameters;
-import com.spotify.github.v3.prs.requests.PullRequestUpdate;
-import com.spotify.github.v3.repos.CommitItem;
-
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.lang.invoke.MethodHandles;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
+import static java.util.Objects.isNull;
 import java.util.concurrent.CompletableFuture;
+
 import javax.ws.rs.core.HttpHeaders;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.google.common.base.Strings;
+import com.google.common.collect.ImmutableMap;
+import com.spotify.github.async.AsyncPage;
+import static com.spotify.github.v3.clients.GitHubClient.IGNORE_RESPONSE_CONSUMER;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_COMMIT_TYPE_REFERENCE;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_PR_TYPE_REFERENCE;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_REVIEW_REQUEST_TYPE_REFERENCE;
+import static com.spotify.github.v3.clients.GitHubClient.LIST_REVIEW_TYPE_REFERENCE;
+import com.spotify.github.v3.prs.Comment;
+import com.spotify.github.v3.prs.MergeParameters;
+import com.spotify.github.v3.prs.PullRequest;
+import com.spotify.github.v3.prs.PullRequestItem;
+import com.spotify.github.v3.prs.RequestReviewParameters;
+import com.spotify.github.v3.prs.Review;
+import com.spotify.github.v3.prs.ReviewParameters;
+import com.spotify.github.v3.prs.ReviewRequests;
+import com.spotify.github.v3.prs.requests.PullRequestCreate;
+import com.spotify.github.v3.prs.requests.PullRequestParameters;
+import com.spotify.github.v3.prs.requests.PullRequestUpdate;
+import com.spotify.github.v3.repos.CommitItem;
+
 /** Pull call API client */
 public class PullRequestClient {
 
@@ -57,6 +65,8 @@ public class PullRequestClient {
   private static final String PR_REVIEWS_TEMPLATE = "/repos/%s/%s/pulls/%s/reviews";
   private static final String PR_REVIEW_REQUESTS_TEMPLATE =
       "/repos/%s/%s/pulls/%s/requested_reviewers";
+  private static final String PR_COMMENT_REPLIES_TEMPLATE =
+      "/repos/%s/%s/pulls/%s/comments/%s/replies";
 
   private final GitHubClient github;
   private final String owner;
@@ -450,4 +460,23 @@ private CompletableFuture<List<PullRequestItem>> list(final String parameterPath
     log.debug("Fetching pull requests from " + path);
     return github.request(path, LIST_PR_TYPE_REFERENCE);
   }
+
+  /**
+   * Creates a reply to a pull request review comment.
+   *
+   * @param prNumber pull request number
+   * @param commentId the ID of the comment to reply to
+   * @param body the reply message
+   * @return the created comment
+   * @see "https://docs.github.com/en/rest/pulls/comments#create-a-reply-for-a-review-comment"
+   */
+  public CompletableFuture<Comment> createCommentReply(
+      final long prNumber, final long commentId, final String body) {
+    final String path =
+        String.format(PR_COMMENT_REPLIES_TEMPLATE, owner, repo, prNumber, commentId);
+    final Map<String, String> payload = ImmutableMap.of("body", body);
+    final String jsonPayload = github.json().toJsonUnchecked(payload);
+    log.debug("Creating reply to PR comment: " + path);
+    return github.post(path, jsonPayload, Comment.class);
+  }
 }

src/main/java/com/spotify/github/v3/comment/Comment.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.
@@ -75,4 +75,8 @@ public interface Comment extends UpdateTracking {
 
   /** The issueURL which the comment belongs to. */
   Optional<URI> issueUrl();
+
+  /** Node ID */
+  @Nullable
+  String nodeId();
 }

src/main/java/com/spotify/github/v3/prs/Comment.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.
@@ -73,7 +73,6 @@ public interface Comment extends UpdateTracking {
   /** Base commit sha. */
   @Nullable
   String originalCommitId();
-
   /** Comment author. */
   @Nullable
   User user();
@@ -82,6 +81,38 @@ public interface Comment extends UpdateTracking {
   @Nullable
   String body();
 
+  /** The ID of the comment to reply to. */
+  @Nullable
+  Long inReplyToId();
+
+  /** The author association of the comment. */
+  @Nullable
+  String authorAssociation();
+
+  /** The starting line number in the diff. */
+  @Nullable
+  Integer startLine();
+
+  /** The starting line number in the original file. */
+  @Nullable
+  Integer originalStartLine();
+
+  /** The side of the diff where the starting line is from. */
+  @Nullable
+  String startSide();
+
+  /** The line number in the diff. */
+  @Nullable
+  Integer line();
+
+  /** The line number in the original file. */
+  @Nullable
+  Integer originalLine();
+
+  /** The side of the diff where the line is from. */
+  @Nullable
+  String side();
+
   /** Comment URL. */
   @Nullable
   URI htmlUrl();
@@ -94,4 +125,12 @@ public interface Comment extends UpdateTracking {
   @Nullable
   @JsonProperty("_links")
   CommentLinks links();
+
+  /** Node ID */
+  @Nullable
+  String nodeId();
+
+  /** Pull request review ID. */
+  @Nullable
+  Long pullRequestReviewId();
 }

src/main/java/com/spotify/github/v3/prs/PullRequestItem.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.
@@ -122,6 +122,12 @@ public interface PullRequestItem extends PartialPullRequestItem {
   @JsonProperty("requested_teams")
   List<User> requestedTeams();
 
-  /** @Deprecated the merge commit sha. */
+  /**
+   * @Deprecated the merge commit sha.
+   */
   Optional<String> mergeCommitSha();
+
+  /** Node ID. */
+  @Nullable
+  String nodeId();
 }

src/test/java/com/spotify/github/v3/activity/events/IssueCommentEventTest.java

@@ -0,0 +1,49 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2020 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.activity.events;
+
+import java.io.IOException;
+import static java.nio.charset.Charset.defaultCharset;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+import org.junit.jupiter.api.Test;
+
+import com.google.common.io.Resources;
+import static com.google.common.io.Resources.getResource;
+import com.spotify.github.jackson.Json;
+
+public class IssueCommentEventTest {
+
+  @Test
+  public void testDeserialization() throws IOException {
+    String fixture =
+        Resources.toString(
+            getResource(this.getClass(), "fixtures/issue_comment_event.json"), defaultCharset());
+    final IssueCommentEvent event = Json.create().fromJson(fixture, IssueCommentEvent.class);
+    assertThat(event.action(), is("created"));
+    assertThat(event.issue().number(), is(2L));
+    assertThat(event.comment().id(), is(99262140L));
+    assertThat(event.comment().nodeId(), is("asd123"));
+    assertThat(
+        event.comment().body(), is("You are totally right! I'll get this fixed right away."));
+  }
+}

src/test/java/com/spotify/github/v3/activity/events/PullRequestReviewCommentEventTest.java

@@ -0,0 +1,60 @@
+/*-
+ * -\-\-
+ * github-client
+ * --
+ * Copyright (C) 2016 - 2020 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.activity.events;
+
+import java.io.IOException;
+import static java.nio.charset.Charset.defaultCharset;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+import org.junit.jupiter.api.Test;
+
+import com.google.common.io.Resources;
+import static com.google.common.io.Resources.getResource;
+import com.spotify.github.jackson.Json;
+
+public class PullRequestReviewCommentEventTest {
+  @Test
+  public void testDeserialization() throws IOException {
+    String fixture =
+        Resources.toString(
+            getResource(this.getClass(), "fixtures/pull_request_review_comment_event.json"),
+            defaultCharset());
+    final PullRequestReviewCommentEvent event =
+        Json.create().fromJson(fixture, PullRequestReviewCommentEvent.class);
+    assertThat(event.action(), is("created"));
+    assertThat(event.comment().id(), is(29724692L));
+    assertThat(event.comment().nodeId(), is("abc234"));
+    assertThat(event.pullRequest().nodeId(), is("abc123"));
+    assertThat(event.comment().body(), is("Maybe you should use more emojji on this line."));
+    assertThat(event.comment().originalCommitId(), is("0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c"));
+    assertThat(event.comment().originalLine(), is(1));
+    assertThat(event.comment().originalPosition(), is(1));
+    assertThat(event.comment().originalStartLine(), is(1));
+    assertThat(event.comment().line(), is(1));
+    assertThat(event.comment().side(), is("RIGHT"));
+    assertThat(event.comment().startLine(), is(1));
+    assertThat(event.comment().startSide(), is("RIGHT"));
+    assertThat(event.comment().authorAssociation(), is("NONE"));
+    assertThat(event.comment().pullRequestReviewId(), is(42L));
+    assertThat(event.comment().inReplyToId(), is(426899381L));
+  }
+}