Yandex support key (#988)

* feat: add api key support to yandex provider

* chore: update tests

* chore: style issue

Author: atymic

src/Provider/Yandex/Readme.md

@@ -16,6 +16,18 @@ This is the Yandex provider from the PHP Geocoder. This is a **READ ONLY** repos
 composer require geocoder-php/yandex-provider
 ```
 
+## Usage
+
+The API now requires an API key. [See here for more information](https://yandex.ru/blog/mapsapi/novye-pravila-dostupa-k-api-kart?from=tech_pp).
+
+```php
+$httpClient = new \Http\Adapter\Guzzle6\Client();
+$provider = new \Geocoder\Provider\Yandex\Yandex($httpClient, null, '<your-api-key>);
+
+$result = $geocoder->geocodeQuery(GeocodeQuery::create('ул.Ленина, 19, Минск 220030, Республика Беларусь'));
+$result = $geocoder->reverseQuery(ReverseQuery::fromCoordinates(...));
+```
+
 ### Note
 
 The default language-locale is `ru-RU`, you can choose between `uk-UA`, `be-BY`,

src/Provider/Yandex/Tests/.cached_responses/geocode-maps.yandex.ru_1ece1b149ef392c5f0da11797f637e7ae221bd17

@@ -1 +1 @@
-s:4485:"{"response":{"GeoObjectCollection":{"metaDataProperty":{"GeocoderResponseMetaData":{"request":"Copenhagen, Denmark","found":"13","results":"5"}},"featureMember":[{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"locality","text":"Данія, Столичная область, Копенгаген","precision":"other","AddressDetails":{"Country":{"AddressLine":"Столичная область, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Столичная область","SubAdministrativeArea":{"SubAdministrativeAreaName":"Копенгаген","Locality":{"LocalityName":"Копенгаген"}}}}}}},"description":"Столичная область, Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"12.45295 55.614999","upperCorner":"12.65075 55.732585"}},"Point":{"pos":"12.567593 55.675676"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"locality","text":"Данія, область Южная Дания, Миддельфарт, Копенгаген","precision":"other","AddressDetails":{"Country":{"AddressLine":"область Южная Дания, Миддельфарт, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"область Южная Дания","SubAdministrativeArea":{"SubAdministrativeAreaName":"Миддельфарт","Locality":{"LocalityName":"Копенгаген"}}}}}}},"description":"Миддельфарт, область Южная Дания, Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"9.971219 55.454366","upperCorner":"9.974965 55.457398"}},"Point":{"pos":"9.972854 55.455739"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"district","text":"Данія, Столичная область, Копенгаген, Копенгаген","precision":"other","AddressDetails":{"Country":{"AddressLine":"Столичная область, Копенгаген, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Столичная область","SubAdministrativeArea":{"SubAdministrativeAreaName":"Копенгаген","Locality":{"LocalityName":"Копенгаген","DependentLocality":{"DependentLocalityName":"Копенгаген"}}}}}}}},"description":"Копенгаген, Столичная область, Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"12.518464 55.703961","upperCorner":"12.551396 55.722553"}},"Point":{"pos":"12.534930 55.713258"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"district","text":"Данія, Столичная область, Копенгаген, Копенгаген","precision":"other","AddressDetails":{"Country":{"AddressLine":"Столичная область, Копенгаген, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Столичная область","SubAdministrativeArea":{"SubAdministrativeAreaName":"Копенгаген","Locality":{"LocalityName":"Копенгаген","DependentLocality":{"DependentLocalityName":"Копенгаген"}}}}}}}},"description":"Копенгаген, Столичная область, Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"12.561736 55.689578","upperCorner":"12.594668 55.708176"}},"Point":{"pos":"12.578202 55.698878"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"district","text":"Данія, Столичная область, Копенгаген, Копенгаген","precision":"other","AddressDetails":{"Country":{"AddressLine":"Столичная область, Копенгаген, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Столичная область","SubAdministrativeArea":{"SubAdministrativeAreaName":"Копенгаген","Locality":{"LocalityName":"Копенгаген","DependentLocality":{"DependentLocalityName":"Копенгаген"}}}}}}}},"description":"Копенгаген, Столичная область, Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"12.538361 55.681077","upperCorner":"12.571294 55.69968"}},"Point":{"pos":"12.554827 55.690380"}}}]}}}";
+s:3537:"{"response":{"GeoObjectCollection":{"metaDataProperty":{"GeocoderResponseMetaData":{"request":"Copenhagen, Denmark","found":"3","results":"5"}},"featureMember":[{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"locality","text":"Данія, Копенгаген","precision":"other","Address":{"country_code":"DK","formatted":"Данія, Копенгаген","Components":[{"kind":"country","name":"Данія"},{"kind":"province","name":"Столичная область"},{"kind":"area","name":"Фредериксберг"},{"kind":"locality","name":"Копенгаген"}]},"AddressDetails":{"Country":{"AddressLine":"Данія, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Столичная область","SubAdministrativeArea":{"SubAdministrativeAreaName":"Фредериксберг","Locality":{"LocalityName":"Копенгаген"}}}}}}},"description":"Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"12.453084 55.615421","upperCorner":"12.652043 55.732727"}},"Point":{"pos":"12.585828 55.680661"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"locality","text":"Данія, Столичная область, Копенгаген","precision":"other","Address":{"country_code":"DK","formatted":"Данія, Столичная область, Копенгаген","Components":[{"kind":"country","name":"Данія"},{"kind":"province","name":"Столичная область"},{"kind":"area","name":"Копенгаген"},{"kind":"locality","name":"Копенгаген"}]},"AddressDetails":{"Country":{"AddressLine":"Данія, Столичная область, Копенгаген","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Столичная область","SubAdministrativeArea":{"SubAdministrativeAreaName":"Копенгаген","Locality":{"LocalityName":"Копенгаген"}}}}}}},"description":"Столичная область, Данія","name":"Копенгаген","boundedBy":{"Envelope":{"lowerCorner":"12.313989 55.584039","upperCorner":"12.656876 55.833359"}},"Point":{"pos":"12.463837 55.716853"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"airport","text":"Данія, Зеландия, Роскилле, Копенгаген Луфтаун Роскилле","precision":"other","Address":{"country_code":"DK","formatted":"Данія, Зеландия, Роскилле, Копенгаген Луфтаун Роскилле","Components":[{"kind":"country","name":"Данія"},{"kind":"province","name":"Зеландия"},{"kind":"area","name":"Роскилле"},{"kind":"airport","name":"Копенгаген Луфтаун Роскилле"}]},"AddressDetails":{"Country":{"AddressLine":"Данія, Зеландия, Роскилле, Копенгаген Луфтаун Роскилле","CountryNameCode":"DK","CountryName":"Данія","AdministrativeArea":{"AdministrativeAreaName":"Зеландия","SubAdministrativeArea":{"SubAdministrativeAreaName":"Роскилле","Locality":{"DependentLocality":{"DependentLocalityName":"Копенгаген Луфтаун Роскилле"}}}}}}}},"description":"Роскилле, Зеландия, Данія","name":"Копенгаген Луфтаун Роскилле","boundedBy":{"Envelope":{"lowerCorner":"12.107035 55.574747","upperCorner":"12.147244 55.596788"}},"Point":{"pos":"12.130041 55.590338"}}}]}}}";

src/Provider/Yandex/Tests/.cached_responses/geocode-maps.yandex.ru_5ded45ea75499ea33bc71c8cbca1ab897dae8164

@@ -1 +1 @@
-s:4108:"{"response":{"GeoObjectCollection":{"metaDataProperty":{"GeocoderResponseMetaData":{"request":"1600 Pennsylvania Ave, Washington","found":"33","results":"5"}},"featureMember":[{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"house","text":"United States, District of Columbia, Washington, Pennsylvania Ave NW, 1600","precision":"exact","AddressDetails":{"Country":{"AddressLine":"District of Columbia, Washington, Pennsylvania Ave NW, 1600","CountryNameCode":"US","CountryName":"United States","AdministrativeArea":{"AdministrativeAreaName":"District of Columbia","SubAdministrativeArea":{"SubAdministrativeAreaName":"District of Columbia","Locality":{"LocalityName":"Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Ave NW","Premise":{"PremiseNumber":"1600"}}}}}}}}},"description":"Washington, District of Columbia, United States","name":"Pennsylvania Ave NW, 1600","boundedBy":{"Envelope":{"lowerCorner":"-77.046921 38.891265","upperCorner":"-77.030464 38.904125"}},"Point":{"pos":"-77.038692 38.897695"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States, District of Columbia, Washington, Pennsylvania Ave SE","precision":"street","AddressDetails":{"Country":{"AddressLine":"District of Columbia, Washington, Pennsylvania Ave SE","CountryNameCode":"US","CountryName":"United States","AdministrativeArea":{"AdministrativeAreaName":"District of Columbia","SubAdministrativeArea":{"SubAdministrativeAreaName":"District of Columbia","Locality":{"LocalityName":"Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Ave SE"}}}}}}}},"description":"Washington, District of Columbia, United States","name":"Pennsylvania Ave SE","boundedBy":{"Envelope":{"lowerCorner":"-77.003532 38.863739","upperCorner":"-76.946777 38.887825"}},"Point":{"pos":"-76.975235 38.875565"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States, Maryland, Washington, Pennsylvania Ave","precision":"street","AddressDetails":{"Country":{"AddressLine":"Maryland, Washington, Pennsylvania Ave","CountryNameCode":"US","CountryName":"United States","AdministrativeArea":{"AdministrativeAreaName":"Maryland","SubAdministrativeArea":{"SubAdministrativeAreaName":"Washington","Locality":{"Thoroughfare":{"ThoroughfareName":"Pennsylvania Ave"}}}}}}}},"description":"Washington, Maryland, United States","name":"Pennsylvania Ave","boundedBy":{"Envelope":{"lowerCorner":"-77.724152 39.649717","upperCorner":"-77.717513 39.721407"}},"Point":{"pos":"-77.720774 39.685568"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States, Pennsylvania, Washington, Pennsylvania Ave","precision":"street","AddressDetails":{"Country":{"AddressLine":"Pennsylvania, Washington, Pennsylvania Ave","CountryNameCode":"US","CountryName":"United States","AdministrativeArea":{"AdministrativeAreaName":"Pennsylvania","Locality":{"DependentLocality":{"DependentLocalityName":"Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Ave"}}}}}}}},"description":"Washington, Pennsylvania, United States","name":"Pennsylvania Ave","boundedBy":{"Envelope":{"lowerCorner":"-79.890044 40.118144","upperCorner":"-79.867263 40.131418"}},"Point":{"pos":"-79.878914 40.124233"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States, District of Columbia, Washington, Pennsylvania Avenue Rear SE","precision":"street","AddressDetails":{"Country":{"AddressLine":"District of Columbia, Washington, Pennsylvania Avenue Rear SE","CountryNameCode":"US","CountryName":"United States","AdministrativeArea":{"AdministrativeAreaName":"District of Columbia","SubAdministrativeArea":{"SubAdministrativeAreaName":"District of Columbia","Locality":{"LocalityName":"Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Avenue Rear SE"}}}}}}}},"description":"Washington, District of Columbia, United States","name":"Pennsylvania Avenue Rear SE","boundedBy":{"Envelope":{"lowerCorner":"-76.98341 38.879315","upperCorner":"-76.981649 38.881175"}},"Point":{"pos":"-76.982790 38.879891"}}}]}}}";
+s:6302:"{"response":{"GeoObjectCollection":{"metaDataProperty":{"GeocoderResponseMetaData":{"request":"1600 Pennsylvania Ave, Washington","found":"5","results":"5"}},"featureMember":[{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Northwest","precision":"street","Address":{"country_code":"US","formatted":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Northwest","Components":[{"kind":"country","name":"United States of America"},{"kind":"province","name":"District of Columbia"},{"kind":"locality","name":"City of Washington"},{"kind":"street","name":"Pennsylvania Avenue Northwest"}]},"AddressDetails":{"Country":{"AddressLine":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Northwest","CountryNameCode":"US","CountryName":"United States of America","AdministrativeArea":{"AdministrativeAreaName":"District of Columbia","Locality":{"LocalityName":"City of Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Avenue Northwest"}}}}}}},"description":"City of Washington, District of Columbia, United States of America","name":"Pennsylvania Avenue Northwest","boundedBy":{"Envelope":{"lowerCorner":"-77.058105 38.890612","upperCorner":"-77.012426 38.905248"}},"Point":{"pos":"-77.033608 38.895512"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Southeast","precision":"street","Address":{"country_code":"US","formatted":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Southeast","Components":[{"kind":"country","name":"United States of America"},{"kind":"province","name":"District of Columbia"},{"kind":"locality","name":"City of Washington"},{"kind":"street","name":"Pennsylvania Avenue Southeast"}]},"AddressDetails":{"Country":{"AddressLine":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Southeast","CountryNameCode":"US","CountryName":"United States of America","AdministrativeArea":{"AdministrativeAreaName":"District of Columbia","Locality":{"LocalityName":"City of Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Avenue Southeast"}}}}}}},"description":"City of Washington, District of Columbia, United States of America","name":"Pennsylvania Avenue Southeast","boundedBy":{"Envelope":{"lowerCorner":"-77.003496 38.878592","upperCorner":"-76.981559 38.887621"}},"Point":{"pos":"-76.992537 38.883092"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"district","text":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Hights","precision":"other","Address":{"country_code":"US","formatted":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Hights","Components":[{"kind":"country","name":"United States of America"},{"kind":"province","name":"District of Columbia"},{"kind":"locality","name":"City of Washington"},{"kind":"district","name":"Pennsylvania Avenue Hights"}]},"AddressDetails":{"Country":{"AddressLine":"United States of America, District of Columbia, City of Washington, Pennsylvania Avenue Hights","CountryNameCode":"US","CountryName":"United States of America","AdministrativeArea":{"AdministrativeAreaName":"District of Columbia","Locality":{"LocalityName":"City of Washington","DependentLocality":{"DependentLocalityName":"Pennsylvania Avenue Hights"}}}}}}},"description":"City of Washington, District of Columbia, United States of America","name":"Pennsylvania Avenue Hights","boundedBy":{"Envelope":{"lowerCorner":"-76.975253 38.855325","upperCorner":"-76.942321 38.88107"}},"Point":{"pos":"-76.958787 38.868199"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"United States of America, Maryland, Prince George's County, Washington, Pennsylvania Avenue Southeast","precision":"street","Address":{"country_code":"US","formatted":"United States of America, Maryland, Prince George's County, Washington, Pennsylvania Avenue Southeast","Components":[{"kind":"country","name":"United States of America"},{"kind":"province","name":"Maryland"},{"kind":"area","name":"Prince George's County"},{"kind":"locality","name":"Washington"},{"kind":"street","name":"Pennsylvania Avenue Southeast"}]},"AddressDetails":{"Country":{"AddressLine":"United States of America, Maryland, Prince George's County, Washington, Pennsylvania Avenue Southeast","CountryNameCode":"US","CountryName":"United States of America","AdministrativeArea":{"AdministrativeAreaName":"Maryland","SubAdministrativeArea":{"SubAdministrativeAreaName":"Prince George's County","Locality":{"LocalityName":"Washington","Thoroughfare":{"ThoroughfareName":"Pennsylvania Avenue Southeast"}}}}}}}},"description":"Washington, Prince George's County, Maryland, United States of America","name":"Pennsylvania Avenue Southeast","boundedBy":{"Envelope":{"lowerCorner":"-76.974508 38.853175","upperCorner":"-76.909955 38.875144"}},"Point":{"pos":"-76.942168 38.862966"}}},{"GeoObject":{"metaDataProperty":{"GeocoderMetaData":{"kind":"street","text":"France, Auvergne-Rhône-Alpes, Isère, Grenoble, Avenue Washington","precision":"street","Address":{"country_code":"FR","formatted":"France, Auvergne-Rhône-Alpes, Isère, Grenoble, Avenue Washington","Components":[{"kind":"country","name":"France"},{"kind":"province","name":"Auvergne-Rhône-Alpes"},{"kind":"area","name":"Isère"},{"kind":"locality","name":"Grenoble"},{"kind":"street","name":"Avenue Washington"}]},"AddressDetails":{"Country":{"AddressLine":"France, Auvergne-Rhône-Alpes, Isère, Grenoble, Avenue Washington","CountryNameCode":"FR","CountryName":"France","AdministrativeArea":{"AdministrativeAreaName":"Auvergne-Rhône-Alpes","SubAdministrativeArea":{"SubAdministrativeAreaName":"Isère","Locality":{"LocalityName":"Grenoble","Thoroughfare":{"ThoroughfareName":"Avenue Washington"}}}}}}}},"description":"Grenoble, Isère, Auvergne-Rhône-Alpes, France","name":"Avenue Washington","boundedBy":{"Envelope":{"lowerCorner":"5.746298 45.175579","upperCorner":"5.747915 45.182116"}},"Point":{"pos":"5.747116 45.178851"}}}]}}}";