Initial commit

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml

.travis.yml

@@ -0,0 +1,14 @@
+language: php
+sudo: false
+
+php: 7.2
+
+install:
+  - composer update --prefer-stable --prefer-dist
+
+script:
+    - composer test-ci
+
+after_success:
+    - wget https://scrutinizer-ci.com/ocular.phar
+    - php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml

Geo6POI.php

@@ -0,0 +1,278 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Geocoder package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Geocoder\Provider\Geo6\POI;
+
+use Geocoder\Collection;
+use Geocoder\Exception\InvalidArgument;
+use Geocoder\Exception\InvalidServerResponse;
+use Geocoder\Exception\UnsupportedOperation;
+use Geocoder\Http\Provider\AbstractHttpProvider;
+use Geocoder\Model\Address;
+use Geocoder\Model\AddressBuilder;
+use Geocoder\Model\AddressCollection;
+use Geocoder\Model\Country;
+use Geocoder\Provider\Geo6\POI\Model\POI;
+use Geocoder\Provider\Provider;
+use Geocoder\Query\GeocodeQuery;
+use Geocoder\Query\ReverseQuery;
+use Http\Client\HttpClient;
+
+/**
+ * @author Jonathan Beliën <[email protected]>
+ */
+final class Geo6POI extends AbstractHttpProvider implements Provider
+{
+    const GEOCODE_ENDPOINT_URL = 'https://api.geo6.be/';
+
+    /**
+     * @var string
+     */
+    private $customerId;
+
+    /**
+     * @var string
+     */
+    private $privateKey;
+
+    /**
+     * @param HttpClient $client an HTTP adapter
+     */
+    public function __construct(HttpClient $client, string $customerId, string $privateKey)
+    {
+        $this->customerId = $customerId;
+        $this->privateKey = $privateKey;
+
+        parent::__construct($client);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function geocodeQuery(GeocodeQuery $query): Collection
+    {
+        $search = $query->getText();
+
+        $source = $query->getData('source');
+        $locality = $query->getData('locality') ?? null;
+
+        // This API does not support IP
+        if (filter_var($search, FILTER_VALIDATE_IP)) {
+            throw new UnsupportedOperation('The Geo-6 POI provider does not support IP addresses, only street addresses.');
+        }
+
+        // Save a request if no valid query entered
+        if (empty($search)) {
+            throw new InvalidArgument('Query cannot be empty.');
+        }
+
+        $language = '';
+        if (!is_null($query->getLocale()) && preg_match('/^(fr|nl).*$/', $query->getLocale(), $matches) === 1) {
+            $language = $matches[1];
+        }
+
+        $url = rtrim(self::GEOCODE_ENDPOINT_URL, '/');
+        if (!is_null($source) && !is_null($locality)) {
+            $url = sprintf($url.'/geocode/getPOI/%s/%s/%s', urlencode($source), urlencode($locality), urlencode($search));
+        } elseif (!is_null($source)) {
+            $url = sprintf($url.'/geocode/getPOI/%s/%s', urlencode($source), urlencode($search));
+        } else {
+            $url = sprintf($url.'/geocode/getPOI/%s', urlencode($search));
+        }
+        $json = $this->executeQuery($url);
+
+        // no result
+        if (empty($json->features)) {
+            return new AddressCollection([]);
+        }
+
+        $results = [];
+        foreach ($json->features as $feature) {
+            $poi_fr = self::extractComponents($this->getName(), $feature, 'fr');
+            $poi_nl = self::extractComponents($this->getName(), $feature, 'nl');
+
+            switch ($language) {
+                case 'fr':
+                    $results[] = $poi_fr ?? $poi_nl;
+                    break;
+
+                case 'nl':
+                    $results[] = $poi_nl ?? $poi_fr;
+                    break;
+
+                default:
+                    if (!is_null($poi_fr)) {
+                        $results[] = $poi_fr;
+                    }
+                    if (!is_null($poi_nl)) {
+                        $results[] = $poi_nl;
+                    }
+                    break;
+            }
+        }
+
+        return new AddressCollection($results);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function reverseQuery(ReverseQuery $query): Collection
+    {
+        // This API does not support reverse geocoding
+        throw new UnsupportedOperation('The Geo-6 POI provider does not support reverse geocoding.');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName(): string
+    {
+        return 'geo6-poi';
+    }
+
+    /**
+     * @param string $url
+     *
+     * @return \stdClass
+     */
+    private function executeQuery(string $url): \stdClass
+    {
+        $token = $this->getToken();
+
+        $request = $this->getRequest($url);
+
+        $request = $request->withHeader('Referer', 'http'.(!empty($_SERVER['HTTPS']) ? 's' : '').'://'.($_SERVER['SERVER_NAME'] ?? 'localhost').'/');
+        $request = $request->withHeader('X-Geo6-Consumer', $this->customerId);
+        $request = $request->withHeader('X-Geo6-Timestamp', (string) $token->time);
+        $request = $request->withHeader('X-Geo6-Token', $token->token);
+
+        $body = $this->getParsedResponse($request);
+
+        $json = json_decode($body);
+        // API error
+        if (!isset($json)) {
+            throw InvalidServerResponse::create($url);
+        }
+
+        return $json;
+    }
+
+    /**
+     * Generate token needed to query API.
+     *
+     * @return object
+     */
+    private function getToken()
+    {
+        $time = time();
+
+        $t = $this->customerId.'__';
+        $t .= $time.'__';
+        $t .= parse_url(self::GEOCODE_ENDPOINT_URL, PHP_URL_HOST).'__';
+        $t .= 'GET'.'__';
+        $t .= '/geocode/getPOI';
+
+        $token = crypt($t, '$6$'.$this->privateKey.'$');
+
+        return (object) [
+            'time'     => $time,
+            'token'    => $token,
+        ];
+    }
+
+    /**
+     * Extract address components in French or Dutch.
+     *
+     * @param string $providedBy
+     * @param object $feature
+     * @param string $language
+     */
+    private static function extractComponents(string $providedBy, object $feature, string $language)
+    {
+        $language = strtolower($language);
+        if (!in_array($language, ['fr', 'nl'])) {
+            throw new InvalidArgument('The Geo-6 POI provider only supports FR (French) and NL (Dutch).');
+        }
+
+        $coordinates = $feature->geometry->coordinates;
+
+        $source = $feature->properties->source;
+        $id = (string) $feature->properties->id;
+        $name = $feature->properties->{'name_'.$language};
+
+        foreach ($feature->properties->components as $component) {
+            switch ($component->type) {
+                case 'country':
+                    $country = $component->{'name_'.$language};
+                    // $countryCode = $component->id;
+                    break;
+                case 'locality':
+                    $locality = $component->{'name_'.$language};
+                    break;
+                case 'municipality':
+                    $municipality = $component->{'name_'.$language};
+                    break;
+                case 'postal_code':
+                    $postalCode = (string) $component->id;
+                    break;
+                case 'province':
+                    $province = $component->{'name_'.$language};
+                    break;
+                case 'region':
+                    $region = $component->{'name_'.$language};
+                    break;
+                case 'street':
+                    $streetName = $component->{'name_'.$language};
+                    break;
+                case 'street_number':
+                    $streetNumber = (string) $component->{'name_'.$language};
+                    break;
+                case 'location_type':
+                    $type = $component->{'name_'.$language};
+                    break;
+            }
+        }
+
+        if (isset($name) && !is_null($name)) {
+            $builder = new AddressBuilder($providedBy);
+            $builder
+                ->setCoordinates($coordinates[1], $coordinates[0])
+                ->setStreetNumber($streetNumber ?? null)
+                ->setStreetName($streetName ?? null)
+                ->setLocality($municipality ?? null)
+                ->setPostalCode($postalCode ?? null)
+                ->setSubLocality($locality ?? null)
+                ->setCountry($country ?? null)
+                ->setCountryCode($countryCode ?? null);
+
+            if (isset($municipality) && !is_null($municipality)) {
+                $builder->addAdminLevel(3, $municipality);
+            }
+            if (isset($region) && !is_null($region)) {
+                $builder->addAdminLevel(1, $region);
+            }
+            if (isset($province) && !is_null($province)) {
+                $builder->addAdminLevel(2, $province);
+            }
+
+            $poi = $builder->build(POI::class);
+            $poi = $poi
+                ->withSource($source)
+                ->withType($type)
+                ->withId($id)
+                ->withName($name);
+
+            return $poi;
+        }
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonathan Beliën
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.