Merge pull request #15 from AddSearch/set-api-hostname

anttiai · web-flow · commit 6bb6e613b0b4 · 2020-12-22T11:52:21.000+02:00
Set api hostname
diff --git a/README.md b/README.md
@@ -306,6 +306,12 @@ client.setJWT(token);
 client.setThrottleTime(500);
 ```
 
+#### Set API hostname
+```js
+// Set API hostname (e.g. for dedicated environments)
+client.setApiHostname('api.addsearch.com');
+```
+
 ## Indexing API
 With the Indexing API, you can fetch, create, update, and delete single documents or
 batches of documents.
diff --git a/src/apifetch.js b/src/apifetch.js
@@ -6,7 +6,7 @@ require('isomorphic-fetch');
 /**
  * Fetch search results of search suggestions from the Addsearch API
  */
-var executeApiFetch = function(sitekey, type, settings, cb, fuzzyRetry) {
+var executeApiFetch = function(apiHostname, sitekey, type, settings, cb, fuzzyRetry) {
 
   const RESPONSE_BAD_REQUEST = 400;
   const RESPONSE_SERVER_ERROR = 500;
@@ -143,7 +143,7 @@ var executeApiFetch = function(sitekey, type, settings, cb, fuzzyRetry) {
 
 
   // Execute API call
-  fetch('https://api.addsearch.com/v1/' + apiPath + '/' + sitekey + '?term=' + kw + qs)
+  fetch('https://' + apiHostname + '/v1/' + apiPath + '/' + sitekey + '?term=' + kw + qs)
     .then(function(response) {
       return response.json();
     }).then(function(json) {
diff --git a/src/index.js b/src/index.js
@@ -7,11 +7,13 @@ var Settings = require('./settings');
 var util = require('./util');
 var throttle = require('./throttle');
 
+var API_HOSTNAME = 'api.addsearch.com';
 var API_THROTTLE_TIME_MS = 200;
 
 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);
 
@@ -53,7 +55,7 @@ var client = function(sitekey, privatekey) {
     if (!this.throttledSearchFetch) {
       this.throttledSearchFetch = throttle(API_THROTTLE_TIME_MS, executeApiFetch);
     }
-    this.throttledSearchFetch(this.sitekey, 'search', this.settings.getSettings(), callback);
+    this.throttledSearchFetch(this.apiHostname, this.sitekey, 'search', this.settings.getSettings(), callback);
   }
 
 
@@ -71,7 +73,7 @@ var client = function(sitekey, privatekey) {
     if (!this.throttledSuggestionsFetch) {
       this.throttledSuggestionsFetch = throttle(API_THROTTLE_TIME_MS, executeApiFetch);
     }
-    this.throttledSuggestionsFetch(this.sitekey, 'suggest', this.settings.getSettings(), callback);
+    this.throttledSuggestionsFetch(this.apiHostname, this.sitekey, 'suggest', this.settings.getSettings(), callback);
   }
 
 
@@ -89,37 +91,37 @@ var client = function(sitekey, privatekey) {
     if (!this.throttledAutocompleteFetch) {
       this.throttledAutocompleteFetch = throttle(API_THROTTLE_TIME_MS, executeApiFetch);
     }
-    this.throttledAutocompleteFetch(this.sitekey, 'autocomplete', this.settings.getSettings(), callback);
+    this.throttledAutocompleteFetch(this.apiHostname, this.sitekey, 'autocomplete', this.settings.getSettings(), callback);
   }
 
 
   /**
    * Indexing API functions
    */
   this.getDocument = function(id) {
-    return indexingapi.getDocument(this.sitekey, this.privatekey, id);
+    return indexingapi.getDocument(this.apiHostname, this.sitekey, this.privatekey, id);
   }
 
   this.saveDocument = function(document) {
-    return indexingapi.saveDocument(this.sitekey, this.privatekey, document);
+    return indexingapi.saveDocument(this.apiHostname, this.sitekey, this.privatekey, document);
   }
 
   this.saveDocumentsBatch = function(batch) {
     if (!batch || !batch.documents || !Array.isArray(batch.documents)) {
       throw "Please provide an array of documents: {documents: []}";
     }
-    return indexingapi.saveDocumentsBatch(this.sitekey, this.privatekey, batch);
+    return indexingapi.saveDocumentsBatch(this.apiHostname, this.sitekey, this.privatekey, batch);
   }
 
   this.deleteDocument = function(id) {
-    return indexingapi.deleteDocument(this.sitekey, this.privatekey, id);
+    return indexingapi.deleteDocument(this.apiHostname, this.sitekey, this.privatekey, id);
   }
 
   this.deleteDocumentsBatch = function(batch) {
     if (!batch || !batch.documents || !Array.isArray(batch.documents)) {
       throw "Please provide an array of document ids: {documents: []}";
     }
-    return indexingapi.deleteDocumentsBatch(this.sitekey, this.privatekey, batch);
+    return indexingapi.deleteDocumentsBatch(this.apiHostname, this.sitekey, this.privatekey, batch);
   }
 
 
@@ -128,6 +130,7 @@ var client = function(sitekey, privatekey) {
   /**
    * Public functions
    */
+  this.setApiHostname = function(hostname) { this.apiHostname = hostname; }
   this.getSettings = function() { return this.settings.getSettings(); }
   this.setLanguage = function(lang) { this.settings.setLanguage(lang); }
   this.setCategoryFilters = function(categories) { this.settings.setCategoryFilters(categories); }
@@ -165,7 +168,7 @@ var client = function(sitekey, privatekey) {
         keyword: keyword,
         numberOfResults: data.numberOfResults
       };
-      sendStats(this.sitekey, data);
+      sendStats(this.apiHostname, this.sitekey, data);
     }
 
     else if (type === 'click') {
@@ -176,7 +179,7 @@ var client = function(sitekey, privatekey) {
         docid: data.documentId,
         position: data.position
       };
-      sendStats(this.sitekey, data);
+      sendStats(this.apiHostname, this.sitekey, data);
     }
 
     else {
diff --git a/src/indexingapi.js b/src/indexingapi.js
@@ -4,8 +4,6 @@ require('isomorphic-fetch');
 const util = require('./util');
 const Promise = require('es6-promise').Promise;
 
-const BASE_URL = 'https://api.addsearch.com/v2/indices/';
-
 const getHeaders = function(sitekey, privatekey) {
   return {
     'Authorization': 'Basic ' + util.base64(sitekey + ':' + privatekey),
@@ -17,9 +15,10 @@ const getHeaders = function(sitekey, privatekey) {
 /**
  * Fetch document
  */
-var getDocument = function(sitekey, privatekey, id) {
+var getDocument = function(apiHostname, sitekey, privatekey, id) {
   const promise = new Promise((resolve, reject) => {
-    fetch(BASE_URL + sitekey + '/documents/' + id,
+
+    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/' + id,
       {
         method: 'GET',
         headers: getHeaders(sitekey, privatekey)
@@ -42,13 +41,13 @@ var getDocument = function(sitekey, privatekey, id) {
 /**
  * Add document
  */
-var saveDocument = function(sitekey, privatekey, document) {
+var saveDocument = function(apiHostname, sitekey, privatekey, document) {
 
   // If the doc has id or url field, PUT instead of POST
   const isPut = document.id || document.url;
 
   const promise = new Promise((resolve, reject) => {
-    fetch(BASE_URL + sitekey + '/documents/',
+    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/',
       {
         method: isPut ? 'PUT' : 'POST',
         headers: getHeaders(sitekey, privatekey),
@@ -73,10 +72,10 @@ var saveDocument = function(sitekey, privatekey, document) {
 /**
  * Batch add documents
  */
-var saveDocumentsBatch = function(sitekey, privatekey, documents) {
+var saveDocumentsBatch = function(apiHostname, sitekey, privatekey, documents) {
 
   const promise = new Promise((resolve, reject) => {
-    fetch(BASE_URL + sitekey + '/documents:batch',
+    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents:batch',
       {
         method: 'PUT',
         headers: getHeaders(sitekey, privatekey),
@@ -101,9 +100,9 @@ var saveDocumentsBatch = function(sitekey, privatekey, documents) {
 /**
  * Delete documents
  */
-var deleteDocument = function(sitekey, privatekey, id) {
+var deleteDocument = function(apiHostname, sitekey, privatekey, id) {
   const promise = new Promise((resolve, reject) => {
-    fetch(BASE_URL + sitekey + '/documents/' + id,
+    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents/' + id,
       {
         method: 'DELETE',
         headers: getHeaders(sitekey, privatekey)
@@ -127,9 +126,9 @@ var deleteDocument = function(sitekey, privatekey, id) {
 /**
  * Batch delete documents
  */
-var deleteDocumentsBatch = function(sitekey, privatekey, batch) {
+var deleteDocumentsBatch = function(apiHostname, sitekey, privatekey, batch) {
   const promise = new Promise((resolve, reject) => {
-    fetch(BASE_URL + sitekey + '/documents:batch',
+    fetch('https://' + apiHostname + '/v2/indices/' + sitekey + '/documents:batch',
       {
         method: 'DELETE',
         headers: getHeaders(sitekey, privatekey),
diff --git a/src/stats.js b/src/stats.js
@@ -3,16 +3,16 @@
 require('es6-promise').polyfill();
 require('isomorphic-fetch');
 
-var sendStats = function(sitekey, data) {
+var sendStats = function(apiHostname, 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));
+    navigator.sendBeacon('https://' + apiHostname + '/v1/stats/' + sitekey + '/', JSON.stringify(data));
   }
 
   // POST in node
   else {
-    fetch('https://api.addsearch.com/v1/stats/' + sitekey + '/', {
+    fetch('https://' + apiHostname + '/v1/stats/' + sitekey + '/', {
         method: 'POST',
         headers: {
           'Content-Type': 'text/plain',
diff --git a/test/apifetch.js b/test/apifetch.js
@@ -10,7 +10,7 @@ describe('apifetch', function() {
       fetchMock.get('*', { response: 200 });
       const expect = {response: 200};
 
-      apifetch('sitekey', 'search', {paging:{}, keyword: 'foo'}, (res) => {
+      apifetch('api.addsearch.com', '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', {paging:{}, keyword: 'foo'}, (res) => {
+      apifetch('api.addsearch.com', 'sitekey', 'ping', {paging:{}, keyword: 'foo'}, (res) => {
         assert.equal(res.error.response, expect);
       });
     });

Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,13 @@ var Settings = require('./settings');`
`7`	`7`	`var util = require('./util');`
`8`	`8`	`var throttle = require('./throttle');`
`9`	`9`
	`10`	`+var API_HOSTNAME = 'api.addsearch.com';`
