Merge pull request #12112 from vera/feat/get-default-contributor-role

 feat: add API for getting default contributor role of a collection

Author: pdurbin

doc/release-notes/12112-get-default-contributor-role.md

@@ -0,0 +1 @@
+A new API endpoint for getting the default contributor role of a collection (`GET /api/dataverses/$ID/defaultContributorRole`) was added.

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

@@ -525,7 +525,7 @@ The fully expanded example above (without environment variables) looks like this
 Assign Default Role to User Creating a Dataset in a Dataverse Collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Assign a default role to a user creating a dataset in a Dataverse collection ``id`` where ``roleAlias`` is the database alias of the role to be assigned:
+Assign a default role to a user creating a dataset in a Dataverse collection ``id`` where ``roleAlias`` is the database alias of the role to be assigned (requires ``ManageDataversePermissions``):
 
 .. code-block:: bash
 
@@ -544,6 +544,27 @@ The fully expanded example above (without environment variables) looks like this
 
 Note: You may use "none" as the ``ROLE_ALIAS``. This will prevent a user who creates a dataset from having any role on that dataset. It is not recommended for Dataverse collections with human contributors.
 
+.. _get-default-contributor-role-on-a-dataverse-api:
+
+Get Default Role Assigned to User Creating a Dataset in a Dataverse Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Get the default role that is assigned to a user creating a dataset in a Dataverse collection ``id`` (requires ``ManageDataversePermissions``):
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=root
+
+  curl -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/dataverses/$ID/defaultContributorRole"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "https://demo.dataverse.org/api/dataverses/root/defaultContributorRole"
+
 .. _assign-role-on-a-dataverse-api:
 
 Assign a New Role on a Dataverse Collection

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

@@ -1631,6 +1631,21 @@ public Response updateDefaultContributorRole(
 
     }
 
+    @GET
+    @AuthRequired
+    @Path("{identifier}/defaultContributorRole")
+    public Response getDefaultContributorRole(
+            @Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvIdtf) {
+
+        return response(req -> ok(
+                json(
+                        execCommand(
+                                new GetCollectionDefaultContributorRoleCommand(req,
+                                        findDataverseOrDie(dvIdtf))))), getRequestUser(crc));
+
+    }
+
     @DELETE
     @AuthRequired
     @Path("{identifier}/groups/{aliasInOwner}")

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/GetCollectionDefaultContributorRoleCommand.java

@@ -0,0 +1,38 @@
+package edu.harvard.iq.dataverse.engine.command.impl;
+
+import edu.harvard.iq.dataverse.Dataverse;
+import edu.harvard.iq.dataverse.authorization.DataverseRole;
+import edu.harvard.iq.dataverse.authorization.Permission;
+import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
+import edu.harvard.iq.dataverse.engine.command.CommandContext;
+import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.RequiredPermissions;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+
+/**
+ *
+ * Gets the default contributor role of a collection.
+ * Used by the /api/dataverses/.../defaultContributorRole API.
+ */
+@RequiredPermissions( Permission.ManageDataversePermissions )
+public class GetCollectionDefaultContributorRoleCommand extends AbstractCommand<DataverseRole> {
+
+    private final Dataverse dataverse;
+
+    public GetCollectionDefaultContributorRoleCommand(DataverseRequest aRequest, Dataverse target) {
+        super(aRequest, target);
+        dataverse = target;
+    }
+
+    @Override
+    public DataverseRole execute(CommandContext ctxt) throws CommandException {
+
+        if (dataverse != null) {
+            return dataverse.getDefaultContributorRole();
+        }
+
+        return null;
+    }
+}
+
+

src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java

