feat: Add additional PR field in CheckRunResponse and CheckSuite

Author: Abhi347

src/main/java/com/spotify/github/v3/checks/CheckRunResponse.java

@@ -22,7 +22,11 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.spotify.github.GithubStyle;
+
+import java.util.List;
 import java.util.Optional;
+
+import com.spotify.github.v3.prs.PartialPullRequestItem;
 import org.immutables.value.Value;
 
 /** The CheckRun response resource. */
@@ -73,4 +77,10 @@ public interface CheckRunResponse extends CheckRunBase {
    * @return the optional
    */
   Optional<App> app();
+
+  /**
+   * Pull Requests where this check is applied.
+   * @return the list of pull requests
+   */
+  List<PartialPullRequestItem> pullRequests();
 }

src/main/java/com/spotify/github/v3/checks/CheckSuite.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.
@@ -22,23 +22,34 @@
 
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.spotify.github.GithubStyle;
+
+import java.util.List;
 import java.util.Optional;
+
+import com.spotify.github.v3.prs.PartialPullRequestItem;
 import org.immutables.value.Value;
 
-/** Github CheckSuite */
+/** GitHub CheckSuite */
 @Value.Immutable
 @GithubStyle
 @JsonDeserialize(as = ImmutableCheckSuite.class)
 public interface CheckSuite {
 
   /**
-   * The Check Suite Id.
+   * The Check Suite id.
    *
-   * @return the integer
+   * @return the long id
    */
   Long id();
 
   Optional<App> app();
 
   Optional<String> headBranch();
+
+  /**
+   * Pull Requests where this check suite is applied.
+   *
+   * @return the list of pull requests
+   */
+  List<PartialPullRequestItem> pullRequests();
 }

src/main/java/com/spotify/github/v3/prs/PartialPullRequestItem.java

@@ -0,0 +1,52 @@
+/*-
+ * -\-\-
+ * 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.prs;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.spotify.github.CloseTracking;
+import com.spotify.github.GithubStyle;
+import org.immutables.value.Value;
+
+import javax.annotation.Nullable;
+import java.net.URI;
+
+@Value.Immutable
+@GithubStyle
+@JsonSerialize(as = ImmutablePartialPullRequestItem.class)
+@JsonDeserialize(as = ImmutablePartialPullRequestItem.class)
+public interface PartialPullRequestItem extends CloseTracking {
+  /** ID. */
+  Long id();
+
+  /** URL. */
+  URI url();
+
+  /** Number. */
+  Long number();
+
+  /** Head reference. */
+  @Nullable
+  PullRequestRef head();
+
+  /** Base reference. */
+  @Nullable
+  PullRequestRef base();
+}

src/main/java/com/spotify/github/v3/prs/PullRequestItem.java

@@ -23,7 +23,6 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import com.spotify.github.CloseTracking;
 import com.spotify.github.GitHubInstant;
 import com.spotify.github.GithubStyle;
 import com.spotify.github.v3.Milestone;
@@ -39,15 +38,7 @@
 @GithubStyle
 @JsonSerialize(as = ImmutablePullRequestItem.class)
 @JsonDeserialize(as = ImmutablePullRequestItem.class)
-public interface PullRequestItem extends CloseTracking {
-
-  /** ID. */
-  @Nullable
-  Long id();
-
-  /** URL. */
-  @Nullable
-  URI url();
+public interface PullRequestItem extends PartialPullRequestItem {
 
   /** HTML URL. */
   @Nullable
@@ -69,10 +60,6 @@ public interface PullRequestItem extends CloseTracking {
   @Nullable
   URI commitsUrl();
 
-  /** Number. */
-  @Nullable
-  Integer number();
-
   /** Either open, closed, or all to filter by state. Default: open. */
   @Nullable
   String state();
@@ -100,14 +87,6 @@ public interface PullRequestItem extends CloseTracking {
   /** Merged date. */
   Optional<GitHubInstant> mergedAt();
 
-  /** Head reference. */
-  @Nullable
-  PullRequestRef head();
-
-  /** Base reference. */
-  @Nullable
-  PullRequestRef base();
-
   /** User. */
   @Nullable
   User user();

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

@@ -40,7 +40,7 @@ public void testDeserialization() throws IOException {
     final PullRequestReviewEvent statusEvent =
         Json.create().fromJson(fixture, PullRequestReviewEvent.class);
     assertThat(statusEvent.action(), is("submitted"));
-    assertThat(statusEvent.pullRequest().number(), is(8));
+    assertThat(statusEvent.pullRequest().number(), is(8L));
     assertThat(statusEvent.review().state(), is(ReviewState.APPROVED));
   }
 }

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

@@ -286,7 +286,7 @@ public void listPullRequestsForCommit() throws Exception {
         .thenReturn(fixture);
     final List<PullRequestItem> prs = repoClient.listPullRequestsForCommit("thesha").get();
     assertThat(prs.size(), is(1));
-    assertThat(prs.get(0).number(), is(1347));
+    assertThat(prs.get(0).number(), is(1347L));
   }
 
   @Test