Added distinctRecomms parameter to batch request

Author: OndraFiedler

README.md

@@ -17,7 +17,7 @@ or
 ```
 {
     "require": {
-        "recombee/php-api-client": ">=1.2.3"
+        "recombee/php-api-client": ">=1.2.4"
     }
 }
 ```

src/RecommApi/Requests/Batch.php

@@ -10,7 +10,7 @@
 use Recombee\RecommApi\Util\Util;
 
 /**
- * In many cases, it may be desirable to execute multiple requests at once. By example, when synchronizing the catalog of items in 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 a 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 problems mentioned, batch processing may be used, encapsulating a sequence of requests into a single HTTP request.
+ * 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 a 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 problems mentioned, batch processing may be used, encapsulating a sequence of requests into a single HTTP request.
  * Batch processing allows you to submit arbitrary sequence of requests in form of JSON array. Any type of request from the above documentation may be used in the batch, and the batch may combine different types of requests arbitrarily as well.
  * Note that:
  * - executing the requests in a batch is equivalent as if they were executed one-by-one individually; there are, however, many optimizations to make batch execution as fast as possible,
@@ -21,16 +21,30 @@
 class Batch extends Request {
 
     /**
-     * @var Requst[] Requests contained in the batch
+     * @var Request[] Requests contained in the batch
      */ 
     public $requests;
 
     /**
      * Construct the Batch request
      * @param Request[] $requests Array of Requests.
+     * @param array $optional Optional parameters given as an array containing pairs name of the parameter => value
+     * - Allowed parameters:
+     *     - *distinctRecomms*
+     *         - Type: bool
+     *         - Description: Makes all the recommended items for a certain user distinct among multiple recommendation requests in the batch.
+     * @throws Exceptions\UnknownOptionalParameterException UnknownOptionalParameterException if an unknown optional parameter is given in $optional
      */
-    public function __construct($requests) {
+    public function __construct($requests, $optional=array()) {
         $this->requests = $requests;
+        $this->optional = $optional;
+
+        $existing_optional = array('distinctRecomms');
+        foreach ($this->optional as $key => $value) {
+            if (!in_array($key, $existing_optional))
+                 throw new UnknownOptionalParameterException($key);
+         }
+
         $this->timeout = null;
         $this->ensure_https = true;
     }
@@ -84,7 +98,13 @@ public function getBodyParameters() {
         foreach ($this->requests as $r) {
             array_push($reqs, $this->requestToBatchArray($r));
         }
-        return ['requests' => $reqs];
+
+        $result = ['requests' => $reqs];
+
+        if(isset($this->optional['distinctRecomms']))
+            $result['distinctRecomms'] = $this->optional['distinctRecomms'];
+
+        return $result;
     }
 
     protected function requestToBatchArray($req) {

src/RecommApi/Requests/ListGroups.php

@@ -19,7 +19,7 @@ class ListGroups extends Request {
      * Construct the request
      */
     public function __construct() {
-        $this->timeout = 1000;
+        $this->timeout = 30000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/ListItems.php

@@ -41,7 +41,7 @@ public function __construct($optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 30000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/ListSeries.php

@@ -19,7 +19,7 @@ class ListSeries extends Request {
      * Construct the request
      */
     public function __construct() {
-        $this->timeout = 1000;
+        $this->timeout = 30000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/ListUsers.php

@@ -19,7 +19,7 @@ class ListUsers extends Request {
      * Construct the request
      */
     public function __construct() {
-        $this->timeout = 1000;
+        $this->timeout = 30000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/MergeUsers.php

@@ -11,7 +11,7 @@
 
 /**
  * Merges purchases, ratings, bookmarks, and detail views of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
- * Merging happens between two users referred to as the *source* and the *target*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted** unless special parameter `keepSourceUser` is set `true`.
+ * Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted** unless special parameter `keepSourceUser` is set `true`.
  */
 class MergeUsers extends Request {
 

tests/AddInteractionTestCase.php

@@ -27,6 +27,18 @@ public function testAddInteraction() {
          $resp = $this->client->send($req);
 
          //it fails with nonexisting item id
+         $req = $this->createRequest('entity_id','nonex_id');
+         try {
+
+             $this->client->send($req);
+             throw new \Exception('Exception was not thrown');
+         }
+         catch(Exc\ResponseException $e)
+         {
+            $this->assertEquals(404, $e->status_code);
+         }
+
+         //it fails with nonexisting user id
          $req = $this->createRequest('nonex_id','entity_id');
          try {
 

tests/BatchTest.php

@@ -32,7 +32,7 @@ public function testBatch() {
                                                                         'allowNonexistent' => true])
                 ];
 
-        $repl = $this->client->send(new Reqs\Batch($reqs));
+        $repl = $this->client->send(new Reqs\Batch($reqs, ['distinctRecomms' => true]));
 
         $codes = array();
         foreach ($repl as $r) {