@@ -246,16 +246,19 @@ public static JsonArrayBuilder jsonDataverseRoles(List<DataverseRole> roles) {
     }
 
     public static JsonObjectBuilder json(DataverseRole role) {
-        JsonObjectBuilder bld = jsonObjectBuilder()
-                .add("alias", role.getAlias())
-                .add("name", role.getName())
-                .add("permissions", JsonPrinter.json(role.permissions()))
-                .add("description", role.getDescription());
-        if (role.getId() != null) {
-            bld.add("id", role.getId());
-        }
-        if (role.getOwner() != null && role.getOwner().getId() != null) {
-            bld.add("ownerId", role.getOwner().getId());
+        JsonObjectBuilder bld = jsonObjectBuilder();
+
+        if (role != null) {
+            bld.add("alias", role.getAlias())
+               .add("name", role.getName())
+               .add("permissions", JsonPrinter.json(role.permissions()))
+               .add("description", role.getDescription());
+            if (role.getId() != null) {
+                bld.add("id", role.getId());
+            }
+            if (role.getOwner() != null && role.getOwner().getId() != null) {
+                bld.add("ownerId", role.getOwner().getId());
+            }
         }
 
         return bld;

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

@@ -21,6 +21,7 @@
 import java.nio.file.Paths;
 import java.text.MessageFormat;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.logging.Logger;
@@ -544,6 +545,13 @@ public void testUpdateDefaultContributorRole() {
         updateDataverseDefaultRole.then().assertThat()
                 .body("data.message", equalTo("Default contributor role for Dataverse " + dataverseAlias + " has been set to Curator."))
                 .statusCode(200);
+
+        // test GET API for retrieving the role that was just set
+        Response getDataverseDefaultRole = UtilIT.getDefaultContributorsRoleOnDataverse(dataverseAlias, apiToken);
+        getDataverseDefaultRole.prettyPrint();
+        getDataverseDefaultRole.then().assertThat()
+                .body("data.alias", equalTo("curator"))
+                .statusCode(200);
 
         //for test use an existing role. In practice this likely will be a custom role
         Response updateDataverseDefaultRoleNone = UtilIT.updateDefaultContributorsRoleOnDataverse(dataverseAlias, "none", apiToken);
@@ -552,6 +560,13 @@ public void testUpdateDefaultContributorRole() {
                 .body("data.message", equalTo("Default contributor role for Dataverse " + dataverseAlias + " has been set to None."))
                 .statusCode(200);
 
+        // test GET API for retrieving the role that was just set
+        Response getDataverseDefaultRoleNone = UtilIT.getDefaultContributorsRoleOnDataverse(dataverseAlias, apiToken);
+        getDataverseDefaultRoleNone.prettyPrint();
+        getDataverseDefaultRoleNone.then().assertThat()
+                .body("data", equalTo(Collections.emptyMap()))
+                .statusCode(200);
+
         // try bad role alias
         Response updateDataverseDefaultRoleBadRoleAlias = UtilIT.updateDefaultContributorsRoleOnDataverse(dataverseAlias, "colonel", apiToken);
         updateDataverseDefaultRoleBadRoleAlias.prettyPrint();

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

@@ -2729,14 +2729,21 @@ static Response getRoleAssignmentsOnDataverse(String dataverseAliasOrId, String
                 .get(url);
     }
 
-    static Response updateDefaultContributorsRoleOnDataverse(String dataverseAliasOrId,String roleAlias, String apiToken) {
+    static Response updateDefaultContributorsRoleOnDataverse(String dataverseAliasOrId, String roleAlias, String apiToken) {
         String url = "/api/dataverses/" + dataverseAliasOrId + "/defaultContributorRole/" + roleAlias;
         System.out.println("URL: " + url);
         return given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken)
                 .put(url);
     }
 
+    static Response getDefaultContributorsRoleOnDataverse(String dataverseAliasOrId, String apiToken) {
+        String url = "/api/dataverses/" + dataverseAliasOrId + "/defaultContributorRole";
+        return given()
+                .header(API_TOKEN_HTTP_HEADER, apiToken)
+                .get(url);
+    }
+
     static Response getRoleAssignmentsOnDataset(String datasetId, String persistentId, String apiToken) {
         String url = "/api/datasets/" + datasetId + "/assignments";
         System.out.println("URL: " + url);