feat: Add auto_merge field to the PR class (#226)

Author: Abhi347

src/main/java/com/spotify/github/v3/prs/AutoMerge.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.prs;
+
+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 org.immutables.value.Value;
+
+import javax.annotation.Nullable;
+
+@Value.Immutable
+@GithubStyle
+@JsonSerialize(as = ImmutableAutoMerge.class)
+@JsonDeserialize(as = ImmutableAutoMerge.class)
+public interface AutoMerge {
+  // Who enabled the auto merge
+  User enabledBy();
+
+  // Merge Method chosen for the auto merge
+  String mergeMethod();
+
+  // The commit title to use when merging the pull request
+  @Nullable
+  String commitTitle();
+
+  // The commit message to use when merging the pull request
+  @Nullable
+  String commitMessage();
+}

src/main/java/com/spotify/github/v3/prs/PullRequest.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.
@@ -87,4 +87,7 @@ public interface PullRequest extends PullRequestItem {
 
   @Nullable
   List<Label> labels();
+
+  @Nullable
+  AutoMerge autoMerge();
 }

src/test/java/com/spotify/github/v3/prs/PullRequestTest.java

@@ -24,6 +24,8 @@
 import static java.nio.charset.Charset.defaultCharset;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.Is.is;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
 
 import com.google.common.io.Resources;
 import com.spotify.github.jackson.Json;
@@ -85,6 +87,36 @@ public void testSerializationMergeParams() throws IOException {
     assertThat(params.mergeMethod(), is(MergeMethod.merge));
   }
 
+  @Test
+  public void testSerializationAutoMergeDisabled() throws IOException {
+    String fixture =
+            Resources.toString(getResource(this.getClass(), "pull_request_automerge_disabled.json"), defaultCharset());
+    final PullRequest pr = Json.create().fromJson(fixture, PullRequest.class);
+
+    assertThat(pr.id(), is(2439836648L));
+    assertThat(pr.head().sha(), is("881ef333d1ffc01869b666f13d3b37d7af92b9a2"));
+    assertThat(pr.merged(), is(false));
+    assertThat(pr.mergeable().get(), is(true));
+    assertThat(pr.draft(), is(Optional.of(true)));
+    assertNull(pr.autoMerge());
+  }
+
+  @Test
+  public void testSerializationAutoMergeEnabled() throws IOException {
+    String fixture =
+            Resources.toString(getResource(this.getClass(), "pull_request_automerge_enabled.json"), defaultCharset());
+    final PullRequest pr = Json.create().fromJson(fixture, PullRequest.class);
+
+    assertThat(pr.id(), is(2439836648L));
+    assertThat(pr.head().sha(), is("881ef333d1ffc01869b666f13d3b37d7af92b9a2"));
+    assertThat(pr.merged(), is(false));
+    assertThat(pr.mergeable().get(), is(true));
+    assertThat(pr.draft(), is(Optional.of(false)));
+    assertNotNull(pr.autoMerge());
+    assertThat(pr.autoMerge().enabledBy().login(), is("octocat"));
+    assertThat(pr.autoMerge().mergeMethod(), is("squash"));
+  }
+
   @Test
   public void testDeserializationMergeParamsOmitsFields() throws IOException {
     final MergeParameters params = ImmutableMergeParameters.builder()