Fix #101, updated ror provider to v2, adapted tests

Author: ThomasJejkal

src/main/java/edu/kit/datamanager/ro_crate/RoCrate.java

@@ -10,9 +10,13 @@
 import edu.kit.datamanager.ro_crate.entities.AbstractEntity;
 import edu.kit.datamanager.ro_crate.entities.contextual.ContextualEntity;
 import edu.kit.datamanager.ro_crate.entities.contextual.JsonDescriptor;
+import edu.kit.datamanager.ro_crate.entities.contextual.OrganizationEntity;
 import edu.kit.datamanager.ro_crate.entities.data.DataEntity;
+import edu.kit.datamanager.ro_crate.entities.data.DataEntity.DataEntityBuilder;
+import edu.kit.datamanager.ro_crate.entities.data.FileEntity;
 import edu.kit.datamanager.ro_crate.entities.data.RootDataEntity;
 import edu.kit.datamanager.ro_crate.externalproviders.dataentities.ImportFromDataCite;
+import edu.kit.datamanager.ro_crate.externalproviders.organizationprovider.RorProvider;
 import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
 import edu.kit.datamanager.ro_crate.payload.CratePayload;
 import edu.kit.datamanager.ro_crate.payload.RoCratePayload;
@@ -22,9 +26,12 @@
 import edu.kit.datamanager.ro_crate.special.JsonUtilFunctions;
 import edu.kit.datamanager.ro_crate.validation.JsonSchemaValidation;
 import edu.kit.datamanager.ro_crate.validation.Validator;
+import edu.kit.datamanager.ro_crate.writer.FolderWriter;
+import edu.kit.datamanager.ro_crate.writer.RoCrateWriter;
 
 import java.io.File;
 import java.net.URI;
+import java.nio.file.Paths;
 import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
@@ -58,22 +65,27 @@ public void setRoCratePreview(CratePreview preview) {
         this.roCratePreview = preview;
     }
 
+    @Override
     public void setMetadataContext(CrateMetadataContext metadataContext) {
         this.metadataContext = metadataContext;
     }
 
+    @Override
     public ContextualEntity getJsonDescriptor() {
         return jsonDescriptor;
     }
 
+    @Override
     public void setJsonDescriptor(ContextualEntity jsonDescriptor) {
         this.jsonDescriptor = jsonDescriptor;
     }
-
+    
+    @Override
     public RootDataEntity getRootDataEntity() {
         return rootDataEntity;
     }
-
+    
+    @Override
     public void setRootDataEntity(RootDataEntity rootDataEntity) {
         this.rootDataEntity = rootDataEntity;
     }

src/main/java/edu/kit/datamanager/ro_crate/entities/data/DataEntity.java

@@ -8,9 +8,7 @@
 import edu.kit.datamanager.ro_crate.util.ZipUtil;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.URI;
 import java.nio.file.Path;
 import java.util.ArrayList;

src/main/java/edu/kit/datamanager/ro_crate/entities/validation/JsonSchemaValidation.java

