Merge pull request #42 from ConvertAPI/develop

kmozsi · web-flow · commit f05abd53e97b · 2024-09-13T00:12:43.000+01:00
Merge develop into master
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ And many others files manipulations.
 In just few minutes you can integrate it into your application and use it easily.
 
 The ConvertAPI-Java library makes it easier to use the Convert API from your Java 8 projects without having to build your own API calls.
-You can get your free API secret at https://www.convertapi.com/a
+You can get your free API credentials at https://www.convertapi.com/a
 
 ## Installation
 
@@ -19,21 +19,18 @@ Add the following dependency to your pom.xml:
 <dependency>
     <groupId>com.convertapi.client</groupId>
     <artifactId>convertapi</artifactId>
-    <version>2.10</version>
+    <version>2.11</version>
 </dependency>
 ```
 
 ## Usage
 
 ### Configuration
 
-You can get your secret at https://www.convertapi.com/a
+You can get your credentials at https://www.convertapi.com/a
 
 ```java
-Config.setDefaultSecret("your-api-secret");
-// or token authentication
-Config.setDefaultToken("your-token");
-Config.setDefaultApiKey("your-api-key");
+Config.setDefaultApiCredentials("your-api-secret");
 ```
 
 ### File conversion
@@ -98,7 +95,7 @@ int conversionsConsumed = user.ConversionsConsumed;
 Create `Config` instance with the alternative domain and provide it in `convert` method. Dedicated to the region [domain list](https://www.convertapi.com/doc/servers-location).
 
 ```java
-Config config = new Config(secret, "https", "eu-v2.convertapi.com", 0, httpClientBuilder);
+Config config = new Config(credentials, "https", "eu-v2.convertapi.com", 0, httpClientBuilder);
 ```
 
 ### More examples
@@ -114,13 +111,13 @@ import com.convertapi.ConvertApi;
 
 public class SimpleConversion {
     public static void main(String[] args) {
-        ConvertApi.convert("source.docx", "result.pdf", "your-api-secret");
+        ConvertApi.convert("source.docx", "result.pdf", "your-api-credentials");
     }
 }
 ```
 
 This is the bare-minimum to convert a file using the ConvertAPI client, but you can do a great deal more with the ConvertAPI Java library.
-Take special note that you should replace `your-api-secret` with the secret you obtained in item two of the pre-requisites.
+Take special note that you should replace `your-api-credentials` with the secret you obtained in item two of the pre-requisites.
 
 ### Issues &amp; Comments
 Please leave all comments, bugs, requests, and issues on the Issues page. We'll respond to your request ASAP!
diff --git a/examples/pom.xml b/examples/pom.xml
@@ -15,7 +15,7 @@
         <dependency>
             <groupId>com.convertapi.client</groupId>
             <artifactId>convertapi</artifactId>
-            <version>2.10</version>
+            <version>2.11</version>
         </dependency>
     </dependencies>
     
