Improve metadata serialization for events

Author: jamo

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

@@ -16,6 +16,8 @@
 import fi.helsinki.cs.tmc.utilities.ByteArrayGsonSerializer;
 import fi.helsinki.cs.tmc.utilities.CancellableCallable;
 import fi.helsinki.cs.tmc.utilities.ExceptionUtils;
+import fi.helsinki.cs.tmc.utilities.JsonMaker;
+import fi.helsinki.cs.tmc.utilities.JsonMakerGsonSerializer;
 import fi.helsinki.cs.tmc.utilities.UriUtils;
 import fi.helsinki.cs.tmc.utilities.http.FailedHttpResponseException;
 import fi.helsinki.cs.tmc.utilities.http.HttpTasks;
@@ -37,13 +39,13 @@
  */
 public class ServerAccess {
     public static final int API_VERSION = 7;
-    
+
     private TmcSettings settings;
     private CourseListParser courseListParser;
     private CourseInfoParser courseInfoParser;
     private ReviewListParser reviewListParser;
     private String clientVersion;
-    
+
     public ServerAccess() {
         this(TmcSettings.getDefault());
     }
@@ -64,30 +66,30 @@ public ServerAccess(
         this.reviewListParser = reviewListParser;
         this.clientVersion = getClientVersion();
     }
-    
+
     private static String getClientVersion() {
         return Modules.getDefault().ownerOf(ServerAccess.class).getSpecificationVersion().toString();
     }
-    
+
     public void setSettings(TmcSettings settings) {
         this.settings = settings;
     }
-    
+
     private String getCourseListUrl() {
         return addApiCallQueryParameters(settings.getServerBaseUrl() + "/courses.json");
     }
-    
+
     private String addApiCallQueryParameters(String url) {
         url = UriUtils.withQueryParam(url, "api_version", ""+API_VERSION);
         url = UriUtils.withQueryParam(url, "client", "netbeans_plugin");
         url = UriUtils.withQueryParam(url, "client_version", clientVersion);
         return url;
     }
-    
+
     private HttpTasks createHttpTasks() {
         return new HttpTasks().setCredentials(settings.getUsername(), settings.getPassword());
     }
-    
+
     public boolean hasEnoughSettings() {
         return
                 !settings.getUsername().isEmpty() &&
@@ -101,7 +103,7 @@ public boolean needsOnlyPassword() {
                 settings.getPassword().isEmpty() &&
                 !settings.getServerBaseUrl().isEmpty();
     }
-    
+
     public CancellableCallable<List<Course>> getDownloadingCourseListTask() {
         final CancellableCallable<String> download = createHttpTasks().getForText(getCourseListUrl());
         return new CancellableCallable<List<Course>>() {
@@ -142,7 +144,7 @@ public boolean cancel() {
             }
         };
     }
-    
+
     public CancellableCallable<Void> getUnlockingTask(Course course) {
         Map<String, String> params = Collections.emptyMap();
         final CancellableCallable<String> download = createHttpTasks().postForText(getUnlockUrl(course), params);
@@ -163,16 +165,16 @@ public boolean cancel() {
             }
         };
     }
-    
+
     private String getUnlockUrl(Course course) {
         return addApiCallQueryParameters(course.getUnlockUrl());
     }
-    
+
     public CancellableCallable<byte[]> getDownloadingExerciseZipTask(Exercise exercise) {
         String zipUrl = exercise.getDownloadUrl();
         return createHttpTasks().getForBinary(zipUrl);
     }
-    
+
     public CancellableCallable<byte[]> getDownloadingExerciseSolutionZipTask(Exercise exercise) {
         String zipUrl = exercise.getSolutionDownloadUrl();
         return createHttpTasks().getForBinary(zipUrl);
@@ -188,7 +190,7 @@ public CancellableCallable<SubmissionResponse> getSubmittingExerciseTask(final E
 
         final CancellableCallable<String> upload =
                 createHttpTasks().uploadFileForTextDownload(submitUrl, params, "submission[file]", sourceZip);
-        
+
         return new CancellableCallable<SubmissionResponse>() {
             @Override
             public SubmissionResponse call() throws Exception {
@@ -198,7 +200,7 @@ public SubmissionResponse call() throws Exception {
                 } catch (FailedHttpResponseException ex) {
                     return checkForObsoleteClient(ex);
                 }
-                
+
                 JsonObject respJson = new JsonParser().parse(response).getAsJsonObject();
                 if (respJson.get("error") != null) {
                     throw new RuntimeException("Server responded with error: " + respJson.get("error"));
@@ -230,11 +232,11 @@ public SubmissionResponse(URI submissionUrl, URI pasteUrl) {
             this.pasteUrl = pasteUrl;
         }
     }
-    
+
     public CancellableCallable<String> getSubmissionFetchTask(String submissionUrl) {
         return createHttpTasks().getForText(submissionUrl);
     }
-    
+
     public CancellableCallable<List<Review>> getDownloadingReviewListTask(Course course) {
         String url = addApiCallQueryParameters(course.getReviewsUrl());
         final CancellableCallable<String> download = createHttpTasks().getForText(url);
@@ -255,7 +257,7 @@ public boolean cancel() {
             }
         };
     }
-    
+
     public CancellableCallable<Void> getMarkingReviewAsReadTask(Review review, boolean read) {
         String url = addApiCallQueryParameters(review.getUpdateUrl() + ".json");
         Map<String, String> params = new HashMap<String, String>();
@@ -265,7 +267,7 @@ public CancellableCallable<Void> getMarkingReviewAsReadTask(Review review, boole
         } else {
             params.put("mark_as_unread", "1");
         }
-        
+
         final CancellableCallable<String> task = createHttpTasks().postForText(url, params);
         return new CancellableCallable<Void>() {
             @Override
@@ -280,20 +282,20 @@ public boolean cancel() {
             }
         };
     }
-    
+
     public CancellableCallable<String> getFeedbackAnsweringJob(String answerUrl, List<FeedbackAnswer> answers) {
         final String submitUrl = addApiCallQueryParameters(answerUrl);
-        
+
         Map<String, String> params = new HashMap<String, String>();
         for (int i = 0; i < answers.size(); ++i) {
             String keyPrefix = "answers[" + i + "]";
             FeedbackAnswer answer = answers.get(i);
             params.put(keyPrefix + "[question_id]", "" + answer.getQuestion().getId());
             params.put(keyPrefix + "[answer]", answer.getAnswer());
         }
-        
+
         final CancellableCallable<String> upload = createHttpTasks().postForText(submitUrl, params);
-        
+
         return new CancellableCallable<String>() {
             @Override
             public String call() throws Exception {
@@ -310,7 +312,7 @@ public boolean cancel() {
             }
         };
     }
-    
+
     public CancellableCallable<Object> getSendEventLogJob(String spywareServerUrl, List<LoggableEvent> events) {
         String url = addApiCallQueryParameters(spywareServerUrl);
 
@@ -347,8 +349,10 @@ private byte[] eventListToPostBody(List<LoggableEvent> events) throws IOExceptio
         GZIPOutputStream gzos = new GZIPOutputStream(bufferBos);
         OutputStreamWriter bufferWriter = new OutputStreamWriter(gzos, Charset.forName("UTF-8"));
 
+
         Gson gson = new GsonBuilder()
                 .registerTypeAdapter(byte[].class, new ByteArrayGsonSerializer())
+                .registerTypeAdapter(JsonMaker.class, new JsonMakerGsonSerializer())
                 .create();
 
         gson.toJson(events, new TypeToken<List<LoggableEvent>>(){}.getType(), bufferWriter);
@@ -357,7 +361,7 @@ private byte[] eventListToPostBody(List<LoggableEvent> events) throws IOExceptio
 
         return bufferBos.toByteArray();
     }
-    
+
     private <T> T checkForObsoleteClient(FailedHttpResponseException ex) throws ObsoleteClientException, FailedHttpResponseException {
         if (ex.getStatusCode() == 404) {
             boolean obsolete;

tmc-plugin/src/fi/helsinki/cs/tmc/utilities/JsonMakerGsonSerializer.java

@@ -0,0 +1,34 @@
+package fi.helsinki.cs.tmc.utilities;
+
+import com.google.gson.JsonDeserializationContext;
+import com.google.gson.JsonDeserializer;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonNull;
+import com.google.gson.JsonParseException;
+import com.google.gson.JsonPrimitive;
+import com.google.gson.JsonSerializationContext;
+import com.google.gson.JsonSerializer;
+import java.lang.reflect.Type;
+import java.nio.charset.Charset;
+import org.apache.commons.codec.binary.Base64;
+
+/**
+ * Converts JsonMaker to byte[] to base64 in JSON.
+ */
+
+public class JsonMakerGsonSerializer implements JsonSerializer<JsonMaker> /*, JsonDeserializer<JsonMaker> */ {
+    @Override
+    public JsonElement serialize(JsonMaker data, Type type, JsonSerializationContext jsc) {
+
+        if (data == null) {
+            return JsonNull.INSTANCE;
+        } else {
+            return new JsonPrimitive(Base64.encodeBase64String(data.toString().getBytes(Charset.forName("UTF-8"))));
+        }
+    }
+
+//    @Override
+//    public JsonMaker deserialize(JsonElement je, Type type, JsonDeserializationContext jdc) throws JsonParseException {
+//        return null;
+//    }
+}