5325 no header tab download

doc/sphinx-guides/source/api/dataaccess.rst

@@ -39,6 +39,18 @@ subset          Column-wise subsetting. You must also supply a comma separated l
 
 ---------------------------
 
+``noVarHeader``
+
+(supported for tabular data files only; ignored for all other file types)
+
+==============  ===========
+Value           Description
+==============  ===========
+true|1          Tab-delimited data file, without the variable name header (added to tab. files by default)
+==============  ===========
+
+---------------------------
+
 ``imageThumb``
 
 the following parameter values are supported (for image and pdf files only): 

src/main/java/edu/harvard/iq/dataverse/api/Access.java

@@ -294,12 +294,13 @@ public DownloadInstance datafile(@PathParam("fileId") String fileId, @QueryParam
         }
         for (String key : uriInfo.getQueryParameters().keySet()) {
             String value = uriInfo.getQueryParameters().getFirst(key);
-
+            logger.fine("is download service supported? key="+key+", value="+value);
+
             if (downloadInstance.checkIfServiceSupportedAndSetConverter(key, value)) {
-                logger.fine("is download service supported? key="+key+", value="+value);
                 // this automatically sets the conversion parameters in 
                 // the download instance to key and value;
                 // TODO: I should probably set these explicitly instead. 
+                logger.fine("yes!");
 
                 if (downloadInstance.getConversionParam().equals("subset")) {
                     String subsetParam = downloadInstance.getConversionParamValue();

src/main/java/edu/harvard/iq/dataverse/api/DownloadInstance.java

@@ -93,13 +93,22 @@ public Boolean checkIfServiceSupportedAndSetConverter(String serviceArg, String
 
         for (OptionalAccessService dataService : servicesAvailable) {
             if (dataService != null) {
-                // Special case for the subsetting parameter (variables=<LIST>):
                 if (serviceArg.equals("variables")) {
+                    // Special case for the subsetting parameter (variables=<LIST>):
                     if ("subset".equals(dataService.getServiceName())) {
                         conversionParam = "subset";
                         conversionParamValue = serviceArgValue; 
                         return true; 
                     }
+                } else if (serviceArg.equals("noVarHeader")) {
+                    // Another special case available for tabular ("subsettable") data files - 
+                    // "do not add variable header" flag:
+                    if ("true".equalsIgnoreCase(serviceArgValue) || "1".equalsIgnoreCase(serviceArgValue)) {
+                        if ("subset".equals(dataService.getServiceName())) {
+                            this.conversionParam = serviceArg;
+                            return true;
+                        }
+                    }
                 } else if ("imageThumb".equals(serviceArg)) {
                     if ("true".equals(serviceArgValue)) {
                         this.conversionParam = serviceArg;

src/test/java/edu/harvard/iq/dataverse/api/AccessIT.java

@@ -60,6 +60,10 @@ public class AccessIT {
     public static String tabFile3NameRestrictedConvert;
     public static String tabFile4NameUnpublishedConvert;
 
+    public static int tabFile1SizeOriginal = 279;
+    public static int tabFile1SizeConverted = 4;
+    public static int tabFile1SizeConvertedWithVarHeader = 9; 
+
     @BeforeClass
     public static void setUp() throws InterruptedException {
         RestAssured.baseURI = UtilIT.getRestAssuredBaseUri();
@@ -150,12 +154,19 @@ public void testDownloadSingleFile() {
         //Not logged in non-restricted
         Response anonDownloadOriginal = UtilIT.downloadFileOriginal(tabFile1Id);
         Response anonDownloadConverted = UtilIT.downloadFile(tabFile1Id);
+        // ... and download the same tabular data file, but without the variable name header added:
+        Response anonDownloadTabularNoHeader = UtilIT.downloadTabularFileNoVarHeader(tabFile1Id);
         assertEquals(OK.getStatusCode(), anonDownloadOriginal.getStatusCode());
-        assertEquals(OK.getStatusCode(), anonDownloadConverted.getStatusCode()); //just to ensure next test
+        assertEquals(OK.getStatusCode(), anonDownloadConverted.getStatusCode());
+        assertEquals(OK.getStatusCode(), anonDownloadTabularNoHeader.getStatusCode());
         int origSizeAnon = anonDownloadOriginal.getBody().asByteArray().length;
         int convertSizeAnon = anonDownloadConverted.getBody().asByteArray().length;
-        System.out.println("origSize: "+origSizeAnon + " | convertSize: " + convertSizeAnon);
-        assertThat(origSizeAnon, is(not(convertSizeAnon)));
+        int tabularSizeNoVarHeader = anonDownloadTabularNoHeader.getBody().asByteArray().length;
+        System.out.println("origSize: "+origSizeAnon + " | convertSize: " + convertSizeAnon + " | convertNoHeaderSize: " + tabularSizeNoVarHeader);
+
+        assertEquals(origSizeAnon, tabFile1SizeOriginal);
+        assertEquals(convertSizeAnon, tabFile1SizeConvertedWithVarHeader);        
+        assertEquals(tabularSizeNoVarHeader, tabFile1SizeConverted);
 
         //Not logged in restricted
         Response anonDownloadOriginalRestricted = UtilIT.downloadFileOriginal(tabFile3IdRestricted);
@@ -178,7 +189,7 @@ public void testDownloadSingleFile() {
         int convertSizeAuth = authDownloadConverted.getBody().asByteArray().length;
         System.out.println("origSize: "+origSizeAuth + " | convertSize: " + convertSizeAuth);
         assertThat(origSizeAuth, is(not(convertSizeAuth)));  
-
+                
         //Logged in restricted
         Response authDownloadOriginalRestricted = UtilIT.downloadFileOriginal(tabFile3IdRestricted, apiToken);
         Response authDownloadConvertedRestricted = UtilIT.downloadFile(tabFile3IdRestricted, apiToken);

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

@@ -593,6 +593,11 @@ static Response downloadFileOriginal(Integer fileId) {
                 .get("/api/access/datafile/" + fileId + "?format=original");
     }
 
+    static Response downloadTabularFileNoVarHeader(Integer fileId) {
+        return given()
+                .get("/api/access/datafile/" + fileId + "?noVarHeader=true");
+    }
+
     static Response downloadFileOriginal(Integer fileId, String apiToken) {
         return given()
                 .get("/api/access/datafile/" + fileId + "?format=original&key=" + apiToken);