Merge pull request openjournals#88 from openjournals/validate-archive-doi

New responder to validate archive DOIs

Author: xuanxu

app/responders/openjournals/set_archive_responder.rb

@@ -0,0 +1,48 @@
+require_relative '../../lib/responder'
+require 'uri'
+require 'faraday'
+
+
+module Openjournals
+  class SetArchiveResponder < Responder
+    keyname :openjournals_set_archive
+
+    def define_listening
+      @event_action = "issue_comment.created"
+      @event_regex = /\A@#{bot_name} set (.*) as archive\.?\s*$/i
+    end
+
+    def process_message(message)
+      new_value = @match_data[1]
+      new_value = new_value.gsub("https://doi.org/", "")
+
+      ok_reply = "Done! archive is now [#{new_value}](https://doi.org/#{new_value})"
+      nok_reply = "Error: `archive` not found in the issue's body"
+
+      if valid_doi_value?(new_value)
+        reply = update_value("archive", new_value) ? ok_reply : nok_reply
+      else
+        reply = "That doesn't look like a valid DOI value"
+      end
+      respond(reply)
+    end
+
+    def valid_doi_value?(archive_value)
+      escaped_archive_value = archive_value.gsub("<", "%3C").gsub(">", "%3E").gsub("[", "%5B").gsub("]", "%5D")
+      doi_url = URI.join("https://doi.org", escaped_archive_value).to_s
+
+      status_code = Faraday.head(doi_url).status
+      return [301, 302].include?(status_code)
+    rescue
+      return false
+    end
+
+    def default_description
+      "Set a value for the archive DOI"
+    end
+
+    def default_example_invocation
+      "@#{bot_name} set set 10.5281/zenodo.6861996 as archive"
+    end
+  end
+end

config/settings-production.yml

@@ -68,10 +68,6 @@ buffy:
       - version:
           only: editors
           sample_value: "v1.0.0"
-      - archive:
-          only: editors
-          sample_value: "10.21105/zenodo.12345"
-          template_file: set_archive.md
       - branch:
           sample_value: "joss-paper"
       - target-repository:
@@ -87,6 +83,8 @@ buffy:
               id: issue_id
               repository_url: new_value
             silent: true
+    openjournals_set_archive:
+      only: editors
     ping_track_eics:
       only: editors
     external_service:

docs/available_responders.md

@@ -47,6 +47,7 @@ Buffy includes a list of Responders that can be used by configuring them in the
    :maxdepth: 1
 
    responders/openjournals/ping_track_eics
+   responders/openjournals/set_archive
    responders/openjournals/whedon
    responders/openjournals/reviewers_log_review_start
    responders/openjournals/reviewers_log_review_end

docs/images/responders/openjournals/set_archive_1.png

@@ -0,0 +1,46 @@
+OpenJournals :: Set archive
+===========================
+
+This responder can be used to set a valid DOI as the value of the archive field in the body of the issue.
+
+## Listens to
+
+
+```
+@botname set <ARCHIVE-DOI> as archive
+```
+
+where ARCHIVE-DOI is a valid DOI
+
+## Requirements
+
+The body of the issue should have the _archive_ field placeholder marked with HTML comments.
+
+```html
+<!--archive-->  <!--end-archive-->
+```
+
+## Settings key
+
+`openjournals_set_archive`
+
+
+## Examples
+
+```yaml
+...
+
+  responders:
+    openjournals_set_archive:
+      only: editors
+...
+```
+
+## In action
+
+
+![](../../images/responders/openjournals/set_archive_1.png "Set archive responder in action: valid DOI")
+
+* **`DOIs are validated:`**
+
+![](../../images/responders/openjournals/set_archive_2.png "Set archive responder in action: invalid value")

docs/images/responders/openjournals/set_archive_2.png

