Feature/api rating bookmark data model

apis/collection/backend.js

@@ -1,5 +1,3 @@
-import ss from 'simple-statistics';
-
 ApiBackends = new Mongo.Collection('apiBackends');
 
 // RegEx constants
@@ -653,49 +651,28 @@ Schemas.ApiBackendsSchema = new SimpleSchema({
       type: "hidden",
       label: false
     }
-  }
-});
-
-ApiBackends.attachSchema(Schemas.ApiBackendsSchema);
-
-ApiBackends.allow({
-  insert: function () {
-    return true;
-  },
-  update: function (userId, apiBackendDoc) {
-    // Save ID of API Backend
-    const apiBackendId = apiBackendDoc._id;
-    // Get API backend with ID
-    const apiBackend = ApiBackends.findOne(apiBackendId);
-    // Check if current user can edit API Backend
-    let currentUserCanEdit = apiBackend.currentUserCanEdit();
-
-    if (currentUserCanEdit) {
-      // User is allowed to perform action
-      return true;
-    } else {
-      // User is not allowded to perform action
-      return false;
+  },
+  averageRating: {
+    type: Number,
+    decimal: true,
+    optional: true,
+    autoform: {
+      type: "hidden",
+      label: false
     }
   },
-  remove: function (userId, apiBackendDoc) {
-    // Save ID of API Backend
-    const apiBackendId = apiBackendDoc._id;
-    // Get API backend with ID
-    const apiBackend = ApiBackends.findOne(apiBackendId);
-    // Check if current user can edit API Backend
-    let currentUserCanEdit = apiBackend.currentUserCanEdit();
-
-    if (currentUserCanEdit) {
-      // User is allowed to perform action
-      return true;
-    } else {
-      // User is not allowded to perform action
-      return false;
+  bookmarkCount: {
+    type: Number,
+    optional: true,
+    autoform: {
+      type: "hidden",
+      label: false
     }
   }
 });
 
+ApiBackends.attachSchema(Schemas.ApiBackendsSchema);
+
 SimpleSchema.messages({
   // RegEx messages
   regEx: [
@@ -705,80 +682,3 @@ SimpleSchema.messages({
   // update password form
   "updatePassword_passwordsMismatch": "Passwords do not match"
 });
-
-ApiBackends.helpers({
-  'getRating': function () {
-    // Get API Backend ID
-    apiBackendId = this._id;
-
-    // Check if user is logged in
-    if (Meteor.userId()) {
-      // Check if user has rated API Backend
-      var userRating = ApiBackendRatings.findOne({
-        userId: Meteor.userId(),
-        apiBackendId: apiBackendId
-      });
-
-      if (userRating) {
-        return userRating.rating;
-      }
-    }
-
-    // Otherwise, get average rating
-
-    // Fetch all ratings
-    var apiBackendRatings = ApiBackendRatings.find({
-      apiBackendId: apiBackendId
-    }).fetch();
-
-    // If ratings exist
-    if (apiBackendRatings) {
-      // Create array containing only rating values
-      var apiBackendRatingsArray = _.map(apiBackendRatings, function (rating) {
-        // get only the rating value; omit User ID and API Backend ID fields
-        return rating.rating;
-      });
-
-      // Get the average (mean) value for API Backend ratings
-      var apiBackendRatingsAverage = ss.mean(apiBackendRatingsArray);
-
-      return apiBackendRatingsAverage;
-    }
-  },
-  currentUserCanEdit: function() {
-    // Get current userId
-    var userId = Meteor.userId();
-
-    // Check that user is logged in
-    if( userId ) {
-      // Check if user is API manager
-      var isManager = _.contains(this.managerIds, userId);
-
-      if (isManager) {
-        return true;
-      }
-
-      // Check if user is administrator
-      var isAdmin = Roles.userIsInRole(userId, ['admin']);
-
-      if (isAdmin) {
-        return true;
-      }
-    } else {
-      // User is not logged in
-      return false;
-    }
-  },
-  currentUserIsManager: function () {
-    // Get current User ID
-    var userId = Meteor.userId();
-
-    // Get Manager IDs array from API Backend document
-    var managerIds = this.managerIds;
-
-    // Check if User ID is in Manager IDs array
-    var isManager = _.contains(managerIds, userId);
-
-    return isManager;
-  }
-});

apis/collection/helpers.js

@@ -0,0 +1,115 @@
+import ss from 'simple-statistics';
+
+ApiBackends.helpers({
+  getAverageRating () {
+    console.log("getting average rating");
+    // Fetch all ratings
+    var apiBackendRatings = ApiBackendRatings.find({
+      apiBackendId: this._id
+    }).fetch();
+
+    // If ratings exist
+    if (apiBackendRatings) {
+      // Create array containing only rating values
+      var apiBackendRatingsArray = _.map(apiBackendRatings, function (rating) {
+        // get only the rating value; omit User ID and API Backend ID fields
+        return rating.rating;
+      });
+
+      // Get the average (mean) value for API Backend ratings
+      var apiBackendRatingsAverage = ss.mean(apiBackendRatingsArray);
+
+      return apiBackendRatingsAverage;
+    }
+  },
+  setAverageRating () {
+    // get average rating value
+    const averageRating = this.getAverageRating();
+
+    // Check if average rating calculation succeeds
+    if (averageRating) {
+      // Update the API Backend with average rating value
+      ApiBackends.update(this._id, {$set: {averageRating}});
+    }
+  },
+  getBookmarkCount () {
+    // Get API Backend ID
+    const apiBackendId = this._id;
+
+    // Get count of API Bookmarks where API Backend ID is in API Backend IDs array
+    const apiBookmarkCount = ApiBookmarks.find({apiIds: apiBackendId}).count();
+
+    return apiBookmarkCount;
+  },
+  setBookmarkCount () {
+    // get average rating value
+    const bookmarkCount = this.getBookmarkCount();
+
+    // Check if average rating calculation succeeds
+    if (bookmarkCount) {
+      // Update the API Backend with average rating value
+      ApiBackends.update(this._id, {$set: {bookmarkCount}});
+    } else {
+      ApiBackends.update(this._id, {$unset: {bookmarkCount: ""}})
+    }
+  },
+  getRating () {
+    // Get API Backend ID
+    const apiBackendId = this._id;
+
+    // Get current user ID
+    const userId = Meteor.userId();
+
+    // Check if user is logged in
+    if (Meteor.userId()) {
+      // Check if user has rated API Backend
+      var userRating = ApiBackendRatings.findOne({
+        apiBackendId,
+        userId
+      });
+
+      if (userRating) {
+        return userRating.rating;
+      }
+    }
+
+    // Otherwise, get average rating
+    return this.averageRating;
+  },
+  currentUserCanEdit () {
+    // Get current userId
+    var userId = Meteor.userId();
+
+    // Check that user is logged in
+    if( userId ) {
+      // Check if user is API manager
+      var isManager = _.contains(this.managerIds, userId);
+
+      if (isManager) {
+        return true;
+      }
+
+      // Check if user is administrator
+      var isAdmin = Roles.userIsInRole(userId, ['admin']);
+
+      if (isAdmin) {
+        return true;
+      }
+    } else {
+      // User is not logged in
+      return false;
+    }
+  },
+  currentUserIsManager () {
+    // Get current User ID
+    var userId = Meteor.userId();
+
+    // Get Manager IDs array from API Backend document
+    var managerIds = this.managerIds;
+
+    // Check if User ID is in Manager IDs array
+    var isManager = _.contains(managerIds, userId);
+
+    return isManager;
+  }
+});

apis/collection/permissions.js

@@ -0,0 +1,52 @@
+ApiBackends.allow({
+  insert: function () {
+    return true;
+  },
+  update: function (userId, apiBackendDoc) {
+    // Save ID of API Backend
+    const apiBackendId = apiBackendDoc._id;
+    // Get API backend with ID
+    const apiBackend = ApiBackends.findOne(apiBackendId);
+    // Check if current user can edit API Backend
+    let currentUserCanEdit = apiBackend.currentUserCanEdit();
+
+    if (currentUserCanEdit) {
+      // User is allowed to perform action
+      return true;
+    } else {
+      // User is not allowded to perform action
+      return false;
+    }
+  },
+  remove: function (userId, apiBackendDoc) {
+    // Save ID of API Backend
+    const apiBackendId = apiBackendDoc._id;
+    // Get API backend with ID
+    const apiBackend = ApiBackends.findOne(apiBackendId);
+    // Check if current user can edit API Backend
+    let currentUserCanEdit = apiBackend.currentUserCanEdit();
+
+    if (currentUserCanEdit) {
+      // User is allowed to perform action
+      return true;
+    } else {
+      // User is not allowded to perform action
+      return false;
+    }
+  }
+});
+
+ApiBackends.deny({
+  insert () {
+    // Don't allow user to set average rating or bookmark count fields
+    if (_.contains(fields, "averageRating") || _.contains(fields, "bookmarkCount")) {
+      return true;
+    }
+  },
+  update () {
+    // Don't allow user to set average rating or bookmark count fields
+    if (_.contains(fields, "averageRating") || _.contains(fields, "bookmarkCount")) {
+      return true;
+    }
+  }
+});

apis/server/methods/bookmarks.js

@@ -0,0 +1,20 @@
+Meteor.methods({
+  setAllApiBackendBookmarkCounts () {
+    // Get all API Backends
+    const apiBackends = ApiBackends.find().fetch();
+
+    // Update the average rating value for each API Backend
+    apiBackends.forEach(function (apiBackend) {
+      // Set average rating value for current API Backend
+      apiBackend.setBookmarkCount();
+    });
+  },
+  setApiBackendBookmarkCount (apiBackendId) {
+    console.log("Setting api bookmark count")
+    // Get API Backend
+    const apiBackend = ApiBackends.findOne(apiBackendId);
+
+    // Update the API Backend bookmark count
+    apiBackend.setBookmarkCount();
+  }
+});

apis/server/methods/ratings.js

@@ -0,0 +1,20 @@
+Meteor.methods({
+  setAllApiBackendAverageRatings () {
+    // Get all API Backends
+    const apiBackends = ApiBackends.find().fetch();
+
+    // Update the average rating value for each API Backend
+    apiBackends.forEach(function (apiBackend) {
+      // Set average rating value for current API Backend
+      apiBackend.setAverageRating();
+    });
+  },
+  setApiBackendAverageRating (apiBackendId) {
+    console.log("Setting api bookmark count")
+    // Get API Backend
+    const apiBackend = ApiBackends.findOne(apiBackendId);
+
+    // Update the API Backend bookmark count
+    apiBackend.setAverageRating();
+  }
+});

bookmarks/server/methods.js

@@ -6,10 +6,10 @@ Meteor.methods({
 
     // object to store currentUserId and the Api ID
     var userBookmarks = {userId: currentUserId, apiIds: apiBackendIds};
-    
+
     // If possible, get the bookmarks for current user.
     var existingUserBookmarks = ApiBookmarks.findOne({userId: currentUserId});
-    
+
     // Check if user has existing bookmarks
     if (existingUserBookmarks) {
       // Get an array of bookmark IDs
@@ -31,14 +31,16 @@ Meteor.methods({
       }
 
       // Updating current user apiBookmarks
-      ApiBookmarks.update({userId: currentUserId},{$set: {apiIds: apiIds} });
+      ApiBookmarks.update({userId: currentUserId},{$set: { apiIds } });
 
     } else {
       // Insert bookmark to database
       ApiBookmarks.insert(userBookmarks);
     }
 
+    // Update the API Backend bookmark count
+    Meteor.call("setApiBackendBookmarkCount", backendId);
+
     return apiIds;
   }
 });
-