Merge pull request #1 from HaiD84/new_methods

New methods

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [7.2, 7.3, 7.4]
+        php: [7.2, 7.3, 7.4, 8.0, 8.1]
         os: [ubuntu-latest]
         env: ['low', 'high']
     name: PHP ${{ matrix.php }} Test ${{ matrix.env }} on ${{ matrix.os }}
@@ -24,7 +24,7 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Install PHP
-      uses: shivammathur/setup-php@1.7.0
+      uses: shivammathur/setup-php@v2
       with:
         php-version: ${{ matrix.php }}
         extensions: json, mbstring
@@ -39,11 +39,11 @@ jobs:
       run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
     - name: Cache dependencies
-      uses: actions/cache@v1.0.3
+      uses: actions/cache@v2
       with:
         path: ${{ steps.composer-cache.outputs.dir }}
-        key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-        restore-keys: ${{ runner.os }}-composer-
+        key: ${{ runner.os }}-composer-${{ matrix.env }}-${{ hashFiles('**/composer.json') }}
+        restore-keys: ${{ runner.os }}-composer-${{ matrix.env }}-
 
     - name: Composer update
       run: |
@@ -52,9 +52,13 @@ jobs:
         fi;
         if [ "$DEPENDENCIES" = 'low' ]; then
             composer update $DEFAULT_COMPOSER_FLAGS --prefer-lowest
+            if [ "$PHP_VERSION" = '8' ] || [ "$PHP_VERSION" = '8.1' ]; then
+                composer update $DEFAULT_COMPOSER_FLAGS --prefer-lowest --with-all-dependencies jms/serializer:^3.14
+            fi;
         fi;
       env:
         DEPENDENCIES: ${{ matrix.env }}
+        PHP_VERSION: ${{ matrix.php }}
 
     - name: Run phpunit
       run: ./vendor/bin/phpunit

composer.json