`10`	`11`	`var API_THROTTLE_TIME_MS = 200;`
`11`	`12`
`12`	`13`	`var client = function(sitekey, privatekey) {`
`13`	`14`	`this.sitekey = sitekey;`
`14`	`15`	`this.privatekey = privatekey;`
	`16`	`+ this.apiHostname = API_HOSTNAME;`
`15`	`17`	`this.settings = new Settings();`
`16`	`18`	`this.sessionId = ('a-' + (Math.random() * 100000000)).substring(0, 10);`
`17`	`19`
`@@ -53,7 +55,7 @@ var client = function(sitekey, privatekey) {`
`53`	`55`	`if (!this.throttledSearchFetch) {`
`54`	`56`	`this.throttledSearchFetch = throttle(API_THROTTLE_TIME_MS, executeApiFetch);`
`55`	`57`	`}`
`56`		`- this.throttledSearchFetch(this.sitekey, 'search', this.settings.getSettings(), callback);`
	`58`	`+ this.throttledSearchFetch(this.apiHostname, this.sitekey, 'search', this.settings.getSettings(), callback);`
`57`	`59`	`}`
`58`	`60`
`59`	`61`
`@@ -71,7 +73,7 @@ var client = function(sitekey, privatekey) {`
`71`	`73`	`if (!this.throttledSuggestionsFetch) {`
`72`	`74`	`this.throttledSuggestionsFetch = throttle(API_THROTTLE_TIME_MS, executeApiFetch);`
`73`	`75`	`}`
`74`		`- this.throttledSuggestionsFetch(this.sitekey, 'suggest', this.settings.getSettings(), callback);`
	`76`	`+ this.throttledSuggestionsFetch(this.apiHostname, this.sitekey, 'suggest', this.settings.getSettings(), callback);`
