Merge pull request geocoder-php#507 from mtmail/OpenCage-more-exception-cases

Handle invalid API key, over quota respones for OpenCage provider

Author: willdurand

src/Geocoder/Provider/OpenCage.php

@@ -10,6 +10,7 @@
 namespace Geocoder\Provider;
 
 use Geocoder\Exception\InvalidCredentials;
+use Geocoder\Exception\QuotaExceeded;
 use Geocoder\Exception\NoResult;
 use Geocoder\Exception\UnsupportedOperation;
 use Ivory\HttpAdapter\HttpAdapterInterface;
@@ -106,6 +107,18 @@ private function executeQuery($query)
 
  $json = json_decode($content, true);
 
+ // https://geocoder.opencagedata.com/api#codes
+ if (isset($json['status'])) {
+ switch ($json['status']['code']) {
+ case 400:
+ throw new InvalidArgument('Invalid request (a required parameter is missing).');
+ case 402:
+ throw new QuotaExceeded('Valid request but quota exceeded.');
+ case 403:
+ throw new InvalidCredentials('Invalid or missing api key.');
+ }
+ }
+
  if (!isset($json['total_results']) || $json['total_results'] == 0) {
  throw new NoResult(sprintf('Could not find results for query "%s".', $query));
  }

tests/Geocoder/Tests/Provider/OpenCageTest.php

@@ -253,6 +253,47 @@ public function testGeocodeWithLocale()
  $this->assertEquals('GB', $result->getCountry()->getCode());
  }
 
+
+ /**
+ * @expectedException \Geocoder\Exception\QuotaExceeded
+ * @expectedExceptionMessage Valid request but quota exceeded.
+ */
+ public function testGeocodeQuotaExceeded()
+ {
+ $provider = new OpenCage(
+ $this->getMockAdapterReturns(
+ '{
+ "status": {
+ "code": 402,
+ "message": "quota exceeded"
+ }
+ }'
+ ),
+ 'api_key'
+ );
+ $provider->geocode('New York');
+ }
+
+ /**
+ * @expectedException \Geocoder\Exception\InvalidCredentials
+ * @expectedExceptionMessage Invalid or missing api key.
+ */
+ public function testGeocodeInvalidApiKey()
+ {
+ $provider = new OpenCage(
+ $this->getMockAdapterReturns(
+ '{
+ "status": {
+ "code": 403,
+ "message": "invalid API key"
+ }
+ }'
+ ),
+ 'api_key'
+ );
+ $provider->geocode('New York');
+ }
+
  /**
  * @expectedException \Geocoder\Exception\UnsupportedOperation
  * @expectedExceptionMessage The OpenCage provider does not support IP addresses, only street addresses.