Shared boxes for users (#605)

* shared boxes for users, TODO: function to share box with others

* use third test box for grouptag tests

Co-authored-by: Umut Tas <[email protected]>

Author: mpfeil

packages/api/lib/controllers/boxesController.js

@@ -397,6 +397,7 @@ const getBox = async function getBox (req, res, next) {
  * @apiParam (RequestBody) {Object} [mqtt] specify parameters of the MQTT integration for external measurement upload. Please see below for the accepted parameters
  * @apiParam (RequestBody) {Object} [ttn] specify parameters for the TTN integration for measurement from TheThingsNetwork.org upload. Please see below for the accepted parameters
  * @apiParam (RequestBody) {Boolean="true","false"} [useAuth] whether to use access_token or not for authentication
+ * @apiParam (RequestBody) {Boolean="true","false"} [sharedBox] whether to share this box (allows transfer to another user while still being able to read the secret and commit measurements)
  *
  * @apiUse LocationBody
  * @apiUse SensorBody
@@ -774,6 +775,7 @@ module.exports = {
       { name: 'ttn', dataType: 'object' },
       { name: 'useAuth', allowedValues: ['true', 'false'] },
       { predef: 'location', required: true },
+      { name: 'sharedBox', allowedValues: ['true', 'false'] }
     ]),
     postNewBox,
   ],

packages/api/lib/controllers/usersController.js

