recombee-api-client 4.1.5 → 5.0.0

package/test/set-environment.js

@@ -1,113 +1,116 @@
-'use strict'
+'use strict';
 
 var recombee = require('./../index.js');
 var rqs = recombee.requests;
 var errs = recombee.errors;
 
-var client = new recombee.ApiClient('client-test', 'jGGQ6ZKa8rQ1zTAyxTc0EMn55YPF7FJLUtaMLhbsGxmvwxgTwXYqmUk5xVZFw98L', {'region': 'eu-west'});
+// Read credentials from environment variables
+const DB_ID = process.env.DB_ID;
+const PRIVATE_TOKEN = process.env.PRIVATE_TOKEN;
+
+if (!DB_ID || !PRIVATE_TOKEN) {
+    throw new Error('Environment variables DB_ID and PRIVATE_TOKEN must be set.');
+}
+
+var client = new recombee.ApiClient(DB_ID, PRIVATE_TOKEN, { region: 'eu-west' });
 
 var _setEnvironmentData = (() => {
-  let requests = new rqs.Batch([
-
-      new rqs.AddItem('entity_id'),
-      new rqs.AddUser('entity_id'),
-      new rqs.AddSeries('entity_id'),
-      new rqs.AddGroup('entity_id'),
-      new rqs.InsertToGroup('entity_id', 'item', 'entity_id'),
-      new rqs.InsertToSeries('entity_id', 'item', 'entity_id', 1),
-      new rqs.AddItemProperty('int_property', 'int'),
-      new rqs.AddItemProperty('str_property', 'string'),
-      new rqs.SetItemValues('entity_id', {'int_property': 42, 'str_property': 'hello'}),
-      new rqs.AddUserProperty('int_property', 'int'),
-      new rqs.AddUserProperty('str_property', 'string'),
-      new rqs.SetUserValues('entity_id', {'int_property': 42, 'str_property': 'hello'})        
-  ]);
-
-  return client.send(requests);
+    let requests = new rqs.Batch([
+        new rqs.AddItem('entity_id'),
+        new rqs.AddUser('entity_id'),
+        new rqs.AddSeries('entity_id'),
+        new rqs.InsertToSeries('entity_id', 'item', 'entity_id', 1),
+        new rqs.AddItemProperty('int_property', 'int'),
+        new rqs.AddItemProperty('str_property', 'string'),
+        new rqs.SetItemValues('entity_id', { 'int_property': 42, 'str_property': 'hello' }),
+        new rqs.AddUserProperty('int_property', 'int'),
+        new rqs.AddUserProperty('str_property', 'string'),
+        new rqs.SetUserValues('entity_id', { 'int_property': 42, 'str_property': 'hello' })
+    ]);
+
+    return client.send(requests);
 });
 
 var _delay = ((t, v) => {
-   return new Promise(function(resolve) { 
-       setTimeout(resolve.bind(null, v), t)
-   })
+    return new Promise(function (resolve) {
+        setTimeout(resolve.bind(null, v), t);
+    });
 });
 
 var _checkDbErased = (() => {
-  return client.send(new rqs.ListItems())
-  .then((resp) => {
-    return _setEnvironmentData();
-  })
-  .catch((err) => {
-    if (err instanceof errs.ResponseError && err.statusCode === 422) {
-      // Wait until DB is erased
-      return _delay(2000).then(() => {
-        return _checkDbErased();
-      });
-    }
-    throw err;
-  })
+    return client.send(new rqs.ListItems())
+        .then((resp) => {
+            return _setEnvironmentData();
+        })
+        .catch((err) => {
+            if (err instanceof errs.ResponseError && err.statusCode === 422) {
+                // Wait until DB is erased
+                return _delay(2000).then(() => {
+                    return _checkDbErased();
+                });
+            }
+            throw err;
+        });
 });
 
 var setEnvironment = (() => {
-  return client.send(new rqs.ResetDatabase())
-  .then((resp) => {
-    return _checkDbErased();
-  })
+    return _checkDbErased() // Ensure DB is in a clean state before resetting
+        .then(() => {
+            return client.send(new rqs.ResetDatabase());
+        })
+        .then((resp) => {
+            return _checkDbErased(); // Ensure DB is ready after resetting
+        });
 });
 
 var setInteractions = (() => {
-
-  let requests = new rqs.Batch([
-      new rqs.AddUser('user'),
-      new rqs.AddItem('item'),
-      new rqs.AddDetailView('user', 'item', {'timestamp': 0}),
-      new rqs.AddPurchase('user', 'item', {'timestamp': 0}),
-      new rqs.AddRating('user', 'item', -1, {'timestamp': 0}),
-      new rqs.AddCartAddition('user', 'item', {'timestamp': 0}),
-      new rqs.AddBookmark('user', 'item', {'timestamp': 0}),
-      new rqs.SetViewPortion('user', 'item',1, {'timestamp': 0})
-  ]);
-
-  return client.send(requests);
+    let requests = new rqs.Batch([
+        new rqs.AddUser('user'),
+        new rqs.AddItem('item'),
+        new rqs.AddDetailView('user', 'item', { 'timestamp': 0 }),
+        new rqs.AddPurchase('user', 'item', { 'timestamp': 0 }),
+        new rqs.AddRating('user', 'item', -1, { 'timestamp': 0 }),
+        new rqs.AddCartAddition('user', 'item', { 'timestamp': 0 }),
+        new rqs.AddBookmark('user', 'item', { 'timestamp': 0 }),
+        new rqs.SetViewPortion('user', 'item', 1, { 'timestamp': 0 })
+    ]);
+
+    return client.send(requests);
 });
 
 var setRecommEntities = (() => {
-
-  const NUM = 100
-  const PROBABILITY_PURCHASED = 0.1
-
-  let users = Array.apply(0, Array(NUM)).map(function (_, i) { 
-          return `user-${i}`;
-      });
-
-  let items = Array.apply(0, Array(NUM)).map(function (_, i) { 
-          return `item-${i}`;
-      });
-
-  let purchases = [];
-
-  users.forEach((user) => {
-    let p = items.filter(() => Math.random() < PROBABILITY_PURCHASED);
-    p.forEach((item) => {purchases.push(new rqs.AddPurchase(user, item))});
-  });
-
-  return client.send(new rqs.Batch(users.map((u) => {return new rqs.AddUser(u)})))
-  .then(() => {
-    return client.send(new rqs.Batch([
-      new rqs.AddItemProperty('answer', 'int'),
-      new rqs.AddItemProperty('id2', 'string'),
-      new rqs.AddItemProperty('empty', 'string')]));
-  })
-  .then(() => {
-    return client.send(new rqs.Batch(items.map((itemId) => {
-      return new rqs.SetItemValues(itemId, {'answer': 42, 'id2': itemId}, {'cascadeCreate': true})})));
-  })
-  .then(() => {
-    return client.send(new rqs.Batch(purchases));
-  });
+    const NUM = 100;
+    const PROBABILITY_PURCHASED = 0.1;
+
+    let users = Array.from({ length: NUM }, (_, i) => `user-${i}`);
+    let items = Array.from({ length: NUM }, (_, i) => `item-${i}`);
+
+    let purchases = [];
+
+    users.forEach((user) => {
+        let p = items.filter(() => Math.random() < PROBABILITY_PURCHASED);
+        p.forEach((item) => { purchases.push(new rqs.AddPurchase(user, item)); });
+    });
+
+    return client.send(new rqs.Batch(users.map((u) => new rqs.AddUser(u))))
+        .then(() => {
+            return client.send(new rqs.Batch([
+                new rqs.AddItemProperty('answer', 'int'),
+                new rqs.AddItemProperty('id2', 'string'),
+                new rqs.AddItemProperty('empty', 'string')
+            ]));
+        })
+        .then(() => {
+            return client.send(new rqs.Batch(items.map((itemId) => {
+                return new rqs.SetItemValues(itemId, { 'answer': 42, 'id2': itemId }, { 'cascadeCreate': true });
+            })));
+        })
+        .then(() => {
+            return client.send(new rqs.Batch(purchases));
+        });
 });
 
 exports.client = client;
 exports.setEnvironment = setEnvironment;
 exports.setInteractions = setInteractions;
