Merge pull request #56 from ditup/ideas-highly

create GET /ideas?filter[highlyRated]=bottomRateLimit

Author: agatatalita

apidoc.raml

@@ -373,6 +373,7 @@ types:
       - new ideas: `?sort=-created`
       - ideas with provided creators: `?filter[creators]=username0,username1,username2`
       - ideas commented by provided users: `?filter[commentedBy]=username0,username1,username2`
+      - highly voted ideas with minimum amount of votes parameter: `?filter[highlyVoted]=bottomValueLimit`
   /{id}:
     get:
       description: Read an idea by id.

controllers/goto/ideas.js

@@ -9,6 +9,7 @@ module.exports = {
     new: route(['query.sort'], 'newQuery'),
     random: route(['query.filter.random']),
     withCreators: route(['query.filter.creators']),
-    commentedBy: route(['query.filter.commentedBy'])
+    commentedBy: route(['query.filter.commentedBy']),
+    highlyVoted: route(['query.filter.highlyVoted'])
   },
 };

controllers/ideas.js

@@ -231,5 +231,28 @@ async function getIdeasCommentedBy(req, res, next) {
   }
 }
 
+/**
+ * Get highly voted ideas with an optional parameter of minimum votes
+ */
+async function getIdeasHighlyVoted(req, res, next) {
+  try {
+    // gather data
+    const { page: { offset = 0, limit = 5 } = { } } = req.query;
+    const { highlyVoted } = req.query.filter;
+
+    // read ideas from database
+    const foundIdeas = await models.idea.findHighlyVoted(highlyVoted, { offset, limit });
+
+    // serialize
+    const serializedIdeas = serialize.idea(foundIdeas);
+
+    // respond
+    return res.status(200).json(serializedIdeas);
+
+  } catch (e) {
+    return next(e);
+  }
+}
+
 
-module.exports = { get, getIdeasCommentedBy, getIdeasWithCreators, getIdeasWithMyTags, getIdeasWithTags, getNewIdeas, getRandomIdeas, patch, post };
+module.exports = { get, getIdeasCommentedBy, getIdeasHighlyVoted, getIdeasWithCreators, getIdeasWithMyTags, getIdeasWithTags, getNewIdeas, getRandomIdeas, patch, post };

controllers/validators/ideas.js

@@ -5,6 +5,7 @@ const validate = require('./validate-by-schema');
 module.exports = {
   get: validate('getIdea'),
   getIdeasCommentedBy: validate('getIdeasCommentedBy'),
+  getIdeasHighlyVoted: validate('getIdeasHighlyVoted'),
   getIdeasWithCreators: validate('getIdeasWithCreators'),
   getIdeasWithMyTags: validate('getIdeasWithMyTags'),
   getIdeasWithTags: validate('getIdeasWithTags'),

controllers/validators/parser.js

@@ -27,7 +27,8 @@ const parametersDictionary = {
     relatedToTags: 'array',
     size: 'int',
     creators: 'array',
-    commentedBy: 'array'
+    commentedBy: 'array',
+    highlyVoted: 'int'
   },
 };
 

controllers/validators/schema/ideas.js

@@ -173,4 +173,26 @@ const getIdeasCommentedBy = {
   required: ['query']
 };
 
-module.exports = { getIdea, getIdeasCommentedBy, getIdeasWithCreators, getIdeasWithMyTags, getIdeasWithTags, getNewIdeas, getRandomIdeas, patchIdea, postIdeas };
+const getIdeasHighlyVoted = {
+  properties: {
+    query: {
+      properties: {
+        filter: {
+          properties: {
+            highlyVoted: {
+              type: 'number'
+            }
+          },
+          required: ['highlyVoted'],
+          additionalProperties: false
+        },
+        page
+      },
+      required: ['filter'],
+      additionalProperties: false
+    },
+  },
+  required: ['query']
+};
+
+module.exports = { getIdea, getIdeasCommentedBy, getIdeasHighlyVoted, getIdeasWithCreators, getIdeasWithMyTags, getIdeasWithTags, getNewIdeas, getRandomIdeas, patchIdea, postIdeas };

