Compare commits

..

No commits in common. "master" and "v0.7.0" have entirely different histories.

20 changed files with 254 additions and 505 deletions

5
.gitignore vendored
View File

@ -1,14 +1,13 @@
_site _site
.gh-pages .gh-pages
.idea .idea
GeoLite2-City.mmdb
apigen.phar
box.phar
build build
composer.lock composer.lock
composer.phar composer.phar
phpunit.xml phpunit.xml
geoip2.phar
geoip2-php.sublime-* geoip2-php.sublime-*
vendor/ vendor/
*.sw? *.sw?
t.php
*.old *.old

View File

@ -1,59 +1,12 @@
CHANGELOG CHANGELOG
========= =========
2.1.1 (2014-12-03)
------------------
* The 2.1.0 Phar builds included a shebang line, causing issues when loading
it as a library. This has been corrected. GitHub #33.
2.1.0 (2014-10-29)
------------------
* Update ApiGen dependency to version that isn't broken on case sensitive
file systems.
* Added support for the GeoIP2 Anonymous IP database. The
`GeoIP2\Database\Reader` class now has an `anonymousIp` method which returns
a `GeoIP2\Model\AnonymousIp` object.
* Boolean attributes like those in the `GeoIP2\Record\Traits` class now return
`false` instead of `null` when they were not true.
2.0.0 (2014-09-22)
------------------
* First production release.
0.9.0 (2014-09-15)
------------------
* IMPORTANT: The deprecated `omni()` and `cityIspOrg()` methods have been
removed from `GeoIp2\WebService\Client`.
0.8.1 (2014-09-12)
------------------
* The check added to the `GeoIP2\Database\Reader` lookup methods in 0.8.0 did
not work with the GeoIP2 City Database Subset by Continent with World
Countries. This has been fixed. Fixes GitHub issue #23.
0.8.0 (2014-09-10)
------------------
* The `GeoIp2\Database\Reader` lookup methods (e.g., `city()`, `isp()`) now
throw a `BadMethodCallException` if they are used with a database that
does not match the method. In particular, doing a `city()` lookup on a
GeoIP2 Country database will result in an exception, and vice versa.
* A `metadata()` method has been added to the `GeoIP2\Database\Reader` class.
This returns a `MaxMind\Db\Reader\Metadata` class with information about the
database.
* The name attribute was missing from the RepresentedCountry class.
0.7.0 (2014-07-22) 0.7.0 (2014-07-22)
------------------ ------------------
* The web service client API has been updated for the v2.1 release of the web * The web service client API has been updated for the v2.1 release of the web
service. In particular, the `cityIspOrg` and `omni` methods on service. In particular, the `cityIspOrg` and `omni` methods on
`GeoIp2\WebService\Client` should be considered deprecated. The `city` `GeoIP2\WebService\Client` should be considered deprecated. The `city`
method now provides all of the data formerly provided by `cityIspOrg`, and method now provides all of the data formerly provided by `cityIspOrg`, and
the `omni` method has been replaced by the `insights` method. the `omni` method has been replaced by the `insights` method.
* Support was added for GeoIP2 Connection Type, Domain and ISP databases. * Support was added for GeoIP2 Connection Type, Domain and ISP databases.

View File

