Merge pull request #291 from zapcannon87/developer

feat(storage): keep file name

Author: zapcannon87

LeanCloudTests/LCFileTestCase.swift

@@ -161,6 +161,13 @@ class LCFileTestCase: BaseTestCase {
         XCTAssertNil(wf)
     }
 
+    func testSaveOptions() {
+        let fileURL = bundleResourceURL(name: "test", ext: "png")
+        let file = LCFile(payload: .fileURL(fileURL: fileURL))
+        XCTAssertTrue(file.save(options: .keepFileName).isSuccess)
+        XCTAssertTrue(file.url!.value.hasSuffix("/test.png"))
+    }
+    
     func testFetch() {
         let fileURL = bundleResourceURL(name: "test", ext: "png")
         let savedFile = LCFile(payload: .fileURL(fileURL: fileURL))

Sources/Foundation/File.swift

@@ -104,29 +104,49 @@ public class LCFile: LCObject {
 
     // MARK: Save
 
+    /// Save Options
+    public struct Options: OptionSet {
+        public let rawValue: Int
+        
+        public init(rawValue: Int) {
+            self.rawValue = rawValue
+        }
+        
+        /// Using "/\(LCFile.name)" as URL suffix when creating file from payload.
+        public static let keepFileName = Options(rawValue: 1 << 0)
+    }
+    
     /// Save file synchronously.
-    public func save() -> LCBooleanResult {
+    /// - Parameter options: @see `LCFile.Options`, default is none.
+    public func save(options: LCFile.Options = []) -> LCBooleanResult {
         return expect { fulfill in
-            self.save(progressOn: .main, progress: nil) { result in
+            self.save(
+                options: options,
+                progressOn: .main,
+                progress: nil)
+            { result in
                 fulfill(result)
             }
         }
     }
 
     /// Save file asynchronously.
+    /// - Parameter options: @see `LCFile.Options`, default is none.
     /// - Parameter progressQueue: The queue where the progress be called. default is main.
     /// - Parameter progress: The progress of saving.
     /// - Parameter completionQueue: The queue where the completion be called. default is main.
     /// - Parameter completion: The callback of result.
     @discardableResult
     public func save(
+        options: LCFile.Options = [],
         progressQueue: DispatchQueue = .main,
         progress: ((Double) -> Void)? = nil,
         completionQueue: DispatchQueue = .main,
         completion: @escaping (LCBooleanResult) -> Void)
         -> LCRequest
     {
         return self.save(
+            options: options,
             progressOn: progressQueue,
             progress: progress)
         { result in
@@ -154,6 +174,7 @@ public class LCFile: LCObject {
 
     @discardableResult
     private func save(
+        options: LCFile.Options,
         progressOn queue: DispatchQueue,
         progress: ((Double) -> Void)?,
         completion: @escaping (LCBooleanResult) -> Void)
@@ -168,12 +189,15 @@ public class LCFile: LCObject {
                 completionHandler: completion)
         }
         if let payload = self.payload {
-            return FileUploader(file: self, payload: payload).upload(
-                progressQueue: queue,
-                progress: progress)
-            { result in
-                self.handleUploadResult(result, completion: completion)
-            }
+            return FileUploader(
+                file: self,
+                payload: payload,
+                options: options).upload(
+                    progressQueue: queue,
+                    progress: progress,
+                    completion: { result in
+                        self.handleUploadResult(result, completion: completion)
+                })
         } else if let remoteURL = self.url {
             self.paddingInfo(remoteURL: remoteURL)
             var parameters = dictionary.jsonValue as? [String: Any]

Sources/Foundation/FileUploader.swift

@@ -17,22 +17,14 @@ import MobileCoreServices
  File uploader.
  */
 class FileUploader {
-
-    /// The file to be uploaded.
     let file: LCFile
-
-    /// The file payload to be uploaded.
     let payload: LCFile.Payload
+    let options: LCFile.Options
 
-    /**
-     Create file uploader with file.
-
-     - parameter file: The file to be uploaded.
-     - parameter payload: The file payload to be uploaded.
-     */
-    init(file: LCFile, payload: LCFile.Payload) {
+    init(file: LCFile, payload: LCFile.Payload, options: LCFile.Options) {
         self.file = file
         self.payload = payload
+        self.options = options
         let configuration = URLSessionConfiguration.default
         configuration.urlCache = nil
         self.session = Session(
@@ -260,6 +252,9 @@ class FileUploader {
         parameters["key"] = attributes.resourceKey
         parameters["name"] = attributes.name
         parameters["mime_type"] = attributes.mimeType
+        if self.options.contains(.keepFileName) {
+            parameters["keep_file_name"] = true
+        }
 
         var metaData: [String: Any] = (file.metaData?.jsonValue as? [String: Any]) ?? [:]
         metaData.merge(["size": attributes.size]) { (current, _) in current }