[GraphHopper] Add GraphHopperProviders enum for provider options of GraphHopper geocoding api

Graphhopper geocoding supports different providers. Hereby the option is given to use only available providers.

Author: bisleadity

src/Provider/GraphHopper/GraphHopper.php

@@ -75,7 +75,7 @@ public function geocodeQuery(GeocodeQuery $query): Collection
         }
 
         $provider = $query->getData('provider');
-        if (is_string($provider) && '' !== $provider) {
+        if (is_string($provider) && GraphHopperProviders::tryFrom($provider)) {
             $url .= sprintf('&provider=%s', urlencode($provider));
         }
 

src/Provider/GraphHopper/GraphHopperProviders.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Geocoder\Provider\GraphHopper;
+
+enum GraphHopperProviders: string
+{
+    case Default = 'default';
+    case Nominatim = 'nominatim';
+    case Gisgraphy = 'gisgraphy';
+    case Nettoolkit = 'nettoolkit';
+    case Opencagedata = 'opencagedata';
+}

src/Provider/GraphHopper/Tests/GraphHopperTest.php

@@ -150,6 +150,35 @@ function (RequestInterface $request) use (&$uri) {
         );
     }
 
+    public function testNoProviderIsAppendedWhenProviderNotInEnum(): void
+    {
+        $uri = '';
+
+        $provider = new GraphHopper(
+            $this->getMockedHttpClientCallback(
+                function (RequestInterface $request) use (&$uri) {
+                    $uri = (string) $request->getUri();
+                }
+            ),
+            'api_key'
+        );
+
+        $query = GeocodeQuery::create('242 Acklam Road, London, United Kingdom')
+            ->withLocale('fr')
+            ->withData('provider', 'invalidProvider');
+
+        try {
+            $provider->geocodeQuery($query);
+        } catch (InvalidServerResponse $e) {
+        }
+
+        $this->assertEquals('https://graphhopper.com/api/1/geocode'.
+            '?q=242+Acklam+Road%2C+London%2C+United+Kingdom'.
+            '&key=api_key&locale=fr&limit=5',
+            $uri
+        );
+    }
+
     public function testReverseWithRealCoordinates(): void
     {
         if (!isset($_SERVER['GRAPHHOPPER_API_KEY'])) {