Merge pull request #57 from rarus/dev

Task#55
rarus · Aug 22, 2018 · 56835a4 · 56835a4
2 parents 5963640 + 3860d3f
commit 56835a4
Show file tree

Hide file tree

Showing 20 changed files with 310 additions and 88 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 .idea/*
 vendor
+tests/logs/*
 composer.phar
 phpunit.xml
 composer.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # bonus-server-php-sdk change log
 
+## 0.5.1 (20.08.2018)
+- исправлена ошибка с точностью в парсере timestamp `Rarus\BonusServer\Util\DateTimeParser` [issue#55](https://github.com/rarus/bonus-server-php-sdk/issues/55)
+- исправлена ошибка с некорректными датами рождения при добавлении новых пользователей [issue#55](https://github.com/rarus/bonus-server-php-sdk/issues/55)
+- исправлена ошибка с получением пустого логина для всех пользователей [issue#55](https://github.com/rarus/bonus-server-php-sdk/issues/55)
+- подробный лог работы юнит-тестов теперь сохраняется в папке `/tests/logs/`
+- в ApiClient добавлена поддержка таймзон и метод `setTimezone` который позволяет указать нужную таймзону
+
 ## 0.5.0 (6.08.2018)
 - исправлен ошибочный 404 статус если нет скидок, результаты рассчёта скидок стали опциональными [issue#36](https://github.com/rarus/bonus-server-php-sdk/issues/36)
 - для сущности `Cards` для роли `Organization` добавлен метод `getByBarcode` [issue#31](https://github.com/rarus/bonus-server-php-sdk/issues/31) 

diff --git a/src/Rarus/BonusServer/ApiClient.php b/src/Rarus/BonusServer/ApiClient.php
@@ -57,6 +57,10 @@ class ApiClient
      * @var float number of seconds to wait while trying to connect to a server. Use 0 to wait indefinitely (the default behavior).
      */
     protected $connectTimeout;
+    /**
+     * @var \DateTimeZone временная зона в которой работает API-клиент, по умолчанию берётся зона установленная на сервере
+     */
+    protected $timezone;
 
     /**
      * ApiClient constructor.
@@ -67,22 +71,24 @@ class ApiClient
      */
     public function __construct(string $apiEndpointUrl, GuzzleHttp\ClientInterface $obHttpClient, LoggerInterface $obLogger = null)
     {
-        $this->apiEndpoint = $apiEndpointUrl;
-        $this->httpClient = $obHttpClient;
-        $this->setConnectTimeout(2.0);
-
         if ($obLogger !== null) {
             $this->log = $obLogger;
         } else {
             $this->log = new NullLogger();
         }
+        $this->apiEndpoint = $apiEndpointUrl;
+        $this->httpClient = $obHttpClient;
+        $this->setConnectTimeout(2.0);
+        $this->setTimezone(new \DateTimeZone(date_default_timezone_get()));
+
         $this->guzzleHandlerStack = GuzzleHttp\HandlerStack::create();
 
         $this->log->debug(
             'rarus.bonus.server.apiClient.init',
             [
                 'url' => $apiEndpointUrl,
                 'connect_timeout' => $this->getConnectTimeout(),
+                'timezone' => $this->getTimezone()->getName(),
             ]
         );
     }
@@ -97,10 +103,42 @@ public function getConnectTimeout(): float
 
     /**
      * @param float $connectTimeout
+     *
+     * @return ApiClient
      */
-    public function setConnectTimeout(float $connectTimeout): void
+    public function setConnectTimeout(float $connectTimeout): ApiClient
     {
+        $this->log->debug('rarus.bonus.server.apiClient.setConnectTimeout.start', [
+            'connectTimeout' => $connectTimeout,
+        ]);
         $this->connectTimeout = $connectTimeout;
+        $this->log->debug('rarus.bonus.server.apiClient.setConnectTimeout.finish');
+
+        return $this;
+    }
+
+    /**
+     * @return \DateTimeZone
+     */
+    public function getTimezone(): \DateTimeZone
+    {
+        return $this->timezone;
+    }
+
+    /**
+     * @param \DateTimeZone $timezone
+     *
+     * @return ApiClient
+     */
+    public function setTimezone(\DateTimeZone $timezone): ApiClient
+    {
+        $this->log->debug('rarus.bonus.server.apiClient.setTimezone.start', [
+            'name' => $timezone->getName(),
+        ]);
+        $this->timezone = $timezone;
+        $this->log->debug('rarus.bonus.server.apiClient.setTimezone.finish');
+
+        return $this;
     }
 
     /**
@@ -381,9 +419,15 @@ protected function getGuzzleHandlerStack(): GuzzleHttp\HandlerStack
 
     /**
      * @param GuzzleHttp\HandlerStack $guzzleHandlerStack
+     *
+     * @return ApiClient
      */