`75`	`77`	`}`
`76`	`78`
`77`	`79`
`@@ -89,37 +91,37 @@ var client = function(sitekey, privatekey) {`
`89`	`91`	`if (!this.throttledAutocompleteFetch) {`
`90`	`92`	`this.throttledAutocompleteFetch = throttle(API_THROTTLE_TIME_MS, executeApiFetch);`
`91`	`93`	`}`
`92`		`- this.throttledAutocompleteFetch(this.sitekey, 'autocomplete', this.settings.getSettings(), callback);`
	`94`	`+ this.throttledAutocompleteFetch(this.apiHostname, this.sitekey, 'autocomplete', this.settings.getSettings(), callback);`
`93`	`95`	`}`
`94`	`96`
`95`	`97`
`96`	`98`	`/**`
`97`	`99`	`* Indexing API functions`
`98`	`100`	`*/`
`99`	`101`	`this.getDocument = function(id) {`
`100`		`- return indexingapi.getDocument(this.sitekey, this.privatekey, id);`
	`102`	`+ return indexingapi.getDocument(this.apiHostname, this.sitekey, this.privatekey, id);`
`101`	`103`	`}`
`102`	`104`
`103`	`105`	`this.saveDocument = function(document) {`
`104`		`- return indexingapi.saveDocument(this.sitekey, this.privatekey, document);`
	`106`	`+ return indexingapi.saveDocument(this.apiHostname, this.sitekey, this.privatekey, document);`
