Update Project providers to also include the provider key

Pass the provider key and name back so that a nicely formatted name can be shown in the Appwrite Console.
n1klaus · Jul 20, 2023 · 5be6d8e · 5be6d8e
1 parent 7a02a16
commit 5be6d8e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/app/config/providers.php b/app/config/providers.php
@@ -232,7 +232,7 @@
         'mock' => false
     ],
     'paypalSandbox' => [
-        'name' => 'PayPal',
+        'name' => 'PayPal Sandbox',
         'developers' => 'https://developer.paypal.com/docs/api/overview/',
         'icon' => 'icon-paypal',
         'enabled' => true,
@@ -302,7 +302,7 @@
         'mock' => false,
     ],
     'tradeshiftBox' => [
-        'name' => 'Tradeshift',
+        'name' => 'Tradeshift Sandbox',
         'developers' => 'https://developers.tradeshift.com/docs/api',
         'icon' => 'icon-tradeshiftbox',
         'enabled' => true,

diff --git a/src/Appwrite/Utopia/Response/Model/Project.php b/src/Appwrite/Utopia/Response/Model/Project.php
@@ -136,7 +136,7 @@ public function __construct()
                 'type' => Response::MODEL_PROVIDER,
                 'description' => 'List of Providers.',
                 'default' => [],
-                'example' => new \stdClass(),
+                'example' => [new \stdClass()],
                 'array' => true,
             ])
             ->addRule('platforms', [
@@ -273,7 +273,8 @@ public function filter(Document $document): Document
             }
 
             $projectProviders[] = new Document([
-                'name' => ucfirst($key),
+                'key' => $key,
+                'name' => $provider['name'] ?? '',
                 'appId' => $providerValues[$key . 'Appid'] ?? '',
                 'secret' => $providerValues[$key . 'Secret'] ?? '',
                 'enabled' => $providerValues[$key . 'Enabled'] ?? false,

diff --git a/src/Appwrite/Utopia/Response/Model/Provider.php b/src/Appwrite/Utopia/Response/Model/Provider.php
@@ -15,6 +15,12 @@ class Provider extends Model
     public function __construct()
     {
         $this
+            ->addRule('key', [
+                'type' => self::TYPE_STRING,
+                'description' => 'Provider.',
+                'default' => '',
+                'example' => 'github',
+            ])
             ->addRule('name', [
                 'type' => self::TYPE_STRING,
                 'description' => 'Provider name.',

diff --git a/tests/e2e/Services/Projects/ProjectsConsoleClientTest.php b/tests/e2e/Services/Projects/ProjectsConsoleClientTest.php
@@ -618,7 +618,7 @@ public function testUpdateProjectOAuth($data): array
         foreach ($providers as $key => $provider) {
             $asserted = false;
             foreach ($response['body']['providers'] as $responseProvider) {
-                if ($responseProvider['name'] === ucfirst($key)) {
+                if ($responseProvider['key'] === $key) {
                     $this->assertEquals('AppId-' . ucfirst($key), $responseProvider['appId']);
                     $this->assertEquals('Secret-' . ucfirst($key), $responseProvider['secret']);
                     $this->assertFalse($responseProvider['enabled']);
@@ -660,7 +660,7 @@ public function testUpdateProjectOAuth($data): array
         foreach ($providers as $key => $provider) {
             $asserted = false;
             foreach ($response['body']['providers'] as $responseProvider) {
-                if ($responseProvider['name'] === ucfirst($key)) {
+                if ($responseProvider['key'] === $key) {
                     // On first provider, test enabled=false
                     $this->assertEquals($i !== 0, $responseProvider['enabled']);
                     $asserted = true;