@@ -68,7 +68,7 @@ public boolean validateEntity(JsonNode entity) {
   @Override
   public boolean validateFieldOfEntity(JsonNode field) {
     Set<ValidationMessage> errors = this.entityFieldSchema.validate(field);
-    if (errors.size() != 0) {
+    if (!errors.isEmpty()) {
       ObjectMapper objectMapper = MyObjectMapper.getMapper();
       System.err.println("The property: ");
       try {

src/main/java/edu/kit/datamanager/ro_crate/externalproviders/organizationprovider/RorProvider.java

@@ -1,11 +1,14 @@
 package edu.kit.datamanager.ro_crate.externalproviders.organizationprovider;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import edu.kit.datamanager.ro_crate.entities.contextual.OrganizationEntity;
 import edu.kit.datamanager.ro_crate.objectmapper.MyObjectMapper;
 
 import java.io.IOException;
+import java.util.ArrayList;
 
 import org.apache.http.HttpStatus;
 import org.apache.http.client.methods.CloseableHttpResponse;
@@ -20,45 +23,63 @@
  */
 public class RorProvider {
 
-  private static Logger logger = LoggerFactory.getLogger(RorProvider.class);
+    private static Logger logger = LoggerFactory.getLogger(RorProvider.class);
 
-  private RorProvider() {}
+    private RorProvider() {
+    }
+
+    /**
+     * The method that parses a ror entry to a crate entity.
+     *
+     * @param url the url of the ror entry.
+     * @return the created Organization entity.
+     */
+    public static OrganizationEntity getOrganization(String url) {
+        if (!url.startsWith("https://ror.org/")) {
+            throw new IllegalArgumentException("Should provide ror url");
+        }
+        String newUrl = "https://api.ror.org/v2/organizations/" + url.replaceAll("https://ror.org/", "");
+        HttpGet request = new HttpGet(newUrl);
 
-  /**
-   * The method that parses a ror entry to a crate entity.
-   *
-   * @param url the url of the ror entry.
-   * @return the created Organization entity.
-   */
-  public static OrganizationEntity getOrganization(String url) {
-    if (!url.startsWith("https://ror.org/")) {
-      throw new IllegalArgumentException("Should provide ror url");
+        try (
+                CloseableHttpClient httpClient = HttpClients.createDefault(); CloseableHttpResponse response = httpClient.execute(request);) {
+            boolean isError = response.getStatusLine().getStatusCode() != HttpStatus.SC_OK;
+            if (isError) {
+                String errorMessage = String.format("Identifier not found: %s", response.getStatusLine().toString());
+                logger.error(errorMessage);
+                return null;
+            }
+            ObjectNode jsonNode = MyObjectMapper.getMapper().readValue(response.getEntity().getContent(),
+                    ObjectNode.class);
+
+            return new OrganizationEntity.OrganizationEntityBuilder()
+                    .setId(jsonNode.get("id").asText())
+                    .addProperty("name", getOrganizationNameV2(jsonNode.get("names")))
+                    .addProperty("email", jsonNode.get("email_address"))
+                    .addProperty("url", jsonNode.get("id").asText())
+                    .build();
+        } catch (IOException e) {
+            String errorMessage = String.format("IO error: %s", e.getMessage());
+            logger.error(errorMessage);
+        }
+        return null;
     }
-    String newUrl = "https://api.ror.org/organizations/" + url.replaceAll("https://ror.org/", "");
-    HttpGet request = new HttpGet(newUrl);
 
-    try (
-      CloseableHttpClient httpClient = HttpClients.createDefault();
-      CloseableHttpResponse response = httpClient.execute(request);
-    ) {
-        boolean isError = response.getStatusLine().getStatusCode() != HttpStatus.SC_OK;
-        if (isError) {
-          String errorMessage = String.format("Identifier not found: %s", response.getStatusLine().toString());
-          logger.error(errorMessage);
-          return null;
+    private static String getOrganizationNameV2(JsonNode node) {
+        if (node.isArray()) {
+            for (JsonNode n : node) {
+                if (n.has("types") && n.get("types").isArray()) {
+                    ArrayList l = new ObjectMapper().convertValue(n.get("types"), ArrayList.class);
+                    if (l.contains("ror_display")) {
+                        return n.get("value").asText();
+                    }
+                }
+            }
+            //fallback
+            return node.get(0).get("value").asText();
+        } else {
+            return node.asText();
         }
-        ObjectNode jsonNode = MyObjectMapper.getMapper().readValue(response.getEntity().getContent(),
-            ObjectNode.class);
-        return new OrganizationEntity.OrganizationEntityBuilder()
-            .setId(jsonNode.get("id").asText())
-            .addProperty("name", jsonNode.get("name"))
-            .addProperty("email", jsonNode.get("email_address"))
-            .addProperty("url", jsonNode.get("links"))
-            .build();
-    } catch (IOException e) {
-      String errorMessage = String.format("IO error: %s", e.getMessage());
-      logger.error(errorMessage);
     }
-    return null;
-  }
+
 }

src/main/resources/json_schemas/entity_field_structure_schema.json

@@ -12,7 +12,6 @@
           {"type": "boolean"},
           {"type": "null"}
         ]
-
       }
     },
     {

src/test/java/edu/kit/datamanager/ro_crate/externalproviders/RorProviderTest.java

@@ -5,6 +5,7 @@
 import edu.kit.datamanager.ro_crate.HelpFunctions;
 import edu.kit.datamanager.ro_crate.entities.contextual.OrganizationEntity;
 import edu.kit.datamanager.ro_crate.externalproviders.organizationprovider.RorProvider;
+import org.junit.jupiter.api.Assertions;
 
 import org.junit.jupiter.api.Test;
 
@@ -18,23 +19,25 @@
  */
 public class RorProviderTest {
 
-  @Test
-  void testExternalRorProvider() throws IOException {
-    OrganizationEntity organizationEntity = RorProvider.getOrganization("https://ror.org/04t3en479");
-    assertNotNull(organizationEntity);
-    HelpFunctions.compareEntityWithFile(organizationEntity, "/json/entities/contextual/rorkit.json");
-  }
-
-  @Test
-  void testInvalidRorUrl() {
-    assertThrows(IllegalArgumentException.class, () -> {
-      RorProvider.getOrganization("https://notror.org/04t3en479");
-    });
-  }
-
-  @Test
-  void testInvalidRorId() {
-    OrganizationEntity organizationEntity = RorProvider.getOrganization("https://ror.org/42");
-    assertNull(organizationEntity);
-  }
+    @Test
+    void testExternalRorProvider() throws IOException {
+        OrganizationEntity organizationEntity = RorProvider.getOrganization("https://ror.org/04t3en479");
+        assertNotNull(organizationEntity);
+        Assertions.assertEquals("https://ror.org/04t3en479", organizationEntity.getProperty("@id").asText());
+        Assertions.assertEquals("https://ror.org/04t3en479", organizationEntity.getProperty("url").asText());
+        Assertions.assertEquals("Karlsruhe Institute of Technology", organizationEntity.getProperty("name").asText());
+    }
+
+    @Test
+    void testInvalidRorUrl() {
+        assertThrows(IllegalArgumentException.class, () -> {
+            RorProvider.getOrganization("https://notror.org/04t3en479");
+        });
+    }
+
+    @Test
+    void testInvalidRorId() {
+        OrganizationEntity organizationEntity = RorProvider.getOrganization("https://ror.org/42");
+        assertNull(organizationEntity);
+    }
 }