Add support to Here CIT environment (#955)

* Add support to CIT environment.

* PHPDoc fix

* Tests regarding CIT environment.

* PHPDoc fix

Author: DamienHarper

Here.php

@@ -39,6 +39,16 @@ final class Here extends AbstractHttpProvider implements Provider
      */
     const REVERSE_ENDPOINT_URL = 'https://reverse.geocoder.api.here.com/6.2/reversegeocode.json?prox=%F,%F&250&app_id=%s&app_code=%s&mode=retrieveAddresses&gen=8&maxresults=%d';
 
+    /**
+     * @var string
+     */
+    const GEOCODE_CIT_ENDPOINT_URL = 'https://geocoder.cit.api.here.com/6.2/geocode.json?app_id=%s&app_code=%s&searchtext=%s&gen=8';
+
+    /**
+     * @var string
+     */
+    const REVERSE_CIT_ENDPOINT_URL = 'https://reverse.geocoder.cit.api.here.com/6.2/reversegeocode.json?prox=%F,%F&250&app_id=%s&app_code=%s&mode=retrieveAddresses&gen=8&maxresults=%d';
+
     /**
      * @var string
      */
@@ -50,17 +60,24 @@ final class Here extends AbstractHttpProvider implements Provider
     private $appCode;
 
     /**
-     * @param HttpClient $adapter An HTTP adapter.
+     * @var bool
+     */
+    private $useCIT;
+
+    /**
+     * @param HttpClient $client  An HTTP adapter.
      * @param string     $appId   An App ID.
-     * @param string     $apoCode An App code.
+     * @param string     $appCode An App code.
+     * @param bool       $useCIT  Use Customer Integration Testing environment (CIT) instead of production.
      */
-    public function __construct(HttpClient $client, string $appId, string $appCode)
+    public function __construct(HttpClient $client, string $appId, string $appCode, bool $useCIT = false)
     {
         if (empty($appId) || empty($appCode)) {
             throw new InvalidCredentials('Invalid or missing api key.');
         }
         $this->appId = $appId;
         $this->appCode = $appCode;
+        $this->useCIT = $useCIT;
 
         parent::__construct($client);
     }
@@ -75,7 +92,7 @@ public function geocodeQuery(GeocodeQuery $query): Collection
             throw new UnsupportedOperation('The Here provider does not support IP addresses, only street addresses.');
         }
 
