Merge pull request #6 from Wingly-Company/gkleitz/add_place_id_parame…

…ter_to_geocode

Adding place_id parameter to geocode endpoint

README.md

@@ -138,6 +138,7 @@ You can streamline your search by adding the following query params to your url:
 - `language`: To get the results in a specific language. Defaults to the application current locale. 
 - `country`: To get the results for a specific country. 
 - `types`: To get the results for a specific type. Available only for autocomplete requests.
+- `place_id`: (geocoding only) The place id returned by the autocomplete api. Will replace user input if provided.
 
 If you like to prevent the publishing of those routes completely, you can use the `ignoreRoutes` method provided by GooglePlaces.  
 Typically this method should be called in the register method of your `AppServiceProvider`: 

src/Builder.php

@@ -22,6 +22,9 @@ class Builder
     /** @var string */
     public $query;
 
+    /** @var string */
+    public $placeId;
+
     /** @var \Wingly\GooglePlaces\Engines\Engine */
     public $engine;
 
@@ -65,6 +68,13 @@ public function setFields(string $fields): self
         return $this;
     }
 
+    public function setPlaceId(string $placeId): self
+    {
+        $this->placeId = $placeId;
+
+        return $this;
+    }
+
     public function get(): mixed
     {
         $cacheKey = $this->engine->getHashedCacheKey($this);

src/Engines/GeocodeEngine.php

@@ -20,7 +20,7 @@ public function search(Builder $builder): mixed
     {
         $payload = $this->getRequestPayload($builder);
 
-        if (empty($builder->query)) {
+        if (empty($builder->query) && empty($builder->placeId)) {
             return [];
         }
 
@@ -70,6 +70,11 @@ protected function getRequestPayload(Builder $builder): array
             'language' => $builder->language,
         ];
 
+        if ($builder->placeId) {
+            $parameters['place_id'] = $builder->placeId;
+            unset($parameters['address']);
+        }
+
         if ($builder->country) {
             $parameters = array_merge(
                 $parameters,

src/Http/Controllers/GeocodeController.php

@@ -9,14 +9,15 @@
 use Wingly\GooglePlaces\GooglePlaces;
 use Wingly\GooglePlaces\Pipes\Country;
 use Wingly\GooglePlaces\Pipes\Language;
+use Wingly\GooglePlaces\Pipes\PlaceId;
 
 class GeocodeController extends Controller
 {
     public function __invoke(Request $request): JsonResponse
     {
         $results = app(Pipeline::class)
             ->send(GooglePlaces::geocode($request->query('input') ?? ''))
-            ->through([Language::class, Country::class])
+            ->through([Language::class, Country::class, PlaceId::class])
             ->thenReturn()
             ->get();
 

src/Pipes/PlaceId.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Wingly\GooglePlaces\Pipes;
+
+use Wingly\GooglePlaces\Builder;
+
+class PlaceId
+{
+    public function handle(Builder $builder, $next): mixed
+    {
+        if (request()->has('place_id')) {
+            $builder->setPlaceId(request('place_id', ''));
+        }
+
+        return $next($builder);
+    }
+}

tests/GoogleGeocodeTest.php

@@ -31,7 +31,7 @@ public function test_it_can_translate_the_data(): void
     {
         $result = GooglePlaces::geocode('Roma, Italy')->get();
 
-        $this->assertEquals('Rome, Metropolitan City of Rome, Italy', $result['formatted_address']);
+        $this->assertEquals('Rome, Metropolitan City of Rome Capital, Italy', $result['formatted_address']);
 
         $result = GooglePlaces::geocode('Roma, Italy')
             ->setLanguage('it')
@@ -64,4 +64,13 @@ public function test_it_will_cache_a_request(): void
 
         $this->assertEquals($results, $cachedResults);
     }
+
+    public function test_place_id_overrides_address_when_provided()
+    {
+        $result = GooglePlaces::geocode('Faketown')
+            ->setPlaceId('ChIJ60OJPWsTLUYRA2vzEgdY4q4')
+            ->get();
+
+        $this->assertEquals('North Sea', $result['formatted_address']);
+    }
 }

tests/GooglePlaceDetailsTest.php

@@ -26,7 +26,7 @@ public function test_it_can_translate_the_data(): void
             ->setFields('formatted_address')
             ->get();
 
-        $this->assertEquals('Rome, Metropolitan City of Rome, Italy', $result['formatted_address']);
+        $this->assertEquals('Rome, Metropolitan City of Rome Capital, Italy', $result['formatted_address']);
 
         $result = GooglePlaces::details('ChIJu46S-ZZhLxMROG5lkwZ3D7k')
             ->setFields('formatted_address')