Merge pull request #380 from toin0u/patch-provider-tests

Patch provider's tests

Author: willdurand

README.md

@@ -46,7 +46,7 @@ Provider  | Name | IPv4? | IPv6? | Terms | Notes
 [IpInfoDB](http://ipinfodb.com/)            | `ip_info_db` | yes | no | requires API key. | city precision
 Geoip | `geoip` | | | | wrapper around the [PHP extension](http://php.net/manual/en/book.geoip.php) which must be installed
 [MaxMind](https://www.maxmind.com/) web service | `maxmind` | yes | yes | requires Omni API key | City/ISP/Org and Omni services, IPv6 on country level
-MaxMind Binary file | `maxmind_binary` | yes | yes | | needs locally installed database files
+MaxMind Binary file | `maxmind_binary` | yes | no | | needs locally installed database files
 
 **Important:** the [Geocoder
 Extra](https://github.com/geocoder-php/geocoder-extra) library contains even
@@ -514,7 +514,6 @@ following lines and add your own API keys:
     <!-- <server name="GEOIPS_API_KEY" value="YOUR_API_KEY" /> -->
     <!-- <server name="MAXMIND_API_KEY" value="YOUR_API_KEY" /> -->
     <!-- <server name="GEONAMES_USERNAME" value="YOUR_USERNAME" /> -->
-    <!-- <server name="TOMTOM_GEOCODING_KEY" value="YOUR_GEOCODING_KEY" /> -->
     <!-- <server name="TOMTOM_MAP_KEY" value="YOUR_MAP_KEY" /> -->
     <!-- <server name="GOOGLE_GEOCODING_KEY" value="YOUR_GEOCODING_KEY" /> -->
     <!-- <server name="OPENCAGE_API_KEY" value="YOUR_API_KEY" /> -->

phpunit.xml.dist

@@ -24,7 +24,6 @@
         <!-- <server name="MAXMIND_API_KEY" value="YOUR_API_KEY" /> -->
         <!-- <server name="MAPQUEST_API_KEY" value="YOUR_API_KEY" /> -->
         <!-- <server name="GEONAMES_USERNAME" value="YOUR_USERNAME" /> -->
-        <!-- <server name="TOMTOM_GEOCODING_KEY" value="YOUR_GEOCODING_KEY" /> -->
         <!-- <server name="TOMTOM_MAP_KEY" value="YOUR_MAP_KEY" /> -->
         <!-- <server name="GOOGLE_GEOCODING_KEY" value="YOUR_GEOCODING_KEY" /> -->
         <!-- <server name="OPENCAGE_API_KEY" value="YOUR_GEOCODING_KEY" /> -->

src/Geocoder/Provider/AbstractProvider.php

@@ -111,4 +111,16 @@ protected function returnResults(array $data = [])
 
         return $this->factory->createFromArray($data);
     }
+
+    /**
+    * @param array $results
+    *
+    * @return array
+    */
+    protected function fixEncoding(array $results)
+    {
+        return array_map(function ($value) {
+            return is_string($value) ? utf8_encode($value) : $value;
+        }, $results);
+    }
 }

src/Geocoder/Provider/GeoIP2.php

@@ -64,7 +64,7 @@ public function geocode($address)
         }
 
         return $this->returnResults([
-            array_merge($this->getDefaults(), array(
+            $this->fixEncoding(array_merge($this->getDefaults(), array(
                 'countryCode' => (isset($result->country->iso_code) ? $result->country->iso_code : null),
                 'country'     => (isset($result->country->names->{$this->locale}) ? $result->country->names->{$this->locale} : null),
                 'locality'    => (isset($result->city->names->{$this->locale}) ? $result->city->names->{$this->locale} : null),
@@ -74,7 +74,7 @@ public function geocode($address)
                 'postalCode'  => (isset($result->location->postalcode) ? $result->location->postalcode : null),
                 'region'      => $region,
                 'regionCode'  => $regionCode
-            ))
+            )))
         ]);
     }
 

src/Geocoder/Provider/Geoip.php

