Merge pull request #33 from brunodea/add-create-review

Add createReview action to PullRequestClient

Author: hewhomustnotbenamed

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

@@ -27,10 +27,7 @@
 
 import com.google.common.base.Strings;
 import com.spotify.github.async.AsyncPage;
-import com.spotify.github.v3.prs.Review;
-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.*;
 import com.spotify.github.v3.prs.requests.PullRequestCreate;
 import com.spotify.github.v3.prs.requests.PullRequestParameters;
 import com.spotify.github.v3.prs.requests.PullRequestUpdate;
@@ -162,6 +159,20 @@ public Iterator<AsyncPage<Review>> listReviews(final int number, final int items
     return new GithubPageIterator<>(new GithubPage<>(github, path, LIST_REVIEW_TYPE_REFERENCE));
   }
 
+  /**
+   * Creates a review for a pull request.
+   *
+   * @param number pull request number
+   * @param properties properties for reviewing the PR, such as sha, body and event
+   * @see "https://developer.github.com/v3/pulls/reviews/#create-a-review-for-a-pull-request"
+   */
+  public CompletableFuture<Review> createReview(final int number, final ReviewParameters properties) {
+    final String path = String.format(PR_REVIEWS_TEMPLATE, owner, repo, number);
+    final String jsonPayload = github.json().toJsonUnchecked(properties);
+    log.debug("Creating review for PR: " + path);
+    return github.post(path, jsonPayload, Review.class);
+  }
+
   /**
    * Merges a pull request.
    *

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

@@ -0,0 +1,64 @@
+/*-
+ * -\-\-
+ * 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.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.spotify.github.GithubStyle;
+import java.util.Optional;
+import org.immutables.value.Value;
+
+/**
+ * The parameters for creating a review for a Pull Request.
+ *
+ * @see "https://developer.github.com/v3/pulls/reviews/#input"
+ */
+@Value.Immutable
+@GithubStyle
+@JsonSerialize(as = ImmutableReviewParameters.class)
+@JsonDeserialize(as = ImmutableReviewParameters.class)
+@JsonInclude(JsonInclude.Include.NON_ABSENT)
+public abstract class ReviewParameters {
+    /**
+     * SHA of the commit that needs a review. If not the latest, the review may be outdated.
+     * Defaults to the most recent commit in the PR when you do not specify a value.
+     *
+     * @return the optional commitId.
+     */
+    public abstract Optional<String> commitId();
+
+    /**
+     * **required** when using REQUEST_CHANGES or COMMENT for the event.
+     *
+     * @return the optional body for REQUEST_CHANGES or COMMENT events.
+     */
+    public abstract Optional<String> body();
+
+    /**
+     * Review action you want to perform. Should be one of: APPROVE, REQUEST_CHANGES or COMMENT.
+     *
+     * @return the review action to perform.
+     */
+    public abstract String event();
+
+    // FIXME: add the missing input for reviews: array of comment objects.
+}