Merge pull request #5 from WeGetFinancing/GET-1975

GET-1975

Author: rdeleo

.env.dist

@@ -1,5 +1,3 @@
 TEST_USERNAME=
 TEST_PASSWORD=
 TEST_MERCHANT_ID=
-TEST_WEGETFINANCING_URL=
-TEST_WEGETFINANCING_URL_V3=

src/Client.php

@@ -14,11 +14,9 @@
 
 class Client
 {
-    protected AuthEntity $authEntity;
-
-    public function __construct(AuthEntity $authEntity)
-    {
-        $this->authEntity = $authEntity;
+    public function __construct(
+        protected AuthEntity $authEntity
+    ) {
     }
 
     /**

src/Command/AbstractCommand.php

@@ -8,10 +8,7 @@
 
 abstract class AbstractCommand implements CommandInterface
 {
-    protected HttpClientInterface $httpClient;
-
-    public function __construct(HttpClientInterface $httpClient)
+    public function __construct(protected HttpClientInterface $httpClient)
     {
-        $this->httpClient = $httpClient;
     }
 }

src/Command/RequestNewLoanCommand.php

@@ -16,7 +16,6 @@
 class RequestNewLoanCommand extends AbstractCommand
 {
     public const LOAN_REQUEST_VERB = 'POST';
-
     public const LOAN_REQUEST_PATH = '/merchant/' . HttpClientInterface::MERCHANT_ID_REPLACE . '/requests';
 
     /**

src/Command/UpdateShippingStatusCommand.php

@@ -8,8 +8,6 @@
 use WeGetFinancing\SDK\Entity\Request\AbstractRequestEntity;
 use WeGetFinancing\SDK\Entity\Request\UpdateShippingStatusRequestEntity;
 use WeGetFinancing\SDK\Entity\Response\ResponseEntity;
-use WeGetFinancing\SDK\Exception\EntityValidationException;
-use WeGetFinancing\SDK\Service\Http\HttpClientInterface;
 use WeGetFinancing\SDK\Service\Http\V3\HttpClientV3;
 
 class UpdateShippingStatusCommand extends AbstractCommand

src/Entity/AbstractEntity.php

@@ -12,28 +12,18 @@
 
 abstract class AbstractEntity implements EntityInterface
 {
-    protected ValidatorInterface $validator;
-
-    protected NameConverterInterface $camelCaseToSnakeCase;
-
     /**
      * @param ValidatorInterface $validator
      * @param NameConverterInterface $camelCaseToSnakeCase
      * @param null|array<string, mixed> $data
      * @throws EntityValidationException
      */
     public function __construct(
-        ValidatorInterface $validator,
-        NameConverterInterface $camelCaseToSnakeCase,
+        protected ValidatorInterface $validator,
+        protected NameConverterInterface $camelCaseToSnakeCase,
         array $data = null
     ) {
-        $this->validator = $validator;
-        $this->camelCaseToSnakeCase = $camelCaseToSnakeCase;
-
-        if (
-            true === is_null($data) ||
-            true === empty($data)
-        ) {
+        if (true === is_null($data) || true === empty($data)) {
             return;
         }
 

src/Entity/AuthEntity.php

@@ -37,14 +37,7 @@ class AuthEntity extends AbstractEntity
      */
     protected string $merchantId;
 
-    /**
-     * @Assert\Url(
-     *     protocols = { "https" },
-     *     message = "The value of url is not a valid URL."
-     * )
-     * @Assert\NotBlank(message = "The value of url should not be blank.")
-     */
-    protected string $url;
+    protected bool $prod = false;
 
     /**
      * @SuppressWarnings(PHPMD.StaticAccess)
@@ -77,8 +70,8 @@ public function getMerchantId(): string
         return $this->merchantId;
     }
 
-    public function getUrl(): string
+    public function isProd(): bool
     {
-        return $this->url;
+        return $this->prod;
     }
 }

src/Service/Http/AbstractHttpClient.php

@@ -9,25 +9,39 @@
 
 abstract class AbstractHttpClient implements HttpClientInterface
 {
-    public AuthEntity $authEntity;
-
-    protected ClientInterface $httpClient;
+    public const URL_API_V1_PROD = 'https://api.wegetfinancing.com';
+    public const URL_API_V1_SANDBOX = 'https://api.sandbox.wegetfinancing.com';
+    public const URL_API_V3_PROD = 'https://apisrv.wegetfinancing.com';
+    public const URL_API_V3_SANDBOX = 'https://apisrv.sandbox.wegetfinancing.com';
 
     /**
      * @param AuthEntity $authEntity
      * @param ClientInterface $httpClient
      */
     public function __construct(
-        AuthEntity $authEntity,
-        ClientInterface $httpClient
+        public AuthEntity $authEntity,
+        protected ClientInterface $httpClient
     ) {
-        $this->authEntity = $authEntity;
-        $this->httpClient = $httpClient;
     }
 
-    protected function getUrlFromPath(string $path): string
+    protected function getBaseUrlApiV1(): string
+    {
+        return (true === $this->authEntity->isProd()) ? self::URL_API_V1_PROD : self::URL_API_V1_SANDBOX;
+    }
+
+    protected function getBaseUrlApiV3(): string
+    {
+        return (true === $this->authEntity->isProd()) ? self::URL_API_V3_PROD : self::URL_API_V3_SANDBOX;
+    }
+
+    protected function getUrlApiV1FromPath(string $path): string
+    {
+        return $this->getBaseUrlApiV1() . $path;
+    }
+
+    protected function getUrlApiV3FromPath(string $path): string
     {
-        return $this->authEntity->getUrl() . $path;
+        return $this->getBaseUrlApiV3() . $path;
     }
 
     protected function getMerchantIdPath(string $path): string
@@ -39,9 +53,9 @@ protected function getMerchantIdPath(string $path): string
         );
     }
 
-    protected function getUrlFromMerchantIdPath(string $path): string
+    protected function getUrlApiV1FromMerchantIdPath(string $path): string
     {
-        return $this->getUrlFromPath(
+        return $this->getUrlApiV1FromPath(
             $this->getMerchantIdPath($path)
         );
     }

src/Service/Http/V1/HttpClientV1.php

@@ -14,13 +14,9 @@
 class HttpClientV1 extends AbstractHttpClient
 {
     public const DEFAULT_ERROR_ERROR = 'unknown-error';
-
     public const DEFAULT_ERROR_MESSAGE = 'Impossible to decode response content.';
-
     public const DEFAULT_ERROR_STAMP = '0x0';
-
     public const DEFAULT_ERROR_TYPE = 'error';
-
     public const HEADERS = [
         'Content-Type' => 'application/json',
         'Accept' =>  'application/json',
@@ -51,7 +47,7 @@ public function request(string $verb, string $path, array $data): ResponseEntity
     {
         $response = $this->httpClient->request(
             $verb,
-            $this->getUrlFromMerchantIdPath($path),
+            $this->getUrlApiV1FromMerchantIdPath($path),
             [
                 'http_errors' => false,
                 'headers' => $this->getHeaders(),

src/Service/Http/V3/HttpClientV3.php

@@ -48,7 +48,7 @@ public function request(string $verb, string $path, array $data): ResponseEntity
 
         $response = $this->httpClient->request(
             $verb,
-            $this->getUrlFromPath($path),
+            $this->getUrlApiV3FromPath($path),
             [
                 'http_errors' => false,
                 'headers' => $this->getAuthenticatedHeaders($token['access_token']),
@@ -97,7 +97,7 @@ public function getToken(): mixed
     {
         $response = $this->httpClient->request(
             'POST',
-            $this->getUrlFromPath('/v3/auth'),
+            $this->getUrlApiV3FromPath('/v3/auth'),
             [
                 'http_errors' => false,
                 'headers' => self::HEADERS,

tests/Functional/Entity/AuthEntityTest.php

@@ -17,13 +17,13 @@ final class AuthEntityTest extends TestCase
             'username' => 'User',
             'password' => 'password',
             'merchantId' => '1234',
-            'url' => 'https://valid.url.com',
+            'prod' => false,
         ],
         'expected' => [
             'username' => 'User',
             'password' => 'password',
             'merchantId' => '1234',
-            'url' => 'https://valid.url.com',
+            'prod' => false,
         ],
     ];
 
@@ -32,13 +32,27 @@ final class AuthEntityTest extends TestCase
             'username' => 'Username1234',
             'password' => 'pass1234',
             'merchant_id' => '5678',
-            'url' => 'https://api.sandbox.wegetfinancing.com',
+            'prod' => true,
         ],
         'expected' => [
             'username' => 'Username1234',
             'password' => 'pass1234',
             'merchantId' => '5678',
-            'url' => 'https://api.sandbox.wegetfinancing.com',
+            'prod' => true,
+        ],
+    ];
+
+    public const VALID_ITEM_3 = [
+        'entity' => [
+            'username' => 'Username1234',
+            'password' => 'pass1234',
+            'merchant_id' => '5678',
+        ],
+        'expected' => [
+            'username' => 'Username1234',
+            'password' => 'pass1234',
+            'merchantId' => '5678',
+            'prod' => false,
         ],
     ];
 
@@ -47,7 +61,6 @@ final class AuthEntityTest extends TestCase
             'username' => '',
             'password' => '',
             'merchantId' => '',
-            'url' => '',
         ],
         'violations' => [
             7 => [
@@ -57,7 +70,6 @@ final class AuthEntityTest extends TestCase
                 'The value of password should not be blank.',
                 'The value of merchant id is too short. It should have 2 characters or more.',
                 'The value of merchant id should not be blank.',
-                'The value of url should not be blank.',
             ],
             8 => [
                 'The value of username is too short. It should have 2 characters or more.',
@@ -66,7 +78,6 @@ final class AuthEntityTest extends TestCase
                 'The value of password should not be blank.',
                 'The value of merchant id is too short. It should have 2 characters or more.',
                 'The value of merchant id should not be blank.',
-                'The value of url should not be blank.',
             ],
         ],
     ];
@@ -88,21 +99,11 @@ final class AuthEntityTest extends TestCase
             'username' => 'u',
             'password' => 'p',
             'merchantId' => '1',
-            'url' => 'http://invalid.protocol.com',
+            'prod' => 'http://invalid.protocol.com',
         ],
         'violations' => [
-            7 => [
-                'The value of username is too short. It should have 2 characters or more.',
-                'The value of password is too short. It should have 2 characters or more.',
-                'The value of merchant id is too short. It should have 2 characters or more.',
-                'The value of url is not a valid URL.',
-            ],
-            8 => [
-                'The value of username is too short. It should have 2 characters or more.',
-                'The value of password is too short. It should have 2 characters or more.',
-                'The value of merchant id is too short. It should have 2 characters or more.',
-                'The value of url is not a valid URL.',
-            ],
+            7 => [ 'Typed property WeGetFinancing\SDK\Entity\AuthEntity::$prod must be bool, string used' ],
+            8 => [ 'Cannot assign string to property WeGetFinancing\SDK\Entity\AuthEntity::$prod of type bool' ],
         ],
     ];
 
@@ -118,12 +119,13 @@ public function testMakeWithoutDataWillWorkAsExpected(): void
     }
 
     /**
-     * @return iterable<array<array<string, array<string, string>>>>
+     * @return iterable<array<array<string, array<string, bool|string>>>>
      */
     public function getValidAuthEntityData(): iterable
     {
         yield [ self::VALID_ITEM_1 ];
         yield [ self::VALID_ITEM_2 ];
+        yield [ self::VALID_ITEM_3 ];
     }
 
     /**
@@ -151,8 +153,8 @@ public function testMakeWithDataWillSucceedAndEntityWillWorkAsExpected(array $da
             $this->sut->getMerchantId()
         );
         $this->assertEquals(
-            $data['expected']['url'],
-            $this->sut->getUrl()
+            $data['expected']['prod'],
+            $this->sut->isProd()
         );
     }
 

tests/Integration/ClientTest.php

@@ -24,18 +24,15 @@ public function setUp(): void
         $username = getenv('TEST_USERNAME');
         $password = getenv('TEST_PASSWORD');
         $merchantId = getenv('TEST_MERCHANT_ID');
-        $url = getenv('TEST_WEGETFINANCING_URL');
 
         $this->assertIsNotBool($username);
         $this->assertIsNotBool($password);
         $this->assertIsNotBool($merchantId);
-        $this->assertIsNotBool($url);
 
         $auth = AuthEntity::make([
             'username' => $username,
             'password' => $password,
             'merchantId' => $merchantId,
-            'url' => $url,
         ]);
 
         $this->sut = new Client($auth);
@@ -61,18 +58,15 @@ public function testUnsuccessfullyV3Auth(): void
         $username = getenv('TEST_USERNAME');
         $password = 'wrong_password';
         $merchantId = getenv('TEST_MERCHANT_ID');
-        $url = getenv('TEST_WEGETFINANCING_URL_V3');
 
         $this->assertIsNotBool($username);
         $this->assertIsNotBool($password);
         $this->assertIsNotBool($merchantId);
-        $this->assertIsNotBool($url);
 
         $auth = AuthEntity::make([
             'username' => $username,
             'password' => $password,
             'merchantId' => $merchantId,
-            'url' => $url,
         ]);
 
         $this->sut = new Client($auth);
@@ -98,25 +92,6 @@ public function testSuccessfullyUpdateShippingStatus(): void
         $loanResponse = $this->sut->requestNewLoan($loanRequest);
         $this->assertTrue($loanResponse->getIsSuccess());
 
-        $username = getenv('TEST_USERNAME');
-        $password = getenv('TEST_PASSWORD');
-        $merchantId = getenv('TEST_MERCHANT_ID');
-        $url = getenv('TEST_WEGETFINANCING_URL_V3');
-
-        $this->assertIsNotBool($username);
-        $this->assertIsNotBool($password);
-        $this->assertIsNotBool($merchantId);
-        $this->assertIsNotBool($url);
-
-        $auth = AuthEntity::make([
-            'username' => $username,
-            'password' => $password,
-            'merchantId' => $merchantId,
-            'url' => $url,
-        ]);
-
-        $this->sut = new Client($auth);
-
         $this->assertArrayHasKey('invId', $loanResponse->getData());
 
         $data = UpdateShippingStatusRequestEntityTest::VALID_ITEM_1['entity'];