Extract method and rename property refactorings (#1)

Also add another exception case for when the token variable is empty.

Author: benr77

src/GitlabApiClient.php

@@ -25,9 +25,9 @@ final class GitlabApiClient
 {
     private const API_URL = 'https://%s/api/v4/ci/lint';
 
-    private string $apiToken;
+    private string $gitlabToken;
 
-    private string $configFile;
+    private string $gitlabFile;
 
     private string $gitlabInstance;
 
@@ -36,8 +36,8 @@ final class GitlabApiClient
      */
     public function __construct(array $config)
     {
-        $this->configFile = $config['gitlab_file'];
-        $this->apiToken = $config['api_token'];
+        $this->gitlabToken = $config['api_token'];
+        $this->gitlabFile = $config['gitlab_file'];
         $this->gitlabInstance = $config['gitlab_url'];
     }
 
@@ -52,28 +52,19 @@ public function __construct(array $config)
      */
     public function lint(): array
     {
-        $httpClient = HttpClient::create();
-
-        $yamlEncoder = new YamlEncoder();
-        $jsonEncoder = new JsonEncoder();
-
-        $fileContents = (string) file_get_contents($this->configFile);
-
-        $jsonData = $jsonEncoder->encode(
-            $yamlEncoder->decode($fileContents, YamlEncoder::FORMAT),
-            JsonEncoder::FORMAT
-        );
+        if (strlen($this->gitlabToken) === 0) {
+            throw GitlabLinterException::missingToken();
+        }
 
-        $jsonData = str_replace('\\', '\\\\', $jsonData);
-        $jsonData = str_replace('"', '\"', $jsonData);
+        $httpClient = HttpClient::create();
 
         $url = sprintf(self::API_URL, $this->gitlabInstance);
         $response = $httpClient->request('POST', $url, [
             'headers' => [
                 'Content-Type' => 'application/json',
-                'PRIVATE-TOKEN' => $this->apiToken,
+                'PRIVATE-TOKEN' => $this->gitlabToken,
             ],
-            'body' => sprintf('{"content": "%s"}', $jsonData),
+            'body' => sprintf('{"content": "%s"}', $this->yamlConfigEncodedAsJson()),
         ]);
 
         if ($response->getStatusCode() === 401) {
@@ -86,4 +77,21 @@ public function lint(): array
 
         return $response->toArray();
     }
+
+    private function yamlConfigEncodedAsJson(): string
+    {
+        $fileContents = (string) file_get_contents($this->gitlabFile);
+
+        $yamlEncoder = new YamlEncoder();
+        $jsonEncoder = new JsonEncoder();
+
+        $jsonData = $jsonEncoder->encode(
+            $yamlEncoder->decode($fileContents, YamlEncoder::FORMAT),
+            JsonEncoder::FORMAT
+        );
+
+        $jsonData = str_replace('\\', '\\\\', $jsonData);
+
+        return str_replace('"', '\"', $jsonData);
+    }
 }

src/GitlabLinterException.php

@@ -19,9 +19,14 @@ private function __construct(string $message)
         parent::__construct($message);
     }
 
+    public static function missingToken(): self
+    {
+        return new self('Your Gitlab API token cannot be read!');
+    }
+
     public static function unauthorized(): self
     {
-        return new self('Your token has not been authorized by Gitlab!');
+        return new self('Your Gitlab API token has not been authorized by Gitlab!');
     }
 
     public static function error500(): self
@@ -31,6 +36,6 @@ public static function error500(): self
 
     public static function fileNotFound(string $file): self
     {
-        return new self(sprintf('Cannot find the Gitlab file "%s"', $file));
+        return new self(sprintf('Cannot find the Gitlab CI file "%s"', $file));
     }
 }

tests/GitlabLintTaskTest.php

@@ -48,13 +48,25 @@ public function test_handles_missing_file(): void
         $sut->run($context);
     }
 
-    public function test_handles_authentication_error(): void
+    public function test_handles_missing_token(): void
     {
         [
             $context,
             $sut
         ] = $this->buildTask(self::VALID_GITLAB_CI_YML, '');
 
+        $this->expectExceptionObject(GitlabLinterException::missingToken());
+
+        $sut->run($context);
+    }
+
+    public function test_handles_authentication_error(): void
+    {
+        [
+            $context,
+            $sut
+        ] = $this->buildTask(self::VALID_GITLAB_CI_YML, 'random-token-string');
+
         $this->expectExceptionObject(GitlabLinterException::unauthorized());
 
         $sut->run($context);