On import fetch tickets page-by-page

Author: gurdiga

index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 module.exports.API_URL     = 'https://api.assembla.com/v1';
+module.exports.TICKET_LIST_PAGE_SIZE = 100;
 
 module.exports.getGoal     = require('./lib/handlers/getGoal');
 module.exports.createGoal  = require('./lib/handlers/createGoal');

lib/makeApiRequest.js

@@ -1,11 +1,12 @@
 'use strict';
 
-var API_URL = require('..').API_URL;
+var async = require('async');
+var connector = require('..');
 var makeRequest = require('./http').makeRequest;
 
 
 module.exports = function(params) {
-  var spaceUrl = API_URL + '/spaces/' + params.urlName;
+  var spaceUrl = connector.API_URL + '/spaces/' + params.urlName;
   var headers = {
     'Content-type': 'application/json',
     'Authorization': 'Bearer ' + params.accessToken
@@ -70,26 +71,69 @@ module.exports = function(params) {
 
 
   module.exports.getTickets = function(callback, results) {
-    var url = spaceUrl + '/tickets';
+    var url = getUrl(results);
+    var pageNumber = 1;
+    var tickets, fetchedTicketCount;
 
-    if (results.currentMilestone) {
-      url += '/milestone/' + results.currentMilestone.id;
+    async.doUntil(fetchAnotherPageOfTickets, isLastPage, function(err) {
+      callback(err, tickets);
+    });
+
+    return;
+
+
+    function getUrl(results) {
+      var url = spaceUrl + '/tickets';
+
+      if (results.currentMilestone) {
+        url += '/milestone/' + results.currentMilestone.id;
+      }
+
+      url += '.json';
+
+      return url;
     }
 
-    url += '.json';
+    function fetchAnotherPageOfTickets(callback) {
+      var requestInfo = getTicketListRequestInfo(url);
 
-    var requestInfo = getRequestInfo(url);
+      makeRequest(requestInfo, function(err, jsend) {
+        collectTickets(jsend);
+        fetchedTicketCount = jsend.data.length;
+        pageNumber += 1;
 
-    requestInfo.qs = {
-      'per_page': 100
-    };
+        callback(jsend.status === 'success' ? null : new Error(jsend.message));
+      });
+    }
+
+    function getTicketListRequestInfo(url) {
+      var requestInfo = getRequestInfo(url);
+
+      requestInfo.qs = {
+        'page': pageNumber,
+        'per_page': connector.TICKET_LIST_PAGE_SIZE
+      };
+
+      return requestInfo;
+    }
+
+    function collectTickets(jsend) {
+      if (tickets) {
+        tickets.data = tickets.data.concat(jsend.data);
+      } else {
+        tickets = jsend;
+      }
+    }
+
+    function isLastPage() {
+      return fetchedTicketCount < connector.TICKET_LIST_PAGE_SIZE;
+    }
 
-    makeRequest(requestInfo, callback);
   };
 
 
   module.exports.getSpaces = function(callback) {
-    var requestInfo = getRequestInfo(API_URL + '/spaces.json');
+    var requestInfo = getRequestInfo(connector.API_URL + '/spaces.json');
 
     makeRequest(requestInfo, callback);
   };

spec/indexSpec.js

@@ -254,7 +254,10 @@ describe('AssemblaConnector', function() {
           status: 'Fixed'
         }];
 
-        paginationParams = {'per_page': 100};
+        paginationParams = {
+          'page': 1,
+          'per_page': connector.TICKET_LIST_PAGE_SIZE
+        };
 
         stubHttpReponseFor('get', ticketsApiUrl + '/statuses.json').andRespondWith(200, apiData.ticketStatuses);
       });
@@ -307,6 +310,77 @@ describe('AssemblaConnector', function() {
       });
 
 
+      describe('pagination', function() {
+        var originalConnectorPageSize, page1, page2, page3;
+
+        beforeEach(function() {
+          originalConnectorPageSize = connector.TICKET_LIST_PAGE_SIZE;
+        });
+
+        afterEach(function() {
+          connector.TICKET_LIST_PAGE_SIZE = originalConnectorPageSize;
+        });
+
+        beforeEach(function() {
+          stubHttpReponseFor('get', spaceApiUrl + '/milestones/all.json').andRespondWith(200, []);
+
+          paginationParams['per_page'] =
+          connector.TICKET_LIST_PAGE_SIZE = 2;
+
+          page1 = [{
+            number: 1,
+            summary: 'Summary 1',
+            description: 'Description 1',
+            state: 1,
+            status: 'In-Progress'
+          }, {
+            number: 2,
+            summary: 'Summary 2',
+            description: 'Description 2',
+            state: 1,
+            status: 'Fixed'
+          }];
+          paginationParams.page = 1;
+          stubHttpReponseFor('get', ticketsApiUrl + '.json', paginationParams).andRespondWith(200, page1);
+
+          page2 = [{
+            number: 3,
+            summary: 'Summary 3',
+            description: 'Description 3',
+            state: 1,
+            status: 'In-Progress'
+          }, {
+            number: 4,
+            summary: 'Summary 4',
+            description: 'Description 4',
+            state: 1,
+            status: 'Fixed'
+          }];
+          paginationParams.page = 2;
+          stubHttpReponseFor('get', ticketsApiUrl + '.json', paginationParams).andRespondWith(200, page2);
+
+          page3 = [{
+            number: 5,
+            summary: 'Summary 5',
+            description: 'Description 5',
+            state: 1,
+            status: 'Fixed'
+          }];
+          paginationParams.page = 3;
+          stubHttpReponseFor('get', ticketsApiUrl + '.json', paginationParams).andRespondWith(200, page3);
+        });
+
+        it('fetches all the tickets page-by-page', function(done) {
+          connector.getGoals(params, function(jsendResponse) {
+            expect(jsendResponse.data.goals.length).toBe(page1.length + page2.length + page3.length);
+            expect(request.get.callCount).toBe(5); // 1 statuses + 1  milestones + 3 pages of tickets
+
+            done();
+          });
+        });
+      });
+
+
       it('transforms and packs the received tickets into a success JSend response and passes it to the callback', function(done) {
         stubHttpReponseFor('get', spaceApiUrl + '/milestones/all.json').andRespondWith(200, []);
         stubHttpReponseFor('get', ticketsApiUrl + '.json', paginationParams).andRespondWith(200, apiData.tickets);