Merge pull request #7 from WeGetFinancing/GET-2124

GET-2124 | feat(ppe): Implemented test call

Author: rdeleo

.env.dist

@@ -1,3 +1,6 @@
 TEST_USERNAME=
 TEST_PASSWORD=
 TEST_MERCHANT_ID=
+MERCHANT_TOKEN_EMPTY=use demo default a token
+MERCHANT_TOKEN_SUCCESS=use demo master token
+MERCHANT_TOKEN_ERROR=fakeToken

.github/workflows/test.yml

@@ -15,6 +15,9 @@ env:
   TEST_WEGETFINANCING_URL: ${{ secrets.TEST_WEGETFINANCING_URL }}
   TEST_WEGETFINANCING_URL_V3: ${{ secrets.TEST_WEGETFINANCING_URL_V3 }}
   CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+  MERCHANT_TOKEN_EMPTY: ${{ secrets.MERCHANT_TOKEN_EMPTY }}
+  MERCHANT_TOKEN_SUCCESS: ${{ secrets.MERCHANT_TOKEN_SUCCESS }}
+  MERCHANT_TOKEN_ERROR: ${{ secrets.MERCHANT_TOKEN_ERROR }}
 
 jobs:
 

composer.json

@@ -4,7 +4,7 @@
   "minimum-stability": "stable",
   "prefer-stable": true,
   "license": "LGPL-3.0-only",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "authors": [
     {
       "name": "Riccardo De Leo",

src/Client.php

@@ -4,13 +4,15 @@
 
 namespace WeGetFinancing\SDK;
 
+use GuzzleHttp\Exception\GuzzleException;
 use WeGetFinancing\SDK\Command\RequestNewLoanCommand;
 use WeGetFinancing\SDK\Command\UpdateShippingStatusCommand;
 use WeGetFinancing\SDK\Entity\AuthEntity;
 use WeGetFinancing\SDK\Entity\Request\LoanRequestEntity;
 use WeGetFinancing\SDK\Entity\Request\UpdateShippingStatusRequestEntity;
 use WeGetFinancing\SDK\Entity\Response\ResponseEntity;
 use WeGetFinancing\SDK\Exception\EntityValidationException;
+use WeGetFinancing\SDK\Service\PpeClient;
 
 class Client
 {
@@ -54,4 +56,17 @@ public function updateStatus(UpdateShippingStatusRequestEntity $requestEntity):
         $command = UpdateShippingStatusCommand::make($this->authEntity);
         return $command->execute($requestEntity);
     }
+
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     *
+     * @param string $merchantToken
+     * @throws GuzzleException
+     * @return array<string, string>
+     */
+    public function testPpe(string $merchantToken): array
+    {
+        $command = PpeClient::make($merchantToken, $this->authEntity->isProd());
+        return $command->testPpe();
+    }
 }

src/Service/PpeClient.php

@@ -0,0 +1,92 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WeGetFinancing\SDK\Service;
+
+use Exception;
+use GuzzleHttp\Client;
+use GuzzleHttp\ClientInterface;
+use GuzzleHttp\Exception\GuzzleException;
+
+class PpeClient
+{
+    public const MERCHANT_TOKEN_REPLACE = '%MERCHANT_TOKEN%';
+    public const URL_TEST_PPE_PROD = 'https://partner.wegetfinancing.com/integration/%MERCHANT_TOKEN%/ppe';
+    public const URL_TEST_PPE_SANDBOX = 'https://partner.sandbox.wegetfinancing.com/integration/%MERCHANT_TOKEN%/ppe';
+    public const TEST_ERROR_RESPONSE = 'error';
+    public const TEST_EMPTY_RESPONSE = 'empty';
+    public const TEST_SUCCESS_RESPONSE = 'success';
+    public const EMPTY_LENDERS_MESSAGE =
+        "The merchant account you've selected isn't properly configured for PPE use yet. " .
+        "Please reach out to our support team to get your account set up correctly.";
+
+    public function __construct(
+        protected string $merchantToken,
+        protected bool $isProd,
+        protected ClientInterface $client
+    ) {
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     *
+     * @param  string $merchantToken
+     * @param  bool $isProd
+     * @return PpeClient
+     */
+    public static function make(string $merchantToken, bool $isProd): PpeClient
+    {
+        return new PpeClient(
+            $merchantToken,
+            $isProd,
+            new Client()
+        );
+    }
+
+    /**
+     * @throws GuzzleException
+     * @throws Exception
+     * @return array<string, string>
+     */
+    public function testPpe(): array
+    {
+        $response = $this->client->request('GET', $this->getTestPpePath());
+        $content = $response->getBody()->getContents();
+        $data = json_decode($content, true);
+        $error = json_last_error();
+        if (JSON_ERROR_NONE !== $error) {
+            throw new Exception(
+                self::class . "::testPpe() json error: " . json_last_error_msg(),
+                $error
+            );
+        }
+
+        if (true === array_key_exists(self::TEST_ERROR_RESPONSE, $data)) {
+            return [
+                'status' => self::TEST_ERROR_RESPONSE,
+                'message' => $data[self::TEST_ERROR_RESPONSE],
+            ];
+        }
+
+        if (true === array_key_exists(0, $data) && true === array_key_exists('max_amount', $data[0])) {
+            return [
+                'status' => self::TEST_SUCCESS_RESPONSE,
+            ];
+        }
+
+        return [
+            'status' => self::TEST_EMPTY_RESPONSE,
+            'message' => self::EMPTY_LENDERS_MESSAGE,
+        ];
+    }
+
+    protected function getTestPpePath(): string
+    {
+        return str_replace(
+            self::MERCHANT_TOKEN_REPLACE,
+            $this->merchantToken,
+            (true === $this->isProd) ? self::URL_TEST_PPE_PROD : self::URL_TEST_PPE_SANDBOX
+        );
+    }
+}

tests/Integration/ClientTest.php

@@ -11,6 +11,7 @@
 use WeGetFinancing\SDK\Entity\Request\UpdateShippingStatusRequestEntity;
 use Functional\Entity\Request\LoanRequestEntityTest;
 use PHPUnit\Framework\TestCase;
+use WeGetFinancing\SDK\Service\PpeClient;
 
 /**
  * @SuppressWarnings(PHPMD.StaticAccess)
@@ -105,4 +106,23 @@ public function testSuccessfullyUpdateShippingStatus(): void
 
         $this->assertEquals(204, $response->getCode());
     }
+
+    public function testEmptyPpe(): void
+    {
+        $response = $this->sut->testPpe((string)getenv('MERCHANT_TOKEN_EMPTY'));
+        $this->assertEquals(PpeClient::TEST_EMPTY_RESPONSE, $response['status']);
+        $this->assertEquals(PpeClient::EMPTY_LENDERS_MESSAGE, $response['message']);
+    }
+
+    public function testErrorPpe(): void
+    {
+        $response = $this->sut->testPpe((string)getenv('MERCHANT_TOKEN_ERROR'));
+        $this->assertEquals(PpeClient::TEST_ERROR_RESPONSE, $response['status']);
+    }
+
+    public function testSuccessPpe(): void
+    {
+        $response = $this->sut->testPpe((string)getenv('MERCHANT_TOKEN_SUCCESS'));
+        $this->assertEquals(PpeClient::TEST_SUCCESS_RESPONSE, $response['status']);
+    }
 }