Fix config, configuration, and documentation

Author: willdurand

DependencyInjection/BazingaGeocoderExtension.php

@@ -36,13 +36,15 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
 
-        if (isset($config['fake_ip']) && !empty($config['fake_ip'])) {
+        if (!empty($config['fake_ip']) && true === $config['fake_ip']['enabled']) {
             $definition = $container->getDefinition('bazinga_geocoder.event_listener.fake_request');
             $definition->replaceArgument(0, $config['fake_ip']['ip']);
 
             $tag = current($definition->getTag('kernel.event_listener'));
             $tag['priority'] = $config['fake_ip']['priority'];
             $definition->setTags(array($tag));
+        } else {
+            $container->removeDefinition('bazinga_geocoder.event_listener.fake_request');
         }
 
         if (isset($config['adapter']['class']) && !empty($config['adapter']['class'])) {

DependencyInjection/Configuration.php

@@ -21,7 +21,7 @@ class Configuration implements ConfigurationInterface
     /**
      * Generates the configuration tree builder.
      *
-     * @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
+     * @return TreeBuilder The tree builder
      */
     public function getConfigTreeBuilder()
     {
@@ -35,7 +35,13 @@ public function getConfigTreeBuilder()
                 ->ifString()
                     ->then(function($value) { return array('ip' => $value); })
                 ->end()
+                ->treatFalseLike(array('enabled' => false))
+                ->treatTrueLike(array('enabled' => true))
+                ->treatNullLike(array('enabled' => true))
                 ->children()
+                    ->booleanNode('enabled')
+                        ->defaultTrue()
+                    ->end()
                     ->scalarNode('ip')->defaultNull()->end()
                     ->scalarNode('priority')->defaultValue(0)->end()
                 ->end()
@@ -114,7 +120,6 @@ public function getConfigTreeBuilder()
                 ->arrayNode('host_ip')->end()
                 ->arrayNode('geoip')->end()
                 ->arrayNode('free_geo_ip')->end()
-
                 ->arrayNode('mapquest')->end()
                 ->arrayNode('oiorest')->end()
                 ->arrayNode('geocoder_ca')->end()
@@ -166,7 +171,7 @@ public function getConfigTreeBuilder()
                 ->end()
 
             ->end()
-            ;
+        ;
 
         return $treeBuilder;
     }

Resources/config/services.xml

@@ -45,6 +45,7 @@
     </parameters>
 
     <services>
+        <service id="geocoder" alias="bazinga_geocoder.geocoder" />
         <service id="bazinga_geocoder.geocoder" class="%bazinga_geocoder.geocoder.class%" />
 
         <!-- Adapters -->

Resources/doc/index.md

@@ -42,7 +42,8 @@ Usage
 -----
 
 This bundle registers a `bazinga_geocoder.geocoder` service which is an instance
-of `Geocoder`. You'll be able to do whatever you want with it.
+of `Geocoder`. You'll be able to do whatever you want with it but be sure to
+configure at least **one provider** first.
 
 **NOTE:** When using `Request::getClientIp()` with Symfony 2.1+, ensure you have
 a trusted proxy set in your `config.yml`:
@@ -67,14 +68,15 @@ information in your development environment, for instance:
     /**
      * @Template()
      */
-    public function indexAction()
+    public function indexAction(Request $request)
     {
         // Retrieve information from the current user (by its IP address)
-        $result = $this->geocoder
+        $result = $this->container
+            ->get('bazinga_geocoder.geocoder')
             ->using('yahoo')
-            ->geocode($this->getRequest()->server->get('REMOTE_ADDR'));
+            ->geocode($request->server->get('REMOTE_ADDR'));
 
-        // Find the 5 nearest objects from the current user.
+        // Find the 5 nearest objects (15km) from the current user.
         $objects = ObjectQuery::create()
             ->filterByDistanceFrom($result->getLatitude(), $result->getLongitude(), 15)
             ->limit(5)
@@ -129,12 +131,14 @@ Here is an example:
 ```php
 <?php
 
-public function geocodeAction()
+public function geocodeAction(Request $request)
 {
-    $result = $this->container->get('bazinga_geocoder.geocoder')
-        ->geocode($this->container->get('request')->server->get('REMOTE_ADDR'));
+    $result = $this->container
+        ->get('bazinga_geocoder.geocoder')
+        ->geocode($request->server->get('REMOTE_ADDR'));
 
-    $body = $this->container->get('bazinga_geocoder.dumper_manager')
+    $body = $this->container
+        ->get('bazinga_geocoder.dumper_manager')
         ->get('geojson')
         ->dump($result);
 
@@ -196,60 +200,66 @@ Toolbar](https://raw.github.com/willdurand/BazingaGeocoderBundle/master/Resource
 Reference Configuration
 -----------------------
 
-You have to define the providers you want to use in your configuration.
-Some of them need information (API key for instance).
+You MUST define the providers you want to use in your configuration.  Some of
+them need information (API key for instance).
 
 You'll find the reference configuration below:
 
 ``` yaml
 # app/config/config*.yml
 
 bazinga_geocoder:
-    fake_ip:    999.999.999.999
+    fake_ip:
+        enabled:              true
+        ip:                   ~
+        priority:             0
     adapter:
-        class:  \Your\CustomAdapter
+        class:                ~
     providers:
         bing_maps:
-            api_key:    XXXXXXXXX
-            locale:     xx_XX
-        google_maps:
-            locale:     xx_XX
-            region:     xx_XX
+            api_key:              ~ # Required
+            locale:               ~
+        cache:
+            adapter:              ~ # Required
+            provider:             ~ # Required
+            locale:               ~
+            lifetime:             86400
         ip_info_db:
-            api_key:    XXXXXXXXX
+            api_key:              ~ # Required
         yahoo:
-            api_key:    XXXXXXXXX
-            locale:     xx_XX
+            api_key:              ~ # Required
+            locale:               ~
         cloudmade:
-            api_key:    XXXXXXXXX
-        free_geo_ip: ~
+            api_key:              ~ # Required
+        google_maps:
+            locale:               ~
+            region:               ~
+            use_ssl:              false
         openstreetmaps:
-            locale:     xx_XX
-        host_ip: ~
-        geoip: ~
-        mapquest: ~
-        oiorest: ~
-        geocoder_ca: ~
-        geocoder_us: ~
+            locale:               ~
+        host_ip:              []
+        geoip:                []
+        free_geo_ip:          []
+        mapquest:             []
+        oiorest:              []
+        geocoder_ca:          []
+        geocoder_us:          []
         ign_openls:
-            api_key:    XXXXXXXXX
-        data_science_toolkit: ~
+            api_key:              ~ # Required
+        data_science_toolkit:  []
         yandex:
-            locale:     xx-XX
-            toponym:    XXXXXXXXX
+            locale:               ~
+            toponym:              ~
         geo_ips:
-            api_key:    XXXXXXXXX
-        geo_plugin: ~
+            api_key:              ~
+        geo_plugin:           []
         maxmind:
-            api_key:    XXXXXXXXX
-        # Caching Layer
-        cache:
-            provider: openstreetmaps
-            adapter:  some_service_id
-            lifetime: 86400
-            locale:   %locale%
+            api_key:              ~ # Required
+        maxmind_binary:
+            binary_file:          ~ # Required
+            open_flag:            ~
         chain:
-            providers: [free_geo_ip, host_ip]
+            providers:            []
 ```
 
 

Resources/views/Collector/geocoder.html.twig

@@ -30,7 +30,7 @@
 {% endblock %}
 
 {% block panel %}
-    <h2>Gocoder requests</h2>
+    <h2>Geocoder Requests</h2>
 
     {% if not collector.requestsCount %}
         <p><em>No requests.</em></p>
@@ -67,13 +67,12 @@
     function geo_explain(link) {
         "use strict";
 
-        var imgs = link.children,
-                target = link.getAttribute('data-target-id');
+        var imgs   = link.children,
+            target = link.getAttribute('data-target-id');
 
         Sfjs.toggle(target, imgs[0], imgs[1]);
 
         return false;
     }
     //]]></script>
-
 {% endblock %}