feat(authorization): add possibility to use *Request object in wrapped API (#457)

bednar · web-flow · commit f137cd92c0d7 · 2022-10-25T12:29:48.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### Features
 1. [#439](https://github.com/influxdata/influxdb-client-java/pull/439): Add `FluxRecord.getRow()` which stores response data in a list
+1. [#457](https://github.com/influxdata/influxdb-client-java/pull/457): Add possibility to use `AuthorizationPostRequest` and `AuthorizationUpdateRequest` in `AuthorizationApi`
 
 ### Dependencies
 
diff --git a/client/src/main/java/com/influxdb/client/AuthorizationsApi.java b/client/src/main/java/com/influxdb/client/AuthorizationsApi.java
@@ -27,6 +27,8 @@
 import javax.annotation.concurrent.ThreadSafe;
 
 import com.influxdb.client.domain.Authorization;
+import com.influxdb.client.domain.AuthorizationPostRequest;
+import com.influxdb.client.domain.AuthorizationUpdateRequest;
 import com.influxdb.client.domain.Organization;
 import com.influxdb.client.domain.Permission;
 import com.influxdb.client.domain.User;
@@ -70,6 +72,21 @@ Authorization createAuthorization(@Nonnull final Organization organization,
     Authorization createAuthorization(@Nonnull final String orgID,
                                       @Nonnull final List<Permission> permissions);
 
+    /**
+     * Create an authorization.
+     *
+     * <p>
+     * Use this method to create an authorization, which generates an API token with permissions to `read` or `write`
+     * to a specific resource or `type` of resource. The response contains the new authorization
+     * with the generated API token.
+     * </p>
+     *
+     * @param request The authorization to create.
+     * @return Newly created authorization
+     */
+    @Nonnull
+    Authorization createAuthorization(@Nonnull final AuthorizationPostRequest request);
+
     /**
      * Updates the status of the authorization. Useful for setting an authorization to inactive or active.
      *
@@ -79,6 +96,17 @@ Authorization createAuthorization(@Nonnull final String orgID,
     @Nonnull
     Authorization updateAuthorization(@Nonnull final Authorization authorization);
 
+    /**
+     * Update an authorization to be active or inactive.
+     *
+     * @param authorizationID The ID of the authorization to update.
+     * @param request         Authorization to update
+     * @return The active or inactive authorization
+     */
+    @Nonnull
+    Authorization updateAuthorization(@Nonnull final String authorizationID,
+                                      @Nonnull final AuthorizationUpdateRequest request);
+
     /**
      * Delete an authorization.
      *
diff --git a/client/src/main/java/com/influxdb/client/internal/AuthorizationsApiImpl.java b/client/src/main/java/com/influxdb/client/internal/AuthorizationsApiImpl.java
@@ -30,6 +30,7 @@
 import com.influxdb.client.AuthorizationsApi;
 import com.influxdb.client.domain.Authorization;
 import com.influxdb.client.domain.AuthorizationPostRequest;
+import com.influxdb.client.domain.AuthorizationUpdateRequest;
 import com.influxdb.client.domain.Authorizations;
 import com.influxdb.client.domain.Organization;
 import com.influxdb.client.domain.Permission;
@@ -96,6 +97,15 @@ public Authorization createAuthorization(@Nonnull final Authorization authorizat
                 .permissions(authorization.getPermissions())
                 .description(authorization.getDescription());
 
+        return createAuthorization(request);
+    }
+
+    @Override
+    @Nonnull
+    public Authorization createAuthorization(@Nonnull final AuthorizationPostRequest request) {
+
+        Arguments.checkNotNull(request, "AuthorizationPostRequest is required");
+
         Call<Authorization> call = service.postAuthorizations(request, null);
 
         return execute(call);
@@ -160,8 +170,18 @@ public Authorization updateAuthorization(@Nonnull final Authorization authorizat
 
         Arguments.checkNotNull(authorization, "Authorization is required");
 
-        Call<Authorization> authorizationCall = service
-                .patchAuthorizationsID(authorization.getId(), authorization, null);
+        return updateAuthorization(authorization.getId(), authorization);
+    }
+
+    @Override
+    @Nonnull
+    public Authorization updateAuthorization(@Nonnull final String authorizationID,
+                                             @Nonnull final AuthorizationUpdateRequest request) {
+
+        Arguments.checkNonEmpty(authorizationID, "authorizationID");
+        Arguments.checkNotNull(authorizationID, "AuthorizationUpdateRequest");
+
+        Call<Authorization> authorizationCall = service.patchAuthorizationsID(authorizationID, request, null);
 
         return execute(authorizationCall);
     }
diff --git a/client/src/test/java/com/influxdb/client/ITAuthorizationsApi.java b/client/src/test/java/com/influxdb/client/ITAuthorizationsApi.java
@@ -22,13 +22,16 @@
 package com.influxdb.client;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import javax.annotation.Nonnull;
 
 import com.influxdb.client.domain.Authorization;
+import com.influxdb.client.domain.AuthorizationPostRequest;
+import com.influxdb.client.domain.AuthorizationUpdateRequest;
 import com.influxdb.client.domain.Bucket;
 import com.influxdb.client.domain.Organization;
 import com.influxdb.client.domain.Permission;
@@ -200,6 +203,34 @@ void createAuthorizationBucket() {
         Assertions.assertThat(authorization.getPermissions().get(1).getAction()).isEqualTo(Permission.ActionEnum.WRITE);
     }
 
+    @Test
+    void createAuthorizationRequest() {
+
+        PermissionResource checks = new PermissionResource();
+        checks.setOrgID(organization.getId());
+        checks.setType(PermissionResource.TYPE_CHECKS);
+
+        Permission read = new Permission();
+        read.setResource(checks);
+        read.setAction(Permission.ActionEnum.READ);
+
+        Permission write = new Permission();
+        write.setResource(checks);
+        write.setAction(Permission.ActionEnum.WRITE);
+
+        AuthorizationPostRequest request = new AuthorizationPostRequest();
+        request
+                .orgID(organization.getId())
+                .permissions(Arrays.asList(read, write))
+                .description("Created by AuthorizationPostRequest");
+
+        Authorization authorization = authorizationsApi.createAuthorization(request);
+
+        Assertions.assertThat(authorization.getPermissions()).hasSize(2);
+        Assertions.assertThat(authorization.getDescription()).isEqualTo("Created by AuthorizationPostRequest");
+        Assertions.assertThat(authorization.getToken()).isNotBlank();
+    }
+
     @Test
     void findAuthorizationsByID() {
 
@@ -304,6 +335,29 @@ void updateAuthorizationStatus() {
         Assertions.assertThat(authorization.getStatus()).isEqualTo(Authorization.StatusEnum.ACTIVE);
     }
 
+    @Test
+    void updateAuthorizationRequest() {
+
+        PermissionResource user = new PermissionResource();
+        user.setOrgID(organization.getId());
+        user.setType(PermissionResource.TYPE_USERS);
+
+        Permission read = new Permission();
+        read.setAction(Permission.ActionEnum.READ);
+        read.setResource(user);
+
+        Authorization authorization = authorizationsApi.createAuthorization(organization, Collections.singletonList(read));
+        Assertions.assertThat(authorization.getStatus()).isEqualTo(Authorization.StatusEnum.ACTIVE);
+
+        AuthorizationUpdateRequest request = new AuthorizationUpdateRequest()
+                .status(AuthorizationUpdateRequest.StatusEnum.INACTIVE)
+                .description("Updated description");
+        authorization = authorizationsApi.updateAuthorization(authorization.getId(), request);
+
+        Assertions.assertThat(authorization.getStatus()).isEqualTo(Authorization.StatusEnum.INACTIVE);
+        Assertions.assertThat(authorization.getDescription()).isEqualTo("Updated description");
+    }
+
     @Test
     void deleteAuthorization() {
 
