Add new methods for payments, taxes history (#32)

* add new methods * update tests and codestyle * codestyle * add errorhadler * update codestyle, fix psalm errors * update readme
shoman4eg · Jul 23, 2024 · 7327a77 · 7327a77
1 parent 049c4c7
commit 7327a77
Show file tree

Hide file tree

Showing 22 changed files with 674 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -251,6 +251,27 @@ $apiClient->authenticate($accessToken);
 $userInfo = $apiClient->user()->get();
 ```
 
+### Получить информацию о необходимых платежах
+```php
+$apiClient->authenticate($accessToken);
+
+$userInfo = $apiClient->tax()->get();
+```
+
+### Получить информацию о платежах
+```php
+$apiClient->authenticate($accessToken);
+
+$userInfo = $apiClient->tax()->payments();
+```
+
+### Получить информацию о прошлых платежах
+```php
+$apiClient->authenticate($accessToken);
+
+$userInfo = $apiClient->tax()->history();
+```
+
 ## Использованные ресурсы
 Статья на Habr: [Автоматизация для самозанятых: как интегрировать налог с IT проектом](https://habr.com/ru/post/436656/)
 
@@ -265,4 +286,4 @@ $userInfo = $apiClient->user()->get();
 [Сделать пожертвование автору](https://www.tinkoff.ru/cf/7rZnC7N4bOO)
 
 ## License
-The MIT License (MIT). Please see [License File](LICENSE) for more information.
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
diff --git a/src/Api/Tax.php b/src/Api/Tax.php
@@ -0,0 +1,59 @@
+<?php
+declare(strict_types=1);
+
+namespace Shoman4eg\Nalog\Api;
+
+use Psr\Http\Client\ClientExceptionInterface;
+use Shoman4eg\Nalog\ErrorHandler;
+use Shoman4eg\Nalog\Exception\DomainException;
+use Shoman4eg\Nalog\Model\Tax\HistoryRecords;
+use Shoman4eg\Nalog\Model\Tax\PaymentRecords;
+use Shoman4eg\Nalog\Model\Tax\Tax as TaxModel;
+
+/**
+ * @author Artem Dubinin <artem@dubinin.me>
+ */
+final class Tax extends BaseHttpApi
+{
+    /**
+     * @throws ClientExceptionInterface
+     */
+    public function get(): TaxModel
+    {
+        $response = $this->httpGet('/taxes');
+
+        return $this->hydrator->hydrate($response, TaxModel::class);
+    }
+
+    /**
+     * @throws \JsonException
+     * @throws ClientExceptionInterface
+     */
+    public function history(?string $oktmo = null): HistoryRecords
+    {
+        $response = $this->httpPost('/taxes/history', [
+            'oktmo' => $oktmo,
+        ]);
+
+        return $this->hydrator->hydrate($response, HistoryRecords::class);
+    }
+
+    /**
+     * @throws \JsonException
+     * @throws ClientExceptionInterface
+     * @throws DomainException
+     */
+    public function payments(?string $oktmo = null, bool $onlyPaid = false): PaymentRecords
+    {
+        $response = $this->httpPost('/taxes/payments', [
+            'oktmo' => $oktmo,
+            'onlyPaid' => $onlyPaid,
+        ]);
+
+        if ($response->getStatusCode() >= 400) {
+            (new ErrorHandler())->handleResponse($response);
+        }
+
+        return $this->hydrator->hydrate($response, PaymentRecords::class);
+    }
+}
diff --git a/src/Api/User.php b/src/Api/User.php
@@ -4,6 +4,8 @@
 namespace Shoman4eg\Nalog\Api;
 
 use Psr\Http\Client\ClientExceptionInterface;
+use Shoman4eg\Nalog\ErrorHandler;
+use Shoman4eg\Nalog\Exception\DomainException;
 use Shoman4eg\Nalog\Model\User\UserType;
 
 /**
@@ -13,11 +15,16 @@ final class User extends BaseHttpApi
 {
     /**
      * @throws ClientExceptionInterface
+     * @throws DomainException
      */
     public function get(): UserType
     {
         $response = $this->httpGet('/user');
 
+        if ($response->getStatusCode() >= 400) {
+            (new ErrorHandler())->handleResponse($response);
+        }
+
         return $this->hydrator->hydrate($response, UserType::class);
     }
 }
diff --git a/src/ApiClient.php b/src/ApiClient.php
@@ -15,7 +15,7 @@
 /**
  * @author Artem Dubinin <artem@dubinin.me>
  */
-class ApiClient
+final class ApiClient
 {
     private RequestBuilder $requestBuilder;
     private ClientConfigurator $clientConfigurator;
@@ -120,7 +120,7 @@ public function createNewAccessTokenByPhone(string $phone, string $challengeToke
 
     /**
      * Authenticate the client with an access token. This should be the full access token object with
-     * refresh token and expirery timestamps.
+     * refresh token and expire timestamps.
      *
      * ```php
      *   $accessToken = $client->createNewAccessToken('inn', 'password');
@@ -173,6 +173,11 @@ public function paymentType(): Api\PaymentType
         return new Api\PaymentType($this->getHttpClient(), $this->requestBuilder);
     }
 