-    public function setGuzzleHandlerStack(GuzzleHttp\HandlerStack $guzzleHandlerStack): void
+    public function setGuzzleHandlerStack(GuzzleHttp\HandlerStack $guzzleHandlerStack): ApiClient
     {
+        $this->log->debug('rarus.bonus.server.apiClient.setGuzzleHandlerStack.start');
         $this->guzzleHandlerStack = $guzzleHandlerStack;
+        $this->log->debug('rarus.bonus.server.apiClient.setGuzzleHandlerStack.finish');
+
+        return $this;
     }
 }
diff --git a/src/Rarus/BonusServer/Cards/DTO/Fabric.php b/src/Rarus/BonusServer/Cards/DTO/Fabric.php
@@ -19,13 +19,14 @@
 class Fabric
 {
     /**
-     * @param array    $arCard
-     * @param Currency $currency
+     * @param array         $arCard
+     * @param Currency      $currency
+     * @param \DateTimeZone $dateTimeZone
      *
      * @return Card
      * @throws \Rarus\BonusServer\Exceptions\ApiClientException
      */
-    public static function initCardFromServerResponse(array $arCard, \Money\Currency $currency): Card
+    public static function initCardFromServerResponse(array $arCard, \Money\Currency $currency, \DateTimeZone $dateTimeZone): Card
     {
         $currencies = new ISOCurrencies();
         $moneyParser = new DecimalMoneyParser($currencies);
@@ -39,10 +40,10 @@ public static function initCardFromServerResponse(array $arCard, \Money\Currency
             ->setDescription((string)$arCard['description'])
             ->setCardLevelId(new LevelId((string)$arCard['card_level_id']))
             ->setAccumSaleAmount($moneyParser->parse((string)$arCard['accum_sale_amount'], $currency->getCode()))
-            ->setCardStatus(Status\Fabric::initFromServerResponse($arCard));
+            ->setCardStatus(Status\Fabric::initFromServerResponse($arCard, $dateTimeZone));
 
         if ($arCard['date_last_transaction'] !== 0) {
-            $card->setDateLastTransaction(DateTimeParser::parseTimestampFromServerResponse((string)$arCard['date_last_transaction']));
+            $card->setDateLastTransaction(DateTimeParser::parseTimestampFromServerResponse((string)$arCard['date_last_transaction'], $dateTimeZone));
         }
         if ($arCard['last_transaction'] !== '') {
             $card->setLastTransaction((string)$arCard['last_transaction']);

diff --git a/src/Rarus/BonusServer/Cards/DTO/Status/Fabric.php b/src/Rarus/BonusServer/Cards/DTO/Status/Fabric.php
@@ -9,23 +9,24 @@
 class Fabric
 {
     /**
-     * @param array $arCard
+     * @param array         $arCard
+     * @param \DateTimeZone $dateTimeZone
      *
      * @return CardStatus
      * @throws \Rarus\BonusServer\Exceptions\ApiClientException
      */
-    public static function initFromServerResponse(array $arCard): CardStatus
+    public static function initFromServerResponse(array $arCard, \DateTimeZone $dateTimeZone): CardStatus
     {
         $cardStatus = (new CardStatus())
             ->setIsActive((bool)$arCard['active'])
             ->setIsBlocked((bool)$arCard['blocked'])
             ->setBlockedDescription((string)$arCard['blockeddescription']);
 
         if ($arCard['date_active'] !== 0) {
-            $cardStatus->setDateActivate(DateTimeParser::parseTimestampFromServerResponse((string)$arCard['date_active']));
+            $cardStatus->setDateActivate(DateTimeParser::parseTimestampFromServerResponse((string)$arCard['date_active'], $dateTimeZone));
         }
         if ($arCard['date_deactivate'] !== 0) {
-            $cardStatus->setDateDeactivate(DateTimeParser::parseTimestampFromServerResponse((string)$arCard['date_deactivate']));
+            $cardStatus->setDateDeactivate(DateTimeParser::parseTimestampFromServerResponse((string)$arCard['date_deactivate'], $dateTimeZone));
         }
 
         return $cardStatus;

diff --git a/src/Rarus/BonusServer/Cards/DTO/TransactionAmount/Fabric.php b/src/Rarus/BonusServer/Cards/DTO/TransactionAmount/Fabric.php
@@ -17,18 +17,19 @@
 class Fabric
 {
     /**
-     * @param Currency $currency
-     * @param array    $arTransactionAmount
+     * @param Currency      $currency
+     * @param array         $arTransactionAmount
+     * @param \DateTimeZone $dateTimeZone
      *
      * @return TransactionAmount
      * @throws \Rarus\BonusServer\Exceptions\ApiClientException
      */
-    public static function initFromServerResponse(Currency $currency, array $arTransactionAmount): TransactionAmount
+    public static function initFromServerResponse(Currency $currency, array $arTransactionAmount, \DateTimeZone $dateTimeZone): TransactionAmount
     {
         $moneyParser = new DecimalMoneyParser(new ISOCurrencies());
 
         return (new TransactionAmount())
             ->setTransactionSum($moneyParser->parse((string)$arTransactionAmount['sum'], $currency->getCode()))
-            ->setDate(DateTimeParser::parseTimestampFromServerResponse((string)$arTransactionAmount['date']));
+            ->setDate(DateTimeParser::parseTimestampFromServerResponse((string)$arTransactionAmount['date'], $dateTimeZone));
     }
 }
diff --git a/src/Rarus/BonusServer/Cards/Transport/Role/Organization/Transport.php b/src/Rarus/BonusServer/Cards/Transport/Role/Organization/Transport.php
@@ -113,7 +113,7 @@ public function list(BonusServer\Transport\DTO\Pagination $pagination): BonusSer
 
         $cardCollection = new BonusServer\Cards\DTO\CardCollection();
         foreach ((array)$requestResult['cards'] as $card) {
-            $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency()));
+            $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency(), $this->apiClient->getTimezone()));
         }
 
         $paginationResponse = new BonusServer\Cards\Transport\DTO\PaginationResponse(
@@ -146,19 +146,25 @@ public function getByUser(BonusServer\Users\DTO\User $user, ?BonusServer\Transpo
             'phone' => $user->getPhone(),
         ]);
 
-        $requestResult = $this->apiClient->executeApiRequest(
-            sprintf('/organization/card?%s&calculate_count=true&user_id=%s',
-                BonusServer\Transport\Formatters\Pagination::toRequestUri($pagination),
-                $user->getUserId()->getId()
-            ),
-            RequestMethodInterface::METHOD_GET
-        );
-
         $cardCollection = new BonusServer\Cards\DTO\CardCollection();
-        foreach ((array)$requestResult['cards'] as $card) {
-            $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency()));
+        try {
+            $requestResult = $this->apiClient->executeApiRequest(
+                sprintf('/organization/card?%s&calculate_count=true&user_id=%s',
+                    BonusServer\Transport\Formatters\Pagination::toRequestUri($pagination),
+                    $user->getUserId()->getId()
+                ),
+                RequestMethodInterface::METHOD_GET
+            );
+            foreach ((array)$requestResult['cards'] as $card) {
+                $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency(), $this->apiClient->getTimezone()));
+            }
+            $cardCollection->rewind();
+        } catch (BonusServer\Exceptions\ApiClientException $exception) {
+            // если карты не найдены, то сервер возврашает 404 статус выставив 114 код в данном случае мы его подавляем
+            if ($exception->getCode() !== 114) {
+                throw $exception;
+            }
         }
