Add paging and store keyword in settings

Author: anttiai

README.md

@@ -22,14 +22,35 @@ client.search('keyword', cb);
 client.suggest('api', cb);
 ```
 
-## Settings
+## Publicly accessible functions
 
-The following settings are supported by the client
+The client provides the following functions.
+
+#### Fetch search results
+```js
+// Search with a specific keyword
+client.search('keyword', callback);
+
+// Search with the previously used keyword or execute a "match all" query
+client.search(callback);
+```
+
+#### Define language filter (e.g. "en" or "de")
 ```js
-// Get search results only in a specified language (e.g. "en" or "de")
 client.setLanguage('en');
 ```
 
+#### Manage paging
+```js
+// Defaults: page "1", pageSize "10", sortBy "relevance", sortOrder "desc"
+client.setPaging(page, pageSize, sortBy, sortOrder);
+
+// Next {pageSize} results
+client.nextPage();
+
+// Previous {pageSize} results
+client.previousPage();
+```
 
 ## Browser support
 The client is tested on following browsers

src/apifetch.js

@@ -6,19 +6,27 @@ require('isomorphic-fetch');
 /**
  * Fetch search results of search suggestions from the Addsearch API
  */
-var executeApiFetch = function(sitekey, type, keyword, settings, cb) {
+var executeApiFetch = function(sitekey, type, settings, cb) {
 
   const RESPONSE_BAD_REQUEST = 400;
   const RESPONSE_SERVER_ERROR = 500;
 
+  var settingToQueryParam = function(setting, key) {
+    if (setting) {
+      return '&' + key + '=' + setting;
+    }
+    return '';
+  }
+
+
   // Validate query type
   if (type !== 'search' && type !== 'suggest') {
     cb({error: {response: RESPONSE_BAD_REQUEST, message: 'invalid query type'}});
     return;
   }
 
-  // If no keyword, fetch all results
-  let kw = keyword || '*';
+  // Keyword
+  let kw = settings.keyword;
 
   // Boolean operators (AND, OR, NOT) uppercase
   kw = kw.replace(/ and /g, ' AND ').replace(/ or /g, ' OR ').replace(/ not /g, ' NOT ');
@@ -29,9 +37,11 @@ var executeApiFetch = function(sitekey, type, keyword, settings, cb) {
   // Construct query string from settings
   var qs = '';
   if (type === 'search') {
-    if (settings.lang) {
-      qs = qs + '&lang=' + settings.lang;
-    }
+    qs = settingToQueryParam(settings.lang, 'lang') +
+         settingToQueryParam(settings.paging.page, 'page') +
+         settingToQueryParam(settings.paging.pageSize, 'limit') +
+         settingToQueryParam(settings.paging.sortBy, 'sort') +
+         settingToQueryParam(settings.paging.order, 'order');
   }
 
 
@@ -42,6 +52,7 @@ var executeApiFetch = function(sitekey, type, keyword, settings, cb) {
     }).then(function(json) {
     cb(json);
   }).catch(function(ex) {
+    console.log(ex);
     cb({error: {response: RESPONSE_SERVER_ERROR, message: 'invalid server response'}});
   });
 };

src/index.js

@@ -1,18 +1,34 @@
 'use strict';
 
 var executeApiFetch = require('./apifetch');
-var settings = require('./settings');
+var Settings = require('./settings');
+var util = require('./util');
 
 var client = function(sitekey) {
   this.sitekey = sitekey;
+  this.settings = new Settings();
 
   /**
    * Fetch search results
    *
-   * @param keyword
+   * @param a1  Argument 1: Keyword. If no Argument 2, then this is the callback function and search is executed with
+   *            the previous keyword. If there is no Argument 2 and no previous keywords, then search is executed
+   *            without keyword (i.e. match all query)
+   * @param a2  Callback function to call with search results
    */
-  this.search = function(keyword, cb) {
-    executeApiFetch(this.sitekey, 'search', keyword, settings.getSettings(), cb);
+  this.search = function(a1, a2) {
+
+    var keyword = a1;
+    var callback = a2;
+
+    // If function is called with callback only, use previous keyword from settings object
+    if (!a2 && util.isFunction(a1)) {
+      keyword = this.settings.getSettings().keyword;
+      callback = a1;
+    }
+
+    this.settings.setKeyword(keyword);
+    executeApiFetch(this.sitekey, 'search', this.settings.getSettings(), callback);
   };
 
 
@@ -21,15 +37,20 @@ var client = function(sitekey) {
    *
    * @param keyword
    */
-  this.suggest = function(keyword, cb) {
-    executeApiFetch(this.sitekey, 'suggest', keyword, settings.getSettings(), cb);
+  this.suggest = function(keyword, callback) {
+    executeApiFetch(this.sitekey, 'suggest', this.settings.getSettings(), callback);
   };
 
 
   /**
    * Public functions
    */
-  this.setLanguage = settings.setLanguage;
+  this.getSettings = function() { return this.settings.getSettings(); }
+  this.setLanguage = function(lang) { this.settings.setLanguage(lang); };
+  this.setPaging = function(page, pageSize, sortBy, sortOder) { this.settings.setPaging(page, pageSize, sortBy, sortOder); };
+  this.nextPage = function() { this.settings.nextPage(); };
+  this.previousPage = function() { this.settings.previousPage(); };
+
 }
 
 module.exports = client;

src/settings.js

@@ -1,16 +1,43 @@
 'use strict';
 
-var settings = {};
+var settings = function() {
+  this.settings = {
+    keyword: '*',
+    paging: {
+      page: 1,
+      pageSize: 10,
+      sortBy: 'relevance',
+      sortOrder: 'desc'
+    }
+  };
 
-var getSettings = function() {
-  return settings;
-}
+  this.getSettings = function () {
+    return this.settings;
+  }
+
+  this.setKeyword = function (keyword) {
+    this.settings.keyword = keyword || '*';
+  }
+
+  this.setLanguage = function (language) {
+    console.log('LANG SET TO ' + language);
+    this.settings.lang = language;
+  }
 
-var setLanguage = function(language) {
-  settings.lang = language;
+  this.setPaging = function (page, pageSize, sortBy, sortOder) {
+    this.settings.paging.page = page;
+    this.settings.paging.pageSize = pageSize;
+    this.settings.paging.sortBy = sortBy;
+    this.settings.paging.sortOder = sortOder;
+  }
+  this.nextPage = function () {
+    this.settings.paging.page = this.settings.paging.page + 1;
+  }
+  this.previousPage = function () {
+    if (this.settings.paging.page > 0) {
+      this.settings.paging.page = this.settings.paging.page - 1;
+    }
+  }
 }
 
-module.exports = {
-  getSettings,
-  setLanguage
-};
+module.exports = settings;

test/apifetch.js

@@ -10,7 +10,7 @@ describe('apifetch', function() {
       fetchMock.get('*', { response: 200 });
       const expect = {response: 200};
 
-      apifetch('sitekey', 'search', 'keyword', {}, (res) => {
+      apifetch('sitekey', 'search', {paging:{}, keyword: 'foo'}, (res) => {
         assert.deepEqual(res, expect);
       });
     });
@@ -20,7 +20,7 @@ describe('apifetch', function() {
       fetchMock.get('*', 'foo');
       const expect = 400;
 
-      apifetch('sitekey', 'ping', 'keyword', {}, (res) => {
+      apifetch('sitekey', 'ping', {paging:{}, keyword: 'foo'}, (res) => {
         assert.equal(res.error.response, expect);
       });
     });

test/settings.js

@@ -1,14 +1,15 @@
 var assert = require('assert');
-var settings = require('../src/settings');
+var Settings = require('../src/settings');
 
 
 describe('settings', function() {
   describe('setLanguage', function() {
 
     it('language setting should be set', function() {
       const expect = {lang: 'en'};
-      settings.setLanguage('en');
-      assert.deepEqual(settings.getSettings(), expect);
+      var s = new Settings();
+      s.setLanguage('en');
+      assert.equal(s.getSettings().lang, expect.lang);
     });
 
   });