HAL

service/config.js.example

@@ -1,3 +1,5 @@
+'use strict';
+
 var development = {
     'db': {
         'url': 'http://localhost:9200',

service/package.json

@@ -25,7 +25,8 @@
     "express": "~3.4.6",
     "q": "~0.9.7",
     "lodash": "~2.4.1",
-    "elasticsearch": "~1.0.3"
+    "elasticsearch": "~1.0.3",
+    "express-hal": "0.0.1"
   },
   "devDependencies": {
     "should": "~2.1.1",

service/src/app.js

@@ -1,11 +1,16 @@
+'use strict';
+
 var routes = require('./routes'),
     express = require('express'),
+    hal = require('express-hal'),
     api = express(),
     config = require('../config').Config;
 
 api.use(express.methodOverride());
 api.use(express.json());
 
+api.use(hal.middleware);
+
 routes.setup(api);
 
 api.use(express.logger('dev'));

service/src/lib/paginator.js

@@ -0,0 +1,71 @@
+'use strict';
+
+var getRetroId = function (type, item) {
+    if (type==='ticket') {
+        return item.retroId;
+    } else {
+        return item.id;
+    }
+};
+
+exports.getParameters = function(req) {
+    var start = 0,
+        limit = 10,
+        page = 1;
+
+    if (req.query.page) {
+        page = parseInt(req.query.page, 10);
+    }
+
+    if (req.query.limit) {
+        limit = parseInt(req.query.limit, 10);
+    }
+
+    // page is a human readable iterator
+    // start is for the machines
+    start = (page -1) * limit;
+
+    return {
+        start: start,
+        page: page,
+        limit: limit
+    };
+};
+
+exports.getItemLink = function (type, item) {
+    var link = '/retrospectives',
+        retroId = 0;
+
+    if (!item.id) {
+        return false;
+    }
+
+    retroId = getRetroId(type, item);
+    link += '/' + retroId;
+
+    if (type === 'ticket') {
+        link += '/tickets/' + item.id;
+    }
+    return {
+        link : link
+    };
+};
+
+exports.getBulkLinks = function (baseUrl, parameters, results) {
+    var links = {
+        self: baseUrl + '?page=' + parameters.page + '&limit=' + parameters.limit,
+        find: {
+            href: baseUrl + '{?id}',
+            templated: true
+        }
+    };
+
+    if (parameters.page - 1) {
+        links.previous = baseUrl + '?page=' + (parameters.page - 1) + '&limit=' + parameters.limit;
+    }
+
+    if (results.length > parameters.limit) {
+        links.next = baseUrl + '?page=' + ( parameters.page + 1) + '&limit=' + parameters.limit;
+    }
+    return links;
+};

service/src/models/retrospectives.js

@@ -1,7 +1,8 @@
 'use strict';
 
 var config = require('../../config').Config,
-    db = require('../wrapper');
+    db = require('../wrapper'),
+    paginator = require('../lib/paginator');
 
 exports.getRetrospective = function (req, res) {
     db.query('_id:' + req.params.retroId).of('retrospective').from(config.db.index)
@@ -15,25 +16,48 @@ exports.getRetrospective = function (req, res) {
 };
 
 exports.getRetrospectives = function (req, res) {
-    var start = 0,
-        limit = 10,
-        page = 1;
+    var parameters = paginator.getParameters(req);
 
-    if (req.query.page) {
-        page = req.query.page;
-    }
+    db.getAll('retrospective').sortBy('createdAt:desc').start(parameters.start).size(parameters.limit + 1).from(config.db.index)
+        .then(function (result) {
+            var links = paginator.getBulkLinks('/retrospectives', parameters, result),
+            retrospectives = [];
 
-    if (req.query.limit) {
-        limit = req.query.limit;
-    }
+            if (links.next) {
+                result.pop();
+            }
 
-    // page is a human readable iterator
-    // start is for the machines
-    start = (page - 1) * limit;
+            result.forEach(function(retrospective, index) {
+                var links = {
+                    self: paginator.getItemLink('retrospective', retrospective)
+                };
 
-    db.getAll('retrospective').sortBy('createdAt:desc').start(start).size(limit).from(config.db.index)
-        .then(function (result) {
-            res.json({'results': result, 'total': result.total});
+                if (result[index-1]) {
+                    links.previous = paginator.getItemLink('retrospective', result[index - 1]);
+                }
+
+                if (result[index + 1]) {
+                    links.next = paginator.getItemLink('retrospective', result[index + 1]);
+                }
+
+                retrospectives.push({
+                    data: retrospective,
+                    links: links
+                });
+            });
+
+            res.set('Content-Type', 'application/hal+json');
+            res.hal({
+                data: {
+                    total: result.total,
+                    page: parameters.page,
+                    limit: parameters.limit
+                },
+                links: links,
+                embeds: {
+                    'retrospectives': retrospectives
+                }
+            });
         })
         .fail(function (err) {
             console.log(err);

service/src/models/tickets.js

@@ -3,6 +3,7 @@
 var _ = require('lodash'),
     config = require('../../config').Config,
     db = require('../wrapper'),
+    paginator = require('../lib/paginator'),
 
     explodeMessages = function (results) {
         var words = [];
@@ -25,23 +26,48 @@ exports.getTicketWords = function (req, res) {
 };
 
 exports.getTickets = function (req, res) {
-    var start = 0,
-        limit = 100,
-        page = 1;
+    var parameters = paginator.getParameters(req);
 
-    if (req.query.page) {
-        page = req.query.page;
-    }
+    db.query('retroId:' + req.params.retroId).start(parameters.start).sortBy('createdAt:desc').size(parameters.limit + 1).of('ticket').from(config.db.index)
+        .then(function (result) {
+            var links = paginator.getBulkLinks('/retrospectives' + req.params.retroId + '/tickets', parameters, result),
+            tickets = [];
 
-    if (req.query.limit) {
-        limit = req.query.limit;
-    }
+            if(links.next) {
+                result.pop();
+            }
 
-    start = (page - 1) * limit;
+            result.forEach(function(ticket, index) {
+                var links = {
+                    self: paginator.getItemLink('ticket', ticket)
+                };
 
-    db.query('retroId:' + req.params.retroId).start(start).sortBy('createdAt:desc').size(limit).of('ticket').from(config.db.index)
-        .then(function (result) {
-            res.json({'results': result, 'total': result.total});
+                if (result[index-1]) {
+                    links.previous = paginator.getItemLink('ticket', result[index - 1]);
+                }
+
+                if (result[index+1]) {
+                    links.next = paginator.getItemLink('ticket', result[index + 1]);
+                }
+
+                tickets.push({
+                    data: ticket,
+                    links: links
+                });
+            });
+
+            res.set('Content-Type', 'application/hal+json');
+            res.hal({
+                data: {
+                    total: result.total,
+                    page: parameters.page,
+                    limit: parameters.limit
+                },
+                links: links,
+                embeds: {
+                    'tickets': tickets
+                }
+            });
         })
         .fail(function (err) {
             console.log(err);

static/app/scripts/controllers/board.js

@@ -27,9 +27,9 @@ angular.module('retrospectApp')
 
             $scope.updateTickets = function () {
                 console.log('Updating tickets.');
-                tickets.get({'page': $scope.page, 'limit': $scope.limit, 'retroId': $scope.retroId}, function (tickets) {
+                tickets.get({'page': $scope.page, 'limit': $scope.limit, 'retroId': $scope.retroId}, function (response) {
                     console.log('Got tickets');
-                    $scope.tickets = tickets.results;
+                    $scope.tickets = response._embedded.tickets;
                 });
             };
 

static/app/scripts/controllers/retrospectives.js

@@ -42,7 +42,7 @@ angular.module('retrospectApp').controller('RetroCtrl', [
 
         // this throws an error with cross domain
         retrospectives.get({'limit': $scope.limit, 'page': $scope.page},function (response) {
-            $scope.retrospectives = response.results;
+            $scope.retrospectives = response._embedded.retrospectives;
         });
     }
 ]);