Skip to content
Permalink
Browse files

fix: deprecate geoips provider (#972)

* fix: deprecate geoips provider

- adds `@deprecated` annotations to the class & constructor (which will warn people using IDEs)
- Updates the readme and changelog to communicate the deprecation
- Removes it from the main readme.

* feat: add deprecation docs

* fix: add back authors
  • Loading branch information...
atymic authored and jbelien committed Jul 15, 2019
1 parent 43b1494 commit 30ad373737deef1d7bde2b88d209f378e6120275
@@ -161,7 +161,6 @@ Provider | Package | Features | Stats
[FreeGeoIp](https://github.com/geocoder-php/free-geoip-provider) | `geocoder-php/free-geoip-provider` | IPv4, IPv6 <br> [Website](http://freegeoip.net/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/free-geoip-provider/v/stable)](https://packagist.org/packages/geocoder-php/free-geoip-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/free-geoip-provider/downloads)](https://packagist.org/packages/geocoder-php/free-geoip-provider)
[GeoIP](https://github.com/geocoder-php/geoip-provider) | `geocoder-php/geoip-provider` | IPv4, local <br> [Website](http://www.geoips.com/en/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/geoip-provider/v/stable)](https://packagist.org/packages/geocoder-php/geoip-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/geoip-provider/downloads)](https://packagist.org/packages/geocoder-php/geoip-provider)
[GeoIP2](https://github.com/geocoder-php/geoip2-provider) | `geocoder-php/geoip2-provider` | IPv4 <br> [Website](https://www.maxmind.com/en/geoip2-databases) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/geoip2-provider/v/stable)](https://packagist.org/packages/geocoder-php/geoip2-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/geoip2-provider/downloads)](https://packagist.org/packages/geocoder-php/geoip2-provider)
[GeoIPs](https://github.com/geocoder-php/geoips-provider) | `geocoder-php/geoips-provider` | IPv4 <br> | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/geoips-provider/v/stable)](https://packagist.org/packages/geocoder-php/geoips-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/geoips-provider/downloads)](https://packagist.org/packages/geocoder-php/geoips-provider)
[GeoPlugin](https://github.com/geocoder-php/geo-plugin-provider) | `geocoder-php/geo-plugin-provider` | IPv4, IPv6 <br> [Website](http://www.geoplugin.com/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/geo-plugin-provider/v/stable)](https://packagist.org/packages/geocoder-php/geo-plugin-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/geo-plugin-provider/downloads)](https://packagist.org/packages/geocoder-php/geo-plugin-provider)
[HostIp](https://github.com/geocoder-php/host-ip-provider) | `geocoder-php/host-ip-provider` | IPv4 <br> [Website](http://www.hostip.info/use.html) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/host-ip-provider/v/stable)](https://packagist.org/packages/geocoder-php/host-ip-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/host-ip-provider/downloads)](https://packagist.org/packages/geocoder-php/host-ip-provider)
[IpInfo](https://github.com/geocoder-php/ip-info-provider) | `geocoder-php/ip-info-provider` | IPv4, IPv6 <br> [Website](https://ipinfo.io/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/ip-info-provider/v/stable)](https://packagist.org/packages/geocoder-php/ip-info-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/ip-info-provider/downloads)](https://packagist.org/packages/geocoder-php/ip-info-provider)
@@ -0,0 +1,5 @@
# Procedures

Procedures for Geocoder contributors.

- [Provider Deprecation](provider-deprecation.md)
@@ -0,0 +1,12 @@
# Deprecating providers

A provider is considered shut down when the APIs no longer respond to queries with a valid geocoded response.
If the provider has alternatives that are a drop in replacement, or offer self hosting it should not be deprecated.

## Steps

1) Update Provider class, adding `@deprecated` annotations to the class and constructor method.
2) Remove the provider from the main repository README
3) Update the provider README to indicate that the package is abandoned, and where possible include alternatives.
4) Publish new package version (containing the `@deprecated` annotations) to Packagist
5) Mark Packagist package as abandoned
@@ -2,6 +2,10 @@

The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.

## 4.2.0

Final release of this provider due to the service shutting down. Please see provider [README.md](README.md).

## 4.1.0

### Changed
@@ -30,7 +30,8 @@
* @author Andrea Cristaudo <andrea.cristaudo@gmail.com>
* @author Arthur Bodera <abodera@thinkscape.pro>
*
* @see http://www.geoips.com/en/developer/api-guide
* @deprecated The GeoIPs provider has shut down
* @see https://github.com/geocoder-php/Geocoder/issues/965
*/
final class GeoIPs extends AbstractHttpProvider implements Provider
{
@@ -59,6 +60,8 @@ final class GeoIPs extends AbstractHttpProvider implements Provider
private $apiKey;
/**
* @deprecated The GeoIPs provider has shut down
*
* @param HttpClient $client An HTTP adapter
* @param string $apiKey An API key
*/
@@ -7,8 +7,13 @@
[![Quality Score](https://img.shields.io/scrutinizer/g/geocoder-php/geoips-provider.svg?style=flat-square)](https://scrutinizer-ci.com/g/geocoder-php/geoips-provider)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

This is the GeoIPs 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
GeoIPs has shut down as their APIs.
This package is abandoned.

## Alternatives
https://github.com/geocoder-php/Geocoder#ip


### Install

0 comments on commit 30ad373

Please sign in to comment.
You can’t perform that action at this time.