Merge pull request #3 from answear/city-street-requests

Add requests related to cities and streets

Author: SzymonKaminski

src/Enum/RequestEnum.php

@@ -10,8 +10,36 @@ class RequestEnum extends Enum
 {
     public const SEARCH_DIVISIONS = 'searchDivisions';
 
+    public const GET_API_VERSION = 'getApiVersion';
+
+    public const SEARCH_CITY_BY_POST_CODE = 'searchCityByPostCode';
+
+    public const SEARCH_CITY = 'searchCity';
+
+    public const SEARCH_STREET_BY_NAME_AND_CITY_ID_REF = 'searchStreetByNameAndCityIdRef';
+
     public static function searchDivisions(): self
     {
         return static::get(static::SEARCH_DIVISIONS);
     }
+
+    public static function getApiVersion(): self
+    {
+        return static::get(static::GET_API_VERSION);
+    }
+
+    public static function searchCityByPostCode(): self
+    {
+        return static::get(static::SEARCH_CITY_BY_POST_CODE);
+    }
+
+    public static function searchCity(): self
+    {
+        return static::get(static::SEARCH_CITY);
+    }
+
+    public static function searchStreetByNameAndCityIdRef(): self
+    {
+        return static::get(static::SEARCH_STREET_BY_NAME_AND_CITY_ID_REF);
+    }
 }

src/Enum/ResponseEnum.php

@@ -8,5 +8,18 @@ class ResponseEnum
 {
     public const SEARCH_DIVISIONS = 'searchDivisionsResponse';
 
+    public const GET_API_VERSION = 'getApiVersionResponse';
+
+    public const SEARCH_CITY_BY_POST_CODE = 'searchCityByPostCodeResponse';
+
+    public const SEARCH_CITY = 'searchCityResponse';
+
+    public const SEARCH_STREET_BY_NAME_AND_CITY_ID_REF = 'searchStreetByNameAndCityIdRefResponse';
+
+    // inner DTOs
     public const DIVISION_DTO = 'divisionApiBean';
+
+    public const CITY_DTO = 'cityApiBean';
+
+    public const STREET_DTO = 'streetApiBean';
 }

src/Exception/MeestException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\MeestBundle\Exception;
+
+class MeestException extends \RuntimeException
+{
+    public function __construct(\SoapFault $soapFault)
+    {
+        parent::__construct('Meest B2B API error has occurred.', 0, $soapFault);
+    }
+}

src/Request/GetApiVersion.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\MeestBundle\Request;
+
+use Answear\MeestBundle\Enum\RequestEnum;
+
+class GetApiVersion implements RequestInterface
+{
+    public function __construct()
+    {
+    }
+
+    public function getEndpoint(): RequestEnum
+    {
+        return RequestEnum::getApiVersion();
+    }
+
+    public function toArray(): array
+    {
+        return [];
+    }
+}

src/Request/RequestInterface.php

@@ -8,7 +8,7 @@
 
 interface RequestInterface
 {
-    public function getMethod(): RequestEnum;
+    public function getEndpoint(): RequestEnum;
 
     public function toArray(): array;
 }

src/Request/SearchCity.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\MeestBundle\Request;
+
+use Answear\MeestBundle\Enum\RequestEnum;
+
+class SearchCity implements RequestInterface
+{
+    /**
+     * @var string
+     */
+    private $cityName;
+
+    public function __construct(string $cityName)
+    {
+        $this->cityName = $cityName;
+    }
+
+    public function getEndpoint(): RequestEnum
+    {
+        return RequestEnum::searchCity();
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'arg0' => $this->cityName,
+        ];
+    }
+}

src/Request/SearchCityByPostCode.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\MeestBundle\Request;
+
+use Answear\MeestBundle\Enum\RequestEnum;
+use Webmozart\Assert\Assert;
+
+class SearchCityByPostCode implements RequestInterface
+{
+    /**
+     * @var string
+     */
+    private $postCode;
+
+    public function __construct(string $postCode)
+    {
+        Assert::length($postCode, 5);
+        Assert::digits($postCode);
+        $this->postCode = $postCode;
+    }
+
+    public function getEndpoint(): RequestEnum
+    {
+        return RequestEnum::searchCityByPostCode();
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'arg0' => $this->postCode,
+        ];
+    }
+}

src/Request/SearchDivisions.php

@@ -25,7 +25,7 @@ public function __construct(?DivisionTypeEnum $divisionType = null, ?string $cit
         $this->cityId = $cityId;
     }
 
-    public function getMethod(): RequestEnum
+    public function getEndpoint(): RequestEnum
     {
         return RequestEnum::searchDivisions();
     }

src/Request/SearchStreetByNameAndCityIdRef.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\MeestBundle\Request;
+
+use Answear\MeestBundle\Enum\RequestEnum;
+
+class SearchStreetByNameAndCityIdRef implements RequestInterface
+{
+    /**
+     * @var string
+     */
+    private $cityId;
+
+    /**
+     * @var string
+     */
+    private $streetName;
+
+    public function __construct(string $cityId, string $streetName)
+    {
+        $this->cityId = $cityId;
+        $this->streetName = $streetName;
+    }
+
+    public function getEndpoint(): RequestEnum
+    {
+        return RequestEnum::searchStreetByNameAndCityIdRef();
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'arg0' => $this->cityId,
+            'arg1' => $this->streetName,
+        ];
+    }
+}

src/Response/DTO/CityDTO.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\MeestBundle\Response\DTO;
+
+class CityDTO
+{
+    /**
+     * @var string
+     */
+    public $cityIdRef;
+
+    /**
+     * @var string
+     */
+    public $descriptionUA;
+
+    /**
+     * @var string|null
+     */
+    public $descriptionRU;
+
+    /**
+     * @var string|null
+     */
+    public $descriptionEN;
+
+    /**
+     * @var string
+     */
+    public $regionDescriptionUA;
+
+    /**
+     * @var string|null
+     */
+    public $regionDescriptionRU;
+
+    /**
+     * @var string|null
+     */
+    public $regionDescriptionEN;
+
+    /**
+     * @var string
+     */
+    public $districtDescriptionUA;
+
+    /**
+     * @var string|null
+     */
+    public $districtDescriptionRU;
+
+    /**
+     * @var string|null
+     */
+    public $districtDescriptionEN;
+
+}