-        $cardCollection->rewind();
 
         $this->log->debug('rarus.bonus.server.cards.transport.organization.getByUser.finish', [
             'itemsCount' => $cardCollection->count(),
@@ -216,7 +222,7 @@ public function getByCardId(BonusServer\Cards\DTO\CardId $cardId): BonusServer\C
             RequestMethodInterface::METHOD_GET
         );
 
-        $card = BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($requestResult['card'], $this->getDefaultCurrency());
+        $card = BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($requestResult['card'], $this->getDefaultCurrency(), $this->apiClient->getTimezone());
 
         $this->log->debug('rarus.bonus.server.cards.transport.organization.getByCardId.finish', [
             'cardId' => $card->getCardId()->getId(),
@@ -546,7 +552,7 @@ public function getByBarcode(BonusServer\Cards\DTO\Barcode\Barcode $cardBarcode)
             RequestMethodInterface::METHOD_GET
         );
 
-        $card = BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($requestResult['cards'][0], $this->getDefaultCurrency());
+        $card = BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($requestResult['cards'][0], $this->getDefaultCurrency(), $this->apiClient->getTimezone());
 
         $this->log->debug('rarus.bonus.server.cards.transport.organization.getByBarcode.finish', [
             'cardId' => $card->getCardId()->getId(),
@@ -579,7 +585,7 @@ public function getByFilter(BonusServer\Cards\DTO\CardFilter $cardFilter): Bonus
             );
 
             foreach ((array)$requestResult['cards'] as $card) {
-                $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency()));
+                $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency(), $this->apiClient->getTimezone()));
             }
 
             $this->log->debug('rarus.bonus.server.cards.transport.organization.getByFilter.finish', [

diff --git a/src/Rarus/BonusServer/Cards/Transport/Role/User/Transport.php b/src/Rarus/BonusServer/Cards/Transport/Role/User/Transport.php
@@ -34,7 +34,7 @@ public function list(): BonusServer\Cards\DTO\CardCollection
 
         $cardCollection = new BonusServer\Cards\DTO\CardCollection();
         foreach ((array)$requestResult['cards'] as $card) {
-            $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency()));
+            $cardCollection->attach(BonusServer\Cards\DTO\Fabric::initCardFromServerResponse($card, $this->getDefaultCurrency(), $this->apiClient->getTimezone()));
         }
 
         $this->log->debug('rarus.bonus.server.cards.transport.list.finish', [

diff --git a/src/Rarus/BonusServer/Transactions/DTO/Points/Fabric.php b/src/Rarus/BonusServer/Transactions/DTO/Points/Fabric.php
@@ -24,13 +24,14 @@
 class Fabric
 {
     /**
-     * @param Currency $currency
-     * @param array    $arPointTransaction
+     * @param Currency      $currency
+     * @param array         $arPointTransaction
+     * @param \DateTimeZone $dateTimeZone
      *
      * @return PointTransaction
      * @throws \Rarus\BonusServer\Exceptions\ApiClientException
      */
-    public static function initPointTransactionFromServerResponse(Currency $currency, array $arPointTransaction): PointTransaction
+    public static function initPointTransactionFromServerResponse(Currency $currency, array $arPointTransaction, \DateTimeZone $dateTimeZone): PointTransaction
     {
         $currencies = new ISOCurrencies();
         $moneyParser = new DecimalMoneyParser($currencies);
@@ -41,7 +42,7 @@ public static function initPointTransactionFromServerResponse(Currency $currency
             ->setPointId(new PointId((string)$arPointTransaction['id']))
             ->setCardId(new CardId((string)$arPointTransaction['card_id']))
             ->setMastercardId(new CardId((string)$arPointTransaction['mastercard_id']))
-            ->setTime(DateTimeParser::parseTimestampFromServerResponse((string)$arPointTransaction['time']))
+            ->setTime(DateTimeParser::parseTimestampFromServerResponse((string)$arPointTransaction['time'], $dateTimeZone))
             ->setSum($moneyParser->parse((string)$arPointTransaction['sum'], $currency->getCode()))
             ->setType($arPointTransaction['type'] === 0 ? Type\Fabric::getRefund() : Type\Fabric::getSale())
             ->setAuthor((string)$arPointTransaction['author'])
@@ -50,34 +51,35 @@ public static function initPointTransactionFromServerResponse(Currency $currency
             ->setCashRegisterId(new CashRegisterId((string)$arPointTransaction['kkm_id']))
             ->setShopId(new ShopId((string)$arPointTransaction['shop_id']))
             ->setDocumentTypeId((string)$arPointTransaction['doc_type'])
-            ->setInvalidatePeriod(DateTimeParser::parseTimestampFromServerResponse((string)$arPointTransaction['invalidate_period']))
-            ->setActivationPeriod(DateTimeParser::parseTimestampFromServerResponse((string)$arPointTransaction['activation_period']))
+            ->setInvalidatePeriod(DateTimeParser::parseTimestampFromServerResponse((string)$arPointTransaction['invalidate_period'], $dateTimeZone))
+            ->setActivationPeriod(DateTimeParser::parseTimestampFromServerResponse((string)$arPointTransaction['activation_period'], $dateTimeZone))
             ->setDiscountId(new DiscountId((string)$arPointTransaction['discount_id']));
 
         return $pointTrx;
     }
 
     /**
-     * @param Currency $currency
-     * @param array    $arPoint
+     * @param Currency      $currency
+     * @param array         $arPoint
+     * @param \DateTimeZone $dateTimeZone
      *
      * @return Point
      * @throws \Rarus\BonusServer\Exceptions\ApiClientException
      */
-    public static function initPointFromServerResponse(Currency $currency, array $arPoint): Point
+    public static function initPointFromServerResponse(Currency $currency, array $arPoint, \DateTimeZone $dateTimeZone): Point
     {
         $moneyParser = new DecimalMoneyParser(new ISOCurrencies());
 
         $point = new Point();
         $point
             ->setSum($moneyParser->parse((string)$arPoint['sum'], $currency->getCode()))
-            ->setDateCreate(DateTimeParser::parseTimestampFromServerResponse((string)$arPoint['date']));
+            ->setDateCreate(DateTimeParser::parseTimestampFromServerResponse((string)$arPoint['date'], $dateTimeZone));
 
         if ($arPoint['active_from'] !== 0) {
-            $point->setActiveFrom(DateTimeParser::parseTimestampFromServerResponse((string)$arPoint['active_from']));
+            $point->setActiveFrom(DateTimeParser::parseTimestampFromServerResponse((string)$arPoint['active_from'], $dateTimeZone));
         }
         if ($arPoint['active_to'] !== 0) {
-            $point->setActiveFrom(DateTimeParser::parseTimestampFromServerResponse((string)$arPoint['active_to']));
+            $point->setActiveFrom(DateTimeParser::parseTimestampFromServerResponse((string)$arPoint['active_to'], $dateTimeZone));
         }
 
         return $point;

diff --git a/src/Rarus/BonusServer/Users/DTO/Fabric.php b/src/Rarus/BonusServer/Users/DTO/Fabric.php
@@ -15,15 +15,17 @@ class Fabric
 {
 
     /**
-     * @param array $arUser
+     * @param array         $arUser
+     * @param \DateTimeZone $dateTimeZone
      *
      * @return User
      * @throws \Rarus\BonusServer\Exceptions\ApiClientException
      */
-    public static function initUserFromServerResponse(array $arUser): User
+    public static function initUserFromServerResponse(array $arUser, \DateTimeZone $dateTimeZone): User
     {
         $user = (new User())
             ->setUserId(new UserId($arUser['id']))
+            ->setLogin($arUser['login'])
             ->setName($arUser['name'])
             ->setPhone($arUser['phone'])
             ->setStatus(Users\DTO\Status\Fabric::initFromServerResponse($arUser))
@@ -33,7 +35,12 @@ public static function initUserFromServerResponse(array $arUser): User
             $user->setGender(Users\DTO\Gender\Fabric::initFromServerResponse($arUser['gender']));
         }
         if ($arUser['birthdate'] !== 0) {
-            $user->setBirthdate(DateTimeParser::parseTimestampFromServerResponse((string)$arUser['birthdate']));
+            $gmtOffsetInSeconds = $dateTimeZone->getOffset(new \DateTime('now', $dateTimeZone));
+            $realTimestamp = (int)$arUser['birthdate'];
+            $birthdateWithGmt = DateTimeParser::parseTimestampFromServerResponse((string)$realTimestamp, $dateTimeZone);
+            $birthday = \DateTime::createFromFormat('U', (string)($birthdateWithGmt->getTimestamp() + $gmtOffsetInSeconds), $dateTimeZone);
+            $birthday->setTimezone($dateTimeZone);
+            $user->setBirthdate($birthday);
         }
 
         return $user;