Merge branch 'feature/signed-urls'

Author: josiasmontag

README.md

@@ -190,7 +190,7 @@ final TaskResponse uploadImportTaskResponse = asyncCloudConvertClient.importUsin
 final TaskResponse waitUploadImportTaskResponse = asyncCloudConvertClient.tasks().wait(uploadImportTaskResponse.getId()).get().getBody();
 ```
 
-## Signing Webhook 
+## Verify Webhook Signatures
 The node SDK allows to verify webhook requests received from CloudConvert.
 
 ```java
@@ -207,6 +207,28 @@ final String signature = "signature";
 final boolean isValid = cloudConvertClient.webhooks().verify(payload, signature);
 ```
 
+## Signed URLs
+
+Signed URLs allow converting files on demand only using URL query parameters. The Java SDK allows to generate such URLs. Therefore, you need to obtain a signed URL base and a signing secret on the [CloudConvert Dashboard](https://cloudconvert.com/dashboard/api/v2/signed-urls).
+
+```java
+
+final String base = "https://s.cloudconvert.com/..."; // You can find it in your signed URL settings.
+final String signingSecret = "..."; // You can find it in your signed URL settings.
+final String cacheKey = "mykey"; // Allows caching of the result file for 24h
+
+final Map<String, TaskRequest> tasks = ImmutableMap.of(
+        "import-my-file", new UrlImportRequest().setUrl("import-url"),
+        "convert-my-file", new ConvertFilesTaskRequest()
+        .setInput("import-my-file")
+        .setOutputFormat("pdf")
+        "export-my-file", new UrlExportRequest().setInput("convert-my-file")
+        );
+
+
+final String url = cloudConvertClient.signedUrls().sign(base, signingSecret, tasks, cacheKey);
+```
+
 ## Unit Tests
 ```
 $ mvn clean install -U -Punit-tests

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

@@ -7,13 +7,7 @@
 import com.cloudconvert.dto.response.UserResponse;
 import com.cloudconvert.dto.response.WebhookResponse;
 import com.cloudconvert.dto.result.AbstractResult;
-import com.cloudconvert.resource.AbstractExportFilesResource;
-import com.cloudconvert.resource.AbstractFilesResource;
-import com.cloudconvert.resource.AbstractImportFilesResource;
-import com.cloudconvert.resource.AbstractJobsResource;
-import com.cloudconvert.resource.AbstractTasksResource;
-import com.cloudconvert.resource.AbstractUsersResource;
-import com.cloudconvert.resource.AbstractWebhooksResource;
+import com.cloudconvert.resource.*;
 
 import java.io.Closeable;
 import java.io.IOException;
@@ -33,20 +27,22 @@ public class AbstractCloudConvertClient<
     private final AbstractUsersResource<URAR> abstractUsersResource;
     private final AbstractWebhooksResource<WRAR, WRPAR, VAR> abstractWebhooksResource;
     private final AbstractFilesResource<ISAR> abstractFilesResource;