-exports.setRecommEntities = setRecommEntities;
+exports.setRecommEntities = setRecommEntities;

package/test/set-view-portion-batch_test.js

@@ -25,7 +25,6 @@ describe('SetViewPortion', function(){
       new rqs.SetViewPortion('entity_id','entity_id',0),
       new rqs.SetViewPortion('entity_id','nonex_id',1),
       new rqs.SetViewPortion('nonex_id','entity_id',0.5),
-      new rqs.SetViewPortion('entity_id','entity_id',0,{'timestamp': -15}),
       new rqs.SetViewPortion('entity_id','entity_id',-2),
       new rqs.SetViewPortion('entity_id','entity_id',0.7,{'sessionId': 'a****'})
       ];
@@ -38,7 +37,6 @@ describe('SetViewPortion', function(){
         chai.equal(responses[3].code, 404);
         chai.equal(responses[4].code, 400);
         chai.equal(responses[5].code, 400);
-        chai.equal(responses[6].code, 400);
       done();
     });
   });

package/test/set-view-portion-callback_test.js

@@ -76,21 +76,6 @@ describe('SetViewPortion', function(){
     }));
   });
   
-  it ('fails with invalid time', (done) => {
-    let req, req2, resp;
-    req = new rqs.SetViewPortion('entity_id','entity_id',0,{'timestamp': -15});
-    env.client.send(req,((err,res) => {
-      if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 400);
-        done();
-      }
-      else {
-        chai.fail();
-      }
-    }));
-  });
-  
   it ('fails with invalid portion', (done) => {
     let req, req2, resp;
     req = new rqs.SetViewPortion('entity_id','entity_id',-2);

package/test/set-view-portion-test.js

@@ -72,23 +72,6 @@ describe('SetViewPortion', function(){
     });
   });
   
