Added cascadeCreate parameter to merge users request

OndraFiedler · OndraFiedler · commit 5f025e0e1601 · 2016-08-23T15:37:54.000+02:00
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ or
 ```
 {
     "require": {
-        "recombee/php-api-client": ">=1.2"
+        "recombee/php-api-client": ">=1.2.3"
     }
 }
 ```
@@ -75,7 +75,7 @@ try
     $recommended = $client->send(new Reqs\UserBasedRecommendation('user-25', 5, ['rotationRate' => 0]));
     echo 'Recommended items: ' . implode(',',$recommended) . "\n";
 }
-catch(Ex\ApiTimeoutException $e)
+catch(Ex\ApiException $e)
 {
     //use fallback
 }
@@ -192,4 +192,4 @@ catch(Ex\ApiException $e)
 {
     //ApiException is parent of both ResponseException and ApiTimeoutException
 }
-```
+```
diff --git a/src/RecommApi/Requests/ItemBasedRecommendation.php b/src/RecommApi/Requests/ItemBasedRecommendation.php
@@ -74,7 +74,7 @@ class ItemBasedRecommendation extends Request {
      */
     protected $return_properties;
     /**
-     * @var string $included_properties Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+     * @var array $included_properties Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
      * Example response for `includedProperties=description,price`:
      * ```
      *   [
@@ -163,7 +163,7 @@ class ItemBasedRecommendation extends Request {
      *   ]
      * ```
      *     - *includedProperties*
-     *         - Type: string
+     *         - Type: array
      *         - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
      * Example response for `includedProperties=description,price`:
      * ```
diff --git a/src/RecommApi/Requests/MergeUsers.php b/src/RecommApi/Requests/MergeUsers.php
@@ -24,9 +24,13 @@ class MergeUsers extends Request {
      */
     protected $source_user_id;
     /**
-     * @var string $keep_source_user If true, the source user will not be deleted, but also kept in the database..
+     * @var string $keep_source_user If true, the source user will not be deleted, but also kept in the database.
      */
     protected $keep_source_user;
+    /**
+     * @var bool $cascade_create Sets whether the user *targetUserId* should be created if not present in the database.
+     */
+    protected $cascade_create;
     /**
      * @var array Array containing values of optional parameters
      */
@@ -40,16 +44,20 @@ class MergeUsers extends Request {
      * - Allowed parameters:
      *     - *keepSourceUser*
      *         - Type: string
-     *         - Description: If true, the source user will not be deleted, but also kept in the database..
+     *         - Description: If true, the source user will not be deleted, but also kept in the database.
+     *     - *cascadeCreate*
+     *         - Type: bool
+     *         - Description: Sets whether the user *targetUserId* should be created if not present in the database.
      * @throws Exceptions\UnknownOptionalParameterException UnknownOptionalParameterException if an unknown optional parameter is given in $optional
      */
     public function __construct($target_user_id, $source_user_id, $optional = array()) {
         $this->target_user_id = $target_user_id;
         $this->source_user_id = $source_user_id;
         $this->keep_source_user = isset($optional['keepSourceUser']) ? $optional['keepSourceUser'] : null;
+        $this->cascade_create = isset($optional['cascadeCreate']) ? $optional['cascadeCreate'] : null;
         $this->optional = $optional;
 
-        $existing_optional = array('keepSourceUser');
+        $existing_optional = array('keepSourceUser','cascadeCreate');
         foreach ($this->optional as $key => $value) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
@@ -82,6 +90,8 @@ public function getQueryParameters() {
         $params = array();
         if (isset($this->optional['keepSourceUser']))
             $params['keepSourceUser'] = $this->optional['keepSourceUser'];
+        if (isset($this->optional['cascadeCreate']))
+            $params['cascadeCreate'] = $this->optional['cascadeCreate'];
         return $params;
     }
 
diff --git a/src/RecommApi/Requests/UserBasedRecommendation.php b/src/RecommApi/Requests/UserBasedRecommendation.php
@@ -66,7 +66,7 @@ class UserBasedRecommendation extends Request {
      */
     protected $return_properties;
     /**
-     * @var string $included_properties Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+     * @var array $included_properties Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
      * Example response for `includedProperties=description,price`:
      * ```
      *   [
@@ -149,7 +149,7 @@ class UserBasedRecommendation extends Request {
      *   ]
      * ```
      *     - *includedProperties*
-     *         - Type: string
+     *         - Type: array
      *         - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
      * Example response for `includedProperties=description,price`:
      * ```
diff --git a/tests/AddEntityTestCase.php b/tests/AddEntityTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class AddEntityTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($entity_id);
+    abstract protected function createRequest($item_id);
 
     public function testAddEntity() {
 
diff --git a/tests/AddInteractionTestCase.php b/tests/AddInteractionTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class AddInteractionTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($user_id,$item_id,$optional);
+    abstract protected function createRequest($user_id,$item_id,$optional=array());
 
     public function testAddInteraction() {
 
diff --git a/tests/AddPropertyTestCase.php b/tests/AddPropertyTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class AddPropertyTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($name,$type);
+    abstract protected function createRequest($property_name,$type);
 
     public function testAddProperty() {
 
diff --git a/tests/AddRatingTestCase.php b/tests/AddRatingTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class AddRatingTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($user_id,$item_id,$rating,$optional);
+    abstract protected function createRequest($user_id,$item_id,$rating,$optional=array());
 
     public function testAddRating() {
 
diff --git a/tests/DeleteEntityTestCase.php b/tests/DeleteEntityTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class DeleteEntityTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($entity_id);
+    abstract protected function createRequest($item_id);
 
     public function testDeleteEntity() {
 
diff --git a/tests/DeleteInteractionTestCase.php b/tests/DeleteInteractionTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class DeleteInteractionTestCase extends InteractionsTestCase {
 
-    abstract protected function createRequest($user_id,$item_id,$optional);
+    abstract protected function createRequest($user_id,$item_id,$optional=array());
 
     public function testDeleteInteraction() {
 
diff --git a/tests/DeletePropertyTestCase.php b/tests/DeletePropertyTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class DeletePropertyTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($name);
+    abstract protected function createRequest($property_name);
 
     public function testDeleteProperty() {
 
diff --git a/tests/GetPropertyInfoTestCase.php b/tests/GetPropertyInfoTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class GetPropertyInfoTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($name);
+    abstract protected function createRequest($property_name);
 
     public function testGetPropertyInfo() {
 
diff --git a/tests/GetValuesTestCase.php b/tests/GetValuesTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class GetValuesTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($entity_id);
+    abstract protected function createRequest($item_id);
 
     public function testGetValues() {
 
diff --git a/tests/InsertToGroupTestCase.php b/tests/InsertToGroupTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class InsertToGroupTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($set_id,$type,$entity_id,$optional);
+    abstract protected function createRequest($group_id,$item_type,$item_id,$optional=array());
 
     public function testInsertToGroup() {
 
diff --git a/tests/InsertToSeriesTestCase.php b/tests/InsertToSeriesTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class InsertToSeriesTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($set_id,$type,$entity_id,$time,$optional);
+    abstract protected function createRequest($series_id,$item_type,$item_id,$time,$optional=array());
 
     public function testInsertToSeries() {
 
diff --git a/tests/ListItemInteractionsTestCase.php b/tests/ListItemInteractionsTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class ListItemInteractionsTestCase extends InteractionsTestCase {
 
-    abstract protected function createRequest($entity_id);
+    abstract protected function createRequest($item_id);
 
     public function testListItemInteractions() {
 
diff --git a/tests/ListSetItemsTestCase.php b/tests/ListSetItemsTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class ListSetItemsTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($entity_id);
+    abstract protected function createRequest($series_id);
 
     public function testListSetItems() {
 
diff --git a/tests/ListUserInteractionsTestCase.php b/tests/ListUserInteractionsTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class ListUserInteractionsTestCase extends InteractionsTestCase {
 
-    abstract protected function createRequest($entity_id);
+    abstract protected function createRequest($user_id);
 
     public function testListUserInteractions() {
 
diff --git a/tests/MergeUsersTestCase.php b/tests/MergeUsersTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class MergeUsersTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($target,$source,$optional);
+    abstract protected function createRequest($target_user_id,$source_user_id,$optional=array());
 
     public function testMergeUsers() {
 
diff --git a/tests/RecommendationTestCase.php b/tests/RecommendationTestCase.php
@@ -75,7 +75,6 @@ public function testInBatch() {
     public function testReturningProperties() {
         $req = $this->createRequest('entity_id', 9, ['returnProperties' => true, 'includedProperties'=>['answer', 'id2', 'empty']]);
         $recommended = $this->client->send($req);
-        var_dump($recommended);
         foreach ($recommended as $rec) {
             $this->assertEquals($rec['id2'], $rec['itemId']);
             $this->assertEquals(42, $rec['answer']);
@@ -84,7 +83,6 @@ public function testReturningProperties() {
 
         $req = $this->createRequest('entity_id', 9, ['returnProperties' => true, 'includedProperties'=>'answer,id2']);
         $recommended = $this->client->send($req);
-        var_dump($recommended);
         foreach ($recommended as $rec) {
             $this->assertEquals($rec['id2'], $rec['itemId']);
             $this->assertEquals(42, $rec['answer']);
diff --git a/tests/RemoveFromGroupTestCase.php b/tests/RemoveFromGroupTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class RemoveFromGroupTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($set_id,$type,$entity_id);
+    abstract protected function createRequest($group_id,$item_type,$item_id);
 
     public function testRemoveFromGroup() {
 
diff --git a/tests/RemoveFromSeriesTestCase.php b/tests/RemoveFromSeriesTestCase.php
@@ -10,7 +10,7 @@
 
 abstract class RemoveFromSeriesTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($set_id,$type,$entity_id,$time);
+    abstract protected function createRequest($series_id,$item_type,$item_id,$time);
 
     public function testRemoveFromSeries() {
 
diff --git a/tests/SetValuesTestCase.php b/tests/SetValuesTestCase.php
@@ -10,14 +10,18 @@
 
 abstract class SetValuesTestCase extends RecombeeTestCase {
 
-    abstract protected function createRequest($entity_id,$values);
+    abstract protected function createRequest($item_id,$values);
 
     public function testSetValues() {
 
          //it does not fail with existing entity and property
          $req = $this->createRequest('entity_id',['int_property' => 5]);
          $resp = $this->client->send($req);
 
+         //it does not fail with non-ASCII string
+         $req = $this->createRequest('entity_id',['str_property' => 'šřžذ的‎']);
+         $resp = $this->client->send($req);
+
          //it sets multiple properties
          $req = $this->createRequest('entity_id',['int_property' => 5,'str_property' => 'test']);
          $resp = $this->client->send($req);

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ or`
`17`	`17`	```
`18`	`18`	`{`
`19`	`19`	`"require": {`
`20`		`- "recombee/php-api-client": ">=1.2"`
	`20`	`+ "recombee/php-api-client": ">=1.2.3"`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	```
`@@ -75,7 +75,7 @@ try`
`75`	`75`	`$recommended = $client->send(new Reqs\UserBasedRecommendation('user-25', 5, ['rotationRate' => 0]));`
`76`	`76`	`echo 'Recommended items: ' . implode(',',$recommended) . "\n";`
`77`	`77`	`}`
`78`		`-catch(Ex\ApiTimeoutException $e)`
	`78`	`+catch(Ex\ApiException $e)`
`79`	`79`	`{`
`80`	`80`	`//use fallback`
`81`	`81`	`}`
`@@ -192,4 +192,4 @@ catch(Ex\ApiException $e)`
`192`	`192`	`{`
`193`	`193`	`//ApiException is parent of both ResponseException and ApiTimeoutException`
`194`	`194`	`}`
`195`		-```
	`195`	+```