-        $url = sprintf(self::GEOCODE_ENDPOINT_URL, $this->appId, $this->appCode, rawurlencode($query->getText()));
+        $url = sprintf($this->useCIT ? self::GEOCODE_CIT_ENDPOINT_URL : self::GEOCODE_ENDPOINT_URL, $this->appId, $this->appCode, rawurlencode($query->getText()));
 
         if (null !== $query->getLocale()) {
             $url = sprintf('%s&language=%s', $url, $query->getLocale());
@@ -90,14 +107,13 @@ public function geocodeQuery(GeocodeQuery $query): Collection
     public function reverseQuery(ReverseQuery $query): Collection
     {
         $coordinates = $query->getCoordinates();
-        $url = sprintf(self::REVERSE_ENDPOINT_URL, $coordinates->getLatitude(), $coordinates->getLongitude(), $this->appId, $this->appCode, $query->getLimit());
+        $url = sprintf($this->useCIT ? self::REVERSE_CIT_ENDPOINT_URL : self::REVERSE_ENDPOINT_URL, $coordinates->getLatitude(), $coordinates->getLongitude(), $this->appId, $this->appCode, $query->getLimit());
 
         return $this->executeQuery($url, $query->getLimit());
     }
 
     /**
      * @param string $url
-     * @param string $locale
      * @param int    $limit
      *
      * @return \Geocoder\Collection

Tests/.cached_responses/geocoder.cit.api.here.com_5a8be9c1bbbd2bb76f0864d9492c4cb8497db5d0

@@ -0,0 +1 @@
+s:998:"{"Response":{"MetaInfo":{"Timestamp":"2019-05-14T11:59:07.488+0000"},"View":[{"_type":"SearchResultsViewType","ViewId":0,"Result":[{"Relevance":1.0,"MatchLevel":"houseNumber","MatchQuality":{"Country":1.0,"City":1.0,"Street":[1.0],"HouseNumber":1.0},"MatchType":"pointAddress","Location":{"LocationId":"NT_lWsc8knsFwVitNTFX88zmA_xAD","LocationType":"address","DisplayPosition":{"Latitude":51.50341,"Longitude":-0.12765},"NavigationPosition":[{"Latitude":51.50322,"Longitude":-0.12767}],"MapView":{"TopLeft":{"Latitude":51.5045342,"Longitude":-0.129456},"BottomRight":{"Latitude":51.5022858,"Longitude":-0.125844}},"Address":{"Label":"10 Downing Street, London, SW1A 2AA, United Kingdom","Country":"GBR","State":"England","County":"London","City":"London","District":"Westminster","Street":"Downing Street","HouseNumber":"10","PostalCode":"SW1A 2AA","AdditionalData":[{"value":"United Kingdom","key":"CountryName"},{"value":"England","key":"StateName"},{"value":"London","key":"CountyName"}]}}}]}]}}";

Tests/.cached_responses/reverse.geocoder.cit.api.here.com_60b84333b0446383a5b73aec36bd3fc743fa4943

@@ -0,0 +1 @@
+s:2297:"{"Response":{"MetaInfo":{"Timestamp":"2019-05-14T14:25:50.744+0000"},"View":[{"_type":"SearchResultsViewType","ViewId":0,"Result":[{"Relevance":1.0,"Distance":-0.6,"Direction":326.1,"MatchLevel":"district","MatchQuality":{"Country":1.0,"State":1.0,"County":1.0,"City":1.0,"District":1.0,"PostalCode":1.0},"Location":{"LocationId":"NT_oGdFab4eWiYVcjO-u0pTFB","LocationType":"area","DisplayPosition":{"Latitude":38.90357,"Longitude":-77.0399},"MapView":{"TopLeft":{"Latitude":38.90939,"Longitude":-77.04974},"BottomRight":{"Latitude":38.89599,"Longitude":-77.03363}},"Address":{"Label":"Connecticut Avenue/K Street, Washington, DC, United States","Country":"USA","State":"DC","County":"District of Columbia","City":"Washington","District":"Connecticut Avenue/K Street","PostalCode":"20036","AdditionalData":[{"value":"United States","key":"CountryName"},{"value":"District of Columbia","key":"StateName"},{"value":"District of Columbia","key":"CountyName"},{"value":"N","key":"PostalCodeType"}]},"MapReference":{"ReferenceId":"1219975889","MapId":"NAAM191N0","MapVersion":"Q1/2019","MapReleaseDate":"2019-01-28","SideOfStreet":"neither","CountryId":"21000001","StateId":"21022302","CountyId":"21022303","CityId":"21022306"}}},{"Relevance":1.0,"Distance":0.7,"Direction":163.6,"MatchLevel":"district","MatchQuality":{"Country":1.0,"State":1.0,"County":1.0,"City":1.0,"District":1.0,"PostalCode":1.0},"Location":{"LocationId":"NT_zeyJ5M16Ci53y9KE8RMTGD","LocationType":"area","DisplayPosition":{"Latitude":38.89142,"Longitude":-77.03367},"MapView":{"TopLeft":{"Latitude":38.90021,"Longitude":-77.05679},"BottomRight":{"Latitude":38.88508,"Longitude":-77.00202}},"Address":{"Label":"Washington Mall, Washington, DC, United States","Country":"USA","State":"DC","County":"District of Columbia","City":"Washington","District":"Washington Mall","PostalCode":"20004","AdditionalData":[{"value":"United States","key":"CountryName"},{"value":"District of Columbia","key":"StateName"},{"value":"District of Columbia","key":"CountyName"},{"value":"N","key":"PostalCodeType"}]},"MapReference":{"ReferenceId":"1114357553","MapId":"NAAM191N0","MapVersion":"Q1/2019","MapReleaseDate":"2019-01-28","SideOfStreet":"neither","CountryId":"21000001","StateId":"21022302","CountyId":"21022303","CityId":"21022306"}}}]}]}}";

Tests/IntegrationTest.php

@@ -34,9 +34,9 @@ class IntegrationTest extends ProviderIntegrationTest
 
     protected $testIpv6 = false;
 
-    protected function createProvider(HttpClient $httpClient)
+    protected function createProvider(HttpClient $httpClient, bool $useCIT = false)
     {
-        return new Here($httpClient, $this->getAppId(), $this->getAppCode());
+        return new Here($httpClient, $this->getAppId(), $this->getAppCode(), $useCIT);
     }
 
     protected function getCacheDir()
@@ -108,6 +108,31 @@ public function testGeocodeQuery()
         }
     }
 
+    public function testGeocodeQueryCIT()
+    {
+        if (isset($this->skippedTests[__FUNCTION__])) {
+            $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
+        }
+        if (!$this->testAddress) {
+            $this->markTestSkipped('Geocoding address is not supported by this provider');
+        }
+
+        $provider = $this->createProvider($this->getCachedHttpClient(), true);
+        $query = GeocodeQuery::create('10 Downing St, London, UK')->withLocale('en');
+        $result = $provider->geocodeQuery($query);
+        $this->assertWellFormattedResult($result);
+
+        // Check Downing Street
+        $location = $result->first();
+        $this->assertEquals(51.5033, $location->getCoordinates()->getLatitude(), 'Latitude should be in London', 0.1);
+        $this->assertEquals(-0.1276, $location->getCoordinates()->getLongitude(), 'Longitude should be in London', 0.1);
+        $this->assertContains('Downing', $location->getStreetName(), 'Street name should contain "Downing St"');
+
+        if (null !== $streetNumber = $location->getStreetNumber()) {
+            $this->assertContains('10', $streetNumber, 'Street number should contain "10"');
+        }
+    }
+
     public function testGeocodeQueryWithNoResults()
     {
         if (isset($this->skippedTests[__FUNCTION__])) {
@@ -140,6 +165,22 @@ public function testReverseQuery()
         $this->assertWellFormattedResult($result);
     }
 
+    public function testReverseQueryCIT()
+    {
+        if (isset($this->skippedTests[__FUNCTION__])) {
+            $this->markTestSkipped($this->skippedTests[__FUNCTION__]);
+        }
+        if (!$this->testReverse) {
+            $this->markTestSkipped('Reverse geocoding address is not supported by this provider');
+        }
+
+        $provider = $this->createProvider($this->getCachedHttpClient(), true);
+
+        // Close to the white house
+        $result = $provider->reverseQuery(ReverseQuery::fromCoordinates(38.900206, -77.036991)->withLocale('en'));
+        $this->assertWellFormattedResult($result);
+    }
+
     public function testReverseQueryWithNoResults()
     {
         if (isset($this->skippedTests[__FUNCTION__])) {