Project

ojra

0.0
The project is in a healthy, maintained state
ojraxuanxu/ojraHomepageDocumentationSource CodeBug TrackerWiki
Ruby wrapper for the Open Journal's Reviewers application's API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,092
Stars
0
Forks
0
Watchers
2
 Releases
Current version
1.1.1
Total releases
4
First release
2023-01-17
Latest release
2024-01-30
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-05-11
Reverse Dependencies
0

 Dependencies

Development

rake
~> 13.1
rspec
~> 3.12

Runtime

faraday
~> 2.9
 Project Readme

OJRA: Open Journals Reviewers API

A Ruby wrapper for the Open Journal's Reviewers application's API

Tests Gem Version

Use

Installation

Install OJRA running:

gem install ojra

Or adding the gem to your project's Gemfile:

gem "ojra"

Authentication

Initialize the API Client class with the URL of the Reviewers site and a valid API token:

  require "ojra"

  client = OJRA::Client("https://reviewers-app.url", "secretTOKEN1234")

Available methods

STATS:

  • assign_reviewers(reviewers_list, issue_id): Add a new active review to a reviewer or list of reviewers (array or comma separated string)
   client.assign_reviewers("@reviewer21", 4321)
   client.assign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
   client.assign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
  • unassign_reviewers(reviewers_list, issue_id): Log a review unassignment for a reviewer or list of reviewers (array or comma separated string)
   client.unassign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
   client.unassign_reviewers("@reviewer21", 4321)
   client.unassign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
  • start_review(reviewers_list, issue_id): Log starting a review for a reviewer or list of reviewers (array or comma separated string)
   client.start_review("@reviewer21", 4321)
   client.start_review("@reviewer21, @reviewer33, @reviewer42", 4321)
   client.start_review(["reviewer21", "reviewer33", "reviewer42"], 4321)
  • finish_review(reviewers_list, issue_id): Log end of review for a reviewer or list of reviewers (array or comma separated string)
   client.finish_review("@reviewer21", 4321)
   client.finish_review("@reviewer21, @reviewer33, @reviewer42", 4321)
   client.finish_review(["reviewer21", "reviewer33", "reviewer42"], 4321)