Return null instead of throwing

composer.json

@@ -18,7 +18,8 @@
         "symfony/http-client": "^6.1",
         "symfony/dependency-injection": "^6.1",
         "symfony/framework-bundle": "^6.1",
-        "symfony/yaml": "^6.1"
+        "symfony/yaml": "^6.1",
+        "doctrine/orm": "^2.13"
     },
 
     "require-dev": {

src/Entity/Trait/MappableTrait.php

@@ -4,6 +4,8 @@ declare(strict_types=1);
 
 namespace Pcm\GeocodeBundle\Entity\Trait;
 
+use Doctrine\ORM\Mapping as ORM;
+
 /**
  * Allows an entity to be mapped via latitude and longitude coordinates
  *
@@ -13,8 +15,10 @@ namespace Pcm\GeocodeBundle\Entity\Trait;
  */
 trait MappableTrait
 {
+    #[ORM\Column(type: 'decimal', precision: 10, scale: 6, nullable: true)]
     private ?float $latitude = null;
 
+    #[ORM\Column(type: 'decimal', precision: 10, scale: 6, nullable: true)]
     private ?float $longitude = null;
 
     public function getLatitude(): ?float

src/Model/LatLongModel.php

@@ -9,17 +9,17 @@ namespace Pcm\GeocodeBundle\Model;
  *
  * @package Pcm\GeocodeBundle
  */
-class LatLonModel
+class LatLongModel
 {
     public function __construct(private float $latitude, private float $longitude) {}
 
     public function getLatitude(): float
     {
-        return $this->getLatitude();
+        return $this->latitude;
     }
 
     public function getLongitude(): float
     {
-        return $this->getLongitude();
+        return $this->longitude;
     }
 }

src/Service/Geocoder.php

@@ -4,8 +4,7 @@ declare(strict_types=1);
 
 namespace Pcm\GeocodeBundle\Service;
 
-use Pcm\GeocodeBundle\Entity\GeocodeData;
-use Pcm\GeocodeBundle\Model\LatLonModel;
+use Pcm\GeocodeBundle\Model\LatLongModel;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
@@ -16,19 +15,22 @@ class Geocoder
     public function __construct(private HttpClientInterface $client) {}
 
     /**
-     * Returns a LatLonModel object
+     * Convert a postcode into latitude and longitude. Returns null if conversion failed.
      *
      * @param string $postcode
-     * @return GeocodeData
+     * @return null|LatLongModel
      */
-    public function geocodePostcode(string $postcode): LatLonModel
+    public function geocodePostcode(string $postcode): ?LatLongModel
     {
         $client = $this->createClient();
-        $response = $this->requestGeocodeData($client, $postcode);
-        $data = $response->toArray();
-        $this->throwIfNoResponseData($data);
+        $response = $this->makeApiRequest($client, $postcode);
+        $data = $this->getDataFromResponse($response);
 
-        return $this->createLatLonObject($data);
+        if (empty($data)) {
+            return null;
+        }
+
+        return $this->createLatLongModel($data);
     }
 
     private function createClient(): HttpClientInterface
@@ -38,7 +40,7 @@ class Geocoder
         ]);
     }
 
-    private function requestGeocodeData(HttpClientInterface $client, string $postcode): ResponseInterface
+    private function makeApiRequest(HttpClientInterface $client, string $postcode): ResponseInterface
     {
         return $client->request(
             method: 'GET',
@@ -52,14 +54,26 @@ class Geocoder
         );
     }
 
-    private function throwIfNoResponseData(array $data): void
+    private function getDataFromResponse(ResponseInterface $response): array
     {
-        if (empty($data))
-            throw new \Exception("No data was received from API response! Were the arguments valid?");
+        return $response->toArray(false);
     }
 
-    private function createLatLonObject(array $data): LatLonModel
+    private function createLatLongModel(array $data): LatLongModel
     {
-        return new LatLonModel((float) $data[0]['lat'], (float) $data[0]['lon']);
+        $lat = $this->getLatitudeFromData($data);
+        $long = $this->getLongitudeFromData($data);
+
+        return new LatLongModel($lat, $long);
+    }
+
+    private function getLatitudeFromData(array $data): float
+    {
+        return (float) $data[0]['lat'];
+    }
+
+    private function getLongitudeFromData(array $data): float
+    {
+        return (float) $data[0]['lon'];
     }
 }

tests/Service/GeocodeTest.php

@@ -6,11 +6,14 @@ namespace Pcm\GeocodeBundle\Tests;
 
 use Pcm\GeocodeBundle\Entity\Interface\MappableInterface;
 use Pcm\GeocodeBundle\Entity\Trait\MappableTrait;
-use Pcm\GeocodeBundle\Model\LatLonModel;
+use Pcm\GeocodeBundle\Model\LatLongModel;
 use Pcm\GeocodeBundle\Service\Geocoder;
 use Pcm\GeocodeBundle\Tests\AppKernel;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 
+/**
+ * Note we sleep 1s after requests to prevent breaking the API T&Cs
+ */
 class GeocodeTest extends KernelTestCase
 {
     // Buckingham Palace
@@ -30,18 +33,17 @@ class GeocodeTest extends KernelTestCase
         $this->assertInstanceOf(Geocoder::class, $this->geocoder);
     }
 
-    public function testGeocodePostcodeThrowsOnInvalidInput(): void
+    public function testGeocodePostcodeReturnsNullOnInvalidInput(): void
     {
         sleep(1);
-        $this->expectException(\Exception::class);
-        $this->geocoder->geocodePostcode('aaaaaaaa');
+        $this->assertNull($this->geocoder->geocodePostcode(''));
     }
 
     public function testGeocodePostcodeReturnsLatLonModel(): void
     {
         sleep(1);
         $result = $this->geocoder->geocodePostcode(self::POSTCODE);
-        $this->assertInstanceOf(LatLonModel::class, $result);
+        $this->assertInstanceOf(LatLongModel::class, $result);
     }
 
     private function getMappableEntity(): MappableInterface