@ -26,7 +26,7 @@ You should now have the file `composer.phar` in your project directory.
Run in your project root: Run in your project root:
``` ```
php composer.phar require geoip2/geoip2:~2.0 php composer.phar require geoip2/geoip2:~0.7.0
``` ```
You should now have the files `composer.json` and `composer.lock` as well as You should now have the files `composer.json` and `composer.lock` as well as
@ -114,24 +114,6 @@ print($record->location->longitude . "\n"); // -93.2323
``` ```
### Anonymous IP 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-Anonymous-IP.mmdb');
$record = $reader->anonymousIp('128.101.101.101');
if ($record->isAnonymous) { print "anon\n"; }
print($record->ipAddress . "\n"); // '128.101.101.101'
```
### Connection-Type Example ### ### Connection-Type Example ###
```php ```php
@ -256,6 +238,9 @@ 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
check to see if the attribute is set.
## Integration with GeoNames ## ## Integration with GeoNames ##
[GeoNames](http://www.geonames.org/) offers web services and downloadable [GeoNames](http://www.geonames.org/) offers web services and downloadable
@ -305,16 +290,13 @@ supported.
This library works and is tested with HHVM. This library works and is tested with HHVM.
This library also relies on the [Guzzle3 HTTP client](https://github.com/guzzle/guzzle3) This library also relies on the [Guzzle HTTP client](http://guzzlephp.org/)
and the [MaxMind DB Reader](https://github.com/maxmind/MaxMind-DB-Reader-php). and the [MaxMind DB Reader](https://github.com/maxmind/MaxMind-DB-Reader-php).
If you are using PHP 5.3 with an autoloader besides Composer, you must load
`JsonSerializable.php` in the `compat` directory.
## Contributing ## ## Contributing ##
Patches and pull requests are encouraged. All code should follow the Patches and pull requests are encouraged. All code should follow the
PSR-2 style guidelines. Please include unit tests whenever possible. You may obtain the test data for the maxmind-db folder by running `git submodule update --init --recursive` or adding `--recursive` to your initial clone, or from https://github.com/maxmind/MaxMind-DB PSR-2 style guidelines. Please include unit tests whenever possible.
## Versioning ## ## Versioning ##

View File

@ -1,26 +0,0 @@
#!/usr/bin/env php
<?php
require_once '../vendor/autoload.php';
use GeoIp2\Database\Reader;
use GeoIp2\Exception\AddressNotFoundException;
$reader = new Reader('GeoLite2-City.mmdb');
$count = 40000;
$startTime = microtime(true);
for ($i = 0; $i < $count; $i++) {
$ip = long2ip(rand(0, pow(2, 32) -1));
try {
$t = $reader->city($ip);
} catch (AddressNotFoundException $e) {
}
if ($i % 1000 == 0) {
print($i . ' ' . $ip . "\n");
}
}
$endTime = microtime(true);
$duration = $endTime - $startTime;
print('Requests per second: ' . $count / $duration . "\n");

63
bin/release.sh Executable file
View File

@ -0,0 +1,63 @@
#!/bin/bash
TAG=$1
if [ -z $TAG ]; then
echo "Please specify a tag"
exit 1
fi
if [ -n "$(git status --porcelain)" ]; then
echo ". is not clean." >&2
exit 1
fi
if [ ! -d .gh-pages ]; then
echo "Checking out gh-pages in .gh-pages"
git clone -b gh-pages git@git.maxmind.com:GeoIP2-php .gh-pages
cd .gh-pages
else
echo "Updating .gh-pages"
cd .gh-pages
git pull
fi
if [ -n "$(git status --porcelain)" ]; then
echo ".gh-pages is not clean" >&2
exit 1
fi
apigen --quiet --download --title "GeoIP2 PHP API $TAG" --source ../src --destination doc/$TAG
PAGE=index.md
cat <<EOF > $PAGE
---
layout: default
title: MaxMind GeoIP2 PHP API
language: php
version: $TAG
---
EOF
cat ../README.md >> $PAGE
git add doc/
git commit -m "Updated for $TAG" -a
read -e -p "Push to origin? " SHOULD_PUSH
if [ "$SHOULD_PUSH" != "y" ]; then
echo "Aborting"
exit 1
fi
# If we don't push directly to github, the page doesn't get built for some
# reason.
git push git@github.com:maxmind/GeoIP2-php.git
git push
cd ..
git tag -a $TAG
git push
git push --tags

View File

@ -13,8 +13,6 @@
"finder": [ "finder": [
{ {
"name": [ "name": [
"LICENSE",
"LICENSE.*",
"*.php", "*.php",
"*.pem", "*.pem",
"*.pem.md5" "*.pem.md5"
@ -29,8 +27,8 @@
"in": "vendor" "in": "vendor"
} }
], ],
"directories": ["compat", "src/"], "directories": ["compat", "src/"],
"git-version": "git-version", "git-version": "git-version",
"shebang": false,
"stub": true "stub": true
} }

View File

@ -14,11 +14,11 @@
], ],
"require": { "require": {
"guzzle/guzzle": "3.*", "guzzle/guzzle": "3.*",
"maxmind-db/reader": "~1.0", "maxmind-db/reader": "~0.3.1",
"php": ">=5.3.1" "php": ">=5.3.1"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "4.2.*", "phpunit/phpunit": "4.1.*",
"satooshi/php-coveralls": "dev-master" "satooshi/php-coveralls": "dev-master"
}, },
"autoload": { "autoload": {

View File

@ -1,15 +0,0 @@
#!/usr/bin/env php
<?php
require_once 'geoip2.phar';
use GeoIp2\Database\Reader;
$reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
$record = $reader->city('81.2.69.160');
if ( $record->country->isoCode === 'GB' ) {
exit(0);
}
print('Problem with Phar!');
exit(1);

View File

@ -1,112 +0,0 @@
#!/bin/bash
set -e
TAG=$1
if [ -z $TAG ]; then
echo "Please specify a tag"
exit 1
fi
if [ -f geoip2.phar ]; then
rm geoip2.phar
fi
if [ -n "$(git status --porcelain)" ]; then
echo ". is not clean." >&2
exit 1
fi
if [ -d vendor ]; then
rm -fr vendor
fi
php composer.phar self-update
php composer.phar update --no-dev
if [ ! -f box.phar ]; then
wget -O box.phar "https://github.com/box-project/box2/releases/download/2.5.0/box-2.5.0.phar"
fi
php box.phar build
PHAR_TEST=$(./dev-bin/phar-test.php)
if [[ -n $PHAR_TEST ]]; then
echo "Phar test outputed non-empty string: $PHAR_TEST"
exit 1
fi
# Download test deps
php composer.phar update
./vendor/bin/phpunit
if [ ! -d .gh-pages ]; then
echo "Checking out gh-pages in .gh-pages"
git clone -b gh-pages git@git.maxmind.com:GeoIP2-php .gh-pages
pushd .gh-pages
else
echo "Updating .gh-pages"
pushd .gh-pages
git pull
fi
if [ -n "$(git status --porcelain)" ]; then
echo ".gh-pages is not clean" >&2
exit 1
fi
# We no longer have apigen as a dependency in Composer as releases are
# sporadically deleted upstream and compatibility is often broken on patch
# releases.
if [ ! -f apigen.phar ]; then
wget -O apigen.phar "https://github.com/apigen/apigen/releases/download/v4.0.0-RC3/apigen-4.0.0-RC3.phar"
fi
cat <<EOF > apigen.neon
destination: doc/$TAG
source:
- ../src
title: "GeoIP2 PHP API $TAG"
EOF
php apigen.phar generate
PAGE=index.md
cat <<EOF > $PAGE
---
layout: default
title: MaxMind GeoIP2 PHP API
language: php
version: $TAG
---
EOF
cat ../README.md >> $PAGE
git add doc/
git commit -m "Updated for $TAG" -a
read -e -p "Push to origin? " SHOULD_PUSH
if [ "$SHOULD_PUSH" != "y" ]; then
echo "Aborting"
exit 1
fi
# If we don't push directly to github, the page doesn't get built for some
# reason.
git push git@github.com:maxmind/GeoIP2-php.git
git push
popd
git tag -a $TAG
git push
git push --tags

@ -1 +1 @@
Subproject commit e53ed8cde6951be3bbd0fdb300d69c898b399a97 Subproject commit c57c2ccf4a0c7b000cd6cd9a4a4463e7b54d7d2c

View File

@ -8,9 +8,13 @@ use MaxMind\Db\Reader as DbReader;
/** /**
* Instances of this class provide a reader for the GeoIP2 database format. * Instances of this class provide a reader for the GeoIP2 database format.
* IP addresses can be looked up using the database specific methods. * 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 ## * **Usage**
* *
* The basic API for this class is the same for every database. First, you * 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 * create a reader object, specifying a file name. You then call the method
@ -21,7 +25,7 @@ use MaxMind\Db\Reader as DbReader;
* the method you called. This model in turn contains multiple record classes, * 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 * each of which represents part of the data returned by the database. If
* the database does not contain the requested information, the attributes * the database does not contain the requested information, the attributes
* on the record class will have a `null` value. * on the record class will have a <code>null</code> value.
* *
* If the address is not in the database, an * If the address is not in the database, an
* {@link \GeoIp2\Exception\AddressNotFoundException} exception will be * {@link \GeoIp2\Exception\AddressNotFoundException} exception will be
@ -67,7 +71,7 @@ class Reader implements ProviderInterface
*/ */
public function city($ipAddress) public function city($ipAddress)
{ {
return $this->modelFor('City', 'City', $ipAddress); return $this->modelFor('City', $ipAddress);
} }
/** /**
@ -84,96 +88,65 @@ class Reader implements ProviderInterface
*/ */
public function country($ipAddress) public function country($ipAddress)
{ {
return $this->modelFor('Country', 'Country', $ipAddress); return $this->modelFor('Country', $ipAddress);
} }
/** /**
* This method returns a GeoIP2 Anonymous IP model. * This method returns a GeoIP2 City model.
* *
* @param string $ipAddress IPv4 or IPv6 address as a string. * @param string $ipAddress IPv4 or IPv6 address as a string.
* *
* @return \GeoIp2\Model\AnonymousIp * @return \GeoIp2\Model\City
* *
* @throws \GeoIp2\Exception\AddressNotFoundException if the address is * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
* not in the database. * not in the database.
* @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
* is corrupt or invalid * is corrupt or invalid
*
* @deprecated deprecated since version 0.7.0
*/ */
public function anonymousIp($ipAddress) public function cityIspOrg($ipAddress)
{ {
return $this->flatModelFor( return $this->modelFor('City', $ipAddress);
'AnonymousIp',
'GeoIP2-Anonymous-IP',
$ipAddress
);
} }
/** /**
* This method returns a GeoIP2 Connection Type model. * This method returns a GeoIP2 Insights model.
* *
* @param string $ipAddress IPv4 or IPv6 address as a string. * @param string $ipAddress IPv4 or IPv6 address as a string.
* *
* @return \GeoIp2\Model\ConnectionType * @return \GeoIp2\Model\Insights
* *
* @throws \GeoIp2\Exception\AddressNotFoundException if the address is * @throws \GeoIp2\Exception\AddressNotFoundException if the address is
* not in the database. * not in the database.
* @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database * @throws \MaxMind\Db\Reader\InvalidDatabaseException if the database
* is corrupt or invalid * is corrupt or invalid
*
* @deprecated deprecated since version 0.7.0
*/ */
public function omni($ipAddress)
{
return $this->modelFor('Insights', $ipAddress);
}
public function connectionType($ipAddress) public function connectionType($ipAddress)
{ {
return $this->flatModelFor( return $this->flatModelFor('ConnectionType', $ipAddress);
'ConnectionType',
'GeoIP2-Connection-Type',
$ipAddress
);
} }
/**
* This method returns a GeoIP2 Domain model.
*
* @param string $ipAddress IPv4 or IPv6 address as a string.
*
* @return \GeoIp2\Model\Domain
*
* @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 domain($ipAddress) public function domain($ipAddress)
{ {
return $this->flatModelFor( return $this->flatModelFor('Domain', $ipAddress);
'Domain',
'GeoIP2-Domain',
$ipAddress
);
} }
/**
* This method returns a GeoIP2 ISP model.
*
* @param string $ipAddress IPv4 or IPv6 address as a string.
*
* @return \GeoIp2\Model\Isp
*
* @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 isp($ipAddress) public function isp($ipAddress)
{ {
return $this->flatModelFor( return $this->flatModelFor('Isp', $ipAddress);
'Isp',
'GeoIP2-ISP',
$ipAddress
);
} }
private function modelFor($class, $type, $ipAddress) private function modelFor($class, $ipAddress)
{ {
$record = $this->getRecord($class, $type, $ipAddress); $record = $this->getRecord($ipAddress);
$record['traits']['ip_address'] = $ipAddress; $record['traits']['ip_address'] = $ipAddress;
$class = "GeoIp2\\Model\\" . $class; $class = "GeoIp2\\Model\\" . $class;
@ -181,9 +154,9 @@ class Reader implements ProviderInterface
return new $class($record, $this->locales); return new $class($record, $this->locales);
} }
private function flatModelFor($class, $type, $ipAddress) private function flatModelFor($class, $ipAddress)
{ {
$record = $this->getRecord($class, $type, $ipAddress); $record = $this->getRecord($ipAddress);
$record['ip_address'] = $ipAddress; $record['ip_address'] = $ipAddress;
$class = "GeoIp2\\Model\\" . $class; $class = "GeoIp2\\Model\\" . $class;
@ -191,15 +164,8 @@ class Reader implements ProviderInterface
return new $class($record); return new $class($record);
} }
private function getRecord($class, $type, $ipAddress) private function getRecord($ipAddress)
{ {
if (strpos($this->metadata()->databaseType, $type) === false) {
$method = lcfirst($class);
throw new \BadMethodCallException(
"The $method method cannot be used to open a "
. $this->metadata()->databaseType . " database"
);
}
$record = $this->dbReader->get($ipAddress); $record = $this->dbReader->get($ipAddress);
if ($record === null) { if ($record === null) {
throw new AddressNotFoundException( throw new AddressNotFoundException(
@ -209,16 +175,6 @@ class Reader implements ProviderInterface
return $record; return $record;
} }
/**
* @throws \InvalidArgumentException if arguments are passed to the method.
* @throws \BadMethodCallException if the database has been closed.
* @return \MaxMind\Db\Reader\Metadata object for the database.
*/
public function metadata()
{
return $this->dbReader->metadata();
}
/** /**
* Closes the GeoIP2 database and returns the resources to the system. * Closes the GeoIP2 database and returns the resources to the system.
*/ */

View File

@ -2,6 +2,7 @@
namespace GeoIp2\Model; namespace GeoIp2\Model;
/** /**
* @ignore * @ignore
*/ */
@ -22,15 +23,7 @@ abstract class AbstractModel implements \JsonSerializable
*/ */
protected function get($field) protected function get($field)
{ {
if (isset($this->raw[$field])) { return isset($this->raw[$field]) ? $this->raw[$field] : null;
return $this->raw[$field];
} else {
if (preg_match('/^is_/', $field)) {
return false;
} else {
return null;
}
}
} }
/** /**

View File

@ -1,50 +0,0 @@
<?php
namespace GeoIp2\Model;
/**
* This class provides the GeoIP2 Anonymous IP model.
*
* @property boolean $isAnonymous This is true if the IP address belongs to
* any sort of anonymous network.
*
* @property boolean $isAnonymousVpn This is true if the IP address belongs to
* an anonymous VPN system.
*
* @property boolean $isHostingProvider This is true if the IP address belongs
* to a hosting provider.
*
* @property boolean $isPublicProxy This is true if the IP address belongs to
* a public proxy.
*
* @property boolean $isTorExitNode This is true if the IP address is a Tor
* exit node.
*
* @property string $ipAddress The IP address that the data in the model is
* for.
*
*/
class AnonymousIp extends AbstractModel
{
protected $isAnonymous;
protected $isAnonymousVpn;
protected $isHostingProvider;
protected $isPublicProxy;
protected $isTorExitNode;
protected $ipAddress;
/**
* @ignore
*/
public function __construct($raw)
{
parent::__construct($raw);
$this->isAnonymous = $this->get('is_anonymous');
$this->isAnonymousVpn = $this->get('is_anonymous_vpn');
$this->isHostingProvider = $this->get('is_hosting_provider');
$this->isPublicProxy = $this->get('is_public_proxy');
$this->isTorExitNode = $this->get('is_tor_exit_node');
$this->ipAddress = $this->get('ip_address');
}
}

View File

@ -17,4 +17,22 @@ interface ProviderInterface
* @return \GeoIp2\Model\City A City model for the requested IP address. * @return \GeoIp2\Model\City A City model for the requested IP address.
*/ */
public function city($ipAddress); public function city($ipAddress);
/**
* @param ipAddress
* IPv4 or IPv6 address to lookup.
* @return \GeoIp2\Model\City A City model for the requested IP address.
*
* @deprecated deprecated since version 0.7.0
*/
public function cityIspOrg($ipAddress);
/**
* @param ipAddress
* IPv4 or IPv6 address to lookup.
* @return \GeoIp2\Model\Insights An Insights model for the requested IP address.
*
* @deprecated deprecated since version 0.7.0
*/
public function omni($ipAddress);
} }

View File

@ -25,11 +25,7 @@ abstract class AbstractRecord implements \JsonSerializable
if ($this->__isset($attr)) { if ($this->__isset($attr)) {
return $this->record[$key]; return $this->record[$key];
} elseif ($this->validAttribute($attr)) { } elseif ($this->validAttribute($attr)) {
if (preg_match('/^is_/', $key)) {
return false;
} else {
return null; return null;
}
} else { } else {
throw new \RuntimeException("Unknown attribute: $attr"); throw new \RuntimeException("Unknown attribute: $attr");
} }

View File

@ -34,7 +34,7 @@ class RepresentedCountry extends Country
'confidence', 'confidence',
'geonameId', 'geonameId',
'isoCode', 'isoCode',
'names', 'namespace',
'type' 'type'
); );
} }

View File

@ -30,12 +30,13 @@ use Guzzle\Http\Exception\ServerErrorResponseException;
* The web service may not return any information for an entire record, in * The web service may not return any information for an entire record, in
* which case all of the attributes for that record class will be empty. * which case all of the attributes for that record class will be empty.
* *
* ## Usage ## * **Usage**
* *
* The basic API for this class is the same for all of the web service end * The basic API for this class is the same for all of the web service end
* points. First you create a web service object with your MaxMind `$userId` * points. First you create a web service object with your MaxMind
* and `$licenseKey`, then you call the method corresponding to a specific end * <code>$userId</code> and <code>$licenseKey</code>, then you call the method
* point, passing it the IP address you want to look up. * corresponding to a specific end point, passing it the IP address you want
* to look up.
* *
* If the request succeeds, the method call will return a model class for * 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 * the end point you called. This model in turn contains multiple record
@ -51,8 +52,6 @@ class Client implements ProviderInterface
private $locales; private $locales;
private $host; private $host;
private $guzzleClient; private $guzzleClient;
private $timeout;
private $connectTimeout;
/** /**
* Constructor. * Constructor.
@ -64,17 +63,13 @@ class Client implements ProviderInterface
* @param string $host Optional host parameter * @param string $host Optional host parameter
* @param object $guzzleClient Optional Guzzle client to use (to facilitate * @param object $guzzleClient Optional Guzzle client to use (to facilitate
* unit testing). * unit testing).
* @param string $timeout Total transaction timeout in seconds
* @param string $connectTimeout Initial connection timeout in seconds
*/ */
public function __construct( public function __construct(
$userId, $userId,
$licenseKey, $licenseKey,
$locales = array('en'), $locales = array('en'),
$host = 'geoip.maxmind.com', $host = 'geoip.maxmind.com',
$guzzleClient = null, $guzzleClient = null
$timeout = null,
$connectTimeout = null
) { ) {
$this->userId = $userId; $this->userId = $userId;
$this->licenseKey = $licenseKey; $this->licenseKey = $licenseKey;
@ -82,8 +77,6 @@ class Client implements ProviderInterface
$this->host = $host; $this->host = $host;
// To enable unit testing // To enable unit testing
$this->guzzleClient = $guzzleClient; $this->guzzleClient = $guzzleClient;
$this->timeout = $timeout;
$this->connectTimeout = $connectTimeout;
} }
/** /**
@ -118,6 +111,40 @@ class Client implements ProviderInterface
return $this->responseFor('city', 'City', $ipAddress); return $this->responseFor('city', 'City', $ipAddress);
} }
/**
* This method calls the GeoIP2 Precision: City endpoint.
*
* @param string $ipAddress IPv4 or IPv6 address as a string. If no
* address is provided, the address that the web service is called
* from will be used.
*
* @return \GeoIp2\Model\City
*
* @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.
*
* @deprecated deprecated since version 0.7.0
*/
public function cityIspOrg($ipAddress = 'me')
{
return $this->city($ipAddress);
}
/** /**
* This method calls the GeoIP2 Precision: Country endpoint. * This method calls the GeoIP2 Precision: Country endpoint.
* *
@ -176,26 +203,55 @@ class Client implements ProviderInterface
* @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
* class to the above exceptions. It will be thrown directly if a 200 * class to the above exceptions. It will be thrown directly if a 200
* status code is returned but the body is invalid. * status code is returned but the body is invalid.
*
* @deprecated deprecated since version 0.7.0
*/ */
public function insights($ipAddress = 'me') public function insights($ipAddress = 'me')
{ {
return $this->responseFor('insights', 'Insights', $ipAddress); return $this->responseFor('insights', 'Insights', $ipAddress);
} }
/**
* This method calls the GeoIP2 Precision: Insights (prev. Omni) endpoint.
*
* @param string $ipAddress IPv4 or IPv6 address as a string. If no
* address is provided, the address that the web service is called
* from will be used.
*
* @return \GeoIp2\Model\Insights
*
* @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.
*
* @deprecated deprecated since version 0.7.0
*/
public function omni($ipAddress = 'me')
{
return $this->insights($ipAddress);
}
private function responseFor($endpoint, $class, $ipAddress) private function responseFor($endpoint, $class, $ipAddress)
{ {
$uri = implode('/', array($this->baseUri(), $endpoint, $ipAddress)); $uri = implode('/', array($this->baseUri(), $endpoint, $ipAddress));
$client = $this->guzzleClient ? $client = $this->guzzleClient ?
$this->guzzleClient : new GuzzleClient(); $this->guzzleClient : new GuzzleClient();
$options = array(); $request = $client->get($uri, array('Accept' => 'application/json'));
if ($this->timeout !== null) {
$options['timeout'] = $this->timeout;
}
if ($this->connectTimeout !== null) {
$options['connect_timeout'] = $this->connectTimeout;
}
$request = $client->get($uri, array('Accept' => 'application/json'), $options);
$request->setAuth($this->userId, $this->licenseKey); $request->setAuth($this->userId, $this->licenseKey);
$this->setUserAgent($request); $this->setUserAgent($request);

View File

@ -8,39 +8,44 @@ class ReaderTest extends \PHPUnit_Framework_TestCase
{ {
public function testDefaultLocale() public function testDefaultLocale()
{ {
foreach (array('City', 'Country') as $type) { $reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
$reader = new Reader("maxmind-db/test-data/GeoIP2-$type-Test.mmdb"); // Needed for PHP 5.3
$method = lcfirst($type); $that = $this;
$this->checkAllMethods(
function ($method) use (&$that, &$reader) {
$record = $reader->$method('81.2.69.160'); $record = $reader->$method('81.2.69.160');
$this->assertEquals('United Kingdom', $record->country->name); $that->assertEquals('United Kingdom', $record->country->name);
} }
);
$reader->close(); $reader->close();
} }
public function testLocaleList() public function testLocaleList()
{ {
foreach (array('City', 'Country') as $type) {
$reader = new Reader( $reader = new Reader(
"maxmind-db/test-data/GeoIP2-$type-Test.mmdb", 'maxmind-db/test-data/GeoIP2-City-Test.mmdb',
array('xx', 'ru', 'pt-BR', 'es', 'en') array('xx', 'ru', 'pt-BR', 'es', 'en')
); );
$method = lcfirst($type); $that = $this;
$this->checkAllMethods(
function ($method) use (&$that, &$reader) {
$record = $reader->$method('81.2.69.160'); $record = $reader->$method('81.2.69.160');
$this->assertEquals('Великобритания', $record->country->name); $that->assertEquals('Великобритания', $record->country->name);
} }
);
$reader->close(); $reader->close();
} }
public function testHasIpAddress() public function testHasIpAddress()
{ {
foreach (array('City', 'Country') as $type) { $reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
$reader = new Reader("maxmind-db/test-data/GeoIP2-$type-Test.mmdb"); $that = $this;
$method = lcfirst($type); $this->checkAllMethods(
function ($method) use (&$that, &$reader) {
$record = $reader->$method('81.2.69.160'); $record = $reader->$method('81.2.69.160');
$this->assertEquals('81.2.69.160', $record->traits->ipAddress); $that->assertEquals('81.2.69.160', $record->traits->ipAddress);
} }
);
$reader->close(); $reader->close();
} }
@ -55,28 +60,6 @@ class ReaderTest extends \PHPUnit_Framework_TestCase
$reader->close(); $reader->close();
} }
/**
* @expectedException BadMethodCallException
* @expectedExceptionMessage The country method cannot be used to open a GeoIP2-City database
*/
public function testIncorrectDatabase()
{
$reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
$reader->country('10.10.10.10');
$reader->close();
}
/**
* @expectedException BadMethodCallException
* @expectedExceptionMessage The domain method cannot be used to open a GeoIP2-City database
*/
public function testIncorrectDatabaseFlat()
{
$reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb');
$reader->domain('10.10.10.10');
$reader->close();
}
/** /**
* @expectedException InvalidArgumentException * @expectedException InvalidArgumentException
* @expectedExceptionMessage is not a valid IP address * @expectedExceptionMessage is not a valid IP address
@ -88,21 +71,6 @@ class ReaderTest extends \PHPUnit_Framework_TestCase
$reader->close(); $reader->close();
} }
public function testAnonymousIp()
{
$reader = new Reader('maxmind-db/test-data/GeoIP2-Anonymous-IP-Test.mmdb');
$ipAddress = '1.2.0.1';
$record = $reader->anonymousIp($ipAddress);
$this->assertSame(true, $record->isAnonymous);
$this->assertSame(true, $record->isAnonymousVpn);
$this->assertSame(false, $record->isHostingProvider);
$this->assertSame(false, $record->isPublicProxy);
$this->assertSame(false, $record->isTorExitNode);
$this->assertEquals($ipAddress, $record->ipAddress);
$reader->close();
}
public function testConnectionType() public function testConnectionType()
{ {
$reader = new Reader('maxmind-db/test-data/GeoIP2-Connection-Type-Test.mmdb'); $reader = new Reader('maxmind-db/test-data/GeoIP2-Connection-Type-Test.mmdb');
@ -144,11 +112,10 @@ class ReaderTest extends \PHPUnit_Framework_TestCase
$reader->close(); $reader->close();
} }
public function testMetadata() public function checkAllMethods($testCb)
{ {
$reader = new Reader('maxmind-db/test-data/GeoIP2-City-Test.mmdb'); foreach (array('city', 'cityIspOrg', 'country', 'omni') as $method) {
$this->assertEquals('GeoIP2-City', $reader->metadata()->databaseType); $testCb($method);
}
$reader->close();
} }
} }

View File

@ -62,7 +62,7 @@ class InsightsTest extends \PHPUnit_Framework_TestCase
'autonomous_system_organization' => 'AS Organization', 'autonomous_system_organization' => 'AS Organization',
'domain' => 'example.com', 'domain' => 'example.com',
'ip_address' => '1.2.3.4', 'ip_address' => '1.2.3.4',
'is_satellite_provider' => true, 'is_satellite_provider' => 1,
'isp' => 'Comcast', 'isp' => 'Comcast',
'organization' => 'Blorg', 'organization' => 'Blorg',
'user_type' => 'college', 'user_type' => 'college',
@ -130,18 +130,6 @@ class InsightsTest extends \PHPUnit_Framework_TestCase
'$model->traits' '$model->traits'
); );
$this->assertSame(
true,
$model->traits->isSatelliteProvider,
'$model->traits->isSatelliteProvider is true'
);
$this->assertSame(
false,
$model->traits->isAnonymousProxy,
'$model->traits->isAnonymousProxy is false'
);
$this->assertEquals( $this->assertEquals(
22, 22,
$model->maxmind->queriesRemaining, $model->maxmind->queriesRemaining,

View File

@ -201,8 +201,10 @@ class ClientTest extends \PHPUnit_Framework_TestCase
public function testInsights() public function testInsights()
{ {
$methods = array('omni', 'insights');
foreach ($methods as $method) {
$record = $this->client($this->getResponse('1.2.3.4')) $record = $this->client($this->getResponse('1.2.3.4'))
->insights('1.2.3.4'); ->$method('1.2.3.4');
$this->assertInstanceOf('GeoIp2\Model\Insights', $record); $this->assertInstanceOf('GeoIp2\Model\Insights', $record);
@ -212,6 +214,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
'continent geoname_id is 42' 'continent geoname_id is 42'
); );
} }
}
public function testCity() public function testCity()
{ {
@ -227,7 +230,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$this->assertInstanceOf( $this->assertInstanceOf(
'GeoIp2\Model\City', 'GeoIp2\Model\City',
$client->city('me'), $client->cityIspOrg('me'),
'can set ip parameter to me' 'can set ip parameter to me'
); );
} }
@ -419,9 +422,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
'abcdef123456', 'abcdef123456',
array('en'), array('en'),
'geoip.maxmind.com', 'geoip.maxmind.com',
$guzzleClient, $guzzleClient
27,
72
); );
$client->country('1.2.3.4'); $client->country('1.2.3.4');
@ -448,21 +449,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$this->assertStringMatchesFormat( $this->assertStringMatchesFormat(
'GeoIP2 PHP API (Guzzle%s)', 'GeoIP2 PHP API (Guzzle%s)',
$request->getHeader('User-Agent') . '', $request->getHeader('User-Agent') . '',
'request sets Accept header to GeoIP2 PHP API (Guzzle%s)' 'request sets Accept header to application/json'
);
$curlOptions = $request->getCurlOptions();
$this->assertEquals(
'27000',
$curlOptions[CURLOPT_TIMEOUT_MS],
'request sets Curl Option Timeout to 27 seconds'
);
$this->assertEquals(
'72000',
$curlOptions[CURLOPT_CONNECTTIMEOUT_MS],
'request sets Curl Option Connect Timeout to 72 seconds'
); );
} }
@ -480,10 +467,6 @@ class ClientTest extends \PHPUnit_Framework_TestCase
$locales, $locales,
'geoip.maxmind.com', 'geoip.maxmind.com',
$guzzleClient $guzzleClient
// intentionally not specifying the below, to ensure backwards compatibility
//,
// 1, // optional timeout
// 1 // optional connect timeout
); );
return $client; return $client;