Skip to content

Feat: support base URL #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lohanidamodar wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Feat: support base URL #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5702098
Feat: support base URL
lohanidamodar Nov 17, 2025
330fabd
Format
lohanidamodar Nov 17, 2025
4221e07
Fix suggestions
lohanidamodar Dec 1, 2025
9ed8075
Fixes and add test for base url
lohanidamodar Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,19 @@ class Client
private array $retryStatusCodes = [500, 503];
private mixed $jsonEncodeFlags;

protected string $baseUrl = '';
Copy link
Contributor

@Meldiron Meldiron Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update tests to try and set base URL


public function setBaseUrl(string $baseUrl): self
{
$this->baseUrl = $baseUrl;
return $this;
}

public function getBaseUrl(): string
{
return $this->baseUrl;
}

/**
* @param string $key
* @param string $value
Expand Down Expand Up @@ -127,7 +140,7 @@ public function setMaxRetries(int $maxRetries): self
*
* @param array<int> $flags
* @return self
*/
*/
public function setJsonEncodeFlags(array $flags): self
{
$this->jsonEncodeFlags = implode('|', $flags);
Expand Down Expand Up @@ -248,6 +261,10 @@ public function fetch(
?int $timeoutMs = null,
?int $connectTimeoutMs = null,
): Response {
if (!empty($this->baseUrl) && !preg_match('~^https?://~i', $url)) {
$url = rtrim($this->baseUrl, '/') . '/' . ltrim($url, '/');
}

if (!in_array($method, [self::METHOD_PATCH, self::METHOD_GET, self::METHOD_CONNECT, self::METHOD_DELETE, self::METHOD_POST, self::METHOD_HEAD, self::METHOD_OPTIONS, self::METHOD_PUT, self::METHOD_TRACE])) {
throw new Exception("Unsupported HTTP method");
}
Expand Down
135 changes: 135 additions & 0 deletions tests/ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,141 @@ public function testSetGetUserAgent(): void
$this->assertEquals($userAgent, $client->getUserAgent());
}

/**
* Test setting and getting the base URL.
* @return void
*/
public function testSetGetBaseUrl(): void
{
$client = new Client();
$baseUrl = "http://localhost:8000";

$client->setBaseUrl($baseUrl);

$this->assertEquals($baseUrl, $client->getBaseUrl());
}

/**
* Test base URL prepending to relative URLs.
* @return void
*/
public function testBaseUrlWithRelativePath(): void
{
$client = new Client();
$client->setBaseUrl('http://localhost:8000');

$resp = $client->fetch(
url: '',
method: Client::METHOD_GET
);

if ($resp->getStatusCode() === 200) {
$respData = $resp->json();
$this->assertEquals($respData['method'], Client::METHOD_GET);
$this->assertEquals($respData['url'], 'localhost:8000');
} else {
echo "Please configure your PHP inbuilt SERVER";
}
}

/**
* Test base URL with path appending.
* @return void
*/
public function testBaseUrlWithPath(): void
{
$client = new Client();
$client->setBaseUrl('http://localhost:8000');

$resp = $client->fetch(
url: 'redirect',
method: Client::METHOD_GET
);

if ($resp->getStatusCode() === 200) {
$respData = $resp->json();
$this->assertEquals($respData['page'], "redirectedPage");
} else {
echo "Please configure your PHP inbuilt SERVER";
}
}

/**
* Test base URL doesn't interfere with absolute URLs.
* @return void
*/
public function testBaseUrlWithAbsoluteUrl(): void
{
$client = new Client();
$client->setBaseUrl('http://example.com');

$resp = $client->fetch(
url: 'http://localhost:8000',
method: Client::METHOD_GET
);

if ($resp->getStatusCode() === 200) {
$respData = $resp->json();
$this->assertEquals($respData['method'], Client::METHOD_GET);
$this->assertEquals($respData['url'], 'localhost:8000');
} else {
echo "Please configure your PHP inbuilt SERVER";
}
}

/**
* Test base URL with query parameters.
* @return void
*/
public function testBaseUrlWithQuery(): void
{
$client = new Client();
$client->setBaseUrl('http://localhost:8000');

$resp = $client->fetch(
url: '',
method: Client::METHOD_GET,
query: [
'name' => 'John Doe',
'age' => '30',
]
);

if ($resp->getStatusCode() === 200) {
$respData = $resp->json();
$this->assertEquals($respData['method'], Client::METHOD_GET);
$this->assertEquals(
json_encode($respData['query']),
json_encode(['name' => 'John Doe', 'age' => '30'])
);
} else {
echo "Please configure your PHP inbuilt SERVER";
}
}

/**
* Test base URL with trailing slash normalization.
* @return void
*/
public function testBaseUrlTrailingSlashNormalization(): void
{
$client = new Client();

// Test with trailing slash in base URL
$client->setBaseUrl('http://localhost:8000/');
$resp = $client->fetch(
url: '/redirect',
method: Client::METHOD_GET
);

if ($resp->getStatusCode() === 200) {
$respData = $resp->json();
$this->assertEquals($respData['page'], "redirectedPage");
} else {
echo "Please configure your PHP inbuilt SERVER";
}
}

/**
* Data provider for testFetch
* @return array<string, array<mixed>>
Expand Down