fix: update freegeoip post-shutdown (#1002)

* fix: update freegeoip post-shutdown

* chore: fixing tests

* chore: docs update

Author: atymic

src/Provider/FreeGeoIp/FreeGeoIp.php

@@ -13,6 +13,7 @@
 namespace Geocoder\Provider\FreeGeoIp;
 
 use Geocoder\Collection;
+use Geocoder\Exception\InvalidArgument;
 use Geocoder\Exception\UnsupportedOperation;
 use Geocoder\Model\AddressBuilder;
 use Geocoder\Model\AddressCollection;
@@ -28,15 +29,15 @@
 final class FreeGeoIp extends AbstractHttpProvider implements Provider
 {
     /**
-     * @var string
+     * @var string|null
      */
     private $baseUrl;
 
     /**
      * @param HttpClient $client
      * @param string     $baseUrl
      */
-    public function __construct(HttpClient $client, string $baseUrl = 'https://freegeoip.net/json/%s')
+    public function __construct(HttpClient $client, string $baseUrl = null)
     {
         parent::__construct($client);
 
@@ -48,6 +49,14 @@ public function __construct(HttpClient $client, string $baseUrl = 'https://freeg
      */
     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.');

src/Provider/FreeGeoIp/Readme.md

@@ -10,13 +10,34 @@
 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. 
 
-### Install
+## 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.
+
+## Usage
+```php
+$httpClient = new \Http\Adapter\Guzzle6\Client();
+
+// This will no longer work
+$provider = new Geocoder\Provider\FreeGeoIp\FreeGeoIp($httpClient);
+// You must provide the endpoint of your instance 
+$provider = new Geocoder\Provider\FreeGeoIp\FreeGeoIp($httpClient, 'http://my.internal.geocoder/json/%s');
+```
+
+## 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
+https://github.com/geocoder-php/Geocoder#ip
+
+## Install
 
 ```bash
 composer require geocoder-php/free-geoip-provider
 ```
 
-### Contribute
+## Contribute
 
 Contributions are very welcome! Send a pull request to the [main repository](https://github.com/geocoder-php/Geocoder) or 
 report any issues you find on the [issue tracker](https://github.com/geocoder-php/Geocoder/issues).