Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Api client service providers #115

Open
wants to merge 52 commits into
base: develop
Choose a base branch
from
Open

Api client service providers #115

wants to merge 52 commits into from

Conversation

betsyecastro
Copy link
Contributor

@betsyecastro betsyecastro commented Feb 22, 2023 •
edited
Loading

This PR replaces PR #110 and includes:

  1. Publications API Interface to import publications from the the Academic Analytics API, for now.
  2. AA Publications API service provider that implements the interface mentioned above
  3. In the publications-import-modal Livewire component, it fixes the collection iteration method before the data is rendered.
  4. Corrections in the jQuery selectors that contain the publication data that will be added to the editor.
  5. AA Publications API service provider mock for testing purposes.
  6. Artisan command to search and add DOI's to publications that don't have it.
  7. Feature tests:
  • Search and add academic analytics id's for the profiles that don't have it
  • Measure similarity between phrases publications titles to obtain DOI's.
  • publications-import-modal Livewire component

Local configuration required to test the feature:

  1. Add the following values to the .env file:
    DOI_REGEX = '/(10[.][0-9]{4,}[^\s"\/<>]*/[^\s"<>]+)/'
    EMAIL_ADDRESS_DOMAIN= 'utdallas.edu'

  2. Artisan command to add the DOI to existing publications:

Description:
Search the DOI to add it to the existing publications for the profiles with the first letter of their last name given.

Usage:
profiles:add-doi <starting_character>

Arguments:
starting_character - The first letter of the last name of the profiles to run command for. Not case-sensitive.

Example: php artisan profiles:add-doi "d" or php artisan profiles:add-doi "D"

betsyecastro and others added 30 commits September 30, 2022 14:26
@betsyecastro
Lists the publications from Academics Analytics in a modal in the pub…
5fa4a40 
…lications edit view
@betsyecastro
Renders academics analytics publications in a modal through a livewir…
23f9482 
…e component when a button is clicked
@betsyecastro
Adds pagination feature to publications listed on modal
1f2604a
@betsyecastro
Error when attempting to render collection from livewire view
c62eff4
@wunc
AA: rename from academics to academic
1b9574c
@wunc
AA: working modal show event
2e2f577
@wunc
AA: caches aa_publications
0f42081
@wunc
Style: fixes indentation
6c859bb
@wunc
AA: records as new instances
c26c27c
@wunc
AA: pub data as data-attributes
0a80a2b 
so we can more easily read them via JS
@betsyecastro
Merging into develop
ba0d8cd
@betsyecastro
Merging into local branch
2bc50f2
@betsyecastro
Imports publications to the editor
69146d4
@betsyecastro
Rearranges selectors with data for JS functionality and applies some …
edbd731 
…style improvments on the publications table
@betsyecastro
Applies a couple of additional style improvments
07b5bbb
@betsyecastro
Adds all publications to editor
3047962
@betsyecastro
Fixes Select All button style
b5b0bcd
@betsyecastro
Merge branch 'develop' of github.com:utdal/profiles into develop
d80d5fa
@betsyecastro
Fixes iteration over publications object when selecting all
62acf73
@betsyecastro
Fixes Select All button style
ca43f3b
@betsyecastro
Merge branch 'develop' of github.com:utdal/profiles into develop
81e7f80
@betsyecastro
Artisan command to search and add DOI to existing publications
18cd941
@betsyecastro
Fixes profiles_count variable
fb8ab8c
@betsyecastro
Adds job for adding doi to existing publications
1e99e76
@betsyecastro
Merge branch 'develop' of github.com:utdal/profiles into develop
5c8081e
@betsyecastro
Moves function searchPublicationByTitlonAndYear to Profile model and …
26d2d2e 
…documents cachedAAPublications
@betsyecastro
Removes job for adding DOI to existing publications
c2f81ec
@betsyecastro
Fixes syntax errors in app/Console/Commands/AddDoiToExistingPublicati…
2b86d10 
…ons.php
@betsyecastro
Removes console message left by mistake from app/Console/Commands/Add…
c777439 
…DoiToExistingPublications.php
@betsyecastro
Refactoring to improve memory usage when running add-doi artisan command
cdde980
@betsyecastro betsyecastro mentioned this pull request Feb 22, 2023
Closed
betsyecastro and others added 10 commits February 22, 2023 16:31
@betsyecastro
Correction in parameter passed to mocked method
aeb156d
@betsyecastro
Correction in default value of doi regex
15b4cd9
@betsyecastro
Validates status code before attempting to return array response
432ad8a
@betsyecastro
Adds data->academic_analytics_id to profile json object test in API test
816ca98
@betsyecastro
Removes unnecessary AAfactory file
c1fefed
@betsyecastro
Removes unnecessary OrcidApiServiceProvider file
335bd33
@betsyecastro
Fixes Psalm errors
0e17ebd
@betsyecastro
Fixes Psalm errors
567cda4
@betsyecastro
Fixes view for the case of no publications available for import.
a3a167a
@betsyecastro @wunc
Fixes variable type returned by getPublications method which caused a…
eaea6ca 
… Psalm error

Method returns a ProfileData Illuminate\Database\Eloquent\Collection, rather than an empty collection.

Psalm error: ERROR: InvalidArgument - app/Providers/AAPublicationsApiServiceProvider.php:75:37 - Argument 1 of Illuminate\Database\Eloquent\Collection::push expects empty, App\ProfileData&static provided (see https://psalm.dev/004)                $publications->push($new_record);

Solution: Define type items in the collection by adding:
/** @var Collection<ProfileData> */

Co-Authored-By: Wun Chiou <[email protected]>
@betsyecastro betsyecastro requested a review from wunc March 3, 2023 14:18
@betsyecastro
Copy link
Contributor Author

Local configuration required to test the feature:

Add the following values to the .env file:
DOI_REGEX = '/(10[.][0-9]{4,}[^\s"\/<>]*/[^\s"<>]+)/'
EMAIL_ADDRESS_DOMAIN= 'utdallas.edu'

Artisan command to add the DOI to existing publications:

Description:
Search the DOI to add it to the existing publications for the profiles with the first letter of their last name given.

Usage:
profiles:add-doi <starting_character>

Arguments:
starting_character - The first letter of the last name of the profiles to run command for. Not case-sensitive.

Example: php artisan profiles:add-doi "d" or php artisan profiles:add-doi "D"

@betsyecastro betsyecastro added the ✨ enhancement New feature or request label Mar 10, 2023
@betsyecastro betsyecastro self-assigned this Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wunc wunc Awaiting requested review from wunc

Assignees

@betsyecastro betsyecastro

Labels
✨ enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@betsyecastro @wunc