Merge branch 'feature/mg-AdminEndpoint' of AVENCY/Gitea into master

Reviewed-by: Lisa Kampert <lisa.kampert@avency.de>

Classes/Client.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace Avency\Gitea;
 
+use Avency\Gitea\Endpoint\Admin;
 use Avency\Gitea\Endpoint\EndpointInterface;
 use Avency\Gitea\Endpoint\Miscellaneous;
 use Avency\Gitea\Endpoint\Repositories;
@@ -13,8 +14,9 @@ use Psr\Http\Message\ResponseInterface;
 /**
  * Gitea Client
  *
- * @method Repositories repositories()
+ * @method Admin admin()
  * @method Miscellaneous miscellaneous()
+ * @method Repositories repositories()
  */
 class Client
 {
@@ -73,6 +75,9 @@ class Client
      */
     public function request(string $uri = '', string $method = 'GET', array $options = []): ResponseInterface
     {
+        if (!empty($this->config['query']) && !empty($options['query'])) {
+            $options['query'] = array_merge($this->config['query'], $options['query']);
+        }
         return $this->httpClient->request($method, $uri, $options);
     }
 

Classes/Endpoint/AbstractEndpoint.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Avency\Gitea\Endpoint;
+
+use Avency\Gitea\Client;
+
+/**
+ * Abstract endpoint
+ */
+abstract class AbstractEndpoint implements EndpointInterface
+{
+    /**
+     * @param array $array
+     * @return array
+     */
+    protected function removeNullValues(array $array): array
+    {
+        return array_filter(
+            $array,
+            function($value) {
+                return !is_null($value);
+            }
+        );
+    }
+}

Classes/Endpoint/Admin.php

@@ -0,0 +1,281 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Avency\Gitea\Endpoint;
+
+use Avency\Gitea\Client;
+
+/**
+ * Admin endpoint
+ */
+class Admin extends AbstractEndpoint implements EndpointInterface
+{
+    const BASE_URI = 'api/v1/admin';
+
+    /**
+     * @var Client
+     */
+    protected $client;
+
+    /**
+     * @param Client $client
+     */
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * @param int|null $page
+     * @param int|null $limit
+     * @return array
+     */
+    public function getOrgs(int $page = null, int $limit = null): array
+    {
+        $options['query'] = [
+            'page' => $page,
+            'limit' => $limit,
+        ];
+        $options['query'] = $this->removeNullValues($options['query']);
+
+        $response = $this->client->request(self::BASE_URI . '/orgs', 'GET', $options);
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+
+    /**
+     * @return array
+     */
+    public function getUsers(): array
+    {
+        $response = $this->client->request(self::BASE_URI . '/users');
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+
+    /**
+     * @param string $username
+     * @param string $password
+     * @param string $email
+     * @param string|null $fullName
+     * @param string|null $loginName
+     * @param bool $mustChangePassword
+     * @param bool $sendNotify
+     * @param int|null $sourceId
+     * @return array
+     */
+    public function createUser(
+        string $username,
+        string $password,
+        string $email,
+        string $fullName = null,
+        string $loginName = null,
+        bool $mustChangePassword = true,
+        bool $sendNotify = true,
+        int $sourceId = null
+    ): array
+    {
+        $options['json'] = [
+            'username' => $username,
+            'password' => $password,
+            'email' => $email,
+            'full_name' => $fullName,
+            'login_name' => $loginName,
+            'must_change_password' => $mustChangePassword,
+            'send_notify' => $sendNotify,
+            'source_id' => $sourceId,
+        ];
+        $options['json'] = $this->removeNullValues($options['json']);
+
+        $response = $this->client->request(self::BASE_URI . '/users', 'POST', $options);
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+
+    /**
+     * @param string $username
+     * @param string $email
+     * @param string|null $password
+     * @param bool|null $active
+     * @param bool|null $admin
+     * @param bool|null $allowCreateOrganization
+     * @param bool|null $allowGitHook
+     * @param bool|null $allowImportLocal
+     * @param string|null $fullName
+     * @param string|null $location
+     * @param string|null $loginName
+     * @param int|null $maxRepoCreation
+     * @param bool|null $mustChangePassword
+     * @param bool|null $prohibitLogin
+     * @param int|null $sourceId
+     * @param string|null $website
+     * @return array
+     */
+    public function updateUser(
+        string $username,
+        string $email,
+        string $password = null,
+        bool $active = null,
+        bool $admin = null,
+        bool $allowCreateOrganization = null,
+        bool $allowGitHook = null,
+        bool $allowImportLocal = null,
+        string $fullName = null,
+        string $location = null,
+        string $loginName = null,
+        int $maxRepoCreation = null,
+        bool $mustChangePassword = null,
+        bool $prohibitLogin = null,
+        int $sourceId = null,
+        string $website = null
+    ): array
+    {
+        $options['json'] = [
+            'email' => $email,
+            'password' => $password,
+            'active' => $active,
+            'admin' => $admin,
+            'allow_create_organization' => $allowCreateOrganization,
+            'allow_git_hook' => $allowGitHook,
+            'allow_import_local' => $allowImportLocal,
+            'full_name' => $fullName,
+            'location' => $location,
+            'login_name' => $loginName,
+            'max_repo_creation' => $maxRepoCreation,
+            'must_change_password' => $mustChangePassword,
+            'prohibit_login' => $prohibitLogin,
+            'source_id' => $sourceId,
+            'website' => $website,
+        ];
+        $options['json'] = $this->removeNullValues($options['json']);
+
+        $response = $this->client->request(self::BASE_URI . '/users/' . $username, 'PATCH', $options);
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+
+    /**
+     * @param string $username
+     * @return bool
+     */
+    public function deleteUser(string $username): bool
+    {
+        $response = $this->client->request(self::BASE_URI . '/users/' . $username, 'DELETE');
+        return true;
+    }
+
+    /**
+     * @param string $username
+     * @param string $title
+     * @param string $key
+     * @param bool|null $readOnly
+     * @return array
+     */
+    public function addKeyToUser(
+        string $username,
+        string $title,
+        string $key,
+        bool $readOnly = null
+    ): array
+    {
+        $options['json'] = [
+            'title' => $title,
+            'key' => $key,
+            'read_only' => $readOnly,
+        ];
+        $options['json'] = $this->removeNullValues($options['json']);
+
+        $response = $this->client->request(self::BASE_URI . '/users/' . $username . '/keys', 'POST', $options);
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+
+    /**
+     * @param string $username
+     * @param string $title
+     * @param string $key
+     * @param bool|null $readOnly
+     * @return bool
+     */
+    public function deleteKeyFromUser(
+        string $username,
+        int $id
+    ): bool
+    {
+        $response = $this->client->request(self::BASE_URI . '/users/' . $username . '/keys/' . $id, 'DELETE');
+        return true;
+    }
+
+    /**
+     * @param string $username
+     * @param string $orgUsername
+     * @param string|null $description
+     * @param string|null $fullName
+     * @param string|null $location
+     * @param bool|null $repoAdminChangeTeamAccess
+     * @param string|null $visibility // public, limited, private
+     * @param string|null $website
+     * @return array
+     */
+    public function createOrgWithUser(
+        string $username,
+        string $orgUsername,
+        string $description = null,
+        string $fullName = null,
+        string $location = null,
+        bool $repoAdminChangeTeamAccess = null,
+        string $visibility = null,
+        string $website = null
+    ): array
+    {
+        $options['json'] = [
+            'username' => $orgUsername,
+            'description' => $description,
+            'full_name' => $fullName,
+            'location' => $location,
+            'repo_admin_change_team_access' => $repoAdminChangeTeamAccess,
+            'visibility' => $visibility,
+            'website' => $website,
+        ];
+        $options['json'] = $this->removeNullValues($options['json']);
+
+        $response = $this->client->request(self::BASE_URI . '/users/' . $username . '/orgs', 'POST', $options);
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+
+    /**
+     * @param string $username
+     * @param string $repoName
+     * @param bool|null $auto_init
+     * @param string|null $description
+     * @param string|null $gitignores
+     * @param string|null $issue_labels
+     * @param string|null $license
+     * @param bool|null $private
+     * @param string|null $readme
+     * @return array
+     */
+    public function createUserRepository(
+        string $username,
+        string $repoName,
+        bool $auto_init = null,
+        string $description = null,
+        string $gitignores = null,
+        string $issue_labels = null,
+        string $license = null,
+        bool $private = null,
+        string $readme = null
+    ): array
+    {
+        $options['json'] = [
+            'name' => $repoName,
+            'auto_init' => $auto_init,
+            'description' => $description,
+            'gitignores' => $gitignores,
+            'issue_labels' => $issue_labels,
+            'license' => $license,
+            'private' => $private,
+            'readme' => $readme,
+        ];
+        $options['json'] = $this->removeNullValues($options['json']);
+
+        $response = $this->client->request(self::BASE_URI . '/users/' . $username . '/repos', 'POST', $options);
+        return \GuzzleHttp\json_decode($response->getBody(), true);
+    }
+}

Classes/Endpoint/Miscellaneous.php

@@ -9,7 +9,7 @@ use Avency\Gitea\Client;
 /**
  * Miscellaneous endpoint
  */
-class Miscellaneous implements EndpointInterface
+class Miscellaneous extends AbstractEndpoint implements EndpointInterface
 {
     const BASE_URI = 'api/v1';
 
@@ -41,7 +41,7 @@ class Miscellaneous implements EndpointInterface
             'text' => $text,
             'wiki' => $wiki
         ];
-        $options['json'] = array_filter($options['json']);
+        $options['json'] = $this->removeNullValues($options['json']);
 
         $response = $this->client->request(self::BASE_URI . '/markdown', 'POST', $options);
         return (string)$response->getBody();

Classes/Endpoint/Repositories.php

@@ -9,7 +9,7 @@ use Avency\Gitea\Client;
 /**
  * Repositories endpoint
  */
-class Repositories implements EndpointInterface
+class Repositories extends AbstractEndpoint implements EndpointInterface
 {
     const BASE_URI = 'api/v1/repos';
 
@@ -79,7 +79,7 @@ class Repositories implements EndpointInterface
             ]
         ];
 
-        $options['json'] = array_filter($options['json']);
+        $options['json'] = $this->removeNullValues($options['json']);
         $response = $this->client->request(self::BASE_URI . '/migrate', 'POST', $options);
         return \GuzzleHttp\json_decode($response->getBody(), true);
     }
@@ -134,7 +134,7 @@ class Repositories implements EndpointInterface
             'sort' => $sort,
             'order' => $order,
         ];
-        $options['query'] = array_filter($options['query']);
+        $options['query'] = $this->removeNullValues($options['query']);
         $response = $this->client->request(self::BASE_URI . '/search', 'GET', $options);
         return \GuzzleHttp\json_decode($response->getBody(), true);
     }

README.md

@@ -82,14 +82,14 @@ This project is licensed under the MIT License - see the
 
 Status | Method | Endpoint
 --- | --- | ---
-❌ | GET | /admin/orgs
-❌ | POST | /admin/users
-❌ | DELETE | /admin/users/{username}
-❌ | PATCH | /admin/users/{username}
-❌ | POST | /admin/users/{username}/keys
-❌ | DELETE | /admin/users/{username}/keys/{id}
-❌ | POST | /admin/users/{username}/orgs
-❌ | POST | /admin/users/{username}/repos
+✅ | GET | /admin/orgs
+✅ | POST | /admin/users
+✅ | DELETE | /admin/users/{username}
+✅ | PATCH | /admin/users/{username}
+✅ | POST | /admin/users/{username}/keys
+✅ | DELETE | /admin/users/{username}/keys/{id}
+✅ | POST | /admin/users/{username}/orgs
+✅ | POST | /admin/users/{username}/repos
 
 #### Miscellaneous