Skip to content

Add premium endpoint and token authentication support for Geonames provider #1261

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
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add premium endpoint and token authentication support for Geonames provider #1261

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
91c36b9
Add premium endpoint and token authentication support for Geonames pr…
web-flow Oct 17, 2025
9ac9f01
use consts properly, cleanup
AronNovak Oct 20, 2025
89b7fe6
test coverage
AronNovak Oct 20, 2025
4e1f258
initial test
AronNovak Oct 20, 2025
8de527b
Merge branch 'master' into feature/geonames-premium-support
AronNovak Oct 31, 2025
d7f1d3c
Fix cache dir check to handle boolean true from PHPUnit
AronNovak Oct 31, 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
60 changes: 56 additions & 4 deletions src/Provider/Geonames/Geonames.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,38 @@ final class Geonames extends AbstractHttpProvider implements Provider
*/
private $username;

/**
* @var string|null
*/
private $token;

/**
* @var string
*/
private $baseUrl;

/**
* @param ClientInterface $client An HTTP adapter
* @param string $username Username login (Free registration at http://www.geonames.org/login)
* @param string|null $token Optional token for premium accounts
* @param bool $secure Use secure endpoint (https://secure.geonames.net) for premium accounts
*/
public function __construct(ClientInterface $client, string $username)
public function __construct(ClientInterface $client, string $username, ?string $token = null, bool $secure = false)
{
if (empty($username)) {
throw new InvalidCredentials('No username provided.');
}

$this->username = $username;
$this->token = $token;

// Determine base URL based on secure flag
if ($secure) {
$this->baseUrl = 'https://secure.geonames.net';
} else {
$this->baseUrl = 'http://api.geonames.org';
}

parent::__construct($client);
}

Expand All @@ -75,7 +96,15 @@ public function geocodeQuery(GeocodeQuery $query): Collection
throw new UnsupportedOperation('The Geonames provider does not support IP addresses.');
}

$url = sprintf(self::GEOCODE_ENDPOINT_URL, urlencode($address), $query->getLimit(), $this->username);
$url = sprintf(
'%s/searchJSON?q=%s&maxRows=%d&style=full&username=%s',
$this->baseUrl,
urlencode($address),
$query->getLimit(),
$this->username
);

$url = $this->appendToken($url);

return $this->executeQuery($url, $query->getLocale());
}
Expand All @@ -86,7 +115,16 @@ public function reverseQuery(ReverseQuery $query): Collection
$longitude = $coordinates->getLongitude();
$latitude = $coordinates->getLatitude();

$url = sprintf(self::REVERSE_ENDPOINT_URL, $latitude, $longitude, $query->getLimit(), $this->username);
$url = sprintf(
'%s/findNearbyPlaceNameJSON?lat=%F&lng=%F&style=full&maxRows=%d&username=%s',
$this->baseUrl,
$latitude,
$longitude,
$query->getLimit(),
$this->username
);

$url = $this->appendToken($url);

return $this->executeQuery($url, $query->getLocale());
}
Expand All @@ -96,7 +134,7 @@ public function reverseQuery(ReverseQuery $query): Collection
*/
public function getCountryInfo(?string $country = null, ?string $locale = null): array
{
$url = sprintf(self::BASE_ENDPOINT_URL, 'countryInfoJSON', $this->username);
$url = sprintf('%s/countryInfoJSON?username=%s', $this->baseUrl, $this->username);

if (isset($country)) {
$url = sprintf('%s&country=%s', $url, $country);
Expand All @@ -109,6 +147,8 @@ public function getCountryInfo(?string $country = null, ?string $locale = null):
$url = sprintf('%s&lang=%s', $url, substr($locale, 0, 2));
}

$url = $this->appendToken($url);

$content = $this->getUrlContents($url);
if (null === $json = json_decode($content)) {
throw InvalidServerResponse::create($url);
Expand Down Expand Up @@ -217,4 +257,16 @@ private function executeQuery(string $url, ?string $locale = null): AddressColle

return new AddressCollection($results);
}

/**
* Append token parameter to URL if token is provided.
*/
private function appendToken(string $url): string
{
if (null !== $this->token && '' !== $this->token) {
$url = sprintf('%s&token=%s', $url, $this->token);
}

return $url;
}
}
Loading