will/GeoIP2-php
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated code to follow the PSR-2 style guidelines.

Browse Source
This commit is contained in:
Gregory Oschwald 2013-05-09 07:29:29 -07:00
parent 95813b00a9
commit ed6166f934
22 changed files with 807 additions and 636 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.travis.yml
View File

@ -6,7 +6,12 @@ php:
- 5.4 - 5.4
- 5.5 - 5.5
script: phpunit before_install:
- pear install pear/PHP_CodeSniffer
script:
- phpcs --standard=PSR2 src/
- phpunit
notifications: notifications:
email: email:

4
README
View File

@ -58,6 +58,10 @@ SUPPORT
to the client API please see http://www.maxmind.com/en/support for to the client API please see http://www.maxmind.com/en/support for
details. details.
CONTRIBUTING
Patches and pull requests are encouraged. All code should follow the
PSR-2 style guidelines. Please include unit tests whenever possible.
AUTHOR AUTHOR
Gregory Oschwald <goschwald@maxmind.com> Gregory Oschwald <goschwald@maxmind.com>

20
src/GeoIP2/Exception/HttpException.php
View File

@ -4,13 +4,15 @@ namespace GeoIP2\Exception;
class HttpException extends \Exception class HttpException extends \Exception
{ {
public $code; public $code;
public function __construct($message, $code, $uri, public function __construct(
Exception $previous = null) $message,
{ $code,
$this->code = $code; $uri,
parent::__construct($message, null, $previous); Exception $previous = null
} ) {
$this->code = $code;
} parent::__construct($message, null, $previous);
}
}

21
src/GeoIP2/Exception/WebserviceException.php
View File

@ -4,13 +4,16 @@ namespace GeoIP2\Exception;
class WebserviceException extends HttpException class WebserviceException extends HttpException
{ {
public $httpStatus; public $httpStatus;
public function __construct($message, $code, $httpStatus, $uri, public function __construct(
Exception $previous = null) $message,
{ $code,
$this->httpStatus = $httpStatus; $httpStatus,
parent::__construct($message, $code, $uri, $previous); $uri,
} Exception $previous = null
) {
} $this->httpStatus = $httpStatus;
parent::__construct($message, $code, $uri, $previous);
}
}

63
src/GeoIP2/Model/City.php
View File

@ -4,28 +4,49 @@ namespace GeoIP2\Model;
class City extends Country class City extends Country
{ {
protected $city; protected $city;
protected $location; protected $location;
protected $postal; protected $postal;
protected $subdivisions = Array(); protected $subdivisions = array();
public function __construct($raw, $languages) public function __construct($raw, $languages)
{ {
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);
}
private function createSubdivisions($raw, $languages) {
if(!isset($raw['subdivisions'])) return;
foreach ($raw['subdivisions'] as $sub) {
array_push($this->subdivisions,
new \GeoIP2\Record\Subdivision($sub, $languages));
} }
}
} private function createSubdivisions($raw, $languages)
{
if (!isset($raw['subdivisions'])) {
return;
}
foreach ($raw['subdivisions'] as $sub) {
array_push(
$this->subdivisions,
new \GeoIP2\Record\Subdivision($sub, $languages)
);
}
}
public function __get($attr)
{
if ($attr == 'mostSpecificSubdivision') {
return $this->$attr();
} else {
return parent::__get($attr);
}
}
private function mostSpecificSubdivision()
{
return empty($this->subdivisions)?
new \GeoIP2\Record\Subdivision(array(), $this->languages):
end($this->subdivisions);
}
}

3
src/GeoIP2/Model/CityIspOrg.php
View File

@ -4,5 +4,4 @@ namespace GeoIP2\Model;
class CityIspOrg extends City class CityIspOrg extends City
{ {
}
}

68
src/GeoIP2/Model/Country.php
View File

