1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486:
<?php
namespace GeoIp2\Test\WebService;
use GeoIp2\WebService\Client;
use MaxMind\WebService\Client as WsClient;
class ClientTest extends \PHPUnit_Framework_TestCase
{
private $country
= array(
'continent' => array(
'code' => 'NA',
'geoname_id' => 42,
'names' => array('en' => 'North America'),
),
'country' => array(
'geoname_id' => 1,
'iso_code' => 'US',
'names' => array('en' => 'United States of America'),
),
'maxmind' => array('queries_remaining' => 11),
'traits' => array(
'ip_address' => '1.2.3.4',
),
);
private function getResponse($ipAddress)
{
$responses = array(
'1.2.3.4' => $this->response(
'country',
200,
$this->country
),
'me' => $this->response(
'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.6' => $this->response(
'error',
400,
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.8' => $this->response(
'error',
400,
array('weird' => 42)
),
'1.2.3.9' => $this->response(
'error',
400,
null,
'bad body'
),
'1.2.3.10' => $this->response(
null,
500
),
'1.2.3.11' => $this->response(
null,
300
),
'1.2.3.12' => $this->response(
'error',
406,
'Cannot satisfy your Accept-Charset requirements',
null,
'text/plain'
),
'1.2.3.13' => $this->response(
'error',
404,
array(
'code' => 'IP_ADDRESS_NOT_FOUND',
'error' => 'The address "1.2.3.13" is not in our database.'
)
),
'1.2.3.14' => $this->response(
'error',
400,
array(
'code' => 'IP_ADDRESS_RESERVED',
'error' => 'The address "1.2.3.14" is a private address.'
)
),
'1.2.3.15' => $this->response(
'error',
401,
array(
'code' => 'AUTHORIZATION_INVALID',
'error' => 'A user ID and license key are required to use this service'
)
),
'1.2.3.16' => $this->response(
'error',
401,
array(
'code' => 'LICENSE_KEY_REQUIRED',
'error' => 'A license key is required to use this service'
)
),
'1.2.3.17' => $this->response(
'error',
401,
array(
'code' => 'USER_ID_REQUIRED',
'error' => 'A user ID is required to use this service'
)
),
'1.2.3.18' => $this->response(
'error',
402,
array(
'code' => 'OUT_OF_QUERIES',
'error' => 'The license key you have provided is out of queries.'
)
),
);
return $responses[$ipAddress];
}
public function testCountry()
{
$country = $this->makeRequest('Country', '1.2.3.4');
$this->assertInstanceOf('GeoIp2\Model\Country', $country);
$this->assertSame(
42,
$country->continent->geonameId,
'continent geoname_id is 42'
);
$this->assertSame(
'NA',
$country->continent->code,
'continent code is NA'
);
$this->assertSame(
array('en' => 'North America'),
$country->continent->names,
'continent names'
);
$this->assertSame(
'North America',
$country->continent->name,
'continent name is North America'
);
$this->assertSame(
1,
$country->country->geonameId,
'country geoname_id is 1'
);
$this->assertSame(
'US',
$country->country->isoCode,
'country iso_code is US'
);
$this->assertSame(
array('en' => 'United States of America'),
$country->country->names,
'country names'
);
$this->assertSame(
'United States of America',
$country->country->name,
'country name is United States of America'
);
$this->assertSame(
11,
$country->maxmind->queriesRemaining,
'queriesRemaining is correct'
);
}
public function testInsights()
{
$record = $this->makeRequest('Insights', '1.2.3.4');
$this->assertInstanceOf('GeoIp2\Model\Insights', $record);
$this->assertSame(
42,
$record->continent->geonameId,
'continent geoname_id is 42'
);
}
public function testCity()
{
$city = $this->makeRequest('City', '1.2.3.4');
$this->assertInstanceOf('GeoIp2\Model\City', $city);
}
public function testMe()
{
$city = $this->makeRequest('City', 'me');
$this->assertInstanceOf(
'GeoIp2\Model\City',
$city,
'can set ip parameter to me'
);
}
public function testNoBodyException()
{
$this->makeRequest('Country', '1.2.3.5');
}
public function testBadBodyException()
{
$this->makeRequest('Country', '2.2.3.5');
}
public function testInvalidIPException()
{
$this->makeRequest('Country', '1.2.3.6');
}
public function testNoErrorBodyIPException()
{
$this->makeRequest('Country', '1.2.3.7');
}
public function testWeirdErrorBodyIPException()
{
$this->makeRequest('Country', '1.2.3.8');
}
public function testInvalidErrorBodyIPException()
{
$this->makeRequest('Country', '1.2.3.9');
}
public function test500PException()
{
$this->makeRequest('Country', '1.2.3.10');
}
public function test3xxException()
{
$this->makeRequest('Country', '1.2.3.11');
}
public function test406Exception()
{
$this->makeRequest('Country','1.2.3.12');
}
public function testAddressNotFoundException()
{
$this->makeRequest('Country', '1.2.3.13');
}
public function testAddressReservedException()
{
$this->makeRequest('Country', '1.2.3.14');
}
public function testAuthorizationException()
{
$this->makeRequest('Country', '1.2.3.15');
}
public function testMissingLicenseKeyException()
{
$this->makeRequest('Country', '1.2.3.16');
}
public function testMissingUserIdException()
{
$this->makeRequest('Country', '1.2.3.17');
}
public function testOutOfQueriesException()
{
$this->makeRequest('Country', '1.2.3.18');
}
public function testParams()
{
$this->makeRequest(
'Country',
'1.2.3.4',
array('en'),
array(
'host' => 'api.maxmind.com',
'timeout' => 27,
'connectTimeout' => 72,
)
);
}
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 array($status, $headers, $body, );
}
private function makeRequest(
$service,
$ipAddress,
$locales = array('en'),
$options = array(),
$callsToRequest = 1
) {
$userId = 42;
$licenseKey = 'abcdef123456';
list($statusCode, $headers, $responseBody)
= $this->getResponse($ipAddress);
$stub = $this->getMockForAbstractClass(
'MaxMind\\WebService\\Http\\Request'
);
$contentType = isset($headers['Content-Type'])
? $headers['Content-Type']
: null;
$stub->expects($this->exactly($callsToRequest))
->method('get')
->willReturn(array($statusCode, $contentType, $responseBody));
$factory = $this->getMockBuilder(
'MaxMind\\WebService\\Http\\RequestFactory'
)->getMock();
$host = isset($options['host']) ? $options['host'] : 'geoip.maxmind.com';
$url = 'https://' . $host . '/geoip/v2.1/' . strtolower($service)
. '/' . $ipAddress;
$headers = array(
'Authorization: Basic '
. base64_encode($userId . ':' . $licenseKey),
'Accept: application/json',
);
$reflectionClass = new \ReflectionClass('MaxMind\\WebService\\Client');
$file = $reflectionClass->getFileName();
$caBundle = dirname($file) . '/cacert.pem';
$curlVersion = curl_version();
$factory->expects($this->exactly($callsToRequest))
->method('request')
->with(
$this->equalTo($url),
$this->equalTo(
array(
'headers' => $headers,
'userAgent' => 'GeoIP2-API/' . \GeoIp2\WebService\Client::VERSION
. ' MaxMind-WS-API/' . WsClient::VERSION
. ' PHP/' . PHP_VERSION
. ' curl/' . $curlVersion['version'],
'connectTimeout' => isset($options['connectTimeout'])
? $options['connectTimeout'] : null,
'timeout' => isset($options['timeout'])
? $options['timeout'] : null,
'caBundle' => $caBundle,
)
)
)->willReturn($stub);
$options['httpRequestFactory'] = $factory;
$method = strtolower($service);
$client = new \GeoIp2\WebService\Client(
$userId,
$licenseKey,
$locales,
$options
);
return $client->$method($ipAddress);
}
}