Merge pull request #309 from nassuf/feat/add_locationiq_provider

Add locationIQ provider

Author: norkunas

ProviderFactory/LocationIQFactory.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * 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\LocationIQ\LocationIQ;
+use Geocoder\Provider\Provider;
+use Http\Discovery\HttpClientDiscovery;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+final class LocationIQFactory extends AbstractFactory
+{
+    protected static $dependencies = [
+        ['requiredClass' => LocationIQ::class, 'packageName' => 'geocoder-php/locationiq-provider'],
+    ];
+
+    protected function getProvider(array $config): Provider
+    {
+        $httplug = $config['httplug_client'] ?: $this->httpClient ?? HttpClientDiscovery::find();
+
+        return new LocationIQ($httplug, $config['api_key']);
+    }
+
+    protected static function configureOptionResolver(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'httplug_client' => null,
+        ]);
+
+        $resolver->setAllowedTypes('httplug_client', ['object', 'null']);
+        $resolver->setRequired(['api_key']);
+        $resolver->setAllowedTypes('api_key', ['string']);
+    }
+}

Resources/doc/services.md

@@ -27,6 +27,7 @@ Here is a list of all provider factories and their options.
 | `Bazinga\GeocoderBundle\ProviderFactory\IpInfoFactory` | httplug_client
 | `Bazinga\GeocoderBundle\ProviderFactory\IpInfoDbFactory` | httplug_client, api_key, precision
 | `Bazinga\GeocoderBundle\ProviderFactory\IpstackFactory` | httplug_client, api_key
+| `Bazinga\GeocoderBundle\ProviderFactory\LocationIQFactory` | httplug_client, api_key
 | `Bazinga\GeocoderBundle\ProviderFactory\MapboxFactory` | httplug_client, api_key, country, mode
 | `Bazinga\GeocoderBundle\ProviderFactory\MapQuestFactory` | httplug_client, api_key, licensed
 | `Bazinga\GeocoderBundle\ProviderFactory\MapzenFactory` | httplug_client, api_key

Tests/Functional/ProviderFactoryTest.php

@@ -30,6 +30,7 @@
 use Geocoder\Provider\IpInfo\IpInfo;
 use Geocoder\Provider\IpInfoDb\IpInfoDb;
 use Geocoder\Provider\Ipstack\Ipstack;
+use Geocoder\Provider\LocationIQ\LocationIQ;
 use Geocoder\Provider\Mapbox\Mapbox;
 use Geocoder\Provider\MapQuest\MapQuest;
 use Geocoder\Provider\Mapzen\Mapzen;
@@ -80,6 +81,7 @@ public function getProviders()
         yield [IpInfo::class, ['acme']];
         yield [IpInfoDb::class, ['empty', 'acme']];
         yield [Ipstack::class, ['acme']];
+        yield [LocationIQ::class, ['acme']];
         yield [Mapbox::class, ['acme']];
         yield [MapQuest::class, ['acme']];
         if (class_exists(Mapzen::class)) {

Tests/Functional/config/provider/locationiq.yml

@@ -0,0 +1,8 @@
+bazinga_geocoder:
+    profiling:
+        enabled: false
+    providers:
+        acme:
+            factory: Bazinga\GeocoderBundle\ProviderFactory\LocationIQFactory
+            options:
+                api_key: 'foo'

composer.json

@@ -41,6 +41,7 @@
     "geocoder-php/ip-info-db-provider": "^4.2",
     "geocoder-php/ip-info-provider": "^0.3",
     "geocoder-php/ipstack-provider": "^0.3",
+    "geocoder-php/locationiq-provider": "^1.2",
     "geocoder-php/mapbox-provider": "^1.3",
     "geocoder-php/mapquest-provider": "^4.2",
     "geocoder-php/mapzen-provider": "^4.0",