Remove prefix use in public APIs and respell Upload as DirectUpload (#84

) * Respell MuxUpload as DirectUpload * MuxUploadSDK -> SDKLogger * UploadManager -> DirectUploadManager * MuxErrorCase -> DirectUpload.UploadError.Kind * Rename property for consistency with type name * Rename MuxUploadTests -> DirectUploadTests * Remove Error.asMuxUploadError * Move UploadError Kind to DirectUpload file * UploadsUpdateDelegate -> DirectUploadManagerDelegate * Renames DirectUploadManagerDelegate.uploadListUpdated(with:) -> DirectUploadManagerDelegate.didUpdate(managedDirectUploads:) DirectUploadManager.allManagedUploads() -> DirectUploadManager.allManagedDirectUploads() DirectUploadManager.findStartedUpload(ofFile:) -> DirectUploadManager.startedDirectUpload(ofFile:) DirectUploadManager.resumeUpload(ofFile:) -> DirectUploadManager.resumeDirectUpload(ofFile:) DirectUploadManager.resumeUpload(ofFile:completion:) -> DirectUploadManager.resumeDirectUpload(ofFile:completion:) DirectUploadManager.resumeAllUploads() -> DirectUploadManager.resumeAllDirectUploads() * Fix docs typo separately * Fix Example * Rename UploadOptions -> DirectUploadOptions * Docs * Unnest DirectUploadError Remove Error.parseAsUploadError(lastSeenUploadStatus:) * Rename UploadResult -> DirectUploadResult * DirectUpload.InputStatus renames uploadSucceeded -> finished, wraps DirectUploadResult uploadFailed -> finished, wraps DirectUploadResult awaitingUploadConfirmation -> awaitingConfirmation uploadInProgress -> transportInProgress uploadPaused -> paused * DirectUpload.Success -> DirectUpload.SuccessDetails To distinguish from DirectUploadResult.success
muxinc · Jul 31, 2023 · 3af8e48 · 3af8e48
1 parent 8a190c5
commit 3af8e48
Show file tree

Hide file tree

Showing 23 changed files with 269 additions and 278 deletions.
diff --git a/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Model/ThumbnailModel.swift b/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Model/ThumbnailModel.swift
@@ -48,13 +48,13 @@ class ThumbnailModel: ObservableObject {
     }
 
     private let asset: AVAsset
-    private let upload: MuxUpload
+    private let upload: DirectUpload
     private var thumbnailGenerator: AVAssetImageGenerator?
 
     @Published var thumbnail: CGImage?
-    @Published var uploadProgress: MuxUpload.TransportStatus?
+    @Published var uploadProgress: DirectUpload.TransportStatus?
 
