Standardizing "R" on "Repository URL" across Apps.

Author: Tim Sowers

src/main/java/gov/osti/connectors/README.md

@@ -1,73 +1,73 @@
-# API Connectors
-
-These are the currently-supported repositories from which the API will attempt
-to pre-populate information it can glean given the project URL.  Currently the
-information obtained is somewhat sparse, as this is intended to provoke 
-discussion on what elements of metadata we should map to DOE CODE's schema.
-
-If any of these sources should have a "metadata.yml" file checked-in on the
-master branch, project root level, the Connector will attempt to read from and
-parse its information instead of calling various API methods to fill in the
-metadata information.
-
-## GitHub
-
-Given the GitHub repository URL, the following information is obtained (provided
-the project has such filled-in):
-* Software Title ("Full Name")
-* Acronym ("Name")
-* Description
-* Developers Listing ("Contributors")
-  * First/Last Name
-  * Email
-  * Affiliations ("Company") if provided
-
-## SourceForge
-
-From SourceForge's available API, the following is mapped:
-* Software Title ("Name")
-* Acronym ("Short Name")
-* Description
-* License (concatenating multiple SF licenses, if provided)
-* Developers (first and last name)
-
-## BitBucket
-
-BitBucket API maps elements:
-* Software Title ("Full Name")
-* Acronym ("Name")
-* Developers
-  * If a "team" is found, iterate through each team member; if a single user/
-    Owner, take that as the sole developer
-  * First/Last Name
-
-# ConnectorFactory instantiation
-
-These connector instances should each implement the ConnectorInterface interface
-in order to be added to a ConnectorFactory instantiation.  The interface defines
-only two methods:
-
-``` java
-  init() throws IOException
-```
-
-  Initialize the Connector, if necessary, throwing IOException on errors
-
-``` java
-  read(String url)
-```
-
-  Attempt to load Metadata information from the given URL, if recognized. If not,
-  or unable to do so, return null.
-
-In order to use the Factory, one should acquire an instance, and add each desired Connector to it:
-
-``` java
-  ConnectorFactory factory = ConnectorFactory.getInstance()
-                             .add(new GitHub())
-                             .add(new SourceForge())
-                             .build();
-```
-
-Simply call the `factory.read(String)` method to obtain any JSON metadata if possible.
-Note this may return null if not recognized.
+# API Connectors
+
+These are the currently-supported repositories from which the API will attempt
+to pre-populate information it can glean given the project URL.  Currently the
+information obtained is somewhat sparse, as this is intended to provoke 
+discussion on what elements of metadata we should map to DOE CODE's schema.
+
+If any of these sources should have a "metadata.yml" file checked-in on the
+master branch, project root level, the Connector will attempt to read from and
+parse its information instead of calling various API methods to fill in the
+metadata information.
+
+## GitHub
+
+Given the GitHub Repository URL, the following information is obtained (provided
+the project has such filled-in):
+* Software Title ("Full Name")
+* Acronym ("Name")
+* Description
+* Developers Listing ("Contributors")
+  * First/Last Name
+  * Email
+  * Affiliations ("Company") if provided
+
+## SourceForge
+
+From SourceForge's available API, the following is mapped:
+* Software Title ("Name")
+* Acronym ("Short Name")
+* Description
+* License (concatenating multiple SF licenses, if provided)
+* Developers (first and last name)
+
+## BitBucket
+
+BitBucket API maps elements:
+* Software Title ("Full Name")
+* Acronym ("Name")
+* Developers
+  * If a "team" is found, iterate through each team member; if a single user/
+    Owner, take that as the sole developer
+  * First/Last Name
+
+# ConnectorFactory instantiation
+
+These connector instances should each implement the ConnectorInterface interface
+in order to be added to a ConnectorFactory instantiation.  The interface defines
+only two methods:
+
+``` java
+  init() throws IOException
+```
+
+  Initialize the Connector, if necessary, throwing IOException on errors
+
+``` java
+  read(String url)
+```
+
+  Attempt to load Metadata information from the given URL, if recognized. If not,
+  or unable to do so, return null.
+
+In order to use the Factory, one should acquire an instance, and add each desired Connector to it:
+
+``` java
+  ConnectorFactory factory = ConnectorFactory.getInstance()
+                             .add(new GitHub())
+                             .add(new SourceForge())
+                             .build();
+```
+
+Simply call the `factory.read(String)` method to obtain any JSON metadata if possible.
+Note this may return null if not recognized.

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

@@ -152,7 +152,7 @@ not used to mint information until submitted or announced with metadata successf
 
 `GET /doecodeapi/services/metadata/autopopulate?repo={url}`
 
-Attempt to read information from the given *repository URL* value.  Supports github.com, bitbucket.org, and sourceforge.com. 
+Attempt to read information from the given *Repository URL* value.  Supports github.com, bitbucket.org, and sourceforge.com. 
 Any relevant information from the repository API will be returned in JSON metadata format.
 Mapped repository information varies according to service API-supplied metadata.  Optionally, you may specify
 a query parameter of "format=yaml" to receive YAML file suitable for download.  
