“As a user, I want to see Scirate ‘Scite!’ counts, so that I have an index of general academic social media statistics for Metriq content.”

vprusso commented 3 years ago

User <-> Web App

User	System (Web app)
1. (User on single submission view)	1. (Displaying homepage)
2.	2. "Scite!" button is displayed blow the submission abstract.
3. User looks at the "Scite!" button to determine if submision contains information from Scirate.	3.
4.	4. IF: The single submission view contains an arXiv URL, a number is displayed next to "Scite!" ELSE: The "Scite!" button is displayed with no number
5. (User sees how many scites there are for submission)	5. (Number of scites for submission displayed on button if applicable.

User <-> REST API

User	System (REST API)
1. Call REST API: GET ./api/submissions:/{uuid}/scites	1.
2. IF `submissionContentUrl` has arXiv prefix (in `Submission.js`) call to Scirate Python client to retrieve scite count. ELSE: Return NULL	2.
3. (Successful call)	3. (Successful response)

Questions:

Can we use this Scirate parser to use the extracted information? Some concerns are:

Our API is Javascript and the parser is in Python. We'd need some way for these to talk to each other.
CSRF may prevent us from obtaining information from a script and then displaying it on our site?

Alternate approach:

Ask Scirate devs if they are able to supply API access to their website to directly extract this information.

Related issues to this story:

trentfridey commented 2 years ago

Hi - I'd like to work on this issue. What do I need to get started?

WrathfulSpatula commented 2 years ago

@trentfridey Sorry it took me so long to respond! We discussed this issue within the team, and I think it lacks sufficient design behind it to make for a good unitaryHACK issue. However, rather than remove the bounty, we've added two new bounties for Metriq as well as keeping the bounty on this issue.

It's a little difficult to advise on how to get started with this issue, because I don't think it's realistically attainable within the constraints of the Hackathon. Reach out to me here or on the Unitary Fund Discord server if you'd still like to give it a shot, but #558 was meant to the replace this issue, as an easier bounty, and maybe you'd like to look there. I can advise on that other ticket, too, if you're interested!

unitaryfund / metriq-app