recombee-api-client 3.2.0 → 4.0.0

package/README.md

@@ -44,7 +44,7 @@ client.send(new AddDetailView,
 var recombee = require('recombee-api-client');
 var rqs = recombee.requests;
 
-var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--');
+var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--', {region: 'us-west'});
 
 // Prepare some userIDs and itemIDs
 const NUM = 100;
@@ -96,7 +96,7 @@ client.send(new rqs.Batch(purchases))
 var recombee = require('recombee-api-client');
 var rqs = recombee.requests;
 
-var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--');
+var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--', {region: 'ap-se'});
 const NUM = 100;
 
 // We will use computers as items in this example

package/lib/api-client.js

@@ -1,8 +1,7 @@
 'use strict';
 
 const jsSHA = require("jssha");
-const rp = require('request-promise');
-const rp_errors = require('request-promise/errors');
+const got = require('got');
 
 const api_errors = require('./errors');
 const requests = require('./requests');
@@ -17,15 +16,17 @@ class ApiClient {
    * Construct the client
    * @param {string} databaseId - ID of your database
    * @param {string} secretToken - Corresponding secret token
-   * @param {boolean} alwaysUseHttps - If true, all requests are sent using HTTPS (default: true)
    * @param {Object} options - Other custom options
    */
-  constructor (databaseId, token, alwaysUseHttps, options) {
+  constructor (databaseId, token, options) {
       this.databaseId = databaseId;
       this.token = token;
-      this.alwaysUseHttps = (alwaysUseHttps === undefined) ? true : alwaysUseHttps;
       this.options = options || {};
-      this.baseUri = process.env.RAPI_URI || this.options.baseUri || 'rapi.recombee.com';
+
+      if (Object.getPrototypeOf(this.options) !== Object.prototype) throw new Error(`options must be given as an Object (${this.options} given instead)`);
+
+      this.protocol = this.options.protocol || 'https';
+      this.baseUri = this._getBaseUri()
   }
 
   /**
@@ -41,50 +42,69 @@ class ApiClient {
     let url = this._buildRequestUrl(request);
     let options = {
         method: request.method,
-        uri: url,
+        url: url,
         headers: {'Accept': 'application/json',
                   'Content-Type': 'application/json',
-                  'User-Agent': 'recombee-node-api-client/3.2.0'},
-        timeout: request.timeout,
-        resolveWithFullResponse: true,
-        json: true
+                  'User-Agent': 'recombee-node-api-client/4.0.0'},
+        timeout: request.timeout
     };
 
-    if (this.options.proxy)
-      options.proxy = this.options.proxy;
-
-    if (request.bodyParameters()) 
-      options.body = request.bodyParameters();
+    if (Object.entries(request.bodyParameters()).length > 0)
+      options.json = request.bodyParameters();
 
-    return rp(options)
-           .then(this._parseResponse)
+    return got(options)
+           .json()
            .then((response)=> {
               return new Promise( (resolve) => {
                 if (callback) { return callback(null, response); }
                 return resolve(response);
               });
             })
-            .catch(rp_errors.StatusCodeError,((error) => {
-                throw new api_errors.ResponseError(request, error.statusCode, error.message);
+            .catch((error) => {
+              if (error instanceof got.HTTPError) {
+                error = new api_errors.ResponseError(request, error.response.statusCode, error.response.body);
               }
-            ))
-            .catch(rp_errors.RequestError,((error) => {
-                if(error.cause.code === 'ETIMEDOUT' || error.cause.code === 'ESOCKETTIMEDOUT')
-                  throw new api_errors.TimeoutError(request, error);
-                throw error;
+              else if (error instanceof got.RequestError) {
+                if(error.code === 'ETIMEDOUT' || error.code === 'ESOCKETTIMEDOUT') {
+                  error = new api_errors.TimeoutError(request, error);
+                }
               }
-            ))
-            .catch((error) => {
               if (callback) {return callback(error)};
               throw error;
             });
   }
 
+  _getRegionalBaseUri(region) {
+    const uri = {
+      'ap-se': 'rapi-ap-se.recombee.com',
+      'ca-east': 'rapi-ca-east.recombee.com',
+      'eu-west': 'rapi-eu-west.recombee.com',
+      'us-west': 'rapi-us-west.recombee.com'
+    }[region.toLowerCase()];
+
+    if (uri === undefined) {
+      throw new Error(`Region "${region}" is unknown. You may need to update the version of the SDK.`)
+    }
+
+    return uri;
+  }
+
+  _getBaseUri() {
+    let baseUri = process.env.RAPI_URI || this.options.baseUri;
+    if (this.options.region) {
+      if (baseUri) {
+        throw new Error('baseUri and region cannot be specified at the same time');
+      }
+      baseUri = this._getRegionalBaseUri(this.options.region);
+    }
+    return baseUri || 'rapi.recombee.com';
+  }
+
   _buildRequestUrl(request) {
-    let protocol = (request.ensureHttps || this.alwaysUseHttps) ? 'https' : 'http';
+    let usedProtocol = (request.ensureHttps) ? 'https' : this.protocol;
     let reqUrl = request.path + this._encodeRequestQueryParams(request);
     let signedUrl = this._signUrl(reqUrl);
-    return protocol + '://' + this.baseUri + signedUrl;
+    return usedProtocol + '://' + this.baseUri + signedUrl;
   }
 
   _encodeRequestQueryParams(request) {
@@ -161,14 +181,6 @@ class ApiClient {
       });
   }
 
-  _parseResponse(response) {
-    return new Promise(
-      function (resolve, reject) {
-        resolve(response.body);
-      }
-    );
-  }
-
   _signUrl (req_part) {
     let url = '/' + this.databaseId + req_part;
     url += (req_part.indexOf("?") == -1 ? "?" : "&" ) + "hmac_timestamp=" + parseInt(new Date().getTime() / 1000);

package/lib/requests/delete-item.js

@@ -8,7 +8,7 @@ const rqs = require("./request");
 /**
  * Deletes an item of given `itemId` from the catalog.
  * If there are any *purchases*, *ratings*, *bookmarks*, *cart additions* or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
- * If an item becomes obsolete/no longer available, it is often meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and only exclude the item from recommendations. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+ * If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
  */
 class DeleteItem extends rqs.Request {
 

package/lib/requests/delete-more-items.js

@@ -0,0 +1,44 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Delete all the items that pass the filter.
+ * If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+ */
+class DeleteMoreItems extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
+   */
+  constructor(filter) {
+    super('DELETE', '/more-items/', 1000, false);
+    this.filter = filter;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.DeleteMoreItems = DeleteMoreItems

package/lib/requests/delete-user.js

@@ -13,7 +13,7 @@ class DeleteUser extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} userId - ID of the user to be added.
+   * @param {string} userId - ID of the user to be deleted.
    */
   constructor(userId) {
     super('DELETE', `/users/${userId}`, 1000, false);

package/lib/requests/index.js

@@ -12,6 +12,8 @@ exports.AddItemProperty = require("./add-item-property").AddItemProperty;
 exports.DeleteItemProperty = require("./delete-item-property").DeleteItemProperty;
 exports.GetItemPropertyInfo = require("./get-item-property-info").GetItemPropertyInfo;
 exports.ListItemProperties = require("./list-item-properties").ListItemProperties;
+exports.UpdateMoreItems = require("./update-more-items").UpdateMoreItems;
+exports.DeleteMoreItems = require("./delete-more-items").DeleteMoreItems;
 exports.AddSeries = require("./add-series").AddSeries;
 exports.DeleteSeries = require("./delete-series").DeleteSeries;
 exports.ListSeries = require("./list-series").ListSeries;
@@ -63,8 +65,6 @@ exports.RecommendItemsToItem = require("./recommend-items-to-item").RecommendIte
 exports.RecommendNextItems = require("./recommend-next-items").RecommendNextItems;
 exports.RecommendUsersToUser = require("./recommend-users-to-user").RecommendUsersToUser;
 exports.RecommendUsersToItem = require("./recommend-users-to-item").RecommendUsersToItem;
-exports.UserBasedRecommendation = require("./user-based-recommendation").UserBasedRecommendation;
-exports.ItemBasedRecommendation = require("./item-based-recommendation").ItemBasedRecommendation;
 exports.SearchItems = require("./search-items").SearchItems;
 exports.AddSearchSynonym = require("./add-search-synonym").AddSearchSynonym;
 exports.ListSearchSynonyms = require("./list-search-synonyms").ListSearchSynonyms;

package/lib/requests/recommend-items-to-user.js

@@ -110,7 +110,7 @@ class RecommendItemsToUser extends rqs.Request {
    *         - Description: **Expert option** Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevance, and may return less than *count* items when there is not enough data to fulfill it.
    *     - *rotationRate*
    *         - Type: number
-   *         - Description: **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.1`.
+   *         - Description: **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0`.
    *     - *rotationTime*
    *         - Type: number
    *         - Description: **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.

package/lib/requests/update-more-items.js

@@ -0,0 +1,53 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Update (some) property values of all the items that pass the filter.
+ * Example: *Setting all the items that are older than a week as unavailable*
+ *   ```
+ *     {
+ *       "filter": "'releaseDate' < now() - 7*24*3600",
+ *       "changes": {"available": false}
+ *     }
+ *   ```
+ */
+class UpdateMoreItems extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
+   * @param {} changes - A dictionary where the keys are properties which shall be updated.
+   */
+  constructor(filter, changes) {
+    super('POST', '/more-items/', 1000, false);
+    this.filter = filter;
+    this.changes = changes;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+    params.changes = this.changes;
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.UpdateMoreItems = UpdateMoreItems

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recombee-api-client",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "scripts": {
@@ -26,8 +26,7 @@
   },
   "homepage": "https://github.com/Recombee/node-api-client#readme",
   "dependencies": {
-    "request-promise": "^4.2.5",
-    "request": "^2.88.0",
+    "got": "^11.8.2",
     "jssha": "^2.3.0"
   },
   "devDependencies": {

package/test/add-bookmark-test.js

@@ -55,9 +55,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddBookmark', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-cart-addition-test.js

@@ -55,9 +55,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddCartAddition', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-detail-view-test.js

@@ -55,9 +55,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddDetailView', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-group-test.js

@@ -37,9 +37,12 @@ describe('AddGroup', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -53,9 +56,12 @@ describe('AddGroup', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-item-property-test.js

@@ -41,9 +41,12 @@ describe('AddItemProperty', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -57,9 +60,12 @@ describe('AddItemProperty', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-item-test.js

@@ -37,9 +37,12 @@ describe('AddItem', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -53,9 +56,12 @@ describe('AddItem', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });