Add write metadata support

Author: josiasmontag

src/main/java/com/cloudconvert/client/AsyncCloudConvertClient.java

@@ -51,7 +51,8 @@ public AsyncCloudConvertClient(
                 new AsyncCreateArchivesResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
                 new AsyncExecuteCommandsResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
                 new AsyncCreateThumbnailsResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
-                new AsyncGetMetadataResource(settingsProvider, objectMapperProvider, asyncRequestExecutor)
+                new AsyncGetMetadataResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
+                new AsyncWriteMetadataResource(settingsProvider, objectMapperProvider, asyncRequestExecutor)
             ),
             new AsyncJobsResource(settingsProvider, objectMapperProvider, asyncRequestExecutor)
         );

src/main/java/com/cloudconvert/client/CloudConvertClient.java

@@ -52,7 +52,8 @@ public CloudConvertClient(
                 new CreateArchivesResource(settingsProvider, objectMapperProvider, requestExecutor),
                 new ExecuteCommandsResource(settingsProvider, objectMapperProvider, requestExecutor),
                 new CreateThumbnailsResource(settingsProvider, objectMapperProvider, requestExecutor),
-                new GetMetadataResource(settingsProvider, objectMapperProvider, requestExecutor)
+                new GetMetadataResource(settingsProvider, objectMapperProvider, requestExecutor),
+                    new WriteMetadataResource(settingsProvider, objectMapperProvider, requestExecutor)
             ),
             new JobsResource(settingsProvider, objectMapperProvider, requestExecutor)
         );

src/main/java/com/cloudconvert/dto/Operation.java

