Code review fixes part 81

Signed-off-by: Konstantin Myakshin <[email protected]>

Author: Koc

appinfo/routes.php

@@ -99,7 +99,7 @@
 			'url' => '/api/{apiVersion}/form/{id}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-3])?'
+				'apiVersion' => 'v2(\.[1-4])?'
 			]
 		],
 		[
@@ -304,15 +304,15 @@
 			'url' => '/api/{apiVersion}/submissions/export/{hash}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-3])?'
+				'apiVersion' => 'v2(\.[1-4])?'
 			]
 		],
 		[
 			'name' => 'api#exportSubmissionsToCloud',
 			'url' => '/api/{apiVersion}/submissions/export',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2(\.[1-3])?'
+				'apiVersion' => 'v2(\.[1-4])?'
 			]
 		],
 		[
@@ -345,7 +345,7 @@
 			'url' => '/api/{apiVersion}/form/link/{fileFormat}',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2.3',
+				'apiVersion' => 'v2.4',
 				'fileFormat' => 'csv|ods|xlsx'
 			]
 		],
@@ -354,7 +354,7 @@
 			'url' => '/api/{apiVersion}/form/unlink',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v2.3',
+				'apiVersion' => 'v2.4',
 			]
 		]
 	]

docs/API.md

@@ -28,16 +28,16 @@ This file contains the API-Documentation. For more information on the returned D
 - Completely new way of handling access & shares.
 
 ### Other API changes
-- In API version 2.3 the following endpoints were introduced:
-  - `POST /api/2.3/form/link/{fileFormat}` to link form to a file
-  - `POST /api/2.3/form/unlink` to unlink form from a file
-- In API version 2.3 the following endpoints were changed:
-  - `GET /api/v2.3/submissions/export/{hash}` was extended with optional parameter `fileFormat` to export submissions in different formats
-  - `GET /api/v2.3/submissions/export` was extended with optional parameter `fileFormat` to export submissions to cloud in different formats
-  - `GET /api/v2.3/form/{id}` was extended with optional parameters `fileFormat`, `fileId`, `filePath` to link form to a file
-- In API version 2.1 the endpoint `/api/v2.1/share/update` was added to update a Share
-- In API version 2.2 the endpoint `/api/v2.2/form/transfer` was added to transfer ownership of a form
+- In API version 2.4 the following endpoints were introduced:
+  - `POST /api/2.4/form/link/{fileFormat}` to link form to a file
+  - `POST /api/2.4/form/unlink` to unlink form from a file
+- In API version 2.4 the following endpoints were changed:
+  - `GET /api/v2.4/submissions/export/{hash}` was extended with optional parameter `fileFormat` to export submissions in different formats
+  - `GET /api/v2.4/submissions/export` was extended with optional parameter `fileFormat` to export submissions to cloud in different formats
+  - `GET /api/v2.4/form/{id}` was extended with optional parameters `fileFormat`, `fileId`, `filePath` to link form to a file
 - In API version 2.3 the endpoint `/api/v2.3/question/clone` was added to clone a question
+- In API version 2.2 the endpoint `/api/v2.2/form/transfer` was added to transfer ownership of a form
+- In API version 2.1 the endpoint `/api/v2.1/share/update` was added to update a Share
 
 ## Form Endpoints
 ### List owned Forms
@@ -118,7 +118,7 @@ See next section, 'Request full data of a form'
 
 ### Request full data of a form
 Returns the full-depth object of the requested form (without submissions).
-- Endpoint: `/api/v2.2/form/{id}`
+- Endpoint: `/api/v2.4/form/{id}`
 - Url-Parameter:
   | Parameter | Type    | Description |
   |-----------|---------|-------------|
@@ -261,7 +261,7 @@ Transfer the ownership of a form to another user
 ```
 
 ### Link a form to a file
-- Endpoint: `/api/v2.3/form/link/{fileFormat}`
+- Endpoint: `/api/v2.4/form/link/{fileFormat}`
 - Url-Parameter:
   | Parameter    | Type    | Description  |
   |--------------|---------|--------------|
@@ -283,7 +283,7 @@ Transfer the ownership of a form to another user
 ```
 
 ### Unlink file from form
