feat: #13 get import job status

Author: shaunthegeek

app/Coding.php

@@ -3,8 +3,10 @@
 namespace App;
 
 use GuzzleHttp\Client;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Storage;
+use Illuminate\Support\Str;
 
 class Coding
 {
@@ -59,16 +61,14 @@ public function createUploadToken($token, $projectName, $fileName)
         return $uploadToken;
     }
 
-    public function createMarkdownZip($markdown, $path, $filename): bool|string
+    public function createMarkdownZip($markdown, $path, $markdownFilename): bool|string
     {
-        $tmpFile = tempnam(sys_get_temp_dir(), $filename);
-        $zipFileFullPath = $tmpFile . '.zip';
-        rename($tmpFile, $zipFileFullPath);
-        if ($this->zipArchive->open($zipFileFullPath, \ZipArchive::OVERWRITE) !== true) {
+        $zipFileFullPath = sys_get_temp_dir() . '/' . $markdownFilename . '-' . Str::uuid() . '.zip';
+        if ($this->zipArchive->open($zipFileFullPath, \ZipArchive::CREATE) !== true) {
             Log::error("cannot open <$zipFileFullPath>");
             return false;
         }
-        $this->zipArchive->addFromString($filename, $markdown);
+        $this->zipArchive->addFromString($markdownFilename, $markdown);
         preg_match_all('/!\[\]\((.+)\)/', $markdown, $matches);
         if (!empty($matches)) {
             foreach ($matches[1] as $attachment) {
@@ -88,6 +88,38 @@ public function upload(array $uploadToken, string $fileFullPath): bool
         config(['filesystems.disks.cos.region' => $uploadToken['Region']]);
         config(['filesystems.disks.cos.bucket' => $uploadToken['Bucket']]);
 
-        return Storage::disk('cos')->put(basename($fileFullPath), $fileFullPath);
+        return Storage::disk('cos')->put(basename($fileFullPath), File::get($fileFullPath));
+    }
+
+    /**
+     * 获取 Wiki 导入任务的进度（API 文档未展示，其实此接口已上线）
+     *
+     * @param string $token
+     * @param string $projectName
+     * @param string $jobId
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function getImportJobStatus(string $token, string $projectName, string $jobId)
+    {
+        $response = $this->client->request('POST', 'https://e.coding.net/open-api', [
+            'headers' => [
+                'Accept' => 'application/json',
+                'Authorization' => "token ${token}",
+                'Content-Type' => 'application/json'
+            ],
+            'json' => [
+                'Action' => 'DescribeImportJobStatus',
+                'ProjectName' => $projectName,
+                'JobId' => $jobId,
+            ],
+        ]);
+        $result = json_decode($response->getBody(), true);
+        if (isset($result['Response']['Data']['Status'])) {
+            return $result['Response']['Data']['Status'];
+        } else {
+            // TODO exception message
+            return new \Exception('failed');
+        }
     }
 }

tests/Unit/CodingTest.php

@@ -122,4 +122,36 @@ public function testUpload()
 
         Storage::disk('cos')->assertExists(basename($file));
     }
+
+    public function testGetImportJobStatus()
+    {
+        $responseBody = file_get_contents($this->dataDir . 'coding/DescribeImportJobStatusResponse.json');
+        $codingToken = $this->faker->md5;
+        $codingProjectUri = $this->faker->slug;
+        $jobId = '123456ad-f123-4ac2-9586-42ebe5d1234d';
+
+        $clientMock = $this->getMockBuilder(Client::class)->getMock();
+        $clientMock->expects($this->once())
+            ->method('request')
+            ->with(
+                'POST',
+                'https://e.coding.net/open-api',
+                [
+                    'headers' => [
+                        'Accept' => 'application/json',
+                        'Authorization' => "token ${codingToken}",
+                        'Content-Type' => 'application/json'
+                    ],
+                    'json' => [
+                        'Action' => 'DescribeImportJobStatus',
+                        'ProjectName' => $codingProjectUri,
+                        'JobId' => $jobId,
+                    ],
+                ]
+            )
+            ->willReturn(new Response(200, [], $responseBody));
+        $coding = new Coding($clientMock);
+        $result = $coding->getImportJobStatus($codingToken, $codingProjectUri, $jobId);
+        $this->assertEquals('success', $result);
+    }
 }

tests/data/coding/DescribeImportJobStatusResponse.json

@@ -0,0 +1,9 @@
+{
+  "Response" : {
+    "Data": {
+      "JobId": "123456ad-f123-4ac2-9586-42ebe5d1234d",
+      "Status": "success"
+    },
+    "RequestId": "78d6ecf8-9123-574f-8da9-23bb44c467f1"
+  }
+}

tests/data/coding/DescribeImportJobStatusResponseError.json

@@ -0,0 +1,9 @@
+{
+  "Response" : {
+    "Error" : {
+      "Code" : "InvalidParameterValue",
+      "Message" : "资源未找到"
+    },
+    "RequestId" : "cca345b2-762e-c257-da19-b98d27a62ab2"
+  }
+}