@@ -25,9 +25,9 @@
     "jms/serializer": "^1.4 || ^2.0 || ^3.0"
   },
   "require-dev": {
-    "phpstan/phpstan": "^0.12.5",
-    "phpstan/phpstan-phpunit": "^0.12.6",
-    "phpunit/phpunit": "^8.5"
+    "phpstan/phpstan": "^1.0",
+    "phpstan/phpstan-phpunit": "^1.0",
+    "phpunit/phpunit": "^8.5.23 || ^9.0"
   },
   "autoload": {
     "psr-4": {

src/Dto/BalanceResponse.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Feech\SmsAero\Dto;
+
+use JMS\Serializer\Annotation as JMS;
+
+class BalanceResponse extends BaseResponse
+{
+    /**
+     * @var BalanceResult
+     * @JMS\Type("Feech\SmsAero\Dto\BalanceResult")
+     */
+    public $data;
+}

src/Dto/BalanceResult.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Feech\SmsAero\Dto;
+
+use JMS\Serializer\Annotation as JMS;
+
+class BalanceResult
+{
+    /**
+     * @var float
+     * @JMS\Type("float")
+     */
+    public $balance;
+}

src/Dto/FlashCallResponse.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Feech\SmsAero\Dto;
+
+use JMS\Serializer\Annotation as JMS;
+
+class FlashCallResponse extends BaseResponse
+{
+    /**
+     * @var FlashCallStatus|null
+     * @JMS\Type("Feech\SmsAero\Dto\FlashCallStatus")
+     */
+    public $data;
+}

src/Dto/FlashCallStatus.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Feech\SmsAero\Dto;
+
+use JMS\Serializer\Annotation as JMS;
+
+class FlashCallStatus
+{
+    /**
+     * @var int
+     * @JMS\Type("int")
+     */
+    public $id;
+
+    /**
+     * @var int
+     * @JMS\Type("int")
+     */
+    public $status;
+
+    /**
+     * @var string
+     * @JMS\Type("string")
+     */
+    public $code;
+
+    /**
+     * @var string
+     * @JMS\Type("string")
+     */
+    public $phone;
+
+    /**
+     * @var float
+     * @JMS\Type("float")
+     */
+    public $cost;
+
+    /**
+     * @var int
+     * @JMS\Type("int")
+     * @JMS\SerializedName("timeCreate")
+     */
+    public $timeCreate;
+
+    /**
+     * @var int
+     * @JMS\Type("int")
+     * @JMS\SerializedName("timeUpdate")
+     */
+    public $timeUpdate;
+}

src/SmsAeroClient.php

@@ -13,6 +13,9 @@
 
 class SmsAeroClient
 {
+    /** @var IClient */
+    private $client;
+
     /** @var SmsAero */
     private $rawJsonClient;
 
@@ -21,6 +24,7 @@ class SmsAeroClient
 
     public function __construct(IClient $client, SerializerInterface $serializer)
     {
+        $this->client = $client;
         $this->rawJsonClient = new SmsAero($client);
         $this->serializer = $serializer;
     }
@@ -210,10 +214,27 @@ public function testSend(
     /**
      * Запрос баланса
      *
-     * @return string
+     * @return Dto\BalanceResponse
      * @throws BaseSmsAeroException
+     * @throws \InvalidArgumentException
      */
-    //public function balance(): string
+    public function balance(): Dto\BalanceResponse
+    {
+        try {
+            $jsonResponse = $this->rawJsonClient->balance();
+
+            $result = $this->serializer->deserialize(
+                $jsonResponse,
+                Dto\BalanceResponse::class,
+                'json'
+            );
+            assert($result instanceof Dto\BalanceResponse);
+        } catch (RuntimeException $e) {
+            throw BadResponseException::becauseOfDeserializationError($e);
+        }
+
+        return $result;
+    }
 
     /**
      * Запрос тарифа
@@ -263,4 +284,33 @@ public function testSend(
      * @throws BaseSmsAeroException
      */
     //public function operatorNumber(string $number): string
+
+    /**
+     * @param string $number
+     * @param string $code
+     *
+     * @return Dto\FlashCallResponse
+     * @throws BaseSmsAeroException
+     * @throws \InvalidArgumentException
+     */
+    public function flashCall(string $number, string $code): Dto\FlashCallResponse
+    {
+        try {
+            $jsonResponse = $this->client->request('/flashcall/send', [
+                'phone' => $number,
+                'code'  => $code,
+            ]);
+
+            $result = $this->serializer->deserialize(
+                $jsonResponse,
+                Dto\FlashCallResponse::class,
+                'json'
+            );
+            assert($result instanceof Dto\FlashCallResponse);
+        } catch (RuntimeException $e) {
+            throw BadResponseException::becauseOfDeserializationError($e);
+        }
+
+        return $result;
+    }
 }

tests/SmsAeroClientTest.php

@@ -245,4 +245,77 @@ public function testBulkSendWhenSendToSingleNumberShouldThrowException(): void
 
         $this->client->bulkSend($sms);
     }
+
+    public function testBalanceWhenSuccess(): void
+    {
+        $this->mockHandler->append(function (Request $request, array $options) {
+            $this->assertStringContainsString(
+                '/v2/balance',
+                (string) $request->getUri()
+            );
+
+            return new Response(200, [], StubData::balanceSuccessResponse());
+        });
+
+        $result = $this->client->balance();
+
+        $this->assertTrue($result->success);
+        $this->assertNull($result->message);
+
+        $this->assertInstanceOf(Dto\BalanceResult::class, $result->data);
+        $this->assertSame(1389.26, $result->data->balance);
+    }
+
+    public function testBalanceWhenUnknownResponseShouldThrowException(): void
+    {
+        $this->mockHandler->append(
+            new Response(200, [], '')
+        );
+
+        $this->expectException(BadResponseException::class);
+
+        $this->client->balance();
+    }
+
+    public function testFlashCallWhenSuccess(): void
+    {
+        $this->mockHandler->append(function (Request $request, array $options) {
+            $this->assertStringContainsString(
+                '/v2/flashcall/send',
+                (string) $request->getUri()
+            );
+
+            return new Response(200, [], StubData::flashCallSendSuccessResponse());
+        });
+
+        $result = $this->client->flashCall('79990000000', '1234');
+
+        $this->assertTrue($result->success);
+        $this->assertNull($result->message);
+
+        $this->assertInstanceOf(Dto\FlashCallStatus::class, $result->data);
+        $this->assertFlashCallStatusToTestData($result->data);
+    }
+
+    private function assertFlashCallStatusToTestData(Dto\FlashCallStatus $result): void
+    {
+        $this->assertSame(1, $result->id);
+        $this->assertSame(0, $result->status);
+        $this->assertSame('1234', $result->code);
+        $this->assertSame('79990000000', $result->phone);
+        $this->assertSame(0.59, $result->cost);
+        $this->assertSame(1646926190, $result->timeCreate);
+        $this->assertSame(1646926190, $result->timeUpdate);
+    }
+
+    public function testFlashCallWhenUnknownResponseShouldThrowException(): void
+    {
+        $this->mockHandler->append(
+            new Response(200, [], '')
+        );
+
+        $this->expectException(BadResponseException::class);
+
+        $this->client->flashCall('79990000000', '1234');
+    }
 }

tests/StubData.php

@@ -84,6 +84,38 @@ public static function sendToMultipleNumbersSuccessResponse(): string
     ],
     "message": null
 }
+JSON;
+    }
+
+    public static function balanceSuccessResponse(): string
+    {
+        return <<<JSON
+{
+    "success": true,
+    "data": {
+        "balance": 1389.26
+    },
+    "message": null
+}
+JSON;
+    }
+
+    public static function flashCallSendSuccessResponse(): string
+    {
+        return <<<JSON
+{
+    "success": true,
+    "data": {
+        "id": 1,
+        "status": 0,
+        "code": "1234",
+        "phone": "79990000000",
+        "cost": "0.59",
+        "timeCreate": 1646926190,
+        "timeUpdate": 1646926190
+    },
+    "message": null
+}
 JSON;
     }
 }