Merge pull request #80 from doubletapp/issues/78-api-version-migration

API version migration from v0.6 to v0.7
uploadcare · Oct 11, 2023 · 472e1d9 · 472e1d9
2 parents 91d0f2d + 25a9bbc
commit 472e1d9
Show file tree

Hide file tree

Showing 21 changed files with 300 additions and 214 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,17 @@
 
 # History
 
+## 4.0.0
+- Library:
+  - Migrated REST API support from v0.6 to v0.7.
+  - Removed the `UploadcareClient.storeGroup()` and `UploadcareGroup.store()` methods, as their
+    endpoints have been removed.
+  - Added support for new event types of webhooks.
+  - Removed sorting methods by file size, as the corresponding parameter has been removed from
+    the API query parameters.
+- Example:
+  - Removed sorting options by file size from `UploadFragment`.
+
 ## 3.3.0
 - Library:
   - Added support for [signing your webhooks](https://uploadcare.com/docs/webhooks/#signed-webhooks) using the `signingSecret` parameter.

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Check out [demo app](/example).
 
 Supported features:
 
-- File, group, and project API v0.6.
+- File, group, and project API v0.7.
 - Paginated resource fetching.
 - CDN path builder.
 - File uploading from a file, byte array, URL, and URI.

diff --git a/build.gradle b/build.gradle
@@ -13,7 +13,7 @@ buildscript {
 
     versions.androidx_core = "1.12.0"
     versions.material = "1.9.0"
-    versions.navigation = "2.7.2"
+    versions.navigation = "2.7.3"
     versions.lifecycle = "2.6.2"
     versions.constraintlayout = "2.1.4"
     versions.annotation = '1.7.0'

diff --git a/documentation/LIBRARY.md b/documentation/LIBRARY.md
@@ -42,7 +42,7 @@ Java
 UploadcareClient uploadcare = new UploadcareClient("YOUR_PUBLIC_KEY", "YOUR_SECRET_KEY");
 ```
 
-## List of files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/filesList)) ##
+## List of files ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/filesList)) ##
 
 ##### Asynchronous file fetch.
 
@@ -112,7 +112,7 @@ FilesQueryBuilder filesQueryBuilder = uploadcare.getFiles()
 List<UploadcareFile> files = filesQueryBuilder.asList();
 ```
 
-## File info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/fileInfo)) ##
+## File info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileInfo)) ##
 
 ##### Asynchronous file info fetch.
 
@@ -160,7 +160,7 @@ Java
 UploadcareFile file = uploadcare.getFile("YOUR_FILE_UUID");
 ```
 
-## Store a file ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/storeFile)) ##
+## Store a file ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/storeFile)) ##
 
 ##### Asynchronous file store.
 
@@ -184,7 +184,7 @@ Java
 uploadcare.saveFile("YOUR_FILE_UUID");
 ```
 
-## Batch file store ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/filesStoring)) ##
+## Batch file store ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/filesStoring)) ##
 
 ##### Asynchronous multiple files store.
 
@@ -212,7 +212,7 @@ List<String> fileIds = ... // list of file UUID's
 uploadcare.saveFiles(fileIds);
 ```
 
-## Delete file ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/deleteFile)) ##
+## Delete file ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteFileStorage)) ##
 
 ##### Asynchronous file delete.
 
@@ -236,7 +236,7 @@ Java
 uploadcare.deleteFile("YOUR_FILE_UUID");
 ```
 
-## Batch file delete ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/filesDelete)) ##
+## Batch file delete ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/filesDelete)) ##
 
 ##### Asynchronous multiple files delete.
 
@@ -264,7 +264,7 @@ List<String> fileIds = ... // list of file UUID's
 uploadcare.deleteFiles(fileIds);
 ```
 
-## Copy file to local storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFileLocal)) ##
+## Copy file to local storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/createLocalCopy)) ##
 
 ##### Asynchronous file copy to local storage.
 
@@ -321,7 +321,7 @@ UploadcareCopyFile copyResult = uploadcare.copyFileLocalStorage(source, true);
 // process result that will have either UploadcareFile or URI depending on source.
 ```
 
-## Copy file to remote storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/copyFile)) ##
+## Copy file to remote storage ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/createRemoteCopy)) ##
 
 ##### Asynchronous copy file to remote storage.
 
@@ -385,7 +385,7 @@ UploadcareCopyFile copyResult = uploadcare.copyFileRemoteStorage(source, target,
 // process result that will have either UploadcareFile or URI depending on source.
 ```
 
-## List of groups ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupsList)) ##
+## List of groups ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/groupsList)) ##
 
 ##### Asynchronous group list fetch.
 
@@ -451,7 +451,7 @@ GroupsQueryBuilder groupsQueryBuilder = uploadcare.getGroups()
 List<UploadcareGroup> groups = groupsQueryBuilder.asList();
 ```
 
-## Group info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/groupInfo)) ##
+## Group info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/groupInfo)) ##
 
 ##### Asynchronous group info fetch.
 
@@ -499,31 +499,7 @@ Java
 UploadcareGroup group = uploadcare.getGroup("YOUR_GROUP_UUID");
 ```
 
-## Store group ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#tag/Group/paths/~1groups~1%3Cuuid%3E~1storage~1/put)) ##
-
-##### Asynchronous group store.
-
-Kotlin
-```kotlin
-uploadcare.storeGroupAsync(context, "YOUR_GROUP_UUID")
-```
-Java
-```java
-uploadcare.storeGroupAsync(context, "YOUR_GROUP_UUID", null); // callback is optional
-```
-
-##### Synchronous group store.
-
-Kotlin
-```kotlin
-uploadcare.storeGroup("YOUR_GROUP_UUID")
-```
-Java
-```java
-uploadcare.storeGroup("YOUR_GROUP_UUID");
-```
-
-## Project info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/projectInfo)) ##
+## Project info ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/projectInfo)) ##
 
 ##### Asynchronous project info fetch.
 
@@ -569,7 +545,7 @@ Java
 Project project = uploadcare.getProject();
 ```
 
-## List of webhooks ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/webhooksList)) ##
+## List of webhooks ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/webhooksList)) ##
 
 ##### Asynchronous webhook list fetch.
 
@@ -615,7 +591,7 @@ Java
 List<UploadcareWebhook> webhooks = uploadcare.getWebhooks();
 ```
 
-## Create webhook ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/webhookCreate)) ##
+## Create webhook ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/webhookCreate)) ##
 
 ##### Asynchronous webhook create.
 
@@ -624,7 +600,7 @@ Kotlin
 uploadcare.createWebhookAsync(
         context, // Context
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         signingSecret = "YOUR_WEBHOOK_SIGNING_SECRET",
         callback = object : UploadcareWebhookCallback {
             override fun onFailure(e: UploadcareApiException) {
@@ -641,7 +617,7 @@ Java
 uploadcare.createWebhookAsync(
         context, // Context
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         true, // is webhook active or not.
         "YOUR_WEBHOOK_SIGNING_SECRET",
         new UploadcareWebhookCallback() {
@@ -663,7 +639,7 @@ Kotlin
 ```kotlin
 val webhook = uploadcare.createWebhook(
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         true, // is webhook active or not.
         "YOUR_WEBHOOK_SIGNING_SECRET"
         )
@@ -672,13 +648,13 @@ Java
 ```java
 UploadcareWebhook webhook = uploadcare.createWebhook(
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         true, // is webhook active or not.
         "YOUR_WEBHOOK_SIGNING_SECRET"
         );
 ```
 
-## Update webhook ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/updateWebhook)) ##
+## Update webhook ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/updateWebhook)) ##
 
 ##### Asynchronous webhook update.
 
@@ -688,7 +664,7 @@ uploadcare.updateWebhookAsync(
         context, // Context
         "YOUR_WEBHOOK_UUID",
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         signingSecret = "YOUR_WEBHOOK_SIGNING_SECRET",
         callback = object : UploadcareWebhookCallback {
             override fun onFailure(e: UploadcareApiException) {
@@ -706,7 +682,7 @@ uploadcare.updateWebhookAsync(
         context, // Context
         "YOUR_WEBHOOK_UUID",
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         true, // is webhook active or not.
         "YOUR_WEBHOOK_SIGNING_SECRET",
         new UploadcareWebhookCallback() {
@@ -729,7 +705,7 @@ Kotlin
 val webhook = uploadcare.updateWebhook(
         "YOUR_WEBHOOK_UUID",
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         true, // is webhook active or not.
         "YOUR_WEBHOOK_SIGNING_SECRET"
         )
@@ -739,13 +715,13 @@ Java
 UploadcareWebhook webhook = uploadcare.updateWebhook(
         "YOUR_WEBHOOK_UUID",
         URI.create("YOUR_WEBHOOK_URL"),
-        "YOUR_WEBHOOK_EVENT",
+        EventType.UPLOADED, // Webhook event
         true, // is webhook active or not.
         "YOUR_WEBHOOK_SIGNING_SECRET"
         );
 ```
 
-## Delete webhook ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/webhookUnsubscribe)) ##
+## Delete webhook ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/webhookUnsubscribe)) ##
 
 ##### Asynchronous webhook delete.
 
@@ -769,7 +745,7 @@ Java
 uploadcare.deleteWebhook(URI.create("YOUR_WEBHOOK_URL"));
 ```
 
-## Convert documents ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/documentConvert)) ##
+## Convert documents ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvert)) ##
 
 ##### Asynchronous documents convert.
 
@@ -858,7 +834,7 @@ DocumentConverter converter = new DocumentConverter(uploadcare, conversionJobs);
 List<UploadcareFile> result = converter.convert();
 ```
 
-## Convert videos ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.6.0/#operation/videoConvert)) ##
+## Convert videos ([API Reference](https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/videoConvert)) ##
 
 ##### Asynchronous videos convert.
 

diff --git a/example/build.gradle b/example/build.gradle
@@ -14,7 +14,7 @@ android {
         applicationId "com.uploadcare.android.example"
         minSdkVersion versions.min_sdk
         targetSdkVersion versions.target_sdk
-        versionCode 9
+        versionCode 10
         versionName "${version}"
     }
 

diff --git a/example/src/main/java/com/uploadcare/android/example/fragments/OrderDialogFragment.kt b/example/src/main/java/com/uploadcare/android/example/fragments/OrderDialogFragment.kt
@@ -36,8 +36,6 @@ class OrderDialogFragment : DialogFragment() {
     private fun orderSelected(position: Int) {
         val order: Order = when (position) {
             1 -> Order.UPLOAD_TIME_DESC
-            2 -> Order.SIZE_ASC
-            3 -> Order.SIZE_DESC
             0 -> Order.UPLOAD_TIME_ASC
             else -> Order.UPLOAD_TIME_ASC
         }
@@ -54,4 +52,4 @@ class OrderDialogFragment : DialogFragment() {
 
 interface OrderDialogListener {
     fun onOrderSelected(order: Order)
-}
+}
diff --git a/example/src/main/res/values/strings.xml b/example/src/main/res/values/strings.xml
@@ -52,7 +52,5 @@
     <array name="orders">
         <item>Upload time, Ascending (Default)</item>
         <item>Upload time, Descending</item>
-        <item>File size, Ascending</item>
-        <item>File size, Descending</item>
     </array>
 </resources>
diff --git a/gradle.properties b/gradle.properties
@@ -1,5 +1,5 @@
 # Project-wide Gradle settings.
-version=3.3.0
+version=4.0.0-SNAPSHOT
 
 # IDE (e.g. Android Studio) users:
 # Gradle settings configured through the IDE *will override*

diff --git a/library/README.md b/library/README.md
@@ -7,7 +7,7 @@ This is an Android library for Uploadcare.
 
 Supported features:
 
-- File, group, and project API v0.6.
+- File, group, and project API v0.7.
 - Paginated resources fetching.
 - CDN path builder.
 - File uploading from a file, byte array, URL, and URI.

diff --git a/library/build.gradle b/library/build.gradle
@@ -15,7 +15,7 @@ android {
     defaultConfig {
         minSdkVersion versions.min_sdk
         targetSdkVersion versions.target_sdk
-        versionCode 13
+        versionCode 14
         versionName "${version}"
         buildConfigField 'String', 'VERSION_NAME', "\"${version}\""
     }

diff --git a/library/src/main/java/com/uploadcare/android/library/api/FilesQueryBuilder.kt b/library/src/main/java/com/uploadcare/android/library/api/FilesQueryBuilder.kt
@@ -71,18 +71,6 @@ class FilesQueryBuilder(private val client: UploadcareClient)
         return this
     }
 
-    /**
-     * Adds a filter for datetime from objects will be returned.
-     * Order {@link Order#SIZE_ASC} will be used.
-     *
-     * @param fromSize File size in bytes.
-     */
-    fun from(fromSize: Long): FilesQueryBuilder {
-        parameters["ordering"] = FilesOrderParameter(Order.SIZE_ASC)
-        parameters["from"] = FilesFromParameter(fromSize)
-        return this
-    }
-
     /**
      * Adds a filter for datetime to which objects will be returned.
      * Order {@link Order#UPLOAD_TIME_DESC} will be used.
@@ -95,25 +83,13 @@ class FilesQueryBuilder(private val client: UploadcareClient)
         return this
     }
 
-    /**
-     * Adds a filter for datetime to which objects will be returned.
-     * Order {@link Order#SIZE_DESC} will be used.
-     *
-     * @param toSize File size in bytes.
-     */
-    fun to(toSize: Long): FilesQueryBuilder {
-        parameters["ordering"] = FilesOrderParameter(Order.SIZE_DESC)
-        parameters["from"] = FilesFromParameter(toSize)
-        return this
-    }
-
     /**
      * Add special fields to the file object in the result.
      *
      * @param fields Example: "rekognition_info"
      */
-    fun addFields(fields: String): FilesQueryBuilder {
-        parameters["add_fields"] = AddFieldsParameter(fields)
+    fun include(fields: String): FilesQueryBuilder {
+        parameters["include"] = IncludeParameter(fields)
         return this
     }