Merge pull request #58 from lepidus/main

Update thoth schema integration (OMP 3.5.0)

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

@@ -20,6 +20,7 @@
 
 use APP\template\TemplateManager;
 use GuzzleHttp\Exception\GuzzleException;
+use Illuminate\Contracts\Encryption\DecryptException;
 use Illuminate\Support\Facades\Crypt;
 use PKP\form\Form;
 use PKP\form\validation\FormValidatorCSRF;
@@ -34,8 +35,7 @@
 class ThothSettingsForm extends Form
 {
     private const SETTINGS = [
-        'email',
-        'password',
+        'token',
         'customThothApi',
         'customThothApiUrl',
     ];
@@ -84,20 +84,27 @@ 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))
         ));
     }
 
     public function initData(): void
     {
         foreach (self::SETTINGS as $setting) {
             $value = $this->plugin->getSetting($this->contextId, $setting);
+            if ($setting === 'token' && $value) {
+                try {
+                    $value = Crypt::decrypt($value);
+                } catch (DecryptException $exception) {
+                    $value = '';
+                }
+            }
             $this->setData(
                 $setting,
-                $setting === 'password' && $value ? Crypt::decrypt($value) : $value
+                $value
             );
         }
     }
@@ -116,7 +123,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 +132,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/api/ThothEndpoint.php

@@ -123,7 +123,7 @@ public function register(IlluminateRequest $illuminateRequest): JsonResponse
             $this->handleNotification($request, $submission, true, $disableNotification);
         } catch (QueryException $e) {
             $thothBookService->deleteRegisteredEntry();
-            $this->handleNotification($request, $submission, false, $disableNotification, $e->getMessage());
+            $this->handleNotification($request, $submission, false, $disableNotification, $e);
             $failure['errors'][] = __('plugins.generic.thoth.register.error.log', ['reason' => $e->getMessage()]);
             return response()->json($failure, Response::HTTP_BAD_REQUEST);
         }

classes/components/forms/config/PublishFormConfig.php

@@ -19,6 +19,7 @@
 use APP\facades\Repo;
 use APP\plugins\generic\thoth\classes\facades\ThothRepository;
 use APP\plugins\generic\thoth\classes\facades\ThothService;
+use APP\plugins\generic\thoth\classes\notification\ThothNotification;
 use APP\submission\Submission;
 use ThothApi\GraphQL\Models\Work as ThothWork;
 

classes/container/providers/ThothRepositoryProvider.php

@@ -20,7 +20,9 @@
 
 use APP\core\Application;
 use APP\plugins\generic\thoth\classes\repositories\ThothAccountRepository;
+use APP\plugins\generic\thoth\classes\repositories\ThothAbstractRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothAffiliationRepository;
+use APP\plugins\generic\thoth\classes\repositories\ThothBiographyRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothBookRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothChapterRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothContributionRepository;
@@ -32,8 +34,10 @@
 use APP\plugins\generic\thoth\classes\repositories\ThothPublicationRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothReferenceRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothSubjectRepository;
+use APP\plugins\generic\thoth\classes\repositories\ThothTitleRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothWorkRelationRepository;
 use APP\plugins\generic\thoth\classes\repositories\ThothWorkRepository;
+use Illuminate\Contracts\Encryption\DecryptException;
 use Illuminate\Support\Facades\Crypt;
 use PKP\db\DAORegistry;
 use ThothApi\GraphQL\Client;
@@ -48,14 +52,21 @@ 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') ?? '';
+            $decryptedToken = '';
+
+            if ($token) {
+                try {
+                    $decryptedToken = Crypt::decrypt($token);
+                } catch (DecryptException $exception) {
+                    $decryptedToken = '';
+                }
+            }
 
             return [
                 'customThothApi' => $customThothApi,
                 'customThothApiUrl' => $customThothApiUrl,
-                'email' => $email,
-                'password' => Crypt::decrypt($password)
+                'token' => $decryptedToken
             ];
         });
 
@@ -68,13 +79,17 @@ 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) {
             return new ThothAccountRepository($container->get('client'));
         });
 
+        $container->set('abstractRepository', function ($container) {
+            return new ThothAbstractRepository($container->get('client'));
+        });
+
         $container->set('affiliationRepository', function ($container) {
             return new ThothAffiliationRepository($container->get('client'));
         });
@@ -83,6 +98,10 @@ public function register($container)
             return new ThothBookRepository($container->get('client'));
         });
 
+        $container->set('biographyRepository', function ($container) {
+            return new ThothBiographyRepository($container->get('client'));
+        });
+
         $container->set('chapterRepository', function ($container) {
             return new ThothChapterRepository($container->get('client'));
         });
@@ -123,6 +142,10 @@ public function register($container)
             return new ThothSubjectRepository($container->get('client'));
         });
 
