theoj 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09237502c90ed400980274941c03683a2f5b33eaa911debc8b9d50d0747e5a91'
+  data.tar.gz: eb959c2aa0821a45246d3a7551f1fc265c0dc571c9ce791840e7465fc5bb6045
+SHA512:
+  metadata.gz: 877313b88d2739e7076ec44b18e7efe50026f099f0e2a55e95919aa2af8ea8d72edbb35ee4882154c650b79134bbb72cdf2780f26e8daa64d06a7505ecd91e26
+  data.tar.gz: 54b6835727136c213a5339d303000bc6f2ee47e8ae24118a3577c2e70657a36613417397074bf7228ffd66a6b3949df0fd7b91649e06be4ba9bdb3b7664ec5b2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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,4 @@
+# The Open Journal
+A library to manage editorial objects used by the open journals review process
+
+[![CI](https://github.com/xuanxu/theoj/actions/workflows/ci.yml/badge.svg)](https://github.com/xuanxu/theoj/actions/workflows/ci.yml)

data/lib/theoj/author.rb

@@ -0,0 +1,17 @@
+module Theoj
+  class Author
+    attr_accessor :name
+    attr_accessor :orcid
+    attr_accessor :affiliation
+
+    def initialize(name, orcid, affiliation)
+      @name = name
+      @orcid = orcid
+      @affiliation = affiliation
+    end
+
+    def validate_orcid
+    end
+
+  end
+end

data/lib/theoj/git.rb

@@ -0,0 +1,21 @@
+require 'open3'
+require 'fileutils'
+
+module Theoj
+  module Git
+    def clone_repo(url, local_path)
+      url = URI.extract(url.to_s).first
+      return false if url.nil?
+
+      FileUtils.mkdir_p(local_path)
+      stdout, stderr, status = Open3.capture3 "git clone #{url} #{local_path}"
+      status.success?
+    end
+
+    def change_branch(branch, local_path)
+      return true if (branch.nil? || branch.strip.empty?)
+      stdout, stderr, status = Open3.capture3 "git -C #{local_path} checkout #{branch}"
+      status.success?
+    end
+  end
+end

data/lib/theoj/github.rb

@@ -0,0 +1,63 @@
+require "octokit"
+
+# This module includes all the methods involving calls to the GitHub API
+# It reuses a memoized Octokit::Client instance
+module Theoj
+  module GitHub
+
+    # Authenticated Octokit
+    def github_client
+      @github_client ||= Octokit::Client.new(access_token: github_access_token, auto_paginate: true)
+    end
+
+    # GitHub access token
+    def github_access_token
+      @github_access_token ||= ENV["GH_ACCESS_TOKEN"]
+    end
+
+    # GitHub API headers
+    def github_headers
+      @github_headers ||= { "Authorization" => "token #{github_access_token}",
+                            "Content-Type" => "application/json",
+                            "Accept" => "application/vnd.github.v3+json" }
+    end
+
+    # Return an Octokit GitHub Issue
+    def issue(repo, issue_id)
+      @issue ||= github_client.issue(repo, issue_id)
+    end
+
+    # List labels of a GitHub issue
+    def issue_labels(repo, issue_id)
+      github_client.labels_for_issue(repo, issue_id).map { |l| l[:name] }
+    end
+
+    # Uses the GitHub API to determine if a user is already a collaborator of the repo
+    def is_collaborator?(repo, username)
+      username = user_login(username)
+      github_client.collaborator?(repo, username)
+    end
+
+    # Uses the GitHub API to determine if a user is already a collaborator of the repo
+    def can_be_assignee?(repo, username)
+      username = user_login(username)
+      github_client.check_assignee(repo, username)
+    end
+
+    # Uses the GitHub API to determine if a user has a pending invitation
+    def is_invited?(repo, username)
+      username = user_login(username)
+      github_client.repository_invitations(repo).any? { |i| i.invitee.login.downcase == username }
+    end
+
+    # Returns the user login (removes the @ from the username)
+    def user_login(username)
+      username.strip.sub(/^@/, "").downcase
+    end
+
+    # Returns true if the string is a valid GitHub isername (starts with @)
+    def username?(username)
+      username.match?(/\A@/)
+    end
+  end
+end

data/lib/theoj/paper.rb

@@ -0,0 +1,75 @@
+require 'find'
+
+module Theoj
+  class Paper
+    include Theoj::Git
+
+    attr_accessor :review_issue
+    attr_accessor :repository
+    attr_accessor :paper_path
+
+    def initialize(repository, branch, path = nil)
+      @repository = repository
+      @branch = branch
+      find_paper path
+    end
+
+    def find_paper(path)
+      if path.to_s.strip.empty?
+        setup_local_repo
+        @paper_path = Theoj::Paper.find_paper_path(local_path)
+        cleanup
+      else
+        @paper_path = path
+      end
+    end
+
+    def authors
+      []
+    end
+
+    def self.find_paper_path(search_path)
+      paper_path = nil
+
+      if Dir.exist? search_path
+        Find.find(search_path).each do |path|
+          if path =~ /paper\.tex$|paper\.md$/
+            paper_path = path
+            break
+          end
+        end
+      end
+
+      paper_path
+    end
+
+    def self.from_repo(repository, branch = "main")
+      Paper.new(repository, branch, nil)
+    end
+
+    private
+      def setup_local_repo
+        msg_no_repo = "Downloading of the repository failed. Please make sure the URL is correct."
+        msg_no_branch = "Couldn't check the bibtex because branch name is incorrect: #{paper_branch.to_s}"
+
+        error = clone_repo(target_repository, local_path) ? nil : msg_no_repo
+        (error = change_branch(paper_branch, local_path) ? nil : msg_no_branch) unless error
+
+        failure(error) if error
+        error.nil?
+      end
+
+      def local_path
+        @local_path ||= "tmp/#{SecureRandom.hex}"
+      end
+
+      def cleanup
+        FileUtils.rm_rf(local_path) if Dir.exist?(local_path)
+      end
+
+      def failure(msg)
+        cleanup
+        raise(msg)
+      end
+  end
+end

data/lib/theoj/review_issue.rb

@@ -0,0 +1,50 @@
+require "securerandom"
+
+module Theoj
+  class ReviewIssue
+    include Theoj::GitHub
+
+    attr_accessor :issue_id
+    attr_accessor :repository
+    attr_accessor :paper
+    attr_accessor :local_path
+
+    def initialize(repository, issue_id, access_token=nil)
+      @issue_id = issue_id
+      @repository = repository
+      @github_access_token = access_token
+    end
+
+    def issue_body
+      issue(repository, issue_id).body
+    end
+
+    def paper
+    end
+
+    def target_repository
+      @target_repository ||= read_value_from_body("target-repository")
+    end
+
+    def paper_branch
+      @paper_branch ||= read_value_from_body("branch")
+    end
+
+    private
+
+      def read_from_body(start_mark, end_mark)
+        text = ""
+        issue_body.match(/#{start_mark}(.*)#{end_mark}/im) do |m|
+          text = m[1]
+        end
+        text.strip
+      end
+
+      # Read value in issue's body between HTML comments
+      def read_value_from_body(value_name)
+        start_mark = "<!--#{value_name}-->"
+        end_mark = "<!--end-#{value_name}-->"
+        read_from_body(start_mark, end_mark)
+      end
+  end
+end

data/lib/theoj/version.rb

@@ -0,0 +1,3 @@
+module Theoj
+  VERSION = "0.0.1"
+end

data/lib/theoj.rb

@@ -0,0 +1,9 @@
+require_relative "theoj/version"
+require_relative "theoj/git"
+require_relative "theoj/github"
+require_relative "theoj/review_issue"
+require_relative "theoj/paper"
+require_relative "theoj/author"
+
+module Theoj
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: theoj
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Juanjo Bazán
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
+- !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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: A library to manage editorial objects used in the Open Journals' review
+  process
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/theoj.rb
+- lib/theoj/author.rb
+- lib/theoj/git.rb
+- lib/theoj/github.rb
+- lib/theoj/paper.rb
+- lib/theoj/review_issue.rb
+- lib/theoj/version.rb
+homepage: http://github.com/xuanxu/theoj
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/xuanxu/theoj/issues
+  changelog_uri: https://github.com/xuanxu/theoj/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/theoj
+  homepage_uri: http://github.com/xuanxu/theoj
+  source_code_uri: http://github.com/xuanxu/theoj
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Editorial objects used by the Open Journals
+test_files: []