@@ -14,6 +14,7 @@ public enum Operation {
     COMMAND("command"),
     THUMBNAIL("thumbnail"),
     METADATA("metadata"),
+    METADATA_WRITE("metadata/write"),
 
     IMPORT_URL("import/url"),
     IMPORT_UPLOAD("import/upload"),

src/main/java/com/cloudconvert/dto/request/WriteMetadataTaskRequest.java

@@ -0,0 +1,57 @@
+package com.cloudconvert.dto.request;
+
+import com.cloudconvert.dto.Operation;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+@Getter
+@Setter
+@Accessors(chain = true)
+@ToString
+@EqualsAndHashCode(callSuper = true)
+public class WriteMetadataTaskRequest extends TaskRequest {
+
+    /**
+     * (required) The ID of the input task for the conversion, normally the import task. Multiple task IDs can be provided as an array.
+     */
+    private List<String> input;
+
+    /**
+     * (optional) The current format of the file, e.g. pdf. If not set, the extension of the input file is used as input format.
+     */
+    private String inputFormat;
+
+    /**
+     * (optional) Use a specific engine for the conversion.
+     */
+    private String engine;
+
+    /**
+     * (required) Keys and values of metadata to write. Possible keys include Title, Author, Creator, Producer.
+     */
+    private Map<String, String> metadata;
+
+    /**
+     * (optional) Use a specific engine version for the conversion.
+     */
+    private String engineVersion;
+
+
+    public WriteMetadataTaskRequest setInput(final String... input) {
+        this.input = Arrays.stream(input).collect(Collectors.toList());
+        return this;
+    }
+
+    @Override
+    public Operation getOperation() {
+        return Operation.METADATA_WRITE;
+    }
+}

src/main/java/com/cloudconvert/resource/AbstractTasksResource.java

@@ -64,6 +64,9 @@ public abstract class AbstractTasksResource<TRAR extends AbstractResult<TaskResp
     @Getter
     private final AbstractGetMetadataResource<TRAR> abstractGetMetadataResource;
 
+    @Getter
+    private final AbstractWriteMetadataResource<TRAR> abstractWriteMetadataResource;
+
     private final IncludesToNameValuePairsConverter includesToNameValuePairsConverter;
     private final FiltersToNameValuePairsConverter filtersToNameValuePairsConverter;
     private final AlternativeToNameValuePairsConverter alternativeToNameValuePairsConverter;
@@ -74,7 +77,8 @@ public AbstractTasksResource(
         final AbstractConvertFilesResource<TRAR, ORPAR> abstractConvertFilesResource, final AbstractOptimizeFilesResource<TRAR> abstractOptimizeFilesResource,
         final AbstractCaptureWebsitesResource<TRAR> abstractCaptureWebsitesResource, final AbstractMergeFilesResource<TRAR> abstractMergeFilesResource,
         final AbstractCreateArchivesResource<TRAR> abstractCreateArchivesResource, final AbstractExecuteCommandsResource<TRAR> abstractExecuteCommandsResource,
-        final AbstractCreateThumbnailsResource<TRAR> abstractCreateThumbnailsResource, final AbstractGetMetadataResource<TRAR> abstractGetMetadataResourceResource
+        final AbstractCreateThumbnailsResource<TRAR> abstractCreateThumbnailsResource, final AbstractGetMetadataResource<TRAR> abstractGetMetadataResourceResource,
+        final AbstractWriteMetadataResource<TRAR> abstractWriteMetadataResourceResource
     ) {
         super(settingsProvider, objectMapperProvider);
 
@@ -86,6 +90,7 @@ public AbstractTasksResource(
         this.abstractExecuteCommandsResource = abstractExecuteCommandsResource;
         this.abstractCreateThumbnailsResource = abstractCreateThumbnailsResource;
         this.abstractGetMetadataResource = abstractGetMetadataResourceResource;
+        this.abstractWriteMetadataResource = abstractWriteMetadataResourceResource;
 
         this.includesToNameValuePairsConverter = new IncludesToNameValuePairsConverter();
         this.filtersToNameValuePairsConverter = new FiltersToNameValuePairsConverter();
@@ -511,7 +516,7 @@ public abstract TRAR thumbnail(
     /**
      * Create a task to extract metadata from one file. Requires the task.write scope.
      *
-     * @param getMetadataTaskRequest {@link CreateThumbnailsTaskRequest}
+     * @param getMetadataTaskRequest {@link GetMetadataTaskRequest}
      * @return {@link TRAR}
      * @throws IOException
      * @throws URISyntaxException
@@ -521,6 +526,19 @@ public abstract TRAR metadata(
     ) throws IOException, URISyntaxException;
 
 
+    /**
+     * Create a task to write file metadata.
+     *
+     * @param writeMetadataTaskRequest {@link WriteMetadataTaskRequest}
+     * @return {@link TRAR}
+     * @throws IOException
+     * @throws URISyntaxException
+     */
+    public abstract TRAR writeMetadata(
+            @NotNull final WriteMetadataTaskRequest writeMetadataTaskRequest
+    ) throws IOException, URISyntaxException;
+
+
     @Override
     public void close() throws IOException {
         abstractConvertFilesResource.close();
@@ -530,5 +548,7 @@ public void close() throws IOException {
         abstractCreateArchivesResource.close();
         abstractExecuteCommandsResource.close();
         abstractCreateThumbnailsResource.close();
+        abstractGetMetadataResource.close();
+        abstractWriteMetadataResource.close();
     }
 }

src/main/java/com/cloudconvert/resource/AbstractWriteMetadataResource.java

@@ -0,0 +1,49 @@
+package com.cloudconvert.resource;
+
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.client.setttings.SettingsProvider;
+import com.cloudconvert.dto.request.WriteMetadataTaskRequest;
+import com.cloudconvert.dto.response.TaskResponse;
+import com.cloudconvert.dto.result.AbstractResult;
+import com.google.common.collect.ImmutableList;
+import org.apache.http.HttpEntity;
+import org.apache.http.client.methods.HttpPost;
+import org.apache.http.client.methods.HttpUriRequest;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+
+public abstract class AbstractWriteMetadataResource<TRAR extends AbstractResult<TaskResponse>> extends AbstractResource {
+
+    public static final String PATH_SEGMENT_METADATA = "metadata";
+    public static final String PATH_SEGMENT_WRITE = "write";
+
+    public AbstractWriteMetadataResource(
+        final SettingsProvider settingsProvider, final ObjectMapperProvider objectMapperProvider
+    ) {
+        super(settingsProvider, objectMapperProvider);
+    }
+
+    /**
+     * Create a task to write file metadata.
+     *
+     * @param writeMetadataTaskRequest {@link WriteMetadataTaskRequest}
+     * @return {@link TRAR}
+     * @throws IOException
+     * @throws URISyntaxException
+     */
+    public abstract TRAR writeMetadata(
+        @NotNull final WriteMetadataTaskRequest writeMetadataTaskRequest
+    ) throws IOException, URISyntaxException;
+
+    protected HttpUriRequest getWriteMetadataHttpUriRequest(
+        @NotNull final WriteMetadataTaskRequest writeMetadataTaskRequest
+    ) throws IOException, URISyntaxException {
+        final URI uri = getUri(ImmutableList.of(PATH_SEGMENT_METADATA, PATH_SEGMENT_WRITE));
+        final HttpEntity httpEntity = getHttpEntity(writeMetadataTaskRequest);
+
+        return getHttpUriRequest(HttpPost.class, uri, httpEntity);
+    }
+}

src/main/java/com/cloudconvert/resource/async/AsyncTasksResource.java

@@ -34,10 +34,11 @@ public AsyncTasksResource(
         final AsyncConvertFilesResource asyncConvertFilesResource, final AsyncOptimizeFilesResource asyncOptimizeFilesResource,
         final AsyncCaptureWebsitesResource asyncCaptureWebsitesResource, final AsyncMergeFilesResource asyncMergeFilesResource,
         final AsyncCreateArchivesResource asyncCreateArchivesResource, final AsyncExecuteCommandsResource asyncExecuteCommandsResource,
-        final AsyncCreateThumbnailsResource asyncCreateThumbnailsResource, final AsyncGetMetadataResource asyncGetMetadataResource
+        final AsyncCreateThumbnailsResource asyncCreateThumbnailsResource, final AsyncGetMetadataResource asyncGetMetadataResource,
+        final AsyncWriteMetadataResource asyncWriteMetadataResource
     ) {
         super(settingsProvider, objectMapperProvider, asyncConvertFilesResource, asyncOptimizeFilesResource, asyncCaptureWebsitesResource,
-            asyncMergeFilesResource, asyncCreateArchivesResource, asyncExecuteCommandsResource, asyncCreateThumbnailsResource, asyncGetMetadataResource);
+            asyncMergeFilesResource, asyncCreateArchivesResource, asyncExecuteCommandsResource, asyncCreateThumbnailsResource, asyncGetMetadataResource, asyncWriteMetadataResource);
 
         this.asyncRequestExecutor = asyncRequestExecutor;
     }
@@ -206,6 +207,13 @@ public AsyncResult<TaskResponse> metadata(
         return getAbstractGetMetadataResource().metadata(getMetadataTaskRequest);
     }
 
+    @Override
+    public AsyncResult<TaskResponse> writeMetadata(
+            @NotNull final WriteMetadataTaskRequest writeMetadataTaskRequest
+    ) throws IOException, URISyntaxException {
+        return getAbstractWriteMetadataResource().writeMetadata(writeMetadataTaskRequest);
+    }
+
     @Override
     public void close() throws IOException {
         asyncRequestExecutor.close();

src/main/java/com/cloudconvert/resource/async/AsyncWriteMetadataResource.java

@@ -0,0 +1,41 @@
+package com.cloudconvert.resource.async;
+
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.client.setttings.SettingsProvider;
+import com.cloudconvert.dto.request.WriteMetadataTaskRequest;
+import com.cloudconvert.dto.response.TaskResponse;
+import com.cloudconvert.dto.result.AsyncResult;
+import com.cloudconvert.executor.AsyncRequestExecutor;
+import com.cloudconvert.resource.AbstractWriteMetadataResource;
+import lombok.extern.slf4j.Slf4j;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+
+@Slf4j
+public class AsyncWriteMetadataResource extends AbstractWriteMetadataResource<AsyncResult<TaskResponse>> {
+
+    private final AsyncRequestExecutor asyncRequestExecutor;
+
+    public AsyncWriteMetadataResource(
+        final SettingsProvider settingsProvider,
+        final ObjectMapperProvider objectMapperProvider, final AsyncRequestExecutor asyncRequestExecutor
+    ) {
+        super(settingsProvider, objectMapperProvider);
+
+        this.asyncRequestExecutor = asyncRequestExecutor;
+    }
+
+    @Override
+    public AsyncResult<TaskResponse> writeMetadata(
+        @NotNull final WriteMetadataTaskRequest writeMetadataTaskRequest
+    ) throws IOException, URISyntaxException {
+        return asyncRequestExecutor.execute(getWriteMetadataHttpUriRequest(writeMetadataTaskRequest), TASK_RESPONSE_TYPE_REFERENCE);
+    }
+
+    @Override
+    public void close() throws IOException {
+        asyncRequestExecutor.close();
+    }
+}