+        $container->set('titleRepository', function ($container) {
+            return new ThothTitleRepository($container->get('client'));
+        });
+
         $container->set('workRelationRepository', function ($container) {
             return new ThothWorkRelationRepository($container->get('client'));
         });

classes/container/providers/ThothServiceProvider.php

@@ -19,11 +19,16 @@
 
 use APP\plugins\generic\thoth\classes\factories\ThothBookFactory;
 use APP\plugins\generic\thoth\classes\factories\ThothChapterFactory;
+use APP\plugins\generic\thoth\classes\factories\ThothAbstractFactory;
+use APP\plugins\generic\thoth\classes\factories\ThothBiographyFactory;
 use APP\plugins\generic\thoth\classes\factories\ThothContributionFactory;
 use APP\plugins\generic\thoth\classes\factories\ThothContributorFactory;
 use APP\plugins\generic\thoth\classes\factories\ThothLocationFactory;
 use APP\plugins\generic\thoth\classes\factories\ThothPublicationFactory;
+use APP\plugins\generic\thoth\classes\factories\ThothTitleFactory;
 use APP\plugins\generic\thoth\classes\services\ThothAffiliationService;
+use APP\plugins\generic\thoth\classes\services\ThothAbstractService;
+use APP\plugins\generic\thoth\classes\services\ThothBiographyService;
 use APP\plugins\generic\thoth\classes\services\ThothBookService;
 use APP\plugins\generic\thoth\classes\services\ThothChapterService;
 use APP\plugins\generic\thoth\classes\services\ThothContributionService;
@@ -33,6 +38,7 @@
 use APP\plugins\generic\thoth\classes\services\ThothPublicationService;
 use APP\plugins\generic\thoth\classes\services\ThothReferenceService;
 use APP\plugins\generic\thoth\classes\services\ThothSubjectService;
+use APP\plugins\generic\thoth\classes\services\ThothTitleService;
 use APP\plugins\generic\thoth\classes\services\ThothWorkRelationService;
 
 class ThothServiceProvider implements ContainerProvider
@@ -43,6 +49,20 @@ public function register($container)
             return new ThothAffiliationService($container->get('affiliationRepository'));
         });
 
+        $container->set('abstractService', function ($container) {
+            return new ThothAbstractService(
+                new ThothAbstractFactory(),
+                $container->get('abstractRepository')
+            );
+        });
+
+        $container->set('biographyService', function ($container) {
+            return new ThothBiographyService(
+                new ThothBiographyFactory(),
+                $container->get('biographyRepository')
+            );
+        });
+
         $container->set('bookService', function ($container) {
             return new ThothBookService(
                 new ThothBookFactory(),
@@ -97,6 +117,13 @@ public function register($container)
             return new ThothSubjectService($container->get('subjectRepository'));
         });
 
+        $container->set('titleService', function ($container) {
+            return new ThothTitleService(
+                new ThothTitleFactory(),
+                $container->get('titleRepository')
+            );
+        });
+
         $container->set('workRelationService', function ($container) {
             return new ThothWorkRelationService($container->get('workRelationRepository'));
         });

classes/facades/ThothRepository.php

@@ -25,6 +25,16 @@ public static function account()
         return ThothContainer::getInstance()->get('accountRepository');
     }
 
+    public static function abstract()
+    {
+        return ThothContainer::getInstance()->get('abstractRepository');
+    }
+
+    public static function biography()
+    {
+        return ThothContainer::getInstance()->get('biographyRepository');
+    }
+
     public static function affiliation()
     {
         return ThothContainer::getInstance()->get('affiliationRepository');
@@ -75,6 +85,11 @@ public static function subject()
         return ThothContainer::getInstance()->get('subjectRepository');
     }
 
+    public static function title()
+    {
+        return ThothContainer::getInstance()->get('titleRepository');
+    }
+
     public static function workRelation()
     {
         return ThothContainer::getInstance()->get('workRelationRepository');

classes/facades/ThothService.php

@@ -20,11 +20,21 @@
 
 class ThothService
 {
+    public static function abstract()
+    {
+        return ThothContainer::getInstance()->get('abstractService');
+    }
+
     public static function affiliation()
     {
         return ThothContainer::getInstance()->get('affiliationService');
     }
 
+    public static function biography()
+    {
+        return ThothContainer::getInstance()->get('biographyService');
+    }
+
     public static function book()
     {
         return ThothContainer::getInstance()->get('bookService');
@@ -75,6 +85,11 @@ public static function subject()
         return ThothContainer::getInstance()->get('subjectService');
     }
 
+    public static function title()
+    {
+        return ThothContainer::getInstance()->get('titleService');
+    }
+
     public static function workRelation()
     {
         return ThothContainer::getInstance()->get('workRelationService');