Merge pull request #478 from nextcloud/backport/472

[Backport/472] Add capabilities
nextcloud · Aug 31, 2023 · f456f12 · f456f12
2 parents 4d27c18 + 87ac06e
commit f456f12
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 0 deletions.
diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php
@@ -11,6 +11,7 @@
 
 use Closure;
 use OCA\Files\Event\LoadSidebar;
+use OCA\OpenProject\Capabilities;
 use OCA\OpenProject\Listener\BeforeNodeInsideOpenProjectGroupfilderChangedListener;
 use OCA\OpenProject\Listener\BeforeUserDeletedListener;
 use OCA\OpenProject\Listener\BeforeGroupDeletedListener;
@@ -65,6 +66,7 @@ public function __construct(array $urlParams = []) {
 	}
 
 	public function register(IRegistrationContext $context): void {
+		$context->registerCapability(Capabilities::class);
 		$context->registerDashboardWidget(OpenProjectWidget::class);
 		$context->registerSearchProvider(OpenProjectSearchProvider::class);
 

diff --git a/lib/Capabilities.php b/lib/Capabilities.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\OpenProject;
+
+use OCA\OpenProject\AppInfo\Application;
+use OCP\App\IAppManager;
+use OCP\Capabilities\IPublicCapability;
+
+class Capabilities implements IPublicCapability {
+
+	/** @var IAppManager */
+	private $appManager;
+
+	public function __construct(
+		IAppManager $appManager
+	) {
+		$this->appManager = $appManager;
+	}
+
+	/**
+	 * @return array<string, array<string, bool|string>>
+	 */
+	public function getCapabilities(): array {
+		$appVersion = $this->appManager->getAppVersion(Application::APP_ID);
+		$groupfoldersVersion = $this->appManager->getAppVersion('groupfolders');
+		$groupfoldersEnabled = $this->appManager->isEnabledForUser('groupfolders');
+		return [
+			Application::APP_ID => [
+				'app_version' => $appVersion,
+				'groupfolder_version' => $groupfoldersVersion,
+				'groupfolders_enabled' => $groupfoldersEnabled,
+			],
+		];
+	}
+}
diff --git a/tests/acceptance/features/api/capabilities.feature b/tests/acceptance/features/api/capabilities.feature
@@ -0,0 +1,48 @@
+Feature: get capabilities of the app
+
+  Scenario: Get capabilities when group folder app is enabled
+    When the administrator requests the nextcloud capabilities
+    Then the HTTP status code should be "200"
+    And the ocs data of the response should match
+    """"
+    {
+      "type": "object",
+      "required": [
+        "capabilities"
+      ],
+      "properties": {
+        "capabilities": {
+          "type": "object",
+          "required": [
+            "integration_openproject"
+          ],
+          "properties": {
+            "integration_openproject": {
+              "type": "object",
+              "required": [
+                "app_version",
+                "groupfolder_version",
+                "groupfolders_enabled"
+              ],
+              "properties": {
+                "app_version": {
+                  "type": "string",
+                  "pattern": "^\\d+\\.\\d+\\.\\d+$"
+                },
+                "groupfolder_version": {
+                  "type": "string",
+                  "pattern": "^\\d+\\.\\d+\\.\\d+(\\-\\w+)?$"
+                },
+                "groupfolders_enabled": {
+                  "type": "boolean",
+                  "enum": [
+                    true
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    """
diff --git a/tests/acceptance/features/bootstrap/FeatureContext.php b/tests/acceptance/features/bootstrap/FeatureContext.php
@@ -914,6 +914,16 @@ public function theUserSendsARequestToTheEndpoint(
 		);
 	}
 
+	/**
+	 * @When the administrator requests the nextcloud capabilities
+	 *
+	 * @return void
+	 */
+	public function theAdministratorRequestsCapabilities(): void {
+		$this->response = $this->sendOCSRequest(
+			'/cloud/capabilities', 'GET', $this->getAdminUsername()
+		);
+	}
 
 	/**
 	 * @Then /^the content of file at "([^"]*)" for user "([^"]*)" should be "([^"]*)"$/