api: improve url build to better handle query parameters

Author: andrepimpao

composer.json

@@ -13,6 +13,7 @@
     ],
     "require": {
         "php": ">=8.1",
+        "nyholm/append-query-string": "^1.0",
         "php-http/cache-plugin": "^2.0",
         "php-http/client-common": "^2.7",
         "php-http/discovery": "^1.20",

src/Api.php

@@ -66,8 +66,8 @@ public function request(
             $headers = array_merge($this->headerDefaults, $headers);
         }
 
-        $uri = $this->buildUri($path, $query);
-        $request = $this->createRequest($method, $uri, $headers, $body);
+        $url = $this->buildUrl($path, $query);
+        $request = $this->createRequest($method, $url, $headers, $body);
 
         // pre request listener
         $request = $this->eventDispatcher->dispatch(new PreRequestEvent($request))->getRequest();
@@ -276,25 +276,26 @@ public function buildPath(string $path, array $parameters): string
         return $path;
     }
 
-    private function buildUri(string $path, array $query = []): string
+    private function buildUrl(string $path, array $query = []): string
     {
-        $uri = StringHelper::reduceDuplicateSlashes($this->baseUrl . $path);
+        $appendQuery = http_build_query($query);
 
-        if (!empty($query)) {
-            $uri = sprintf('%s?%s', $uri, http_build_query($query));
+        if (StringHelper::isUrl($path)) {
+            return append_query_string($path, $appendQuery, APPEND_QUERY_STRING_REPLACE_DUPLICATE);
         }
 
-        return $uri;
+        $url = StringHelper::reduceDuplicateSlashes($this->baseUrl . $path);
+        return append_query_string($url, $appendQuery, APPEND_QUERY_STRING_REPLACE_DUPLICATE);
     }
 
     private function createRequest(
         string $method,
-        string $uri,
+        string $url,
         array $headers = [],
         string|StreamInterface $body = null
     ): RequestInterface
     {
-        $request = $this->clientBuilder->getRequestFactory()->createRequest($method, $uri);
+        $request = $this->clientBuilder->getRequestFactory()->createRequest($method, $url);
 
         foreach ($headers as $key => $value) {
             $request = $request->withHeader($key, $value);

src/Helper/StringHelper.php

@@ -8,4 +8,9 @@ public static function reduceDuplicateSlashes(string $string): string
     {
         return preg_replace('#(^|[^:])//+#', '\\1/', $string);
     }
+
+    public static function isUrl(string $string): bool
+    {
+        return filter_var($string, FILTER_VALIDATE_URL) !== false;
+    }
 }