new method to enable sending personalization to stat endpoints

Author: haoAddsearch

README.md

@@ -358,6 +358,16 @@ var events = [
 client.setPersonalizationEvents(events);
 ```
 
+
+### Advanced Personalization
+
+#### Set personalization token
+```js
+// Add a personalization token to the stat events
+client.enablePersonalization(options);
+```
+
+
 ### Other
 
 #### Set JSON Web Token (for authentication)

src/cookie.js

@@ -0,0 +1,44 @@
+const setCookie = function(cookieName, cookieValue, expireDays) {
+  const date = new Date();
+  date.setTime(date.getTime() + (expireDays * 24 * 60 * 60 * 1000));
+  let expires = "expires="+ date.toUTCString();
+  document.cookie = cookieName + "=" + cookieValue + ";" + expires + ";path=/";
+}
+
+const getCookie = function(cookieName) {
+  let name = cookieName + "=";
+  let decodedCookie = decodeURIComponent(document.cookie);
+  let cookieArray = decodedCookie.split(';');
+  for(let i = 0; i < cookieArray.length; i++) {
+    let cookie = cookieArray[i];
+    while (cookie.charAt(0) === ' ') {
+      cookie = cookie.substring(1);
+    }
+    if (cookie.indexOf(name) === 0) {
+      return cookie.substring(name.length, cookie.length);
+    }
+  }
+  return "";
+}
+
+const deleteCookie = function(name) {
+  document.cookie = name +'=; Path=/; Expires=Thu, 01 Jan 2000 00:00:01 GMT;';
+}
+
+const checkCookie = function(){
+  var cookieEnabled = navigator.cookieEnabled;
+  var testCookieName = 'addstestcookie';
+  if (!cookieEnabled){
+    setCookie(testCookieName);
+    cookieEnabled = !!getCookie(testCookieName);
+    deleteCookie(testCookieName);
+  }
+  return cookieEnabled;
+}
+
+module.exports = {
+  setCookie,
+  getCookie,
+  deleteCookie,
+  checkCookie
+}

src/index.js

@@ -6,15 +6,18 @@ var sendStats = require('./stats');
 var Settings = require('./settings');
 var util = require('./util');
 var throttle = require('./throttle');
+var cookie = require('./cookie');
 
 var API_HOSTNAME = 'api.addsearch.com';
+var PERSONALIZATION_TOKEN_COOKIE_NAME = 'addsearchPersonalizationToken';
 
 var client = function(sitekey, privatekey) {
   this.sitekey = sitekey;
   this.privatekey = privatekey;
   this.apiHostname = API_HOSTNAME;
   this.settings = new Settings();
   this.sessionId = ('a-' + (Math.random() * 100000000)).substring(0, 10);
+  this.personalizationToken = null;
 
   /**
    * Fetch search results
@@ -209,7 +212,7 @@ var client = function(sitekey, privatekey) {
     if (type === 'search') {
       let payload = {
         action: 'search',
-        session: this.sessionId,
+        session: this.personalizationToken || this.sessionId,
         keyword: keyword,
         numberOfResults: data.numberOfResults,
         analyticsTag: this.getSettings().analyticsTag
@@ -220,7 +223,7 @@ var client = function(sitekey, privatekey) {
     else if (type === 'click') {
       let payload = {
         action: 'click',
-        session: this.sessionId,
+        session: this.personalizationToken || this.sessionId,
         keyword: keyword,
         docid: data.documentId,
         position: data.position,
@@ -234,6 +237,25 @@ var client = function(sitekey, privatekey) {
     }
   }
 
+  this.enablePersonalization = function(options) {
+    if (options && options.personalizationToken) {
+      this.personalizationToken = options.personalizationToken;
+      return;
+    }
+
+    if (!cookie.checkCookie()) {
+      return;
+    }
+
+    // TODO: set cookie expires days
+    let personalizationTokenInCookies = cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME);
+    if (!personalizationTokenInCookies) {
+      personalizationTokenInCookies = util.generateRandomString('ps');
+      cookie.setCookie(PERSONALIZATION_TOKEN_COOKIE_NAME, personalizationTokenInCookies);
+    }
+    this.personalizationToken = personalizationTokenInCookies;
+  };
+
 
   // Deprecated
   this.searchResultClicked = function(documentId, position) {

src/util.js

@@ -39,8 +39,13 @@ const validateSetPagingParams = function(page, pageSize, sortBy, sortOrder) {
   }
 }
 
+const generateRandomString = function(prefix) {
+  return (prefix + '-' + (Math.random() * 100000000)).substring(0, 10);
+};
+
 module.exports = {
   isFunction,
   base64,
-  validateSetPagingParams: validateSetPagingParams
+  validateSetPagingParams: validateSetPagingParams,
+  generateRandomString
 }