fix: bring back free geo ip provider (#1010)

atymic · jbelien · commit d8cc1f7afebe · 2019-09-13T08:49:04.000+02:00
diff --git a/src/Provider/FreeGeoIp/FreeGeoIp.php b/src/Provider/FreeGeoIp/FreeGeoIp.php
@@ -13,7 +13,6 @@
 namespace Geocoder\Provider\FreeGeoIp;
 
 use Geocoder\Collection;
-use Geocoder\Exception\InvalidArgument;
 use Geocoder\Exception\UnsupportedOperation;
 use Geocoder\Model\AddressBuilder;
 use Geocoder\Model\AddressCollection;
@@ -37,7 +36,7 @@ final class FreeGeoIp extends AbstractHttpProvider implements Provider
      * @param HttpClient $client
      * @param string     $baseUrl
      */
-    public function __construct(HttpClient $client, string $baseUrl = null)
+    public function __construct(HttpClient $client, string $baseUrl = 'https://freegeoip.app/json/%s')
     {
         parent::__construct($client);
 
@@ -49,15 +48,8 @@ public function __construct(HttpClient $client, string $baseUrl = null)
      */
     public function geocodeQuery(GeocodeQuery $query): Collection
     {
-        if (null === $this->baseUrl) {
-            throw new InvalidArgument(sprintf(
-                'The FreeGeoIp.net service no longer operates. See %s and %s for more information.',
-                'http://freegeoip.net/shutdown',
-                'https://github.com/geocoder-php/free-geoip-provider'
-            ));
-        }
-
         $address = $query->getText();
+
         if (!filter_var($address, FILTER_VALIDATE_IP)) {
             throw new UnsupportedOperation('The FreeGeoIp provider does not support street addresses.');
         }
diff --git a/src/Provider/FreeGeoIp/Readme.md b/src/Provider/FreeGeoIp/Readme.md
@@ -10,25 +10,30 @@
 This is the Free GeoIp provider from the PHP Geocoder. This is a **READ ONLY** repository. See the
 [main repo](https://github.com/geocoder-php/Geocoder) for information and documentation. 
 
-## Freegeoip Shutdown
-As per the [freegeoip.net](http://freegeoip.net/shutdown) website, the provider has been purchased by [IpStack](https://ipstack.com/).
-As a result, this provider no longer works with the default configuration. It will still work if you use the 
-[self hosted variant](https://github.com/apilayer/freegeoip/) and supply a host when constructing the provider.
+Provider Website: https://freegeoip.app
 
 ## Usage
 ```php
 $httpClient = new \Http\Adapter\Guzzle6\Client();
 
-// This will no longer work
+// Use the default provider (https://freegeoip.app)
 $provider = new Geocoder\Provider\FreeGeoIp\FreeGeoIp($httpClient);
-// You must provide the endpoint of your instance 
+// Or provide the endpoint of your instance 
 $provider = new Geocoder\Provider\FreeGeoIp\FreeGeoIp($httpClient, 'http://my.internal.geocoder/json/%s');
 ```
 
-## Alternatives
+## Freegeoip.net shutdown
+As per the [freegeoip.net](http://freegeoip.net/shutdown) website, the provider has been purchased by [IpStack](https://ipstack.com/).
+As a result, this provider no longer uses this service with the default configuration.
+
+By default, it will now use `freegeoip.app` (which provides a hosted version of the same API as `freegeoip.net`).
+
+You can also use the [self hosted variant](https://github.com/apilayer/freegeoip/) and supply a host when constructing the provider.
+
+### Alternatives
 We offer an [IpStack provider](https://github.com/geocoder-php/ipstack-provider) which you can use if you wish to continue with the new service owner.
 
-### Full IP Provider List
+#### Full IP Provider List
 https://github.com/geocoder-php/Geocoder#ip
 
 ## Install
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_287e2fc601183d3c64eb06780ebdf06e6eff2a0f b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_287e2fc601183d3c64eb06780ebdf06e6eff2a0f
@@ -0,0 +1,2 @@
+s:190:"{"ip":"2001:db8:0:42:0:8a2e:370:7334","country_code":"","country_name":"","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"","latitude":0,"longitude":0,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_2a61928234649892f83eabb3b84bbaf9d8bfc3c0 b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_2a61928234649892f83eabb3b84bbaf9d8bfc3c0
@@ -0,0 +1,2 @@
+s:230:"{"ip":"83.227.123.8","country_code":"SE","country_name":"Sweden","region_code":"K","region_name":"Blekinge","city":"Naettraby","zip_code":"370 24","time_zone":"Europe/Stockholm","latitude":56.2,"longitude":15.5167,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_52f2739d0d293189ed31683f58998ad875f51da4 b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_52f2739d0d293189ed31683f58998ad875f51da4
@@ -0,0 +1,2 @@
+s:209:"{"ip":"87.227.124.53","country_code":"SE","country_name":"Sweden","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"Europe/Stockholm","latitude":59.3247,"longitude":18.056,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_5cf1bc787ac59f3086a117f62b2311ad1ccfbc1f b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_5cf1bc787ac59f3086a117f62b2311ad1ccfbc1f
@@ -0,0 +1,2 @@
+s:235:"{"ip":"129.67.242.154","country_code":"GB","country_name":"United Kingdom","region_code":"ENG","region_name":"England","city":"Oxford","zip_code":"OX1","time_zone":"Europe/London","latitude":51.7155,"longitude":-1.2926,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_71db954a7fb3c6e841d92b1614d26a6dea5db1f4 b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_71db954a7fb3c6e841d92b1614d26a6dea5db1f4
@@ -0,0 +1,2 @@
+s:274:"{"ip":"81.27.51.253","country_code":"RU","country_name":"Россия","region_code":"VLA","region_name":"Владимирская область","city":"Владимир","zip_code":"601280","time_zone":"Europe/Moscow","latitude":56.1833,"longitude":40.35,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_943e3e292f951716af133cde8f71bb30874b788f b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_943e3e292f951716af133cde8f71bb30874b788f
@@ -0,0 +1,2 @@
+s:215:"{"ip":"74.200.247.59","country_code":"US","country_name":"United States","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"America/Chicago","latitude":37.751,"longitude":-97.822,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_ac8a572613ac63c600a7aebca4f0ddc09e31f535 b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_ac8a572613ac63c600a7aebca4f0ddc09e31f535
@@ -0,0 +1,2 @@
+s:215:"{"ip":"74.200.247.59","country_code":"US","country_name":"United States","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"America/Chicago","latitude":37.751,"longitude":-97.822,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_b2b556319d2fd93829588a8569762f595b685472 b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_b2b556319d2fd93829588a8569762f595b685472
@@ -0,0 +1,2 @@
+s:239:"{"ip":"81.27.51.252","country_code":"RU","country_name":"Russie","region_code":"VLA","region_name":"Oblast de Vladimir","city":"Vladimir","zip_code":"601280","time_zone":"Europe/Moscow","latitude":56.1833,"longitude":40.35,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_cb0e9ad847c41bd2f2a34b3b04b91e728332135c b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_cb0e9ad847c41bd2f2a34b3b04b91e728332135c
@@ -0,0 +1,2 @@
+s:242:"{"ip":"81.27.51.251","country_code":"RU","country_name":"Russia","region_code":"VLA","region_name":"Vladimirskaya Oblast'","city":"Vladimir","zip_code":"601280","time_zone":"Europe/Moscow","latitude":56.1833,"longitude":40.35,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_e213dd6ed4bc8e27b4f8e1284cf60838a36e44ab b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_e213dd6ed4bc8e27b4f8e1284cf60838a36e44ab
@@ -0,0 +1,2 @@
+s:235:"{"ip":"129.67.242.154","country_code":"GB","country_name":"United Kingdom","region_code":"ENG","region_name":"England","city":"Oxford","zip_code":"OX1","time_zone":"Europe/London","latitude":51.7155,"longitude":-1.2926,"metro_code":0}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_ffabd31de5b91b170eb6751e7df604f79a5755f4 b/src/Provider/FreeGeoIp/Tests/.cached_responses/freegeoip.app_ffabd31de5b91b170eb6751e7df604f79a5755f4
@@ -0,0 +1,2 @@
+s:243:"{"ip":"72.229.28.185","country_code":"US","country_name":"United States","region_code":"NY","region_name":"New York","city":"New York","zip_code":"10009","time_zone":"America/New_York","latitude":40.7263,"longitude":-73.9819,"metro_code":501}
+";
diff --git a/src/Provider/FreeGeoIp/Tests/FreeGeoIpTest.php b/src/Provider/FreeGeoIp/Tests/FreeGeoIpTest.php
@@ -14,9 +14,9 @@
 
 use Geocoder\IntegrationTest\BaseTestCase;
 use Geocoder\Location;
+use Geocoder\Provider\FreeGeoIp\FreeGeoIp;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\ReverseQuery;
-use Geocoder\Provider\FreeGeoIp\FreeGeoIp;
 
 class FreeGeoIpTest extends BaseTestCase
 {
@@ -73,8 +73,6 @@ public function testGeocodeWithLocalhostIPv6()
 
     public function testGeocodeWithRealIPv4()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('74.200.247.59'));
 
@@ -84,20 +82,14 @@ public function testGeocodeWithRealIPv4()
         /** @var Location $result */
         $result = $results->first();
         $this->assertInstanceOf('\Geocoder\Model\Address', $result);
-        $this->assertEquals(33.0347, $result->getCoordinates()->getLatitude(), '', 0.01);
-        $this->assertEquals(-96.8134, $result->getCoordinates()->getLongitude(), '', 0.01);
-        $this->assertEquals(75093, $result->getPostalCode());
-        $this->assertEquals('Plano', $result->getLocality());
-        $this->assertCount(1, $result->getAdminLevels());
-        $this->assertEquals('Texas', $result->getAdminLevels()->get(1)->getName());
+        $this->assertEquals(37.751, $result->getCoordinates()->getLatitude(), '', 0.01);
+        $this->assertEquals(-97.822, $result->getCoordinates()->getLongitude(), '', 0.01);
         $this->assertEquals('United States', $result->getCountry()->getName());
         $this->assertEquals('US', $result->getCountry()->getCode());
     }
 
     public function testGeocodeWithRealIPv6()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('::ffff:74.200.247.59'));
 
@@ -107,48 +99,54 @@ public function testGeocodeWithRealIPv6()
         /** @var Location $result */
         $result = $results->first();
         $this->assertInstanceOf('\Geocoder\Model\Address', $result);
-        $this->assertEquals(33.0347, $result->getCoordinates()->getLatitude(), '', 0.01);
-        $this->assertEquals(-96.8134, $result->getCoordinates()->getLongitude(), '', 0.01);
-        $this->assertEquals(75093, $result->getPostalCode());
-        $this->assertEquals('Plano', $result->getLocality());
-        $this->assertCount(1, $result->getAdminLevels());
-        $this->assertEquals('Texas', $result->getAdminLevels()->get(1)->getName());
+
+        $this->assertEquals(37.751, $result->getCoordinates()->getLatitude(), '', 0.01);
+        $this->assertEquals(-97.822, $result->getCoordinates()->getLongitude(), '', 0.01);
         $this->assertEquals('United States', $result->getCountry()->getName());
         $this->assertEquals('US', $result->getCountry()->getCode());
     }
 
     public function testGeocodeWithUSIPv4()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
-        $results = $provider->geocodeQuery(GeocodeQuery::create('74.200.247.59'));
+        $results = $provider->geocodeQuery(GeocodeQuery::create('72.229.28.185'));
 
         $this->assertInstanceOf('Geocoder\Model\AddressCollection', $results);
         $this->assertCount(1, $results);
 
-        $this->assertCount(1, $results->first()->getAdminLevels());
-        $this->assertEquals('TX', $results->first()->getAdminLevels()->get(1)->getCode());
+        /** @var Location $result */
+        $result = $results->first();
+        $this->assertInstanceOf('\Geocoder\Model\Address', $result);
+
+        $this->assertEquals(40.7263, $result->getCoordinates()->getLatitude(), '', 0.01);
+        $this->assertEquals(-73.9819, $result->getCoordinates()->getLongitude(), '', 0.01);
+        $this->assertCount(1, $result->getAdminLevels());
+        $this->assertEquals('New York', $result->getAdminLevels()->get(1)->getName());
+        $this->assertEquals('NY', $result->getAdminLevels()->get(1)->getCode());
+        $this->assertEquals('United States', $result->getCountry()->getName());
+        $this->assertEquals('US', $result->getCountry()->getCode());
+        $this->assertEquals('10009', $result->getPostalCode());
+        $this->assertEquals('America/New_York', $result->getTimezone());
     }
 
     public function testGeocodeWithUSIPv6()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('::ffff:74.200.247.59'));
 
         $this->assertInstanceOf('Geocoder\Model\AddressCollection', $results);
         $this->assertCount(1, $results);
 
-        $this->assertCount(1, $results->first()->getAdminLevels());
-        $this->assertEquals('TX', $results->first()->getAdminLevels()->get(1)->getCode());
+        /** @var Location $result */
+        $result = $results->first();
+        $this->assertInstanceOf('\Geocoder\Model\Address', $result);
+
+        $this->assertEquals('United States', $result->getCountry()->getName());
+        $this->assertEquals('US', $result->getCountry()->getCode());
     }
 
     public function testGeocodeWithUKIPv4()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('129.67.242.154'));
 
@@ -158,12 +156,11 @@ public function testGeocodeWithUKIPv4()
 
         $this->assertCount(1, $results->first()->getAdminLevels());
         $this->assertEquals('ENG', $results->first()->getAdminLevels()->get(1)->getCode());
+        $this->assertEquals('Oxford', $results->first()->getLocality());
     }
 
     public function testGeocodeWithUKIPv6()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('::ffff:129.67.242.154'));
 
