5447 merge v2.x to v3.x

.github/ISSUE_TEMPLATE/apiary.yml → .github/ISSUE_TEMPLATE/doc.yml

@@ -1,6 +1,6 @@
-name: Apiary
+name: WS API documentation
 description: Issue about documentation for ThePay.cz WS API
-labels: ["Apiary"]
+labels: ["OpenAPI"]
 body:
   - type: markdown
     attributes:

.github/ISSUE_TEMPLATE/sdk.yml

@@ -20,8 +20,7 @@ body:
       options:
         - Production
         - Demo
-        - Apiary mock
-        - Apiary proxy
+        - OpenAPI mock
     validations:
       required: false
   - type: input

.github/ISSUE_TEMPLATE/ws.yml

@@ -20,8 +20,7 @@ body:
       options:
         - Production
         - Demo
-        - Apiary mock
-        - Apiary proxy
+        - OpenAPI mock
     validations:
       required: true
   - type: input

.github/workflows/ci.yml

@@ -10,6 +10,11 @@ jobs:
         name: "php 8.4"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:8.4"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             -   name: Checkout repository
                 uses: actions/checkout@v4
@@ -20,13 +25,21 @@ jobs:
             -   name: Run static analysis
                 run: composer stan
 
+            -   name: Create mock server from our production OpenAPI
+                run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             -   name: Run tests
                 run: composer test
 
     php83:
         name: "php 8.3"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:8.3"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             -   name: Checkout repository
                 uses: actions/checkout@v4
@@ -37,13 +50,21 @@ jobs:
             -   name: Run static analysis
                 run: composer stan
 
+            -   name: Create mock server from our production OpenAPI
+                run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             -   name: Run tests
                 run: composer test
 
     php82:
         name: "php 8.2 psr/http-message 2.0"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:8.2"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             -   name: Checkout repository
                 uses: actions/checkout@v3
@@ -57,13 +78,21 @@ jobs:
             -   name: Run static analysis
                 run: composer stan
 
+            -   name: Create mock server from our production OpenAPI
+                run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             -   name: Run tests
                 run: composer test
 
     php82psrmessage10:
         name: "php 8.2 psr/http-message 1.0"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:8.2"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             -   name: Checkout repository
                 uses: actions/checkout@v3
@@ -74,13 +103,21 @@ jobs:
             -   name: Run static analysis
                 run: composer stan
 
+            -   name: Create mock server from our production OpenAPI
+                run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             -   name: Run tests
                 run: composer test
 
     php81:
         name: "php 8.1"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:8.1"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             - name: Checkout repository
               uses: actions/checkout@v3
@@ -91,13 +128,21 @@ jobs:
             - name: Run static analysis
               run: composer stan
 
+            - name: Create mock server from our production OpenAPI
+              run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             - name: Run tests
               run: composer test
 
     php80:
         name: "php 8.0"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:8.0"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             - name: Checkout repository
               uses: actions/checkout@v3
@@ -108,13 +153,21 @@ jobs:
             - name: Run static analysis
               run: composer stan
 
+            - name: Create mock server from our production OpenAPI
+              run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             - name: Run tests
               run: composer test
 
     php74:
         name: "php 7.4"
         runs-on: ubuntu-latest
         container: "nofutur3/php-tests:7.4"
+        services:
+            openAPImock:
+                image: mockserver/mockserver
+                ports:
+                    - 1080:1080
         steps:
             # Deprecation example for future support removal.
             #
@@ -130,6 +183,9 @@ jobs:
             -   name: Run static analysis
                 run: composer stan
 
+            -   name: Create mock server from our production OpenAPI
+                run: curl -X PUT -d "{\"specUrlOrPayload\":\"https://gate.thepay.cz/openapi.yaml\"}" http://openAPImock:1080/mockserver/openapi
+
             -   name: Run tests
                 run: composer test
 

tests/BaseTestCase.php

@@ -9,8 +9,8 @@
 use PHPUnit\Framework\TestCase;
 use ThePay\ApiClient\Service\ApiService;
 use ThePay\ApiClient\Service\SignatureService;
+use ThePay\ApiClient\Tests\Mocks\TheConfig;
 use ThePay\ApiClient\TheClient;
-use ThePay\ApiClient\TheConfig;
 
 abstract class BaseTestCase extends TestCase
 {
@@ -22,21 +22,15 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->config = new TheConfig(self::MERCHANT_ID, 1, 'password', 'https://test.api.cz/', 'https://test.gate.cz/');
+        $this->config = new TheConfig();
     }
 
     /**
-     * method return TheClient witch use apiary mock server
+     * method return TheClient witch use mock server
      */
