Merge pull request #2 from AddSearch/stats

Stats

Author: anttiai

README.md

@@ -81,6 +81,15 @@ client.setFuzzyMatch(false);
 client.setCollectAnalytics(false);
 ```
 
+#### Send click event to analytics
+When a search results is clicked, send the event to your AddSearch Analytics Dashboard. Information on clicks is used
+in your statistics and in the self-learning search algorithm.
+```js
+// Docid is the 32-character long identifier in each hit returned by the search. 
+// Position is the position of the document that was clicked, the first result being 1
+client.searchResultClicked(docid, position);
+```
+
 #### Set JSON Web Token (for authentication)
 ```js
 // Add JWT to the search request (if protected search index)

src/index.js

@@ -1,13 +1,14 @@
 'use strict';
 
 var executeApiFetch = require('./apifetch');
+var sendStats = require('./stats');
 var Settings = require('./settings');
 var util = require('./util');
-//var sendClickHit = require('./stats');
 
 var client = function(sitekey) {
   this.sitekey = sitekey;
   this.settings = new Settings();
+  this.sessionId = ('a-' + (Math.random() * 100000000)).substring(0, 10);
 
   /**
    * Fetch search results
@@ -85,7 +86,16 @@ var client = function(sitekey) {
   this.setShuffleAndLimitTo = function(shuffleAndLimitTo) { this.settings.setShuffleAndLimitTo(shuffleAndLimitTo); }
   this.setFuzzyMatch = function(fuzzy) { this.settings.setFuzzyMatch(fuzzy); }
   this.setCollectAnalytics = function(collectAnalytics) { this.settings.setCollectAnalytics(collectAnalytics); }
-  //this.hitClicked = function(docid, position) { sendClickHit(this.sitekey, this.settings.getSettings().keyword, docid, position); }
+  this.searchResultClicked = function(documentId, position) {
+    var data = {
+      action: 'click',
+      session: this.sessionId,
+      keyword: this.settings.getSettings().keyword,
+      docid: documentId,
+      position: position
+    };
+    sendStats(this.sitekey, data);
+  }
 
   // Deprecated
   this.useFuzzyMatch = function(use) { this.settings.setFuzzyMatch(use); }

src/stats.js

@@ -0,0 +1,25 @@
+'use strict';
+
+require('es6-promise').polyfill();
+require('isomorphic-fetch');
+
+var sendStats = function(sitekey, data) {
+
+  // Beacon in browsers
+  if (typeof window !== 'undefined' && window.navigator && window.navigator.sendBeacon) {
+    navigator.sendBeacon('https://api.addsearch.com/v1/stats/' + sitekey + '/', JSON.stringify(data));
+  }
+
+  // POST in node
+  else {
+    fetch('https://api.addsearch.com/v1/stats/' + sitekey + '/', {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'text/plain',
+        },
+        body: JSON.stringify(data)
+    });
+  }
+};
+
+module.exports = sendStats;