Adding optional setting to allow automatic deletion of uploaded files if they are located in the user's temporary directory.

Author: Ruben Nine

Sources/FilestackSDK/Internal/Extensions/URL+Deletable.swift

@@ -0,0 +1,22 @@
+//
+//  URL+Deletable.swift
+//  FilestackSDK
+//
+//  Created by Ruben Nine on 16/10/2020.
+//  Copyright © 2020 Filestack. All rights reserved.
+//
+
+import Foundation
+
+extension URL: Deletable {
+    func delete() {
+        guard isDeletable else { return }
+        try? FileManager.default.removeItem(at: self)
+    }
+}
+
+private extension URL {
+    var isDeletable: Bool {
+        return path.starts(with: FileManager.default.temporaryDirectory.path)
+    }
+}

Sources/FilestackSDK/Internal/Protocols/Deletable.swift

@@ -0,0 +1,14 @@
+//
+//  Deletable.swift
+//  FilestackSDK
+//
+//  Created by Ruben Nine on 16/10/2020.
+//  Copyright © 2020 Filestack. All rights reserved.
+//
+
+import Foundation
+
+protocol Deletable {
+    /// Deletes this deletable.
+    func delete()
+}

Sources/FilestackSDK/Internal/Uploaders/MultipartUpload.swift

@@ -147,6 +147,10 @@ private extension MultipartUpload {
 
             // Block to run when operation completes.
             operation.completionBlock = {
+                if self.options.deleteTemporaryFilesAfterUpload, let deletable = uploadable as? Deletable {
+                    deletable.delete()
+                }
+
                 if let fileCompletedCount = self.progress.fileCompletedCount {
                     self.progress.fileCompletedCount = fileCompletedCount + 1
                 }

Sources/FilestackSDK/Public/Extensions/Client+Deprecated.swift

@@ -24,6 +24,7 @@ extension Client {
                                 completionHandler: @escaping (JSONResponse) -> Void) -> Uploader {
         let options = UploadOptions(preferIntelligentIngestion: useIntelligentIngestionIfAvailable,
                                     startImmediately: startUploadImmediately,
+                                    deleteTemporaryFilesAfterUpload: false,
                                     storeOptions: storeOptions)
 
         return upload(using: localURL,
@@ -46,6 +47,7 @@ extension Client {
                                 completionHandler: @escaping ([JSONResponse]) -> Void) -> Uploader {
         let options = UploadOptions(preferIntelligentIngestion: useIntelligentIngestionIfAvailable,
                                     startImmediately: startUploadImmediately,
+                                    deleteTemporaryFilesAfterUpload: false,
                                     storeOptions: storeOptions)
 
         return upload(using: localURLs,

Sources/FilestackSDK/Public/Models/UploadOptions.swift

@@ -21,7 +21,11 @@ public class UploadOptions: NSObject {
 
     /// A default set of upload options.
     @objc public static var defaults: UploadOptions = {
-        UploadOptions(preferIntelligentIngestion: true, startImmediately: true)
+        UploadOptions(
+            preferIntelligentIngestion: true,
+            startImmediately: true,
+            deleteTemporaryFilesAfterUpload: false
+        )
     }()
 
     // MARK: - Public Properties
@@ -32,6 +36,9 @@ public class UploadOptions: NSObject {
     /// Whether the upload should start immediately.
     @objc public var startImmediately: Bool
 
+    /// Whether uploaded files located in the user's temporary directoy should be deleted after being uploaded.
+    @objc public var deleteTemporaryFilesAfterUpload: Bool
+
     /// An object containing the store options (e.g. location, region, container, access, etc.)
     @objc public var storeOptions: StorageOptions
 
@@ -50,12 +57,14 @@ public class UploadOptions: NSObject {
     /// Default initializer.
     @objc public init(preferIntelligentIngestion: Bool,
                       startImmediately: Bool,
+                      deleteTemporaryFilesAfterUpload: Bool,
                       storeOptions: StorageOptions = .defaults,
                       uploadTags: [String: String] = [:],
                       partUploadConcurrency: Int = UploadOptions.defaultPartUploadConcurrency,
                       chunkUploadConcurrency: Int = UploadOptions.defaultChunkUploadConcurrency) {
         self.preferIntelligentIngestion = preferIntelligentIngestion
         self.startImmediately = startImmediately
+        self.deleteTemporaryFilesAfterUpload = deleteTemporaryFilesAfterUpload
         self.storeOptions = storeOptions
         self.uploadTags = uploadTags
         self.partUploadConcurrency = partUploadConcurrency

Tests/FilestackSDKTests/UploadTests.swift

@@ -52,6 +52,7 @@ class UploadTests: XCTestCase {
 
         let uploadOptions = UploadOptions(preferIntelligentIngestion: false,
                                           startImmediately: true,
+                                          deleteTemporaryFilesAfterUpload: false,
                                           storeOptions: defaultStoreOptions)
 
         let uploader = client.upload(using: largeFileURL, options: uploadOptions) { resp in
@@ -140,7 +141,9 @@ class UploadTests: XCTestCase {
         let expectation = self.expectation(description: "request should succeed")
         var response: [JSONResponse] = []
 
-        let uploadOptions = UploadOptions(preferIntelligentIngestion: true, startImmediately: true)
+        let uploadOptions = UploadOptions(preferIntelligentIngestion: true,
+                                          startImmediately: true,
+                                          deleteTemporaryFilesAfterUpload: false)
 
         let uploader = client.upload(options: uploadOptions) { resp in
             response = resp
@@ -161,7 +164,9 @@ class UploadTests: XCTestCase {
         let expectation = self.expectation(description: "request should succeed")
         var response: [JSONResponse] = []
 
-        let uploadOptions = UploadOptions(preferIntelligentIngestion: true, startImmediately: false)
+        let uploadOptions = UploadOptions(preferIntelligentIngestion: true,
+                                          startImmediately: false,
+                                          deleteTemporaryFilesAfterUpload: false)
 
         let uploader = client.upload(options: uploadOptions) { resp in
             response = resp
@@ -251,6 +256,7 @@ class UploadTests: XCTestCase {
 
         let uploadOptions = UploadOptions(preferIntelligentIngestion: true,
                                           startImmediately: true,
+                                          deleteTemporaryFilesAfterUpload: false,
                                           storeOptions: storeOptions)
 
         uploadOptions.uploadTags = uploadTags
@@ -303,6 +309,7 @@ class UploadTests: XCTestCase {
 
         let uploadOptions = UploadOptions(preferIntelligentIngestion: false,
                                           startImmediately: true,
+                                          deleteTemporaryFilesAfterUpload: false,
                                           storeOptions: defaultStoreOptions)
 
         let uploader = client.upload(using: [sampleFileURL], options: uploadOptions) { resp in
@@ -340,6 +347,7 @@ class UploadTests: XCTestCase {
 
         let uploadOptions = UploadOptions(preferIntelligentIngestion: false,
                                           startImmediately: true,
+                                          deleteTemporaryFilesAfterUpload: false,
                                           storeOptions: defaultStoreOptions)
 
         let uploader = client.upload(using: [sampleFileURL, sampleFileURL], options: uploadOptions) { resp in
@@ -367,6 +375,7 @@ class UploadTests: XCTestCase {
 
         let uploadOptions = UploadOptions(preferIntelligentIngestion: false,
                                           startImmediately: false,
+                                          deleteTemporaryFilesAfterUpload: false,
                                           storeOptions: defaultStoreOptions)
 
         let uploader = client.upload(options: uploadOptions) { resp in