-    protected function getApiaryClient(): TheClient
+    protected function getMockClient(): TheClient
     {
-        $config = new TheConfig(
-            '6cdf1b24',
-            1212,
-            'password',
-            'https://private-aa6aa3-thepay.apiary-mock.com/',
-            'https://private-ddc40-gatezalozeniplatby.apiary-mock.com/'
-        );
+        $config = new TheConfig();
 
         $httpFactory = new HttpFactory();
 

tests/CancelPreauthorizationPaymentTest.php

@@ -4,71 +4,29 @@
 
 namespace ThePay\ApiClient\Tests;
 
-use GuzzleHttp\Psr7\HttpFactory;
-use GuzzleHttp\Psr7\Response;
-use PHPUnit\Framework\MockObject\MockObject;
-use Psr\Http\Client\ClientInterface;
-use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use ThePay\ApiClient\Service\ApiService;
-use ThePay\ApiClient\Service\SignatureService;
 use ThePay\ApiClient\TheClient;
 
 final class CancelPreauthorizationPaymentTest extends BaseTestCase
 {
-    /** @var MockObject&ClientInterface */
-    private MockObject $httpClient;
     private TheClient $client;
 
     protected function setUp(): void
     {
         parent::setUp();
-        $this->httpClient = $this->createMock(ClientInterface::class);
-        $httpFactory = new HttpFactory();
-        $apiService = new ApiService(
-            $this->config,
-            $this->createMock(SignatureService::class),
-            $this->httpClient,
-            $httpFactory,
-            $httpFactory
-        );
-        $this->client = new TheClient($this->config, $apiService);
+        $this->client = $this->getMockClient();
     }
 
     public function testRequest(): void
     {
-        $this->httpClient
-            ->expects(self::once())
-            ->method('sendRequest')
-            ->willReturnCallback(function (RequestInterface $request): ResponseInterface {
-                $expectedUrl = $this->config->getApiUrl() . 'projects/1/payments/abc/preauthorized?merchant_id=' . self::MERCHANT_ID;
-
-                self::assertSame('DELETE', $request->getMethod());
-                self::assertSame($expectedUrl, $request->getUri()->__toString());
-
-                return $this->getOkResponse();
-            })
-        ;
-
         $this->client->cancelPreauthorizedPayment('abc');
+        self::assertTrue(true);
     }
 
     public function testNotOkResponse(): void
     {
         $this->expectException(\Exception::class);
 
-        $this->httpClient->method('sendRequest')->willReturn($this->getNotOkResponse());
-
-        $this->client->cancelPreauthorizedPayment('abc');
-    }
-
-    private function getOkResponse(): ResponseInterface
-    {
-        return new Response(204);
-    }
-
-    private function getNotOkResponse(): ResponseInterface
-    {
-        return new Response(401);
+        /** @phpstan-ignore-next-line */
+        $this->client->cancelPreauthorizedPayment('');
     }
 }

tests/GeneratePaymentConfirmationTest.php

@@ -4,70 +4,24 @@
 
 namespace ThePay\ApiClient\Tests;
 
-use GuzzleHttp\Psr7\HttpFactory;
-use GuzzleHttp\Psr7\Response;
-use Psr\Http\Client\ClientInterface;
-use Psr\Http\Message\RequestInterface;
-use ThePay\ApiClient\Service\ApiService;
-use ThePay\ApiClient\Service\SignatureService;
-use ThePay\ApiClient\TheClient;
-
 final class GeneratePaymentConfirmationTest extends BaseTestCase
 {
     public function testSuccess(): void
     {
-        $httpFactory = new HttpFactory();
-
-        $httpClient = $this->createMock(ClientInterface::class);
-        $httpClient->expects(self::once())->method('sendRequest')
-            ->willReturnCallback(function (RequestInterface $request): Response {
-                self::assertSame('GET', $request->getMethod());
-                self::assertSame(
-                    $this->config->getApiUrl() . 'projects/1/payments/testUID/generate_confirmation?language=cs&merchant_id=' . self::MERCHANT_ID,
-                    $request->getUri()->__toString()
-                );
-
-                return new Response(200, [], 'test pdf content');
-            })
-        ;
-
-        $theClient = new TheClient(
-            $this->config,
-            new ApiService(
-                $this->config,
-                $this->createMock(SignatureService::class),
-                $httpClient,
-                $httpFactory,
-                $httpFactory
-            )
-        );
+        $theClient = $this->getMockClient();
 
         $pdfContent = $theClient->generatePaymentConfirmationPdf('testUID', 'cs');
 
-        self::assertSame('test pdf content', $pdfContent);
+        self::assertTrue(is_string($pdfContent));
     }
 
     public function testFailed(): void
     {
-        $httpFactory = new HttpFactory();
-
-        $httpClient = $this->createMock(ClientInterface::class);
-        $httpClient->expects(self::once())->method('sendRequest')
-            ->willReturn(new Response(400));
-
-        $theClient = new TheClient(
-            $this->config,
-            new ApiService(
-                $this->config,
-                $this->createMock(SignatureService::class),
-                $httpClient,
-                $httpFactory,
-                $httpFactory
-            )
-        );
+        $theClient = $this->getMockClient();
 
-        $this->expectException(\RuntimeException::class);
+        $this->expectException(\InvalidArgumentException::class);
 
-        $theClient->generatePaymentConfirmationPdf('testUID', 'cs');
+        /** @phpstan-ignore-next-line */
+        $theClient->generatePaymentConfirmationPdf('');
     }
 }