models/idea/index.js

@@ -274,6 +274,37 @@ class Idea extends Model {
     const cursor = await this.db.query(query, params);
     return await cursor.all();
   }
+
+
+  /**
+   * Read ideas commented by specified users
+   * @param {string[]} voteSumBottomLimit - minimal query voteSum
+   * @param {integer} offset - pagination offset
+   * @param {integer} limit - pagination limit
+   * @returns {Promise<Idea[]>} - list of found ideas
+   */
+  static async findHighlyVoted(voteSumBottomLimit, { offset, limit }) {
+    const query = `
+      FOR idea IN ideas
+        LET ideaVotes = (FOR vote IN votes FILTER idea._id == vote._to RETURN vote)
+        // get sum of each idea's votes values
+        LET voteSum = SUM(ideaVotes[*].value)
+        // set bottom limit of voteSum
+        FILTER voteSum >= @voteSumBottomLimit
+        // find creator
+        LET c = (DOCUMENT(idea.creator))
+        LET creator = MERGE(KEEP(c, 'username'), c.profile)
+        LET ideaOut = MERGE(KEEP(idea, 'title', 'detail', 'created'), { id: idea._key}, { creator }, { voteSum })
+
+        // sort by amount of votes
+        SORT ideaOut.voteSum DESC,  ideaOut.created DESC
+        LIMIT @offset, @limit
+        RETURN ideaOut`;
+
+    const params = { voteSumBottomLimit, offset, limit };
+    const cursor = await this.db.query(query, params);
+    return await cursor.all();
+  }
 }
 
 module.exports = Idea;

routes/ideas.js

@@ -40,6 +40,11 @@ router.route('/')
 router.route('/')
   .get(go.get.commentedBy, authorize.onlyLogged, parse, ideaValidators.getIdeasCommentedBy, ideaControllers.getIdeasCommentedBy);
 
+// get ideas commented by specified users
+router.route('/')
+  .get(go.get.highlyVoted, authorize.onlyLogged, parse, ideaValidators.getIdeasHighlyVoted, ideaControllers.getIdeasHighlyVoted);
+
+
 
 router.route('/:id')
   // read idea by id

serializers/ideas.js

@@ -57,9 +57,11 @@ const ideaSerializer = new Serializer('ideas', {
     myVote(record, current) {
       if (!current.hasOwnProperty('myVote')) return;
       return (current.myVote) ? current.myVote.value : 0;
+    },
+    voteSum(record, current) {
+      return current.voteSum;
     }
   }
-
 });
 
 function idea(data) {

test/ideas.list.js

@@ -684,4 +684,150 @@ describe('read lists of ideas', () => {
       });
     });
   });
