ojra 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 211acd3d634f9e9ddaf06dbcb9a4847abe24adf330be05813b42bc60ed0d81dd
+  data.tar.gz: 74ecc2f3d61f90151fb4991d484831d1ba34c6ac83d8a4866022305298f8250e
+SHA512:
+  metadata.gz: dbe9d37a5f02685aa4638e9f35520d7045e814e9d20b774b8d0ca53043b0b52185b5d0e5e372d6e0364def85846b05724a34823f2fdd3e903cb9034619980a71
+  data.tar.gz: f65c8b13a8063d052a7d4d853fe10b741949c8ae466263264f993592c4bf4ff9e315dd192ac2004719f97b2c49866571679bf99006845b7ad45d4561e9b953bb

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    ojra (1.0.1)
+      faraday (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    faraday (2.7.3)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ojra!
+  rake (~> 13.0.6)
+  rspec (~> 3.12)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Juanjo Bazán
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# OJRA: Open Journals Reviewers API
+
+A Ruby wrapper for the Open Journal's Reviewers application's API
+
+## Use
+
+### Installation
+
+Install OJRA running:
+
+```
+gem install ojra
+```
+
+Or adding the gem to your project's `Gemfile`:
+```ruby
+gem "ojra"
+```
+
+### Authentication
+
+Initialize the API Client class with the URL of the Reviewers site and a valid API token:
+
+```ruby
+  require "ojra"
+
+  client = OJRA::Client("https://reviewers-app.url", "secretTOKEN1234")
+```
+
+### Available methods
+
+**STATS:**
+
+
+ - **assign_reviewer(reviewer, issue_id)**: Add a new active review to a reviewers' stats
+ ```ruby
+    client.assign_reviewer("reviewer21", 4321)
+ ```
+
+ - **assign_reviewers(reviewers_list, issue_id)**: Add a new active review to a list of reviewers (array or comma separated string)
+ ```ruby
+    client.assign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
+    client.assign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
+ ```
+
+
+ - **unassign_reviewer(reviewer, issue_id)**: Log end of review for a reviewer
+ ```ruby
+    client.unassign_reviewer("@reviewer21", 4321)
+ ```
+
+
+ - **unassign_reviewers(reviewers_list, issue_id)**: Log end of review for a list of reviewers (array or comma separated string)
+ ```ruby
+    client.unassign_reviewers("@reviewer21, @reviewer33, @reviewer42", 4321)
+    client.unassign_reviewers(["reviewer21", "reviewer33", "reviewer42"], 4321)
+ ```
+

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/ojra/client.rb

@@ -0,0 +1,77 @@
+require 'faraday'
+
+module OJRA
+  class Client
+    attr_reader :host_url, :token, :error_msg
+
+    def initialize(host_url, token)
+      @host_url = host_url.to_s.strip
+      @token = token.to_s.strip
+      @error_msg = nil
+    end
+
+    def configured?
+      !(host_url.empty? || token.empty?)
+    end
+
+    def assign_reviewer(reviewer, issue_id)
+      set_error_msg("Missing value: reviewer") and return if reviewer.to_s.strip.empty?
+
+      url = "#{host_url}/api/stats/update/#{reviewer}/review_assigned"
+      idempotency_key = "assign-#{reviewer}-#{issue_id}"
+
+      reviewers_api_post(url, { idempotency_key: idempotency_key })
+    end
+
+    def unassign_reviewer(reviewer, issue_id)
+      set_error_msg("Missing value: reviewer") and return if reviewer.to_s.strip.empty?
+
+      url = "#{host_url}/api/stats/update/#{reviewer}/review_unassigned"
+      idempotency_key = "unassign-#{reviewer}-#{issue_id}"
+
+      reviewers_api_post(url, { idempotency_key: idempotency_key })
+    end
+
+    def assign_reviewers(reviewers, issue_id)
+      reviewers_list = get_list(reviewers)
+      reviewers_list.each { |reviewer| assign_reviewer(reviewer, issue_id) }
+    end
+
+    def unassign_reviewers(reviewers, issue_id)
+      reviewers_list = get_list(reviewers)
+      reviewers_list.each { |reviewer| unassign_reviewer(reviewer, issue_id) }
+    end
+
+    private
+
+    def unconfigured_api
+      raise UnconfiguredAPI.new("Missing configuration values for the API: host's URL and/or API Token")
+    end
+
+    def set_error_msg(message)
+      @error_msg = message
+    end
+
+    def get_list(items)
+      items_list = []
+      if items.is_a?(String)
+        items_list = items.split(',').each(&:strip!)
+      elsif items.is_a?(Array)
+        items_list = items.each(&:strip!)
+      end
+      items_list
+    end
+
+    def reviewers_api_post(url, params)
+      unconfigured_api unless configured?
+
+      response = Faraday.post(url, params, { "TOKEN" => token })
+
+      if response.status.between?(400, 599)
+        set_error_msg("Error response code: #{response.status}")
+      end
+
+      response.status.between?(200, 299)
+    end
+  end
+end

data/lib/ojra/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OJRA
+  VERSION = "1.0.1"
+end

data/lib/ojra.rb

@@ -0,0 +1,7 @@
+require_relative "ojra/client"
+require_relative "ojra/version"
+
+module OJRA
+  class Error < StandardError; end
+  class UnconfiguredAPI < Error; end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ojra
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Juanjo Bazán
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Ruby wrapper for the Open Journal's Reviewers application's API
+email:
+- jjbazan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ojra.rb
+- lib/ojra/client.rb
+- lib/ojra/version.rb
+homepage: http://github.com/xuanxu/ojra
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/xuanxu/ojra
+  source_code_uri: http://github.com/xuanxu/ojra
+  bug_tracker_uri: https://github.com/xuanxu/ojra/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Wrapper for the Open Journal's Reviewers API
+test_files: []