Vote for ideas (#51)

* vote for ideas: POST /ideas/:id/votes

* Remove vote from idea DELETE /ideas/:id/votes/vote

* show amount of up and down votes and my vote when GET /ideas/:id

* generalize votes for other objects

use it to vote for comments

* add error messages, remove TODO comment

apidoc.raml

@@ -421,6 +421,14 @@ types:
           403:
           404:
       get:
+    /votes:
+      post:
+        description: Vote for an idea.
+        responses:
+          201:
+          400:
+          403:
+          404:
 /comments:
   /{id}:
     patch:

app.js

@@ -71,6 +71,9 @@ app.use('/messages', require('./routes/messages'));
 app.use('/account', require('./routes/account'));
 app.use('/contacts', require('./routes/contacts'));
 app.use('/ideas', require('./routes/ideas'));
+// vote for ideas, ...
+app.use('/ideas', require('./routes/votes'));
+app.use('/comments', require('./routes/votes'));
 
 // following are route factories
 // they need to know what is the primary object (i.e. idea, comment, etc.)

collections.js

@@ -117,6 +117,19 @@ module.exports = {
         fields: ['creator']
       }
     ]
+  },
+
+  votes: {
+    type: 'edge',
+    from: ['users'],
+    to: ['ideas', 'comments'],
+    indexes: [
+      {
+        type: 'hash',
+        fields: ['_from', '_to'],
+        unique: true
+      }
+    ]
   }
 
 };

controllers/comments.js