@ -4,36 +4,50 @@ namespace GeoIP2\Model;
class Country class Country
{ {
private $continent; private $continent;
private $country; private $country;
private $registeredCountry; private $languages;
private $representedCountry; private $registeredCountry;
private $traits; private $representedCountry;
private $raw; private $traits;
private $raw;
public function __construct($raw, $languages) { public function __construct($raw, $languages)
$this->raw = $raw; {
$this->raw = $raw;
$this->continent = new \GeoIP2\Record\Continent($this->get('continent'), $this->continent = new \GeoIP2\Record\Continent(
$languages); $this->get('continent'),
$this->country = new \GeoIP2\Record\Country($this->get('country'), $languages
$languages); );
$this->registeredCountry = $this->country = new \GeoIP2\Record\Country(
new \GeoIP2\Record\Country($this->get('registered_country'), $languages); $this->get('country'),
$this->representedCountry = $languages
new \GeoIP2\Record\RepresentedCountry($this->get('represented_country'), );
$languages); $this->registeredCountry = new \GeoIP2\Record\Country(
$this->traits = new \GeoIP2\Record\Traits($this->get('traits')); $this->get('registered_country'),
} $languages
);
$this->representedCountry = new \GeoIP2\Record\RepresentedCountry(
$this->get('represented_country'),
$languages
);
$this->traits = new \GeoIP2\Record\Traits($this->get('traits'));
protected function get($field) { $this->languages = $languages;
return isset($this->raw[$field]) ? $this->raw[$field] : Array(); }
}
public function __get ($attr) protected function get($field)
{ {
if ($attr != "instance" && isset($this->$attr)) return $this->$attr; return isset($this->raw[$field]) ? $this->raw[$field] : array();
}
throw new \RuntimeException("Unknown attribute: $attr"); public function __get ($attr)
} {
if ($attr != "instance" && isset($this->$attr)) {
return $this->$attr;
}
throw new \RuntimeException("Unknown attribute: $attr");
}
} }

1
src/GeoIP2/Model/Omni.php
View File

@ -4,5 +4,4 @@ namespace GeoIP2\Model;
class Omni extends CityIspOrg class Omni extends CityIspOrg
{ {
} }

40
src/GeoIP2/Record/AbstractPlaceRecord.php
View File

@ -4,25 +4,29 @@ namespace GeoIP2\Record;
abstract class AbstractPlaceRecord extends AbstractRecord abstract class AbstractPlaceRecord extends AbstractRecord
{ {
private $languages; private $languages;
public function __construct($record, $languages){ public function __construct($record, $languages)
$this->languages = $languages; {
parent::__construct($record); $this->languages = $languages;
} parent::__construct($record);
public function __get($attr) {
if ($attr == 'name') {
return $this->name();
} else {
return parent::__get($attr);
} }
}
public function __get($attr)
private function name() { {
foreach($this->languages as $language) { if ($attr == 'name') {
if (isset($this->names[$language])) return $this->names[$language]; return $this->name();
} else {
return parent::__get($attr);
}
} }
}
} private function name()
{
foreach ($this->languages as $language) {
if (isset($this->names[$language])) {
return $this->names[$language];
}
}
}
}

38
src/GeoIP2/Record/AbstractRecord.php
View File

@ -4,23 +4,25 @@ namespace GeoIP2\Record;
abstract class AbstractRecord abstract class AbstractRecord
{ {
private $record; private $record;
public function __construct($record) { public function __construct($record)
$this->record = $record; {
} $this->record = $record;
public function __get($attr) {
$valid = in_array($attr, $this->validAttributes);
// XXX - kind of ugly but greatly reduces boilerplate code
$key = strtolower(preg_replace('/([A-Z])/', '_\1', $attr));
if ($valid && isset($this->record[$key])){
return $this->record[$key];
} elseif ($valid) {
return null;
} else {
throw new \RuntimeException("Unknown attribute: $attr");
} }
}
} public function __get($attr)
{
$valid = in_array($attr, $this->validAttributes);
// XXX - kind of ugly but greatly reduces boilerplate code
$key = strtolower(preg_replace('/([A-Z])/', '_\1', $attr));
if ($valid && isset($this->record[$key])) {
return $this->record[$key];
} elseif ($valid) {
return null;
} else {
throw new \RuntimeException("Unknown attribute: $attr");
}
}
}

4
src/GeoIP2/Record/City.php
View File

@ -4,5 +4,5 @@ namespace GeoIP2\Record;
class City extends AbstractPlaceRecord class City extends AbstractPlaceRecord
{ {
protected $validAttributes = Array('confidence', 'geonameId', 'names'); protected $validAttributes = array('confidence', 'geonameId', 'names');
} }

10
src/GeoIP2/Record/Continent.php
View File

@ -4,7 +4,9 @@ namespace GeoIP2\Record;
class Continent extends AbstractPlaceRecord class Continent extends AbstractPlaceRecord
{ {
protected $validAttributes = Array('continentCode', protected $validAttributes = array(
'geonameId', 'continentCode',
'names'); 'geonameId',
} 'names'
);
}

13
src/GeoIP2/Record/Country.php
View File

@ -4,9 +4,10 @@ namespace GeoIP2\Record;
class Country extends AbstractPlaceRecord class Country extends AbstractPlaceRecord
{ {
protected $validAttributes = array(
protected $validAttributes = Array('confidence', 'confidence',
'geonameId', 'geonameId',
'isoCode', 'isoCode',
'names'); 'names'
} );
}

18
src/GeoIP2/Record/Location.php
View File

