18 Commits

Author SHA1 Message Date
Gregory Oschwald
8febab1fe4 Updates for v0.4.0 release 2013-07-16 12:40:34 -07:00
Gregory Oschwald
f0430b613d No reason for call_user_func_array 2013-07-16 10:34:44 -07:00
Gregory Oschwald
e3289ec416 Fix for PHP 5.3 where you can't use '$this' in a callback. 2013-07-16 10:11:06 -07:00
Gregory Oschwald
1d1dcec74c Added missing method documentation 2013-07-16 09:48:45 -07:00
Gregory Oschwald
630765f924 Make unit tests check all the methods 2013-07-16 09:44:30 -07:00
Gregory Oschwald
b55d42b5cd Documentation updates 2013-07-16 09:21:08 -07:00
Gregory Oschwald
044ca4d085 Added specific exceptions for the different types of errors. 2013-07-16 07:46:50 -07:00
Gregory Oschwald
3ba84992c8 Updated for new test path 2013-07-15 16:10:05 -07:00
Gregory Oschwald
a6c1f9378e Updated submodule 2013-07-15 16:09:31 -07:00
Gregory Oschwald
1c0817d133 Test looking up an invalid address 2013-07-15 16:05:08 -07:00
Gregory Oschwald
59a51ef34d Tests for the reader 2013-07-15 15:52:07 -07:00
Gregory Oschwald
3e0fc2a837 Basic GeoIP2 database reader 2013-07-15 15:06:51 -07:00
Gregory Oschwald
c898f76a50 Release of 0.3.0 with updated namespace 2013-07-12 07:01:27 -07:00
Gregory Oschwald
8a265a763e Remove HipChat notifications due to popular demand. 2013-07-12 07:00:48 -07:00
Gregory Oschwald
3579ce7297 Doc updates plus HipChat notification 2013-07-10 19:25:09 -07:00
Gregory Oschwald
aa88c3040f Fixed a couple of incorrect case changes 2013-07-10 15:35:09 -07:00
Gregory Oschwald
5df4bbee47 Fix composer file 2013-07-10 15:30:33 -07:00
Gregory Oschwald
e60181f13a Rename GeoIP2 => GeoIp2 for consistency 2013-07-10 15:24:40 -07:00
38 changed files with 703 additions and 248 deletions

1
.gitignore vendored
View File

@@ -3,6 +3,7 @@ _site
composer.lock composer.lock
composer.phar composer.phar
phpunit.xml phpunit.xml
geoip2-php.sublime-*
vendor/ vendor/
*.sw? *.sw?
t.php t.php

3
.gitmodules vendored Normal file
View File

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

View File

@@ -1,6 +1,20 @@
CHANGELOG CHANGELOG
========= =========
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)
------------------
* In namespaces and class names, "GeoIP2" was renamed to "GeoIp2" to improve
consistency.
0.2.1 (2013-06-10) 0.2.1 (2013-06-10)
------------------ ------------------
@@ -13,18 +27,18 @@ CHANGELOG
* `GenericException` was renamed to `GeoIP2Exception`. * `GenericException` was renamed to `GeoIP2Exception`.
* We now support more languages. The new languages are de, es, fr, and pt-BR. * We now support more languages. The new languages are de, es, fr, and pt-BR.
* The REST API now returns a record with data about your account. There is * The REST API now returns a record with data about your account. There is
a new geoip.records.MaxMind class for this data. a new `GeoIP\Records\MaxMind` class for this data.
* The `continentCode` attribute on `Continent` was renamed to `code`. * The `continentCode` attribute on `Continent` was renamed to `code`.
* Documentation updates. * Documentation updates.
0.1.1 (2013-05-14) 0.1.1 (2013-05-14)
------------------ ------------------
* Updated Guzzle version requirement * Updated Guzzle version requirement.
* Fixed Composer example in README.md * Fixed Composer example in README.md.
0.1.0 (2013-05-13) 0.1.0 (2013-05-13)
------------------ ------------------
* Initial release * Initial release.

View File

