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

Rename GeoIP2 => GeoIp2 for consistency

Browse Source
This commit is contained in:
Gregory Oschwald
2013-07-10 15:24:40 -07:00
parent 1c37dcac03
commit e60181f13a
28 changed files with 179 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/GeoIp2/Test/Model/CountryTest.php
+162
View File
@@ -0,0 +1,162 @@
<?php
namespace GeoIp2\Test\Model;
use GeoIp2\Model\Country;
class CountryTest extends \PHPUnit_Framework_TestCase
{
private $raw = 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' ),
),
'registered_country' => array(
'geoname_id' => 2,
'iso_code' => 'CA',
'names' => array( 'en' => 'Canada' ),
),
'traits' => array(
'ip_address' => '1.2.3.4',
),
);
private $model;
public function setUp ()
{
$this->model = new Country($this->raw, array('en'));
}
public function testObjects ()
{
$this->assertInstanceOf(
'GeoIp2\Model\Country',
$this->model,
'minimal GeoIp2::Model::Country object'
);
$this->assertInstanceOf(
'GeoIp2\Record\Continent',
$this->model->continent
);
$this->assertInstanceOf(
'GeoIp2\Record\Country',
$this->model->country
);
$this->assertInstanceOf(
'GeoIp2\Record\Country',
$this->model->registeredCountry
);
$this->assertInstanceOf(
'GeoIp2\Record\RepresentedCountry',
$this->model->representedCountry
);
$this->assertInstanceOf(
'GeoIp2\Record\Traits',
$this->model->traits
);
}
public function testValues()
{
$this->assertEquals(
42,
$this->model->continent->geonameId,
'continent geoname_id is 42'
);
$this->assertEquals(
'NA',
$this->model->continent->code,
'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'
);
}
}
tests/GeoIp2/Test/Model/NameTest.php
+82
View File
@@ -0,0 +1,82 @@
<?php
namespace GeoIp2\Test\Model;
use GeoIp2\Model\Country;
class NameTest extends \PHPUnit_Framework_TestCase
{
public $raw = array(
'continent' => array(
'code' => 'NA',
'geoname_id' => 42,
'names' => array(
'en' => 'North America',
'zh-CN' => '北美洲',
),
),
'country' => array(
'geoname_id' => 1,
'iso_code' => 'US',
'names' => array(
'en' => 'United States of America',
'ru' => 'объединяет государства',
'zh-CN' => '美国',
),
),
'traits' => array(
'ip_address' => '1.2.3.4',
),
);
public function testFallback()
{
$model = new Country($this->raw, array( 'ru', 'zh-CN', 'en' ));
$this->assertEquals(
'北美洲',
$model->continent->name,
'continent name is in Chinese (no Russian available)'
);
$this->assertEquals(
'объединяет государства',
$model->country->name,
'country name is in Russian'
);
}
public function testTwoFallbacks()
{
$model = new Country($this->raw, array('ru', 'ja'));
$this->assertEquals(
null,
$model->continent->name,
'continent name is undef (no Russian or Japanese available)'
);
$this->assertEquals(
'объединяет государства',
$model->country->name,
'country name is in Russian'
);
}
public function testNoFallbacks()
{
$model = new Country($this->raw, array('ja'));
$this->assertEquals(
null,
$model->continent->name,
'continent name is undef (no Japanese available) '
);
$this->assertEquals(
null,
$model->country->name,
'country name is undef (no Japanese available) '
);
}
}
tests/GeoIp2/Test/Model/OmniTest.php
+248
View File
@@ -0,0 +1,248 @@
<?php
namespace GeoIp2\Test\Model;
use GeoIp2\Model\Omni;
class OmniTest extends \PHPUnit_Framework_TestCase
{
public function testFull()
{
$raw = array(
'city' => array(
'confidence' => 76,
'geoname_id' => 9876,
'names' => array( 'en' => 'Minneapolis' ),
),
'continent' => array(
'code' => 'NA',
'geoname_id' => 42,
'names' => array( 'en' => 'North America' ),
),
'country' => array(
'confidence' => 99,
'geoname_id' => 1,
'iso_code' => 'US',
'names' => array( 'en' => 'United States of America' ),
),
'location' => array(
'accuracy_radius' => 1500,
'latitude' => 44.98,
'longitude' => 93.2636,
'metro_code' => 765,
'postal_code' => '55401',
'postal_confidence' => 33,
'time_zone' => 'America/Chicago',
),
'maxmind' => array(
'queries_remaining' => 22,
),
'registered_country' => array(
'geoname_id' => 2,
'iso_code' => 'CA',
'names' => array( 'en' => 'Canada' ),
),
'represented_country' => array(
'geoname_id' => 3,
'iso_code' => 'GB',
'names' => array( 'en' => 'United Kingdom' ),
),
'subdivisions' => array(
array(
'confidence' => 88,
'geoname_id' => 574635,
'iso_code' => 'MN',
'names' => array( 'en' => 'Minnesota' ),
)
),
'traits' => array(
'autonomous_system_number' => 1234,
'autonomous_system_organization' => 'AS Organization',
'domain' => 'example.com',
'ip_address' => '1.2.3.4',
'is_satellite_provider' => 1,
'isp' => 'Comcast',
'organization' => 'Blorg',
'user_type' => 'college',
),
);
$model = new Omni($raw, array('en'));
$this->assertInstanceOf(
'GeoIp2\Model\Omni',
$model,
'GeoIp2\Model\Omni object'
);
$this->assertInstanceOf(
'GeoIp2\Record\City',
$model->city,
'$model->city'
);
$this->assertInstanceOf(
'GeoIp2\Record\Continent',
$model->continent,
'$model->continent'
);
$this->assertInstanceOf(
'GeoIp2\Record\Country',
$model->country,
'$model->country'
);
$this->assertInstanceOf(
'GeoIp2\Record\Location',
$model->location,
'$model->location'
);
$this->assertInstanceOf(
'GeoIp2\Record\Country',
$model->registeredCountry,
'$model->registeredCountry'
);
$this->assertInstanceOf(
'GeoIp2\Record\RepresentedCountry',
$model->representedCountry,
'$model->representedCountry'
);
$subdivisions = $model->subdivisions;
foreach ($subdivisions as $subdiv) {
$this->assertInstanceOf('GeoIp2\Record\Subdivision', $subdiv);
}
$this->assertInstanceOf(
'GeoIp2\Record\Subdivision',
$model->mostSpecificSubdivision,
'$model->mostSpecificSubdivision'
);
$this->assertInstanceOf(
'GeoIp2\Record\Traits',
$model->traits,
'$model->traits'
);
$this->assertEquals(
22,
$model->maxmind->queriesRemaining,
'queriesRemaining is correct'
);
$this->assertEquals(
$raw,
$model->raw,
'raw method returns raw input'
);
}
public function testEmptyObjects()
{
$raw = array( 'traits' => array( 'ip_address' => '5.6.7.8' ) );
$model = new Omni($raw, array('en'));
$this->assertInstanceOf(
'GeoIp2\Model\Omni',
$model,
'GeoIp2\Model\Omni object with no data except traits.ipAddress'
);
$this->assertInstanceOf(
'GeoIp2\Record\City',
$model->city,
'$model->city'
);
$this->assertInstanceOf(
'GeoIp2\Record\Continent',
$model->continent,
'$model->continent'
);
$this->assertInstanceOf(
'GeoIp2\Record\Country',
$model->country,
'$model->country'
);
$this->assertInstanceOf(
'GeoIp2\Record\Location',
$model->location,
'$model->location'
);
$this->assertInstanceOf(
'GeoIp2\Record\Country',
$model->registeredCountry,
'$model->registeredCountry'
);
$this->assertInstanceOf(
'GeoIp2\Record\RepresentedCountry',
$model->representedCountry,
'$model->representedCountry'
);
$this->assertCount(
0,
$model->subdivisions,
'$model->subdivisions returns an empty list'
);
$this->assertInstanceOf(
'GeoIp2\Record\Subdivision',
$model->mostSpecificSubdivision,
'$model->mostSpecificSubdivision'
);
$this->assertInstanceOf(
'GeoIp2\Record\Traits',
$model->traits,
'$model->traits'
);
$this->assertEquals(
$raw,
$model->raw,
'raw method returns raw input with no added empty values'
);
}
public function testUnknown()
{
$raw = array(
'new_top_level' => array( 'foo' => 42 ),
'city' => array(
'confidence' => 76,
'geoname_id_id' => 9876,
'names' => array( 'en' => 'Minneapolis' ),
'population' => 50,
),
'traits' => array( 'ip_address' => '5.6.7.8' )
);
// checking whether there are exceptions with unknown keys
$model = new Omni($raw, array('en'));
$this->assertInstanceOf(
'GeoIp2\Model\Omni',
$model,
'no exception when Omni model gets raw data with unknown keys'
);
$this->assertEquals(
$raw,
$model->raw,
'raw method returns raw input'
);
}
}
tests/GeoIp2/Test/WebService/ClientTest.php
+388
View File
@@ -0,0 +1,388 @@
<?php
namespace GeoIp2\Test\WebService;
use GeoIp2\WebService\Client;
use Guzzle\Http\Client as GuzzleClient;
use Guzzle\Http\Message\Response;
use Guzzle\Plugin\Mock\MockPlugin;
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($ip)
{
$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'
),
);
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->code,
'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'
);
$this->assertEquals(
11,
$country->maxmind->queriesRemaining,
'queriesRemaining is correct'
);
}
public function testOmni()
{
$omni = $this->client($this->getResponse('1.2.3.4'))
->omni('1.2.3.4');
$this->assertInstanceOf('GeoIp2\Model\Omni', $omni);
$this->assertEquals(
42,
$omni->continent->geonameId,
'continent geoname_id is 42'
);
}
public function testCity()
{
$city = $this->client($this->getResponse('1.2.3.4'))
->city('1.2.3.4');
$this->assertInstanceOf('GeoIp2\Model\City', $city);
}
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\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.
*/
public function testNoBodyException()
{
$client = $this->client($this->getResponse('1.2.3.5'));
$client->country('1.2.3.5');
}
/**
* @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:
*/
public function testBadBodyException()
{
$client = $this->client($this->getResponse('2.2.3.5'));
$client->country('2.2.3.5');
}
/**
* @expectedException GeoIp2\Exception\WebServiceException
* @expectedExceptionCode 400
* @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\GeoIp2Exception
* @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'),
'geoip.maxmind.com',
$guzzleClient
);
$client->country('1.2.3.4');
$all_requests = $plugin->getReceivedRequests();
$request = $all_requests[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,
'geoip.maxmind.com',
$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);
}
}