-    init(asset: AVAsset, upload: MuxUpload) {
+    init(asset: AVAsset, upload: DirectUpload) {
         self.asset = asset
         self.upload = upload
 

diff --git a/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Model/UploadCreationModel.swift b/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Model/UploadCreationModel.swift
@@ -41,8 +41,8 @@ class UploadCreationModel : ObservableObject {
         }
     }
 
-    @discardableResult func startUpload(preparedMedia: PreparedUpload, forceRestart: Bool) -> MuxUpload {
-        let upload = MuxUpload(
+    @discardableResult func startUpload(preparedMedia: PreparedUpload, forceRestart: Bool) -> DirectUpload {
+        let upload = DirectUpload(
             uploadURL: preparedMedia.remoteURL,
             videoFileURL: preparedMedia.localVideoFile
         )

diff --git a/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Model/UploadListModel.swift b/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Model/UploadListModel.swift
@@ -12,7 +12,7 @@ import MuxUploadSDK
 class UploadListModel : ObservableObject {
 
     init() {
-        UploadManager.shared.addUploadsUpdatedDelegate(
+        DirectUploadManager.shared.addDelegate(
             Delegate(
                 handler: { uploads in
 
@@ -40,17 +40,17 @@ class UploadListModel : ObservableObject {
         )
     }
 
-    @Published var lastKnownUploads: [MuxUpload] = Array()
+    @Published var lastKnownUploads: [DirectUpload] = Array()
 }
 
-fileprivate class Delegate: UploadsUpdatedDelegate {
-    let handler: ([MuxUpload]) -> Void
-    
-    func uploadListUpdated(with list: [MuxUpload]) {
-        handler(list)
+fileprivate class Delegate: DirectUploadManagerDelegate {
+    let handler: ([DirectUpload]) -> Void
+
+    func didUpdate(managedDirectUploads: [DirectUpload]) {
+        handler(managedDirectUploads)
     }
 
-    init(handler: @escaping ([MuxUpload]) -> Void) {
+    init(handler: @escaping ([DirectUpload]) -> Void) {
         self.handler = handler
     }
 }
diff --git a/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Screens/UploadListView.swift b/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Screens/UploadListView.swift
@@ -23,7 +23,7 @@ struct UploadListScreen: View {
     }
 }
 
-extension MuxUpload {
+extension DirectUpload {
     var objectIdentifier: ObjectIdentifier {
         ObjectIdentifier(self)
     }
@@ -51,7 +51,7 @@ fileprivate struct ListContainerView: View {
 fileprivate struct ListItem: View {
 
     @StateObject var thumbnailModel: ThumbnailModel
-    let upload: MuxUpload
+    let upload: DirectUpload
 
     var body: some View {
         ZStack(alignment: .bottom) {
@@ -130,7 +130,7 @@ fileprivate struct ListItem: View {
         }
     }
 
-    private func statusLine(status: MuxUpload.TransportStatus?) -> String {
+    private func statusLine(status: DirectUpload.TransportStatus?) -> String {
         guard let status = status, let progress = status.progress, let startTime = status.startTime, startTime > 0 else {
             return "missing status"
         }
@@ -152,14 +152,14 @@ fileprivate struct ListItem: View {
         return "\(formattedMBytes) MB in \(formattedTime)s (\(formattedDataRate) KB/s)"
     }
 
-    private func elapsedBytesOfTotal(status: MuxUpload.TransportStatus) -> String {
+    private func elapsedBytesOfTotal(status: DirectUpload.TransportStatus) -> String {
         guard let progress = status.progress else {
             return "unknown"
         }
         return "\(progress.completedUnitCount / 1000)KB"
     }
 
-    init(upload: MuxUpload) {
+    init(upload: DirectUpload) {
         self.upload = upload
         _thumbnailModel = StateObject(
             wrappedValue: {
@@ -214,7 +214,7 @@ struct UploadListItem_Previews: PreviewProvider {
     static var previews: some View {
         ZStack {
             WindowBackground
-            let upload = MuxUpload(uploadURL: URL(string: "file:///")!, videoFileURL: URL(string: "file:///")!)
+            let upload = DirectUpload(uploadURL: URL(string: "file:///")!, videoFileURL: URL(string: "file:///")!)
             ListItem(upload: upload)
         }
     }

diff --git a/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Widgets/UploadProgressView.swift b/Example/SwiftUploadSDKExample/SwiftUploadSDKExample/Widgets/UploadProgressView.swift
@@ -40,15 +40,15 @@ struct UploadProgressView: View {
         }
     }
 
-    private func uploadStatus(uploadState: AppUploadState) -> MuxUpload.Status? {
+    private func uploadStatus(uploadState: AppUploadState) -> DirectUpload.Status? {
         switch uploadState {
         case .done(let success): return success.finalState
         case .uploading(let status): return status
         default: return nil
         }
     }
 
-    private func dataRateTxt(status: MuxUpload.Status?) -> String {
+    private func dataRateTxt(status: DirectUpload.Status?) -> String {
         guard let status = status, let progress = status.progress else {
             return ""
         }
@@ -69,7 +69,7 @@ struct UploadProgressView: View {
         }
     }
 
-    private func elapsedBytesOfTotal(status: MuxUpload.Status) -> String {
+    private func elapsedBytesOfTotal(status: DirectUpload.Status) -> String {
         guard let progress = status.progress else {
             return "unknown"
         }

diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ import MuxUploadSDK
 let directUploadURL: URL = /* Fetch the direct upload URL created before */
 let videoInputURL: URL = /* File URL to your video file. See Test App for how to retrieve a video from PhotosKit */
 
-let upload = MuxUpload(
+let upload = DirectUpload(
     uploadURL: directUploadURL,
     inputFileURL: videoInputURL,
 )

diff --git a/Sources/MuxUploadSDK/InputStandardization/UploadInputStandardizationWorker.swift b/Sources/MuxUploadSDK/InputStandardization/UploadInputStandardizationWorker.swift
@@ -43,7 +43,7 @@ class UploadInputStandardizationWorker {
 
     func standardize(
         sourceAsset: AVAsset,
-        maximumResolution: UploadOptions.InputStandardization.MaximumResolution,
+        maximumResolution: DirectUploadOptions.InputStandardization.MaximumResolution,
         outputURL: URL,
         completion: @escaping (AVAsset, AVAsset?, Error?) -> ()
     ) {

diff --git a/Sources/MuxUploadSDK/InputStandardization/UploadInputStandardizer.swift b/Sources/MuxUploadSDK/InputStandardization/UploadInputStandardizer.swift
@@ -11,7 +11,7 @@ class UploadInputStandardizer {
     func standardize(
         id: String,
         sourceAsset: AVAsset,
-        maximumResolution: UploadOptions.InputStandardization.MaximumResolution,
+        maximumResolution: DirectUploadOptions.InputStandardization.MaximumResolution,
         outputURL: URL,
         completion: @escaping (AVAsset, AVAsset?, Error?) -> ()
     ) {

diff --git a/Sources/MuxUploadSDK/InternalUtilities/ChunkedFile.swift b/Sources/MuxUploadSDK/InternalUtilities/ChunkedFile.swift
@@ -39,7 +39,7 @@ class ChunkedFile {
     /// Reads the next chunk from the file, advancing the file for the next read
     ///  This method does synchronous I/O, so call it in the background
     func readNextChunk() -> Result<FileChunk, Error> {
-        MuxUploadSDK.logger?.info("--readNextChunk(): called")
+        SDKLogger.logger?.info("--readNextChunk(): called")
         do {
             guard fileHandle != nil else {
                 return Result.failure(ChunkedFileError.invalidState("readNextChunk() called but the file was not open"))
@@ -62,7 +62,7 @@ class ChunkedFile {
                     fileHandle: fileHandle,
                     fileURL: fileURL
                 )
-                MuxUploadSDK.logger?.info("Opened file with len \(String(describing: fileSize)) at path \(fileURL.path)")
+                SDKLogger.logger?.info("Opened file with len \(String(describing: fileSize)) at path \(fileURL.path)")
             } catch {
                 throw ChunkedFileError.fileHandle(error)
             }
@@ -75,7 +75,7 @@ class ChunkedFile {
         do {
             try fileHandle?.close()
         } catch {
-            MuxUploadSDK.logger?.warning("Swallowed error closing file: \(error.localizedDescription)")
+            SDKLogger.logger?.warning("Swallowed error closing file: \(error.localizedDescription)")
         }
         state = nil
     }
@@ -87,7 +87,7 @@ class ChunkedFile {
     }
 
     private func doReadNextChunk() throws -> FileChunk {
-        MuxUploadSDK.logger?.info("--doReadNextChunk")
+        SDKLogger.logger?.info("--doReadNextChunk")
         guard let fileHandle = fileHandle, let fileURL = fileURL else {
             throw ChunkedFileError.invalidState("doReadNextChunk called without file handle. Did you call open()?")
         }

diff --git a/Sources/MuxUploadSDK/InternalUtilities/Reporting/Reporter.swift b/Sources/MuxUploadSDK/InternalUtilities/Reporting/Reporter.swift
@@ -92,7 +92,7 @@ extension Reporter {
     func reportUploadSuccess(
         inputDuration: Double,
         inputSize: UInt64,
-        options: UploadOptions,
+        options: DirectUploadOptions,
         uploadEndTime: Date,
         uploadStartTime: Date,
         uploadURL: URL
@@ -133,7 +133,7 @@ extension Reporter {
         errorDescription: String,
         inputDuration: Double,
         inputSize: UInt64,
-        options: UploadOptions,
+        options: DirectUploadOptions,
         uploadEndTime: Date,
         uploadStartTime: Date,
         uploadURL: URL
@@ -173,7 +173,7 @@ extension Reporter {
     func reportUploadInputStandardizationSuccess(
         inputDuration: Double,
         inputSize: UInt64,
-        options: UploadOptions,
+        options: DirectUploadOptions,
         nonStandardInputReasons: [UploadInputFormatInspectionResult.NonstandardInputReason],
         standardizationEndTime: Date,
         standardizationStartTime: Date,
@@ -216,7 +216,7 @@ extension Reporter {
         inputDuration: Double,
         inputSize: UInt64,
         nonStandardInputReasons: [UploadInputFormatInspectionResult.NonstandardInputReason],
-        options: UploadOptions,
+        options: DirectUploadOptions,
         standardizationEndTime: Date,
         standardizationStartTime: Date,
         uploadCanceled: Bool,

diff --git a/Sources/MuxUploadSDK/InternalUtilities/UploadInput.swift b/Sources/MuxUploadSDK/InternalUtilities/UploadInput.swift
@@ -21,10 +21,10 @@ struct UploadInput {
         )
         case standardizationFailed(AVAsset, UploadInfo)
         case awaitingUploadConfirmation(UploadInfo)
-        case uploadInProgress(UploadInfo, MuxUpload.TransportStatus)
-        case uploadPaused(UploadInfo, MuxUpload.TransportStatus)
-        case uploadSucceeded(UploadInfo, MuxUpload.Success)
-        case uploadFailed(UploadInfo, MuxUpload.UploadError)
+        case uploadInProgress(UploadInfo, DirectUpload.TransportStatus)
+        case uploadPaused(UploadInfo, DirectUpload.TransportStatus)
+        case uploadSucceeded(UploadInfo, DirectUpload.SuccessDetails)
+        case uploadFailed(UploadInfo, DirectUploadError)
     }
 
     var status: Status
@@ -83,7 +83,7 @@ struct UploadInput {
         }
     }
 
-    var transportStatus: MuxUpload.TransportStatus? {
+    var transportStatus: DirectUpload.TransportStatus? {
         switch status {
         case .ready:
             return nil
@@ -122,7 +122,7 @@ extension UploadInput {
     }
 
     mutating func processStartNetworkTransport(
-        startingTransportStatus: MuxUpload.TransportStatus
+        startingTransportStatus: DirectUpload.TransportStatus
     ) {
         if case UploadInput.Status.underInspection = status {
             status = .uploadInProgress(uploadInfo, startingTransportStatus)
@@ -132,16 +132,16 @@ extension UploadInput {
     }
 
     mutating func processUploadSuccess(
-        transportStatus: MuxUpload.TransportStatus
+        transportStatus: DirectUpload.TransportStatus
     ) {
         if case UploadInput.Status.uploadInProgress(let info, _) = status {
-            status = .uploadSucceeded(info, MuxUpload.Success(finalState: transportStatus))
+            status = .uploadSucceeded(info, DirectUpload.SuccessDetails(finalState: transportStatus))
         } else {
             return
         }
     }
 
-    mutating func processUploadFailure(error: MuxUpload.UploadError) {
+    mutating func processUploadFailure(error: DirectUploadError) {
         status = .uploadFailed(uploadInfo, error)
     }
 

diff --git a/...on+MuxUpload/MuxUpload+AVFoundation.swift → ...ectUpload/DirectUpload+AVFoundation.swift b/...on+MuxUpload/MuxUpload+AVFoundation.swift → ...ectUpload/DirectUpload+AVFoundation.swift
@@ -1,13 +1,13 @@
 //
-//  MuxUpload+AVFoundation.swift
+//  DirectUpload+AVFoundation.swift
 //
 
 import AVFoundation
 import Foundation
 
-extension MuxUpload {
+extension DirectUpload {
 
-    /// Initializes a MuxUpload from an ``AVAsset``
+    /// Initializes a DirectUpload from an ``AVAsset``
     ///
     /// - Parameters:
     ///    - uploadURL: the URL of your direct upload, see
@@ -20,7 +20,7 @@ extension MuxUpload {
     public convenience init(
         uploadURL: URL,
         inputAsset: AVAsset,
-        options: UploadOptions
+        options: DirectUploadOptions
     ) {
         self.init(
             input: UploadInput(