deprecate updateUsers in favor upsertUsers (#64)

Author: Amin Mahboubi

README.md

@@ -81,13 +81,13 @@ $bob = [
     'name' => 'Robert Tables',
 ];
 
-$bob = $client->updateUser($bob);
+$bob = $client->upsertUser($bob);
 
 //batch update is also supported
 $jane = ['id' => 'jane', 'role' => 'admin'];
 $june = ['id' => 'june', 'role' => 'user'];
 $tom = ['id' => 'tom', 'role' => 'guest'];
-$users = $client->updateUsers([$jane, $june, $tom]);
+$users = $client->upsertUsers([$jane, $june, $tom]);
 ```
 
 ## ChannelType CRUD

lib/GetStream/StreamChat/Client.php

@@ -328,7 +328,7 @@ public function updateAppSettings($settings)
      * @return mixed
      * @throws StreamException
      */
-    public function updateUsers($users)
+    public function upsertUsers($users)
     {
         $user_array = [];
         foreach ($users as $user) {
@@ -342,9 +342,31 @@ public function updateUsers($users)
      * @return mixed
      * @throws StreamException
      */
+    public function upsertUser($user)
+    {
+        return $this->upsertUsers([$user]);
+    }
+
+    /**
+     * @deprecated use $client->upsertUsers instead
+     * @param  array $users
+     * @return mixed
+     * @throws StreamException
+     */
+    public function updateUsers($users)
+    {
+        return $this->upsertUsers($users);
+    }
+
+    /**
+     * @deprecated use $client->upsertUser instead
+     * @param  array $user
+     * @return mixed
+     * @throws StreamException
+     */
     public function updateUser($user)
     {
-        return $this->updateUsers([$user]);
+        return $this->upsertUsers([$user]);
     }
 
     /**

tests/integration/IntegrationTest.php

@@ -49,7 +49,7 @@ private function getUser()
     {
         // this creates a user on the server
         $user = ["id" => Uuid::uuid4()->toString()];
-        $response = $this->client->updateUser($user);
+        $response = $this->client->upsertUser($user);
         $this->assertTrue(array_key_exists("users", $response));
         $this->assertTrue(array_key_exists($user["id"], $response["users"]));
         return $user;
@@ -78,18 +78,18 @@ public function testUpdateAppSettings()
         $this->assertTrue(array_key_exists("duration", $response));
     }
 
-    public function testUpdateUser()
+    public function testUpsertUser()
     {
         $user = ["id" => Uuid::uuid4()->toString()];
-        $response = $this->client->updateUser($user);
+        $response = $this->client->upsertUser($user);
         $this->assertTrue(array_key_exists("users", $response));
         $this->assertTrue(array_key_exists($user["id"], $response["users"]));
     }
 
-    public function testUpdateUsers()
+    public function testUpsertUsers()
     {
         $user = ["id" => Uuid::uuid4()->toString()];
-        $response = $this->client->updateUsers([$user]);
+        $response = $this->client->upsertUsers([$user]);
         $this->assertTrue(array_key_exists("users", $response));
         $this->assertTrue(array_key_exists($user["id"], $response["users"]));
     }
@@ -122,7 +122,7 @@ public function testDeleteUsers()
     public function testDeleteChannels()
     {
         $user = ["id" => Uuid::uuid4()->toString()];
-        $response = $this->client->updateUser($user);
+        $response = $this->client->upsertUser($user);
 
         $c1 = $this->getChannel();
         $c2 = $this->getChannel();
@@ -186,7 +186,7 @@ public function createFellowship()
             ],
             ["id" => "peregrin-took", "name" => "Peregrin Took", "race" => "Hobbit", "age" => 28],
         ];
-        $this->client->updateUsers($members);
+        $this->client->upsertUsers($members);
         $user_ids = [];
         foreach ($members as $user) {
             $user_ids[] = $user['id'];
@@ -383,7 +383,7 @@ public function testQueryMembers()
     {
         $bob = ["id" => Uuid::uuid4()->toString(), "name" => "bob the builder"];
         $bobSponge = ["id" => Uuid::uuid4()->toString(), "name" => "bob the sponge"];
-        $this->client->updateUsers([$bob, $bobSponge]);
+        $this->client->upsertUsers([$bob, $bobSponge]);
         $channel = $this->client->Channel(
             "messaging",
             Uuid::uuid4()->toString(),
@@ -409,7 +409,7 @@ public function testQueryMembersMemberBasedChannel()
     {
         $bob = ["id" => Uuid::uuid4()->toString(), "name" => "bob the builder"];
         $bobSponge = ["id" => Uuid::uuid4()->toString(), "name" => "bob the sponge"];
-        $this->client->updateUsers([$bob, $bobSponge]);
+        $this->client->upsertUsers([$bob, $bobSponge]);
         $channel = $this->client->Channel(
             "messaging",
             null,
@@ -850,7 +850,7 @@ public function testChannelHideShow()
     public function testPartialUpdateUsers()
     {
         $carmen = ["id" => Uuid::uuid4()->toString(), "name" => "Carmen SanDiego", "hat" => "blue", "location" => "Here"];
-        $response = $this->client->updateUser($carmen);
+        $response = $this->client->upsertUser($carmen);
         $this->assertTrue(array_key_exists("users", $response));
         $this->assertTrue(array_key_exists($carmen["id"], $response["users"]));
         $this->assertSame($response["users"][$carmen["id"]]["hat"], "blue");
@@ -859,7 +859,7 @@ public function testPartialUpdateUsers()
         $this->assertSame($response["users"][0]["hat"], "red");
         $this->assertSame($response["users"][0]["location"], "Here");
         $wally = ["id" => Uuid::uuid4()->toString(), "name" => "Wally", "shirt" => "white", "location" => "There"];
-        $response = $this->client->updateUser($wally);
+        $response = $this->client->upsertUser($wally);
         $response = $this->client->partialUpdateUsers([
             ["id" => $carmen["id"], "set" => ["coat" => "red"], "unset" => ["location"]],
             ["id" => $wally["id"], "set" => ["shirt" => "striped"], "unset" => ["location"]],