add support for GetRateLimits (#38)

Author: ruggi

lib/GetStream/StreamChat/Client.php

@@ -752,6 +752,27 @@ public function getDevices($userId)
         return $this->get("devices", $data);
     }
 
+    public function getRateLimits($serverSide=false, $android=false, $ios=false, $web=false, $endpoints=null)
+    {
+        $data = [];
+        if ($serverSide) {
+            $data["server_side"] = "true";
+        }
+        if ($android) {
+            $data["android"] = "true";
+        }
+        if ($ios) {
+            $data["ios"] = "true";
+        }
+        if ($web) {
+            $data["web"] = "true";
+        }
+        if ($endpoints !== null && is_array($endpoints)) {
+            $data["endpoints"] = implode(",", $endpoints);
+        }
+        return $this->get("rate_limits", $data);
+    }
+
    /**
      * @param  array $userId
      * @return mixed

tests/integration/IntegrationTest.php

@@ -371,6 +371,29 @@ public function testDevices()
         $this->assertSame(count($response["devices"]), 1);
     }
 
+    public function testGetRateLimits()
+    {
+        $response = $this->client->getRateLimits();
+        $this->assertTrue(array_key_exists("server_side", $response));
+        $this->assertTrue(array_key_exists("android", $response));
+        $this->assertTrue(array_key_exists("ios", $response));
+        $this->assertTrue(array_key_exists("web", $response));
+        $response = $this->client->getRateLimits(true);
+        $this->assertTrue(array_key_exists("server_side", $response));
+        $this->assertFalse(array_key_exists("android", $response));
+        $this->assertFalse(array_key_exists("ios", $response));
+        $this->assertFalse(array_key_exists("web", $response));
+        $response = $this->client->getRateLimits(true, true, false, false, array("GetRateLimits", "SendMessage"));
+        $this->assertTrue(array_key_exists("server_side", $response));
+        $this->assertTrue(array_key_exists("android", $response));
+        $this->assertFalse(array_key_exists("ios", $response));
+        $this->assertFalse(array_key_exists("web", $response));
+        $this->assertSame(count($response["android"]), 2);
+        $this->assertSame(count($response["server_side"]), 2);
+        $this->assertSame($response["android"]["GetRateLimits"]["Limit"], $response["android"]["GetRateLimits"]["Remaining"]);
+        $this->assertTrue($response["server_side"]["GetRateLimits"]["Limit"] > $response["server_side"]["GetRateLimits"]["Remaining"]);
+    }
+
     public function testChannelBanUser()
     {
         $user = $this->getUser();