add opencage provider

Author: nicolassing

DependencyInjection/BazingaGeocoderExtension.php

@@ -195,6 +195,16 @@ public function load(array $configs, ContainerBuilder $container)
             $container->setDefinition('bazinga_geocoder.provider.maxmind_binary', $provider);
         }
 
+        if (isset($config['providers']['opencage'])) {
+            $openCageParams = $config['providers']['opencage'];
+
+            $this->addProvider('opencage', array(
+                $openCageParams['locale'],
+                $openCageParams['use_ssl'],
+                $openCageParams['api_key'],
+            ));
+        }
+
         if (isset($config['providers']['cache'])) {
             $params   = $config['providers']['cache'];
             $cache    = new Reference($params['adapter']);

DependencyInjection/Configuration.php

@@ -163,6 +163,13 @@ public function getConfigTreeBuilder()
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('opencage')
+                    ->children()
+                        ->scalarNode('locale')->defaultNull()->end()
+                        ->booleanNode('use_ssl')->defaultFalse()->end()
+                        ->scalarNode('api_key')->isRequired()->cannotBeEmpty()->end()
+                    ->end()
+                ->end()
                 ->arrayNode('chain')
                     ->fixXmlConfig('provider')
                     ->children()

Resources/config/services.xml

@@ -27,6 +27,7 @@
         <parameter key="bazinga_geocoder.geocoder.provider.geo_plugin.class">Geocoder\Provider\GeoPluginProvider</parameter>
         <parameter key="bazinga_geocoder.geocoder.provider.maxmind.class">Geocoder\Provider\MaxMindProvider</parameter>
         <parameter key="bazinga_geocoder.geocoder.provider.maxmind_binary.class">Geocoder\Provider\MaxMindBinaryProvider</parameter>
+        <parameter key="bazinga_geocoder.geocoder.provider.opencage.class">Geocoder\Provider\OpenCageProvider</parameter>
         <parameter key="bazinga_geocoder.geocoder.provider.cache.class">Bazinga\Bundle\GeocoderBundle\Provider\CacheProvider</parameter>
         <parameter key="bazinga_geocoder.geocoder.provider.chain.class">Geocoder\Provider\ChainProvider</parameter>
         <parameter key="bazinga_geocoder.geocoder.provider.tom_tom.class">Geocoder\Provider\TomTomProvider</parameter>

Resources/doc/index.md

@@ -293,6 +293,10 @@ bazinga_geocoder:
         maxmind_binary:
             binary_file:          ~ # Required
             open_flag:            null
+        opencage:
+            locale:               null
+            use_ssl:              false
+            api_key:              null
         chain:
             providers:            []
         tom_tom:

Tests/DependencyInjection/BazingaGeocoderExtensionTest.php

@@ -73,6 +73,7 @@ public function testLoad()
             'maxmind'              => 'Geocoder\\Provider\\MaxmindProvider',
             'chain'                => 'Geocoder\\Provider\\ChainProvider',
             'maxmind_binary'       => 'Geocoder\\Provider\\MaxmindBinaryProvider',
+            'opencage'            => 'Geocoder\\Provider\\OpenCageProvider',
         ) as $name => $class) {
             $this->assertInstanceOf($class, $providers[$name], sprintf('-> Assert that %s is instance of %s', $name, $class));
         }

Tests/DependencyInjection/Fixtures/config.yml

@@ -48,5 +48,8 @@ bazinga_geocoder:
             api_key: 123
         maxmind_binary:
             binary_file: %fixtures_dir%/maxmind.dat
+        opencage:
+            locale: en_US
+            api_key: 123
         chain:
             providers: [free_geo_ip, host_ip]