Quality/Use src folder + Bump PHPStan to level 9 + Add support for Symfony 7 (#7)

* Use src folder

* Bump php and symfony versions

* Add phpstan

* Bump phpstan

* Bump phpstan

* Bump phpstan to max level

* Line ending

Author: VincentLanglet

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+charset = utf-8
+
+[*.json]
+indent_size = 2
+
+[composer.json]
+indent_size = 4

.gitattributes

@@ -0,0 +1,4 @@
+.* export-ignore
+*.md export-ignore
+tests export-ignore
+phpstan.dist.neon export-ignore

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 .idea
-/vendor/
+composer.lock
+/vendor/

composer.json

@@ -1,26 +1,30 @@
 {
-  "name": "weglot/text-master-api",
-  "type": "library",
-  "license": "MIT",
-  "authors": [
-    {
-      "name": "Etienne Dhennin",
-      "email": "etienne@weglot.com",
-      "role": "Developer"
+    "name": "weglot/text-master-api",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Etienne Dhennin",
+            "email": "etienne@weglot.com",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=8.0",
+        "ext-json": "*",
+        "guzzlehttp/guzzle": "^7.0",
+        "symfony/config": "^5.4 || ^6.0 || ^7.0",
+        "symfony/dependency-injection": "^5.4 || ^6.0 || ^7.0",
+        "symfony/http-kernel": "^5.4 || ^6.0 || ^7.0"
+    },
+    "require-dev": {
+        "phpstan/phpstan": "1.11.*",
+        "phpstan/phpstan-strict-rules": "1.6.*",
+        "phpstan/phpstan-symfony": "1.4.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "Weglot\\TextMasterBundle\\": "src/"
+        }
     }
-  ],
-  "require": {
-    "php": ">=7.2",
-    "ext-json": "*",
-    "guzzlehttp/guzzle": "^7.0",
-    "symfony/config": "^5.4 || ^6.0",
-    "symfony/dependency-injection": "^5.4 || ^6.0",
-    "symfony/http-kernel": "^5.4 || ^6.0"
-
-  },
-  "autoload": {
-    "psr-4": {
-      "Weglot\\TextMasterBundle\\": ""
-    }
-  }
 }

phpstan.dist.neon

@@ -0,0 +1,18 @@
+includes:
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - vendor/phpstan/phpstan-symfony/rules.neon
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/phpstan/phpstan/conf/bleedingEdge.neon
+
+parameters:
+    level: 9
+    paths:
+        - src/
+    exceptions:
+        check:
+            missingCheckedExceptionInThrows: true
+            tooWideThrowType: true
+        reportUncheckedExceptionDeadCatch: true
+        implicitThrows: false
+        uncheckedExceptionClasses:
+            - LogicException

DependencyInjection/Configuration.php src/DependencyInjection/Configuration.phpDependencyInjection/Configuration.php renamed to src/DependencyInjection/Configuration.php

@@ -9,6 +9,9 @@
 
 class WeglotTextMasterExtension extends Extension
 {
+    /**
+     * @throws \Exception
+     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();

…yInjection/WeglotTextMasterExtension.php …yInjection/WeglotTextMasterExtension.phpDependencyInjection/WeglotTextMasterExtension.php renamed to src/DependencyInjection/WeglotTextMasterExtension.php DependencyInjection/WeglotTextMasterExtension.php renamed to src/DependencyInjection/WeglotTextMasterExtension.php

@@ -13,10 +13,7 @@
 
 class TextMasterApi
 {
-    /** @var Client */
-    private $client;
-    /** @var array */
-    private $basicHeaders = [];
+    private Client $client;
 
     public const BASE_TM_API_URL = 'https://api.';
     public const API_URI = 'textmaster.com/v1/';
@@ -47,13 +44,16 @@ public function __construct(string $apiKey, string $apiSecret, string $textmaste
         $baseUri = self::BASE_TM_API_URL;
         $baseUri .= self::PROD_ENV === $textmasterEnv ? self::API_URI : self::SANDBOX_API_URI;
 
-        $this->basicHeaders['key'] = $apiKey;
-        $this->basicHeaders['secret'] = $apiSecret;
-        $this->basicHeaders['base_uri'] = $baseUri;
-        $this->client = $this->createGuzzleClient($this->basicHeaders);
+        $this->client = $this->createGuzzleClient([
+            'key' => $apiKey,
+            'secret' => $apiSecret,
+            'base_uri' => $baseUri,
+        ]);
     }
 
     /**
+     * @param array<string, mixed> $project
+     *
      * @throws GuzzleException
      */
     public function createProject(array $project): ResponseInterface
@@ -64,14 +64,16 @@ public function createProject(array $project): ResponseInterface
     }
 
     /**
+     * @param array<string, mixed> $project
+     *
      * @throws GuzzleException
      */
