Add support for GitHub Tagged Releases; (DOECODE-789)

Author: Tim Sowers

src/main/java/gov/osti/connectors/GitHub.java

@@ -102,9 +102,9 @@ private static String getProjectFromUrl(String url) {
 
                     if(matcher.find()) {
                         return matcher.group(1);
+                    }
                 }
             }
-            }
         } catch ( URISyntaxException e ) {
             // warn that URL is not a valid URI
             log.warn("Not a valid URI: " + url + " message: " + e.getMessage());
@@ -116,6 +116,27 @@ private static String getProjectFromUrl(String url) {
         return null;
     }
 
+    /**
+     * Attempt to identify the TAG NAME from the given URL.  
+     * 
+     * Criteria:  URL host should contain "github.com"
+     * 
+     * @param url the URL to process
+     * @return the TAG NAME if able to parse; null if not, or unrecognized URL
+     */
+    public static String getTagFromUrl(String url) {
+        String tag = null;
+        
+        Pattern pattern = Pattern.compile("github[.]com.*\\/releases\\/tag\\/(.*)");
+        Matcher matcher = pattern.matcher(url);
+
+        if(matcher.find()) {
+            tag = matcher.group(1);
+        }
+
+        return tag;
+    }
+    
     /**
      * Obtain the connection-driven metadata elements from GitHub public API
      * requests.
@@ -213,4 +234,39 @@ public JsonNode read(String url) {
         return null;
     }
 
+    /**
+     * Determine if tag reference exists in the repo
+     * 
+     * @param url the URL to process
+     * 
+     * @return a JsonElement of the DOECodeMetadata filled in as possible from
+     * the API
+     */
+    public static boolean isTagReferenceAndValid(String url) {
+        try {
+            // try to identify the NAME of the project
+            String name = getProjectFromUrl(url);
+            if (null==name)
+                return false;
+
+            // try to identify the TAG of the project
+            String tag = getTagFromUrl(url);
+            if (null==tag)
+                return false;
+
+            // acquire the GitHub API response as JSON
+            HttpGet get = gitHubAPIGet(GITHUB_BASE_URL + name + "/git/ref/tags/" + tag);
+            
+            return !(HttpUtil.fetch(get) == "");
+        } catch ( IOException e ) {
+            // here's where you'd warn about the IO error
+            log.warn("IO Error reading GitHub information: " + e.getMessage());
+            log.warn("Read from " + url);
+        }
+
+        // unable to process this one
+        return false;
+        
+    }
+    
 }

src/main/java/gov/osti/services/Metadata.java

@@ -2391,7 +2391,7 @@ else if (m.getLicenses().contains(DOECodeMetadata.License.Other.value()) && Stri
                 reasons.add("A valid Landing Page URL is required for non-open source submissions.");
         }
         // if repository link is present, and not CO, it needs to be valid too
-        if (StringUtils.isNotBlank(m.getRepositoryLink()) && !DOECodeMetadata.Accessibility.CO.equals(m.getAccessibility()) && !Validation.isValidRepositoryLink(m.getRepositoryLink()))
+        if (StringUtils.isNotBlank(m.getRepositoryLink()) && !DOECodeMetadata.Accessibility.CO.equals(m.getAccessibility()) && !GitHub.isTagReferenceAndValid(m.getRepositoryLink()) && !Validation.isValidRepositoryLink(m.getRepositoryLink()))
             reasons.add("Repository URL is not a valid repository.");
 
         return reasons;

src/main/java/gov/osti/services/Validation.java

@@ -14,6 +14,7 @@
 import gov.osti.listeners.DoeServletContextListener;
 import gov.osti.repository.GitRepository;
 import gov.osti.repository.SubversionRepository;
+import gov.osti.connectors.GitHub;
 import java.io.IOException;
 import java.io.Serializable;
 import java.net.URLEncoder;
@@ -118,6 +119,7 @@ private static class ValidationRequest implements Serializable {
         private String type;
         private String value;
         private String error;
+        private String extraInfo;
 
         /**
          * @return the type
@@ -160,6 +162,20 @@ public String getError() {
         public void setError(String error) {
             this.error = error;
         }
+
+        /**
+         * @return the value
+         */
+        public String getExtraInfo() {
+            return extraInfo;
+        }
+
+        /**
+         * @param info the value to set
+         */
+        public void setExtraInfo(String info) {
+            this.extraInfo = info;
+        }
     }
 
     /** 
@@ -501,9 +517,19 @@ public Response checkEmail(@QueryParam("value") String value) {
     @Produces (MediaType.APPLICATION_JSON)
     @Path ("/repositorylink")
     public Response checkRepositoryLink(@QueryParam("value") String value) {
-        return ( isValidRepositoryLink(value) ) ?
-                Response.ok().entity(mapper.createObjectNode().put("value", "OK").toString()).build() :
-                ErrorResponse.badRequest(generateURLErrorMsg(value, "repositorylink")).build();
+        // is link a tag URL, or valid Repo
+        String tag = GitHub.getTagFromUrl(value);
+
+        if (tag != null && GitHub.isTagReferenceAndValid(value))
+            return Response.ok().entity(mapper.createObjectNode()
+                .put("value", "OK").put("isTaggedVersion", true)
+                .put("isTaggedVersion", true)
+                .put("tagName", tag)
+                .toString()).build();
+        else if (isValidRepositoryLink(value))
+            return Response.ok().entity(mapper.createObjectNode().put("value", "OK").toString()).build();
+        else
+            return ErrorResponse.badRequest(generateURLErrorMsg(value, "repositorylink")).build();
     }
 
     /**
@@ -565,7 +591,11 @@ public Response request(String object) throws IOException {
                 if (StringUtils.equalsIgnoreCase(req.getType(), "doi")) {
                     req.setError((isValidDoi(req.getValue()) ? "" : req.getValue() + " is not a valid DOI."));
                 } else if (StringUtils.equalsIgnoreCase(req.getType(), "repositorylink")) {
-                     req.setError(isValidRepositoryLink(req.getValue()) ? "" : generateURLErrorMsg(req.getValue(), req.getType()));
+                    String value = req.getValue();
+                    // is link a tag URL, or valid Repo
+                    String tag = GitHub.getTagFromUrl(value);
+                    req.setError(GitHub.isTagReferenceAndValid(value) || isValidRepositoryLink(value) ? "" : generateURLErrorMsg(value, req.getType()));
+                    req.setExtraInfo(tag);
                 } else if (StringUtils.equalsIgnoreCase(req.getType(), "phonenumber")) {
                     req.setError((isValidPhoneNumber(req.getValue()) ? "" : req.getValue() + " is not a valid phone number."));
                 } else if (StringUtils.equalsIgnoreCase(req.getType(), "url")) {