From a7f75207ea5462c1173aa52c157c14917716c8a7 Mon Sep 17 00:00:00 2001 From: Julio Biason Date: Wed, 16 Apr 2014 10:05:29 -0300 Subject: [PATCH] get voting results --- luncho/blueprints/voting.py | 91 +++++++++++++++++++++++++++++++++++++ tests/vote_tests.py | 45 ++++++++++++++++++ 2 files changed, 136 insertions(+) diff --git a/luncho/blueprints/voting.py b/luncho/blueprints/voting.py index b4456ae..0fc82ac 100644 --- a/luncho/blueprints/voting.py +++ b/luncho/blueprints/voting.py @@ -5,6 +5,7 @@ import datetime import logging +import operator from flask import Blueprint from flask import jsonify @@ -193,6 +194,96 @@ def cast_vote(group_id): return jsonify(status='OK') +@voting.route('/', methods=['GET']) +@auth +def get_vote(group_id): + """*Authenticated request* + + Return the current voting status for the group. + + :header Authorization: Access token from '/token/'. + + :status 200: Success + + .. sourcecode:: http + + HTTP/1.1 200 OK + Content-type: text/json + + { "status": "OK", + "closed": , + "results": [ {"id": , + "name": "", + "points": }, + {"id": , + "name": "", + "points": }, + ... ] } + :status 403: User is not member of this group + (:py:class:`UserIsNotMemberException`) + :status 404: User not found (via token) + (:py:class:`UserNotFoundException`) + :status 404: Group not found + (:py:class:`ElementNotFoundException`) + :status 412: Authorization required + (:py:class:`AuthorizationRequiredException`) + """ + # check if the group exists + group = Group.query.get(group_id) + if not group: + raise ElementNotFoundException('Group') + + # check if the user belongs to the group + if request.user not in group.users: + LOG.debug('User is not member') + raise UserIsNotMemberException() + + # calculate the decrementating value, based on the number of places + max_places = min(current_app.config['PLACES_IN_VOTE'], + len(group.places)) + decrement = round(1.0 / float(max_places), 1) + LOG.debug('For {places}, the decrement factor is {decrement}'.format( + places=max_places, decrement=decrement)) + + # get the votes for today + today = datetime.date.today() + group_votes = Vote.query.filter_by(group=group.id, + created_at=today) + points = {} + votes = 0 + for vote in group_votes: + votes += 1 + # get the casted votes + vote_value = 1.0 + for cast in CastedVote.query.filter_by(vote=vote.cast): + if not cast.place in points: + points[cast.place] = 0.0; + points[cast.place] += vote_value + vote_value -= decrement + + LOG.debug('Unsorted results: {results}'.format(results=points)) + + # check if the voting is closed. for that, the number of votes must be + # equal to the number of users in the group + closed = False + if votes == len(group.users): + closed = True + + # sort the results from most voted to least voted + # (turn the dictionary into a list with place,points values, then sort + # them by points) + result = [] + for (place_id, points) in sorted(points.items(), + key=operator.itemgetter(1)): + place = Place.query.get(place_id) + result.append({'id': place.id, + 'name': place.name, + 'points': points}) + + return jsonify(status='OK', + closed=closed, + results=result) + # ---------------------------------------------------------------------- # Helpers # ---------------------------------------------------------------------- diff --git a/tests/vote_tests.py b/tests/vote_tests.py index f24b8ba..451e525 100644 --- a/tests/vote_tests.py +++ b/tests/vote_tests.py @@ -2,6 +2,7 @@ # -*- encoding: utf-8 -*- import unittest +import json from luncho import server @@ -198,5 +199,49 @@ class TestVote(LunchoTests): self.assertJsonError(rv, 404, 'Place not found') return + def test_no_results(self): + """Get the results when no votes were cast.""" + group = self._group() + place = self._place() + group.places.append(place) + server.db.session.commit() + + rv = self.get('/vote/{group_id}/'.format(group_id=group.id), + token=self.user.token) + self.assertJsonOk(rv) + data = json.loads(rv.data) + self.assertTrue('results' in data) + self.assertFalse(data['results']) # the list is empty + self.assertTrue('closed' in data) + self.assertFalse(data['closed']) # now it is a boolean + return + + def test_single_vote(self): + """Test voting in a group with a single user.""" + group = self._group() + place = self._place() + group.places.append(place) + self.user.groups.append(group) + server.db.session.commit() + + group_id = group.id + token = self.user.token + + request = {'choices': [place.id]} + self.post('/vote/{group_id}/'.format(group_id=group_id), + request, + token=token) # we expect everything will go fine + + rv = self.get('/vote/{group_id}/'.format(group_id=group_id), + token=token) + self.assertJsonOk(rv) + + data = json.loads(rv.data) + self.assertTrue('results' in data) + self.assertTrue('closed' in data) + self.assertEqual(len(data['results']), 1) + self.assertTrue(data['closed']) + return + if __name__ == '__main__': unittest.main()