diff --git a/examples/src/main/java/com/convertapi/examples/Advanced.java b/examples/src/main/java/com/convertapi/examples/Advanced.java
@@ -21,7 +21,7 @@
 public class Advanced {
 
     public static void main(String[] args) throws ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
 
         // Advanced HTTP client setup
         Config.setDefaultHttpBuilder(builder -> {
diff --git a/examples/src/main/java/com/convertapi/examples/AlternativeConverter.java b/examples/src/main/java/com/convertapi/examples/AlternativeConverter.java
diff --git a/examples/src/main/java/com/convertapi/examples/ConversionChaining.java b/examples/src/main/java/com/convertapi/examples/ConversionChaining.java
@@ -21,7 +21,7 @@
 public class ConversionChaining {
 
     public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
 
         System.out.println("Converting PDF to JPG and compressing result files with ZIP");
         CompletableFuture<ConversionResult> jpgResult = ConvertApi.convert("docx", "jpg", new Param("file", Paths.get("files/test.docx")));
diff --git a/examples/src/main/java/com/convertapi/examples/ConvertRemoteFile.java b/examples/src/main/java/com/convertapi/examples/ConvertRemoteFile.java
@@ -20,7 +20,7 @@
 public class ConvertRemoteFile {
 
     public static void main(String[] args) throws ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
 
         System.out.println("Converting remote PPTX to PDF");
         CompletableFuture<ConversionResult> result = ConvertApi.convert("pptx", "pdf",
diff --git a/examples/src/main/java/com/convertapi/examples/ConvertStream.java b/examples/src/main/java/com/convertapi/examples/ConvertStream.java
@@ -22,7 +22,7 @@
 public class ConvertStream {
 
     public static void main(String[] args) throws ExecutionException, InterruptedException, IOException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
 
         // Creating file data stream
         InputStream stream = Files.newInputStream(new File("src/main/resources/test.docx").toPath());
diff --git a/examples/src/main/java/com/convertapi/examples/ConvertWebToPdf.java b/examples/src/main/java/com/convertapi/examples/ConvertWebToPdf.java
@@ -20,7 +20,7 @@
 public class ConvertWebToPdf {
 
     public static void main(String[] args) throws ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
 
         System.out.println("Converting WEB to PDF");
         CompletableFuture<ConversionResult> result = ConvertApi.convert("web", "pdf",
diff --git a/examples/src/main/java/com/convertapi/examples/ConvertWordToPdfAndPng.java b/examples/src/main/java/com/convertapi/examples/ConvertWordToPdfAndPng.java
@@ -23,7 +23,7 @@
 public class ConvertWordToPdfAndPng {
 
     public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
         Path tempDir = Paths.get(System.getProperty("java.io.tmpdir"));
 
         System.out.println("Converting DOCX to PDF and JPG in parallel");
diff --git a/examples/src/main/java/com/convertapi/examples/CreatePdfThumbnail.java b/examples/src/main/java/com/convertapi/examples/CreatePdfThumbnail.java
@@ -21,7 +21,7 @@
 public class CreatePdfThumbnail {
 
     public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
         Path tempDir = Paths.get(System.getProperty("java.io.tmpdir"));
 
         System.out.println("Creating PDF thumbnail");
diff --git a/examples/src/main/java/com/convertapi/examples/SimpleConversion.java b/examples/src/main/java/com/convertapi/examples/SimpleConversion.java
@@ -11,7 +11,7 @@
 public class SimpleConversion {
 
     public static void main(String[] args) {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));   //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
         String resourcePath = "files/test.docx";
         String tmpDir = System.getProperty("java.io.tmpdir") + "/";
 
diff --git a/examples/src/main/java/com/convertapi/examples/SplitAndMergePdf.java b/examples/src/main/java/com/convertapi/examples/SplitAndMergePdf.java
@@ -21,7 +21,7 @@
 public class SplitAndMergePdf {
 
     public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
         Path tempDir = Paths.get(System.getProperty("java.io.tmpdir"));
 
         System.out.println("Creating PDF with the first and the last pages");
diff --git a/examples/src/main/java/com/convertapi/examples/TokenAuthentication.java b/examples/src/main/java/com/convertapi/examples/TokenAuthentication.java
diff --git a/examples/src/main/java/com/convertapi/examples/UserInformation.java b/examples/src/main/java/com/convertapi/examples/UserInformation.java
@@ -13,7 +13,7 @@
 public class UserInformation {
 
     public static void main(String[] args) {
-        Config.setDefaultSecret(getenv("CONVERTAPI_SECRET"));    //Get your secret at https://www.convertapi.com/a
+        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
         User user = ConvertApi.getUser();
 
         System.out.println("API Key: " + user.ApiKey);
diff --git a/src/main/java/com/convertapi/client/Config.java b/src/main/java/com/convertapi/client/Config.java
@@ -6,83 +6,44 @@
 
 public class Config {
 
-    private static String defaultSecret;
-    private static String defaultToken;
-    private static String defaultApiKey;
+    private static String defaultApiCredentials;
     private static int defaultTimeout = 0;  // Infinite read waiting
     private static Function<OkHttpClient.Builder, OkHttpClient.Builder> defaultHttpClientBuilder = b -> b;
     private static final String SCHEME = "https";
     private static final String HOST = "v2.convertapi.com";
     private final String scheme;
     private final String host;
-    private final String secret;
-    private final String token;
-    private final String apiKey;
+    private final String apiCredentials;
     private final int timeout;
     private final Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder;
 
     @SuppressWarnings("unused")
-    public Config(String secret, String scheme, String host, int timeout, Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder) {
+    public Config(String apiCredentials, String scheme, String host, int timeout, Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder) {
         this.scheme = scheme;
         this.host = host;
-        this.secret = secret;
-        this.token = null;
-        this.apiKey = null;
-        this.timeout = timeout;
-        this.httpClientBuilder = httpClientBuilder;
-    }
-
-    @SuppressWarnings("unused")
-    public Config(String token, String apiKey, String scheme, String host, int timeout, Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder) {
-        this.scheme = scheme;
-        this.host = host;
-        this.secret = null;
-        this.token = token;
-        this.apiKey = apiKey;
+        this.apiCredentials = apiCredentials;
         this.timeout = timeout;
         this.httpClientBuilder = httpClientBuilder;
     }
 
     @SuppressWarnings("WeakerAccess")
     public static Config defaults() {
-        if (Config.defaultSecret != null)
-            return new Config(Config.defaultSecret, SCHEME, HOST, defaultTimeout, Config.defaultHttpClientBuilder);
-        return new Config(Config.defaultToken, Config.defaultApiKey, SCHEME, HOST, defaultTimeout, Config.defaultHttpClientBuilder);
-    }
-
-    @SuppressWarnings("WeakerAccess")
-    public static Config defaults(String secret) {
-        return new Config(secret, SCHEME, HOST, defaultTimeout, Config.defaultHttpClientBuilder);
+        return new Config(Config.defaultApiCredentials, SCHEME, HOST, defaultTimeout, Config.defaultHttpClientBuilder);
     }
 
     @SuppressWarnings("WeakerAccess")
-    public static Config defaults(String token, String apiKey) {
-        return new Config(token, apiKey, SCHEME, HOST, defaultTimeout, Config.defaultHttpClientBuilder);
+    public static Config defaults(String apiCredentials) {
+        return new Config(apiCredentials, SCHEME, HOST, defaultTimeout, Config.defaultHttpClientBuilder);
     }
 
     @SuppressWarnings("WeakerAccess")
-    public static Config defaults(String secret, Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder) {
-        return new Config(secret, SCHEME, HOST, defaultTimeout, httpClientBuilder);
-    }
-
-    @SuppressWarnings("WeakerAccess")
-    public static Config defaults(String token, String apiKey, Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder) {
-        return new Config(token, apiKey, SCHEME, HOST, defaultTimeout, httpClientBuilder);
-    }
-
-    @SuppressWarnings("unused")
-    public static void setDefaultSecret(String defaultSecret) {
-        Config.defaultSecret = defaultSecret;
+    public static Config defaults(String apiCredentials, Function<OkHttpClient.Builder, OkHttpClient.Builder> httpClientBuilder) {
+        return new Config(apiCredentials, SCHEME, HOST, defaultTimeout, httpClientBuilder);
     }
 
     @SuppressWarnings("unused")
-    public static void setDefaultToken(String defaultToken) {
-        Config.defaultToken = defaultToken;
-    }
-
-    @SuppressWarnings("unused")
-    public static void setDefaultApiKey(String defaultApiKey) {
-        Config.defaultApiKey = defaultApiKey;
+    public static void setDefaultApiCredentials(String defaultApiCredentials) {
+        Config.defaultApiCredentials = defaultApiCredentials;
     }
 
     @SuppressWarnings("unused")
@@ -107,16 +68,8 @@ String getHost() {
         return host;
     }
 
-    String getSecret() {
-        return secret;
-    }
-
-    String getToken() {
-        return token;
-    }
-
-    String getApiKey() {
-        return apiKey;
+    String getApiCredentials() {
+        return apiCredentials;
     }
 
     Function<OkHttpClient.Builder, OkHttpClient.Builder> getHttpClientBuilder() {
diff --git a/src/main/java/com/convertapi/client/ConvertApi.java b/src/main/java/com/convertapi/client/ConvertApi.java
diff --git a/src/main/java/com/convertapi/client/Http.java b/src/main/java/com/convertapi/client/Http.java
diff --git a/src/main/java/com/convertapi/client/Param.java b/src/main/java/com/convertapi/client/Param.java