@@ -199,17 +199,18 @@ const confirmEmailAddress = async function confirmEmailAddress (req, res, next)
 };
 
 /**
- * @api {post} /users/me/boxes list all boxes of the signed in user
+ * @api {post} /users/me/boxes list all boxes and sharedBoxes of the signed in user
  * @apiName getUserBoxes
- * @apiDescription List all boxes of the signed in user with secret fields
+ * @apiDescription List all boxes and sharedBoxes of the signed in user with secret fields
  * @apiGroup Users
  * @apiSuccess {String} code `Ok`
  * @apiSuccess {String} data A json object with a single `boxes` array field
  */
 const getUserBoxes = async function getUserBoxes (req, res, next) {
   try {
     const boxes = await req.user.getBoxes();
-    res.send(200, { code: 'Ok', data: { boxes } });
+    const sharedBoxes = await req.user.getSharedBoxes();
+    res.send(200, { code: 'Ok', data: { boxes: boxes, sharedBoxes: sharedBoxes } });
   } catch (err) {
     handleError(err, next);
   }

packages/models/src/box/box.js

@@ -727,7 +727,7 @@ boxSchema.statics.findMeasurementsOfBoxesStream = function findMeasurementsOfBox
       // store all matching sensors under sensors[sensorId]
       for (let i = 0, len = boxData.length; i < len; i++) {
         for (let j = 0, sensorslen = boxData[i].sensors.length; j < sensorslen; j++) {
-          if (boxData[i].sensors[j][sensorProperty].toString() === phenomenon) {
+          if (boxData[i].sensors[j][sensorProperty] && boxData[i].sensors[j][sensorProperty].toString() === phenomenon) {
             const sensor = boxData[i].sensors[j];
 
             sensor.lat = boxData[i].currentLocation.coordinates[1];

packages/models/src/user/user.js

@@ -61,6 +61,10 @@ const userSchema = new mongoose.Schema({
     type: mongoose.Schema.Types.ObjectId,
     ref: 'Box'
   }],
+  sharedBoxes: [{
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'Box'
+  }],
   language: {
     type: String,
     trim: true,
@@ -286,6 +290,9 @@ userSchema.methods.addBox = function addBox (params) {
       // persist the saved box in the user
       savedBox.serialPort = serialPort;
       user.boxes.addToSet(savedBox._id);
+      if (params.sharedBox) {
+        user.sharedBoxes.addToSet(savedBox._id);
+      }
 
       return user.save()
         .then(function () {
@@ -550,6 +557,14 @@ userSchema.methods.getBoxes = function getBoxes () {
     });
 };
 
+userSchema.methods.getSharedBoxes = function getSharedBoxes () {
+  return Box.find({ _id: { $in: this.sharedBoxes } })
+    .populate(Box.BOX_SUB_PROPS_FOR_POPULATION)
+    .then(function (boxes) {
+      return boxes.map(b => b.toJSON({ includeSecrets: true }));
+    });
+};
+
 userSchema.statics.confirmEmail = function confirmEmail ({ token, email }) {
   return this.findOne({ $and: [{ $or: [{ email: email }, { unconfirmedEmail: email }] }, { emailConfirmationToken: token }] })
     .exec()

tests/data/getUserBoxesSchema.js

@@ -193,10 +193,195 @@ module.exports = {
               'integrations'
             ]
           }
+        },
+        'sharedBoxes': {
+          'type': 'array',
+          'items': {
+            'type': 'object',
+            'properties': {
+              'createdAt': {
+                'type': 'string'
+              },
+              'exposure': {
+                'type': 'string'
+              },
+              'model': {
+                'type': 'string'
+              },
+              'name': {
+                'type': 'string'
+              },
+              'updatedAt': {
+                'type': 'string'
+              },
+              'useAuth': {
+                'type': 'boolean'
+              },
+              'access_token': {
+                'type': 'string'
+              },
+              'currentLocation': {
+                'type': 'object',
+                'properties': {
+                  'coordinates': {
+                    'type': 'array',
+                    'items': { 'type': 'number' }
+                  },
+                  'timestamp': { 'type': 'string' },
+                  'type': { 'type': 'string' }
+                },
+                'required': [
+                  'coordinates',
+                  'timestamp',
+                  'type'
+                ]
+              },
+              'loc': {
+                'type': 'array',
+                'items': {
+                  'type': 'object',
+                  'properties': {
+                    'geometry': {
+                      'type': 'object',
+                      'properties': {
+                        'coordinates': {
+                          'type': 'array',
+                          'items': {
+                            'type': 'number'
+                          }
+                        },
+                        'type': {
+                          'type': 'string'
+                        }
+                      },
+                      'required': [
+                        'coordinates',
+                        'type'
+                      ]
+                    },
+                    'type': {
+                      'type': 'string'
+                    }
+                  },
+                  'required': [
+                    'geometry',
+                    'type'
+                  ]
+                }
+              },
+              'sensors': {
+                'type': 'array',
+                'items': {
+                  'type': 'object',
+                  'properties': {
+                    'title': {
+                      'type': 'string'
+                    },
+                    'unit': {
+                      'type': 'string'
+                    },
+                    'sensorType': {
+                      'type': 'string'
+                    },
+                    'icon': {
+                      'type': 'string'
+                    },
+                    '_id': {
+                      'type': 'string'
+                    },
+                    'lastMeasurement': {
+                      'type': 'object',
+                      'properties': {
+                        'value': {
+                          'type': 'string'
+                        },
+                        'createdAt': {
+                          'type': 'string'
+                        }
+                      },
+                      'required': [
+                        'value',
+                        'createdAt'
+                      ]
+                    }
+                  },
+                  'required': [
+                    'title',
+                    'unit',
+                    'sensorType',
+                    '_id'
+                  ]
+                }
+              },
+              '_id': {
+                'type': 'string'
+              },
+              'integrations': {
+                'type': 'object',
+                'properties': {
+                  'mqtt': {
+                    'type': 'object',
+                    'properties': {
+                      'url': {
+                        'type': 'string'
+                      },
+                      'topic': {
+                        'type': 'string'
+                      },
+                      'decodeOptions': {
+                        'type': 'string'
+                      },
+                      'connectionOptions': {
+                        'type': 'string'
+                      },
+                      'messageFormat': {
+                        'type': 'string'
+                      },
+                      'enabled': {
+                        'type': 'boolean'
+                      }
+                    },
+                    'required': [
+                      'enabled'
+                    ]
+                  },
+                  'ttn': {
+                    'type': 'object',
+                    'properties': {
+                      'dev_id': {
+                        'type': 'string'
+                      },
+                      'app_id': {
+                        'type': 'string'
+                      },
+                      'profile': {
+                        'type': 'string'
+                      }
+                    },
+                  }
+                },
+                'required': [
+                  'mqtt'
+                ]
+              }
+            },
+            'required': [
+              'createdAt',
+              'exposure',
+              'name',
+              'updatedAt',
+              'currentLocation',
+              'loc',
+              'sensors',
+              '_id',
+              'integrations'
+            ]
+          }
         }
       },
       'required': [
-        'boxes'
+        'boxes',
+        'sharedBoxes'
       ]
     }
   },

tests/data/valid_sensebox.js

@@ -26,6 +26,7 @@ module.exports = function ({ bbox, model, sensors, lonlat, name = '', sensorTemp
     'exposure': 'indoor',
     'weblink': 'https://api.opensensemap.org',
     'location': loc,
+    'sharedBox': true,
     'mqtt': {
       'enabled': false,
       'url': '',

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

@@ -156,7 +156,7 @@ describe('openSenseMap API Routes: /boxes', function () {
         expect(response).to.have.header('content-type', 'application/json; charset=utf-8');
 
         boxCount = boxCount + 1;
-        //boxIds.push(response.body.data._id);
+        boxIds.push(response.body.data._id);
 
         return chakram.get(`${BASE_URL}/boxes/${response.body.data._id}`);
       })
@@ -199,12 +199,13 @@ describe('openSenseMap API Routes: /boxes', function () {
       });
   });
 
-  it('should let users retrieve their box with all fields', function () {
+  it('should let users retrieve their boxes and sharedBoxes with all fields', function () {
     return chakram.get(`${BASE_URL}/users/me/boxes`, { headers: { 'Authorization': `Bearer ${jwt}` } })
       .then(function (response) {
         expect(response).to.have.status(200);
         expect(response).to.have.schema(getUserBoxesSchema);
         expect(response).to.comprise.of.json('data.boxes.0.integrations.mqtt', { enabled: false });
+        expect(response).to.comprise.of.json('data.sharedBoxes.0.integrations.mqtt', { enabled: false });
 
         return chakram.wait();
       });
@@ -598,7 +599,7 @@ describe('openSenseMap API Routes: /boxes', function () {
   it('should allow to update the box via PUT with array as grouptags', function () {
     const update_payload = { name: 'neuername', exposure: 'outdoor', grouptag: ['newgroup'], description: 'total neue beschreibung', location: { lat: 54.2, lng: 21.1 }, weblink: 'http://www.google.de', image: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=' };
 
-    return chakram.put(`${BASE_URL}/boxes/${boxIds[2]}`, update_payload, { headers: { 'Authorization': `Bearer ${jwt2}` } })
+    return chakram.put(`${BASE_URL}/boxes/${boxIds[3]}`, update_payload, { headers: { 'Authorization': `Bearer ${jwt2}` } })
       .then(function (response) {
         expect(response).to.have.status(200);
         expect(response).to.comprise.of.json('data.name', update_payload.name);