Support Batch endpoint

Author: OndraFiedler

README.md

@@ -15,7 +15,7 @@ The library is [UMD](https://github.com/umdjs/umd) compatible.
 You can download [recombee-api-client.min.js](./dist/recombee-api-client.min.js) and host it at your site, or use a CDN such as [jsDelivr](https://www.jsdelivr.com/) CDN:
 
 ```js
-<script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].0/dist/recombee-api-client.min.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].1/dist/recombee-api-client.min.js"></script>
 ```
 
 ### npm
@@ -189,7 +189,7 @@ Let's assume we want to show recommendations at product page of pants `product-2
         </div>
     </div>
 
-    <script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].0/dist/recombee-api-client.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].1/dist/recombee-api-client.min.js"></script>
 
     <script type="text/javascript">
 

dist/recombee-api-client.js

@@ -1,6 +1,6 @@
 {
   "name": "recombee-js-api-client",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Client-side js library for easy use of the Recombee recommendation API",
   "browser": "./src/index.js",
   "repository": {

dist/recombee-api-client.js.map

@@ -22,3 +22,4 @@ exports.RecommendItemSegmentsToItem = require("./requests/recommend-item-segment
 exports.RecommendItemSegmentsToItemSegment = require("./requests/recommend-item-segments-to-item-segment").RecommendItemSegmentsToItemSegment;
 exports.SearchItems = require("./requests/search-items").SearchItems;
 exports.SearchItemSegments = require("./requests/search-item-segments").SearchItemSegments;
+exports.Batch = require("./requests/batch").Batch;

dist/recombee-api-client.min.js

@@ -0,0 +1,56 @@
+'use strict';
+const rqs = require("./request");
+
+var sum_timeouts = ((requests) => {
+  return requests.map((r) => r.timeout).reduce((a, b) => a + b, 0);
+});
+
+/**
+ * In many cases, it may be desirable to execute multiple requests at once. For example, when synchronizing the catalog of items in a periodical manner, you would have to execute a sequence of thousands of separate POST requests, which is very ineffective and may take a very long time to complete. Most notably, network latencies can make execution of such sequence very slow and even if executed in multiple parallel threads, there will still be unreasonable overhead caused by the HTTP(s). To avoid the mentioned problems, batch processing may be used, encapsulating a sequence of requests into a single HTTPS request.
+ * Batch processing allows you to submit arbitrary sequence of requests and the batch may combine different types of requests arbitrarily as well.
+ * Note that the status code of the batch request itself is 200 even if the individual requests result in error – you have to inspect the code values in the resulting array.
+  */
+class Batch extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {Request[]} requests - Array containing the requests.
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *distinctRecomms*
+   *         - Type: boolean
+   *         - Description: Makes all the recommended items for a certain user distinct among multiple recommendation requests in the batch.
+   */
+  constructor(requests, optional) {
+    super('POST', '/batch/', sum_timeouts(requests), true);
+    this.requests = requests;
+    optional = optional || {};
+    this.distinctRecomms = optional.distinctRecomms;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let reqs = this.requests.map((r) => this._request_to_batch_object(r));
+    let result = {requests: reqs};
+
+    if(this.distinctRecomms !== undefined)
+      result.distinctRecomms = this.distinctRecomms;
+    
+    return result;
+  }
+
+  _request_to_batch_object(req) {
+    const bodyParameters = req.bodyParameters();
+    return {
+      method: req.method,
+      path: req.path,
+      params: Object.keys(bodyParameters).length ? bodyParameters : undefined,
+    };
+  }
+
+}
+
+exports.Batch = Batch

dist/recombee-api-client.min.js.map

@@ -3,7 +3,7 @@ function createClient() {
 }
 
 function testInteractionPromise(assert, interactionReq) {
-  assert.timeout(1000);
+  assert.timeout(3000);
   var done = assert.async();
 
   var client = createClient();
@@ -19,7 +19,7 @@ function testInteractionPromise(assert, interactionReq) {
 }
 
 function testInteractionCallback(assert, interactionReq) {
-  assert.timeout(1000);
+  assert.timeout(3000);
   var done = assert.async();
 
   function callback(err, res) {
@@ -157,4 +157,35 @@ QUnit.test("RecommendItemSegmentsToItemSegment test", function( assert ) {
 
 QUnit.test("SearchItemSegments test", function( assert ) {
     testRecommendations(assert, new recombee.SearchItemSegments('user-1', 'computer', 5, {scenario: 's-is'}));
+});
+
+
+QUnit.test("Batch test", function( assert ) {
+  const req = new recombee.Batch([new recombee.AddBookmark('user-1', 'item-1'),
+                                  new recombee.AddCartAddition('user-1', 'item-1'),
+                                  new recombee.AddPurchase('user-1', 'item-1'),
+                                  new recombee.AddRating('user-1', 'item-1', -1),
+                                  new recombee.RecommendItemsToUser('user-1', 5),
+                                  new recombee.RecommendItemsToItem('item-1', 'user-1', 5),
+                                  new recombee.SearchItems('user-1', 'computer', 5),
+                                  new recombee.RecommendItemSegmentsToUser('user-1', 5, {scenario: 'is-to-u'}),
+                                  new recombee.RecommendItemSegmentsToItem('item-1', 'user-1', 5, {scenario: 'is-to-i'}),
+                                  new recombee.RecommendItemSegmentsToItemSegment('5', 'user-1', 5, {scenario: 'is-to-is'}),
+                                  new recombee.SearchItemSegments('user-1', 'computer', 5, {scenario: 's-is'})
+                                  ]);
+
+  assert.timeout(10000);
+  var done = assert.async();
+
+  var client = createClient();
+  client.send(req)
+  .then(function(res) {
+    res.forEach(requestRes => assert.ok(200 <= requestRes.code && requestRes.code <= 299));
+    done();
+  })
+  .catch(function(err) {
+    assert.ok( false, "Sending Batch should not throw" );
+    done();
+  })
+
 });