+    public function tax(): Api\Tax
+    {
+        return new Api\Tax($this->getHttpClient(), $this->requestBuilder);
+    }
+
     private function getHttpClient(): ClientInterface
     {
         return $this->clientConfigurator->createConfiguredClient();

diff --git a/src/Exception/HydrationException.php b/src/Exception/HydrationException.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace Shoman4eg\Nalog\Exception;
 
@@ -7,4 +8,4 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class HydrationException extends \RuntimeException implements Exception {}
+final class HydrationException extends \RuntimeException implements Exception {}
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -8,4 +8,4 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class InvalidArgumentException extends \InvalidArgumentException implements Exception {}
+final class InvalidArgumentException extends \InvalidArgumentException implements Exception {}
diff --git a/src/Http/AuthenticationPlugin.php b/src/Http/AuthenticationPlugin.php
@@ -5,6 +5,7 @@
 
 use Http\Client\Common\Plugin;
 use Http\Promise\Promise;
+use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Shoman4eg\Nalog\Util\JSON;
@@ -28,6 +29,11 @@ public function __construct(Authenticator $authenticator, string $accessToken)
         $this->accessToken = JSON::decode($accessToken);
     }
 
+    /**
+     * @throws \Exception
+     * @throws \JsonException
+     * @throws ClientExceptionInterface
+     */
     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
     {
         if ($this->accessToken === [] || $request->hasHeader('Authorization')) {

diff --git a/src/Model/PaymentType/PaymentType.php b/src/Model/PaymentType/PaymentType.php
@@ -26,7 +26,6 @@ private function __construct() {}
     public static function createFromArray(array $data): self
     {
         $model = new self();
-
         $model->id = $data['id'];
         $model->type = $data['type'];
         $model->bankName = $data['bankName'];

diff --git a/src/Model/PaymentType/PaymentTypeCollection.php b/src/Model/PaymentType/PaymentTypeCollection.php
@@ -13,9 +13,11 @@
  */
 final class PaymentTypeCollection extends AbstractCollection implements CreatableFromArray
 {
+    private function __construct() {}
+
     public static function createFromArray(array $data): self
     {
-        $items = array_map(fn (array $item) => PaymentType::createFromArray($item), $data['items']);
+        $items = array_map(static fn (array $item) => PaymentType::createFromArray($item), $data['items']);
 
         $model = new self();
         $model->setItems($items);

diff --git a/src/Model/Tax/History.php b/src/Model/Tax/History.php
@@ -0,0 +1,123 @@
+<?php
+declare(strict_types=1);
+
+namespace Shoman4eg\Nalog\Model\Tax;
+
+use Shoman4eg\Nalog\Model\CreatableFromArray;
+
+/**
+ * @author Artem Dubinin <artem@dubinin.me>
+ */
+final class History implements CreatableFromArray
+{
+    private int $taxPeriodId;
+    private float $taxAmount;
+    private float $bonusAmount;
+    private float $paidAmount;
+    private ?float $taxBaseAmount;
+    private ?\DateTimeImmutable $chargeDate;
+    private ?\DateTimeImmutable $dueDate;
+    private string $oktmo;
+    private string $regionName;
+    private string $kbk;
+    private string $taxOrganCode;
+    private string $type;
+    private int $krsbTaxChargeId;
+    private int $receiptCount;
+
+    private function __construct() {}
+
+    /**
+     * @throws \Exception
+     */
+    public static function createFromArray(array $data): self
+    {
+        $model = new self();
+        $model->taxPeriodId = $data['taxPeriodId'];
+        $model->taxAmount = $data['taxAmount'];
+        $model->bonusAmount = $data['bonusAmount'];
+        $model->paidAmount = $data['paidAmount'];
+        $model->taxBaseAmount = $data['taxBaseAmount'];
+        $model->chargeDate = $data['chargeDate'] ? new \DateTimeImmutable($data['chargeDate']) : null;
+        $model->dueDate = $data['dueDate'] ? new \DateTimeImmutable($data['dueDate']) : null;
+        $model->oktmo = $data['oktmo'];
+        $model->regionName = $data['regionName'];
+        $model->kbk = $data['kbk'];
+        $model->taxOrganCode = $data['taxOrganCode'];
+        $model->type = $data['type'];
+        $model->krsbTaxChargeId = $data['krsbTaxChargeId'];
+        $model->receiptCount = $data['receiptCount'];
+
+        return $model;
+    }
+
+    public function getPaidAmount(): float
+    {
+        return $this->paidAmount;
+    }
+
+    public function getBonusAmount(): float
+    {
+        return $this->bonusAmount;
+    }
+
+    public function getTaxAmount(): float
+    {
+        return $this->taxAmount;
+    }
+
+    public function getTaxPeriodId(): int
+    {
+        return $this->taxPeriodId;
+    }
+
+    public function getOktmo(): string
+    {
+        return $this->oktmo;
+    }
+
+    public function getRegionName(): string
+    {
+        return $this->regionName;
+    }
+
+    public function getKbk(): string
+    {
+        return $this->kbk;
+    }
+
+    public function getTaxOrganCode(): string
+    {
+        return $this->taxOrganCode;
+    }
+
+    public function getKrsbTaxChargeId(): int
+    {
+        return $this->krsbTaxChargeId;
+    }
+
+    public function getReceiptCount(): int
+    {
+        return $this->receiptCount;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    public function getChargeDate(): ?\DateTimeImmutable
+    {
+        return $this->chargeDate;
+    }
+
+    public function getDueDate(): ?\DateTimeImmutable
+    {
+        return $this->dueDate;
+    }
+
+    public function getTaxBaseAmount(): ?float
+    {
+        return $this->taxBaseAmount;
+    }
+}
diff --git a/src/Model/Tax/HistoryRecords.php b/src/Model/Tax/HistoryRecords.php
@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace Shoman4eg\Nalog\Model\Tax;
+
+use Shoman4eg\Nalog\Model\AbstractCollection;
+use Shoman4eg\Nalog\Model\CreatableFromArray;
+
+/**
+ * @author Artem Dubinin <artem@dubinin.me>
+ *
+ * @extends AbstractCollection<History>
+ */
+final class HistoryRecords extends AbstractCollection implements CreatableFromArray
+{
+    private function __construct() {}
+
+    /**
+     * @throws \Exception
+     */
+    public static function createFromArray(array $data): self
+    {
+        $items = array_map(static fn (array $record) => History::createFromArray($record), $data['records']);
+
+        $model = new self();
+        $model->setItems($items);
+
+        return $model;
+    }
+}