AzureMapsTest.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder\Provider\AzureMaps\Tests;

use Geocoder\IntegrationTest\BaseTestCase;
use Geocoder\Model\Address;
use Geocoder\Model\AddressCollection;
use Geocoder\Provider\AzureMaps\AzureMaps;
use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;

class AzureMapsTest extends BaseTestCase
{
    /**
     * @return string|null the directory where cached responses are stored
     */
    protected function getCacheDir()
    {
        if (isset($_SERVER['USE_CACHED_RESPONSES']) && true === $_SERVER['USE_CACHED_RESPONSES']) {
            return __DIR__.'/.cached_responses';
        }

        return null;
    }

    public function testGeocodeWithRealAddress(): void
    {
        if (!isset($_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY'])) {
            $this->markTestSkipped('You need to configure the AZURE_MAPS_SUBSCRIPTION_KEY value in phpunit.xml');
        }

        $subscriptionKey = $_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY'];
        $provider = new AzureMaps($this->getHttpClient($subscriptionKey), $subscriptionKey);

        $results = $provider->geocodeQuery(GeocodeQuery::create('Yehuda Hamaccabi 15, Tel aviv'));

        $this->assertInstanceOf(AddressCollection::class, $results);
        $this->assertCount(4, $results);

        $result = $results->first();

        $this->assertInstanceOf(Address::class, $result);
        $this->assertEqualsWithDelta(32.09388, $result->getCoordinates()->getLatitude(), 0.001);
        $this->assertEqualsWithDelta(34.78596, $result->getCoordinates()->getLongitude(), 0.001);
        $this->assertNotNull($result->getBounds());
        $this->assertEqualsWithDelta(32.09298, $result->getBounds()->getSouth(), 0.001);
        $this->assertEqualsWithDelta(34.7849, $result->getBounds()->getWest(), 0.001);
        $this->assertEqualsWithDelta(32.09478, $result->getBounds()->getNorth(), 0.001);
        $this->assertEqualsWithDelta(34.78702, $result->getBounds()->getEast(), 0.001);
        $this->assertEquals(15, $result->getStreetNumber());
        $this->assertEquals('Yehuda Hamaccabi Street', $result->getStreetName());
        $this->assertEquals(6266924, $result->getPostalCode());
        $this->assertEquals('Israel', $result->getCountry()->getName());
        $this->assertEquals('IL', $result->getCountry()->getCode());
        $this->assertEquals('Tel Aviv District', $result->getAdminLevels()->get(1)->getName());
    }

    public function testReverseWithRealCoordinates(): void
    {
        if (!isset($_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY'])) {
            $this->markTestSkipped('You need to configure the AZURE_MAPS_SUBSCRIPTION_KEY value in phpunit.xml');
        }

        $subscriptionKey = $_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY'];
        $provider = new AzureMaps($this->getHttpClient($subscriptionKey), $subscriptionKey);
        $results = $provider->reverseQuery(ReverseQuery::fromCoordinates(32.09388, 34.78596));

        $this->assertInstanceOf(AddressCollection::class, $results);
        $this->assertCount(1, $results);

        $result = $results->first();

        $this->assertInstanceOf(Address::class, $result);
        $this->assertEqualsWithDelta(32.09388, $result->getCoordinates()->getLatitude(), 0.001);
        $this->assertEqualsWithDelta(34.78596, $result->getCoordinates()->getLongitude(), 0.001);
        $this->assertNotNull($result->getBounds());
        $this->assertEqualsWithDelta(32.09298, $result->getBounds()->getSouth(), 0.001);
        $this->assertEqualsWithDelta(34.7849, $result->getBounds()->getWest(), 0.001);
        $this->assertEqualsWithDelta(32.093772, $result->getBounds()->getNorth(), 0.001);
        $this->assertEqualsWithDelta(34.78702, $result->getBounds()->getEast(), 0.001);
        $this->assertEquals(15, $result->getStreetNumber());
        $this->assertEquals('Yehuda Hamaccabi Street', $result->getStreetName());
        $this->assertEquals(6266924, $result->getPostalCode());
        $this->assertEquals('Israel', $result->getCountry()->getName());
        $this->assertEquals('IL', $result->getCountry()->getCode());
        $this->assertEquals('Tel Aviv District', $result->getAdminLevels()->get(1)->getName());
    }

    public function testGeocodeIncludesMunicipality(): void
    {
        if (!isset($_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY'])) {
            $this->markTestSkipped('You need to configure the AZURE_MAPS_SUBSCRIPTION_KEY value in phpunit.xml');
        }

        $subscriptionKey = $_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY'];
        $provider = new AzureMaps($this->getHttpClient($subscriptionKey), $subscriptionKey);

        $results = $provider->geocodeQuery(GeocodeQuery::create('Via Giuseppe Garibaldi 62, IT, Italy'));

        $this->assertInstanceOf(AddressCollection::class, $results);
        $this->assertGreaterThan(0, $results->count(), 'No results found');

        $result = $results->first();

        $this->assertInstanceOf(Address::class, $result);
        $this->assertNotNull($result->getLocality(), 'Municipality (city) is missing in the response');
        $this->assertEquals('Scisciano', $result->getLocality());
    }
}