@@ -57,6 +57,9 @@ module.exports = function controllersFactory(primary) {
    * Middleware to read comments of a primary object (i.e. idea)
    */
   async function get(req, res, next) {
+
+    const { username } = req.auth;
+
     try {
       // gather data
       const { id } = req.params;
@@ -67,6 +70,20 @@ module.exports = function controllersFactory(primary) {
       // read the comments from database
       const comments = await models.comment.readCommentsOf(primary, { offset, limit, sort });
 
+      // read votes of comments
+      if (comment === 'comment') {
+        const ids = comments.map(comment => comment.id);
+        // read votes of the comments from database
+        const votes = await models.vote.readVotesToMany({ type: 'comments', ids });
+        const myVotes = await models.vote.readMany({ from: username, to: { type: 'comments', ids } });
+
+        // add the votes to their comments
+        comments.forEach((comment, i) => {
+          comment.votes = votes[i];
+          comment.myVote = myVotes[i];
+        });
+      }
+
       // serialize the comments
       const serializedComments = serialize.comment(comments);
 

controllers/ideas.js

@@ -35,12 +35,17 @@ async function get(req, res, next) {
   try {
     // gather data
     const { id } = req.params;
+    const { username } = req.auth;
 
     // read the idea from database
     const idea = await models.idea.read(id);
 
     if (!idea) return res.status(404).json({ });
 
+    // see how many votes were given to idea and if/how logged user voted (0, -1, 1)
+    idea.votes = await models.vote.readVotesTo({ type: 'ideas', id });
+    idea.myVote = await models.vote.read({ from: username, to: { type: 'ideas', id } });
+
     // serialize the idea (JSON API)
     const serializedIdea = serialize.idea(idea);
 

controllers/validators/index.js

@@ -9,4 +9,5 @@ exports.account = require('./account');
 exports.users = require('./users');
 exports.tags = require('./tags');
 exports.userTags = require('./user-tags');
+exports.votes = require('./votes');
 exports.params = require('./params');

controllers/validators/schema/definitions.js

@@ -126,6 +126,11 @@ module.exports = {
       pattern: '\\S' // at least one non-space character
     }
   },
+  vote: {
+    value: {
+      enum: [-1, 1]
+    }
+  },
   query: {
     page: {
       properties: {

controllers/validators/schema/index.js

@@ -12,8 +12,9 @@ const account = require('./account'),
       params = require('./params'),
       tags = require('./tags'),
       userTags = require('./user-tags'),
-      users = require('./users');
+      users = require('./users'),
+      votes = require('./votes');
 
 
 module.exports = Object.assign({ definitions }, account, authenticate, avatar,
-  comments, contacts, ideas, ideaTags, messages, params, tags, users, userTags);
+  comments, contacts, ideas, ideaTags, messages, params, tags, users, userTags, votes);

controllers/validators/schema/paths.js

@@ -23,5 +23,6 @@ module.exports = {
   title: { $ref: 'sch#/definitions/idea/titl' },
   detail: { $ref: 'sch#/definitions/idea/detail' },
   content: { $ref: 'sch#/definitions/comment/content' },
-  id: { $ref: 'sch#/definitions/shared/objectId' }
+  id: { $ref: 'sch#/definitions/shared/objectId' },
+  voteValue: { $ref: 'sch#/definitions/vote/value' },
 };

controllers/validators/schema/votes.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const { id, voteValue: value } = require('./paths');
+
+const postVotes = {
+  properties: {
+    params: {
+      properties: { id },
+      required: ['id'],
+      additionalProperties: false
+    },
+    body: {
+      properties: { value },
+      required: ['value'],
+      additionalProperties: false
+    },
+    required: ['body', 'params']
+  }
+};
+
+const deleteVote = {
+  properties: {
+    params: {
+      properties: { id },
+      required: ['id'],
+      additionalProperties: false
+    },
+    required: ['params']
+  }
+};
+
+module.exports = { deleteVote, postVotes };

controllers/validators/votes.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const validate = require('./validate-by-schema');
+
+const del = validate('deleteVote');
+const post = validate('postVotes');
+
+module.exports = { del, post };

controllers/votes.js

@@ -0,0 +1,91 @@
+const path = require('path'),
+      models = require(path.resolve('./models')),
+      serializers = require(path.resolve('./serializers'));
+
+/**
+ * Middleware to POST a vote to idea (and other objects in the future)
+ */
+async function post(req, res, next) {
+
+  // read data from request
+  const { id } = req.params;
+  const { value } = req.body;
+  const { username } = req.auth;
+
+  // what is the type of the object we vote for (i.e. ideas, comments, ...)
+  const primarys = req.baseUrl.substring(1);
+  const primary = primarys.slice(0, -1);
+
+  try {
+    // save the vote to database
+    const vote = await models.vote.create({ from: username, to: { type: primarys, id }, value });
+    // respond
+    const serializedVote = serializers.serialize.vote(vote);
+    return res.status(201).json(serializedVote);
+  } catch (e) {
+    // handle errors
+    switch (e.code) {
+      // duplicate vote
+      case 409: {
+        return res.status(409).json({
+          errors: [{
+            status: 409,
+            detail: 'duplicate vote'
+          }]
+        });
+      }
+      // missing idea
+      case 404: {
+        return res.status(404).json({
+          errors: [{
+            status: 404,
+            detail: `${primary} doesn't exist`
+          }]
+        });
+
+      }
+      default: {
+        return next(e);
+      }
+    }
+  }
+}
+
+/**
+ * Middleware to DELETE a vote from an idea (and other objects in the future).
+ */
+async function del(req, res, next) {
+
+  // read data from request
+  const { id } = req.params;
+  const { username } = req.auth;
+
+  // what is the type of the object we vote for (i.e. ideas, comments, ...)
+  const primarys = req.baseUrl.substring(1);
+  const primary = primarys.slice(0, -1);
+
+  try {
+    // remove the vote from database
+    await models.vote.remove({ from: username, to: { type: primarys, id } });
+    // respond
+    return res.status(204).end();
+  } catch (e) {
+    // handle errors
+    switch (e.code) {
+      // primary object or vote doesn't exist
+      case 404: {
+        return res.status(404).json({
+          errors: [{
+            status: 404,
+            detail: `vote or ${primary} doesn't exist`
+          }]
+        });
+      }
+      default: {
+        return next(e);
+      }
+    }
+  }
+}
+
+module.exports = { del, post };

models/index.js

@@ -8,7 +8,8 @@ const comment = require('./comment'),
       model = require('./model'),
       tag = require('./tag'),
       user = require('./user'),
-      userTag = require('./user-tag');
+      userTag = require('./user-tag'),
+      vote = require('./vote');
 
 
 const models = {
@@ -21,4 +22,4 @@ const models = {
   }
 };
 
-module.exports = Object.assign(models, { comment, contact, idea, ideaTag, message, model, tag, user, userTag });
+module.exports = Object.assign(models, { comment, contact, idea, ideaTag, message, model, tag, user, userTag, vote });