location serializer added (#591)

Author: Cameron Mace

mapbox/libandroid-telemetry/src/main/java/com/mapbox/services/android/telemetry/navigation/MapboxNavigationEvent.java

@@ -135,6 +135,7 @@ public static Hashtable<String, Object> buildFeedbackEvent(
     String upcomingModifier, String upcomingName, String previousInstruction, String previousType,
     String previousModifier, String previousName, int distance, int duration, int stepDistanceRemaining,
     int stepDurationRemaining, int stepCount, int originalStepCount) {
+    NavigationLocation navigationLoc = new NavigationLocation();
     Hashtable<String, Object> event = getMetadata(sdKIdentifier, sdkVersion, sessionIdentifier,
       lat, lng, geometry, profile, estimatedDistance, estimatedDuration, rerouteCount,
       isSimulation, originalRequestIdentifier, requestIdentifier, originalGeometry,
@@ -150,12 +151,12 @@ public static Hashtable<String, Object> buildFeedbackEvent(
     event.put(KEY_START_TIMESTAMP, TelemetryUtils.generateCreateDateFormatted(startTimestamp));
     event.put(KEY_FEEDBACK_TYPE, feedbackType);
     if (locationsBefore != null) {
-      event.put(KEY_LOCATIONS_BEFORE, locationsBefore);
+      event.put(KEY_LOCATIONS_BEFORE, navigationLoc.getSerializedJson(locationsBefore));
     } else {
       event.put(KEY_LOCATIONS_BEFORE, JSONObject.NULL);
     }
     if (locationsAfter != null) {
-      event.put(KEY_LOCATIONS_AFTER, locationsAfter);
+      event.put(KEY_LOCATIONS_AFTER, navigationLoc.getSerializedJson(locationsAfter));
     } else {
       event.put(KEY_LOCATIONS_AFTER, JSONObject.NULL);
     }
@@ -180,6 +181,7 @@ public static Hashtable<String, Object> buildRerouteEvent(
     String upcomingName, String previousInstruction, String previousType, String previousModifier,
     String previousName, int distance, int duration, int stepDistanceRemaining, int stepDurationRemaining,
     int stepCount, int originalStepCount) {
+    NavigationLocation navigationLoc = new NavigationLocation();
     Hashtable<String, Object> event = getMetadata(sdKIdentifier, sdkVersion, sessionIdentifier,
       lat, lng, geometry, profile, estimatedDistance, estimatedDuration, rerouteCount,
       isSimulation, originalRequestIdentifier, requestIdentifier, originalGeometry,
@@ -191,12 +193,12 @@ public static Hashtable<String, Object> buildRerouteEvent(
     event.put(KEY_FEEDBACK_ID, feedbackId);
     event.put(KEY_START_TIMESTAMP, TelemetryUtils.generateCreateDateFormatted(startTimestamp));
     if (locationsBefore != null) {
-      event.put(KEY_LOCATIONS_BEFORE, locationsBefore);
+      event.put(KEY_LOCATIONS_BEFORE, navigationLoc.getSerializedJson(locationsBefore));
     } else {
       event.put(KEY_LOCATIONS_BEFORE, JSONObject.NULL);
     }
     if (locationsAfter != null) {
-      event.put(KEY_LOCATIONS_AFTER, locationsAfter);
+      event.put(KEY_LOCATIONS_AFTER, navigationLoc.getSerializedJson(locationsAfter));
     } else {
       event.put(KEY_LOCATIONS_AFTER, JSONObject.NULL);
     }

mapbox/libandroid-telemetry/src/main/java/com/mapbox/services/android/telemetry/navigation/NavigationLocation.java

@@ -0,0 +1,58 @@
+package com.mapbox.services.android.telemetry.navigation;
+
+import android.location.Location;
+import android.util.JsonToken;
+
+import org.json.JSONArray;
+import org.json.JSONObject;
+
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.TimeZone;
+
+public class NavigationLocation {
+
+  private static final String UTC_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
+  private static final String ACCURACY = "horizontalAccuracy";
+  private static final String TIMESTAMP = "timestamp";
+  private static final String ALTITUDE = "altitude";
+  private static final String COURSE = "course";
+  private static final String LONGITUDE = "lng";
+  private static final String LATITUDE = "lat";
+  private static final String SPEED = "speed";
+
+  public JSONArray getSerializedJson(Location[] locations) {
+    JSONArray jsonArray = new JSONArray();
+    for (Location loc : locations) {
+      jsonArray.put(serializeToJson(loc));
+    }
+    return jsonArray;
+  }
+
+  private JSONObject serializeToJson(Location location) {
+    formatLocationTime(location);
+
+    HashMap<String, Object> map = new HashMap<>();
+    // Potentially null values
+    map.put(ALTITUDE, location.hasAltitude() ? location.getAltitude() : JsonToken.NULL);
+    map.put(ACCURACY, location.hasAccuracy() ? location.getAccuracy() : JsonToken.NULL);
+    map.put(COURSE, location.hasBearing() ? location.getBearing() : JsonToken.NULL);
+    map.put(SPEED, location.hasSpeed() ? location.getSpeed() : JsonToken.NULL);
+
+    // Never null values
+    map.put(LATITUDE, location.getLatitude());
+    map.put(LONGITUDE, location.getLongitude());
+    map.put(TIMESTAMP, formatLocationTime(location));
+
+    return new JSONObject(map);
+  }
+
+  private static String formatLocationTime(Location location) {
+    DateFormat formatter = new SimpleDateFormat(UTC_TIME_FORMAT, Locale.US);
+    formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
+    return formatter.format(new Date(location.getTime()));
+  }
+}