`105`	`107`	`}`
`106`	`108`
`107`	`109`	`this.saveDocumentsBatch = function(batch) {`
`108`	`110`	`if (!batch \|\| !batch.documents \|\| !Array.isArray(batch.documents)) {`
`109`	`111`	`throw "Please provide an array of documents: {documents: []}";`
`110`	`112`	`}`
`111`		`- return indexingapi.saveDocumentsBatch(this.sitekey, this.privatekey, batch);`
	`113`	`+ return indexingapi.saveDocumentsBatch(this.apiHostname, this.sitekey, this.privatekey, batch);`
`112`	`114`	`}`
`113`	`115`
`114`	`116`	`this.deleteDocument = function(id) {`
`115`		`- return indexingapi.deleteDocument(this.sitekey, this.privatekey, id);`
	`117`	`+ return indexingapi.deleteDocument(this.apiHostname, this.sitekey, this.privatekey, id);`
`116`	`118`	`}`
`117`	`119`
`118`	`120`	`this.deleteDocumentsBatch = function(batch) {`
`119`	`121`	`if (!batch \|\| !batch.documents \|\| !Array.isArray(batch.documents)) {`
`120`	`122`	`throw "Please provide an array of document ids: {documents: []}";`
`121`	`123`	`}`
`122`		`- return indexingapi.deleteDocumentsBatch(this.sitekey, this.privatekey, batch);`
	`124`	`+ return indexingapi.deleteDocumentsBatch(this.apiHostname, this.sitekey, this.privatekey, batch);`
`123`	`125`	`}`
`124`	`126`
`125`	`127`
`@@ -128,6 +130,7 @@ var client = function(sitekey, privatekey) {`
`128`	`130`	`/**`
`129`	`131`	`* Public functions`
`130`	`132`	`*/`
	`133`	`+ this.setApiHostname = function(hostname) { this.apiHostname = hostname; }`
`131`	`134`	`this.getSettings = function() { return this.settings.getSettings(); }`
`132`	`135`	`this.setLanguage = function(lang) { this.settings.setLanguage(lang); }`
`133`	`136`	`this.setCategoryFilters = function(categories) { this.settings.setCategoryFilters(categories); }`
`@@ -165,7 +168,7 @@ var client = function(sitekey, privatekey) {`
`165`	`168`	`keyword: keyword,`
`166`	`169`	`numberOfResults: data.numberOfResults`
`167`	`170`	`};`
`168`		`- sendStats(this.sitekey, data);`
	`171`	`+ sendStats(this.apiHostname, this.sitekey, data);`
`169`	`172`	`}`
`170`	`173`
`171`	`174`	`else if (type === 'click') {`
`@@ -176,7 +179,7 @@ var client = function(sitekey, privatekey) {`
`176`	`179`	`docid: data.documentId,`
`177`	`180`	`position: data.position`
`178`	`181`	`};`
`179`		`- sendStats(this.sitekey, data);`
	`182`	`+ sendStats(this.apiHostname, this.sitekey, data);`
`180`	`183`	`}`
`181`	`184`
`182`	`185`	`else {`