feat: ORCID deposition for codecheckers + CODECHECK form in reviewer tab (#16)#126
feat: ORCID deposition for codecheckers + CODECHECK form in reviewer tab (#16)#126subhanLabs wants to merge 15 commits into
Conversation
…tab (#16) - Full OAuth 2.0 flow for codechecker ORCID authorisation - ORCID Member API peer-review deposition on publish and manually - CODECHECK metadata form injected into reviewer tab 3 (Download & Review) - ORCID section shown in editor workflow CODECHECK tab - codecheck_orcid_tokens DB table for token/deposit tracking - Reviewer role added to API handler - All settings read from plugin configuration
|
Thanks! Can you please clarify re. "Editor opens the CODECHECK tab in the editorial workflow" > the codechecker needs to be the one that opens the tab and initiates the authentication with ORCID, right? It would be great, because this is a crucial feature, if you could add a couple of screenshots or maybe even a screencast to document the completed functionality. |
nuest
left a comment
There was a problem hiding this comment.
General comments first, detailed line-by-line review later.
- Fix ORCID iD mismatch check to validate against all codecheckers - Remove city as required field, only name and country needed - Bundle ORCID icon locally instead of loading from orcid.org - Restrict auth button to reviewer form, editors see status only - Add Test ORCID Setup button in plugin settings - Add ORCID settings section to settings form and template
|
@subhanLabs For the sake of documentation, can you please update local docs or the README file which field mentioned in https://support.orcid.org/hc/en-us/articles/360006971333-Peer-Reviews your code sets, and what values are put in there? Thanks! |
|
@subhanLabs For the sake of documentation, please post a screenshot of the ORCID Deposition section here. |
I have added a section to the README documenting which ORCID peer-review fields are set and what values are used: Orcid Peer Review Deposition |
06a322f to
4e7eaed
Compare
|
@subhanLabs please merge main branch, it just underwent some massive changes. When done, double check there are no merge artefacts in the code, please. |
|
@subhanLabs Please resolve the minor merge conflicts and add a reply to all conversations of #126 (review) - Thanks! |
All merge conflicts have been resolved and all review comments have been addressed. Please take another look when you get a chance, thanks! |
|
@subhanLabs Please resolve all conversations with a short comment - thanks! |


Summary
This PR implements two major features for the CODECHECK plugin:
Changes
New Classes
classes/Orcid/OrcidApiClient.php— low-level ORCID API HTTP clientclasses/Orcid/OrcidAuthHandler.php— handles OAuth 2.0 authorisation flow (startAuth/callback)classes/Orcid/OrcidDepositService.php— builds and deposits peer-review records to ORCIDclasses/Orcid/OrcidTokenDAO.php— manages token storage incodecheck_orcid_tokenstableclasses/Orcid/PeerReviewPayloadBuilder.php— constructs ORCID peer-review XML payloadclasses/Log/CodecheckLogger.php— structured logger with debug/info/error levelsModified Files
CodecheckPlugin.php— ORCID hooks, reviewer data injection, publish handlerapi/v1/CodecheckApiHandler.php— addedorcid-statusandorcid-depositendpoints, reviewer roleapi/v1/JsonResponse.php— made constructor args optional, addedresponse()convenience methodclasses/Constants.php— added all ORCID and GitHub constantsclasses/migration/CodecheckSchemaMigration.php— addedcodecheck_orcid_tokenstablelocale/en/locale.po— added ORCID and missing locale keysregistry/uiLocaleKeysBackend.json— added ORCID locale keysresources/js/main.js— ORCID section in workflow, reviewer form injection via MutationObserverresources/js/Components/CodecheckOrcidSection.vue— Vue component for ORCID authorisation and deposit UIHow it works
ORCID OAuth flow
codecheck_orcid_tokensReviewer form
CodecheckMetadataFormand optionallyCodecheckOrcidSectionif ORCID is enabledNotes
error_log()calls replaced withCodecheckLogger(debug/info/error levels)Closes #16