-  it ('fails with invalid time', (done) => {
-    let req, req2, resp;
-    req = new rqs.SetViewPortion('entity_id','entity_id',0,{'timestamp': -15});
-    env.client.send(req)
-    .then((res) => {
-      chai.fail();
-      done();
-    })
-    .catch((err) => {
-      if (err instanceof recombee.errors.ResponseError) {
-        chai.equal(err.statusCode, 400);
-        done();
-      }
-      throw err;
-    });
-  });
-  
   it ('fails with invalid portion', (done) => {
     let req, req2, resp;
     req = new rqs.SetViewPortion('entity_id','entity_id',-2);

package/lib/requests/add-group.js

@@ -1,42 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict';
-const rqs = require("./request");
-
-/**
- * Creates a new group in the database.
- */
-class AddGroup extends rqs.Request {
-
-  /**
-   * Construct the request
-   * @param {string} groupId - ID of the group to be created.
-   */
-  constructor(groupId) {
-    super('PUT', `/groups/${groupId}`, 1000, false);
-    this.groupId = groupId;
-  }
-
-  /**
-   * Get body parameters
-   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
-   */
-  bodyParameters() {
-    let params = {};
-
-    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.AddGroup = AddGroup

package/lib/requests/delete-group.js

@@ -1,43 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict';
-const rqs = require("./request");
-
-/**
- * Deletes the group of the given `groupId` from the database.
- * Deleting a group will only delete the assignment of items to it, not the items themselves!
- */
-class DeleteGroup extends rqs.Request {
-
-  /**
-   * Construct the request
-   * @param {string} groupId - ID of the group to be deleted.
-   */
-  constructor(groupId) {
-    super('DELETE', `/groups/${groupId}`, 1000, false);
-    this.groupId = groupId;
-  }
-
-  /**
-   * Get body parameters
-   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
-   */
-  bodyParameters() {
-    let params = {};
-
-    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.DeleteGroup = DeleteGroup

package/lib/requests/insert-to-group.js

@@ -1,58 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict';
-const rqs = require("./request");
-
-/**
- * Inserts an existing item/group into a group of the given `groupId`.
- */
-class InsertToGroup extends rqs.Request {
-
-  /**
-   * Construct the request
-   * @param {string} groupId - ID of the group to be inserted into.
-   * @param {string} itemType - `item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.
-   * @param {string} itemId - ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
-   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
-   * - Allowed parameters:
-   *     - *cascadeCreate*
-   *         - Type: boolean
-   *         - Description: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
-   */
-  constructor(groupId, itemType, itemId, optional) {
-    super('POST', `/groups/${groupId}/items/`, 1000, false);
-    this.groupId = groupId;
-    this.itemType = itemType;
-    this.itemId = itemId;
-    optional = optional || {};
-    this.cascadeCreate = optional.cascadeCreate;
-  }
-
-  /**
-   * Get body parameters
-   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
-   */
-  bodyParameters() {
-    let params = {};
-    params.itemType = this.itemType;
-    params.itemId = this.itemId;
-
-    if(this.cascadeCreate !== undefined)
-      params.cascadeCreate = this.cascadeCreate;
-
-    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.InsertToGroup = InsertToGroup

package/lib/requests/list-group-items.js

@@ -1,42 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict';
-const rqs = require("./request");
-
-/**
- * List all the items present in the given group.
- */
-class ListGroupItems extends rqs.Request {
-
-  /**
-   * Construct the request
-   * @param {string} groupId - ID of the group whose items are to be listed.
-   */
-  constructor(groupId) {
-    super('GET', `/groups/${groupId}/items/`, 100000, false);
-    this.groupId = groupId;
-  }
-
-  /**
-   * Get body parameters
-   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
-   */
-  bodyParameters() {
-    let params = {};
-
-    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.ListGroupItems = ListGroupItems

package/lib/requests/list-groups.js

@@ -1,40 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict';
-const rqs = require("./request");
-
-/**
- * Gets the list of all the groups currently present in the database.
- */
-class ListGroups extends rqs.Request {
-
-  /**
-   * Construct the request
-   */
-  constructor() {
-    super('GET', '/groups/list/', 100000, false);
-  }
-
-  /**
-   * Get body parameters
-   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
-   */
-  bodyParameters() {
-    let params = {};
-
-    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.ListGroups = ListGroups

package/lib/requests/remove-from-group.js

@@ -1,48 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict';
-const rqs = require("./request");
-
-/**
- * Removes an existing group item from the group.
- */
-class RemoveFromGroup extends rqs.Request {
-
-  /**
-   * Construct the request
-   * @param {string} groupId - ID of the group from which a group item is to be removed.
-   * @param {string} itemType - Type of the item to be removed.
-   * @param {string} itemId - ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
-   */
-  constructor(groupId, itemType, itemId) {
-    super('DELETE', `/groups/${groupId}/items/`, 1000, false);
-    this.groupId = groupId;
-    this.itemType = itemType;
-    this.itemId = itemId;
-  }
-
-  /**
-   * Get body parameters
-   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
-   */
-  bodyParameters() {
-    let params = {};
-
-    return params;
-  }
-
-  /**
-   * Get query parameters
-   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
-   */
-  queryParameters() {
-    let params = {};
-    params.itemType = this.itemType;
-    params.itemId = this.itemId;
-    return params;
-  }
-}
-
-exports.RemoveFromGroup = RemoveFromGroup

package/test/add-group-batch_test.js

@@ -1,39 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict'
-var chai = require('chai').assert;
-var recombee = require('./../index.js');
-var rqs = recombee.requests;
-
-var env = require('./set-environment.js');
-
-describe('AddGroup', function(){
-  this.timeout(150000);
-
-  before(function(done){
-
-    env.setEnvironment()
-    .then(()=> {
-      setTimeout(done, 20000);
-     });
-  });
-  it ('works in batch', (done) => {
-    let requests = [
-      new rqs.AddGroup('valid_id'),
-      new rqs.AddGroup('***not_valid$$$'),
-      new rqs.AddGroup('valid_id2'),
-      new rqs.AddGroup('valid_id2')
-      ];
-    
-    env.client.send(new rqs.Batch(requests))
-    .then((responses) => {
-        chai.equal(responses[0].code, 201);
-        chai.equal(responses[1].code, 400);
-        chai.equal(responses[2].code, 201);
-        chai.equal(responses[3].code, 409);
-      done();
-    });
-  });
-});

package/test/add-group-callback_test.js

@@ -1,72 +0,0 @@
-/*
- This file is auto-generated, do not edit
-*/
-
-'use strict'
-var chai = require('chai').assert;
-var recombee = require('./../index.js');
-var rqs = recombee.requests;
-
-var env = require('./set-environment.js');
-
-describe('AddGroup', function(){
-  this.timeout(150000);
-
-  before(function(done){
-
-    env.setEnvironment()
-    .then(()=> {
-      setTimeout(done, 20000);
-     });
-  });
-  
-  it ('does not fail with valid entity id', (done) => {
-    let req, req2, resp;
-    req = new rqs.AddGroup('valid_id');
-    env.client.send(req,((err,res) => {
-      if(err) {
-        chai.fail();
-      }
-      else {
-        done();
-      }
-    }));
-  });
-  
-  it ('fails with invalid entity id', (done) => {
-    let req, req2, resp;
-    req = new rqs.AddGroup('***not_valid$$$');
-    env.client.send(req,((err,res) => {
-      if(err) {
-        chai.equal(err.name, 'ResponseError');
-        chai.equal(err.statusCode, 400);
-        done();
-      }
-      else {
-        chai.fail();
-      }
-    }));
-  });
-  
-  it ('really stores entity to the system', (done) => {
-    let req, req2, resp;
-    req = new rqs.AddGroup('valid_id2');
-    env.client.send(req,((err,res) => {
-      if(err) {
-        chai.fail();
-      }
-      else {
-        env.client.send(req,((err,res) => {
-          if(err) {
-            chai.equal(err.name, 'ResponseError');
-            chai.equal(err.statusCode, 409);
-            done();
-          }
-          else {
-            chai.fail();
-          }
-        }));
-      }
-    }));
-  });
-});