Merge branch 'update_thoth_auth-3_5_0-i1171' into 'main'

Update Thoth auth to use personal access token

See merge request softwares-pkp/plugins_ojs/thoth-omp-plugin!98

Author: thiagolepidus

README.md

@@ -30,11 +30,11 @@ This plugin is compatible with the following PKP applications:
 
 After enabling the plugin, go to the plugin settings and fill in:
 
-- **Email** and **Password**: Credentials for a Thoth account to connect with the API.
+- **Personal access token**: A valid Thoth personal access token used to authenticate API requests.
 - **Custom Thoth API**: Check this option to use a custom Thoth API instead of the official one.
 - **Thoth API URL**: The URL of the custom Thoth API (only required when the custom API option is enabled).
 
-<img src="/docs/images/plugin_settings.png" alt="Plugin settings form with email, password, custom API and URL fields" width="700">
+<img src="/docs/images/plugin_settings.png" alt="Plugin settings form with personal access token, custom API and URL fields" width="700">
 
 ### Registering Monographs
 

ThothSettingsForm.php

@@ -34,8 +34,7 @@
 class ThothSettingsForm extends Form
 {
     private const SETTINGS = [
-        'email',
-        'password',
+        'token',
         'customThothApi',
         'customThothApiUrl',
     ];
@@ -84,10 +83,10 @@ function ($customThothApiUrl) {
 
         $this->addCheck(new FormValidatorCustom(
             $this,
-            'password',
+            'token',
             'required',
             'plugins.generic.thoth.settings.invalidCredentials',
-            fn ($password) => $this->validateCredentials(trim($this->getData('email')), $password)
+            fn ($token) => $this->validateCredentials(trim($token))
         ));
     }
 
@@ -97,7 +96,7 @@ public function initData(): void
             $value = $this->plugin->getSetting($this->contextId, $setting);
             $this->setData(
                 $setting,
-                $setting === 'password' && $value ? Crypt::decrypt($value) : $value
+                $setting === 'token' && $value ? Crypt::decrypt($value) : $value
             );
         }
     }
@@ -116,7 +115,7 @@ public function fetch($request, $template = null, $display = false): string
 
     public function execute(...$functionArgs): void
     {
-        $this->setData('password', Crypt::encrypt($this->getData('password')));
+        $this->setData('token', Crypt::encrypt(trim($this->getData('token'))));
 
         foreach (self::SETTINGS as $setting) {
             $this->plugin->updateSetting($this->contextId, $setting, trim($this->getData($setting)), 'string');
@@ -125,15 +124,15 @@ public function execute(...$functionArgs): void
         parent::execute(...$functionArgs);
     }
 
-    private function validateCredentials(string $email, string $password): bool
+    private function validateCredentials(string $token): bool
     {
         $httpConfig = [];
         if ($this->getData('customThothApi') && $this->getData('customThothApiUrl')) {
             $httpConfig['base_uri'] = trim($this->getData('customThothApiUrl'));
         }
 
         try {
-            (new Client($httpConfig))->login($email, $password);
+            (new Client($httpConfig))->setToken($token)->me();
             return true;
         } catch (QueryException) {
             return false;

classes/container/providers/ThothRepositoryProvider.php

@@ -48,14 +48,12 @@ public function register($container)
 
             $customThothApi = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'customThothApi');
             $customThothApiUrl = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'customThothApiUrl');
-            $email = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'email');
-            $password = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'password') ?? '';
+            $token = $pluginSettingsDao->getSetting($contextId, 'ThothPlugin', 'token') ?? '';
 
             return [
                 'customThothApi' => $customThothApi,
                 'customThothApiUrl' => $customThothApiUrl,
-                'email' => $email,
-                'password' => Crypt::decrypt($password)
+                'token' => $token ? Crypt::decrypt($token) : ''
             ];
         });
 
@@ -68,7 +66,7 @@ public function register($container)
             }
 
             $client = new Client($httpConfig);
-            return $client->login($config['email'], $config['password']);
+            return $client->setToken($config['token']);
         });
 
         $container->set('accountRepository', function ($container) {

classes/repositories/ThothAccountRepository.php

@@ -27,7 +27,23 @@ public function __construct($thothClient)
 
     public function getLinkedPublishers()
     {
-        $details = $this->thothClient->accountDetails();
-        return $details['resourceAccess']['linkedPublishers'];
+        $result = $this->thothClient->rawQuery(
+            <<<'GQL'
+            query {
+                me {
+                    publisherContexts {
+                        publisher {
+                            publisherId
+                        }
+                    }
+                }
+            }
+            GQL
+        );
+
+        return array_map(
+            fn (array $publisherContext) => $publisherContext['publisher'],
+            $result['me']['publisherContexts'] ?? []
+        );
     }
 }

composer.json

@@ -1,6 +1,6 @@
 {
     "require": {
         "biblys/isbn": "~3.0",
-        "thoth-pub/thoth-client-php": "^1.3"
+        "thoth-pub/thoth-client-php": "^1.4"
     }
 }

composer.lock

@@ -30,11 +30,11 @@ Este plugin es compatible con las siguientes aplicaciones PKP:
 
 Después de habilitar el plugin, vaya a la configuración del plugin y complete:
 
-- **Correo electrónico** y **Contraseña**: Credenciales de una cuenta de Thoth para conectar con la API.
+- **Token de acceso personal**: Un token de acceso personal válido de Thoth para autenticar las solicitudes a la API.
 - **API Thoth personalizada**: Marque esta opción para usar una API Thoth personalizada en lugar de la oficial.
 - **URL de la API Thoth**: La URL de la API Thoth personalizada (solo requerida cuando la opción de API personalizada está habilitada).
 
-<img src="/docs/images/plugin_settings.png" alt="Formulario de configuración del plugin con campos de correo, contraseña, API personalizada y URL" width="700">
+<img src="/docs/images/plugin_settings.png" alt="Formulario de configuración del plugin con token de acceso personal, API personalizada y URL" width="700">
 
 ### Registro de Monografías
 

docs/README-es.md

@@ -30,11 +30,11 @@ Este plugin é compatível com as seguintes aplicações PKP:
 
 Após habilitar o plugin, vá nas configurações do plugin e preencha:
 
-- **E-mail** e **Senha**: Credenciais de uma conta do Thoth para conectar com a API.
+- **Token de acesso pessoal**: Um token de acesso pessoal válido do Thoth para autenticar as requisições da API.
 - **API Thoth personalizada**: Marque esta opção para usar uma API Thoth personalizada em vez da oficial.
 - **URL da API Thoth**: A URL da API Thoth personalizada (necessária apenas quando a opção de API personalizada está habilitada).
 
-<img src="/docs/images/plugin_settings.png" alt="Formulário de configuração do plugin com campos de e-mail, senha, API personalizada e URL" width="700">
+<img src="/docs/images/plugin_settings.png" alt="Formulário de configuração do plugin com token de acesso pessoal, API personalizada e URL" width="700">
 
 ### Registro de Monografias