Updated .gitignore

It could use a better name.

.gitignore

@@ -1,5 +1,6 @@
 _site
 .gh-pages
+.idea
 composer.lock
 composer.phar
 phpunit.xml

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "maxmind-db"]
+	path = maxmind-db
+	url = git://github.com/maxmind/MaxMind-DB.git

CHANGELOG.md

@@ -1,6 +1,23 @@
 CHANGELOG
 =========
 
+0.5.0 (2013-10-21)
+------------------
+
+* Renamed $languages constructor parameters to $locales for both the Client
+  and Reader classes.
+* Documentation and code clean-up (Ben Morel).
+* Added the interface `GeoIp2\ProviderInterface`, which is implemented by both
+  `\GeoIp2\Database\Reader` and `\GeoIp2\WebService\Client`.
+
+0.4.0 (2013-07-16)
+------------------
+
+* This is the first release with the GeoIP2 database reader. Please see the
+  `README.md` file and the `\GeoIp2\Database\Reader` class.
+* The general exception classes were replaced with specific exception classes
+  representing particular types of errors, such as an authentication error.
+
 0.3.0 (2013-07-12)
 ------------------
 

README.md

@@ -8,32 +8,24 @@ release, which will be numbered 2.0.0.
 You may find information on the GeoIP2 beta release process on [our
 website](http://www.maxmind.com/en/geoip2_beta).
 
-To provide feedback or get support during the beta, please see the
-[MaxMind Customer Community](https://getsatisfaction.com/maxmind).
-
 ## Description ##
 
-Currently, this distribution provides an API for the [GeoIP2 web services]
-(http://dev.maxmind.com/geoip/geoip2/web-services).
-
-In the future, this distribution will also provide the same API for the
-GeoIP2 downloadable databases. These databases have not yet been
-released as a downloadable product.
-
-See ``GeoIp2\WebService\Client`` for details on the web service client
-API.
+This distribution provides an API for the [GeoIP2 web services]
+(http://dev.maxmind.com/geoip/geoip2/web-services) and the [GeoLite2
+databases](http://dev.maxmind.com/geoip/geoip2/geolite2/). The commercial
+GeoIP2 databases have not yet been released as a downloadable product.
 
 ## Installation ##
 
 ### Define Your Dependencies ###
 
 We recommend installing this package with [Composer](http://getcomposer.org/).
-To do this, add ```geoip2/geoip2``` to your ```composer.json``` file.
+To do this, add `geoip2/geoip2` to your `composer.json` file.
 
 ```json
 {
     "require": {
-        "geoip2/geoip2": "0.3.*"
+        "geoip2/geoip2": "0.5.*"
     }
 }
 ```
@@ -61,10 +53,71 @@ You can autoload all dependencies by adding this to your code:
 require 'vendor/autoload.php';
 ```
 
-## Usage ##
+### Optional C Extension ###
 
-To use this API, you must create a new ``\GeoIp2\WebService\Client``
-object with your ``$userId`` and ``$licenseKey``, then you call the method
+The [MaxMind DB API](https://github.com/maxmind/MaxMind-DB-Reader-php)
+includes an optional C extension that you may install to dramatically increase
+the performance of lookups in GeoIP2 or GeoLite2 databases. To install, please
+follow the instructions included with that API.
+
+The extension has no effect on web-service lookups.
+
+## Database Reader ##
+
+### Usage ###
+
+To use this API, you must create a new `\GeoIp2\Database\Reader` object with
+the path to the database file as the first argument to the constructor. You
+may then call the method corresponding to the database you are using.
+
+If the lookup succeeds, the method call will return a model class for the
+record in the database. This model in turn contains multiple container
+classes for the different parts of the data such as the city in which the
+IP address is located.
+
+If the record is not found, a `\GeoIp2\Exception\AddressNotFoundException`
+is returned. If the database is invalid or corrupt, a
+`\MaxMind\Db\InvalidDatabaseException` will be thrown.
+
+See the API documentation for more details.
+
+### Example ###
+
+```php
+<?php
+require_once 'vendor/autoload.php';
+use GeoIp2\Database\Reader;
+
+// This creates the Reader object, which should be reused across
+// lookups.
+$reader = new Reader('/usr/local/share/GeoIP/GeoIP2-City.mmdb');
+
+// Replace "city" with the appropriate method for your database, e.g.,
+// "country".
+$record = $reader->city('128.101.101.101');
+
+print($record->country->isoCode . "\n"); // 'US'
+print($record->country->name . "\n"); // 'United States'
+print($record->country->names['zh-CN'] . "\n"); // '美国'
+
+print($record->mostSpecificSubdivision->name . "\n"); // 'Minnesota'
+print($record->mostSpecificSubdivision->isoCode . "\n"); // 'MN'
+
+print($record->city->name . "\n"); // 'Minneapolis'
+
+print($record->postal->code . "\n"); // '55455'
+
+print($record->location->latitude . "\n"); // 44.9733
+print($record->location->longitude . "\n"); // -93.2323
+
+```
+
+## Web Service Client ##
+
+### Usage ###
+
+To use this API, you must create a new `\GeoIp2\WebService\Client`
+object with your `$userId` and `$licenseKey`, then you call the method
 corresponding to a specific end point, passing it the IP address you want to
 look up.
 
@@ -72,41 +125,43 @@ If the request succeeds, the method call will return a model class for the end
 point you called. This model in turn contains multiple record classes, each of
 which represents part of the data returned by the web service.
 
+If there is an error, a structured exception is thrown.
+
 See the API documentation for more details.
 
-## Example ##
+### Example ###
 
 ```php
 <?php
 require_once 'vendor/autoload.php';
-use \GeoIp2\WebService\Client;
+use GeoIp2\WebService\Client;
 
+// This creates a Client object that can be reused across requests.
+// Replace "42" with your user ID and "license_key" with your license
+// key.
 $client = new Client(42, 'abcdef123456');
-$omni = $client->omni('24.24.24.24');
-echo $omni->country->isoCode;
+
+// Replace "city" with the method corresponding to the web service that
+// you are using, e.g., "country", "cityIspOrg", "omni".
+$record = $client->city('128.101.101.101');
+
+print($record->country->isoCode . "\n"); // 'US'
+print($record->country->name . "\n"); // 'United States'
+print($record->country->names['zh-CN'] . "\n"); // '美国'
+
+print($record->mostSpecificSubdivision->name . "\n"); // 'Minnesota'
+print($record->mostSpecificSubdivision->isoCode . "\n"); // 'MN'
+
+print($record->city->name . "\n"); // 'Minneapolis'
+
+print($record->postal->code . "\n"); // '55455'
+
+print($record->location->latitude . "\n"); // 44.9733
+print($record->location->longitude . "\n"); // -93.2323
+
 ```
 
-## Exceptions ##
-
-For details on the possible errors returned by the web service itself, see
-the
-[GeoIP2 web service docs](http://dev.maxmind.com/geoip2/geoip/web-service).
-
-If the web service returns an explicit error document, this is thrown as a
-```\GeoIp2\Exception\WebServiceException```. If some other sort of transport
-error occurs, this is thrown as a ```\GeoIp2\Exception\HttpException```.
-The difference is that the web service error includes an error message and
-error code delivered by the web service. The latter is thrown when some sort
-of unanticipated error occurs, such as the web service returning a 500 or an
-invalid error document.
-
-If the web service returns any status code besides 200, 4xx, or 5xx, this also
-becomes a ```\GeoIp2\Exception\HttpException```.
-
-Finally, if the web service returns a 200 but the body is invalid, the client
-throws a ```\GeoIp2\Exception\GeoIp2Exception```.
-
-## What data is returned? ##
+### What data is returned? ###
 
 While many of the end points return the same basic records, the attributes
 which can be populated vary between end points. In addition, while an end
@@ -120,8 +175,8 @@ See the
 [GeoIP2 web service docs](http://dev.maxmind.com/geoip/geoip2/web-services)
 for details on what data each end point may return.
 
-The only piece of data which is always returned is the ```ipAddress```
-attribute in the ``GeoIp2\Record\Traits`` record.
+The only piece of data which is always returned is the `ipAddress`
+attribute in the `GeoIp2\Record\Traits` record.
 
 Every record class attribute has a corresponding predicate method so you can
 check to see if the attribute is set.
@@ -131,10 +186,10 @@ check to see if the attribute is set.
 [GeoNames](http://www.geonames.org/) offers web services and downloadable
 databases with data on geographical features around the world, including
 populated places. They offer both free and paid premium data. Each
-feature is unique identified by a ```geonameId```, which is an integer.
+feature is unique identified by a `geonameId`, which is an integer.
 
 Many of the records returned by the GeoIP2 web services and databases
-include a ```geonameId``` property. This is the ID of a geographical feature
+include a `geonameId` property. This is the ID of a geographical feature
 (city, region, country, etc.) in the GeoNames database.
 
 Some of the data that MaxMind provides is also sourced from GeoNames. We

bin/release.sh

@@ -58,6 +58,6 @@ git push git@github.com:maxmind/GeoIP2-php.git
 git push
 
 cd ..
-git tag $TAG
+git tag -a $TAG
 git push
 git push --tags

composer.json

@@ -14,6 +14,7 @@
     ],
     "require": {
         "guzzle/guzzle": "3.*",
+        "maxmind-db/reader": "0.2.*",
         "php": ">=5.3.1"
     },
     "require-dev": {

src/GeoIp2/Database/Reader.php

@@ -0,0 +1,149 @@
+<?php
+
+namespace GeoIp2\Database;
+
+use GeoIp2\Exception\AddressNotFoundException;
+use GeoIp2\ProviderInterface;
+use MaxMind\Db\Reader as DbReader;
+
+/**
+ * Instances of this class provide a reader for the GeoIP2 database format.
+ * IP addresses can be looked up using the <code>country</code>
+ * and <code>city</code> methods. We also provide <code>cityIspOrg</code>
+ * and <code>omni</code> methods to ease compatibility with the web service
+ * client, although we may offer the ability to specify additional databases
+ * to replicate these web services in the future (e.g., the ISP/Org database).
+ *
+ * **Usage**
+ *
+ * The basic API for this class is the same for every database. First, you
+ * create a reader object, specifying a file name. You then call the method
+ * corresponding to the specific database, passing it the IP address you want
+ * to look up.
+ *
+ * If the request succeeds, the method call will return a model class for
+ * the method you called. This model in turn contains multiple record classes,
+ * each of which represents part of the data returned by the database. If
+ * the database does not contain the requested information, the attributes
+ * on the record class will have a <code>null</code> value.
+ *
+ * If the address is not in the database, an
+ * {@link \GeoIp2\Exception\AddressNotFoundException} exception will be
+ * thrown. If an invalid IP address is passed to one of the methods, a
+ * SPL {@link \InvalidArgumentException} will be thrown. If the database is
+ * corrupt or invalid, a {@link \MaxMind\Db\Reader\InvalidDatabaseException}
+ * will be thrown.
+ *
+ */
+class Reader implements ProviderInterface
+{
+    private $dbReader;
+    private $locales;
+
+    /**
+     * Constructor.
+     *
+     * @param string $filename The path to the GeoIP2 database file.
+     * @param array $locales  List of locale codes to use in name property
+     * from most preferred to least preferred.
+     * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
+     *          is corrupt or invalid
+     */
+    public function __construct(
+        $filename,
+        $locales = array('en')
+    ) {
+        $this->dbReader = new DbReader($filename);
+        $this->locales = $locales;
+    }
+
+    /**
+     * This method returns a GeoIP2 City model.
+     *
+     * @param string $ipAddress IPv4 or IPv6 address as a string.
+     *
+     * @return \GeoIp2\Model\City
+     *
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
+     *         not in the database.
+     * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
+     *         is corrupt or invalid
+     */
+    public function city($ipAddress)
+    {
+        return $this->modelFor('City', $ipAddress);
+    }
+
+    /**
+     * This method returns a GeoIP2 Country model.
+     *
+     * @param string $ipAddress IPv4 or IPv6 address as a string.
+     *
+     * @return \GeoIp2\Model\Country
+     *
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
+     *         not in the database.
+     * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
+     *         is corrupt or invalid
+     */
+    public function country($ipAddress)
+    {
+        return $this->modelFor('Country', $ipAddress);
+    }
+
+    /**
+     * This method returns a GeoIP2 City/ISP/Org model.
+     *
+     * @param string $ipAddress IPv4 or IPv6 address as a string.
+     *
+     * @return \GeoIp2\Model\CityIspOrg
+     *
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
+     *         not in the database.
+     * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
+     *         is corrupt or invalid
+     */
+    public function cityIspOrg($ipAddress)
+    {
+        return $this->modelFor('CityIspOrg', $ipAddress);
+    }
+
+    /**
+     * This method returns a GeoIP2 Omni model.
+     *
+     * @param string $ipAddress IPv4 or IPv6 address as a string.
+     *
+     * @return \GeoIp2\Model\Omni
+     *
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
+     *         not in the database.
+     * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
+     *         is corrupt or invalid
+     */
+    public function omni($ipAddress)
+    {
+        return $this->modelFor('Omni', $ipAddress);
+    }
+
+    private function modelFor($class, $ipAddress)
+    {
+        $record = $this->dbReader->get($ipAddress);
+        if ($record === null) {
+            throw new AddressNotFoundException(
+                "The address $ipAddress is not in the database."
+            );
+        }
+        $record['traits']['ip_address'] = $ipAddress;
+        $class = "GeoIp2\\Model\\" . $class;
+
+        return new $class($record, $this->locales);
+    }
+
+    /**
+     * Closes the GeoIP2 database and returns the resources to the system.
+     */
+    public function close()
+    {
+        $this->dbReader->close();
+    }
+}

src/GeoIp2/Exception/AddressNotFoundException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace GeoIp2\Exception;
+
+/**
+ * This class represents a generic error.
+ */
+class AddressNotFoundException extends GeoIp2Exception
+{
+}

src/GeoIp2/Exception/AuthenticationException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace GeoIp2\Exception;
+
+/**
+ * This class represents a generic error.
+ */
+class AuthenticationException extends GeoIp2Exception
+{
+}

src/GeoIp2/Exception/HttpException.php

@@ -17,7 +17,7 @@ class HttpException extends GeoIp2Exception
         $message,
         $httpStatus,
         $uri,
-        Exception $previous = null
+        \Exception $previous = null
     ) {
         $this->uri = $uri;
         parent::__construct($message, $httpStatus, $previous);

src/GeoIp2/Exception/InvalidRequestException.php

@@ -6,7 +6,7 @@ namespace GeoIp2\Exception;
  * This class represents an error returned by MaxMind's GeoIP2
  * web service.
  */
-class WebServiceException extends HttpException
+class InvalidRequestException extends HttpException
 {
     /**
      * The code returned by the MaxMind web service
@@ -18,7 +18,7 @@ class WebServiceException extends HttpException
         $error,
         $httpStatus,
         $uri,
-        Exception $previous = null
+        \Exception $previous = null
     ) {
         $this->error = $error;
         parent::__construct($message, $httpStatus, $uri, $previous);

src/GeoIp2/Exception/OutOfQueriesException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace GeoIp2\Exception;
+
+/**
+ * This class represents a generic error.
+ */
+class OutOfQueriesException extends GeoIp2Exception
+{
+}

src/GeoIp2/Model/City.php

@@ -74,18 +74,18 @@ class City extends Country
     /**
      * @ignore
      */
-    public function __construct($raw, $languages)
+    public function __construct($raw, $locales)
     {
-        parent::__construct($raw, $languages);
+        parent::__construct($raw, $locales);
 
-        $this->city = new \GeoIp2\Record\City($this->get('city'), $languages);
+        $this->city = new \GeoIp2\Record\City($this->get('city'), $locales);
         $this->location = new \GeoIp2\Record\Location($this->get('location'));
         $this->postal = new \GeoIp2\Record\Postal($this->get('postal'));
 
-        $this->createSubdivisions($raw, $languages);
+        $this->createSubdivisions($raw, $locales);
     }
 
-    private function createSubdivisions($raw, $languages)
+    private function createSubdivisions($raw, $locales)
     {
         if (!isset($raw['subdivisions'])) {
             return;
@@ -94,7 +94,7 @@ class City extends Country
         foreach ($raw['subdivisions'] as $sub) {
             array_push(
                 $this->subdivisions,
-                new \GeoIp2\Record\Subdivision($sub, $languages)
+                new \GeoIp2\Record\Subdivision($sub, $locales)
             );
         }
     }
@@ -114,7 +114,7 @@ class City extends Country
     private function mostSpecificSubdivision()
     {
         return empty($this->subdivisions) ?
-            new \GeoIp2\Record\Subdivision(array(), $this->languages):
+            new \GeoIp2\Record\Subdivision(array(), $this->locales) :
             end($this->subdivisions);
     }
 }

src/GeoIp2/Model/Country.php

@@ -37,7 +37,7 @@ class Country
 {
     private $continent;
     private $country;
-    private $languages;
+    private $locales;
     private $maxmind;
     private $registeredCountry;
     private $representedCountry;
@@ -47,30 +47,30 @@ class Country
     /**
      * @ignore
      */
-    public function __construct($raw, $languages)
+    public function __construct($raw, $locales)
     {
         $this->raw = $raw;
 
         $this->continent = new \GeoIp2\Record\Continent(
             $this->get('continent'),
-            $languages
+            $locales
         );
         $this->country = new \GeoIp2\Record\Country(
             $this->get('country'),
-            $languages
+            $locales
         );
         $this->maxmind = new \GeoIp2\Record\MaxMind($this->get('maxmind'));
         $this->registeredCountry = new \GeoIp2\Record\Country(
             $this->get('registered_country'),
-            $languages
+            $locales
         );
         $this->representedCountry = new \GeoIp2\Record\RepresentedCountry(
             $this->get('represented_country'),
-            $languages
+            $locales
         );
         $this->traits = new \GeoIp2\Record\Traits($this->get('traits'));
 
-        $this->languages = $languages;
+        $this->locales = $locales;
     }
 
     /**

src/GeoIp2/ProviderInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace GeoIp2;
+
+interface ProviderInterface
+{
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return \GeoIp2\Model\Country A Country model for the requested IP address.
+     */
+    public function country($ipAddress);
+
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return \GeoIp2\Model\City A City model for the requested IP address.
+     */
+    public function city($ipAddress);
+
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return \GeoIp2\Model\CityIspOrg A CityIspOrg model for the requested IP address.
+     */
+    public function cityIspOrg($ipAddress);
+
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return \GeoIp2\Model\Omni An Omni model for the requested IP address.
+     */
+    public function omni($ipAddress);
+}

src/GeoIp2/Record/AbstractPlaceRecord.php

@@ -4,14 +4,14 @@ namespace GeoIp2\Record;
 
 abstract class AbstractPlaceRecord extends AbstractRecord
 {
-    private $languages;
+    private $locales;
 
     /**
      * @ignore
      */
-    public function __construct($record, $languages)
+    public function __construct($record, $locales)
     {
-        $this->languages = $languages;
+        $this->locales = $locales;
         parent::__construct($record);
     }
 
@@ -29,9 +29,9 @@ abstract class AbstractPlaceRecord extends AbstractRecord
 
     private function name()
     {
-        foreach ($this->languages as $language) {
-            if (isset($this->names[$language])) {
-                return $this->names[$language];
+        foreach ($this->locales as $locale) {
+            if (isset($this->names[$locale])) {
+                return $this->names[$locale];
             }
         }
     }

src/GeoIp2/Record/City.php

@@ -14,10 +14,10 @@ namespace GeoIp2\Record;
  * @property int $geonameId The GeoName ID for the city. This attribute
  * is returned by all end points.
  *
- * @property string $name The name of the city based on the languages list
+ * @property string $name The name of the city based on the locales list
  * passed to the constructor. This attribute is returned by all end points.
  *
- * @property array $names A array map where the keys are language codes
+ * @property array $names A array map where the keys are locale codes
  * and the values are names. This attribute is returned by all end points.
  */
 class City extends AbstractPlaceRecord

src/GeoIp2/Record/Continent.php

@@ -14,10 +14,10 @@ namespace GeoIp2\Record;
  * is returned by all end points.
  *
  * @property string $name Returns the name of the continent based on the
- * languages list passed to the constructor. This attribute is returned by
+ * locales list passed to the constructor. This attribute is returned by
  * all end points.
  *
- * @property array $names An array map where the keys are language codes
+ * @property array $names An array map where the keys are locale codes
  * and the values are names. This attribute is returned by all end points.
  */
 class Continent extends AbstractPlaceRecord

src/GeoIp2/Record/Country.php

@@ -18,10 +18,10 @@ namespace GeoIp2\Record;
  * two-character ISO 3166-1 alpha code} for the country. This attribute is
  * returned by all end points.
  *
- * @property string $name The name of the country based on the languages list
+ * @property string $name The name of the country based on the locales list
  * passed to the constructor. This attribute is returned by all end points.
  *
- * @property array $names An array map where the keys are language codes and
+ * @property array $names An array map where the keys are locale codes and
  * the values are names. This attribute is returned by all end points.
  */
 class Country extends AbstractPlaceRecord

src/GeoIp2/Record/RepresentedCountry.php

@@ -22,10 +22,10 @@ namespace GeoIp2\Record;
  * two-character ISO 3166-1 alpha code} for the country. This attribute is
  * returned by all end points.
  *
- * @property string $name The name of the country based on the languages list
+ * @property string $name The name of the country based on the locales list
  * passed to the constructor. This attribute is returned by all end points.
  *
- * @property array $names An array map where the keys are language codes and
+ * @property array $names An array map where the keys are locale codes and
  * the values are names. This attribute is returned by all end points.
  *
  * @property string $type A string indicating the type of entity that is

src/GeoIp2/Record/Subdivision.php

@@ -20,11 +20,11 @@ namespace GeoIp2\Record;
  * http://en.wikipedia.org/wiki/ISO_3166-2 ISO 3166-2 code}. This attribute
  * is returned by all end points except Country.
  *
- * @property string $name The name of the subdivision based on the languages
+ * @property string $name The name of the subdivision based on the locales
  * list passed to the constructor. This attribute is returned by all end
  * points except Country.
  *
- * @property array $names An array map where the keys are language codes and
+ * @property array $names An array map where the keys are locale codes and
  * the values are names. This attribute is returned by all end points except
  * Country.
  */

src/GeoIp2/WebService/Client.php

@@ -2,15 +2,15 @@
 
 namespace GeoIp2\WebService;
 
+use GeoIp2\Exception\AddressNotFoundException;
+use GeoIp2\Exception\AuthenticationException;
 use GeoIp2\Exception\GeoIp2Exception;
 use GeoIp2\Exception\HttpException;
-use GeoIp2\Exception\WebServiceException;
-use GeoIp2\Model\City;
-use GeoIp2\Model\CityIspOrg;
-use GeoIp2\Model\Country;
-use GeoIp2\Model\Omni;
-use Guzzle\Http\Client as GuzzleClient;
+use GeoIp2\Exception\InvalidRequestException;
+use GeoIp2\Exception\OutOfQueriesException;
+use GeoIp2\ProviderInterface;
 use Guzzle\Common\Exception\RuntimeException;
+use Guzzle\Http\Client as GuzzleClient;
 use Guzzle\Http\Exception\ClientErrorResponseException;
 use Guzzle\Http\Exception\ServerErrorResponseException;
 
@@ -44,32 +44,12 @@ use Guzzle\Http\Exception\ServerErrorResponseException;
  * service.
  *
  * If the request fails, the client class throws an exception.
- *
- * **Exceptions**
- *
- * For details on the possible errors returned by the web service itself, see
- * {@link http://dev.maxmind.com/geoip2/geoip/web-services the GeoIP2 web
- * service docs}.
- *
- * If the web service returns an explicit error document, this is thrown as a
- * {@link \GeoIp2\Exception\WebServiceException}. If some other sort of
- * transport error occurs, this is thrown as a {@link
- * \GeoIp2\Exception\HttpException}. The difference is that the web service
- * error includes an error message and error code delivered by the web
- * service. The latter is thrown when some sort of unanticipated error occurs,
- * such as the web service returning a 500 or an invalid error document.
- *
- * If the web service returns any status code besides 200, 4xx, or 5xx, this
- * also becomes a {@link \GeoIp2\Exception\HttpException}.
- *
- * Finally, if the web service returns a 200 but the body is invalid, the
- * client throws a {@link \GeoIp2\Exception\GeoIp2Exception}.
  */
-class Client
+class Client implements ProviderInterface
 {
     private $userId;
     private $licenseKey;
-    private $languages;
+    private $locales;
     private $host;
     private $guzzleClient;
 
@@ -78,7 +58,7 @@ class Client
      *
      * @param int $userId     Your MaxMind user ID
      * @param string $licenseKey Your MaxMind license key
-     * @param array  $languages  List of language codes to use in name property
+     * @param array $locales  List of locale codes to use in name property
      * from most preferred to least preferred.
      * @param string $host Optional host parameter
      * @param object $guzzleClient Optional Guzzle client to use (to facilitate
@@ -87,13 +67,13 @@ class Client
     public function __construct(
         $userId,
         $licenseKey,
-        $languages = array('en'),
+        $locales = array('en'),
         $host = 'geoip.maxmind.com',
         $guzzleClient = null
     ) {
         $this->userId = $userId;
         $this->licenseKey = $licenseKey;
-        $this->languages = $languages;
+        $this->locales = $locales;
         $this->host = $host;
         // To enable unit testing
         $this->guzzleClient = $guzzleClient;
@@ -108,12 +88,23 @@ class Client
      *
      * @return \GeoIp2\Model\City
      *
-     * @throws \GeoIp2\Exception\GeoIp2Exception if there was a generic
-     * error processing your request.
-     * @throws \GeoIp2\Exception\HttpException if there was an HTTP transport
-     * error.
-     * @throws \GeoIp2\Exception\WebServiceException if an error was returned
-     * by MaxMind's GeoIP2 web service.
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
+     *   provided is not in our database (e.g., a private address).
+     * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
+     *   with the user ID or license key that you provided.
+     * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
+     *   of queries.
+     * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
+     *   received by the web service but is invalid for some other reason.
+     *   This may indicate an issue with this API. Please report the error to
+     *   MaxMind.
+     * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
+     *   code or message was returned. This could indicate a problem with the
+     *   connection between your server and the web service or that the web
+     *   service returned an invalid document or 500 error code.
+     * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
+     *   class to the above exceptions. It will be thrown directly if a 200
+     *   status code is returned but the body is invalid.
      */
     public function city($ipAddress = 'me')
     {
@@ -129,12 +120,23 @@ class Client
      *
      * @return \GeoIp2\Model\Country
      *
-     * @throws \GeoIp2\Exception\GeoIp2Exception if there was a generic
-     * error processing your request.
-     * @throws \GeoIp2\Exception\HttpException if there was an HTTP transport
-     * error.
-     * @throws \GeoIp2\Exception\WebServiceException if an error was returned
-     * by MaxMind's GeoIP2 web service.
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
+     *   provided is not in our database (e.g., a private address).
+     * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
+     *   with the user ID or license key that you provided.
+     * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
+     *   of queries.
+     * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
+     *   received by the web service but is invalid for some other reason.
+     *   This may indicate an issue with this API. Please report the error to
+     *   MaxMind.
+     * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
+     *   code or message was returned. This could indicate a problem with the
+     *   connection between your server and the web service or that the web
+     *   service returned an invalid document or 500 error code.
+     * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
+     *   class to the above exceptions. It will be thrown directly if a 200
+     *   status code is returned but the body is invalid.
      */
     public function country($ipAddress = 'me')
     {
@@ -150,12 +152,23 @@ class Client
      *
      * @return \GeoIp2\Model\CityIspOrg
      *
-     * @throws \GeoIp2\Exception\GeoIp2Exception if there was a generic
-     * error processing your request.
-     * @throws \GeoIp2\Exception\HttpException if there was an HTTP transport
-     * error.
-     * @throws \GeoIp2\Exception\WebServiceException if an error was returned
-     * by MaxMind's GeoIP2 web service.
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
+     *   provided is not in our database (e.g., a private address).
+     * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
+     *   with the user ID or license key that you provided.
+     * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
+     *   of queries.
+     * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
+     *   received by the web service but is invalid for some other reason.
+     *   This may indicate an issue with this API. Please report the error to
+     *   MaxMind.
+     * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
+     *   code or message was returned. This could indicate a problem with the
+     *   connection between your server and the web service or that the web
+     *   service returned an invalid document or 500 error code.
+     * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
+     *   class to the above exceptions. It will be thrown directly if a 200
+     *   status code is returned but the body is invalid.
      */
     public function cityIspOrg($ipAddress = 'me')
     {
@@ -171,12 +184,23 @@ class Client
      *
      * @return \GeoIp2\Model\Omni
      *
-     * @throws \GeoIp2\Exception\GeoIp2Exception if there was a generic
-     * error processing your request.
-     * @throws \GeoIp2\Exception\HttpException if there was an HTTP transport
-     * error.
-     * @throws \GeoIp2\Exception\WebServiceException if an error was returned
-     * by MaxMind's GeoIP2 web service.
+     * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
+     *   provided is not in our database (e.g., a private address).
+     * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
+     *   with the user ID or license key that you provided.
+     * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
+     *   of queries.
+     * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
+     *   received by the web service but is invalid for some other reason.
+     *   This may indicate an issue with this API. Please report the error to
+     *   MaxMind.
+     * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
+     *   code or message was returned. This could indicate a problem with the
+     *   connection between your server and the web service or that the web
+     *   service returned an invalid document or 500 error code.
+     * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
+     *   class to the above exceptions. It will be thrown directly if a 200
+     *   status code is returned but the body is invalid.
      */
     public function omni($ipAddress = 'me')
     {
@@ -191,11 +215,8 @@ class Client
             $this->guzzleClient : new GuzzleClient();
         $request = $client->get($uri, array('Accept' => 'application/json'));
         $request->setAuth($this->userId, $this->licenseKey);
-        $ua = $request->getHeader('User-Agent');
-        $ua = "GeoIP2 PHP API ($ua)";
-        $request->setHeader('User-Agent', $ua);
+        $this->setUserAgent($request);
 
-        $response = null;
         try {
             $response = $request->send();
         } catch (ClientErrorResponseException $e) {
@@ -207,7 +228,7 @@ class Client
         if ($response && $response->isSuccessful()) {
             $body = $this->handleSuccess($response, $uri);
             $class = "GeoIp2\\Model\\" . $class;
-            return new $class($body, $this->languages);
+            return new $class($body, $this->locales);
         } else {
             $this->handleNon200($response, $uri);
         }
@@ -237,8 +258,6 @@ class Client
     {
         $status = $response->getStatusCode();
 
-        $body = array();
-
         if ($response->getContentLength() > 0) {
             if (strstr($response->getContentType(), 'json')) {
                 try {
@@ -273,8 +292,7 @@ class Client
                 $uri
             );
         }
-
-        throw new WebServiceException(
+        $this->handleWebServiceError(
             $body['error'],
             $body['code'],
             $status,
@@ -282,6 +300,28 @@ class Client
         );
     }
 
+    private function handleWebServiceError($message, $code, $status, $uri)
+    {
+        switch ($code) {
+            case 'IP_ADDRESS_NOT_FOUND':
+            case 'IP_ADDRESS_RESERVED':
+                throw new AddressNotFoundException($message);
+            case 'AUTHORIZATION_INVALID':
+            case 'LICENSE_KEY_REQUIRED':
+            case 'USER_ID_REQUIRED':
+                throw new AuthenticationException($message);
+            case 'OUT_OF_QUERIES':
+                throw new OutOfQueriesException($message);
+            default:
+                throw new InvalidRequestException(
+                    $message,
+                    $code,
+                    $status,
+                    $uri
+                );
+        }
+    }
+
     private function handle5xx($response, $uri)
     {
         $status = $response->getStatusCode();
@@ -305,6 +345,13 @@ class Client
         );
     }
 
+    private function setUserAgent($request)
+    {
+        $userAgent = $request->getHeader('User-Agent');
+        $userAgent = "GeoIP2 PHP API ($userAgent)";
+        $request->setHeader('User-Agent', $userAgent);
+    }
+
     private function baseUri()
     {
         return 'https://' . $this->host . '/geoip/v2.0';

tests/GeoIp2/Test/Database/ReaderTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace GeoIp2\Test\WebService;
+
+use GeoIp2\Database\Reader;
+
+class ReaderTest extends \PHPUnit_Framework_TestCase
+{
+    public function testDefaultLocale()
+    {
+        $reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
+        // Needed for PHP 5.3
+        $that = $this;
+        $this->checkAllMethods(
+            function ($method) use (&$that, &$reader) {
+                $record = $reader->$method('81.2.69.160');
+                $that->assertEquals('United Kingdom', $record->country->name);
+            }
+        );
+        $reader->close();
+    }
+
+    public function testLocaleList()
+    {
+        $reader = new Reader(
+            'maxmind-db/test-data/GeoIP2-City-Test.mmdb',
+            array('xx', 'ru', 'pt-BR', 'es', 'en')
+        );
+        $that = $this;
+        $this->checkAllMethods(
+            function ($method) use (&$that, &$reader) {
+                $record = $reader->$method('81.2.69.160');
+                $that->assertEquals('Великобритания', $record->country->name);
+            }
+        );
+        $reader->close();
+    }
+
+    public function testHasIpAddress()
+    {
+        $reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
+        $that = $this;
+        $this->checkAllMethods(
+            function ($method) use (&$that, &$reader) {
+                $record = $reader->$method('81.2.69.160');
+                $that->assertEquals('81.2.69.160', $record->traits->ipAddress);
+            }
+        );
+        $reader->close();
+    }
+
+    /**
+     * @expectedException GeoIp2\Exception\AddressNotFoundException
+     * @expectedExceptionMessage The address 10.10.10.10 is not in the database.
+     */
+    public function testUnknownAddress()
+    {
+        $reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
+        $reader->city('10.10.10.10');
+        $reader->close();
+    }
+
+    /**
+     * @expectedException InvalidArgumentException
+     * @expectedExceptionMessage is not a valid IP address
+     */
+    public function testInvalidAddress()
+    {
+        $reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
+        $reader->city('invalid');
+        $reader->close();
+    }
+
+    public function checkAllMethods($testCb)
+    {
+        foreach (array('city', 'cityIspOrg', 'country', 'omni') as $method) {
+            $testCb($method);
+        }
+    }
+}

tests/GeoIp2/Test/WebService/ClientTest.php

@@ -82,6 +82,54 @@ class ClientTest extends \PHPUnit_Framework_TestCase
                 null,
                 'text/plain'
             ),
+            '1.2.3.13' => $this->response(
+                'error',
+                404,
+                array(
+                    'code' => 'IP_ADDRESS_NOT_FOUND',
+                    'error' => 'The address "1.2.3.13" is not in our database.'
+                )
+            ),
+            '1.2.3.14' => $this->response(
+                'error',
+                400,
+                array(
+                    'code' => 'IP_ADDRESS_RESERVED',
+                    'error' => 'The address "1.2.3.14" is a private address.'
+                )
+            ),
+            '1.2.3.15' => $this->response(
+                'error',
+                401,
+                array(
+                    'code' => 'AUTHORIZATION_INVALID',
+                    'error' => 'A user ID and license key are required to use this service'
+                )
+            ),
+            '1.2.3.16' => $this->response(
+                'error',
+                401,
+                array(
+                    'code' => 'LICENSE_KEY_REQUIRED',
+                    'error' => 'A license key is required to use this service'
+                )
+            ),
+            '1.2.3.17' => $this->response(
+                'error',
+                401,
+                array(
+                    'code' => 'USER_ID_REQUIRED',
+                    'error' => 'A user ID is required to use this service'
+                )
+            ),
+            '1.2.3.18' => $this->response(
+                'error',
+                402,
+                array(
+                    'code' => 'OUT_OF_QUERIES',
+                    'error' => 'The license key you have provided is out of queries.'
+                )
+            ),
         );
         return $responses[$ip];
     }
@@ -207,7 +255,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
 
 
     /**
-     * @expectedException GeoIp2\Exception\WebServiceException
+     * @expectedException GeoIp2\Exception\InvalidRequestException
      * @expectedExceptionCode 400
      * @expectedExceptionMessage The value "1.2.3" is not a valid ip address
      */
@@ -216,7 +264,6 @@ class ClientTest extends \PHPUnit_Framework_TestCase
         $client = $this->client($this->getResponse('1.2.3.6'));
 
         $client->country('1.2.3.6');
-
     }
 
     /**
@@ -293,6 +340,72 @@ class ClientTest extends \PHPUnit_Framework_TestCase
         $client->country('1.2.3.12');
     }
 
+    /**
+     * @expectedException GeoIp2\Exception\AddressNotFoundException
+     * @expectedExceptionMessage The address "1.2.3.13" is not in our database.
+     */
+    public function testAddressNotFoundException()
+    {
+        $client = $this->client($this->getResponse('1.2.3.13'));
+
+        $client->country('1.2.3.13');
+    }
+
+    /**
+     * @expectedException GeoIp2\Exception\AddressNotFoundException
+     * @expectedExceptionMessage The address "1.2.3.14" is a private address.
+     */
+    public function testAddressReservedException()
+    {
+        $client = $this->client($this->getResponse('1.2.3.14'));
+
+        $client->country('1.2.3.14');
+    }
+
+    /**
+     * @expectedException GeoIp2\Exception\AuthenticationException
+     * @expectedExceptionMessage A user ID and license key are required to use this service
+     */
+    public function testAuthorizationException()
+    {
+        $client = $this->client($this->getResponse('1.2.3.15'));
+
+        $client->country('1.2.3.15');
+    }
+
+    /**
+     * @expectedException GeoIp2\Exception\AuthenticationException
+     * @expectedExceptionMessage A license key is required to use this service
+     */
+    public function testMissingLicenseKeyException()
+    {
+        $client = $this->client($this->getResponse('1.2.3.16'));
+
+        $client->country('1.2.3.16');
+    }
+
+    /**
+     * @expectedException GeoIp2\Exception\AuthenticationException
+     * @expectedExceptionMessage A user ID is required to use this service
+     */
+    public function testMissingUserIdException()
+    {
+        $client = $this->client($this->getResponse('1.2.3.17'));
+
+        $client->country('1.2.3.17');
+    }
+
+    /**
+     * @expectedException GeoIp2\Exception\OutOfQueriesException
+     * @expectedExceptionMessage The license key you have provided is out of queries.
+     */
+    public function testOutOfQueriesException()
+    {
+        $client = $this->client($this->getResponse('1.2.3.18'));
+
+        $client->country('1.2.3.18');
+    }
+
     public function testParams()
     {
         $plugin = new MockPlugin();
@@ -337,7 +450,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
     }
 
 
-    private function client($response, $languages = array('en'))
+    private function client($response, $locales = array('en'))
     {
         $plugin = new MockPlugin();
         $plugin->addResponse($response);
@@ -347,7 +460,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
         $client = new Client(
             42,
             'abcdef123456',
-            $languages,
+            $locales,
             'geoip.maxmind.com',
             $guzzleClient
         );