Merge pull request #572 from apinf/feature/api-backend-ratings

frenchbread · frenchbread · commit 0d88a73ea741 · 2015-11-09T18:49:11.000-08:00
Feature/api backend ratings. Closes #519
diff --git a/.jshintrc b/.jshintrc
@@ -139,6 +139,7 @@
       // Apinf collections
       "ApiBackends": false,
       "ApiBackendConfigurations": false,
+      "ApiBackendRatings": false,
       "ApiBookmarks": false,
       "ApiDocumentation": false,
       "ApiUmbrellaAdmins": false,
diff --git a/.meteor/packages b/.meteor/packages
@@ -66,8 +66,6 @@ mizzao:sharejs-ace
 raix:ui-dropped-event
 brylie:accounts-admin-ui
 brylie:first-user-admin
-
-
 npm-container
 standard-minifiers
 meteor-base
@@ -85,5 +83,6 @@ spacebars
 check
 useraccounts:iron-routing
 pahans:inline-help
+dandv:jquery-rateit
 zenorocha:clipboard
 harrison:papa-parse
diff --git a/.meteor/versions b/.meteor/versions
@@ -52,6 +52,7 @@ chart:chart@1.0.1-beta.4
 check@1.0.6
 cmather:handlebars-server@2.0.0
 coffeescript@1.0.10
+dandv:jquery-rateit@1.0.22_2
 dapearce:material-icons@0.1.3
 dburles:collection-helpers@1.0.3
 dburles:google-maps@1.1.4
diff --git a/both/catalogue.js b/both/catalogue.js
@@ -12,10 +12,15 @@ TabularTables.ApiTable = new Tabular.Table({
     {data: "name", title: "Name"},
     {data: "backend_host", title: "Backend host"},
     {
-      data: "_id",
       title: "View Details",
       tmpl: Meteor.isClient && Template.viewApiBackendButton
     },
-    {tmpl: Meteor.isClient && Template.favourite, title: "Bookmark"}
-  ]
+    {tmpl: Meteor.isClient && Template.favourite, title: "Bookmark"},
+    {
+     tmpl: Meteor.isClient && Template.apiBackendRating,
+     title: "Rating"
+    }
+  ],
+  responsive: true,
+  autoWidth: false
 });