+    private final AbstractSignedUrlResource abstractSignedUrlResource;
 
     public AbstractCloudConvertClient(
-        final AbstractTasksResource<TRAR, TRPAR, VAR, ORPAR> abstractTasksResource, final AbstractJobsResource<JRAR, JRPAR, VAR> abstractJobsResource,
-        final AbstractImportFilesResource<TRAR> abstractImportFilesResource, final AbstractExportFilesResource<TRAR> abstractExportFilesResource,
-        final AbstractUsersResource<URAR> abstractUsersResource, final AbstractWebhooksResource<WRAR, WRPAR, VAR> abstractWebhooksResource,
-        final AbstractFilesResource<ISAR> abstractFilesResource
-    ) {
+            final AbstractTasksResource<TRAR, TRPAR, VAR, ORPAR> abstractTasksResource, final AbstractJobsResource<JRAR, JRPAR, VAR> abstractJobsResource,
+            final AbstractImportFilesResource<TRAR> abstractImportFilesResource, final AbstractExportFilesResource<TRAR> abstractExportFilesResource,
+            final AbstractUsersResource<URAR> abstractUsersResource, final AbstractWebhooksResource<WRAR, WRPAR, VAR> abstractWebhooksResource,
+            final AbstractFilesResource<ISAR> abstractFilesResource, final AbstractSignedUrlResource abstractSignedUrlResource
+            ) {
         this.abstractTasksResource = abstractTasksResource;
         this.abstractJobsResource = abstractJobsResource;
         this.abstractImportFilesResource = abstractImportFilesResource;
         this.abstractExportFilesResource = abstractExportFilesResource;
         this.abstractUsersResource = abstractUsersResource;
         this.abstractWebhooksResource = abstractWebhooksResource;
         this.abstractFilesResource = abstractFilesResource;
+        this.abstractSignedUrlResource = abstractSignedUrlResource;
     }
 
     public AbstractTasksResource<TRAR, TRPAR, VAR, ORPAR> tasks() {
@@ -77,6 +73,8 @@ public AbstractFilesResource<ISAR> files() {
         return abstractFilesResource;
     }
 
+    public AbstractSignedUrlResource signedUrls() { return abstractSignedUrlResource; }
+
     @Override
     public void close() throws IOException {
         abstractTasksResource.close();
@@ -86,5 +84,6 @@ public void close() throws IOException {
         abstractUsersResource.close();
         abstractWebhooksResource.close();
         abstractFilesResource.close();
+        abstractSignedUrlResource.close();
     }
 }

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

@@ -13,22 +13,7 @@
 import com.cloudconvert.dto.result.AsyncResult;
 import com.cloudconvert.executor.AsyncRequestExecutor;
 import com.cloudconvert.extractor.ResultExtractor;
-import com.cloudconvert.resource.async.AsyncCaptureWebsitesResource;
-import com.cloudconvert.resource.async.AsyncConvertFilesResource;
-import com.cloudconvert.resource.async.AsyncCreateArchivesResource;
-import com.cloudconvert.resource.async.AsyncCreateThumbnailsResource;
-import com.cloudconvert.resource.async.AsyncExecuteCommandsResource;
-import com.cloudconvert.resource.async.AsyncExportFilesResource;
-import com.cloudconvert.resource.async.AsyncFilesResource;
-import com.cloudconvert.resource.async.AsyncGetMetadataResource;
-import com.cloudconvert.resource.async.AsyncImportFilesResource;
-import com.cloudconvert.resource.async.AsyncJobsResource;
-import com.cloudconvert.resource.async.AsyncMergeFilesResource;
-import com.cloudconvert.resource.async.AsyncOptimizeFilesResource;
-import com.cloudconvert.resource.async.AsyncTasksResource;
-import com.cloudconvert.resource.async.AsyncUsersResource;
-import com.cloudconvert.resource.async.AsyncWebhookResource;
-import com.cloudconvert.resource.async.AsyncWriteMetadataResource;
+import com.cloudconvert.resource.async.*;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -82,7 +67,8 @@ public AsyncCloudConvertClient(
             new AsyncExportFilesResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
             new AsyncUsersResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
             new AsyncWebhookResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
-            new AsyncFilesResource(settingsProvider, objectMapperProvider, asyncRequestExecutor)
+            new AsyncFilesResource(settingsProvider, objectMapperProvider, asyncRequestExecutor),
+            new AsyncSignedUrlResource(settingsProvider, objectMapperProvider, asyncRequestExecutor)
         );
     }
 }

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

@@ -13,22 +13,7 @@
 import com.cloudconvert.dto.result.Result;
 import com.cloudconvert.executor.RequestExecutor;
 import com.cloudconvert.extractor.ResultExtractor;
-import com.cloudconvert.resource.sync.CaptureWebsitesResource;
-import com.cloudconvert.resource.sync.ConvertFilesResource;
-import com.cloudconvert.resource.sync.CreateArchivesResource;
-import com.cloudconvert.resource.sync.CreateThumbnailsResource;
-import com.cloudconvert.resource.sync.ExecuteCommandsResource;
-import com.cloudconvert.resource.sync.ExportFilesResource;
-import com.cloudconvert.resource.sync.FilesResource;
-import com.cloudconvert.resource.sync.GetMetadataResource;
-import com.cloudconvert.resource.sync.ImportFilesResource;
-import com.cloudconvert.resource.sync.JobsResource;
-import com.cloudconvert.resource.sync.MergeFilesResource;
-import com.cloudconvert.resource.sync.OptimizeFilesResource;
-import com.cloudconvert.resource.sync.TasksResource;
-import com.cloudconvert.resource.sync.UsersResource;
-import com.cloudconvert.resource.sync.WebhookResource;
-import com.cloudconvert.resource.sync.WriteMetadataResource;
+import com.cloudconvert.resource.sync.*;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -84,7 +69,8 @@ public CloudConvertClient(
             new ExportFilesResource(settingsProvider, objectMapperProvider, requestExecutor),
             new UsersResource(settingsProvider, objectMapperProvider, requestExecutor),
             new WebhookResource(settingsProvider, objectMapperProvider, requestExecutor),
-            new FilesResource(settingsProvider, objectMapperProvider, requestExecutor)
+            new FilesResource(settingsProvider, objectMapperProvider, requestExecutor),
+            new SignedUrlResource(settingsProvider, objectMapperProvider, requestExecutor)
         );
     }
 }

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

