Merge branch 'development' into management-routes

Author: ubergesundheit

.scripts/deploy-docs.sh

@@ -15,8 +15,10 @@ sed -i "1 s|$| ${TRAVIS_TAG}|" apidoc/introduction.md
 # run apidoc
 apidoc -i . -f js -e node_modules
 
-if [[ -z "${TRAVIS_TAG}" ]]; then
-  echo "Docs can only be built from tags"
+# should contain the current api tag or nothing
+isApiTag=$(echo "${TRAVIS_TAG}" | grep -E '^v[0-9]+$' || true)
+if [[ -z "$isApiTag" ]]; then
+  echo "Docs can only be built from api version tags"
   exit 0
 fi
 

CHANGELOG.md

@@ -1,6 +1,8 @@
 # openSenseMap API Changelog
 
 ## Unreleased
+
+## v4
 - Include sensorId as default column in measurements download
 - Add format parameter to bulk download and descriptive statistics routes
 - Support json format in bulk download route

packages/api/lib/controllers/boxesController.js

@@ -326,7 +326,16 @@ const getBox = async function getBox (req, res, next) {
   const { format, boxId } = req._userParams;
 
   try {
-    res.send(await Box.findBoxById(boxId, { format }));
+    const box = await Box.findBoxById(boxId);
+
+    if (format === 'geojson') {
+      const coordinates = box.currentLocation.coordinates;
+      box.currentLocation = undefined;
+      box.loc = undefined;
+
+      return res.send(point(coordinates, box));
+    }
+    res.send(box);
   } catch (err) {
     handleError(err, next);
   }

packages/models/CHANGELOG.md

@@ -1,6 +1,7 @@
 # @sensebox/opensensemap-api-models Changelog
 
 ## Unreleased
+- Remove format argument of findBoxById
 - Remove box.updateImage
 - Implement deletion of box images
 - Allow updating of box model value

packages/models/package.json

@@ -7,7 +7,6 @@
   "dependencies": {
     "@sensebox/osem-protos": "^1.1.0",
     "@sensebox/sketch-templater": "^1.1.1",
-    "@turf/helpers": "^4.6.0",
     "bcrypt": "^1.0.2",
     "bunyan": "^1.8.12",
     "config": "^1.29.2",

packages/models/src/box/box.js

@@ -16,7 +16,6 @@ const { mongoose } = require('../db'),
   ModelError = require('../modelError'),
   Sketcher = require('@sensebox/sketch-templater'),
   fs = require('fs'),
-  { point } = require('@turf/helpers'),
   log = require('../log');
 
 const templateSketcher = new Sketcher();
@@ -250,7 +249,7 @@ boxSchema.statics.initNew = function ({
 
 };
 
-boxSchema.statics.findBoxById = function findBoxById (id, { lean = true, populate = true, includeSecrets = false, onlyLastMeasurements = false, onlyLocations = false, format, projection = {} } = {}) {
+boxSchema.statics.findBoxById = function findBoxById (id, { lean = true, populate = true, includeSecrets = false, onlyLastMeasurements = false, onlyLocations = false, projection = {} } = {}) {
   let fullBox = populate;
   if (populate) {
     Object.assign(projection, BOX_PROPS_FOR_POPULATION);
@@ -289,14 +288,6 @@ boxSchema.statics.findBoxById = function findBoxById (id, { lean = true, populat
         throw new ModelError('Box not found', { type: 'NotFoundError' });
       }
 
-      if (format === 'geojson') {
-        const coordinates = box.currentLocation.coordinates;
-        box.currentLocation = undefined;
-        box.loc = undefined;
-
-        return point(coordinates, box);
-      }
-
       if (fullBox === true) {
         // fill in box.loc manually, as toJSON & virtuals are not supported in lean queries.
         box.loc = [{ geometry: box.currentLocation, type: 'Feature' }];

packages/models/test/tests/1-box.js

@@ -300,26 +300,6 @@ describe('Box model', function () {
       });
     });
 
-    it('should allow to return box as geojson', function () {
-      const boxId = Object.keys(testBoxes)[0];
-
-      return Box.findBoxById(boxId, { format: 'geojson' }).then(function (
-        geojsonBox
-      ) {
-        expect(geojsonBox).an('object');
-        expect(geojsonBox.type).equal('Feature');
-        expect(geojsonBox.geometry).an('object');
-
-        expect(geojsonBox.geometry.coordinates).an('array');
-        expect(geojsonBox.geometry.coordinates).lengthOf.within(2, 3);
-        for (const coord of geojsonBox.geometry.coordinates) {
-          expect(coord).a('number');
-        }
-        expect(Math.abs(geojsonBox.geometry.coordinates[0])).most(180);
-        expect(Math.abs(geojsonBox.geometry.coordinates[1])).most(90);
-      });
-    });
-
     it('should allow to disable population and specify own projection', function () {
       const boxId = Object.keys(testBoxes)[0];
 

tests/tests/005-create-boxes-test.js

@@ -181,6 +181,26 @@ describe('openSenseMap API Routes: /boxes', function () {
       });
   });
 
+  it('should return a box as geojson', function () {
+    return chakram.get(`${BASE_URL}/boxes/${boxId}?format=geojson`)
+      .then(function (response) {
+        expect(response).to.have.status(200);
+        const geojsonBox = response.body;
+        expect(geojsonBox).an('object');
+        expect(geojsonBox.type).equal('Feature');
+        expect(geojsonBox.geometry).an('object');
+
+        expect(geojsonBox.geometry.coordinates).an('array');
+        for (const coord of geojsonBox.geometry.coordinates) {
+          expect(coord).a('number');
+        }
+        expect(Math.abs(geojsonBox.geometry.coordinates[0])).most(180);
+        expect(Math.abs(geojsonBox.geometry.coordinates[1])).most(90);
+
+        return chakram.wait();
+      });
+  });
+
   it('should let users retrieve their arduino sketch', function () {
     return chakram.get(`${BASE_URL}/boxes/${boxId}/script`, { headers: { 'Authorization': `Bearer ${jwt}` } })
       .then(function (response) {
@@ -423,7 +443,8 @@ describe('openSenseMap API Routes: /boxes', function () {
         expect(response).to.comprise.of.json('data.exposure', update_payload.exposure);
         expect(response).to.comprise.of.json('data.grouptag', update_payload.grouptag);
         expect(response).to.comprise.of.json('data.description', update_payload.description);
-        expect(response).to.comprise.of.json('data.currentLocation', { type: 'Point',
+        expect(response).to.comprise.of.json('data.currentLocation', {
+          type: 'Point',
           coordinates: [update_payload.location.lng, update_payload.location.lat]
         });