Merge pull request #329 from bezin/add-ors-factory

Add OpenRouteService factory

Author: norkunas

ProviderFactory/OpenRouteServiceFactory.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\ProviderFactory;
+
+use Geocoder\Provider\OpenRouteService\OpenRouteService;
+use Geocoder\Provider\Provider;
+use Http\Client\HttpClient;
+use Http\Discovery\HttpClientDiscovery;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class OpenRouteServiceFactory extends AbstractFactory
+{
+    protected static $dependencies = [
+        ['requiredClass' => OpenRouteService::class, 'packageName' => 'geocoder-php/openrouteservice-provider'],
+    ];
+
+    /**
+     * @phpstan-param array{api_key: string, httplug_client: ?HttpClient} $config
+     */
+    protected function getProvider(array $config): Provider
+    {
+        $httplug = $config['httplug_client'] ?: HttpClientDiscovery::find();
+
+        return new OpenRouteService($httplug, $config['api_key']);
+    }
+
+    protected static function configureOptionResolver(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'httplug_client' => null,
+            'api_key' => null,
+        ]);
+
+        $resolver->setRequired('api_key');
+        $resolver->setAllowedTypes('httplug_client', [HttpClient::class, 'null']);
+        $resolver->setAllowedTypes('api_key', ['string']);
+    }
+}

Resources/doc/services.md

@@ -35,6 +35,7 @@ Here is a list of all provider factories and their options.
 | `Bazinga\GeocoderBundle\ProviderFactory\MaxMindFactory` | httplug_client, api_key, endpoint
 | `Bazinga\GeocoderBundle\ProviderFactory\NominatimFactory` | httplug_client, root_url
 | `Bazinga\GeocoderBundle\ProviderFactory\OpenCageFactory` | httplug_client, api_key
+| `Bazinga\GeocoderBundle\ProviderFactory\OpenRouteServiceFactory` | httplug_client, api_key
 | `Bazinga\GeocoderBundle\ProviderFactory\PickPointFactory` | httplug_client, api_key
 | `Bazinga\GeocoderBundle\ProviderFactory\TomTomFactory` | httplug_client, api_key
 | `Bazinga\GeocoderBundle\ProviderFactory\YandexFactory` | httplug_client, toponym

composer.json

@@ -48,6 +48,7 @@
     "geocoder-php/maxmind-provider": "^4.3",
     "geocoder-php/nominatim-provider": "^5.4",
     "geocoder-php/open-cage-provider": "^4.5",
+    "geocoder-php/openrouteservice-provider": "^1.2",
     "geocoder-php/pickpoint-provider": "^4.2",
     "geocoder-php/tomtom-provider": "^4.2",
     "geocoder-php/yandex-provider": "^4.4",