Finalize the providers (#540)

unkind · Nyholm · commit 9c8745717ee7 · 2016-10-14T09:49:21.000+02:00
diff --git a/src/Geocoder/Provider/ArcGISOnline.php b/src/Geocoder/Provider/ArcGISOnline.php
@@ -17,7 +17,7 @@
 /**
  * @author ALKOUM Dorian <baikunz@gmail.com>
  */
-class ArcGISOnline extends AbstractHttpProvider implements Provider
+final class ArcGISOnline extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/BingMaps.php b/src/Geocoder/Provider/BingMaps.php
@@ -18,7 +18,7 @@
 /**
  * @author David Guyon <dguyon@gmail.com>
  */
-class BingMaps extends AbstractHttpProvider implements LocaleAwareProvider
+final class BingMaps extends AbstractHttpProvider implements LocaleAwareProvider
 {
     use LocaleTrait;
 
diff --git a/src/Geocoder/Provider/Chain.php b/src/Geocoder/Provider/Chain.php
@@ -16,7 +16,7 @@
 /**
  * @author Markus Bachmann <markus.bachmann@bachi.biz>
  */
-class Chain implements LocaleAwareProvider
+final class Chain implements LocaleAwareProvider
 {
     use LocaleTrait;
 
diff --git a/src/Geocoder/Provider/FreeGeoIp.php b/src/Geocoder/Provider/FreeGeoIp.php
@@ -17,7 +17,7 @@
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-class FreeGeoIp extends AbstractHttpProvider implements Provider
+final class FreeGeoIp extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/GeoIP2.php b/src/Geocoder/Provider/GeoIP2.php
@@ -18,7 +18,7 @@
 /**
  * @author Jens Wiese <jens@howtrueisfalse.de>
  */
-class GeoIP2 extends AbstractProvider implements LocaleAwareProvider
+final class GeoIP2 extends AbstractProvider implements LocaleAwareProvider
 {
     use LocaleTrait;
 
diff --git a/src/Geocoder/Provider/GeoIPs.php b/src/Geocoder/Provider/GeoIPs.php
@@ -23,7 +23,7 @@
  *
  * @link http://www.geoips.com/en/developer/api-guide
  */
-class GeoIPs extends AbstractHttpProvider implements Provider
+final class GeoIPs extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/GeoPlugin.php b/src/Geocoder/Provider/GeoPlugin.php
@@ -16,7 +16,7 @@
 /**
  * @author Andrea Cristaudo <andrea.cristaudo@gmail.com>
  */
-class GeoPlugin extends AbstractHttpProvider implements Provider
+final class GeoPlugin extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/Geoip.php b/src/Geocoder/Provider/Geoip.php
@@ -19,7 +19,7 @@
  *
  * @link http://php.net/manual/ref.geoip.php
  */
-class Geoip extends AbstractProvider implements Provider
+final class Geoip extends AbstractProvider implements Provider
 {
     public function __construct()
     {
diff --git a/src/Geocoder/Provider/Geonames.php b/src/Geocoder/Provider/Geonames.php
@@ -19,7 +19,7 @@
 /**
  * @author Giovanni Pirrotta <giovanni.pirrotta@gmail.com>
  */
-class Geonames extends AbstractHttpProvider implements LocaleAwareProvider
+final class Geonames extends AbstractHttpProvider implements LocaleAwareProvider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/GoogleMaps.php b/src/Geocoder/Provider/GoogleMaps.php
@@ -20,7 +20,7 @@
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-class GoogleMaps extends AbstractHttpProvider implements LocaleAwareProvider
+final class GoogleMaps extends AbstractHttpProvider implements LocaleAwareProvider
 {
     /**
      * @var string
@@ -49,6 +49,38 @@ class GoogleMaps extends AbstractHttpProvider implements LocaleAwareProvider
      */
     private $apiKey;
 
+    /**
+     * @var string
+     */
+    private $clientId;
+
+    /**
+     * @var string
+     */
+    private $privateKey;
+
+    /**
+     * Google Maps for Business
+     * https://developers.google.com/maps/documentation/business/
+     *
+     * @param HttpClient $client An HTTP adapter
+     * @param string     $clientId Your Client ID
+     * @param string     $privateKey Your Private Key (optional)
+     * @param string     $locale A locale (optional)
+     * @param string     $region Region biasing (optional)
+     * @param bool       $useSsl Whether to use an SSL connection (optional)
+     * @param string     $apiKey Google Geocoding API key (optional)
+     * @return GoogleMaps
+     */
+    public static function business(HttpClient $client, $clientId, $privateKey = null, $locale = null, $region = null, $useSsl = false, $apiKey = null)
+    {
+        $provider = new self($client, $locale, $region, $useSsl, $apiKey);
+        $provider->clientId = $clientId;
+        $provider->privateKey = $privateKey;
+
+        return $provider;
+    }
+
     /**
      * @param HttpClient $client An HTTP adapter
      * @param string     $locale A locale (optional)
@@ -113,7 +145,7 @@ public function setRegion($region)
      *
      * @return string query with extra params
      */
-    protected function buildQuery($query)
+    private function buildQuery($query)
     {
         if (null !== $this->getLocale()) {
             $query = sprintf('%s&language=%s', $query, $this->getLocale());
@@ -127,6 +159,14 @@ protected function buildQuery($query)
             $query = sprintf('%s&key=%s', $query, $this->apiKey);
         }
 
+        if (null !== $this->clientId) {
+            $query = sprintf('%s&client=%s', $query, $this->clientId);
+
+            if (null !== $this->privateKey) {
+                $query = $this->signQuery($query);
+            }
+        }
+
         return $query;
     }
 
@@ -269,4 +309,31 @@ private function updateAddressComponent(&$resultSet, $type, $values)
 
         return $resultSet;
     }
+    
+    /**
+     * Sign a URL with a given crypto key
+     * Note that this URL must be properly URL-encoded
+     * src: http://gmaps-samples.googlecode.com/svn/trunk/urlsigning/UrlSigner.php-source
+     *
+     * @param string $query Query to be signed
+     *
+     * @return string $query Query with signature appended.
+     */
+    private function signQuery($query)
+    {
+        $url = parse_url($query);
+
+        $urlPartToSign = $url['path'] . '?' . $url['query'];
+
+        // Decode the private key into its binary format
+        $decodedKey = base64_decode(str_replace(array('-', '_'), array('+', '/'), $this->privateKey));
+
+        // Create a signature using the private key and the URL-encoded
+        // string using HMAC SHA1. This signature will be binary.
+        $signature = hash_hmac('sha1', $urlPartToSign, $decodedKey, true);
+
+        $encodedSignature = str_replace(array('+', '/'), array('-', '_'), base64_encode($signature));
+
+        return sprintf('%s&signature=%s', $query, $encodedSignature);
+    }
 }
diff --git a/src/Geocoder/Provider/GoogleMapsBusiness.php b/src/Geocoder/Provider/GoogleMapsBusiness.php
diff --git a/src/Geocoder/Provider/HostIp.php b/src/Geocoder/Provider/HostIp.php
@@ -16,7 +16,7 @@
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-class HostIp extends AbstractHttpProvider implements Provider
+final class HostIp extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/IpInfoDb.php b/src/Geocoder/Provider/IpInfoDb.php
@@ -19,7 +19,7 @@
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-class IpInfoDb extends AbstractHttpProvider implements Provider
+final class IpInfoDb extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/MapQuest.php b/src/Geocoder/Provider/MapQuest.php
@@ -18,7 +18,7 @@
 /**
  * @author William Durand <william.durand1@gmail.com>
  */
-class MapQuest extends AbstractHttpProvider implements Provider
+final class MapQuest extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/Mapzen.php b/src/Geocoder/Provider/Mapzen.php
@@ -18,7 +18,7 @@
 /**
  * @author Gary Gale <gary@vicchi.org>
  */
-class Mapzen extends AbstractHttpProvider
+final class Mapzen extends AbstractHttpProvider
 {
     /**
      * @var string
@@ -69,7 +69,7 @@ public function geocode($address)
 
         $query = sprintf(self::GEOCODE_ENDPOINT_URL, $this->scheme, urlencode($address), $this->apiKey, $this->getLimit());
 
-            return $this->executeQuery($query);
+        return $this->executeQuery($query);
     }
 
     /**
diff --git a/src/Geocoder/Provider/MaxMind.php b/src/Geocoder/Provider/MaxMind.php
@@ -18,7 +18,7 @@
 /**
  * @author Andrea Cristaudo <andrea.cristaudo@gmail.com>
  */
-class MaxMind extends AbstractHttpProvider implements Provider
+final class MaxMind extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string Country, City, ISP and Organization
diff --git a/src/Geocoder/Provider/MaxMindBinary.php b/src/Geocoder/Provider/MaxMindBinary.php
@@ -15,7 +15,7 @@
 use Geocoder\Exception\NoResult;
 use Geocoder\Exception\UnsupportedOperation;
 
-class MaxMindBinary extends AbstractProvider implements Provider
+final class MaxMindBinary extends AbstractProvider implements Provider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/Nominatim.php b/src/Geocoder/Provider/Nominatim.php
@@ -17,7 +17,7 @@
 /**
  * @author Niklas Närhinen <niklas@narhinen.net>
  */
-class Nominatim extends AbstractHttpProvider implements LocaleAwareProvider
+final class Nominatim extends AbstractHttpProvider implements LocaleAwareProvider
 {
     use LocaleTrait;
 
@@ -26,6 +26,16 @@ class Nominatim extends AbstractHttpProvider implements LocaleAwareProvider
      */
     private $rootUrl;
 
+    /**
+     * @param HttpClient  $client
+     * @param string|null $locale
+     * @return Nominatim
+     */
+    public static function withOpenStreetMapServer(HttpClient $client, $locale = null)
+    {
+        return new self($client, 'http://nominatim.openstreetmap.org', $locale);
+    }
+
     /**
      * @param HttpClient $client  An HTTP adapter.
      * @param string     $rootUrl Root URL of the nominatim server
diff --git a/src/Geocoder/Provider/OpenCage.php b/src/Geocoder/Provider/OpenCage.php
@@ -18,7 +18,7 @@
 /**
  * @author mtm <mtm@opencagedata.com>
  */
-class OpenCage extends AbstractHttpProvider implements LocaleAwareProvider
+final class OpenCage extends AbstractHttpProvider implements LocaleAwareProvider
 {
     /**
      * @var string
diff --git a/src/Geocoder/Provider/OpenStreetMap.php b/src/Geocoder/Provider/OpenStreetMap.php
diff --git a/src/Geocoder/Provider/TomTom.php b/src/Geocoder/Provider/TomTom.php
diff --git a/src/Geocoder/Provider/Yandex.php b/src/Geocoder/Provider/Yandex.php
diff --git a/tests/Geocoder/Tests/Provider/GoogleMapsBusinessTest.php b/tests/Geocoder/Tests/Provider/GoogleMapsBusinessTest.php
diff --git a/tests/Geocoder/Tests/Provider/GoogleMapsTest.php b/tests/Geocoder/Tests/Provider/GoogleMapsTest.php
diff --git a/tests/Geocoder/Tests/Provider/NominatimTest.php b/tests/Geocoder/Tests/Provider/NominatimTest.php
diff --git a/tests/Geocoder/Tests/Provider/OpenCageTest.php b/tests/Geocoder/Tests/Provider/OpenCageTest.php
diff --git a/tests/Geocoder/Tests/TestCase.php b/tests/Geocoder/Tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`/**`
`18`	`18`	`* @author ALKOUM Dorian <[email protected]>`
`19`	`19`	`*/`
`20`		`-class ArcGISOnline extends AbstractHttpProvider implements Provider`
	`20`	`+final class ArcGISOnline extends AbstractHttpProvider implements Provider`
`21`	`21`	`{`
`22`	`22`	`/**`
`23`	`23`	`* @var string`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`/**`
`19`	`19`	`* @author David Guyon <[email protected]>`
`20`	`20`	`*/`
`21`		`-class BingMaps extends AbstractHttpProvider implements LocaleAwareProvider`
	`21`	`+final class BingMaps extends AbstractHttpProvider implements LocaleAwareProvider`
`22`	`22`	`{`
`23`	`23`	`use LocaleTrait;`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`/**`
`17`	`17`	`* @author Markus Bachmann <[email protected]>`
`18`	`18`	`*/`
`19`		`-class Chain implements LocaleAwareProvider`
	`19`	`+final class Chain implements LocaleAwareProvider`
`20`	`20`	`{`
`21`	`21`	`use LocaleTrait;`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @link http://www.geoips.com/en/developer/api-guide`
`25`	`25`	`*/`
`26`		`-class GeoIPs extends AbstractHttpProvider implements Provider`
	`26`	`+final class GeoIPs extends AbstractHttpProvider implements Provider`
`27`	`27`	`{`
`28`	`28`	`/**`
`29`	`29`	`* @var string`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*`
`20`	`20`	`* @link http://php.net/manual/ref.geoip.php`
`21`	`21`	`*/`
`22`		`-class Geoip extends AbstractProvider implements Provider`
	`22`	`+final class Geoip extends AbstractProvider implements Provider`
`23`	`23`	`{`
`24`	`24`	`public function __construct()`
`25`	`25`	`{`