SONAR-2404 Extend the Review web service API to create & update

- Java client WS: create, update and delete queries
- Added the ID of each comment on a review (JSON and XML) to be able
  to cleanly delete the last comment of a review

5 files changed, 408 insertions, 4 deletions

diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Review.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Review.java
index 91c84411c83..ba17f28d376 100644
--- a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Review.java
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Review.java
@@ -251,8 +251,8 @@ public class Review extends Model {
     return comments;
   }
 
-  public Review addComments(Date updatedAt, String authorLogin, String text) {
-    this.comments.add(new Review.Comment(updatedAt, authorLogin, text));
+  public Review addComments(Long id, Date updatedAt, String authorLogin, String text) {
+    this.comments.add(new Review.Comment(id, updatedAt, authorLogin, text));
     return this;
   }
 
@@ -261,17 +261,27 @@ public class Review extends Model {
    */
   public static final class Comment extends Model {
 
+    private Long id = null;
     private String authorLogin = null;
     private Date updatedAt = null;
     private String text = null;
 
-    private Comment(Date updatedAt, String authorLogin, String text) {
+    private Comment(Long id, Date updatedAt, String authorLogin, String text) {
+      this.id = id;
       this.updatedAt = updatedAt;
       this.authorLogin = authorLogin;
       this.text = text;
     }
 
     /**
+     * @since 2.9
+     * @return the id
+     */
+    public Long getId() {
+      return id;
+    }
+
+    /**
      * @return the authorLogin
      */
     public String getAuthorLogin() {
diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewCreateQuery.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewCreateQuery.java
new file mode 100644
index 00000000000..96d7a57c66a
--- /dev/null
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewCreateQuery.java
@@ -0,0 +1,141 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * @since 2.9
+ */
+public class ReviewCreateQuery extends UpdateQuery<Review> {
+
+  private Long violationId;
+  private String text;
+  private String assignee;
+  private Boolean falsePositive;
+
+  public ReviewCreateQuery() {
+  }
+
+  /**
+   * Builds a request that will create a simple review on a violation, without any assignee.
+   * 
+   * @param violationId
+   *          The id of the violation that is reviewed
+   * @param text
+   *          The comment of the review
+   */
+  public static ReviewCreateQuery createSimpleReviewQuery(Long violationId, String text) {
+    ReviewCreateQuery query = new ReviewCreateQuery();
+    query.setText(text);
+    query.setViolationId(violationId);
+    return query;
+  }
+
+  /**
+   * Builds a request that will create a simple review on a violation and that will be assigned to the given user.
+   * 
+   * @param violationId
+   *          The id of the violation that is reviewed
+   * @param text
+   *          The comment of the review
+   * @param userLogin
+   *          The login of the user whom this review will be assigned to
+   */
+  public static ReviewCreateQuery createAssignedReviewQuery(Long violationId, String text, String userLogin) {
+    ReviewCreateQuery query = createSimpleReviewQuery(violationId, text);
+    query.setAssignee(userLogin);
+    return query;
+  }
+
+  /**
+   * Builds a request that will create a false-positive review on a violation.
+   * 
+   * @param violationId
+   *          The id of the violation that is reviewed
+   * @param text
+   *          The comment of the review
+   */
+  public static ReviewCreateQuery createFalsePositiveReviewQuery(Long violationId, String text) {
+    ReviewCreateQuery query = createSimpleReviewQuery(violationId, text);
+    query.setFalsePositive(Boolean.TRUE);
+    return query;
+  }
+
+  public Long getViolationId() {
+    return violationId;
+  }
+
+  public ReviewCreateQuery setViolationId(Long violationId) {
+    this.violationId = violationId;
+    return this;
+  }
+
+  public String getText() {
+    return text;
+  }
+
+  public ReviewCreateQuery setText(String text) {
+    this.text = text;
+    return this;
+  }
+
+  public String getAssignee() {
+    return assignee;
+  }
+
+  public ReviewCreateQuery setAssignee(String userLogin) {
+    this.assignee = userLogin;
+    return this;
+  }
+
+  public Boolean getFalsePositive() {
+    return falsePositive;
+  }
+
+  public ReviewCreateQuery setFalsePositive(Boolean falsePositive) {
+    this.falsePositive = falsePositive;
+    return this;
+  }
+
+  @Override
+  public String getUrl() {
+    StringBuilder url = new StringBuilder();
+    url.append(ReviewQuery.BASE_URL);
+    url.append("/");
+    url.append('?');
+    appendUrlParameter(url, "violation_id", getViolationId());
+    appendUrlParameter(url, "text", getText());
+    appendUrlParameter(url, "assignee", getAssignee());
+    appendUrlParameter(url, "false_positive", getFalsePositive());
+    return url.toString();
+  }
+
+  /**
+   * Property 'text' is transmitted through request body as content may exceed URL size allowed by the server.
+   */
+  @Override
+  public String getBody() {
+    return text;
+  }
+
+  @Override
+  public Class<Review> getModelClass() {
+    return Review.class;
+  }
+}
diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewDeleteQuery.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewDeleteQuery.java
new file mode 100644
index 00000000000..fc919b00ea5
--- /dev/null
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewDeleteQuery.java
@@ -0,0 +1,82 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * @since 2.9
+ */
+public class ReviewDeleteQuery extends CreateQuery<Review> {
+
+  private Long reviewId;
+  private Long commentId;
+
+  public ReviewDeleteQuery() {
+  }
+
+  /**
+   * Builds a request that will delete the comment of a review. For the moment, only the last comment can be deleted, and only the author of
+   * this comment is allowed to do so.
+   * 
+   * @param reviewId
+   *          the id of the review
+   * @param commentId
+   *          the id of the comment to delete
+   */
+  public static ReviewDeleteQuery deleteCommentQuery(Long reviewId, Long commentId) {
+    ReviewDeleteQuery query = new ReviewDeleteQuery();
+    query.reviewId = reviewId;
+    query.commentId = commentId;
+    return query;
+  }
+
+  public Long getReviewId() {
+    return reviewId;
+  }
+
+  public ReviewDeleteQuery setReviewId(Long reviewId) {
+    this.reviewId = reviewId;
+    return this;
+  }
+
+  public Long getCommentId() {
+    return commentId;
+  }
+
+  public ReviewDeleteQuery setCommentId(Long commentId) {
+    this.commentId = commentId;
+    return this;
+  }
+
+  @Override
+  public String getUrl() {
+    StringBuilder url = new StringBuilder();
+    url.append(ReviewQuery.BASE_URL);
+    url.append("/");
+    url.append('?');
+    appendUrlParameter(url, "id", getReviewId());
+    appendUrlParameter(url, "comment_id", getCommentId());
+    return url.toString();
+  }
+
+  @Override
+  public Class<Review> getModelClass() {
+    return Review.class;
+  }
+}
diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewUpdateQuery.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewUpdateQuery.java
new file mode 100644
index 00000000000..328ec295216
--- /dev/null
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/ReviewUpdateQuery.java
@@ -0,0 +1,170 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.wsclient.services;
+
+/**
+ * @since 2.9
+ */
+public class ReviewUpdateQuery extends CreateQuery<Review> {
+
+  private Long reviewId;
+  private String text;
+  private String newText;
+  private String assignee;
+  private Boolean falsePositive;
+
+  public ReviewUpdateQuery() {
+  }
+
+  /**
+   * Builds a request that will add a comment on a an existing review.
+   * 
+   * @param reviewId
+   *          The id of the review
+   * @param text
+   *          The new comment
+   */
+  public static ReviewUpdateQuery addCommentQuery(Long reviewId, String text) {
+    ReviewUpdateQuery query = new ReviewUpdateQuery();
+    query.setReviewId(reviewId);
+    query.setNewText(text);
+    return query;
+  }
+
+  /**
+   * Builds a request that will update the false-positive status of an existing review.
+   * 
+   * @param reviewId
+   *          The id of the review
+   * @param text
+   *          The comment for this modification
+   * @param falsePositive
+   *          the new false positive status of the review
+   */
+  public static ReviewUpdateQuery updateFalsePositiveQuery(Long reviewId, String text, Boolean falsePositive) {
+    ReviewUpdateQuery query = addCommentQuery(reviewId, text);
+    query.setFalsePositive(falsePositive);
+    return query;
+  }
+
+  /**
+   * Builds a request that will reassign an existing review to the given user. <br/>
+   * <br/>
+   * To unassign the review, simply pass "none" for the user login.
+   * 
+   * @param reviewId
+   *          The id of the review that is reviewed
+   * @param userLogin
+   *          The login of the user whom this review will be assigned to, or "none" to unassign
+   */
+  public static ReviewUpdateQuery reassignQuery(Long reviewId, String userLogin) {
+    ReviewUpdateQuery query = new ReviewUpdateQuery();
+    query.setReviewId(reviewId);
+    query.setAssignee(userLogin);
+    return query;
+  }
+
+  /**
+   * Builds a request that will edit the last comment of a an existing review (if the last comment belongs to the current user).
+   * 
+   * @param reviewId
+   *          The id of the review
+   * @param text
+   *          The new text for the last comment
+   */
+  public static ReviewUpdateQuery editLastCommentQuery(Long reviewId, String text) {
+    ReviewUpdateQuery query = new ReviewUpdateQuery();
+    query.setReviewId(reviewId);
+    query.setText(text);
+    return query;
+  }
+
+  public Long getReviewId() {
+    return reviewId;
+  }
+
+  public ReviewUpdateQuery setReviewId(Long reviewId) {
+    this.reviewId = reviewId;
+    return this;
+  }
+
+  public String getText() {
+    return text;
+  }
+
+  public ReviewUpdateQuery setText(String text) {
+    this.text = text;
+    return this;
+  }
+
+  public String getNewText() {
+    return newText;
+  }
+
+  public ReviewUpdateQuery setNewText(String text) {
+    this.newText = text;
+    return this;
+  }
+
+  public String getAssignee() {
+    return assignee;
+  }
+
+  public ReviewUpdateQuery setAssignee(String userLogin) {
+    this.assignee = userLogin;
+    return this;
+  }
+
+  public Boolean getFalsePositive() {
+    return falsePositive;
+  }
+
+  public ReviewUpdateQuery setFalsePositive(Boolean falsePositive) {
+    this.falsePositive = falsePositive;
+    return this;
+  }
+
+  @Override
+  public String getUrl() {
+    StringBuilder url = new StringBuilder();
+    url.append(ReviewQuery.BASE_URL);
+    url.append("/");
+    url.append('?');
+    appendUrlParameter(url, "id", getReviewId());
+    appendUrlParameter(url, "text", getText());
+    appendUrlParameter(url, "new_text", getNewText());
+    appendUrlParameter(url, "assignee", getAssignee());
+    appendUrlParameter(url, "false_positive", getFalsePositive());
+    return url.toString();
+  }
+
+  /**
+   * Properties 'text' or 'new_text' are transmitted through request body as content may exceed URL size allowed by the server.
+   */
+  @Override
+  public String getBody() {
+    return text == null ? newText : text;
+  }
+
+  @Override
+  public Class<Review> getModelClass() {
+    return Review.class;
+  }
+}
diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/unmarshallers/ReviewUnmarshaller.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/unmarshallers/ReviewUnmarshaller.java
index 449d45b3f3b..f3fbb3a57e4 100644
--- a/sonar-ws-client/src/main/java/org/sonar/wsclient/unmarshallers/ReviewUnmarshaller.java
+++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/unmarshallers/ReviewUnmarshaller.java
@@ -49,7 +49,8 @@ public class ReviewUnmarshaller extends AbstractUnmarshaller<Review> {
     if (comments != null) {
       for (int i = 0; i < utils.getArraySize(comments); i++) {
         Object comment = utils.getArrayElement(comments, i);
-        review.addComments(utils.getDateTime(comment, "updatedAt"), utils.getString(comment, "author"), utils.getString(comment, "text"));
+        review.addComments(utils.getLong(comment, "id"), utils.getDateTime(comment, "updatedAt"), utils.getString(comment, "author"),
+            utils.getString(comment, "text"));
       }
     }