feat: add custom http client possibility (#73)

Author: peterdeme

.phan/config.php

@@ -16,7 +16,7 @@
     // that functions removed in php 7.0 exist.
     // (See `backward_compatibility_checks` for additional options)
     // TODO: Set this.
-    'target_php_version' => null,
+    'minimum_target_php_version' => '7.3',
 
     'plugins' => [
         'AlwaysReturnPlugin',

lib/GetStream/StreamChat/Client.php

@@ -35,26 +35,11 @@ class Client
      */
     protected $apiSecret;
 
-    /**
-     * @var string
-     */
-    protected $location;
-
     /**
      * @var string
      */
     protected $authToken;
 
-    /**
-     * @var string
-     */
-    public $apiVersion;
-
-    /**
-     * @var float
-     */
-    public $timeout;
-
     /**
      * @var array
      */
@@ -66,19 +51,25 @@ class Client
     protected $httpRequestHeaders = [];
 
     /**
-     * @var HandlerStack
+     * @var GuzzleClient
      */
-    private $handler;
+    private $client;
 
     /**
      * @param string $apiKey
      * @param string $apiSecret
-     * @param string $apiVersion
-     * @param string $location
+     * @param string $apiVersion @deprecated will be removed in the next version
+     * @param string $location @deprecated will be removed in the next version
      * @param float $timeout
      */
-    public function __construct($apiKey, $apiSecret, $apiVersion='v1.0', $location='us-east', $timeout=null)
+    public function __construct($apiKey, $apiSecret, $apiVersion=null, $location=null, $timeout=null)
     {
+        if ($apiVersion !== null || $location !== null) {
+            $warn = "\$apiVersion and \$location parameters are deprecated and will be removed in a future version. ";
+            $warn .= "Please provide null to suppress this warning.";
+            trigger_error($warn, E_USER_NOTICE);
+        }
+
         $this->apiKey = $apiKey ?? getenv("STREAM_KEY");
         $this->apiSecret = $apiSecret ?? getenv("STREAM_SECRET");
 
@@ -87,17 +78,20 @@ public function __construct($apiKey, $apiSecret, $apiVersion='v1.0', $location='
         }
 
         if ($timeout != null) {
-            $this->timeout = $timeout;
+            $timeout = $timeout;
         } elseif (getenv("STREAM_CHAT_TIMEOUT")) {
-            $this->timeout = floatval(getenv("STREAM_CHAT_TIMEOUT"));
+            $timeout = floatval(getenv("STREAM_CHAT_TIMEOUT"));
         } else {
-            $this->timeout = 3.0;
+            $timeout = 3.0;
         }
 
-        $this->apiVersion = $apiVersion;
-        $this->location = $location;
         $this->authToken = JWT::encode(["server"=>"true"], $this->apiSecret, 'HS256');
-        $this->handler = HandlerStack::create();
+        $this->client = new GuzzleClient([
+            'base_uri' => $this->getBaseUrl(),
+            'timeout' => $timeout,
+            'handler' => HandlerStack::create(),
+            'headers' => ['Accept-Encoding' => 'gzip'],
+        ]);
     }
 
     /** Sets the location for the URL. Deprecated, and will be removed in a future version.
@@ -144,17 +138,12 @@ public function buildRequestUrl($uri)
         return "{$baseUrl}/{$uri}";
     }
 
-    /**
-     * @return \GuzzleHttp\Client
+    /** Sets the underlying HTTP client. Make sure you set a base_uri.
+     * @param \GuzzleHttp\Client $client
      */
-    public function getHttpClient()
+    public function setHttpClient($client)
     {
-        return new GuzzleClient([
-            'base_uri' => $this->getBaseUrl(),
-            'timeout' => $this->timeout,
-            'handler' => $this->handler,
-            'headers' => ['Accept-Encoding' => 'gzip'],
-        ]);
+        $this->client = $client;
     }
 
     /** Sets a Guzzle HTTP option that add to the request. See `\GuzzleHttp\RequestOptions`.
@@ -193,7 +182,6 @@ protected function getHttpRequestHeaders()
     public function makeHttpRequest($uri, $method, $data = [], $queryParams = [], $multipart = [])
     {
         $queryParams['api_key'] = $this->apiKey;
-        $client = $this->getHttpClient();
         $headers = $this->getHttpRequestHeaders();
 
         $uri = (new Uri($this->buildRequestUrl($uri)))
@@ -214,7 +202,7 @@ public function makeHttpRequest($uri, $method, $data = [], $queryParams = [], $m
         $options['headers'] = $headers;
 
         try {
-            $response = $client->request($method, $uri, $options);
+            $response = $this->client->request($method, $uri, $options);
         } catch (ClientException $e) {
             $response = $e->getResponse();
             $msg = $response->getBody()->getContents();

tests/integration/IntegrationTest.php

@@ -15,12 +15,7 @@ class IntegrationTest extends TestCase
 
     protected function setUp():void
     {
-        $this->client = new Client(
-            getenv('STREAM_KEY'),
-            getenv('STREAM_SECRET'),
-            'v1.0',
-            getenv('STREAM_REGION')
-        );
+        $this->client = new Client(getenv('STREAM_KEY'), getenv('STREAM_SECRET'));
         $this->client->timeout = 10000;
     }
 
@@ -29,6 +24,22 @@ private function generateGuid()
         return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex(random_bytes(16)), 4));
     }
 
+    public function testHttpClientSet()
+    {
+        $client = new Client(getenv('STREAM_KEY'), getenv('STREAM_SECRET'));
+
+        $client->setHttpClient(new \GuzzleHttp\Client(['base_uri' => 'https://getstream.io']));
+        try {
+            $response = $this->client->getAppSettings();
+            $this->fail("Expected to throw exception");
+        } catch (\Exception $e) {
+        }
+
+        $client->setHttpClient(new \GuzzleHttp\Client(['base_uri' => 'https://chat.stream-io-api.com']));
+        $response = $this->client->getAppSettings();
+        $this->assertTrue(array_key_exists("app", (array)$response));
+    }
+
     public function testStreamResponse()
     {
         $response = $this->client->getAppSettings();
@@ -1026,7 +1037,7 @@ public function testChannelSendAndDeleteFile()
 
     public function testChannelSendAndDeleteImage()
     {
-        $url = "https://www.wikipedia.org/portal/wikipedia.org/assets/img/Wikipedia-logo-v2.png";
+        $url = "https://getstream.io/images/icons/favicon-32x32.png";
         $user = $this->getUser();
         $channel = $this->getChannel();
         $resp = $channel->sendImage($url, "logo.png", $user);