feat(guzzle): add custom http middleware possibility (#112)

GetStream · May 27, 2022 · 6960b3f · 6960b3f
1 parent 971f6a6
commit 6960b3f
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -64,6 +64,14 @@ $client = new GetStream\Stream\Client('YOUR_API_KEY', 'YOUR_API_SECRET');
 
 // Instantiate a feed object
 $userFeed = $client->feed('user', '1');
+
+// If you want, you can set a custom http handler
+$handler = new \GuzzleHttp\HandlerStack();
+$stack->push(Middleware::mapRequest(function (RequestInterface $r) {
+    echo 'Sending request to Stream Feeds API: ' . $r->getUri() . PHP_EOL;
+    return $r;
+}));
+$client->setCustomHttpHandler($handler);
 ```
 
 By default, the Client will target the GetStream REST API at `stream-io-api.com/api`.

diff --git a/lib/GetStream/Stream/BaseFeed.php b/lib/GetStream/Stream/BaseFeed.php
@@ -380,7 +380,11 @@ public function getHandlerStack()
      */
     public function getHttpClient()
     {
-        $handler = $this->getHandlerStack();
+        $handler = $this->client->getCustomHttpHandlerStack();
+        if (!$handler) {
+            $handler = $this->getHandlerStack();
+        }
+
         return new GuzzleClient([
             'base_uri' => $this->client->getBaseUrl(),
             'timeout' => $this->client->timeout,

diff --git a/lib/GetStream/Stream/Client.php b/lib/GetStream/Stream/Client.php
@@ -3,6 +3,7 @@
 
 use DateTime;
 use Exception;
+use GuzzleHttp\HandlerStack;
 
 class Client implements ClientInterface
 {
@@ -43,6 +44,11 @@ class Client implements ClientInterface
      */
     public $timeout;
 
+    /**
+     * @var HandlerStack|null
+     */
+    public $customHttpHandler;
+
     /**
      * @param string $api_key
      * @param string $api_secret
@@ -61,6 +67,23 @@ public function __construct($api_key, $api_secret, $api_version='v1.0', $locatio
         $this->protocol = 'https';
     }
 
+    /**
+     * @param HandlerStack $handler
+     * @return void
+     */
+    public function setCustomHttpHandler($handler)
+    {
+        $this->customHttpHandler = $handler;
+    }
+
+    /**
+     * @return HandlerStack|null
+     */
+    public function getCustomHttpHandlerStack()
+    {
+        return $this->customHttpHandler;
+    }
+
     /**
      * @param  string|null $url
      * @return Client

diff --git a/lib/GetStream/Stream/ClientInterface.php b/lib/GetStream/Stream/ClientInterface.php
@@ -2,6 +2,8 @@
 
 namespace GetStream\Stream;
 
+use GuzzleHttp\HandlerStack;
+
 /**
  * @property string $timeout
  * @property string $api_version
@@ -18,6 +20,11 @@ public function setProtocol($protocol);
      */
     public function setLocation($location);
 
+    /**
+     * @return HandlerStack|null
+     */
+    public function getCustomHttpHandlerStack();
+
     /**
      * @param string $user_id
      * @param ?array $extra_data

diff --git a/lib/GetStream/Stream/Collections.php b/lib/GetStream/Stream/Collections.php
@@ -34,7 +34,7 @@ public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
         $this->client = new GuzzleClient([
             'base_uri' => $streamClient->getBaseUrl().'/'.$streamClient->api_version.'/',
             'timeout' => $streamClient->timeout,
-            'handler' => Util::handlerStack($apiKey, $apiSecret, 'collections'),
+            'handler' => Util::handlerStack($streamClient, $apiKey, $apiSecret, 'collections'),
         ]);
     }
 

diff --git a/lib/GetStream/Stream/Personalization.php b/lib/GetStream/Stream/Personalization.php
@@ -36,7 +36,7 @@ public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
         $this->client = new GuzzleClient([
             'base_uri' => self::API_ENDPOINT,
             'timeout' => $streamClient->timeout,
-            'handler' => Util::handlerStack($apiKey, $apiSecret, 'personalization'),
+            'handler' => Util::handlerStack($streamClient, $apiKey, $apiSecret, 'personalization'),
         ]);
     }
 

diff --git a/lib/GetStream/Stream/Reactions.php b/lib/GetStream/Stream/Reactions.php
@@ -34,7 +34,7 @@ public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
         $this->client = new GuzzleClient([
             'base_uri' => $streamClient->getBaseUrl().'/'.$streamClient->api_version.'/',
             'timeout' => $streamClient->timeout,
-            'handler' => Util::handlerStack($apiKey, $apiSecret, 'reactions'),
+            'handler' => Util::handlerStack($streamClient, $apiKey, $apiSecret, 'reactions'),
         ]);
     }
 

diff --git a/lib/GetStream/Stream/Users.php b/lib/GetStream/Stream/Users.php
@@ -34,7 +34,7 @@ public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
         $this->client = new GuzzleClient([
             'base_uri' => $streamClient->getBaseUrl().'/'.$streamClient->api_version.'/',
             'timeout' => $streamClient->timeout,
-            'handler' => Util::handlerStack($apiKey, $apiSecret, 'users'),
+            'handler' => Util::handlerStack($streamClient, $apiKey, $apiSecret, 'users'),
         ]);
     }
 

diff --git a/lib/GetStream/Stream/Util.php b/lib/GetStream/Stream/Util.php
@@ -9,17 +9,26 @@
 class Util
 {
     /**
+     * @param ClientInterface $streamClient
+     * @param string $apiKey
+     * @param string $apiSecret
+     * @param string $resource
      * @return HandlerStack
      */
-    public static function handlerStack($apiKey, $apiSecret, $resource)
+    public static function handlerStack($streamClient, $apiKey, $apiSecret, $resource)
     {
         $token = JWT::encode([
             'action' => '*',
             'user_id' => '*',
             'feed_id' => '*',
             'resource' => $resource,
         ], $apiSecret, 'HS256');
-        $stack = HandlerStack::create();
+
+
+        $stack = $streamClient->getCustomHttpHandlerStack();
+        if (!$stack) {
+            $stack = HandlerStack::create();
+        }
         $stack->push(function (callable $handler) use ($token, $apiKey) {
             return function (RequestInterface $request, array $options) use ($handler, $token, $apiKey) {
                 // Add authentication headers.