@@ -131,6 +131,10 @@ protected HttpEntity getHttpEntity(
         return new ByteArrayEntity(objectMapperProvider.provide().writeValueAsBytes(map), ContentType.APPLICATION_JSON);
     }
 
+    protected String getJson(final Map<String, Object> map) throws JsonProcessingException {
+        return objectMapperProvider.provide().writeValueAsString(map);
+    }
+
     protected HttpUriRequest getHttpUriRequest(
         final Class<? extends HttpRequestBase> httpRequestBaseClass, final URI uri
     ) {

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

@@ -0,0 +1,72 @@
+package com.cloudconvert.resource;
+
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.client.setttings.SettingsProvider;
+import com.cloudconvert.dto.request.TaskRequest;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.google.common.collect.ImmutableMap;
+import org.apache.commons.codec.binary.Base64;
+import org.apache.commons.codec.binary.Hex;
+import org.jetbrains.annotations.NotNull;
+
+import javax.crypto.Mac;
+import javax.crypto.spec.SecretKeySpec;
+
+import java.nio.charset.StandardCharsets;
+import java.security.InvalidKeyException;
+import java.security.NoSuchAlgorithmException;
+import java.util.Map;
+
+
+public abstract class AbstractSignedUrlResource extends AbstractResource {
+
+    public static final String HMAC_SHA256 = "HmacSHA256";
+
+
+    public AbstractSignedUrlResource(
+            final SettingsProvider settingsProvider, final ObjectMapperProvider objectMapperProvider
+    ) {
+        super(settingsProvider, objectMapperProvider);
+
+
+    }
+
+
+    public String sign(
+            @NotNull final String base,
+            @NotNull final String signingSecret,
+            @NotNull final Map<String, TaskRequest> tasks,
+            String cacheKey
+    ) throws InvalidKeyException, NoSuchAlgorithmException, JsonProcessingException {
+
+        String url = base;
+
+        String jobJson = getJson(ImmutableMap.of("tasks", tasks));
+
+        String base64Job = Base64.encodeBase64URLSafeString(jobJson.getBytes(StandardCharsets.UTF_8));
+
+        url = url.concat("?job=").concat(base64Job);
+
+        if (cacheKey != null) {
+            url = url.concat("&cache_key=").concat(cacheKey);
+        }
+
+        final Mac mac = Mac.getInstance(HMAC_SHA256);
+        final SecretKeySpec secretKeySpec = new SecretKeySpec(signingSecret.getBytes(), HMAC_SHA256);
+        mac.init(secretKeySpec);
+
+        url = url.concat("&s=").concat(Hex.encodeHexString(mac.doFinal(url.getBytes())));
+
+        return url;
+    }
+
+
+    public String sign(
+            @NotNull final String base,
+            @NotNull final String signingSecret,
+            @NotNull final Map<String, TaskRequest> tasks
+    ) throws InvalidKeyException, NoSuchAlgorithmException, JsonProcessingException {
+        return this.sign(base, signingSecret, tasks, null);
+    }
+
+}

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

@@ -0,0 +1,29 @@
+package com.cloudconvert.resource.async;
+
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.client.setttings.SettingsProvider;
+import com.cloudconvert.executor.AsyncRequestExecutor;
+import com.cloudconvert.resource.AbstractSignedUrlResource;
+
+
+import java.io.IOException;
+
+
+public class AsyncSignedUrlResource extends AbstractSignedUrlResource {
+
+    private final AsyncRequestExecutor asyncRequestExecutor;
+
+    public AsyncSignedUrlResource(
+            final SettingsProvider settingsProvider,
+            final ObjectMapperProvider objectMapperProvider, final AsyncRequestExecutor asyncRequestExecutor
+    ) {
+        super(settingsProvider, objectMapperProvider);
+
+        this.asyncRequestExecutor = asyncRequestExecutor;
+    }
+
+    @Override
+    public void close() throws IOException {
+        asyncRequestExecutor.close();
+    }
+}

src/main/java/com/cloudconvert/resource/sync/SignedUrlResource.java

@@ -0,0 +1,27 @@
+package com.cloudconvert.resource.sync;
+
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.client.setttings.SettingsProvider;
+import com.cloudconvert.executor.RequestExecutor;
+import com.cloudconvert.resource.AbstractSignedUrlResource;
+
+import java.io.IOException;
+
+public class SignedUrlResource extends AbstractSignedUrlResource {
+
+    private final RequestExecutor requestExecutor;
+
+    public SignedUrlResource(
+        final SettingsProvider settingsProvider,
+        final ObjectMapperProvider objectMapperProvider, final RequestExecutor requestExecutor
+    ) {
+        super(settingsProvider, objectMapperProvider);
+
+        this.requestExecutor = requestExecutor;
+    }
+
+    @Override
+    public void close() throws IOException {
+        requestExecutor.close();
+    }
+}

src/test/java/com/cloudconvert/test/unit/SignedUrlUnitTest.java

@@ -0,0 +1,84 @@
+package com.cloudconvert.test.unit;
+
+import com.cloudconvert.client.CloudConvertClient;
+import com.cloudconvert.client.mapper.ObjectMapperProvider;
+import com.cloudconvert.client.setttings.SettingsProvider;
+import com.cloudconvert.dto.request.ConvertFilesTaskRequest;
+import com.cloudconvert.dto.request.TaskRequest;
+import com.cloudconvert.dto.request.UrlExportRequest;
+import com.cloudconvert.dto.request.UrlImportRequest;
+import com.cloudconvert.executor.RequestExecutor;
+import com.cloudconvert.test.framework.AbstractTest;
+import com.cloudconvert.test.framework.UnitTest;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.google.common.collect.ImmutableMap;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.junit.runner.RunWith;
+import org.mockito.Answers;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import java.security.InvalidKeyException;
+import java.security.NoSuchAlgorithmException;
+import java.util.Map;
+
+import static org.mockito.Mockito.*;
+import static org.assertj.core.api.Assertions.assertThat;
+
+@Category(UnitTest.class)
+@RunWith(MockitoJUnitRunner.class)
+public class SignedUrlUnitTest extends AbstractTest {
+
+
+    @Mock
+    private SettingsProvider settingsProvider;
+
+    @Mock
+    private RequestExecutor requestExecutor;
+
+    @Mock(answer = Answers.CALLS_REAL_METHODS)
+    private ObjectMapperProvider objectMapperProvider;
+
+    private CloudConvertClient cloudConvertClient;
+
+    @Before
+    public void before() {
+
+
+        cloudConvertClient = new CloudConvertClient(settingsProvider, objectMapperProvider, requestExecutor);
+    }
+
+    @Test
+    public void signSignedUrl() throws NoSuchAlgorithmException, InvalidKeyException, JsonProcessingException {
+
+        final Map<String, TaskRequest> tasks = ImmutableMap.of(
+                "import-my-file", new UrlImportRequest().setUrl("import-url"),
+                "convert-my-file", new ConvertFilesTaskRequest()
+                        .setInput("import-my-file")
+                        .set("width", 100)
+                        .set("height", 100),
+                "export-my-file", new UrlExportRequest().setInput("convert-my-file")
+        );
+
+        final String base = "https://s.cloudconvert.com/b3d85428-584e-4639-bc11-76b7dee9c109";
+        final String signingSecret = "NT8dpJkttEyfSk3qlRgUJtvTkx64vhyX";
+        final String cacheKey = "mykey";
+
+        final String url = cloudConvertClient.signedUrls().sign(base, signingSecret, tasks, cacheKey);
+
+        assertThat(url).startsWith(base);
+        assertThat(url).contains("?job=");
+        assertThat(url).contains("&cache_key=mykey");
+        assertThat(url).contains("&s=b04d8cf7d65ec56c839443c69dd2bb75e8792e006441019957c0d9824319612a");
+
+    }
+
+
+    @After
+    public void after() throws Exception {
+        cloudConvertClient.close();
+    }
+}