@@ -13,27 +13,22 @@ To provide feedback or get support during the beta, please see the
## Description ## ## Description ##
Currently, this distribution provides an API for the [GeoIP2 web services] This distribution provides an API for the [GeoIP2 web services]
(http://dev.maxmind.com/geoip/geoip2/web-services). (http://dev.maxmind.com/geoip/geoip2/web-services) and the [GeoLite2
databases](http://dev.maxmind.com/geoip/geoip2/geolite2/). The commercial
In the future, this distribution will also provide the same API for the GeoIP2 databases have not yet been released as a downloadable product.
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.
## Installation ## ## Installation ##
### Define Your Dependencies ### ### Define Your Dependencies ###
We recommend installing this package with [Composer](http://getcomposer.org/). 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 ```json
{ {
"require": { "require": {
"geoip2/geoip2": "0.2.*" "geoip2/geoip2": "0.4.*"
} }
} }
``` ```
@@ -60,11 +55,43 @@ You can autoload all dependencies by adding this to your code:
``` ```
require 'vendor/autoload.php'; require 'vendor/autoload.php';
``` ```
## Database Reader ##
## Usage ## ### Usage ###
To use this API, you must create a new ``\GeoIP2\WebService\Client`` To use this API, you must create a new `\GeoIp2\Database\Reader` object with
object with your ``$userId`` and ``$licenseKey``, then you call the method 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;
$reader = new Reader('/usr/local/share/GeoIP2/GeoIP2-City.mmdb');
$record = $reader->city('24.24.24.24');
print($record->country->isoCode);
```
## 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 corresponding to a specific end point, passing it the IP address you want to
look up. look up.
@@ -72,41 +99,23 @@ 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 point you called. This model in turn contains multiple record classes, each of
which represents part of the data returned by the web service. 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. See the API documentation for more details.
## Example ## ### Example ###
```php ```php
<?php <?php
require_once 'vendor/autoload.php'; require_once 'vendor/autoload.php';
use \GeoIP2\WebService\Client; use \GeoIp2\WebService\Client;
$client = new Client(42, 'abcdef123456'); $client = new Client(42, 'abcdef123456');
$omni = $client->omni('24.24.24.24'); $omni = $client->omni('24.24.24.24');
echo $omni->country->isoCode; print($omni->country->isoCode);
``` ```
## Exceptions ## ### What data is returned? ###
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? ##
While many of the end points return the same basic records, the attributes 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 which can be populated vary between end points. In addition, while an end
@@ -120,8 +129,8 @@ See the
[GeoIP2 web service docs](http://dev.maxmind.com/geoip/geoip2/web-services) [GeoIP2 web service docs](http://dev.maxmind.com/geoip/geoip2/web-services)
for details on what data each end point may return. for details on what data each end point may return.
The only piece of data which is always returned is the ```ipAddress``` The only piece of data which is always returned is the `ipAddress`
attribute in the ``GeoIP2\Record\Traits`` record. attribute in the `GeoIp2\Record\Traits` record.
Every record class attribute has a corresponding predicate method so you can Every record class attribute has a corresponding predicate method so you can
check to see if the attribute is set. check to see if the attribute is set.
@@ -131,10 +140,10 @@ check to see if the attribute is set.
[GeoNames](http://www.geonames.org/) offers web services and downloadable [GeoNames](http://www.geonames.org/) offers web services and downloadable
databases with data on geographical features around the world, including databases with data on geographical features around the world, including
populated places. They offer both free and paid premium data. Each 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 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. (city, region, country, etc.) in the GeoNames database.
Some of the data that MaxMind provides is also sourced from GeoNames. We Some of the data that MaxMind provides is also sourced from GeoNames. We

View File

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

View File

@@ -14,6 +14,7 @@
], ],
"require": { "require": {
"guzzle/guzzle": "3.*", "guzzle/guzzle": "3.*",
"maxmind-db/reader": "0.1.*",
"php": ">=5.3.1" "php": ">=5.3.1"
}, },
"require-dev": { "require-dev": {
@@ -21,6 +22,6 @@
"satooshi/php-coveralls": "dev-master" "satooshi/php-coveralls": "dev-master"
}, },
"autoload": { "autoload": {
"psr-0": { "GeoIP2": "src/" } "psr-0": { "GeoIp2": "src/" }
} }
} }

1
maxmind-db Submodule

Submodule maxmind-db added at f7b9342b84

View File

@@ -3,13 +3,13 @@
<phpunit bootstrap="./tests/bootstrap.php" colors="true"> <phpunit bootstrap="./tests/bootstrap.php" colors="true">
<testsuites> <testsuites>
<testsuite name="GeoIP2 Test Suite"> <testsuite name="GeoIP2 Test Suite">
<directory suffix="Test.php">./tests/GeoIP2/Test/</directory> <directory suffix="Test.php">./tests/GeoIp2/Test/</directory>
</testsuite> </testsuite>
</testsuites> </testsuites>
<filter> <filter>
<whitelist> <whitelist>
<directory suffix=".php">./src/GeoIP2/</directory> <directory suffix=".php">./src/GeoIp2/</directory>
</whitelist> </whitelist>
</filter> </filter>

View File

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

View File

@@ -0,0 +1,150 @@
<?php
namespace GeoIp2\Database;
use GeoIp2\Exception\AddressNotFoundException;
use GeoIp2\Model\City;
use GeoIp2\Model\CityIspOrg;
use GeoIp2\Model\Country;
use GeoIp2\Model\Omni;
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
{
private $dbReader;
private $languages;
/**
* Constructor.
*
* @param string $filename The path to the GeoIP2 database file.
* @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
* is corrupt or invalid
*/
public function __construct(
$filename,
$languages = array('en')
) {
$this->dbReader = new DbReader($filename);
$this->languages = $languages;
}
/**
* 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->languages);
}
/**
* Closes the GeoIP2 database and returns the resources to the system.
*/
public function close()
{
$this->dbReader->close();
}
}

View File

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

View File

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

View File

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

View File

@@ -1,12 +1,12 @@
<?php <?php
namespace GeoIP2\Exception; namespace GeoIp2\Exception;
/** /**
* This class represents an HTTP transport error. * This class represents an HTTP transport error.
*/ */
class HttpException extends GeoIP2Exception class HttpException extends GeoIp2Exception
{ {
/** /**
* The URI queried * The URI queried

View File

@@ -1,12 +1,12 @@
<?php <?php
namespace GeoIP2\Exception; namespace GeoIp2\Exception;
/** /**
* This class represents an error returned by MaxMind's GeoIP2 * This class represents an error returned by MaxMind's GeoIP2
* web service. * web service.
*/ */
class WebServiceException extends HttpException class InvalidRequestException extends HttpException
{ {
/** /**
* The code returned by the MaxMind web service * The code returned by the MaxMind web service

View File

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

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Model; namespace GeoIp2\Model;
/** /**
* This class provides a model for the data returned by the GeoIP2 * This class provides a model for the data returned by the GeoIP2
@@ -10,33 +10,33 @@ namespace GeoIP2\Model;
* classes is which fields in each record may be populated. See * classes is which fields in each record may be populated. See
* http://dev.maxmind.com/geoip/geoip2/web-services more details. * http://dev.maxmind.com/geoip/geoip2/web-services more details.
* *
* @property \GeoIP2\Record\City $city City data for the requested IP * @property \GeoIp2\Record\City $city City data for the requested IP
* address. * address.
* *
* @property \GeoIP2\Record\Continent $continent Continent data for the * @property \GeoIp2\Record\Continent $continent Continent data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\Country $country Country data for the requested * @property \GeoIp2\Record\Country $country Country data for the requested
* IP address. This object represents the country where MaxMind believes the * IP address. This object represents the country where MaxMind believes the
* end user is located. * end user is located.
* *
* @property \GeoIP2\Record\Location $location Location data for the * @property \GeoIp2\Record\Location $location Location data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\MaxMind $maxmind Data related to your MaxMind * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
* account. * account.
* *
* @property \GeoIP2\Record\Country $registeredCountry Registered country * @property \GeoIp2\Record\Country $registeredCountry Registered country
* data for the requested IP address. This record represents the country * data for the requested IP address. This record represents the country
* where the ISP has registered a given IP block and may differ from the * where the ISP has registered a given IP block and may differ from the
* user's country. * user's country.
* *
* @property \GeoIP2\Record\RepresentedCountry $representedCountry * @property \GeoIp2\Record\RepresentedCountry $representedCountry
* Represented country data for the requested IP address. The represented * Represented country data for the requested IP address. The represented
* country is used for things like military bases or embassies. It is only * country is used for things like military bases or embassies. It is only
* present when the represented country differs from the country. * present when the represented country differs from the country.
* *
* @property array $subdivisions An array of {@link \GeoIP2\Record\Subdivision} * @property array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
* objects representing the country subdivisions for the requested IP * objects representing the country subdivisions for the requested IP
* address. The number and type of subdivisions varies by country, but a * address. The number and type of subdivisions varies by country, but a
* subdivision is typically a state, province, county, etc. Subdivisions * subdivision is typically a state, province, county, etc. Subdivisions
@@ -44,12 +44,12 @@ namespace GeoIP2\Model;
* If the response did not contain any subdivisions, this method returns * If the response did not contain any subdivisions, this method returns
* an empty array. * an empty array.
* *
* @property \GeoIP2\Record\Subdivision $mostSpecificSubdivision An object * @property \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
* representing the most specific subdivision returned. If the response * representing the most specific subdivision returned. If the response
* did not contain any subdivisions, this method returns an empty * did not contain any subdivisions, this method returns an empty
* {@link \GeoIP2\Record\Subdivision} object. * {@link \GeoIp2\Record\Subdivision} object.
* *
* @property \GeoIP2\Record\Traits $traits Data for the traits of the * @property \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address. * requested IP address.
*/ */
class City extends Country class City extends Country
@@ -78,9 +78,9 @@ class City extends Country
{ {
parent::__construct($raw, $languages); parent::__construct($raw, $languages);
$this->city = new \GeoIP2\Record\City($this->get('city'), $languages); $this->city = new \GeoIp2\Record\City($this->get('city'), $languages);
$this->location = new \GeoIP2\Record\Location($this->get('location')); $this->location = new \GeoIp2\Record\Location($this->get('location'));
$this->postal = new \GeoIP2\Record\Postal($this->get('postal')); $this->postal = new \GeoIp2\Record\Postal($this->get('postal'));
$this->createSubdivisions($raw, $languages); $this->createSubdivisions($raw, $languages);
} }
@@ -94,7 +94,7 @@ class City extends Country
foreach ($raw['subdivisions'] as $sub) { foreach ($raw['subdivisions'] as $sub) {
array_push( array_push(
$this->subdivisions, $this->subdivisions,
new \GeoIP2\Record\Subdivision($sub, $languages) new \GeoIp2\Record\Subdivision($sub, $languages)
); );
} }
} }
@@ -114,7 +114,7 @@ class City extends Country
private function mostSpecificSubdivision() private function mostSpecificSubdivision()
{ {
return empty($this->subdivisions)? return empty($this->subdivisions)?
new \GeoIP2\Record\Subdivision(array(), $this->languages): new \GeoIp2\Record\Subdivision(array(), $this->languages):
end($this->subdivisions); end($this->subdivisions);
} }
} }

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Model; namespace GeoIp2\Model;
/** /**
* This class provides a model for the data returned by the GeoIP2 * This class provides a model for the data returned by the GeoIP2
@@ -10,33 +10,33 @@ namespace GeoIP2\Model;
* classes is which fields in each record may be populated. See * classes is which fields in each record may be populated. See
* http://dev.maxmind.com/geoip/geoip2/web-services more details. * http://dev.maxmind.com/geoip/geoip2/web-services more details.
* *
* @property \GeoIP2\Record\City $city City data for the requested IP * @property \GeoIp2\Record\City $city City data for the requested IP
* address. * address.
* *
* @property \GeoIP2\Record\Continent $continent Continent data for the * @property \GeoIp2\Record\Continent $continent Continent data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\Country $country Country data for the requested * @property \GeoIp2\Record\Country $country Country data for the requested
* IP address. This object represents the country where MaxMind believes the * IP address. This object represents the country where MaxMind believes the
* end user is located. * end user is located.
* *
* @property \GeoIP2\Record\Location $location Location data for the * @property \GeoIp2\Record\Location $location Location data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\MaxMind $maxmind Data related to your MaxMind * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
* account. * account.
* *
* @property \GeoIP2\Record\Country $registeredCountry Registered country * @property \GeoIp2\Record\Country $registeredCountry Registered country
* data for the requested IP address. This record represents the country * data for the requested IP address. This record represents the country
* where the ISP has registered a given IP block and may differ from the * where the ISP has registered a given IP block and may differ from the
* user's country. * user's country.
* *
* @property \GeoIP2\Record\RepresentedCountry $representedCountry * @property \GeoIp2\Record\RepresentedCountry $representedCountry
* Represented country data for the requested IP address. The represented * Represented country data for the requested IP address. The represented
* country is used for things like military bases or embassies. It is only * country is used for things like military bases or embassies. It is only
* present when the represented country differs from the country. * present when the represented country differs from the country.
* *
* @property array $subdivisions An array of {@link \GeoIP2\Record\Subdivision} * @property array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
* objects representing the country subdivisions for the requested IP * objects representing the country subdivisions for the requested IP
* address. The number and type of subdivisions varies by country, but a * address. The number and type of subdivisions varies by country, but a
* subdivision is typically a state, province, county, etc. Subdivisions * subdivision is typically a state, province, county, etc. Subdivisions
@@ -44,12 +44,12 @@ namespace GeoIP2\Model;
* If the response did not contain any subdivisions, this method returns * If the response did not contain any subdivisions, this method returns
* an empty array. * an empty array.
* *
* @property \GeoIP2\Record\Subdivision $mostSpecificSubdivision An object * @property \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
* representing the most specific subdivision returned. If the response * representing the most specific subdivision returned. If the response
* did not contain any subdivisions, this method returns an empty * did not contain any subdivisions, this method returns an empty
* {@link \GeoIP2\Record\Subdivision} object. * {@link \GeoIp2\Record\Subdivision} object.
* *
* @property \GeoIP2\Record\Traits $traits Data for the traits of the * @property \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address. * requested IP address.
*/ */
class CityIspOrg extends City class CityIspOrg extends City

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Model; namespace GeoIp2\Model;
/** /**
* This class provides a model for the data returned by the GeoIP2 Country * This class provides a model for the data returned by the GeoIP2 Country
@@ -10,27 +10,27 @@ namespace GeoIP2\Model;
* classes is which fields in each record may be populated. See * classes is which fields in each record may be populated. See
* http://dev.maxmind.com/geoip/geoip2/web-services more details. * http://dev.maxmind.com/geoip/geoip2/web-services more details.
* *
* @property \GeoIP2\Record\Continent $continent Continent data for the * @property \GeoIp2\Record\Continent $continent Continent data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\Country $country Country data for the requested * @property \GeoIp2\Record\Country $country Country data for the requested
* IP address. This object represents the country where MaxMind believes the * IP address. This object represents the country where MaxMind believes the
* end user is located. * end user is located.
* *
* @property \GeoIP2\Record\MaxMind $maxmind Data related to your MaxMind * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
* account. * account.
* *
* @property \GeoIP2\Record\Country $registeredCountry Registered country * @property \GeoIp2\Record\Country $registeredCountry Registered country
* data for the requested IP address. This record represents the country * data for the requested IP address. This record represents the country
* where the ISP has registered a given IP block and may differ from the * where the ISP has registered a given IP block and may differ from the
* user's country. * user's country.
* *
* @property \GeoIP2\Record\RepresentedCountry $representedCountry * @property \GeoIp2\Record\RepresentedCountry $representedCountry
* Represented country data for the requested IP address. The represented * Represented country data for the requested IP address. The represented
* country is used for things like military bases or embassies. It is only * country is used for things like military bases or embassies. It is only
* present when the represented country differs from the country. * present when the represented country differs from the country.
* *
* @property \GeoIP2\Record\Traits $traits Data for the traits of the * @property \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address. * requested IP address.
*/ */
class Country class Country
@@ -51,24 +51,24 @@ class Country
{ {
$this->raw = $raw; $this->raw = $raw;
$this->continent = new \GeoIP2\Record\Continent( $this->continent = new \GeoIp2\Record\Continent(
$this->get('continent'), $this->get('continent'),
$languages $languages
); );
$this->country = new \GeoIP2\Record\Country( $this->country = new \GeoIp2\Record\Country(
$this->get('country'), $this->get('country'),
$languages $languages
); );
$this->maxmind = new \GeoIP2\Record\MaxMind($this->get('maxmind')); $this->maxmind = new \GeoIp2\Record\MaxMind($this->get('maxmind'));
$this->registeredCountry = new \GeoIP2\Record\Country( $this->registeredCountry = new \GeoIp2\Record\Country(
$this->get('registered_country'), $this->get('registered_country'),
$languages $languages
); );
$this->representedCountry = new \GeoIP2\Record\RepresentedCountry( $this->representedCountry = new \GeoIp2\Record\RepresentedCountry(
$this->get('represented_country'), $this->get('represented_country'),
$languages $languages
); );
$this->traits = new \GeoIP2\Record\Traits($this->get('traits')); $this->traits = new \GeoIp2\Record\Traits($this->get('traits'));
$this->languages = $languages; $this->languages = $languages;
} }

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Model; namespace GeoIp2\Model;
/** /**
* This class provides a model for the data returned by the GeoIP2 * This class provides a model for the data returned by the GeoIP2
@@ -10,33 +10,33 @@ namespace GeoIP2\Model;
* classes is which fields in each record may be populated. See * classes is which fields in each record may be populated. See
* http://dev.maxmind.com/geoip/geoip2/web-services more details. * http://dev.maxmind.com/geoip/geoip2/web-services more details.
* *
* @property \GeoIP2\Record\City $city City data for the requested IP * @property \GeoIp2\Record\City $city City data for the requested IP
* address. * address.
* *
* @property \GeoIP2\Record\Continent $continent Continent data for the * @property \GeoIp2\Record\Continent $continent Continent data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\Country $country Country data for the requested * @property \GeoIp2\Record\Country $country Country data for the requested
* IP address. This object represents the country where MaxMind believes the * IP address. This object represents the country where MaxMind believes the
* end user is located. * end user is located.
* *
* @property \GeoIP2\Record\Location $location Location data for the * @property \GeoIp2\Record\Location $location Location data for the
* requested IP address. * requested IP address.
* *
* @property \GeoIP2\Record\MaxMind $maxmind Data related to your MaxMind * @property \GeoIp2\Record\MaxMind $maxmind Data related to your MaxMind
* account. * account.
* *
* @property \GeoIP2\Record\Country $registeredCountry Registered country * @property \GeoIp2\Record\Country $registeredCountry Registered country
* data for the requested IP address. This record represents the country * data for the requested IP address. This record represents the country
* where the ISP has registered a given IP block and may differ from the * where the ISP has registered a given IP block and may differ from the
* user's country. * user's country.
* *
* @property \GeoIP2\Record\RepresentedCountry $representedCountry * @property \GeoIp2\Record\RepresentedCountry $representedCountry
* Represented country data for the requested IP address. The represented * Represented country data for the requested IP address. The represented
* country is used for things like military bases or embassies. It is only * country is used for things like military bases or embassies. It is only
* present when the represented country differs from the country. * present when the represented country differs from the country.
* *
* @property array $subdivisions An array of {@link \GeoIP2\Record\Subdivision} * @property array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
* objects representing the country subdivisions for the requested IP * objects representing the country subdivisions for the requested IP
* address. The number and type of subdivisions varies by country, but a * address. The number and type of subdivisions varies by country, but a
* subdivision is typically a state, province, county, etc. Subdivisions * subdivision is typically a state, province, county, etc. Subdivisions
@@ -44,12 +44,12 @@ namespace GeoIP2\Model;
* If the response did not contain any subdivisions, this method returns * If the response did not contain any subdivisions, this method returns
* an empty array. * an empty array.
* *
* @property \GeoIP2\Record\Subdivision $mostSpecificSubdivision An object * @property \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
* representing the most specific subdivision returned. If the response * representing the most specific subdivision returned. If the response
* did not contain any subdivisions, this method returns an empty * did not contain any subdivisions, this method returns an empty
* {@link \GeoIP2\Record\Subdivision} object. * {@link \GeoIp2\Record\Subdivision} object.
* *
* @property \GeoIP2\Record\Traits $traits Data for the traits of the * @property \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address. * requested IP address.
*/ */
class Omni extends CityIspOrg class Omni extends CityIspOrg

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
abstract class AbstractPlaceRecord extends AbstractRecord abstract class AbstractPlaceRecord extends AbstractRecord
{ {

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
abstract class AbstractRecord abstract class AbstractRecord
{ {

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* City-level data associated with an IP address. * City-level data associated with an IP address.

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* Contains data for the continent record associated with an IP address * Contains data for the continent record associated with an IP address

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* Contains data for the country record associated with an IP address * Contains data for the country record associated with an IP address

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* Contains data for the location record associated with an IP address * Contains data for the location record associated with an IP address

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* Contains data about your account. * Contains data about your account.

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* Contains data for the postal record associated with an IP address * Contains data for the postal record associated with an IP address

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* Contains data for the represented country associated with an IP address * Contains data for the represented country associated with an IP address

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* *

View File

@@ -1,6 +1,6 @@
<?php <?php
namespace GeoIP2\Record; namespace GeoIp2\Record;
/** /**
* *

View File

@@ -1,14 +1,17 @@
<?php <?php
namespace GeoIP2\WebService; namespace GeoIp2\WebService;
use GeoIP2\Exception\GeoIP2Exception; use GeoIp2\Exception\GeoIp2Exception;
use GeoIP2\Exception\HttpException; use GeoIp2\Exception\HttpException;
use GeoIP2\Exception\WebServiceException; use GeoIp2\Exception\AddressNotFoundException;
use GeoIP2\Model\City; use GeoIp2\Exception\AuthenticationException;
use GeoIP2\Model\CityIspOrg; use GeoIp2\Exception\InvalidRequestException;
use GeoIP2\Model\Country; use GeoIp2\Exception\OutOfQueriesException;
use GeoIP2\Model\Omni; use GeoIp2\Model\City;
use GeoIp2\Model\CityIspOrg;
use GeoIp2\Model\Country;
use GeoIp2\Model\Omni;
use Guzzle\Http\Client as GuzzleClient; use Guzzle\Http\Client as GuzzleClient;
use Guzzle\Common\Exception\RuntimeException; use Guzzle\Common\Exception\RuntimeException;
use Guzzle\Http\Exception\ClientErrorResponseException; use Guzzle\Http\Exception\ClientErrorResponseException;
@@ -44,26 +47,6 @@ use Guzzle\Http\Exception\ServerErrorResponseException;
* service. * service.
* *
* If the request fails, the client class throws an exception. * 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
{ {
@@ -106,14 +89,25 @@ class Client
* address is provided, the address that the web service is called * address is provided, the address that the web service is called
* from will be used. * from will be used.
* *
* @return \GeoIP2\Model\City * @return \GeoIp2\Model\City
* *
* @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
* error processing your request. * provided is not in our database (e.g., a private address).
* @throws \GeoIP2\Exception\HttpException if there was an HTTP transport * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
* error. * with the user ID or license key that you provided.
* @throws \GeoIP2\Exception\WebServiceException if an error was returned * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
* by MaxMind's GeoIP2 web service. * 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') public function city($ipAddress = 'me')
{ {
@@ -127,14 +121,25 @@ class Client
* address is provided, the address that the web service is called * address is provided, the address that the web service is called
* from will be used. * from will be used.
* *
* @return \GeoIP2\Model\Country * @return \GeoIp2\Model\Country
* *
* @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
* error processing your request. * provided is not in our database (e.g., a private address).
* @throws \GeoIP2\Exception\HttpException if there was an HTTP transport * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
* error. * with the user ID or license key that you provided.
* @throws \GeoIP2\Exception\WebServiceException if an error was returned * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
* by MaxMind's GeoIP2 web service. * 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') public function country($ipAddress = 'me')
{ {
@@ -148,14 +153,25 @@ class Client
* address is provided, the address that the web service is called * address is provided, the address that the web service is called
* from will be used. * from will be used.
* *
* @return \GeoIP2\Model\CityIspOrg * @return \GeoIp2\Model\CityIspOrg
* *
* @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
* error processing your request. * provided is not in our database (e.g., a private address).
* @throws \GeoIP2\Exception\HttpException if there was an HTTP transport * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
* error. * with the user ID or license key that you provided.
* @throws \GeoIP2\Exception\WebServiceException if an error was returned * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
* by MaxMind's GeoIP2 web service. * 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') public function cityIspOrg($ipAddress = 'me')
{ {
@@ -169,14 +185,25 @@ class Client
* address is provided, the address that the web service is called * address is provided, the address that the web service is called
* from will be used. * from will be used.
* *
* @return \GeoIP2\Model\Omni * @return \GeoIp2\Model\Omni
* *
* @throws \GeoIP2\Exception\GeoIP2Exception if there was a generic * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
* error processing your request. * provided is not in our database (e.g., a private address).
* @throws \GeoIP2\Exception\HttpException if there was an HTTP transport * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
* error. * with the user ID or license key that you provided.
* @throws \GeoIP2\Exception\WebServiceException if an error was returned * @throws \GeoIp2\Exception\QutOfQueriesException if your account is out
* by MaxMind's GeoIP2 web service. * 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') public function omni($ipAddress = 'me')
{ {
@@ -191,11 +218,8 @@ class Client
$this->guzzleClient : new GuzzleClient(); $this->guzzleClient : new GuzzleClient();
$request = $client->get($uri, array('Accept' => 'application/json')); $request = $client->get($uri, array('Accept' => 'application/json'));
$request->setAuth($this->userId, $this->licenseKey); $request->setAuth($this->userId, $this->licenseKey);
$ua = $request->getHeader('User-Agent'); $this->setUserAgent($request);
$ua = "GeoIP2 PHP API ($ua)";
$request->setHeader('User-Agent', $ua);
$response = null;
try { try {
$response = $request->send(); $response = $request->send();
} catch (ClientErrorResponseException $e) { } catch (ClientErrorResponseException $e) {
@@ -206,7 +230,7 @@ class Client
if ($response && $response->isSuccessful()) { if ($response && $response->isSuccessful()) {
$body = $this->handleSuccess($response, $uri); $body = $this->handleSuccess($response, $uri);
$class = "GeoIP2\\Model\\" . $class; $class = "GeoIp2\\Model\\" . $class;
return new $class($body, $this->languages); return new $class($body, $this->languages);
} else { } else {
$this->handleNon200($response, $uri); $this->handleNon200($response, $uri);
@@ -216,7 +240,7 @@ class Client
private function handleSuccess($response, $uri) private function handleSuccess($response, $uri)
{ {
if ($response->getContentLength() == 0) { if ($response->getContentLength() == 0) {
throw new GeoIP2Exception( throw new GeoIp2Exception(
"Received a 200 response for $uri but did not " . "Received a 200 response for $uri but did not " .
"receive a HTTP body." "receive a HTTP body."
); );
@@ -225,7 +249,7 @@ class Client
try { try {
return $response->json(); return $response->json();
} catch (RuntimeException $e) { } catch (RuntimeException $e) {
throw new GeoIP2Exception( throw new GeoIp2Exception(
"Received a 200 response for $uri but could not decode " . "Received a 200 response for $uri but could not decode " .
"the response as JSON: " . $e->getMessage() "the response as JSON: " . $e->getMessage()
); );
@@ -244,7 +268,7 @@ class Client
try { try {
$body = $response->json(); $body = $response->json();
if (!isset($body['code']) || !isset($body['error'])) { if (!isset($body['code']) || !isset($body['error'])) {
throw new GeoIP2Exception( throw new GeoIp2Exception(
'Response contains JSON but it does not specify ' . 'Response contains JSON but it does not specify ' .
'code or error keys: ' . $response->getBody() 'code or error keys: ' . $response->getBody()
); );
@@ -273,8 +297,7 @@ class Client
$uri $uri
); );
} }
$this->handleWebServiceError(
throw new WebServiceException(
$body['error'], $body['error'],
$body['code'], $body['code'],
$status, $status,
@@ -282,6 +305,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) private function handle5xx($response, $uri)
{ {
$status = $response->getStatusCode(); $status = $response->getStatusCode();
@@ -305,6 +350,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() private function baseUri()
{ {
return 'https://' . $this->host . '/geoip/v2.0'; return 'https://' . $this->host . '/geoip/v2.0';

View File

@@ -0,0 +1,80 @@
<?php
namespace GeoIp2\Test\WebService;
use GeoIp2\Database\Reader;
class ReaderTest extends \PHPUnit_Framework_TestCase
{
public function testDefaultLanguage()
{
$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 testLanguageList()
{
$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 invalid 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);
}
}
}

View File

@@ -1,8 +1,8 @@
<?php <?php
namespace GeoIP2\Test\Model; namespace GeoIp2\Test\Model;
use GeoIP2\Model\Country; use GeoIp2\Model\Country;
class CountryTest extends \PHPUnit_Framework_TestCase class CountryTest extends \PHPUnit_Framework_TestCase
{ {
@@ -38,28 +38,28 @@ class CountryTest extends \PHPUnit_Framework_TestCase
public function testObjects () public function testObjects ()
{ {
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Model\Country', 'GeoIp2\Model\Country',
$this->model, $this->model,
'minimal GeoIP2::Model::Country object' 'minimal GeoIp2::Model::Country object'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Continent', 'GeoIp2\Record\Continent',
$this->model->continent $this->model->continent
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Country', 'GeoIp2\Record\Country',
$this->model->country $this->model->country
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Country', 'GeoIp2\Record\Country',
$this->model->registeredCountry $this->model->registeredCountry
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\RepresentedCountry', 'GeoIp2\Record\RepresentedCountry',
$this->model->representedCountry $this->model->representedCountry
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Traits', 'GeoIp2\Record\Traits',
$this->model->traits $this->model->traits
); );
} }

View File

@@ -1,8 +1,8 @@
<?php <?php
namespace GeoIP2\Test\Model; namespace GeoIp2\Test\Model;
use GeoIP2\Model\Country; use GeoIp2\Model\Country;
class NameTest extends \PHPUnit_Framework_TestCase class NameTest extends \PHPUnit_Framework_TestCase
{ {
@@ -46,7 +46,8 @@ class NameTest extends \PHPUnit_Framework_TestCase
); );
} }
public function testTwoFallbacks() { public function testTwoFallbacks()
{
$model = new Country($this->raw, array('ru', 'ja')); $model = new Country($this->raw, array('ru', 'ja'));
$this->assertEquals( $this->assertEquals(

View File

@@ -1,8 +1,8 @@
<?php <?php
namespace GeoIP2\Test\Model; namespace GeoIp2\Test\Model;
use GeoIP2\Model\Omni; use GeoIp2\Model\Omni;
class OmniTest extends \PHPUnit_Framework_TestCase class OmniTest extends \PHPUnit_Framework_TestCase
{ {
@@ -72,60 +72,60 @@ class OmniTest extends \PHPUnit_Framework_TestCase
$model = new Omni($raw, array('en')); $model = new Omni($raw, array('en'));
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Model\Omni', 'GeoIp2\Model\Omni',
$model, $model,
'GeoIP2\Model\Omni object' 'GeoIp2\Model\Omni object'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\City', 'GeoIp2\Record\City',
$model->city, $model->city,
'$model->city' '$model->city'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Continent', 'GeoIp2\Record\Continent',
$model->continent, $model->continent,
'$model->continent' '$model->continent'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Country', 'GeoIp2\Record\Country',
$model->country, $model->country,
'$model->country' '$model->country'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Location', 'GeoIp2\Record\Location',
$model->location, $model->location,
'$model->location' '$model->location'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Country', 'GeoIp2\Record\Country',
$model->registeredCountry, $model->registeredCountry,
'$model->registeredCountry' '$model->registeredCountry'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\RepresentedCountry', 'GeoIp2\Record\RepresentedCountry',
$model->representedCountry, $model->representedCountry,
'$model->representedCountry' '$model->representedCountry'
); );
$subdivisions = $model->subdivisions; $subdivisions = $model->subdivisions;
foreach ($subdivisions as $subdiv) { foreach ($subdivisions as $subdiv) {
$this->assertInstanceOf('GeoIP2\Record\Subdivision', $subdiv); $this->assertInstanceOf('GeoIp2\Record\Subdivision', $subdiv);
} }
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Subdivision', 'GeoIp2\Record\Subdivision',
$model->mostSpecificSubdivision, $model->mostSpecificSubdivision,
'$model->mostSpecificSubdivision' '$model->mostSpecificSubdivision'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Traits', 'GeoIp2\Record\Traits',
$model->traits, $model->traits,
'$model->traits' '$model->traits'
); );
@@ -150,43 +150,43 @@ class OmniTest extends \PHPUnit_Framework_TestCase
$model = new Omni($raw, array('en')); $model = new Omni($raw, array('en'));
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Model\Omni', 'GeoIp2\Model\Omni',
$model, $model,
'GeoIP2\Model\Omni object with no data except traits.ipAddress' 'GeoIp2\Model\Omni object with no data except traits.ipAddress'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\City', 'GeoIp2\Record\City',
$model->city, $model->city,
'$model->city' '$model->city'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Continent', 'GeoIp2\Record\Continent',
$model->continent, $model->continent,
'$model->continent' '$model->continent'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Country', 'GeoIp2\Record\Country',
$model->country, $model->country,
'$model->country' '$model->country'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Location', 'GeoIp2\Record\Location',
$model->location, $model->location,
'$model->location' '$model->location'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Country', 'GeoIp2\Record\Country',
$model->registeredCountry, $model->registeredCountry,
'$model->registeredCountry' '$model->registeredCountry'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\RepresentedCountry', 'GeoIp2\Record\RepresentedCountry',
$model->representedCountry, $model->representedCountry,
'$model->representedCountry' '$model->representedCountry'
); );
@@ -198,13 +198,13 @@ class OmniTest extends \PHPUnit_Framework_TestCase
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Subdivision', 'GeoIp2\Record\Subdivision',
$model->mostSpecificSubdivision, $model->mostSpecificSubdivision,
'$model->mostSpecificSubdivision' '$model->mostSpecificSubdivision'
); );
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Record\Traits', 'GeoIp2\Record\Traits',
$model->traits, $model->traits,
'$model->traits' '$model->traits'
); );
@@ -234,7 +234,7 @@ class OmniTest extends \PHPUnit_Framework_TestCase
$model = new Omni($raw, array('en')); $model = new Omni($raw, array('en'));
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Model\Omni', 'GeoIp2\Model\Omni',
$model, $model,
'no exception when Omni model gets raw data with unknown keys' 'no exception when Omni model gets raw data with unknown keys'
); );

View File

@@ -1,8 +1,8 @@
<?php <?php
namespace GeoIP2\Test\WebService; namespace GeoIp2\Test\WebService;
use GeoIP2\WebService\Client; use GeoIp2\WebService\Client;
use Guzzle\Http\Client as GuzzleClient; use Guzzle\Http\Client as GuzzleClient;
use Guzzle\Http\Message\Response; use Guzzle\Http\Message\Response;
use Guzzle\Plugin\Mock\MockPlugin; use Guzzle\Plugin\Mock\MockPlugin;
@@ -82,6 +82,54 @@ class ClientTest extends \PHPUnit_Framework_TestCase
null, null,
'text/plain' '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]; return $responses[$ip];
} }
@@ -91,7 +139,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$country = $this->client($this->getResponse('1.2.3.4')) $country = $this->client($this->getResponse('1.2.3.4'))
->country('1.2.3.4'); ->country('1.2.3.4');
$this->assertInstanceOf('GeoIP2\Model\Country', $country); $this->assertInstanceOf('GeoIp2\Model\Country', $country);
$this->assertEquals( $this->assertEquals(
42, 42,
@@ -155,7 +203,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$omni = $this->client($this->getResponse('1.2.3.4')) $omni = $this->client($this->getResponse('1.2.3.4'))
->omni('1.2.3.4'); ->omni('1.2.3.4');
$this->assertInstanceOf('GeoIP2\Model\Omni', $omni); $this->assertInstanceOf('GeoIp2\Model\Omni', $omni);
$this->assertEquals( $this->assertEquals(
42, 42,
@@ -169,7 +217,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$city = $this->client($this->getResponse('1.2.3.4')) $city = $this->client($this->getResponse('1.2.3.4'))
->city('1.2.3.4'); ->city('1.2.3.4');
$this->assertInstanceOf('GeoIP2\Model\City', $city); $this->assertInstanceOf('GeoIp2\Model\City', $city);
} }
public function testMe() public function testMe()
@@ -177,14 +225,14 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$client = $this->client($this->getResponse('me')); $client = $this->client($this->getResponse('me'));
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIP2\Model\CityIspOrg', 'GeoIp2\Model\CityIspOrg',
$client->cityIspOrg('me'), $client->cityIspOrg('me'),
'can set ip parameter to me' 'can set ip parameter to me'
); );
} }
/** /**
* @expectedException GeoIP2\Exception\GeoIP2Exception * @expectedException GeoIp2\Exception\GeoIp2Exception
* @expectedExceptionMessage Received a 200 response for https://geoip.maxmind.com/geoip/v2.0/country/1.2.3.5 but did not receive a HTTP body. * @expectedExceptionMessage Received a 200 response for https://geoip.maxmind.com/geoip/v2.0/country/1.2.3.5 but did not receive a HTTP body.
*/ */
public function testNoBodyException() public function testNoBodyException()
@@ -195,7 +243,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* @expectedException GeoIP2\Exception\GeoIP2Exception * @expectedException GeoIp2\Exception\GeoIp2Exception
* @expectedExceptionMessage Received a 200 response for https://geoip.maxmind.com/geoip/v2.0/country/2.2.3.5 but could not decode the response as JSON: * @expectedExceptionMessage Received a 200 response for https://geoip.maxmind.com/geoip/v2.0/country/2.2.3.5 but could not decode the response as JSON:
*/ */
public function testBadBodyException() public function testBadBodyException()
@@ -207,7 +255,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
/** /**
* @expectedException GeoIP2\Exception\WebServiceException * @expectedException GeoIp2\Exception\InvalidRequestException
* @expectedExceptionCode 400 * @expectedExceptionCode 400
* @expectedExceptionMessage The value "1.2.3" is not a valid ip address * @expectedExceptionMessage The value "1.2.3" is not a valid ip address
*/ */
@@ -216,11 +264,10 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$client = $this->client($this->getResponse('1.2.3.6')); $client = $this->client($this->getResponse('1.2.3.6'));
$client->country('1.2.3.6'); $client->country('1.2.3.6');
} }
/** /**
* @expectedException GeoIP2\Exception\HttpException * @expectedException GeoIp2\Exception\HttpException
* @expectedExceptionCode 400 * @expectedExceptionCode 400
* @expectedExceptionMessage with no body * @expectedExceptionMessage with no body
*/ */
@@ -232,7 +279,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* @expectedException GeoIP2\Exception\GeoIP2Exception * @expectedException GeoIp2\Exception\GeoIp2Exception
* @expectedExceptionMessage Response contains JSON but it does not specify code or error keys * @expectedExceptionMessage Response contains JSON but it does not specify code or error keys
*/ */
public function testWeirdErrorBodyIPException() public function testWeirdErrorBodyIPException()
@@ -244,7 +291,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* @expectedException GeoIP2\Exception\HttpException * @expectedException GeoIp2\Exception\HttpException
* @expectedExceptionCode 400 * @expectedExceptionCode 400
* @expectedExceptionMessage did not include the expected JSON body * @expectedExceptionMessage did not include the expected JSON body
*/ */
@@ -257,7 +304,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* @expectedException GeoIP2\Exception\HttpException * @expectedException GeoIp2\Exception\HttpException
* @expectedExceptionCode 500 * @expectedExceptionCode 500
* @expectedExceptionMessage Received a server error (500) * @expectedExceptionMessage Received a server error (500)
*/ */
@@ -270,7 +317,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* @expectedException GeoIP2\Exception\HttpException * @expectedException GeoIp2\Exception\HttpException
* @expectedExceptionCode 300 * @expectedExceptionCode 300
* @expectedExceptionMessage Received a very surprising HTTP status (300) * @expectedExceptionMessage Received a very surprising HTTP status (300)
*/ */
@@ -283,7 +330,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* @expectedException GeoIP2\Exception\HttpException * @expectedException GeoIp2\Exception\HttpException
* @expectedExceptionCode 406 * @expectedExceptionCode 406
* @expectedExceptionMessage Received a 406 error for https://geoip.maxmind.com/geoip/v2.0/country/1.2.3.12 with the following body: Cannot satisfy your Accept-Charset requirements * @expectedExceptionMessage Received a 406 error for https://geoip.maxmind.com/geoip/v2.0/country/1.2.3.12 with the following body: Cannot satisfy your Accept-Charset requirements
*/ */
@@ -293,6 +340,72 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$client->country('1.2.3.12'); $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() public function testParams()
{ {
$plugin = new MockPlugin(); $plugin = new MockPlugin();

View File

@@ -4,4 +4,4 @@ if (!$loader = @include __DIR__.'/../vendor/autoload.php') {
die('Project dependencies missing'); die('Project dependencies missing');
} }
$loader->add('GeoIP2\Test', __DIR__); $loader->add('GeoIp2\Test', __DIR__);