@ -4,11 +4,13 @@ namespace GeoIP2\Record;
class Location extends AbstractRecord class Location extends AbstractRecord
{ {
protected $validAttributes = Array('accuracyRadius', protected $validAttributes = array(
'latitude', 'accuracyRadius',
'longitude', 'latitude',
'metroCode', 'longitude',
'postalCode', 'metroCode',
'postalConfidence', 'postalCode',
'timeZone'); 'postalConfidence',
} 'timeZone'
);
}

2
src/GeoIP2/Record/Postal.php
View File

@ -4,5 +4,5 @@ namespace GeoIP2\Record;
class Postal extends AbstractRecord class Postal extends AbstractRecord
{ {
protected $validAttributes = Array('code', 'confidence'); protected $validAttributes = array('code', 'confidence');
} }

14
src/GeoIP2/Record/RepresentedCountry.php
View File

@ -4,9 +4,11 @@ namespace GeoIP2\Record;
class RepresentedCountry extends Country class RepresentedCountry extends Country
{ {
protected $validAttributes = Array('confidence', protected $validAttributes = array(
'geonameId', 'confidence',
'isoCode', 'geonameId',
'names', 'isoCode',
'type'); 'namespace',
} 'type'
);
}

12
src/GeoIP2/Record/Subdivision.php
View File

@ -4,8 +4,10 @@ namespace GeoIP2\Record;
class Subdivision extends AbstractPlaceRecord class Subdivision extends AbstractPlaceRecord
{ {
protected $validAttributes = Array('confidence', protected $validAttributes = array(
'geonameId', 'confidence',
'isoCode', 'geonameId',
'names'); 'isoCode',
} 'names'
);
}

23
src/GeoIP2/Record/Traits.php
View File

@ -4,14 +4,15 @@ namespace GeoIP2\Record;
class Traits extends AbstractRecord class Traits extends AbstractRecord
{ {
protected $validAttributes = Array('autonomousSystemNumber', protected $validAttributes = array(
'autonomousSystemOrganization', 'autonomousSystemNumber',
'domain', 'autonomousSystemOrganization',
'isAnonymousProxy', 'domain',
'isSatelliteProvider', 'isAnonymousProxy',
'isp', 'isSatelliteProvider',
'ipAddress', 'isp',
'organization', 'ipAddress',
'userType'); 'organization',
'userType'
} );
}

250
src/GeoIP2/Webservice/Client.php
View File

