Add required userAgent (#198)

* Add required userAgent

The requirements of Nominatim state that a User-Agent must be submitted (https://operations.osmfoundation.org/policies/nominatim/). It looks like this was already implemented in the provider but not in the config (`ProviderFactory`). So `Geocoder\Provider\Nominatim` does now require a userAgent as third parameter.

Solves Issue: #195

* Added mandatory parameter to test config

* Made test running again by setting a default user_agent

* Made user_agent option as required

Author: toooni

ProviderFactory/NominatimFactory.php

@@ -27,17 +27,20 @@ protected function getProvider(array $config): Provider
     {
         $httplug = $config['httplug_client'] ?: HttpClientDiscovery::find();
 
-        return new Nominatim($httplug, $config['root_url']);
+        return new Nominatim($httplug, $config['root_url'], $config['user_agent']);
     }
 
     protected static function configureOptionResolver(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
             'httplug_client' => null,
             'root_url' => 'https://nominatim.openstreetmap.org',
+            'user_agent' => 'BazingaGeocoderBundle',
         ]);
 
         $resolver->setAllowedTypes('httplug_client', ['object', 'null']);
         $resolver->setAllowedTypes('root_url', ['string']);
+        $resolver->setAllowedTypes('user_agent', ['string']);
+        $resolver->setRequired('user_agent');
     }
 }

Tests/Functional/config/provider/nominatim.yml

@@ -9,4 +9,4 @@ bazinga_geocoder:
       factory: Bazinga\GeocoderBundle\ProviderFactory\NominatimFactory
       options:
         root_url: 'https://nominatim.openstreetmap.org'
-
+        user_agent: 'geocoder-php test_suite'

composer.json

@@ -47,7 +47,7 @@
     "geocoder-php/tomtom-provider": "^4.0",
     "geocoder-php/pickpoint-provider": "^4.0",
     "geocoder-php/open-cage-provider": "^4.0",
-    "geocoder-php/nominatim-provider": "^4.0",
+    "geocoder-php/nominatim-provider": "^5.0",
     "geocoder-php/maxmind-provider": "^4.0",
     "geocoder-php/mapzen-provider": "^4.0",
     "geocoder-php/mapquest-provider": "^4.0"