Merge pull request #30 from b24io/v4

v4.1.0
b24io · May 22, 2024 · aaaac02 · aaaac02
2 parents 35ecccf + afc779f
commit aaaac02
Show file tree

Hide file tree

Showing 26 changed files with 191 additions and 115 deletions.
diff --git a/.github/workflows/integration-v4.yml b/.github/workflows/integration-v4.yml
@@ -1,6 +1,10 @@
 name: "Integration tests"
 
 on:
+  pull_request:
+    branches:
+      - v4
+      - master
   push:
     branches:
       - v4

diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -14,6 +14,7 @@ jobs:
       matrix:
         php-version:
           - "8.3"
+          - "8.2"
         dependencies: [ highest ]
 
     steps:
@@ -37,7 +38,7 @@ jobs:
         run: "composer update --no-interaction --no-progress --no-suggest"
 
       - name: "PHPStan"
-        run: "make phpstan"
+        run: "make lint-phpstan"
 
       - name: "is PHPStan check succeeded"
         if: ${{ success() }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,27 @@
 # loyalty-php-sdk
 
+## 4.1.0 (2024.05.22)
+* add `TurnoversItemResult` for `CardItemResult`, contains:
+  * total purchases count
+  * total purchases sum
+* add `TurnoversItemResult` for `ContactItemResult`, contains:
+  * total purchases count
+  * total purchases sum
+* add `CardLevelItem` for `ContactItemResult`, contains:
+  * `id` card level id  
+  * `nextLevelId` next level id
+  * `name` level name
+  * `code` level code
+  * `defaultPercentage` card level default percentage
+  * `description` card level description
+  * `externalId` card level external id
+  * `created` date time card level create
+  * `modified` date time card level update
+
+## 4.0.0 (2024.05.11)
+* bump SDK version for PHP `8.2` and `8.3` branch
+
+
 ## 3.1.0 (2024.05.11)
 
 * add requirements:

diff --git a/Makefile b/Makefile
@@ -2,10 +2,14 @@ default:
 	@echo "make needs target:"
 	@egrep -e '^\S+' ./Makefile | grep -v default | sed -r 's/://' | sed -r 's/^/ - /'
 
-phpstan:
+lint-phpstan:
 	vendor/bin/phpstan analyse
-phpinsights:
+lint-phpinsights:
 	vendor/bin/phpinsights analyse ./src
+lint-rector:
+	vendor/bin/rector process --dry-run
+lint-rector-fix:
+	vendor/bin/rector process
 
 test-integration:
 	php vendor/bin/phpunit --colors=always --testsuite integration-tests
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # loyalty-php-sdk
 
-[![License](https://poser.pugx.org/b24io/loyalty-php-sdk/license.svg)](https://packagist.org/packages/b24io/loyalty-php-sdk) [![Total Downloads](https://poser.pugx.org/b24io/loyalty-php-sdk/downloads.svg)](https://packagist.org/packages/b24io/loyalty-php-sdk) [![Build Status](https://travis-ci.org/b24io/loyalty-php-sdk.svg?branch=master)](https://travis-ci.org/b24io/loyalty-php-sdk)
+[![License](https://poser.pugx.org/b24io/loyalty-php-sdk/license.svg)](https://packagist.org/packages/b24io/loyalty-php-sdk) [![Total Downloads](https://poser.pugx.org/b24io/loyalty-php-sdk/downloads.svg)](https://packagist.org/packages/b24io/loyalty-php-sdk)
 
 Loyalty PHP SDK is a tool for work with REST-API Bitrix24
 Application [Loyalty Program and bonus cards for Bitrix24 CRM](https://www.bitrix24.ru/apps/?app=b24io.loyalty)
@@ -24,12 +24,12 @@ $ composer require b24io/loyalty-php-sdk
 
 ### Versions
 
-| loyalty-php-sdk version | support status | REST-API version | PHP versions |
-|-------------------------|----------------|------------------|--------------|
-| **v4**                  | 🟩 **active**  | **2**            | `8.2`,`8.3`  |
-| v3                      | 🟨 bugfix only | 2                | `7.4`        |
-| v2                      | 🟥 end of life | 1                | `7.4`        |
-| v1                      | 🟥 end of life | 1                | `7.4`        |
+| loyalty-php-sdk<br/> version | support status    | build <br/> status                                                                                                                                                                                                                   | REST-API<br/>version | PHP<br/> versions |
+|------------------------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-------------------|
+| **v4.x**                     | 🟩 **active**     | ![integration tests](https://github.com/b24io/loyalty-php-sdk/actions/workflows/integration-v4.yml/badge.svg?branch=v4) <br/> ![phpstan](https://github.com/b24io/loyalty-php-sdk/actions/workflows/phpstan.yml/badge.svg?branch=v4) | **2**                | `8.2`,`8.3`       |
+| v3.x                         | 🟨 bugfix only    | ![integration tests](https://github.com/b24io/loyalty-php-sdk/actions/workflows/integration-v4.yml/badge.svg?branch=v3) <br/> ![phpstan](https://github.com/b24io/loyalty-php-sdk/actions/workflows/phpstan.yml/badge.svg?branch=v3) | 2                    | `7.4`             |
+| v2                           | 🟥 end of life ☠️ |                                                                                                                                                                                                                                      | 1                    | `7.4`             |
+| v1                           | 🟥 end of life ☠️ |                                                                                                                                                                                                                                      | 1                    | `7.4`             |
 
 ### Requirements
 

diff --git a/composer.json b/composer.json
@@ -5,7 +5,6 @@
     "loyalty program",
     "bonus cards",
     "loyalty program SDK",
-    "b24io",
     "REST-API",
     "Bitrix24"
   ],
@@ -47,7 +46,8 @@
     "symfony/stopwatch": "7.*",
     "roave/security-advisories": "dev-master",
     "nunomaduro/phpinsights": "2.*",
-    "fakerphp/faker": "1.23.*"
+    "fakerphp/faker": "1.23.*",
+    "rector/rector": "^1.0"
   },
   "autoload": {
     "psr-4": {

diff --git a/rector.php b/rector.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\DowngradeLevelSetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withSets(
+        [DowngradeLevelSetList::DOWN_TO_PHP_82]
+    )
+     ->withPhpSets(
+         php82: true   // 8.2
+     )
+    ->withRules([
+        AddVoidReturnTypeWhereNoReturnRector::class,
+    ]);
diff --git a/src/Commands/Cards/ExportCards.php b/src/Commands/Cards/ExportCards.php
@@ -77,28 +77,36 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             '============',
             '',
         ]);
-
+        /**
+         * @var ?string $apiEndpointUrl
+         */
         $apiEndpointUrl = $input->getOption('api-endpoint-url');
         if ($apiEndpointUrl === null) {
             $output->writeln('error: you must set api-endpoint-url option');
 
             return Command::INVALID;
         }
-
+        /**
+         * @var ?string $apiClientId
+         */
         $apiClientId = $input->getOption('api-client-id');
         if ($apiClientId === null) {
             $output->writeln('error: you must set api-client-id option');
 
             return Command::INVALID;
         }
-
+        /**
+         * @var ?string $apiAdminKey
+         */
         $apiAdminKey = $input->getOption('api-admin-key');
         if ($apiAdminKey === null) {
             $output->writeln('error: you must set api-admin-key option');
 
             return Command::INVALID;
         }
-
+        /**
+         * @var ?string $filename
+         */
         $filename = $input->getOption('file');
         if ($filename === null) {
             $output->writeln('error: you must set file option');

diff --git a/src/Commands/Transactions/BulkTransactions.php b/src/Commands/Transactions/BulkTransactions.php
@@ -28,7 +28,9 @@
     description: 'Bulk accrual or payment transaction to all active cards')]
 class BulkTransactions extends Command
 {
-    public function __construct(private LoggerInterface $logger)
+    public function __construct(
+        private readonly LoggerInterface $logger
+        )
     {
         parent::__construct();
     }
@@ -186,9 +188,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 }
 
                 $trxHistoryByCard = $admSb->transactionsScope()->transactions()->getByCardNumber($card->number);
-                $reasonCodeHistory = array_map(static function (Reason $reason) {
-                    return $reason->code;
-                }, array_column($trxHistoryByCard->getTransactions(), 'reason'));
+                $reasonCodeHistory = array_map(static fn(Reason $reason) => $reason->code, array_column($trxHistoryByCard->getTransactions(), 'reason'));
                 if (in_array($reasonCode, $reasonCodeHistory, true)) {
                     $this->logger->info(sprintf('transaction already processed for card %s', $card->number));
                     continue;

diff --git a/src/Commands/Transactions/BurnBonuses.php b/src/Commands/Transactions/BurnBonuses.php
@@ -32,9 +32,14 @@
     description: 'Burning of bonuses accrued before the specified date')]
 class BurnBonuses extends Command
 {
-    private const string REASON_ID = 'b24io.loyalty.sdk.cli.util';
-
-    public function __construct(private LoggerInterface $logger)
+    /**
+     * @var string
+     */
+    private const REASON_ID = 'b24io.loyalty.sdk.cli.util';
+
+    public function __construct(
+        private readonly LoggerInterface $logger
+    )
     {
         parent::__construct();
     }
@@ -167,9 +172,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
                 // get last 50 transactions for current card
                 $trxHistoryByCard = $admSb->transactionsScope()->transactions()->getByCardNumber($card->number);
-                $reasonCodeHistory = array_map(static function (Reason $reason) {
-                    return $reason->code;
-                }, array_column($trxHistoryByCard->getTransactions(), 'reason'));
+                $reasonCodeHistory = array_map(static fn(Reason $reason) => $reason->code, array_column($trxHistoryByCard->getTransactions(), 'reason'));
 
                 // if trx with reason-code exists, pass card
                 if (in_array($reasonCode, $reasonCodeHistory, true)) {

diff --git a/src/Commands/Transactions/LoadTransactionsFromFile.php b/src/Commands/Transactions/LoadTransactionsFromFile.php
@@ -44,9 +44,9 @@
 class LoadTransactionsFromFile extends Command
 {
     public function __construct(
-        private TransactionsReader    $transactionsReader,
-        private DecimalMoneyFormatter $decimalMoneyFormatter,
-        private LoggerInterface       $logger
+        private readonly TransactionsReader    $transactionsReader,
+        private readonly DecimalMoneyFormatter $decimalMoneyFormatter,
+        private readonly LoggerInterface       $logger
     )
     {
         parent::__construct();
@@ -166,7 +166,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         /**
          * @var array{'extension':string,'filename':string} $pathInfo
          */
-        $pathInfo = pathinfo($filename);
+        $pathInfo = pathinfo((string) $filename);
 
         $totalTransactionsInFile = $this->transactionsReader->countTransactionsInFile($filename);
         $output->writeln(sprintf('transactions count %s in file %s', $totalTransactionsInFile, $filename));

diff --git a/src/Common/Result/Cards/CardItemResult.php b/src/Common/Result/Cards/CardItemResult.php
@@ -5,6 +5,7 @@
 namespace B24io\Loyalty\SDK\Common\Result\Cards;
 
 use B24io\Loyalty\SDK\Common\Result\Contacts\ContactItemResult;
+use B24io\Loyalty\SDK\Common\Result\Turnovers\TurnoversItemResult;
 use B24io\Loyalty\SDK\Core\Result\AbstractItem;
 use DateTimeImmutable;
 use Money\Currency;
@@ -24,6 +25,7 @@
  * @property-read string $externalId
  * @property-read ?CardLevelItemResult $level
  * @property-read ContactItemResult $contact
+ * @property-read TurnoversItemResult $turnovers
  */
 class CardItemResult extends AbstractItem
 {
@@ -51,6 +53,11 @@ public function __get(int|string $offset)
                     return null;
                 }
                 return new ContactItemResult($this->data[$offset]);
+            case 'turnovers':
+                if ($this->data[$offset] === null) {
+                    return null;
+                }
+                return new TurnoversItemResult($this->data[$offset]);
             default:
                 return parent::__get($offset);
         }

diff --git a/src/Common/Result/Contacts/ContactItemResult.php b/src/Common/Result/Contacts/ContactItemResult.php
@@ -7,6 +7,8 @@
 use B24io\Loyalty\SDK\Common\FullName;
 use B24io\Loyalty\SDK\Common\Gender;
 use B24io\Loyalty\SDK\Common\Result\Cards\CardItemResult;
+use B24io\Loyalty\SDK\Common\Result\Cards\CardLevelItemResult;
+use B24io\Loyalty\SDK\Common\Result\Turnovers\TurnoversItemResult;
 use B24io\Loyalty\SDK\Core\Result\AbstractItem;
 use DateTimeImmutable;
 use DateTimeZone;
@@ -22,6 +24,8 @@
  * @property-read DateTimeImmutable $created
  * @property-read DateTimeImmutable $modified
  * @property-read ?CardItemResult $card
+ * @property-read ?CardLevelItemResult $cardLevel
+ * @property-read ?TurnoversItemResult $turnovers
  */
 class ContactItemResult extends AbstractItem
 {
@@ -51,6 +55,16 @@ public function __get(int|string $offset)
                     return null;
                 }
                 return new CardItemResult($this->data['card']);
+            case 'cardLevel':
+                if ($this->data['card_level'] === null) {
+                    return null;
+                }
+                return new CardLevelItemResult($this->data['card_level']);
+            case 'turnovers':
+                if ($this->data['turnovers'] === null) {
+                    return null;
+                }
+                return new TurnoversItemResult($this->data['turnovers']);
             default:
                 return parent::__get($offset);
         }

diff --git a/src/Common/Result/Transactions/TransactionItemResult.php b/src/Common/Result/Transactions/TransactionItemResult.php
@@ -25,21 +25,16 @@ class TransactionItemResult extends AbstractItem
 {
     public function __get(int|string $offset)
     {
-        switch ($offset) {
-            case 'value':
-                return $this->decimalMoneyParser->parse(
-                    $this->data[$offset]['amount'],
-                    new Currency(($this->data[$offset]['currency']) ?? '')
-                );
-            case 'type':
-                return TransactionType::from(str_replace('_transaction', '', $this->data[$offset]));
-            case 'cardId':
-                return Uuid::fromString($this->data['card']['id']);
-            case 'cardNumber':
-                return $this->data['card']['number'];
-            default:
-                return parent::__get($offset);
-        }
+        return match ($offset) {
+            'value' => $this->decimalMoneyParser->parse(
+                $this->data[$offset]['amount'],
+                new Currency(($this->data[$offset]['currency']) ?? '')
+            ),
+            'type' => TransactionType::from(str_replace('_transaction', '', $this->data[$offset])),
+            'cardId' => Uuid::fromString($this->data['card']['id']),
+            'cardNumber' => $this->data['card']['number'],
+            default => parent::__get($offset),
+        };
 
     }
 }
diff --git a/src/Common/Result/Turnovers/TurnoversItemResult.php b/src/Common/Result/Turnovers/TurnoversItemResult.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace B24io\Loyalty\SDK\Common\Result\Turnovers;
+
+use B24io\Loyalty\SDK\Core\Result\AbstractItem;
+use Money\Currency;
+use Money\Money;
+
+/**
+ * @property-read int $totalPurchasesCount
+ * @property-read Money $totalPurchasesSum
+ */
+class TurnoversItemResult extends AbstractItem
+{
+    public function __get(int|string $offset)
+    {
+        return match ($offset) {
+            'totalPurchasesCount' => (int)$this->data['total_purchases_count'],
+            'totalPurchasesSum' => $this->decimalMoneyParser->parse(
+                $this->data['total_purchases_sum']['amount'],
+                new Currency($this->data['total_purchases_sum']['currency'] ?? '')
+            ),
+            default => parent::__get($offset),
+        };
+    }
+}