-- Endpoint: `/api/v2.3/form/unlink`
+- Endpoint: `/api/v2.4/form/unlink`
 - Method: `POST`
 - Parameters:
   | Parameter | Type    | Description                |
@@ -583,7 +583,7 @@ Get all Submissions to a Form
 
 ### Get Submissions as csv (Download)
 Returns all submissions to the form in form of a csv-file.
-- Endpoint: `/api/v2.2/submissions/export/{hash}`
+- Endpoint: `/api/v2.4/submissions/export/{hash}`
 - Url-Parameter:
   | Parameter    | Type    | Description |
   |--------------|---------|-------------|
@@ -599,7 +599,7 @@ Returns all submissions to the form in form of a csv-file.
 
 ### Export Submissions to Cloud (Files-App)
 Creates a csv file and stores it to the cloud, resp. Files-App.
-- Endpoint: `/api/v2.2/submissions/export`
+- Endpoint: `/api/v2.4/submissions/export`
 - Method: `POST`
 - Parameters:
   | Parameter    | Type    | Description |

…tion/Version030200Date20231001200100.php …tion/Version040010Date20240122133700.phplib/Migration/Version030200Date20231001200100.php renamed to lib/Migration/Version040010Date20240122133700.php lib/Migration/Version030200Date20231001200100.php renamed to lib/Migration/Version040010Date20240122133700.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 /**
- * @copyright Copyright (c) 2023 Ferdinand Thiessen <[email protected]>
+ * @copyright Copyright (c) 2024 Kostiantyn Miakshyn <[email protected]>
  *
  * @author Kostiantyn Miakshyn <[email protected]>
  *
@@ -32,7 +32,7 @@
 use OCP\Migration\IOutput;
 use OCP\Migration\SimpleMigrationStep;
 
-class Version030200Date20231001200100 extends SimpleMigrationStep {
+class Version040010Date20240122133700 extends SimpleMigrationStep {
 	/**
 	 * @param IOutput $output
 	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`

lib/Service/SubmissionService.php

@@ -90,9 +90,6 @@ class SubmissionService {
 	/** @var IMailer */
 	private $mailer;
 