@@ -382,7 +382,7 @@ A full JSON example is [provided below](#json_example).
 | code_id | The unique value given to a particular DOE CODE Project record once stored.  Should be *null* or not provided for new entries, and will be returned once a record is saved or submitted successfully. |
 | site_ownership_code | The DOE National Laboratory, DOE Program Office, Field Office, or Major Site/Facility that is submitting the code/software.  This value is determined by the system. |
 | accessibility | This refers to how the source of the project type is accessed; must be one of "OS" (open source), "ON" (open source, not public), or "CS" (closed source, site hosted) |
-| repository_link | If the software project is available via public hosting service, such as github.com, bitbucket.org, etc. the public repository URL should be provided here.  DOE CODE does not currently support the submission of individual branch URL paths, so this must be a primary or base URL for the repository. |
+| repository_link | If the software project is available via public hosting service, such as github.com, bitbucket.org, etc. the public Repository URL should be provided here.  DOE CODE does not currently support the submission of individual branch URL paths, so this must be a primary or base URL for the repository. |
 | landing_page | If the project is not available via open source hosting site, provide a URL describing the project and contact information for obtaining binary or source |
 | developers | An array of Objects, providing information about a project's developers or creators.  Array order determines display order.  Fields are [specified below](#persons_fields). |
 | contributors | An array of information about project contributors.  Array order determines display order.  Fields are [specified below](#persons_fields). Contributors must specify a [type of contribution](#contributor_types) made to the project. |

src/test/java/gov/osti/connectors/SourceForgeTest.java

@@ -1,65 +1,65 @@
-/*
- */
-package gov.osti.connectors;
-
-import org.junit.After;
-import org.junit.AfterClass;
-import org.junit.Before;
-import org.junit.BeforeClass;
-import org.junit.Test;
-import static org.junit.Assert.*;
-
-/**
- * Simple value tests for SourceForge API reader.
- * 
- * @author ensornl
- */
-public class SourceForgeTest {
-    
-    public SourceForgeTest() {
-    }
-    
-    @BeforeClass
-    public static void setUpClass() {
-    }
-    
-    @AfterClass
-    public static void tearDownClass() {
-    }
-    
-    @Before
-    public void setUp() {
-    }
-    
-    @After
-    public void tearDown() {
-    }
-
-    /**
-     * Test extraction of the project name from various SOURCEFORGE repository URLs.
-     */
-    @Test
-    public void testGetProjectNameFromUrl() {
-        // these aren't recognized
-        String[] badvalues = {
-            "/projects/url",
-            "sourceforge.com/projects/me",
-            "https://sourceforge/projects/nope",
-            "",
-            null
-        };
-        
-        for ( String value : badvalues ) {
-            assertNull ("Found acceptable: " + value, SourceForge.getProjectNameFromUrl(value));
-        }
-        
-        assertEquals("arpa project name wrong", "arpa_project_x", SourceForge.getProjectNameFromUrl("https://svn.code.sf.net/p/arpa_project_x/code/trunk"));
-        
-        assertEquals("wrong niceproject", "niceproject", SourceForge.getProjectNameFromUrl("http://svn.code.sf.net/p/niceproject/code"));
-        assertEquals("Not ats", "ats-automatedtestingsystem", SourceForge.getProjectNameFromUrl("https://svn.code.sf.net/p/ats-automatedtestingsystem/code/"));
-        
-        assertEquals("Matcher failed", "doecode", SourceForge.getProjectNameFromUrl("https://sourceforge.net/projects/doecode"));
-        assertEquals("Matcher failed", "doecode", SourceForge.getProjectNameFromUrl("http://sourceforge.net/projects/doecode/"));
-    }
-    
-}
+/*
+ */
+package gov.osti.connectors;
+
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+/**
+ * Simple value tests for SourceForge API reader.
+ * 
+ * @author ensornl
+ */
+public class SourceForgeTest {
+    
+    public SourceForgeTest() {
+    }
+    
+    @BeforeClass
+    public static void setUpClass() {
+    }
+    
+    @AfterClass
+    public static void tearDownClass() {
+    }
+    
+    @Before
+    public void setUp() {
+    }
+    
+    @After
+    public void tearDown() {
+    }
+
+    /**
+     * Test extraction of the project name from various SOURCEFORGE Repository URLs.
+     */
+    @Test
+    public void testGetProjectNameFromUrl() {
+        // these aren't recognized
+        String[] badvalues = {
+            "/projects/url",
+            "sourceforge.com/projects/me",
+            "https://sourceforge/projects/nope",
+            "",
+            null
+        };
+        
+        for ( String value : badvalues ) {
+            assertNull ("Found acceptable: " + value, SourceForge.getProjectNameFromUrl(value));
+        }
+        
+        assertEquals("arpa project name wrong", "arpa_project_x", SourceForge.getProjectNameFromUrl("https://svn.code.sf.net/p/arpa_project_x/code/trunk"));
+        
+        assertEquals("wrong niceproject", "niceproject", SourceForge.getProjectNameFromUrl("http://svn.code.sf.net/p/niceproject/code"));
+        assertEquals("Not ats", "ats-automatedtestingsystem", SourceForge.getProjectNameFromUrl("https://svn.code.sf.net/p/ats-automatedtestingsystem/code/"));
+        
+        assertEquals("Matcher failed", "doecode", SourceForge.getProjectNameFromUrl("https://sourceforge.net/projects/doecode"));
+        assertEquals("Matcher failed", "doecode", SourceForge.getProjectNameFromUrl("http://sourceforge.net/projects/doecode/"));
+    }
+    
+}