@ -17,134 +17,164 @@ use Guzzle\Http\Exception\ServerErrorResponseException;
class Client class Client
{ {
private $userId; private $userId;
private $licenseKey; private $licenseKey;
private $languages; private $languages;
private $baseUri = 'https://geoip.maxmind.com/geoip/v2.0'; private $baseUri = 'https://geoip.maxmind.com/geoip/v2.0';
private $guzzleClient; private $guzzleClient;
public function __construct($userId, $licenseKey, $languages=array('en'), public function __construct(
$guzzleClient = null) $userId,
{ $licenseKey,
$this->userId = $userId; $languages = array('en'),
$this->licenseKey = $licenseKey; $guzzleClient = null
$this->languages = $languages; ) {
// To enable unit testing $this->userId = $userId;
$this->guzzleClient = $guzzleClient; $this->licenseKey = $licenseKey;
} $this->languages = $languages;
// To enable unit testing
public function city($ipAddress = 'me') $this->guzzleClient = $guzzleClient;
{
return $this->responseFor('city', 'City', $ipAddress);
}
public function country($ipAddress = 'me')
{
return $this->responseFor('country', 'Country', $ipAddress);
}
public function cityIspOrg($ipAddress = 'me')
{
return $this->responseFor('city_isp_org', 'CityIspOrg', $ipAddress);
}
public function omni($ipAddress = 'me')
{
return $this->responseFor('omni', 'Omni', $ipAddress);
}
private function responseFor($path, $class, $ipAddress)
{
$uri = implode('/', array($this->baseUri, $path, $ipAddress));
$client = $this->guzzleClient ? $this->guzzleClient : new GuzzleClient();
$request = $client->get($uri, array('Accept' => 'application/json'));
$request->setAuth($this->userId, $this->licenseKey);
$ua = $request->getHeader('User-Agent');
$ua = "GeoIP2 PHP API ($ua)";
$request->setHeader('User-Agent', $ua);
$response = null;
try{
$response = $request->send();
}
catch (ClientErrorResponseException $e) {
$this->handle4xx($e->getResponse(), $uri);
}
catch (ServerErrorResponseException $e) {
$this->handle5xx($e->getResponse(), $uri);
} }
if ($response && $response->isSuccessful()) { public function city($ipAddress = 'me')
$body = $this->handleSuccess($response, $uri); {
$class = "GeoIP2\\Model\\" . $class; return $this->responseFor('city', 'City', $ipAddress);
return new $class($body, $this->languages);
}
else {
$this->handleNon200($response, $uri);
}
}
private function handleSuccess($response, $uri)
{
if ($response->getContentLength() == 0) {
throw new GenericException("Received a 200 response for $uri but did not receive a HTTP body.");
} }
try { public function country($ipAddress = 'me')
return $response->json(); {
return $this->responseFor('country', 'Country', $ipAddress);
} }
catch (RuntimeException $e) {
throw new GenericException("Received a 200 response for $uri but could not decode the response as JSON: " . $e->getMessage());
public function cityIspOrg($ipAddress = 'me')
{
return $this->responseFor('city_isp_org', 'CityIspOrg', $ipAddress);
} }
}
private function handle4xx($response, $uri) public function omni($ipAddress = 'me')
{ {
$status = $response->getStatusCode(); return $this->responseFor('omni', 'Omni', $ipAddress);
}
$body = array(); private function responseFor($path, $class, $ipAddress)
{
$uri = implode('/', array($this->baseUri, $path, $ipAddress));
if ( $response->getContentLength() > 0 ) { $client = $this->guzzleClient ?
if( strstr($response->getContentType(), 'json')) { $this->guzzleClient : new GuzzleClient();
$request = $client->get($uri, array('Accept' => 'application/json'));
$request->setAuth($this->userId, $this->licenseKey);
$ua = $request->getHeader('User-Agent');
$ua = "GeoIP2 PHP API ($ua)";
$request->setHeader('User-Agent', $ua);
$response = null;
try { try {
$body = $response->json(); $response = $request->send();
if (!isset($body['code']) || !isset($body['error']) ){ } catch (ClientErrorResponseException $e) {
throw new GenericException('Response contains JSON but it does not specify code or error keys: ' . $response->getBody()); $this->handle4xx($e->getResponse(), $uri);
} } catch (ServerErrorResponseException $e) {
$this->handle5xx($e->getResponse(), $uri);
} }
catch (RuntimeException $e){
throw new HttpException("Received a $status error for $uri but it did not include the expected JSON body: " . $e->getMessage(), $status, $uri); if ($response && $response->isSuccessful()) {
$body = $this->handleSuccess($response, $uri);
$class = "GeoIP2\\Model\\" . $class;
return new $class($body, $this->languages);
} else {
$this->handleNon200($response, $uri);
} }
}
else {
throw new HttpException("Received a $status error for $uri with the following body: " . $response->getBody(),
$status, $uri);
}
}
else {
throw new HttpException("Received a $status error for $uri with no body",
$status, $uri);
} }
throw new WebserviceException($body['error'], $body['code'], $status, $uri); private function handleSuccess($response, $uri)
} {
if ($response->getContentLength() == 0) {
throw new GenericException(
"Received a 200 response for $uri but did not " .
"receive a HTTP body."
);
}
private function handle5xx($response, $uri) try {
{ return $response->json();
$status = $response->getStatusCode(); } catch (RuntimeException $e) {
throw new GenericException(
"Received a 200 response for $uri but could not decode " .
"the response as JSON: " . $e->getMessage()
);
throw new HttpException("Received a server error ($status) for $uri", }
$status,$uri); }
}
private function handleNon200($response, $uri) private function handle4xx($response, $uri)
{ {
$status = $response->getStatusCode(); $status = $response->getStatusCode();
throw new HttpException("Received a very surprising HTTP status " . $body = array();
"($status) for $uri",
$status, $uri); if ($response->getContentLength() > 0) {
} if (strstr($response->getContentType(), 'json')) {
try {
$body = $response->json();
if (!isset($body['code']) || !isset($body['error'])) {
throw new GenericException(
'Response contains JSON but it does not specify ' .
'code or error keys: ' . $response->getBody()
);
}
} catch (RuntimeException $e) {
throw new HttpException(
"Received a $status error for $uri but it did not " .
"include the expected JSON body: " .
$e->getMessage(),
$status,
$uri
);
}
} else {
throw new HttpException(
"Received a $status error for $uri with the " .
"following body: " . $response->getBody(),
$status,
$uri
);
}
} else {
throw new HttpException(
"Received a $status error for $uri with no body",
$status,
$uri
);
}
throw new WebserviceException(
$body['error'],
$body['code'],
$status,
$uri
);
}
private function handle5xx($response, $uri)
{
$status = $response->getStatusCode();
throw new HttpException(
"Received a server error ($status) for $uri",
$status,
$uri
);
}
private function handleNon200($response, $uri)
{
$status = $response->getStatusCode();
throw new HttpException(
"Received a very surprising HTTP status " .
"($status) for $uri",
$status,
$uri
);
}
} }

