Merge pull request #35 from developmentseed/feature/trace-as-gpx

Download trace as GPX
developmentseed · Nov 22, 2019 · f9db9e9 · f9db9e9
2 parents 25275d7 + ea1615a
commit f9db9e9
Show file tree

Hide file tree

Showing 5 changed files with 174 additions and 30 deletions.
diff --git a/app/_apidoc.js b/app/_apidoc.js
@@ -87,3 +87,39 @@
  *       }
  *     }
  */
+
+/**
+ * @apiDefine Success200GPX
+ *
+ * @apiSuccess {String} file Trace in GPX format.
+ * @apiSuccessExample {String} Success response:
+ *     HTTP/1.1 200 Success
+ *     <gpx xmlns="http://www.topografix.com/GPX/1/1"
+ *     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd" version="1.1" creator="togpx">
+ *     <metadata/>
+ *     <trk>
+ *       <name>_EQOlQXjjY</name>
+ *       <desc>id=_EQOlQXjjY ownerId=709 ownerDisplayName=vitor description=This is a TraceJSON file. length=534.717</desc>
+ *       <trkseg>
+ *         <trkpt lat="-23.5927391909129" lon="-46.6599869728088">
+ *           <time>2019-07-24T23:34:20.021Z</time>
+ *         </trkpt>
+ *         <trkpt lat="-23.5919329603572" lon="-46.6597080230712">
+ *           <time>2019-07-24T23:34:21.801Z</time>
+ *         </trkpt>
+ *         <trkpt lat="-23.590930081288" lon="-46.6589999198913">
+ *           <time>2019-07-24T23:34:22.345Z</time>
+ *         </trkpt>
+ *         <trkpt lat="-23.590320484382" lon="-46.6580557823181">
+ *           <time>2019-07-24T23:34:23.968Z</time>
+ *         </trkpt>
+ *         <trkpt lat="-23.5900648461272" lon="-46.6571545600891">
+ *           <time>2019-07-24T23:34:24.112Z</time>
+ *         </trkpt>
+ *         <trkpt lat="-23.58951423896" lon="-46.6564464569091">
+ *           <time>2019-07-24T23:34:25.883Z</time>
+ *         </trkpt>
+ *       </trkseg>
+ *     </trk>
+ *     </gpx>
+ */
diff --git a/app/routes/traces/get.js b/app/routes/traces/get.js
@@ -3,47 +3,88 @@ import Joi from '@hapi/joi';
 import { getTraceJson } from '../../models/traces';
 import logger from '../../services/logger';
 import config from 'config';
+import togpx from 'togpx';
 
 const idLength = config.get('idLength');
 
-/**
- * @apiGroup Traces
- *
- * @api {get} /traces/:id 4. GET /traces/:id
- * @apiDescription Get trace, must be owner or admin.
- *
- * @apiParam {string} id Trace id.
- *
- * @apiUse Success200TraceJSON
- * @apiUse Error4xx
- */
+const validate = {
+  params: Joi.object({
+    id: Joi.string().length(idLength)
+  })
+};
+
 export default [
+  /**
+   * @apiGroup Traces
+   *
+   * @api {get} /traces/:id 4. GET /traces/:id
+   * @apiDescription Get trace as GeoJSON. Must be trace's owner or admin.
+   *
+   * @apiParam {string} id Trace id.
+   *
+   * @apiUse AuthorizationHeader
+   * @apiUse Success200TraceJSON
+   * @apiUse Error4xx
+   */
   {
     path: '/traces/{id}',
     method: ['GET'],
     options: {
       auth: 'jwt',
-      validate: {
-        params: Joi.object({
-          id: Joi.string().length(idLength)
-        })
-      }
+      validate
     },
-    handler: async function (request, h) {
-      try {
-        const { id } = request.params;
+    handler: handler('json')
+  },
+  /**
+   * @apiGroup Traces
+   *
+   * @api {get} /traces/:id.gpx 5. GET /traces/:id.gpx
+   * @apiDescription Get trace in GPX format. No authorization is required.
+   *
+   * @apiParam {string} id Trace id.
+   *
+   * @apiUse Success200GPX
+   * @apiUse Error4xx
+   */
+  {
+    path: '/traces/{id}.gpx',
+    method: ['GET'],
+    options: {
+      validate
+    },
+    handler: handler('gpx')
+  }
+];
+
+function handler (type) {
+  return async (request, h) => {
+    try {
+      const { id } = request.params;
 
-        const trace = await getTraceJson(id);
+      const trace = await getTraceJson(id);
+
+      if (!trace) {
+        return Boom.notFound(`Trace ${id} not found`);
+      }
 
-        if (!trace) {
-          return Boom.notFound(`Trace ${id} not found`);
-        }
+      if (type === 'gpx') {
+        // Generate GPX file
+        const gpx = togpx(trace, {
+          featureCoordTimes: f =>
+            f.properties.timestamps.map(t => new Date(t).toISOString())
+        });
 
-        return trace;
-      } catch (error) {
-        logger.error(error);
-        return Boom.badImplementation('Unexpected error.');
+        // Return as text/plain
+        const response = h.response(gpx);
+        response.type('text/plain');
+        return response;
       }
+
+      // Return as TraceJSON
+      return trace;
+    } catch (error) {
+      logger.error(error);
+      return Boom.badImplementation('Unexpected error.');
     }
-  }
-];
+  };
+}
diff --git a/app/routes/traces/list.js b/app/routes/traces/list.js
@@ -6,7 +6,7 @@ import logger from '../../services/logger';
 /**
  * @apiGroup Traces
  *
- * @api {get} /traces 5. GET /traces
+ * @api {get} /traces 6. GET /traces
  * @apiDescription Get a list of photos.
  *
  * @apiUse AuthorizationHeader

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -69,6 +69,7 @@
     "pg": "^7.12.1",
     "qs": "^6.9.0",
     "sharp": "^0.23.2",
+    "togpx": "^0.5.4",
     "uuid": "^3.3.3",
     "winston": "^3.2.1",
     "xml-js": "^1.6.11"