-    public function updateProject(string $textMasterProjectId, array $options): ResponseInterface
+    public function updateProject(string $textMasterProjectId, array $project): ResponseInterface
     {
         $routeParams = self::ROUTES['updateProject'];
         $url = $this->formatUrl($routeParams['url'], ['{projectId}' => $textMasterProjectId]);
 
-        return $this->request($url, $routeParams['method'], ['project' => $options]);
+        return $this->request($url, $routeParams['method'], ['project' => $project]);
     }
 
     /**
@@ -86,6 +88,8 @@ public function launchProject(string $textMasterProjectId): ResponseInterface
     }
 
     /**
+     * @param array<string, mixed> $documents
+     *
      * @throws GuzzleException
      */
     public function addDocumentsToProject(string $textMasterProjectId, array $documents): ResponseInterface
@@ -108,14 +112,16 @@ public function completeDocument(string $documentId, string $textMasterProjectId
     }
 
     /**
+     * @param array<string, mixed> $project
+     *
      * @throws GuzzleException
      */
-    public function setProjectOptions(string $textMasterProjectId, array $options): ResponseInterface
+    public function setProjectOptions(string $textMasterProjectId, array $project): ResponseInterface
     {
         $routeParams = self::ROUTES['setOptions'];
         $url = $this->formatUrl($routeParams['url'], ['{projectId}' => $textMasterProjectId]);
 
-        return $this->request($url, $routeParams['method'], ['project' => $options]);
+        return $this->request($url, $routeParams['method'], ['project' => $project]);
     }
 
     /**
@@ -141,6 +147,8 @@ public function getDocument(string $textMasterProjectId, string $textMasterDocum
     }
 
     /**
+     * @param array<string, mixed> $project
+     *
      * @throws GuzzleException
      */
     public function getProjectQuotation(array $project): ResponseInterface
@@ -187,7 +195,20 @@ public function extractErrorFromResponse(ResponseInterface $response, string $fo
         $errorMsg = '';
         $lineBreaker = 'html' === $format ? '</br>' : "\n";
 
-        $decodedResponse = json_decode($response->getBody()->getContents(), true);
+        try {
+            $decodedResponse = json_decode($response->getBody()->getContents(), true, 512, \JSON_THROW_ON_ERROR);
+        } catch (\Exception) {
+            return $errorMsg;
+        }
+
+        if (
+            !\is_array($decodedResponse)
+            || !isset($decodedResponse['errors'])
+            || !\is_iterable($decodedResponse['errors'])
+        ) {
+            return $errorMsg;
+        }
+
         foreach ($decodedResponse['errors'] as $type => $messagesArray) {
             $errorMsg .= "Type of error: $type ".$lineBreaker;
             if (is_array($messagesArray)) {
@@ -201,6 +222,8 @@ public function extractErrorFromResponse(ResponseInterface $response, string $fo
     }
 
     /**
+     * @param array<string, mixed> $payload
+     *
      * @throws GuzzleException
      */
     private function request(string $url, string $method, array $payload = []): ResponseInterface
@@ -210,10 +233,13 @@ private function request(string $url, string $method, array $payload = []): Resp
         return $this->client->send($request, [RequestOptions::JSON => $payload]);
     }
 
+    /**
+     * @param array{key: string, secret: string, base_uri: string} $options
+     */
     private function createGuzzleClient(array $options): Client
     {
         $stack = HandlerStack::create();
-        $stack->push(Middleware::mapRequest(function (RequestInterface $request) use ($options) {
+        $stack->push(Middleware::mapRequest(static function (RequestInterface $request) use ($options) {
             $date = new \DateTime('now', new \DateTimeZone('UTC'));
 
             return $request
@@ -222,13 +248,16 @@ private function createGuzzleClient(array $options): Client
                 ->withHeader('Signature', sha1($options['secret'].$date->format('Y-m-d H:i:s')))
                 ;
         }));
-        unset($options['key']);
-        unset($options['secret']);
+
+        unset($options['key'], $options['secret']);
         $options = array_merge($options, ['handler' => $stack]);
 
         return new Client($options);
     }
 
+    /**
+     * @param array<string, string> $parameters
+     */
     private function formatUrl(string $url, array $parameters): string
     {
         foreach ($parameters as $placeholder => $value) {