feat: added buildPath helper method

Author: andrepimpao

src/Api.php

@@ -67,12 +67,10 @@ protected function request(
             throw new ConfigException('A base URL must be set.');
         }
 
-        // merge and overwrite query defaults
         if (!empty($this->queryDefaults)) {
             $query = array_merge($this->queryDefaults, $query);
         }
 
-        // merge and overwrite header defaults
         if (!empty($this->headerDefaults)) {
             $headers = array_merge($this->headerDefaults, $headers);
         }
@@ -123,7 +121,7 @@ protected function request(
             );
         }
 
-        $uri = $this->createUri($path, $query);
+        $uri = $this->buildUri($path, $query);
         $request = $this->createRequest($method, $uri, $headers, $body);
 
         $response = $this->clientBuilder->getClient()->sendRequest($request);
@@ -247,6 +245,30 @@ protected function addResponseHandler(callable $handler, int $priority = 0): sel
         return $this;
     }
 
+    protected function buildPath(string $path, array $parameters): string
+    {
+        foreach ($parameters as $parameter => $value) {
+            $path = \str_replace(
+                \sprintf('{%s}', $parameter),
+                $value,
+                $path
+            );
+        }
+
+        return $path;
+    }
+
+    private function buildUri(string $path, array $query = []): string
+    {
+        $uri = $this->reduceDuplicateSlashes($this->baseUrl . $path);
+
+        if (!empty($query)) {
+            $uri = \sprintf('%s?%s', $uri, \http_build_query($query));
+        }
+
+        return $uri;
+    }
+
     private function createRequest(
         string $method,
         string $uri,
@@ -268,15 +290,4 @@ private function createRequest(
 
         return $request;
     }
-
-    private function createUri(string $path, array $query = []): string
-    {
-        $uri = $this->reduceDuplicateSlashes($this->baseUrl . $path);
-
-        if (!empty($query)) {
-            $uri = \sprintf('%s?%s', $uri, \http_build_query($query));
-        }
-
-        return $uri;
-    }
 }

tests/Integration/ApiTest.php

@@ -102,6 +102,11 @@ public function addResponseHandler(callable $handler, int $priority = 0): Api
             {
                 return parent::addResponseHandler($handler, $priority);
             }
+
+            public function buildPath(string $path, array $parameters): string
+            {
+                return parent::buildPath($path, $parameters);
+            }
         };
 
         // set mock client
@@ -273,4 +278,14 @@ public function testResponseHandler()
 
         $this->assertIsArray($response);
     }
+
+    public function testBuildPath()
+    {
+        $path = $this->class->buildPath('/path/{parameter1}/multiple/{parameter2}', [
+            'parameter1' => 'with',
+            'parameter2' => 'parameters'
+        ]);
+
+        $this->assertSame('/path/with/multiple/parameters', $path);
+    }
 }