Code review & imports changed to TmcCore Review

Author: Toivanen Pihla I

tmc-plugin/src/fi/helsinki/cs/tmc/actions/CheckForNewReviews.java

@@ -1,13 +1,19 @@
 package fi.helsinki.cs.tmc.actions;
 
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
 import hy.tmc.core.domain.Course;
-import fi.helsinki.cs.tmc.data.Review;
+import hy.tmc.core.domain.Review;
 import fi.helsinki.cs.tmc.model.CourseDb;
+import fi.helsinki.cs.tmc.model.NBTmcSettings;
 import fi.helsinki.cs.tmc.model.ReviewDb;
 import fi.helsinki.cs.tmc.model.ServerAccess;
+import fi.helsinki.cs.tmc.model.TmcCoreSingleton;
 import fi.helsinki.cs.tmc.ui.ConvenientDialogDisplayer;
 import fi.helsinki.cs.tmc.utilities.BgTask;
 import fi.helsinki.cs.tmc.utilities.BgTaskListener;
+import hy.tmc.core.exceptions.TmcCoreException;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.util.List;
@@ -18,24 +24,26 @@
 import org.openide.awt.ActionReference;
 import org.openide.awt.ActionReferences;
 import org.openide.awt.ActionRegistration;
+import org.openide.util.Exceptions;
 import org.openide.util.NbBundle;
 
 @ActionID(category = "TMC",
-id = "fi.helsinki.cs.tmc.actions.CheckForNewReviews")
+        id = "fi.helsinki.cs.tmc.actions.CheckForNewReviews")
 @ActionRegistration(displayName = "#CTL_CheckForNewReviews")
 @ActionReferences({
     @ActionReference(path = "Menu/TM&C", position = -40)
 })
 @NbBundle.Messages("CTL_CheckForNewReviews=Check for new code &reviews")
 public class CheckForNewReviews implements ActionListener, Runnable {
+
     private static final Logger log = Logger.getLogger(CheckForNewReviews.class.getName());
-    
+
     private static CheckForNewReviews instance;
-    
+
     public static void startTimer() {
         if (instance == null) {
             instance = new CheckForNewReviews(true, false, false);
-            int interval = 20*60*1000; // 20 minutes
+            int interval = 20 * 60 * 1000; // 20 minutes
             javax.swing.Timer timer = new javax.swing.Timer(interval, instance);
             timer.setRepeats(true);
             timer.start();
@@ -44,15 +52,15 @@ public static void startTimer() {
             log.warning("CheckForNewReviews.startTimer() called twice");
         }
     }
-    
+
     private ServerAccess serverAccess;
     private CourseDb courseDb;
     private ReviewDb reviewDb;
     private ConvenientDialogDisplayer dialogs;
     private boolean beQuiet;
     private boolean resetNotifications;
     private boolean notifyAboutNoNewReviews;
-    
+
     CheckForNewReviews() {
         this(false, true, true);
     }
@@ -71,13 +79,13 @@ public static void startTimer() {
     public void actionPerformed(ActionEvent e) {
         run();
     }
-    
+
     @Override
     public void run() {
         if (resetNotifications) {
             reviewDb.forgetReviewsNotifiedAbout();
         }
-        
+
         Course course = courseDb.getCurrentCourse();
         if (course == null) {
             if (!beQuiet) {
@@ -88,28 +96,43 @@ public void run() {
         if (course.getReviewsUrl() == null) {
             return;
         }
-        
-        BgTask.start("Checking for code reviews", serverAccess.getDownloadingReviewListTask(course), new BgTaskListener<List<Review>>() {
-            @Override
-            public void bgTaskReady(List<Review> result) {
-                boolean newReviews = reviewDb.setReviews(result);
-                if (!newReviews && notifyAboutNoNewReviews) {
-                    dialogs.displayMessage("You have no unread code reviews.");
+        getReviews(course);
+
+    }
+    
+    private void getReviews(Course course){
+        try {
+            ListenableFuture<List<Review>> reviews = TmcCoreSingleton.getInstance().getNewReviews(course, NBTmcSettings.getDefault());
+            Futures.addCallback(reviews, new FutureCallback<List<Review>>() {
+
+                @Override
+                public void onSuccess(List<Review> v) {
+                    success(v);
                 }
-            }
 
-            @Override
-            public void bgTaskFailed(final Throwable ex) {
-                final String msg = "Failed to check for code reviews";
-                log.log(Level.INFO, msg, ex);
-                if (!beQuiet) {
-                    dialogs.displayError(msg, ex);
+                @Override
+                public void onFailure(Throwable thrwbl) {
+                    fail(thrwbl);
                 }
-            }
 
-            @Override
-            public void bgTaskCancelled() {
-            }
-        });
+            });
+        } catch (TmcCoreException ex) {
+            Exceptions.printStackTrace(ex);
+        }
+    }
+
+    private void success(List<Review> list) {
+        boolean newReviews = reviewDb.setReviews(list);
+        if (!newReviews && notifyAboutNoNewReviews) {
+            dialogs.displayMessage("You have no unread code reviews.");
+        }
+    }
+
+    private void fail(Throwable thrwbl) {
+        final String msg = "Failed to check for code reviews";
+        log.log(Level.INFO, msg, thrwbl);
+        if (!beQuiet) {
+            dialogs.displayError(msg, thrwbl);
+        }
     }
 }

tmc-plugin/src/fi/helsinki/cs/tmc/actions/ReviewEventListener.java

@@ -1,7 +1,7 @@
 package fi.helsinki.cs.tmc.actions;
 
 import com.google.gson.Gson;
-import fi.helsinki.cs.tmc.data.Review;
+import hy.tmc.core.domain.Review;
 import fi.helsinki.cs.tmc.events.TmcEventBus;
 import fi.helsinki.cs.tmc.events.TmcEventListener;
 import fi.helsinki.cs.tmc.model.CourseDb;

tmc-plugin/src/fi/helsinki/cs/tmc/data/Review.java

@@ -1,43 +1,50 @@
 package fi.helsinki.cs.tmc.data;
 
+import com.google.common.base.Optional;
 import com.google.gson.annotations.SerializedName;
-import java.util.ArrayList;
-import java.util.Date;
+import hy.tmc.core.communication.HttpResult;
+import hy.tmc.core.communication.UrlCommunicator;
+import hy.tmc.core.exceptions.TmcCoreException;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 public class Review {
-    @SerializedName("id")
-    private int id;
+
     @SerializedName("submission_id")
     private int submissionId;
+
     @SerializedName("exercise_name")
     private String exerciseName;
+
+    private int id;
+
     @SerializedName("marked_as_read")
     private boolean markedAsRead;
+
     @SerializedName("reviewer_name")
     private String reviewerName;
+
     @SerializedName("review_body")
     private String reviewBody;
-    @SerializedName("points")
-    private ArrayList<String> points;
+
+    private List<String> points;
+
     @SerializedName("points_not_awarded")
-    private ArrayList<String> pointsNotAwarded;
-    @SerializedName("url")
+    private List<String> pointsNotAwarded;
+
     private String url;
+
     @SerializedName("update_url")
     private String updateUrl;
+
     @SerializedName("created_at")
-    private Date createdAt;
-    @SerializedName("updated_at")
-    private Date updatedAt;
+    private String createdAt;
 
-    public int getId() {
-        return id;
-    }
+    @SerializedName("updated_at")
+    private String updatedAt;
 
-    public void setId(int id) {
-        this.id = id;
-    }
-    
     public int getSubmissionId() {
         return submissionId;
     }
@@ -54,6 +61,14 @@ public void setExerciseName(String exerciseName) {
         this.exerciseName = exerciseName;
     }
 
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
     public boolean isMarkedAsRead() {
         return markedAsRead;
     }
@@ -78,19 +93,19 @@ public void setReviewBody(String reviewBody) {
         this.reviewBody = reviewBody;
     }
 
-    public ArrayList<String> getPoints() {
+    public List<String> getPoints() {
         return points;
     }
 
-    public void setPoints(ArrayList<String> points) {
+    public void setPoints(List<String> points) {
         this.points = points;
     }
 
-    public ArrayList<String> getPointsNotAwarded() {
+    public List<String> getPointsNotAwarded() {
         return pointsNotAwarded;
     }
 
-    public void setPointsNotAwarded(ArrayList<String> pointsNotAwarded) {
+    public void setPointsNotAwarded(List<String> pointsNotAwarded) {
         this.pointsNotAwarded = pointsNotAwarded;
     }
 
@@ -110,20 +125,49 @@ public void setUpdateUrl(String updateUrl) {
         this.updateUrl = updateUrl;
     }
 
-    public Date getCreatedAt() {
+    public String getCreatedAt() {
         return createdAt;
     }
 
-    public void setCreatedAt(Date createdAt) {
+    public void setCreatedAt(String createdAt) {
         this.createdAt = createdAt;
     }
 
-    public Date getUpdatedAt() {
+    public String getUpdatedAt() {
         return updatedAt;
     }
 
-    public void setUpdatedAt(Date updatedAt) {
+    public void setUpdatedAt(String updatedAt) {
         this.updatedAt = updatedAt;
     }
-    
+
+    public void markAs(boolean read, UrlCommunicator urlCommunicator) throws IOException, TmcCoreException {
+        Map<String, String> headers = addHeaders(read);
+        HttpResult result = urlCommunicator.makePutRequest(putUrl(), Optional.of(headers));
+        if (result.getData().contains("OK")) {
+            this.markedAsRead = read;
+        }
+    }
+
+    private Map<String, String> addHeaders(boolean read) {
+        Map<String, String> headers = new HashMap<String, String>();
+        String readUpdate = "mark_as_";
+        if (read) {
+            readUpdate += "read";
+        } else {
+            readUpdate += "unread";
+        }
+        headers.put(readUpdate, "1");
+        return headers;
+    }
+
+    private String putUrl() {
+        return this.updateUrl + ".json?api_version=7";
+    }
+
+    @Override
+    public String toString() {
+        return exerciseName + " reviewed by " + reviewerName + ":\n" + reviewBody + "\n"
+                + this.url;
+    }
 }

tmc-plugin/src/fi/helsinki/cs/tmc/data/serialization/ReviewListParser.java

@@ -2,7 +2,7 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import fi.helsinki.cs.tmc.data.Review;
+import hy.tmc.core.domain.Review;
 import java.util.Arrays;
 import java.util.Date;
 import java.util.List;

tmc-plugin/src/fi/helsinki/cs/tmc/model/ReviewDb.java

@@ -1,6 +1,6 @@
 package fi.helsinki.cs.tmc.model;
 
-import fi.helsinki.cs.tmc.data.Review;
+import hy.tmc.core.domain.Review;
 import fi.helsinki.cs.tmc.events.TmcEvent;
 import fi.helsinki.cs.tmc.events.TmcEventBus;
 import java.util.ArrayList;

tmc-plugin/src/fi/helsinki/cs/tmc/model/ServerAccess.java

@@ -11,7 +11,7 @@
 import hy.tmc.core.domain.Course;
 import hy.tmc.core.domain.Exercise;
 import fi.helsinki.cs.tmc.data.FeedbackAnswer;
-import fi.helsinki.cs.tmc.data.Review;
+import hy.tmc.core.domain.Review;
 import fi.helsinki.cs.tmc.data.serialization.CourseInfoParser;
 import fi.helsinki.cs.tmc.data.serialization.CourseListParser;
 import fi.helsinki.cs.tmc.data.serialization.ReviewListParser;

tmc-plugin/src/fi/helsinki/cs/tmc/ui/CodeReviewDialog.java

@@ -1,6 +1,6 @@
 package fi.helsinki.cs.tmc.ui;
 
-import fi.helsinki.cs.tmc.data.Review;
+import hy.tmc.core.domain.Review;
 import java.awt.Dimension;
 import java.awt.Toolkit;
 import java.awt.event.ActionListener;