216
tests/GeoIP2/Test/Model/CountryTest.php
View File

@ -8,7 +8,7 @@ class CountryTest extends \PHPUnit_Framework_TestCase
{ {
private $raw = array( private $raw = array(
'continent' => array( 'continent' => array(
'continent_code' => 'NA', 'continent_code' => 'NA',
'geoname_id' => 42, 'geoname_id' => 42,
'names' => array( 'en' => 'North America' ), 'names' => array( 'en' => 'North America' ),
@ -30,101 +30,133 @@ class CountryTest extends \PHPUnit_Framework_TestCase
private $model; private $model;
public function setUp () { public function setUp ()
$this->model = new Country($this->raw, ['en']); {
$this->model = new Country($this->raw, ['en']);
} }
public function testObjects () { public function testObjects ()
$this->assertInstanceOf('GeoIP2\Model\Country', $this->model, {
'minimal GeoIP2::Model::Country object'); $this->assertInstanceOf(
$this->assertInstanceOf('GeoIP2\Record\Continent', $this->model->continent); 'GeoIP2\Model\Country',
$this->assertInstanceOf('GeoIP2\Record\Country', $this->model->country); $this->model,
$this->assertInstanceOf('GeoIP2\Record\Country', $this->model->registeredCountry); 'minimal GeoIP2::Model::Country object'
$this->assertInstanceOf('GeoIP2\Record\RepresentedCountry', );
$this->model->representedCountry); $this->assertInstanceOf(
$this->assertInstanceOf('GeoIP2\Record\Traits', $this->model->traits); 'GeoIP2\Record\Continent',
} $this->model->continent
);
public function testValues() { $this->assertInstanceOf(
'GeoIP2\Record\Country',
$this->assertEquals(42, $this->model->continent->geonameId, $this->model->country
'continent geoname_id is 42'); );
$this->assertInstanceOf(
$this->assertEquals('NA', $this->model->continent->continentCode, 'GeoIP2\Record\Country',
'continent continent_code is NA'); $this->model->registeredCountry
);
$this->assertEquals(array( 'en' => 'North America' ), $this->assertInstanceOf(
$this->model->continent->names, 'GeoIP2\Record\RepresentedCountry',
'continent names'); $this->model->representedCountry
);
$this->assertEquals( $this->assertInstanceOf(
'North America', 'GeoIP2\Record\Traits',
$this->model->continent->name, $this->model->traits
'continent name is North America');
$this->assertEquals(
1,
$this->model->country->geonameId,
'country geoname_id is 1'
);
$this->assertEquals(
'US',
$this->model->country->isoCode,
'country iso_code is US'
);
$this->assertEquals(
array( 'en' => 'United States of America' ),
$this->model->country->names,
'country names'
);
$this->assertEquals(
$this->model->country->name,
'United States of America',
'country name is United States of America'
);
$this->assertEquals(
null,
$this->model->country->confidence,
'country confidence is undef'
);
$this->assertEquals(2, $this->model->registeredCountry->geonameId,
'registered_country geoname_id is 2'
);
$this->assertEquals('CA',
$this->model->registeredCountry->isoCode,
'registered_country iso_code is CA'
);
$this->assertEquals(
array( 'en' => 'Canada' ),
$this->model->registeredCountry->names,
'registered_country names'
);
$this->assertEquals(
'Canada',
$this->model->registeredCountry->name,
'registered_country name is Canada'
);
foreach (array( 'isAnonymousProxy', 'isSatelliteProvider' ) as $meth) {
$this->assertEquals(0, $this->model->traits->$meth,
"traits $meth returns 0 by default"
); );
} }
$this->assertEquals( public function testValues()
$this->raw, {
$this->model->raw,
'raw method returns raw input' $this->assertEquals(
); 42,
$this->model->continent->geonameId,
'continent geoname_id is 42'
);
$this->assertEquals(
'NA',
$this->model->continent->continentCode,
'continent continent_code is NA'
);
$this->assertEquals(
array( 'en' => 'North America' ),
$this->model->continent->names,
'continent names'
);
$this->assertEquals(
'North America',
$this->model->continent->name,
'continent name is North America'
);
$this->assertEquals(
1,
$this->model->country->geonameId,
'country geoname_id is 1'
);
$this->assertEquals(
'US',
$this->model->country->isoCode,
'country iso_code is US'
);
$this->assertEquals(
array( 'en' => 'United States of America' ),
$this->model->country->names,
'country name'
);
$this->assertEquals(
$this->model->country->name,
'United States of America',
'country name is United States of America'
);
$this->assertEquals(
null,
$this->model->country->confidence,
'country confidence is undef'
);
$this->assertEquals(
2,
$this->model->registeredCountry->geonameId,
'registered_country geoname_id is 2'
);
$this->assertEquals(
'CA',
$this->model->registeredCountry->isoCode,
'registered_country iso_code is CA'
);
$this->assertEquals(
array( 'en' => 'Canada' ),
$this->model->registeredCountry->names,
'registered_country names'
);
$this->assertEquals(
'Canada',
$this->model->registeredCountry->name,
'registered_country name is Canada'
);
foreach (array( 'isAnonymousProxy', 'isSatelliteProvider' ) as $meth) {
$this->assertEquals(
0,
$this->model->traits->$meth,
"traits $meth returns 0 by default"
);
}
$this->assertEquals(
$this->raw,
$this->model->raw,
'raw method returns raw input'
);
} }
} }

615
tests/GeoIP2/Test/Webservice/ClientTest.php
View File

@ -10,298 +10,345 @@ use Guzzle\Plugin\Mock\MockPlugin;
class ClientTest extends \PHPUnit_Framework_TestCase class ClientTest extends \PHPUnit_Framework_TestCase
{ {
private $country private $country
= array( = array(
'continent' => array( 'continent' => array(
'continent_code' => 'NA', 'continent_code' => 'NA',
'geoname_id' => 42, 'geoname_id' => 42,
'names' => array( 'en' => 'North America' ), 'names' => array( 'en' => 'North America' ),
), ),
'country' => array( 'country' => array(
'geoname_id' => 1, 'geoname_id' => 1,
'iso_code' => 'US', 'iso_code' => 'US',
'names' => array( 'en' => 'United States of America' ), 'names' => array( 'en' => 'United States of America' ),
), ),
'traits' => array( 'traits' => array(
'ip_address' => '1.2.3.4', 'ip_address' => '1.2.3.4',
), ),
); );
private function getResponse($ip) { private function getResponse($ip)
$responses = array( {
'1.2.3.4' => $this->response( $responses = array(
'country', '1.2.3.4' => $this->response(
200, 'country',
$this->country 200,
), $this->country
'me' => $this->response( ),
'country', 'me' => $this->response(
200, 'country',
$this->country 200,
), $this->country
'1.2.3.5' => $this->response('country', 200), ),
'2.2.3.5' => $this->response('country', 200, 'bad body'), '1.2.3.5' => $this->response('country', 200),
'1.2.3.6'=> $this->response( '2.2.3.5' => $this->response('country', 200, 'bad body'),
'error', 400, '1.2.3.6'=> $this->response(
array( 'error',
'code' => 'IP_ADDRESS_INVALID', 400,
'error' => 'The value "1.2.3" is not a valid ip address' array(
) 'code' => 'IP_ADDRESS_INVALID',
), 'error' => 'The value "1.2.3" is not a valid ip address'
'1.2.3.7' => $this->response( )
'error', ),
400 '1.2.3.7' => $this->response(
), 'error',
'1.2.3.8' => $this->response( 400
'error', ),
400, '1.2.3.8' => $this->response(
array( 'weird' => 42 ) 'error',
), 400,
'1.2.3.9' => $this->response( array( 'weird' => 42 )
'error', ),
400, '1.2.3.9' => $this->response(
null, 'error',
'bad body' 400,
), null,
'1.2.3.10' => $this->response( 'bad body'
null, ),
500 '1.2.3.10' => $this->response(
), null,
'1.2.3.11' => $this->response( 500
null, ),
300 '1.2.3.11' => $this->response(
), null,
'1.2.3.12' => $this->response( 300
'error', ),
406, '1.2.3.12' => $this->response(
'Cannot satisfy your Accept-Charset requirements', 'error',
null, 406,
'text/plain' 'Cannot satisfy your Accept-Charset requirements',
), null,
); 'text/plain'
return $responses[$ip]; ),
} );
return $responses[$ip];
public function testCountry() {
$country = $this->client($this->getResponse('1.2.3.4'))->country('1.2.3.4' );
$this->assertInstanceOf('GeoIP2\Model\Country', $country);
$this->assertEquals(42, $country->continent->geonameId,
'continent geoname_id is 42');
$this->assertEquals('NA', $country->continent->continentCode,
'continent continent_code is NA');
$this->assertEquals(array('en' => 'North America'),
$country->continent->names, 'continent names');
$this->assertEquals('North America', $country->continent->name,
'continent name is North America');
$this->assertEquals(1, $country->country->geonameId,
'country geoname_id is 1');
$this->assertEquals('US', $country->country->isoCode,
'country iso_code is US');
$this->assertEquals(array( 'en' => 'United States of America' ),
$country->country->names, 'country names');
$this->assertEquals('United States of America',
$country->country->name,
'country name is United States of America');
}
public function testMe()
{
$client = $this->client($this->getResponse('me'));
$this->assertInstanceOf('GeoIP2\Model\CityIspOrg',
$client->cityIspOrg('me' ),
'can set ip parameter to me');
}
/**
* @expectedException GeoIP2\Exception\GenericException
* @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()
{
$client = $this->client($this->getResponse('1.2.3.5'));
$client->country('1.2.3.5');
}
/**
* @expectedException GeoIP2\Exception\GenericException
* @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()
{
$client = $this->client($this->getResponse('2.2.3.5'));
$client->country('2.2.3.5');
}
/**
* @expectedException GeoIP2\Exception\WebserviceException
* @expectedExceptionCode IP_ADDRESS_INVALID
* @expectedExceptionMessage The value "1.2.3" is not a valid ip address
*/
public function testInvalidIPException()
{
$client = $this->client($this->getResponse('1.2.3.6'));
$client->country('1.2.3.6');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 400
* @expectedExceptionMessage with no body
*/
public function testNoErrorBodyIPException()
{
$client = $this->client($this->getResponse('1.2.3.7'));
$client->country('1.2.3.7');
}
/**
* @expectedException GeoIP2\Exception\GenericException
* @expectedExceptionMessage Response contains JSON but it does not specify code or error keys
*/
public function testWeirdErrorBodyIPException()
{
$client = $this->client($this->getResponse('1.2.3.8'));
$client->country('1.2.3.8');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 400
* @expectedExceptionMessage did not include the expected JSON body
*/
public function testInvalidErrorBodyIPException()
{
$client = $this->client($this->getResponse('1.2.3.9'));
$client->country('1.2.3.9');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 500
* @expectedExceptionMessage Received a server error (500)
*/
public function test500PException()
{
$client = $this->client($this->getResponse('1.2.3.10'));
$client->country('1.2.3.10');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 300
* @expectedExceptionMessage Received a very surprising HTTP status (300)
*/
public function test3xxException()
{
$client = $this->client($this->getResponse('1.2.3.11'));
$client->country('1.2.3.11');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @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
*/
public function test406Exception()
{
$client = $this->client($this->getResponse('1.2.3.12'));
$client->country('1.2.3.12');
}
public function testParams() {
$plugin = new MockPlugin();
$plugin->addResponse($this->getResponse('1.2.3.4'));
$guzzleClient = new GuzzleClient();
$guzzleClient->addSubscriber($plugin);
$client = new Client(42, 'abcdef123456', array('en'),
$guzzleClient);
$client->country('1.2.3.4');
$request = $plugin->getReceivedRequests()[0];
$this->assertEquals('https://geoip.maxmind.com/geoip/v2.0/country/1.2.3.4',
$request->getUrl(),
'got expected URI for Country request');
$this->assertEquals('GET', $request->getMethod(), 'request is a GET');
$this->assertEquals('application/json', $request->getHeader('Accept'),
'request sets Accept header to application/json');
$this->assertStringMatchesFormat('GeoIP2 PHP API (Guzzle%s)',
$request->getHeader('User-Agent') . '',
'request sets Accept header to application/json');
}
private function client($response, $languages=array('en')) {
$plugin = new MockPlugin();
$plugin->addResponse($response);
$guzzleClient = new GuzzleClient();
$guzzleClient->addSubscriber($plugin);
$client = new Client(42, 'abcdef123456', $languages,
$guzzleClient);
return $client;
}
private function response($endpoint, $status, $body=null,
$bad=null, $contentType=null)
{
$headers = Array();
if( $contentType) {
$headers['Content-Type'] = $contentType;
}
elseif ( $status == 200 || ( $status >= 400 && $status < 500 ) ) {
$headers['Content-Type'] = 'application/vnd.maxmind.com-'
. $endpoint . '+json; charset=UTF-8; version=1.0;';
} }
if ($bad) { public function testCountry()
$body = '{ invalid: }'; {
} $country = $this->client($this->getResponse('1.2.3.4'))
elseif (is_array($body)) { ->country('1.2.3.4');
$body = json_encode($body);
$this->assertInstanceOf('GeoIP2\Model\Country', $country);
$this->assertEquals(
42,
$country->continent->geonameId,
'continent geoname_id is 42'
);
$this->assertEquals(
'NA',
$country->continent->continentCode,
'continent continent_code is NA'
);
$this->assertEquals(
array('en' => 'North America'),
$country->continent->names,
'continent names'
);
$this->assertEquals(
'North America',
$country->continent->name,
'continent name is North America'
);
$this->assertEquals(
1,
$country->country->geonameId,
'country geoname_id is 1'
);
$this->assertEquals(
'US',
$country->country->isoCode,
'country iso_code is US'
);
$this->assertEquals(
array( 'en' => 'United States of America' ),
$country->country->names,
'country names'
);
$this->assertEquals(
'United States of America',
$country->country->name,
'country name is United States of America'
);
} }
$headers['Content-Length'] = strlen($body); public function testMe()
{
$client = $this->client($this->getResponse('me'));
return new Response($status, $headers, $body); $this->assertInstanceOf(
} 'GeoIP2\Model\CityIspOrg',
$client->cityIspOrg('me'),
'can set ip parameter to me'
);
}
public function testTest() /**
{ * @expectedException GeoIP2\Exception\GenericException
$this->assertEquals(1,1); * @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()
{
$client = $this->client($this->getResponse('1.2.3.5'));
$client->country('1.2.3.5');
}
/**
* @expectedException GeoIP2\Exception\GenericException
* @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()
{
$client = $this->client($this->getResponse('2.2.3.5'));
$client->country('2.2.3.5');
}
/**
* @expectedException GeoIP2\Exception\WebserviceException
* @expectedExceptionCode IP_ADDRESS_INVALID
* @expectedExceptionMessage The value "1.2.3" is not a valid ip address
*/
public function testInvalidIPException()
{
$client = $this->client($this->getResponse('1.2.3.6'));
$client->country('1.2.3.6');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 400
* @expectedExceptionMessage with no body
*/
public function testNoErrorBodyIPException()
{
$client = $this->client($this->getResponse('1.2.3.7'));
$client->country('1.2.3.7');
}
/**
* @expectedException GeoIP2\Exception\GenericException
* @expectedExceptionMessage Response contains JSON but it does not specify code or error keys
*/
public function testWeirdErrorBodyIPException()
{
$client = $this->client($this->getResponse('1.2.3.8'));
$client->country('1.2.3.8');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 400
* @expectedExceptionMessage did not include the expected JSON body
*/
public function testInvalidErrorBodyIPException()
{
$client = $this->client($this->getResponse('1.2.3.9'));
$client->country('1.2.3.9');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 500
* @expectedExceptionMessage Received a server error (500)
*/
public function test500PException()
{
$client = $this->client($this->getResponse('1.2.3.10'));
$client->country('1.2.3.10');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @expectedExceptionCode 300
* @expectedExceptionMessage Received a very surprising HTTP status (300)
*/
public function test3xxException()
{
$client = $this->client($this->getResponse('1.2.3.11'));
$client->country('1.2.3.11');
}
/**
* @expectedException GeoIP2\Exception\HttpException
* @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
*/
public function test406Exception()
{
$client = $this->client($this->getResponse('1.2.3.12'));
$client->country('1.2.3.12');
}
public function testParams()
{
$plugin = new MockPlugin();
$plugin->addResponse($this->getResponse('1.2.3.4'));
$guzzleClient = new GuzzleClient();
$guzzleClient->addSubscriber($plugin);
$client = new Client(
42,
'abcdef123456',
array('en'),
$guzzleClient
);
$client->country('1.2.3.4');
$request = $plugin->getReceivedRequests()[0];
$this->assertEquals(
'https://geoip.maxmind.com/geoip/v2.0/country/1.2.3.4',
$request->getUrl(),
'got expected URI for Country request'
);
$this->assertEquals(
'GET',
$request->getMethod(),
'request is a GET'
);
$this->assertEquals(
'application/json',
$request->getHeader('Accept'),
'request sets Accept header to application/json'
);
$this->assertStringMatchesFormat(
'GeoIP2 PHP API (Guzzle%s)',
$request->getHeader('User-Agent') . '',
'request sets Accept header to application/json'
);
}
private function client($response, $languages = array('en'))
{
$plugin = new MockPlugin();
$plugin->addResponse($response);
$guzzleClient = new GuzzleClient();
$guzzleClient->addSubscriber($plugin);
$client = new Client(
42,
'abcdef123456',
$languages,
$guzzleClient
);
return $client;
}
private function response(
$endpoint,
$status,
$body = null,
$bad = null,
$contentType = null
) {
$headers = array();
if ($contentType) {
$headers['Content-Type'] = $contentType;
} elseif ($status == 200 || ( $status >= 400 && $status < 500 )) {
$headers['Content-Type'] = 'application/vnd.maxmind.com-'
. $endpoint . '+json; charset=UTF-8; version=1.0;';
}
if ($bad) {
$body = '{ invalid: }';
} elseif (is_array($body)) {
$body = json_encode($body);
}
$headers['Content-Length'] = strlen($body);
return new Response($status, $headers, $body);
}
public function testTest()
{
$this->assertEquals(1, 1);
}
}

1
tests/bootstrap.php
View File

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