chore(provider): deprecate mapzen provider

geocoder-php · May 31, 2019 · 8f9f8bc · 8f9f8bc
1 parent 85979da
commit 8f9f8bc
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -132,7 +132,6 @@ Provider       | Package | Features | Stats
 [LocationIQ](https://github.com/geocoder-php/locationiq-provider) | `geocoder-php/locationiq-provider` | address, reverse <br> [Website](https://locationiq.org/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/locationiq-provider/v/stable)](https://packagist.org/packages/geocoder-php/locationiq-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/locationiq-provider/downloads)](https://packagist.org/packages/geocoder-php/locationiq-provider)
 [Mapbox](https://github.com/geocoder-php/mapbox-provider) | `geocoder-php/mapbox-provider` | address, reverse <br> [Website](https://www.mapbox.com/geocoding/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/mapbox-provider/v/stable)](https://packagist.org/packages/geocoder-php/mapbox-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/mapbox-provider/downloads)](https://packagist.org/packages/geocoder-php/mapbox-provider)
 [MapQuest](https://github.com/geocoder-php/mapquest-provider) | `geocoder-php/mapquest-provider` | address, reverse <br> [Website](http://developer.mapquest.com/web/products/dev-services/geocoding-ws) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/mapquest-provider/v/stable)](https://packagist.org/packages/geocoder-php/mapquest-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/mapquest-provider/downloads)](https://packagist.org/packages/geocoder-php/mapquest-provider)
-[Mapzen](https://github.com/geocoder-php/mapzen-provider) | `geocoder-php/mapzen-provider` | address, reverse <br> [Website](https://mapzen.com/documentation/search/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/mapzen-provider/v/stable)](https://packagist.org/packages/geocoder-php/mapzen-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/mapzen-provider/downloads)](https://packagist.org/packages/geocoder-php/mapzen-provider)
 [Nominatim](https://github.com/geocoder-php/nominatim-provider) <br> (OpenStreetMap) | `geocoder-php/nominatim-provider` | address, reverse <br> [Website](http://wiki.openstreetmap.org/wiki/Nominatim) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/nominatim-provider/v/stable)](https://packagist.org/packages/geocoder-php/nominatim-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/nominatim-provider/downloads)](https://packagist.org/packages/geocoder-php/nominatim-provider)
 [OpenCage](https://github.com/geocoder-php/open-cage-provider) | `geocoder-php/open-cage-provider` | address, reverse <br> [Website](https://opencagedata.com/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/open-cage-provider/v/stable)](https://packagist.org/packages/geocoder-php/open-cage-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/open-cage-provider/downloads)](https://packagist.org/packages/geocoder-php/open-cage-provider)
 [Photon](https://github.com/geocoder-php/photon-provider) | `geocoder-php/photon-provider` | address, reverse <br> [Website](https://photon.komoot.de/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/photon-provider/v/stable)](https://packagist.org/packages/geocoder-php/photon-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/photon-provider/downloads)](https://packagist.org/packages/geocoder-php/photon-provider)

diff --git a/src/Provider/Mapzen/CHANGELOG.md b/src/Provider/Mapzen/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 4.0.1
+
+Final release of this provider due to the service shutting down. Please see the main readme.
+
 ## 4.0.0
 
 First release of this library. 
diff --git a/src/Provider/Mapzen/Mapzen.php b/src/Provider/Mapzen/Mapzen.php
@@ -25,7 +25,9 @@
 use Http\Client\HttpClient;
 
 /**
- * @author Gary Gale <gary@vicchi.org>
+ * Mapzen has shut down as their APIs as of February 1, 2018.
+ *
+ * @deprecated https://github.com/geocoder-php/Geocoder/issues/808
  */
 final class Mapzen extends AbstractHttpProvider implements Provider
 {
@@ -45,6 +47,9 @@ final class Mapzen extends AbstractHttpProvider implements Provider
     private $apiKey;
 
     /**
+     * Mapzen has shut down as their APIs as of February 1, 2018.
+     * @deprecated https://github.com/geocoder-php/Geocoder/issues/808
+     *
      * @param HttpClient $client an HTTP adapter
      * @param string     $apiKey an API key
      */

diff --git a/src/Provider/Mapzen/Readme.md → src/Provider/Mapzen/README.md b/src/Provider/Mapzen/Readme.md → src/Provider/Mapzen/README.md
@@ -7,16 +7,11 @@
 [![Quality Score](https://img.shields.io/scrutinizer/g/geocoder-php/mapzen-provider.svg?style=flat-square)](https://scrutinizer-ci.com/g/geocoder-php/mapzen-provider)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
-This is the Mapzen 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. 
+# Abandoned
+Mapzen has shut down as their APIs as of February 1, 2018.
+This package is abandoned.
 
-### Install
+### Alternatives
 
-```bash
-composer require geocoder-php/mapzen-provider
-```
-
-### 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).
+Please see the list of providers in the main repo:    
+https://github.com/geocoder-php/Geocoder