@@ -174,8 +171,6 @@ public function testGeocodeWithUKIPv6()
 
     public function testGeocodeWithRuLocale()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('81.27.51.253')->withLocale('ru'));
 
@@ -188,8 +183,6 @@ public function testGeocodeWithRuLocale()
 
     public function testGeocodeWithFrLocale()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('81.27.51.252')->withLocale('fr'));
 
@@ -202,8 +195,6 @@ public function testGeocodeWithFrLocale()
 
     public function testGeocodeWithIncorrectLocale()
     {
-        $this->markTestSkipped('Web service no longer operating');
-
         $provider = $this->getProvider();
         $results = $provider->geocodeQuery(GeocodeQuery::create('81.27.51.251')->withLocale('wrong_locale'));
 
@@ -229,12 +220,12 @@ public function testReverse()
      */
     public function testServerEmptyResponse()
     {
-        $provider = $this->getProvider();
+        $provider = new FreeGeoIp($this->getMockedHttpClient());
         $provider->geocodeQuery(GeocodeQuery::create('87.227.124.53'));
     }
 
     private function getProvider(): FreeGeoIp
     {
-        return new FreeGeoIp($this->getMockedHttpClient(), 'https://internal.geocoder/json/%s');
+        return new FreeGeoIp($this->getHttpClient('api_key'));
     }
 }
