Added options to set metadataLanguages and different PID protocols (#30)

* Add metadatalanguage to Dataset and DatasetFacade, and test it
* Upload files with protocols other than DOI

Author: akos326

src/integration-test/java/com/researchspace/dataverse/http/DatasetOperationsTest.java

@@ -20,6 +20,7 @@
 import java.util.List;
 
 import static com.researchspace.dataverse.entities.facade.DatasetTestFactory.createFacade;
+import static com.researchspace.dataverse.entities.facade.DatasetTestFactory.createFacadeWithMetadataLanguage;
 import static org.junit.Assert.*;
 
 
@@ -38,14 +39,14 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 </pre>
-*/
+ */
 
 public class DatasetOperationsTest extends AbstractIntegrationTest {
-	
+
 	@Before
 	public void setup() throws Exception {
 		super.setUp();
-	}	
+	}
 
 	File exampleDatasetJson = new File("src/integration-test/resources/dataset-create-new-all-default-fields.json");
 	@Test
@@ -117,22 +118,22 @@ public void testPostGetDeleteDataset() throws IOException, InterruptedException,
 		DatasetFacade facade = createFacade();
 		//create a new, unpublished Dataverse
 		String newAlias = RandomStringUtils.randomAlphabetic(10);
-    	DataversePost toCreate = DataverseOperationsTest.createADataverse(newAlias);
-    	DataversePost newDV = dataverseOps.createNewDataverse(dataverseAlias, toCreate).getData();
-		
+		DataversePost toCreate = DataverseOperationsTest.createADataverse(newAlias);
+		DataversePost newDV = dataverseOps.createNewDataverse(dataverseAlias, toCreate).getData();
+
 		// create Dataset in child dataverse
 		Identifier datasetId = dataverseOps.createDataset(facade, newDV.getAlias());
 		assertNotNull(datasetId.getId());
 		assertNotNull(datasetId.getPersistentId());
 		Dataset ds = datasetOps.getDataset(datasetId);
 		String doiId = ds.getDoiId().get();
-		datasetOps.uploadFile(doiId, getTestFile());
-		
+		datasetOps.uploadFile(doiId, getTestFile(), ds.getProtocol());
+
 		//publishing will fail, as parent DV is not published
 		DataverseResponse<PublishedDataset> response = datasetOps.publishDataset (datasetId, Version.MAJOR);
 		assertNull(response.getData());
 		assertNotNull(response.getMessage());
-		
+
 		facade.setTitle("Updated title2");
 		datasetOps.updateDataset(facade, datasetId);
 		List<DatasetVersion> versions = datasetOps.getDatasetVersions(datasetId);
@@ -141,7 +142,23 @@ public void testPostGetDeleteDataset() throws IOException, InterruptedException,
 		String msg = datasetOps.deleteDataset(datasetId).getMessage();
 		dataverseOps.deleteDataverse(newAlias);
 		assertNotNull(msg);
-		
+
+	}
+
+	@Test
+	public void testCreateDatasetWithMetadataLanguage() {
+		DatasetFacade facade = createFacadeWithMetadataLanguage();
+		Identifier datasetId = dataverseOps.createDataset(facade, dataverseAlias);
+		assertNotNull(datasetId.getId());
+		assertNotNull(datasetId.getPersistentId());
+	}
+
+	@Test
+	public void testUploadFile() {
+		DatasetFacade facade = createFacadeWithMetadataLanguage();
+		Identifier datasetId = dataverseOps.createDataset(facade, dataverseAlias);
+		Dataset ds = datasetOps.getDataset(datasetId);
+		datasetOps.uploadFile(ds.getDoiId().get(), getTestFile(), ds.getProtocol());
 	}
 
 	private File getTestFile() {

src/main/java/com/researchspace/dataverse/api/v1/DatasetOperations.java

@@ -83,7 +83,7 @@ DatasetFileList uploadNativeFile(InputStream data, long contentLength, FileUploa
 	 * @param doi The DOI of the  Dataset
 	 * @param file The file to add to the DataSet
 	 */
-	void uploadFile(String doi, File file);
+	void uploadFile(String doi, File file, String protocol);
 
 	/**
 	 * Uploads a file using a data stream.
@@ -92,7 +92,7 @@ DatasetFileList uploadNativeFile(InputStream data, long contentLength, FileUploa
 	 * @param inputStream Stream of data to upload as a file in Dataverse.
 	 * @param filename Contents of the field "name" that will appear as in Dataverse.
 	 */
-	void uploadFile(String doi, InputStream inputStream, String filename);
+	void uploadFile(String doi, InputStream inputStream, String filename, String protocol);
 
 	/**
 	 * Deletes a {@link Dataset}  

src/main/java/com/researchspace/dataverse/entities/Dataset.java

@@ -33,9 +33,10 @@ public class Dataset {
 	private Long id;
 	private String identifier, protocol, authority;
 	private URL persistentUrl;
+	private String metadataLanguage;
 
 	/**
-	 * Getter for the DOI String used to identify a dataset for SWORD upload
+	 * Getter for the DOI String or other persistent identifier used to identify a dataset for SWORD upload
 	 * @return an {@link Optional}. Will be <code>null</code> if <code>persistentURL</code> is not set.
 	 */
 	public Optional<String> getDoiId (){

src/main/java/com/researchspace/dataverse/entities/facade/DatasetBuilder.java

@@ -84,6 +84,10 @@ public Dataset build(DatasetFacade facade) {
 		citation.setFields(fields);
 		Dataset toSubmit = new Dataset();
 		toSubmit.setDatasetVersion(dv);
+		String metadataLanguage = facade.getMetadataLanguage();
+		if (metadataLanguage != null) {
+			toSubmit.setMetadataLanguage(facade.getMetadataLanguage());
+		}
 		return toSubmit;
 	}
 

src/main/java/com/researchspace/dataverse/entities/facade/DatasetFacade.java

@@ -50,6 +50,7 @@ public class DatasetFacade   {
 	private Date productionDate;
 	private String productionPlace;
 	private @Singular List<DatasetContributor> contributors;
+	private String metadataLanguage;
 
 	/**
 	 * Returns a copy if the internally stored Date

src/main/java/com/researchspace/dataverse/http/DataverseOperationsImplV1.java

@@ -236,21 +236,21 @@ private DatasetFileList getDatasetFileList(FileUploadMetadata metadata, Identifi
 	 * @see com.researchspace.dataverse.http.DataverseAPI#uploadFile(java.lang.String, java.io.File)
 	 */
 	@Override
-	public void uploadFile (String doi, File file) {
+	public void uploadFile (String doi, File file, String protocol) {
 		try {
-			this.uploadFile(doi, new FileInputStream(file), file.getName());
+			this.uploadFile(doi, new FileInputStream(file), file.getName(), protocol);
 		} catch (FileNotFoundException e) {
 			e.printStackTrace();
 		}
 	}
 
 	@Override
-	public void uploadFile(String doi, InputStream file, String filename) {
+	public void uploadFile(String doi, InputStream file, String filename, String protocol) {
 		FileUploader uploader = new FileUploader();
 		try {
-			uploader.deposit(file, filename, apiKey, new URI(serverURL), doi);
+			uploader.deposit(file, filename, apiKey, new URI(serverURL), doi, protocol);
 		} catch (IOException | SWORDClientException  | ProtocolViolationException | URISyntaxException e) {
-			log.error("Couldn't upload file {} with doi {} : {}", filename, doi.toString(), e.getMessage());
+			log.error("Couldn't upload file {} with {} {} : {}", filename, protocol, doi.toString(), e.getMessage());
 			throw new RestClientException(e.getMessage());
 		} catch (SWORDError error) {
 			if (!StringUtils.isEmpty(error.getErrorBody())) {

src/main/java/com/researchspace/dataverse/sword/FileUploader.java

@@ -56,9 +56,9 @@ public class FileUploader {
 	 * @throws SWORDError
 	 * @throws ProtocolViolationException
 	 */
-	public DepositReceipt deposit(File file, String apiKey, URI dataverseServer, String doi)
+	public DepositReceipt deposit(File file, String apiKey, URI dataverseServer, String doi, String protocol)
 			throws IOException, SWORDClientException, SWORDError, ProtocolViolationException {
-		return this.deposit(new FileInputStream(file), file.getName(), apiKey, dataverseServer, doi);
+		return this.deposit(new FileInputStream(file), file.getName(), apiKey, dataverseServer, doi, protocol);
 	}
 
 
@@ -70,13 +70,14 @@ public DepositReceipt deposit(File file, String apiKey, URI dataverseServer, Str
 	 * @param apiKey Key used to authenticate actions into the goal dataverse instance.
 	 * @param dataverseServer URL of the dataverse instance to attack.
 	 * @param doi To identify the dataset that is the goal of the file upload.
+	 * @param protocol The protocol used for persistent identification
 	 * @return Information of the result of the upload via a {@code DepositReceipt} instance.
 	 * @throws IOException Thrown when a IO error occurs, which is a general error.
 	 * @throws SWORDClientException Thrown when an exception happens inside the SWORD client.
 	 * @throws SWORDError Thrown when an exception happens inside the SWORD client.
 	 * @throws ProtocolViolationException Thrown for unknown reasons.
 	 */
-	public DepositReceipt deposit(InputStream is, String filename, String apiKey, URI dataverseServer, String doi)
+	public DepositReceipt deposit(InputStream is, String filename, String apiKey, URI dataverseServer, String doi, String protocol)
 			throws IOException, SWORDClientException, SWORDError, ProtocolViolationException {
 		SWORDClient cli = new SWORDClient();
 		Deposit dep = new Deposit();
@@ -87,8 +88,8 @@ public DepositReceipt deposit(InputStream is, String filename, String apiKey, UR
 
 		AuthCredentials cred = new AuthCredentials(apiKey, "");
 
-		String depositURI = dataverseServer.toString() + "/dvn/api/data-deposit/v1.1/swordv2/edit-media/study/doi:"
-				+ doi;
+		String depositURI = dataverseServer.toString() + "/dvn/api/data-deposit/v1.1/swordv2/edit-media/study/"
+		 + protocol + ":" + doi;
 		DepositReceipt rct = cli.deposit(depositURI, dep, cred);
 		log.info("Deposit received with status {}" ,rct.getStatusCode());
 		return rct;

src/test/java/com/researchspace/dataverse/entities/facade/DatasetTestFactory.java

@@ -34,32 +34,45 @@ public class DatasetTestFactory {
 	 * Creates a complex DataSet object
 	 * @return
 	 * @throws MalformedURLException
-	 * @throws URISyntaxException 
+	 * @throws URISyntaxException
 	 */
-	public static DatasetFacade createFacade() throws MalformedURLException, URISyntaxException {		
+	public static DatasetFacade createFacade() throws MalformedURLException, URISyntaxException {
 		return DatasetFacade.builder()
-		  .author(buildAnAuthor()).author(buildAnotherAuthor())
-		  .title("title1")
-		  .contact(buildAContact()).contact(buildAnotherContact())
-		  .description(buildADesc())
-		  .keyword(buildAKeyword("key1")).keyword(buildAKeyword("key2"))
-		  .topicClassification(buildATopicClassification("topic1"))
-		  .publication(buildAPublication())
-		  .producer(buildAProducer())
-		  .productionDate(new Date())
-		  .productionPlace("Edinburgh, UK")
-		  .contributor(buildAContributor("Fred")).contributor(buildAContributor("Tim"))
-		  .subject("Chemistry")
-		  .depositor("A depositor")
-		  .subtitle(" A subtitle")
-		  .alternativeTitle("altTitle")
-		  .alternativeURL(new URL("https://www.myrepo.com"))
-		  .note("Some note")
-		  .languages(Arrays.asList(new String []{"English", "French"}))
-		  .build();
+				.author(buildAnAuthor()).author(buildAnotherAuthor())
+				.title("title1")
+				.contact(buildAContact()).contact(buildAnotherContact())
+				.description(buildADesc())
+				.keyword(buildAKeyword("key1")).keyword(buildAKeyword("key2"))
+				.topicClassification(buildATopicClassification("topic1"))
+				.publication(buildAPublication())
+				.producer(buildAProducer())
+				.productionDate(new Date())
+				.productionPlace("Edinburgh, UK")
+				.contributor(buildAContributor("Fred")).contributor(buildAContributor("Tim"))
+				.subject("Chemistry")
+				.depositor("A depositor")
+				.subtitle(" A subtitle")
+				.alternativeTitle("altTitle")
+				.alternativeURL(new URL("https://www.myrepo.com"))
+				.note("Some note")
+				.languages(Arrays.asList(new String[] { "English", "French" }))
+				.build();
 	}
 
-	 private static DatasetContributor buildAContributor(String name) {
+	public static DatasetFacade createFacadeWithMetadataLanguage() {
+		return DatasetFacade.builder()
+				.author(buildAnAuthor())
+				.title("test")
+				.metadataLanguage("hu")
+				.description(buildADesc())
+				.subject("Chemistry")
+				.languages(Arrays.asList(new String[] { "English", "French" }))
+				.depositor("A depositor")
+				.contact(buildAContact())
+				.build();
+	}
+
+	private static DatasetContributor buildAContributor(String name) {
 		return DatasetContributor.builder()
 				.name(name)
 				.type(ContributorType.ProjectLeader)
@@ -92,42 +105,42 @@ private static DatasetTopicClassification buildATopicClassification(String value
 	}
 
 	private static DatasetKeyword buildAKeyword(String key) throws URISyntaxException {
-			return DatasetKeyword.builder().value(key).vocabulary("keywordVocab")
-			     .vocabularyURI(new URI("https://vocab.com")).build();
+		return DatasetKeyword.builder().value(key).vocabulary("keywordVocab")
+				.vocabularyURI(new URI("https://vocab.com")).build();
 	}
 
 	private static DatasetDescription buildADesc() {
-		 return DatasetDescription.builder()
-				 .date(new Date()).description("some desc")
-				 .build();
+		return DatasetDescription.builder()
+				.date(new Date()).description("some desc")
+				.build();
 	}
 
 	static DatasetContact buildAContact() {
 		return DatasetContact.builder()
 				.datasetContactAffiliation("Some place").datasetContactEmail("contact@email.com").datasetContactName("Sarah Contact")
 				.build();
 	}
-	
-	 static DatasetContact buildAnotherContact() {
+
+	static DatasetContact buildAnotherContact() {
 		return DatasetContact.builder()
 				.datasetContactAffiliation("Another place")
 				.datasetContactEmail("contact2@email.com")
 				.datasetContactName("Brian Contact2")
 				.build();
 	}
 
-	 static DatasetAuthor buildAnotherAuthor() {
+	static DatasetAuthor buildAnotherAuthor() {
 		return DatasetAuthor.builder().authorName("John  Smith")
-				  .authorAffiliation("Dataverse")
-				  .authorIdentifierScheme("ISNI")
-				  .authorIdentifier("1234-5678").build();
+				.authorAffiliation("Dataverse")
+				.authorIdentifierScheme("ISNI")
+				.authorIdentifier("1234-5678").build();
 	}
 
-	 static DatasetAuthor buildAnAuthor() {
+	static DatasetAuthor buildAnAuthor() {
 		return DatasetAuthor.builder().authorName("Fred Blogs")
-				  .authorAffiliation("RSpace")
-				  .authorIdentifierScheme("ORCID")
-				  .authorIdentifier("1234-5678").build();
+				.authorAffiliation("RSpace")
+				.authorIdentifierScheme("ORCID")
+				.authorIdentifier("1234-5678").build();
 	}
 
 }