Merge pull request #306 from toin0u/hotfix-googlemaps

Support Google Maps API key

Author: toin0u

README.md

@@ -144,12 +144,13 @@ A valid api key is required.
 ### GoogleMapsProvider ###
 
 The `GoogleMapsProvider` named `google_maps` is able to geocode and reverse geocode **street addresses**.
+A locale and a region can be set as well as an optional api key. This provider also supports SSL.
 
 
 ### GoogleMapsBusinessProvider ###
 
 The `GoogleMapsBusinessProvider` named `google_maps_business` is able to geocode and reverse geocode **street addresses**.
-A valid `Client ID` is required. The private key is optional.
+A valid `Client ID` is required. The private key is optional. This provider also supports SSL.
 
 
 ### BingMapsProvider ###

src/Geocoder/Provider/GoogleMapsProvider.php

@@ -13,6 +13,7 @@
 use Geocoder\Exception\NoResultException;
 use Geocoder\Exception\QuotaExceededException;
 use Geocoder\Exception\UnsupportedException;
+use Geocoder\Exception\InvalidCredentialsException;
 use Geocoder\HttpAdapter\HttpAdapterInterface;
 
 /**
@@ -40,18 +41,25 @@ class GoogleMapsProvider extends AbstractProvider implements LocaleAwareProvider
      */
     private $useSsl = false;
 
+    /**
+     * @var string
+     */
+    private $apiKey = null;
+
     /**
      * @param HttpAdapterInterface $adapter An HTTP adapter.
      * @param string               $locale  A locale (optional).
      * @param string               $region  Region biasing (optional).
      * @param bool                 $useSsl  Whether to use an SSL connection (optional)
+     * @param string               $apiKey  Google Geocoding API key (optional)
      */
-    public function __construct(HttpAdapterInterface $adapter, $locale = null, $region = null, $useSsl = false)
+    public function __construct(HttpAdapterInterface $adapter, $locale = null, $region = null, $useSsl = false, $apiKey = null)
     {
         parent::__construct($adapter, $locale);
 
         $this->region = $region;
         $this->useSsl = $useSsl;
+        $this->apiKey = $apiKey;
     }
 
     /**
@@ -104,6 +112,10 @@ protected function buildQuery($query)
             $query = sprintf('%s&region=%s', $query, $this->getRegion());
         }
 
+        if (null !== $this->apiKey) {
+            $query = sprintf('%s&key=%s', $query, $this->apiKey);
+        }
+
         return $query;
     }
 
@@ -129,6 +141,10 @@ protected function executeQuery($query)
             throw new NoResultException(sprintf('Could not execute query %s', $query));
         }
 
+        if('REQUEST_DENIED' === $json->status && 'The provided API key is invalid.' === $json->error_message) {
+            throw new InvalidCredentialsException(sprintf('API key is invalid %s', $query));
+        }
+
         // you are over your quota
         if ('OVER_QUERY_LIMIT' === $json->status) {
             throw new QuotaExceededException(sprintf('Daily quota exceeded %s', $query));

tests/Geocoder/Tests/Provider/GoogleMapsProviderTest.php

@@ -286,4 +286,14 @@ public function testGetGeocodedDataWithCityDistrict()
         $this->assertInternalType('array', $result);
         $this->assertEquals('Kalbach-Riedberg', $result['cityDistrict']);
     }
+
+    /**
+     * @expectedException \Geocoder\Exception\InvalidCredentialsException
+     * @expectedExceptionMessage API key is invalid http://maps.googleapis.com/maps/api/geocode/json?address=10%20avenue%20Gambetta%2C%20Paris%2C%20France&sensor=false
+     */
+    public function testGetGeocodedDataWithInavlidApiKey()
+    {
+        $provider = new GoogleMapsProvider($this->getMockAdapterReturns('{"error_message":"The provided API key is invalid.", "status":"REQUEST_DENIED"}'));
+        $provider->getGeocodedData('10 avenue Gambetta, Paris, France');
+    }
 }