diff --git a/src/Provider/FreeGeoIp/Tests/IntegrationTest.php b/src/Provider/FreeGeoIp/Tests/IntegrationTest.php
@@ -23,21 +23,11 @@ class IntegrationTest extends ProviderIntegrationTest
 {
     protected $testAddress = false;
 
-    /**
-     * @var bool Web service no longer operating
-     */
-    protected $testIpv4 = false;
-
-    /**
-     * @var bool Web service no longer operating
-     */
-    protected $testIpv6 = false;
-
     protected $testReverse = false;
 
     protected function createProvider(HttpClient $httpClient)
     {
-        return new FreeGeoIp($httpClient, 'https://internal.geocoder/json/%s');
+        return new FreeGeoIp($httpClient);
     }
 
     protected function getCacheDir()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:190:"{"ip":"2001:db8:0:42:0:8a2e:370:7334","country_code":"","country_name":"","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"","latitude":0,"longitude":0,"metro_code":0}`
	`2`	`+";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:230:"{"ip":"83.227.123.8","country_code":"SE","country_name":"Sweden","region_code":"K","region_name":"Blekinge","city":"Naettraby","zip_code":"370 24","time_zone":"Europe/Stockholm","latitude":56.2,"longitude":15.5167,"metro_code":0}`
	`2`	`+";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:209:"{"ip":"87.227.124.53","country_code":"SE","country_name":"Sweden","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"Europe/Stockholm","latitude":59.3247,"longitude":18.056,"metro_code":0}`
	`2`	`+";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:235:"{"ip":"129.67.242.154","country_code":"GB","country_name":"United Kingdom","region_code":"ENG","region_name":"England","city":"Oxford","zip_code":"OX1","time_zone":"Europe/London","latitude":51.7155,"longitude":-1.2926,"metro_code":0}`
	`2`	`+";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:274:"{"ip":"81.27.51.253","country_code":"RU","country_name":"Россия","region_code":"VLA","region_name":"Владимирская область","city":"Владимир","zip_code":"601280","time_zone":"Europe/Moscow","latitude":56.1833,"longitude":40.35,"metro_code":0}`
	`2`	`+";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:215:"{"ip":"74.200.247.59","country_code":"US","country_name":"United States","region_code":"","region_name":"","city":"","zip_code":"","time_zone":"America/Chicago","latitude":37.751,"longitude":-97.822,"metro_code":0}`
	`2`	`+";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+s:239:"{"ip":"81.27.51.252","country_code":"RU","country_name":"Russie","region_code":"VLA","region_name":"Oblast de Vladimir","city":"Vladimir","zip_code":"601280","time_zone":"Europe/Moscow","latitude":56.1833,"longitude":40.35,"metro_code":0}`
	`2`	`+";`