diff --git a/both/collections/apiBackendRatings.js b/both/collections/apiBackendRatings.js
@@ -0,0 +1,26 @@
+ApiBackendRatings = new Mongo.Collection('apiBackendRatings');
+
+Schemas.ApiBackendRating = new SimpleSchema({
+  'apiBackendId': {
+    type: String,
+    regEx: SimpleSchema.RegEx.Id
+  },
+  'userId': {
+    type: String,
+    regEx: SimpleSchema.RegEx.Id
+  },
+  'rating': {
+    type: Number,
+    min: 0,
+    max: 4
+  }
+});
+
+ApiBackendRatings.allow({
+  insert: function () {
+    return true;
+  },
+  update: function () {
+    return true;
+  }
+});
diff --git a/both/collections/backend.js b/both/collections/backend.js
@@ -694,3 +694,44 @@ 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;
+    }
+  }
+});
diff --git a/client/lib/simple-statistics/simple_statistics.min.js b/client/lib/simple-statistics/simple_statistics.min.js
diff --git a/client/lib/simple-statistics/simple_statistics.min.js.map b/client/lib/simple-statistics/simple_statistics.min.js.map
diff --git a/client/views/catalogue/rating/rating.css b/client/views/catalogue/rating/rating.css
@@ -0,0 +1,3 @@
+.user-own-rating .rateit-selected {
+    background: transparent url("packages/dandv_jquery-rateit/rateit/src/star.gif") repeat scroll left -32px;
+}
diff --git a/client/views/catalogue/rating/rating.html b/client/views/catalogue/rating/rating.html
@@ -0,0 +1,9 @@
+<template name="apiBackendRating">
+  <span id="rating-{{ _id }}" class="rateit {{ userRatingClass }}"></span>
+  {{# unless userHasRating}}
+    <span class="rating-count badge">
+      {{ ratingCount }}&nbsp;
+      <i class="fa fa-user"></i>
+    </span>
+  {{/ unless }}
+</template>
diff --git a/client/views/catalogue/rating/rating.js b/client/views/catalogue/rating/rating.js
@@ -0,0 +1,154 @@
+Template.apiBackendRating.created = function () {
+  // Get reference to template instance
+  var instance = this;
+
+  // Get API Backend ID from template instance
+  var apiBackendId = instance.data._id;
+
+  // Subscribe to rating for current API Backend
+  instance.apiRatingSubscription = instance.subscribe(
+    'myApiBackendRating',
+    apiBackendId
+  );
+
+  // Subscribe to ratings for current API Backend
+  instance.apiBackendRatings = instance.subscribe(
+    'apiBackendRatings',
+    apiBackendId
+  );
+};
+
+Template.apiBackendRating.rendered = function () {
+  // Get reference to template instance
+  var instance = this;
+
+  // Get API Backend ID from template instance
+  var apiBackend = instance.data;
+
+  instance.autorun(function () {
+    // Make sure API Backend Rating subscription is ready
+    if (instance.apiRatingSubscription.ready()) {
+      // Check if user has previously rated API Backend
+      var userRating = ApiBackendRatings.findOne({
+        apiBackendId: apiBackend._id,
+        userId: Meteor.userId()
+      });
+
+      // Add the jQuery RateIt widget
+      $("#rating-" + apiBackend._id).rateit({
+        max: 4,
+        step: 1,
+        resetable: false,
+        value: userRating ? userRating.rating : apiBackend.getRating() // use previous rating, if exists
+      });
+    }
+  });
+};
+
+Template.apiBackendRating.events({
+  "click .rateit": function (event, instance) {
+    // Get API Backend ID from template data context
+    var apiBackendId = instance.data._id;
+
+    // Get rating from template based on API Backend ID
+    var rating = $("#rating-" + apiBackendId).rateit('value');
+
+    // Get current user ID
+    var userId = Meteor.userId();
+
+    // Create an rating object with user ID, API Backend ID, and rating
+    var apiBackendRating = {
+      apiBackendId: apiBackendId,
+      userId: userId,
+      rating: rating
+    };
+
+    // Check if user has previously rated API Backend
+    var previousRating = ApiBackendRatings.findOne({
+      apiBackendId: apiBackendId,
+      userId: userId
+    });
+
+    // If previous rating exists
+    if (previousRating) {
+      // Update the existing rating
+      ApiBackendRatings.update(previousRating._id, {$set: apiBackendRating });
+    } else {
+      // Otherwise, create a new rating
+      ApiBackendRatings.insert(apiBackendRating);
+    }
+  }
+});
+
+Template.apiBackendRating.helpers({
+  'userRatingClass': function () {
+    // Get reference to template instance
+    var instance = Template.instance();
+
+    if (instance.apiRatingSubscription.ready()) {
+      // Determine if user has rated API Backend
+      // Get API Backend ID from template data context
+      var apiBackendId = instance.data._id;
+
+      // Get current user ID
+      var userId = Meteor.userId();
+
+      // Check if user has previously rated API Backend
+      var previousRating = ApiBackendRatings.findOne({
+        apiBackendId: apiBackendId,
+        userId: userId
+      });
+
+      // If previous rating exists
+      if (previousRating) {
+        // Return user rating class
+        return "user-own-rating";
+      }
+    }
+  },
+  'ratingCount': function () {
+    // Get reference to template instance
+    var instance = Template.instance();
+
+    // Make sure API Ratings subscription is ready
+    if (instance.apiRatingSubscription.ready()) {
+      // Get API Backend ID
+      var apiBackendId = instance.data._id;
+
+      // Get all ratings for current API Backend
+      var apiBackendRatings = ApiBackendRatings.find({apiBackendId: apiBackendId});
+
+      // Get the count of API Backend ratings
+      var apiBackendRatingsCount = apiBackendRatings.count();
+
+      return apiBackendRatingsCount;
+    }
+  },
+  'userHasRating': function () {
+    // Get reference to template instance
+    var instance = Template.instance();
+
+    if (instance.apiRatingSubscription.ready()) {
+      // Determine if user has rated API Backend
+      // Get API Backend ID from template data context
+      var apiBackendId = instance.data._id;
+
+      // Get current user ID
+      var userId = Meteor.userId();
+
+      // Check if user has previously rated API Backend
+      var previousRating = ApiBackendRatings.findOne({
+        apiBackendId: apiBackendId,
+        userId: userId
+      });
+
+      // If previous rating exists
+      if (previousRating) {
+        // Return user rating class
+        return true;
+      } else {
+        return false;
+      }
+    }
+  }
+});
diff --git a/server/publish/apiBackendRatings.js b/server/publish/apiBackendRatings.js
@@ -0,0 +1,34 @@
+// User rating for a single API Backend
+Meteor.publish('myApiBackendRating', function (apiBackendId) {
+  // get current user ID
+  var userId = this.userId;
+
+  // get user API Backend rating
+  var userApiBackendRatings = ApiBackendRatings.find({
+    userId: userId,
+    apiBackendId: apiBackendId
+  });
+
+  return userApiBackendRatings;
+});
+
+// User ratings for all API Backends
+Meteor.publish('myApiBackendRatings', function () {
+  // get current user ID
+  var userId = this.userId;
+
+  // get user API Backend ratings
+  var userApiBackendRatings = ApiBackendRatings.find({userId: userId});
+
+  return userApiBackendRatings;
+});
+
+// All ratings for a given API Backend, anonymized
+Meteor.publish('apiBackendRatings', function (apiBackendId) {
+  // get API Backend Ratings, excluding the User ID field
+  var apiBackendRatings = ApiBackendRatings.find(
+    {apiBackendId: apiBackendId}
+  );
+
+  return apiBackendRatings;
+});

-Original file line number
+Diff line change
 [email protected]
 cmather:[email protected]
 [email protected]
 +dandv:[email protected]_2
 dapearce:[email protected]
 dburles:[email protected]
 dburles:[email protected]
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+.user-own-rating .rateit-selected {`
	`2`	`+ background: transparent url("packages/dandv_jquery-rateit/rateit/src/star.gif") repeat scroll left -32px;`
	`3`	`+}`