@@ -0,0 +1,91 @@
+require_relative "../../spec_helper.rb"
+
+describe Openjournals::SetArchiveResponder do
+
+  subject do
+    described_class
+  end
+
+  describe "listening" do
+    before { @responder = subject.new({env: {bot_github_user: "botsci"}}, {}) }
+
+    it "should listen to new comments" do
+      expect(@responder.event_action).to eq("issue_comment.created")
+    end
+
+    it "should define regex" do
+      expect(@responder.event_regex).to match("@botsci set 10.5281/zenodo.6861996 as archive")
+      expect(@responder.event_regex).to match("@botsci set 10.5281/zenodo.6861996 as archive.")
+      expect(@responder.event_regex).to match("@botsci set 10.5281/zenodo.6861996 as archive   \r\n")
+      expect(@responder.event_regex).to match("@botsci set 10.5281/zenodo.6861996 as archive   \r\n more")
+      expect(@responder.event_regex).to_not match("@botsci set 10.5281/zenodo.6861996 as editor")
+      expect(@responder.event_regex).to_not match("@botsci set 10.5281/zenodo.6861996 as archive now")
+    end
+  end
+
+  describe "#process_message" do
+    before do
+      @responder = subject.new({env: {bot_github_user: "botsci"}}, {})
+      disable_github_calls_for(@responder)
+
+      issue_body = "...Archive: <!--archive-->Pending<!--end-archive--> ..."
+      allow(@responder).to receive(:issue_body).and_return(issue_body)
+    end
+
+    describe "with a valid DOI" do
+      before do
+        @msg = "@botsci set 10.5281/zenodo.6861996 as archive"
+        @responder.match_data = @responder.event_regex.match(@msg)
+        expect(Faraday).to receive(:head).with("https://doi.org/10.5281/zenodo.6861996").and_return(double(status: 301))
+      end
+
+      it "should update value in the body of the issue" do
+        expected_new_body = "...Archive: <!--archive-->10.5281/zenodo.6861996<!--end-archive--> ..."
+        expect(@responder).to receive(:update_issue).with({ body: expected_new_body })
+        @responder.process_message(@msg)
+      end
+
+      it "should respond to github" do
+        expect(@responder).to receive(:respond).with("Done! archive is now [10.5281/zenodo.6861996](https://doi.org/10.5281/zenodo.6861996)")
+        @responder.process_message(@msg)
+      end
+    end
+
+    describe "with invalid DOI values" do
+      it "should clean doi.org URLs" do
+        @msg = "@botsci set https://doi.org/10.5281/zenodo.6861996 as archive"
+        @responder.match_data = @responder.event_regex.match(@msg)
+        expect(Faraday).to receive(:head).with("https://doi.org/10.5281/zenodo.6861996").and_return(double(status: 301))
+
+        expected_new_body = "...Archive: <!--archive-->10.5281/zenodo.6861996<!--end-archive--> ..."
+        expect(@responder).to receive(:update_issue).with({ body: expected_new_body })
+        expect(@responder).to receive(:respond).with("Done! archive is now [10.5281/zenodo.6861996](https://doi.org/10.5281/zenodo.6861996)")
+
+        @responder.process_message(@msg)
+      end
+
+      it "should reply error if DOI doesn't resolve" do
+        @msg = "@botsci set https://zenodo.org/invalid.6573452618CX as archive"
+        @responder.match_data = @responder.event_regex.match(@msg)
+
+        expect(Faraday).to receive(:head).with("https://zenodo.org/invalid.6573452618CX").and_return(double(status: 404))
+        expect(@responder).to_not receive(:update_issue)
+        expect(@responder).to receive(:respond).with("That doesn't look like a valid DOI value")
+
+        @responder.process_message(@msg)
+      end
+
+      it "should reply error if malformed URI" do
+        @msg = "@botsci set ' OR 1=1 as archive"
+        @responder.match_data = @responder.event_regex.match(@msg)
+
+        expect(Faraday).to_not receive(:head)
+        expect(@responder).to_not receive(:update_issue)
+        expect(@responder).to receive(:respond).with("That doesn't look like a valid DOI value")
+
+        @responder.process_message(@msg)
+      end
+    end
+  end
+
+end