@@ -58,7 +58,7 @@ public function geocode($address)
         $region   = @geoip_region_name_by_code($results['country_code'], $results['region']) ?: $results['region'];
 
         return $this->returnResults([
-            array_merge($this->getDefaults(), [
+            $this->fixEncoding(array_merge($this->getDefaults(), [
                 'latitude'    => $results['latitude'],
                 'longitude'   => $results['longitude'],
                 'locality'    => $results['city'],
@@ -68,7 +68,7 @@ public function geocode($address)
                 'country'     => $results['country_name'],
                 'countryCode' => $results['country_code'],
                 'timezone'    => $timezone,
-            ])
+            ]))
         ]);
     }
 

src/Geocoder/Provider/MaxMindBinary.php

@@ -60,6 +60,8 @@ public function __construct($datFile, $openFlag = null)
 
         $this->datFile  = $datFile;
         $this->openFlag = null === $openFlag ? GEOIP_STANDARD : $openFlag;
+
+        parent::__construct();
     }
 
     /**
@@ -68,7 +70,12 @@ public function __construct($datFile, $openFlag = null)
     public function geocode($address)
     {
         if (false === filter_var($address, FILTER_VALIDATE_IP)) {
-            throw new UnsupportedOperation('The MaxMindBinary does not support street addresses.');
+            throw new UnsupportedOperation('The MaxMindBinary provider does not support street addresses.');
+        }
+
+        // This API does not support IPv6
+        if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
+            throw new UnsupportedOperation('The MaxMindBinary provider does not support IPv6 addresses.');
         }
 
         $geoIp       = geoip_open($this->datFile, $this->openFlag);
@@ -81,14 +88,14 @@ public function geocode($address)
         }
 
         return $this->returnResults([
-            array_merge($this->getDefaults(), [
+            $this->fixEncoding(array_merge($this->getDefaults(), [
                 'countryCode' => $geoIpRecord->country_code,
                 'country'     => $geoIpRecord->country_name,
                 'region'      => $geoIpRecord->region,
                 'locality'    => $geoIpRecord->city,
                 'latitude'    => $geoIpRecord->latitude,
                 'longitude'   => $geoIpRecord->longitude,
-            ])
+            ]))
         ]);
     }
 

src/Geocoder/Provider/TomTom.php

@@ -23,7 +23,7 @@ class TomTom extends AbstractHttpProvider implements LocaleAwareProvider
     /**
      * @var string
      */
