Add bounds to request payload (spatie#42)

* Add bounds param to request payload

* Add API key .env support in tests

* Add bounds param to request payload

Author: hellozach

README.md

@@ -92,6 +92,13 @@ return [
     */
    'region' => '',
 
+    /*
+     * The bounds param used to finetune the geocoding process.
+     *
+     * More info: https://developers.google.com/maps/documentation/geocoding/intro#Viewports
+     */
+    'bounds' => '',
+
 ];
 ```
 

config/geocoder.php

@@ -22,4 +22,11 @@
      */
     'region' => '',
 
+    /*
+     * The bounds param used to finetune the geocoding process.
+     *
+     * More info: https://developers.google.com/maps/documentation/geocoding/intro#Viewports
+     */
+    'bounds' => '',
+
 ];

src/Geocoder.php

@@ -24,6 +24,9 @@ class Geocoder
     /** @var string */
     protected $region;
 
+    /** @var string */
+    protected $bounds;
+
     public function __construct(Client $client)
     {
         $this->client = $client;
@@ -50,6 +53,13 @@ public function setRegion(string $region)
         return $this;
     }
 
+    public function setBounds(string $bounds)
+    {
+        $this->bounds = $bounds;
+
+        return $this;
+    }
+
     public function getCoordinatesForAddress(string $address): array
     {
         if (empty($address)) {
@@ -119,6 +129,7 @@ protected function getRequestPayload(array $parameters): array
             'key' => $this->apiKey,
             'language' => $this->language,
             'region' => $this->region,
+            'bounds' => $this->bounds,
         ], $parameters);
 
         return ['query' => $parameters];

src/GeocoderServiceProvider.php

@@ -22,7 +22,8 @@ public function register()
             return (new Geocoder(new Client))
                 ->setApiKey(config('geocoder.key'))
                 ->setLanguage(config('geocoder.language'))
-                ->setRegion(config('geocoder.region'));
+                ->setRegion(config('geocoder.region'))
+                ->setBounds(config('geocoder.bounds'));
         });
     }
 }

tests/GeocoderTest.php

@@ -81,6 +81,16 @@ public function it_can_translate_coordinates_to_an_address()
         $this->assertEquals('277 Bedford Ave, Brooklyn, NY 11211, Verenigde Staten', $result['formatted_address']);
     }
 
+    /** @test */
+    public function it_should_prefer_a_neighborhood_inside_of_payload_bounds()
+    {
+        $results = $this->geocoder
+            ->setBounds('34.172684,-118.604794|34.236144,-118.500938')
+            ->getCoordinatesForAddress('Winnetka');
+
+        $this->assertEquals('Winnetka, Los Angeles, CA, USA', $results['formatted_address']);
+    }
+
     protected function emptyResponse(): array
     {
         return [