-	/** @var ITempManager */
-	private $tempManager;
-
 	public function __construct(FormMapper $formMapper,
 		QuestionMapper $questionMapper,
 		SubmissionMapper $submissionMapper,
@@ -104,8 +101,9 @@ public function __construct(FormMapper $formMapper,
 		IUserManager $userManager,
 		IUserSession $userSession,
 		IMailer $mailer,
-		ITempManager $tempManager,
-		private FormsService $formsService) {
+		private ITempManager $tempManager,
+		private FormsService $formsService,
+	) {
 		$this->formMapper = $formMapper;
 		$this->questionMapper = $questionMapper;
 		$this->submissionMapper = $submissionMapper;
@@ -116,7 +114,6 @@ public function __construct(FormMapper $formMapper,
 		$this->logger = $logger;
 		$this->userManager = $userManager;
 		$this->mailer = $mailer;
-		$this->tempManager = $tempManager;
 
 		$this->currentUser = $userSession->getUser();
 	}
@@ -332,7 +329,7 @@ private function exportData(array $header, array $data, string $fileFormat, ?Fil
 			$spreadsheet = new Spreadsheet();
 		}
 
-		$activeWorksheet = $spreadsheet->getActiveSheet();
+		$activeWorksheet = $spreadsheet->getSheet(0);
 		foreach ($header as $columnIndex => $value) {
 			$activeWorksheet->setCellValue([$columnIndex + 1, 1], $value);
 		}

src/views/Results.vue

@@ -369,7 +369,7 @@ export default {
 
 	methods: {
 		async onUnlinkFile() {
-			await axios.post(generateOcsUrl('apps/forms/api/v2.3/form/unlink'), {
+			await axios.post(generateOcsUrl('apps/forms/api/v2.4/form/unlink'), {
 				hash: this.form.hash,
 			})
 
@@ -401,7 +401,7 @@ export default {
 		},
 
 		async onDownloadFile(fileFormat) {
-			const exportUrl = generateOcsUrl('apps/forms/api/v2.1/submissions/export/{hash}', { hash: this.form.hash })
+			const exportUrl = generateOcsUrl('apps/forms/api/v2.4/submissions/export/{hash}', { hash: this.form.hash })
 				+ '?requesttoken=' + encodeURIComponent(getRequestToken())
 				+ '&fileFormat=' + fileFormat
 			window.open(exportUrl, '_self')
@@ -412,7 +412,7 @@ export default {
 				await this.getPicker().pick()
 					.then(async (path) => {
 						try {
-							const response = await axios.post(generateOcsUrl('apps/forms/api/v2.3/form/link/{fileFormat}', { fileFormat }), {
+							const response = await axios.post(generateOcsUrl('apps/forms/api/v2.4/form/link/{fileFormat}', { fileFormat }), {
 								hash: this.form.hash,
 								path,
 							})
@@ -440,7 +440,7 @@ export default {
 				await this.getPicker().pick()
 					.then(async (path) => {
 						try {
-							const response = await axios.post(generateOcsUrl('apps/forms/api/v2.2/submissions/export'), { hash: this.form.hash, path, fileFormat })
+							const response = await axios.post(generateOcsUrl('apps/forms/api/v2.4/submissions/export'), { hash: this.form.hash, path, fileFormat })
 							showSuccess(t('forms', 'Export successful to {file}', { file: OcsResponse2Data(response) }))
 						} catch (error) {
 							logger.error('Error while exporting to Files', { error })
@@ -454,7 +454,7 @@ export default {
 		},
 
 		async fetchLinkedFileInfo() {
-			const response = await axios.get(generateOcsUrl('apps/forms/api/v2.2/form/{id}', { id: this.form.id }))
+			const response = await axios.get(generateOcsUrl('apps/forms/api/v2.4/form/{id}', { id: this.form.id }))
 			const form = OcsResponse2Data(response)
 			this.$set(this.form, 'fileFormat', form.fileFormat)
 			this.$set(this.form, 'fileId', form.fileId)

tests/Integration/Api/ApiV2Test.php

@@ -1323,7 +1323,7 @@ public function dataExportSubmissions() {
 	 * @param array $expected
 	 */
 	public function testExportSubmissions(string $expected) {
-		$resp = $this->http->request('GET', "api/v2.1/submissions/export/{$this->testForms[0]['hash']}");
+		$resp = $this->http->request('GET', "api/v2.4/submissions/export/{$this->testForms[0]['hash']}");
 		$data = substr($resp->getBody()->getContents(), 3); // Some strange Character removed at the beginning
 
 		$this->assertEquals(200, $resp->getStatusCode());
@@ -1335,7 +1335,7 @@ public function testExportSubmissions(string $expected) {
 	}
 
 	public function testLinkFile() {
-		$resp = $this->http->request('POST', 'api/v2.3/form/link/csv', [
+		$resp = $this->http->request('POST', 'api/v2.4/form/link/csv', [
 			'json' => [
 				'hash' => $this->testForms[0]['hash'],
 				'path' => ''
@@ -1348,7 +1348,7 @@ public function testLinkFile() {
 	}
 
 	public function testUnlinkFile() {
-		$resp = $this->http->request('POST', 'api/v2.3/form/unlink', [
+		$resp = $this->http->request('POST', 'api/v2.4/form/unlink', [
 			'json' => [
 				'hash' => $this->testForms[2]['hash'],
 				'path' => ''
@@ -1361,7 +1361,7 @@ public function testUnlinkFile() {
 	}
 
 	public function testExportToCloud() {
-		$resp = $this->http->request('POST', 'api/v2.2/submissions/export', [
+		$resp = $this->http->request('POST', 'api/v2.4/submissions/export', [
 			'json' => [
 				'hash' => $this->testForms[0]['hash'],
 				'path' => ''