-    const GEOCODE_ENDPOINT_URL = 'https://api.tomtom.com/lbs/geocoding/geocode?key=%s&query=%s&maxResults=%d';
+    const GEOCODE_ENDPOINT_URL = 'https://api.tomtom.com/lbs/services/geocode/4/geocode?key=%s&query=%s&maxResults=%d';
 
     /**
      * @var string

tests/.cached_responses/007b18894c37cb365c2364dd1dad71b20e0e57dc

@@ -0,0 +1 @@
+s:789:"{"results":[{"locations":[{"latLng":{"lng":2.389089,"lat":48.863193},"adminArea4":"Paris","adminArea5Type":"City","adminArea4Type":"County","adminArea5":"Paris","street":"10 Avenue Gambetta","adminArea1":"FR","adminArea3":"Ile-de-France","type":"s","displayLatLng":{"lng":2.389089,"lat":48.863193},"linkId":0,"postalCode":"75020","sideOfStreet":"N","dragPoint":false,"adminArea1Type":"Country","geocodeQuality":"POINT","geocodeQualityCode":"P1CXX","adminArea3Type":"State"}],"providedLocation":{"location":"10 avenue Gambetta, Paris, France"}}],"options":{"ignoreLatLngInput":false,"maxResults":5,"thumbMaps":false},"info":{"copyright":{"text":"© 2014 MapQuest, Inc.","imageUrl":"http://api.mqcdn.com/res/mqlogo.gif","imageAltText":"© 2014 MapQuest, Inc."},"statuscode":0,"messages":[]}}";

tests/.cached_responses/0fe231d2d035e3995ca8781da2ed65f61cd7bc37

@@ -0,0 +1 @@
+s:2848:"{"authenticationResultCode":"ValidCredentials","brandLogoUri":"http:\/\/dev.virtualearth.net\/Branding\/logo_powered_by.png","copyright":"Copyright © 2014 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.","resourceSets":[{"estimatedTotal":3,"resources":[{"__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1","bbox":[48.859354042429317,2.3809438666389395,48.86707947757067,2.3966003933610596],"name":"10 Avenue Gambetta, 75020 Paris","point":{"type":"Point","coordinates":[48.863216759999993,2.3887721299999995]},"address":{"addressLine":"10 Avenue Gambetta","adminDistrict":"IdF","adminDistrict2":"Paris","countryRegion":"France","formattedAddress":"10 Avenue Gambetta, 75020 Paris","locality":"Paris","postalCode":"75020"},"confidence":"Medium","entityType":"Address","geocodePoints":[{"type":"Point","coordinates":[48.863216759999993,2.3887721299999995],"calculationMethod":"Interpolation","usageTypes":["Display","Route"]}],"matchCodes":["Ambiguous","Good"]},{"__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1","bbox":[48.809565092429317,2.3172171827738461,48.81729052757067,2.3328581572261538],"name":"10 Avenue Léon Gambetta, 92120 Montrouge","point":{"type":"Point","coordinates":[48.813427809999993,2.32503767]},"address":{"addressLine":"10 Avenue Léon Gambetta","adminDistrict":"IdF","adminDistrict2":"Hauts-de-Seine","countryRegion":"France","formattedAddress":"10 Avenue Léon Gambetta, 92120 Montrouge","locality":"Montrouge","postalCode":"92120"},"confidence":"Medium","entityType":"Address","geocodePoints":[{"type":"Point","coordinates":[48.813427809999993,2.32503767],"calculationMethod":"Interpolation","usageTypes":["Display","Route"]}],"matchCodes":["Ambiguous","Good"]},{"__type":"Location:http:\/\/schemas.microsoft.com\/search\/local\/ws\/rest\/v1","bbox":[48.806278752429328,2.4278605052896745,48.814004187570681,2.4435004547103261],"name":"10 Avenue Gambetta, 94700 Maisons-Alfort","point":{"type":"Point","coordinates":[48.810141470000005,2.4356804800000003]},"address":{"addressLine":"10 Avenue Gambetta","adminDistrict":"IdF","adminDistrict2":"Val-de-Marne","countryRegion":"France","formattedAddress":"10 Avenue Gambetta, 94700 Maisons-Alfort","locality":"Maisons-Alfort","postalCode":"94700"},"confidence":"Medium","entityType":"Address","geocodePoints":[{"type":"Point","coordinates":[48.810141470000005,2.4356804800000003],"calculationMethod":"Interpolation","usageTypes":["Display","Route"]}],"matchCodes":["Ambiguous","Good"]}]}],"statusCode":200,"statusDescription":"OK","traceId":"5af34e133a3d45a6b2f0382052ed8367|DB40051321|02.00.108.1000|DB4SCH010060660, DB4SCH010070350"}";

tests/.cached_responses/1dac1d346611ac8378808669fad531fcc546e3c2

@@ -1 +1 @@
-s:334:"{"address":{"Address":"3 Avenue Gambetta","Neighborhood":"20e Arrondissement","City":"Paris","Subregion":"Paris","Region":"Île-de-France","Postal":"75020","PostalExt":null,"CountryCode":"FRA","Loc_name":"FRA.PointAddress"},"location":{"x":2.3890231620189906,"y":48.863306965889223,"spatialReference":{"wkid":4326,"latestWkid":4326}}}";
+s:350:"{"address":{"Address":"3 Avenue Gambetta","Neighborhood":null,"City":"Paris","Subregion":null,"Region":null,"Postal":"75020","PostalExt":null,"CountryCode":"FRA","Match_addr":"3 Avenue Gambetta, 75020, Paris","Loc_name":"FRA.PointAddress"},"location":{"x":2.3890231620189906,"y":48.863307030162396,"spatialReference":{"wkid":4326,"latestWkid":4326}}}";