Add ipstack provider (#205)

* Add ipstack provider

* updated the list of all te providers

* added functional test

* added Ipstack to the ProviderFactoryTest

* fix broken test

Author: jGielen

ProviderFactory/IpstackFactory.php

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

Resources/doc/services.md

@@ -23,6 +23,7 @@ Here is a list of all provider factories and their options.
 | `Bazinga\GeocoderBundle\ProviderFactory\HostIpFactory` | httplug_client
 | `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\MapQuestFactory` | httplug_client, api_key, licensed
 | `Bazinga\GeocoderBundle\ProviderFactory\MapzenFactory` | httplug_client, api_key
 | `Bazinga\GeocoderBundle\ProviderFactory\MaxMindBinaryFactory` | dat_file, open_flag

Tests/Functional/ProviderFactoryTest.php

@@ -26,6 +26,7 @@
 use Geocoder\Provider\HostIp\HostIp;
 use Geocoder\Provider\IpInfo\IpInfo;
 use Geocoder\Provider\IpInfoDb\IpInfoDb;
+use Geocoder\Provider\Ipstack\Ipstack;
 use Geocoder\Provider\MapQuest\MapQuest;
 use Geocoder\Provider\Mapzen\Mapzen;
 use Geocoder\Provider\MaxMind\MaxMind;
@@ -68,6 +69,7 @@ public function getProviders()
             [HostIp::class, ['empty']],
             [IpInfo::class, ['acme']],
             [IpInfoDb::class, ['empty', 'acme']],
+            [Ipstack::class, ['acme']],
             [MapQuest::class, ['acme']],
             [Mapzen::class, ['acme']],
             [MaxMind::class, ['acme']],

Tests/Functional/config/provider/ipstack.yml

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

composer.json

@@ -41,6 +41,7 @@
     "geocoder-php/geoip2-provider": "^4.0",
     "geocoder-php/ip-info-provider": "^0.1",
     "geocoder-php/ip-info-db-provider": "^4.0",
+    "geocoder-php/ipstack-provider": "^0.1",
     "geocoder-php/host-ip-provider": "^4.0",
     "geocoder-php/maxmind-binary-provider": "^4.0",
     "geocoder-php/yandex-provider": "^4.0",