+
+  describe('GET /ideas?filter[highlyVoted]', () => {
+    let user0;
+    // create and save testing data
+    beforeEach(async () => {
+      const primarys = 'ideas';
+      const data = {
+        users: 6,
+        tags: 6,
+        verifiedUsers: [0, 1, 2, 3, 4],
+        ideas: [[{}, 0], [{}, 0],[{}, 1],[{}, 2],[{}, 2],[{}, 2],[{}, 3]],
+        userTag: [
+          [0,0,'',5],[0,1,'',4],[0,2,'',3],[0,4,'',1],
+          [1,1,'',4],[1,3,'',2],
+          [2,5,'',2]
+        ],
+        ideaTags: [
+          [0,0],[0,1],[0,2],
+          [1,1],[1,2],
+          [2,1],[2,2],[2,4],
+          [4,0],[4,1],[4,2],[4,3],[4,4],
+          [5,2],[5,3],
+          [6,3]
+        ],
+        // odeas with votes: 3:3, 1:3, 5:1, 2:1, 0:0, 6: -1, 4:-2
+        votes: [
+          [0, [primarys, 0], -1],
+          [1, [primarys, 0],  1],
+          [0, [primarys, 1],  1],
+          [1, [primarys, 1],  1],
+          [2, [primarys, 1],  1],
+          [0, [primarys, 2], -1],
+          [1, [primarys, 2],  1],
+          [2, [primarys, 2],  1],
+          [0, [primarys, 3],  1],
+          [1, [primarys, 3],  1],
+          [2, [primarys, 3],  1],
+          [3, [primarys, 3],  1],
+          [4, [primarys, 3], -1],
+          [0, [primarys, 4], -1],
+          [1, [primarys, 4], -1],
+          [3, [primarys, 5],  1],
+          [3, [primarys, 6], -1]
+        ]
+      };
+
+      dbData = await dbHandle.fill(data);
+
+      [user0, , , , , ] = dbData.users;
+    });
+
+    context('logged in', () => {
+
+      beforeEach(() => {
+        agent = agentFactory.logged(user0);
+      });
+
+      context('valid data', () => {
+
+        it('[highly voted ideas] 200 and return array of matched ideas', async () => {
+
+          // request
+          const response = await agent
+            .get('/ideas?filter[highlyVoted]=0')
+            .expect(200);
+
+          // without pagination, limit for ideas 5 we should find 5 ideas...
+          should(response.body).have.property('data').Array().length(5);
+
+          // sorted by creation date desc
+          should(response.body.data.map(idea => idea.attributes.title))
+            .eql([3, 1, 5, 2, 0].map(no => `idea title ${no}`));
+
+        });
+
+        it('[highly voted ideas with at least 2 votes in plus] 200 and return array of matched ideas', async () => {
+
+          // request
+          const response = await agent
+            .get('/ideas?filter[highlyVoted]=2')
+            .expect(200);
+
+          // without pagination, limit for ideas 5 we should find 5 ideas...
+          should(response.body).have.property('data').Array().length(2);
+
+          // sorted by creation date desc
+          should(response.body.data.map(idea => idea.attributes.title))
+            .eql([3, 1].map(no => `idea title ${no}`));
+
+          // shoud value be at least 2
+          should(Math.min(...response.body.data.map(idea => idea.meta.voteSum)))
+            .aboveOrEqual(2);
+        });
+
+
+        it('[pagination] offset and limit the results', async () => {
+          const response = await agent
+            .get('/ideas?filter[highlyVoted]=0&page[offset]=1&page[limit]=3')
+            .expect(200);
+
+          // we should find 3 ideas
+          should(response.body).have.property('data').Array().length(3);
+
+          // sorted by creation date desc
+          should(response.body.data.map(idea => idea.attributes.title))
+            .eql([1, 5, 2].map(no => `idea title ${no}`));
+        });
+
+      });
+
+      context('invalid data', () => {
+
+        it('[invalid query.filter.highlyVoted] 400', async () => {
+          await agent
+            .get('/ideas?filter[highlyVoted]=string')
+            .expect(400);
+        });
+
+        it('[invalid query.filter.highlyVoted] 400', async () => {
+          await agent
+            .get('/ideas?filter[highlyVoted]')
+            .expect(400);
+        });
+
+        it('[invalid pagination] 400', async () => {
+          await agent
+            .get('/ideas?filter[highlyVoted]=0&page[offset]=1&page[limit]=21')
+            .expect(400);
+        });
+
+        it('[unexpected query params] 400', async () => {
+          await agent
+            .get('/ideas?filter[highlyVoted]=0&additional[param]=3&page[offset]=1&page[limit]=3')
+            .expect(400);
+        });
+      });
+    });
+
+    context('not logged in', () => {
+      it('403', async () => {
+        await agent
+          .get('/ideas?filter[highlyVoted]=0')
+          .expect(403);
+      });
+    });
+  });
 });