Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 3.21 KB

reviewers.md

File metadata and controls

68 lines (40 loc) · 3.21 KB
Raw

Reviewers Application

Reviewers is a Ruby on Rails application to manage a database of a journal's reviewers. Users can volunteer to review by signing into the site and filling their profile information. Editors can search for reviewers and provide feedback on them.

The Reviewers instance used for JOSS is deployed in Heroku and configured for the JOSS editors team at GitHub. Its API is also used by the editorial bot to sync data for reviewers activity when reviews start and end.

URL

https://reviewers.joss.theoj.org

Source code

The source code can be found here: https://github.com/openjournals/reviewers

Configuration

Multiple elements are needed to configure the application:

GitHub OAuth application

Users log in the Reviewers app using their GitHub identifier. In order for the authentication to work, an OAuth application created at GitHub is needed. It should be configured to receive requests from the reviewers app and the authorization callback URL should be <REVIEWERS_APP_URL>/auth/github/callback

ORCID OAuth application

Users can add their ORCID identifier to their profile. An OAuth application created at orcid.org is needed. It should be configured to receive requests from the reviewers app and the valid redirect URI should include <REVIEWERS_APP_URL>/auth/orcid/callback

The same application used for authenticating into JOSS is used here, just by adding the new callback URL for the Reviewers application.

Enviroment variables

For the GitHub authentication to work, once the GitHub OAuth app is created, two ENV VARs are needed to store the cliend_id and secret:

  • REVIEWERS_GH_CLIENT_ID
  • REVIEWERS_GH_CLIENT_SECRET

To assign ORCID identifiers to users the app uses the ORCID OAuth application client_id and secret:

  • REVIEWERS_ORCID_CLIENT_ID
  • REVIEWERS_ORCID_CLIENT_SECRET

For the API to work:

  • REVIEWERS_API_TOKEN: A random string that will be used by the bot to authenticate when calling the Reviewers app API

To recognize editors there is an editors Rake task (that is run hourly) defined in the lib/tasks/editors.rake file and that uses two variables:

  • REVIEWERS_EDITOR_TEAM_ID: The id of the GitHub team with the list of editors
  • REVIEWERS_GH_TOKEN: The GitHub token to be able to use the GitHub API

To configure links to the journal owning the reviewers database there are three env variables available. These variables are optional as values can also be set in the settings file. If present the value in the ENV VAR will take precedence over the one in the config file.

  • JOURNAL_NAME: The name of the journal
  • JOURNAL_ALIAS: The short name for the journal
  • JOURNAL_URL: The URL of the journals' site

Settings file

There is a YAML file located in config\reviewers_settings.yml where some configuration options are defined:

  all_reviews_url_template: "https://joss.theoj.org/papers/reviewed_by/{{github}}"
  active_reviews_url_template: "https://github.com/openjournals/joss-reviews/issues?q=is:issue+is:open+label:review+mentions:{{github}}"
  journal:
    name: The Journal of Open Source Software
    alias: JOSS
    url: https://joss.theoj.org