pcm-libraries/pcm-geocode-bundle
2
0
Fork 0
Code Issues 2 Releases Activity

Throw exceptions when something goes wrong instead of returning null

Browse Source
This commit is contained in:
brabli
2024-08-05 13:07:04 +01:00
parent fcda1e931c
commit a6c8c4cc0c
2 changed files with 20 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/Service/Geocoder.php
View File

@@ -4,6 +4,8 @@ declare(strict_types=1);
namespace Pcm\GeocodeBundle\Service; namespace Pcm\GeocodeBundle\Service;
use Pcm\GeocodeBundle\Exception\ApiErrorException;
use Pcm\GeocodeBundle\Exception\NoResultsFoundException;
use Pcm\GeocodeBundle\Model\GeoCoordinates; use Pcm\GeocodeBundle\Model\GeoCoordinates;
use Symfony\Contracts\HttpClient\HttpClientInterface; use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface; use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -26,13 +28,12 @@ final class Geocoder
$response = $this->makeApiRequest($client, $postcode); $response = $this->makeApiRequest($client, $postcode);
$data = $this->getDataFromResponse($response); $data = $this->getDataFromResponse($response);
// @todo remove check, I don't think it's needed if (array_key_exists('error', $data)) {
if (empty($data)) { throw new ApiErrorException($postcode, $data['error']['message']);
return null;
} }
if (array_key_exists('error', $data)) { if (empty($data)) {
return null; throw new NoResultsFoundException($postcode, "No results found.");
} }
return $this->createGeoCoordinates($data); return $this->createGeoCoordinates($data);

16
tests/Service/GeocodeTest.php
View File

@@ -6,6 +6,8 @@ namespace Pcm\GeocodeBundle\Tests;
use Pcm\GeocodeBundle\Entity\Interface\MappableInterface; use Pcm\GeocodeBundle\Entity\Interface\MappableInterface;
use Pcm\GeocodeBundle\Entity\Trait\MappableTrait; use Pcm\GeocodeBundle\Entity\Trait\MappableTrait;
use Pcm\GeocodeBundle\Exception\ApiErrorException;
use Pcm\GeocodeBundle\Exception\NoResultsFoundException;
use Pcm\GeocodeBundle\Model\GeoCoordinates; use Pcm\GeocodeBundle\Model\GeoCoordinates;
use Pcm\GeocodeBundle\Service\Geocoder; use Pcm\GeocodeBundle\Service\Geocoder;
use Pcm\GeocodeBundle\Tests\AppKernel; use Pcm\GeocodeBundle\Tests\AppKernel;
@@ -33,10 +35,20 @@ final class GeocodeTest extends KernelTestCase
$this->assertInstanceOf(Geocoder::class, $this->geocoder); $this->assertInstanceOf(Geocoder::class, $this->geocoder);
} }
public function testGeocodePostcodeReturnsNullOnInvalidInput(): void public function testGeocodePostcodeThrowsOnEmptyInput(): void
{ {
sleep(1); sleep(1);
$this->assertNull($this->geocoder->geocodePostcode('')); $this->expectException(ApiErrorException::class);
$this->expectExceptionMessageMatches("/Nothing to search for.$/");
$this->geocoder->geocodePostcode('');
}
public function testGeocodePostcodeThrowsOnInvalidPostcode(): void
{
sleep(1);
$this->expectException(NoResultsFoundException::class);
$this->expectExceptionMessageMatches("/No results found.$/");
$this->geocoder->geocodePostcode('ZZZZZZZZZZZZ');
} }
public function testGeocodePostcodeReturnsGeoCoordinates(): GeoCoordinates public function testGeocodePostcodeReturnsGeoCoordinates(): GeoCoordinates