Refactor GeoIP2Provider: Use injection of Maxmind provider.

Instead of using only the database reader of Maxmind, inject the Maxmind provider. Thus both is available: database reader and webservice client.

Author: Jens Wiese

README.md

@@ -18,7 +18,7 @@ Currently, there are the following adapters:
 * `GuzzleHttpAdapter` to use [Guzzle](https://github.com/guzzle/guzzle), PHP 5.3+ HTTP client and framework for building RESTful web service clients;
 * `SocketHttpAdapter` to use a [socket](http://www.php.net/manual/function.fsockopen.php);
 * `ZendHttpAdapter` to use [Zend Http Client](http://framework.zend.com/manual/2.0/en/modules/zend.http.client.html).
-* `GeoIP2DatabaseAdapter` to use [GeoIP2 Database Reader by MaxMind](https://github.com/maxmind/GeoIP2-php#database-reader).
+* `GeoIP2Adapter` to use [GeoIP2 Database Reader](https://github.com/maxmind/GeoIP2-php#database-reader) or the [Webservice Client](https://github.com/maxmind/GeoIP2-php#web-service-client) by MaxMind.
 
 
 ### Providers ###
@@ -50,7 +50,7 @@ Currently, there are many providers for the following APIs:
 * [GeoIPs](http://www.geoips.com/developer/geoips-api) as IP-Based geocoding provider;
 * [MaxMind web service](http://dev.maxmind.com/geoip/legacy/web-services) as IP-Based geocoding provider (City/ISP/Org and Omni services);
 * [MaxMind binary file](http://dev.maxmind.com/geoip/legacy/downloadable) as IP-Based geocoding provider;
-* [MaxMind GeoIP2 database file](http://www.maxmind.com/en/city) as IP-Based geocoding provider;
+* [MaxMind GeoIP2](http://www.maxmind.com/en/city) as IP-Based geocoding provider;
 * [Geonames](http://www.geonames.org/) as Place-Based geocoding and reverse geocoding provider;
 * [IpGeoBase](http://ipgeobase.ru/) as IP-Based geocoding provider (very accurate in Russia);
 * [Baidu](http://developer.baidu.com/map/geocoding-api.htm) as Address-Based geocoding and reverse geocoding provider (exclusively in China);
@@ -263,17 +263,20 @@ be used in production. For more information, please read [issue #301](https://gi
 
 ### GeoIP2DatabaseProvider ###
 
-The `GeoIP2DatabaseProvider` named `geoip2_database` is able to geocode **IPv4 and IPv6 addresses**
-only - it makes use of the MaxMind GeoIP2 databases.
+The `GeoIP2Provider` named `maxmind_geoip2` is able to geocode **IPv4 and IPv6 addresses**
+only - it makes use of the MaxMind GeoIP2 databases or the webservice.
 
-It requires the [database file](http://dev.maxmind.com/geoip/geoip2/geolite2/), and the [geoip2/geoip2](https://packagist.org/packages/geoip2/geoip2) package must be installed.
+It requires either the [database file](http://dev.maxmind.com/geoip/geoip2/geolite2/), or the [webservice](http://dev.maxmind.com/geoip/geoip2/web-services/) - represented by the GeoIP2 Provider, which is injected to the `GeoIP2Adapter`. The [geoip2/geoip2](https://packagist.org/packages/geoip2/geoip2) package must be installed.
 
-This provider will only work with the corresponding `GeoIP2DatabaseAdapter`.
+This provider will only work with the corresponding `GeoIP2Adapter`.
 
 **Usage:**
 
-    $adapter = new \Geocoder\HttpAdapter\GeoIP2DatabaseAdapter('/path/to/database');
-    $provider = new \Geocoder\Provider\GeoIP2DatabaseProvider($adapter);
+	// Maxmind GeoIP2 Provider: e.g. the database reader
+	$reader = new \GeoIp2\Database\Reader('/path/to/database'); 
+
+    $adapter = new \Geocoder\HttpAdapter\GeoIP2Adapter($reader);
+    $provider = new \Geocoder\Provider\GeoIP2Provider($adapter);
     $geocoder = new \Geocoder\Geocoder($provider);
 
     $result = $geocoder->geocode('74.200.247.59');

composer.json

@@ -19,8 +19,7 @@
         "guzzle/guzzle": "@stable",
         "zendframework/zend-http": "~2.1",
         "geoip/geoip": "~1.13",
-        "geoip2/geoip2": "~0.6",
-        "mikey179/vfsStream": "v1.2.0"
+        "geoip2/geoip2": "~0.6"
     },
     "suggest": {
         "kriswallsmith/buzz": "Enabling Buzz allows you to use the BuzzHttpAdapter.",

src/Geocoder/HttpAdapter/GeoIP2Adapter.php

@@ -0,0 +1,137 @@
+<?php
+
+/**
+ * This file is part of the Geocoder package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Geocoder\HttpAdapter;
+
+use Geocoder\Exception\InvalidArgumentException;
+use Geocoder\Exception\UnsupportedException;
+use GeoIp2\ProviderInterface;
+
+/**
+ * @author Jens Wiese <jens@howtrueisfalse.de>
+ */
+class GeoIP2Adapter implements HttpAdapterInterface
+{
+    /**
+     * GeoIP2 models (e.g. city or country)
+     */
+    const GEOIP2_MODEL_CITY    = 'city';
+    const GEOIP2_MODEL_COUNTRY = 'country';
+    const GEOIP2_MODEL_OMNI    = 'omni';
+
+    /**
+     * @var ProviderInterface
+     */
+    protected $geoIp2Provider;
+
+    /**
+     * @var string
+     */
+    protected $geoIP2Model;
+
+    /**
+     * @var string
+     */
+    protected $locale;
+
+    /**
+     * @param \GeoIp2\ProviderInterface $geoIpProvider
+     * @param string $geoIP2Model (e.g. self::GEOIP2_MODEL_CITY)
+     * @throws \Geocoder\Exception\UnsupportedException
+     * @internal param string $dbFile
+     */
+    public function __construct(ProviderInterface $geoIpProvider, $geoIP2Model = self::GEOIP2_MODEL_CITY)
+    {
+        $this->geoIp2Provider = $geoIpProvider;
+
+        if (false === $this->isSupportedGeoIP2Model($geoIP2Model)) {
+            throw new UnsupportedException(
+                sprintf('Model "%s" is not available.', $geoIP2Model)
+            );
+        }
+
+        $this->geoIP2Model = $geoIP2Model;
+    }
+
+    /**
+     * @param string $locale
+     * @return $this
+     */
+    public function setLocale($locale)
+    {
+        $this->locale = $locale;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLocale()
+    {
+        return $this->locale;
+    }
+
+    /**
+     * Returns the content fetched from a given resource.
+     *
+     * @param string $url (e.g. file://database?127.0.0.1)
+     * @throws \Geocoder\Exception\UnsupportedException
+     * @throws \Geocoder\Exception\InvalidArgumentException
+     * @return string
+     */
+    public function getContent($url)
+    {
+        if (false === filter_var($url, FILTER_VALIDATE_URL)) {
+            throw new InvalidArgumentException(
+                sprintf('"%s" must be called with a valid url. Got "%s" instead.', __METHOD__, $url)
+            );
+        }
+
+        $ipAddress = parse_url($url, PHP_URL_QUERY);
+
+        if (false === filter_var($ipAddress, FILTER_VALIDATE_IP)) {
+            throw new InvalidArgumentException('URL must contain a valid query-string (an IP address, 127.0.0.1 for instance)');
+        }
+
+        $result = $this->geoIp2Provider
+            ->{$this->geoIP2Model}($ipAddress)
+            ->jsonSerialize();
+
+        return json_encode($result);
+    }
+
+    /**
+     * Returns the name of the Adapter.
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return 'maxmind_geoip2';
+    }
+
+    /**
+     * Returns whether method is supported by GeoIP2
+     *
+     * @param string $method
+     * @return bool
+     */
+    protected function isSupportedGeoIP2Model($method)
+    {
+        $availableMethods = array(
+            self::GEOIP2_MODEL_CITY,
+            self::GEOIP2_MODEL_COUNTRY,
+            self::GEOIP2_MODEL_OMNI
+        );
+
+        return in_array($method, $availableMethods);
+    }
+}