Adding ability to specify an HTTP timeout

Also changing Guzzle link in readme to point to appropriate version
This commit is contained in:
Will Bradley 2015-03-19 13:17:24 -07:00
parent a7f561bb64
commit a323cc38cb
3 changed files with 38 additions and 5 deletions

View File

@ -305,7 +305,7 @@ supported.
This library works and is tested with HHVM. This library works and is tested with HHVM.
This library also relies on the [Guzzle HTTP client](http://guzzlephp.org/) This library also relies on the [Guzzle3 HTTP client](https://github.com/guzzle/guzzle3)
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 If you are using PHP 5.3 with an autoloader besides Composer, you must load

View File

@ -51,6 +51,8 @@ class Client implements ProviderInterface
private $locales; private $locales;
private $host; private $host;
private $guzzleClient; private $guzzleClient;
private $timeout;
private $connectTimeout;
/** /**
* Constructor. * Constructor.
@ -62,13 +64,17 @@ 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
* @param string $connectTimeout Initial connection timeout
*/ */
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;
@ -76,6 +82,8 @@ 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;
} }
/** /**
@ -180,7 +188,14 @@ class Client implements ProviderInterface
$client = $this->guzzleClient ? $client = $this->guzzleClient ?
$this->guzzleClient : new GuzzleClient(); $this->guzzleClient : new GuzzleClient();
$request = $client->get($uri, array('Accept' => 'application/json')); $options = array();
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

@ -419,7 +419,9 @@ 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');
@ -446,7 +448,19 @@ 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 application/json' 'request sets Accept header to GeoIP2 PHP API (Guzzle%s)'
);
$this->assertEquals(
'27000',
$request->getCurlOptions()[CURLOPT_TIMEOUT_MS],
'request sets Curl Option Timeout to 27 seconds'
);
$this->assertEquals(
'72000',
$request->getCurlOptions()[CURLOPT_CONNECTTIMEOUT_MS],
'request sets Curl Option Connect Timeout to 72 seconds'
); );
} }
@ -464,6 +478,10 @@ 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;