Chore/update

.github/CONTRIBUTING.md

@@ -3,7 +3,7 @@
   However to keep things clean and neat we ask you follow these small guidelines to help ensure everything runs smoothly.
 
 ## Pull Requests
-  Please direct all Pull Requests to the `swift-development` branch of the repo, to ensure that master will always match with the CocoaPod.
+  Please direct all Pull Requests to the `main` branch of the repo.
 
   Also please
 

.github/workflows/tuskit-ci.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       matrix:
         os: ["macos-latest"]
-        swift: ["5.5"]
+        swift: ["5"]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Extract Branch Name
@@ -19,9 +19,3 @@ jobs:
         run: swift build -Xswiftc --disable-experimental-concurrency
       - name: Run tests
         run: swift test -Xswiftc --disable-experimental-concurrency
-      - uses: 8398a7/action-slack@v3
-        if: failure() && env.BRANCH == 'master'
-        with:
-          status: failure
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

.swiftpm/xcode/xcshareddata/xcschemes/TUSKit.xcscheme

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1420"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "TUSKit"
+               BuildableName = "TUSKit"
+               BlueprintName = "TUSKit"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "TUSKitTests"
+               BuildableName = "TUSKitTests"
+               BlueprintName = "TUSKitTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "TUSKit"
+            BuildableName = "TUSKit"
+            BlueprintName = "TUSKit"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

CHANGELOG.md

@@ -1,3 +1,34 @@
+# 3.1.7
+
+# Enhancements
+- It's now possible to inspect the status code for failed uploads that did not have a 200 OK HTTP status code. See the following example from the sample app:
+
+```swift
+func uploadFailed(id: UUID, error: Error, context: [String : String]?, client: TUSClient) {
+    Task { @MainActor in
+        uploads[id] = .failed(error: error)
+
+        if case TUSClientError.couldNotUploadFile(underlyingError: let underlyingError) = error,
+           case TUSAPIError.failedRequest(let response) = underlyingError {
+            print("upload failed with response \(response)")
+        }
+    }
+}
+```
+
+# 3.1.6
+
+# Enhancements
+- Added ability to fetch in progress / current uploads using `getStoredUploads()` on a `TUSClient` instance.
+
+# 3.1.5
+## Fixed
+- Fixed issue with missing custom headers.
+
+# 3.1.4
+## Fixed
+- Fix compile error Xcode 14
+
 # 3.1.3
 ## Fixed
 - Added `supportedExtensions` to client

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 tus - Resumable File Uploads
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Package.swift

@@ -5,7 +5,7 @@ import PackageDescription
 
 let package = Package(
     name: "TUSKit",
-    platforms: [.iOS(.v10), .macOS(.v10_10)],
+    platforms: [.iOS(.v13), .macOS(.v11)],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(

ROADMAP.md

@@ -1 +1,14 @@
+# Roadmap
 
+- [x] Release version with latest changes (changes: https://github.com/tus/TUSKit/compare/3.1.4...main, relevant issues: https://github.com/tus/TUSKit/issues/138, https://github.com/tus/TUSKit/issues/141 and https://community.transloadit.com/t/ios-tus-client-version-update/16395/3)
+- [ ] Create a documentation describing the release process (pods, swift package manager?)
+- [ ] Update metadata (author, language, repo) in CocoaPods: https://cocoapods.org/pods/TUSKit
+- [ ] Create an example app where TUSKit is used in (would show you how to use the client from a customer’s point of view. Should help evolve the API)
+  - [x] Add pause / resume functionality
+  - [x] Add progress indicator
+  - [x] Add ability to resume uploads from previous app session
+  - [ ] Add ability to upload files in background
+- [ ] Review and address issues & PRs in GitHub until there are zero
+- [ ] ~~Create a release blog post on tus.io with the changes from 2.x to 3.x and some usage examples~~
+- [ ] Fix CI tests
+- [ ] Think about automating releasing using CI

Sources/TUSKit/Files.swift

@@ -67,7 +67,16 @@ final class Files {
     }
 
     static private var documentsDirectory: URL {
+#if os(macOS)
+        var directory = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask)[0]
+        if let bundleId = Bundle.main.bundleIdentifier {
+            directory = directory.appendingPathComponent(bundleId)
+        }
+        return directory
+#else
         return FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
+#endif
+
     }
 
     /// Loads all metadata (decoded plist files) from the target directory.
@@ -80,7 +89,6 @@ final class Files {
     /// - Returns: An array of UploadMetadata types
     func loadAllMetadata() throws -> [UploadMetadata] {
         try queue.sync {
-
             let directoryContents = try FileManager.default.contentsOfDirectory(at: storageDirectory, includingPropertiesForKeys: nil)
 
             // if you want to filter the directory contents you can do like this:
@@ -153,11 +161,14 @@ final class Files {
     /// - Throws: Any error from FileManager when removing a file.
     func removeFileAndMetadata(_ metaData: UploadMetadata) throws {
         let filePath = metaData.filePath
-        let metaDataPath = metaData.filePath.appendingPathExtension("plist")
+        let fileName = filePath.lastPathComponent
+        let metaDataPath = storageDirectory.appendingPathComponent(fileName).appendingPathExtension("plist")
 
         try queue.sync {
-            try FileManager.default.removeItem(at: filePath)
             try FileManager.default.removeItem(at: metaDataPath)
+#if os(iOS)
+            try FileManager.default.removeItem(at: filePath)
+#endif
         }
     }
 
@@ -174,8 +185,8 @@ final class Files {
                 // Could not find the file that's related to this metadata.
                 throw FilesError.relatedFileNotFound
             }
-
-            let targetLocation = metaData.filePath.appendingPathExtension("plist")
+            let fileName = metaData.filePath.lastPathComponent
+            let targetLocation = storageDirectory.appendingPathComponent(fileName).appendingPathExtension("plist")
             try self.makeDirectoryIfNeeded()
 
             let encoder = PropertyListEncoder()

Sources/TUSKit/TUSAPI.swift

@@ -8,11 +8,12 @@
 import Foundation
 
 /// The errors a TUSAPI can return
-enum TUSAPIError: Error {
+public enum TUSAPIError: Error {
     case underlyingError(Error)
     case couldNotFetchStatus
     case couldNotRetrieveOffset
     case couldNotRetrieveLocation
+    case failedRequest(HTTPURLResponse)
 }
 
 /// The status of an upload.
@@ -51,6 +52,10 @@ final class TUSAPI {
             processResult(completion: completion) {
                 let (_, response) =  try result.get()
 
+                guard (200...299).contains(response.statusCode) else {
+                    throw TUSAPIError.failedRequest(response)
+                }
+
                 guard let lengthStr = response.allHeaderFields[caseInsensitive: "upload-Length"] as? String,
                       let length = Int(lengthStr),
                       let offsetStr = response.allHeaderFields[caseInsensitive: "upload-Offset"] as? String,
@@ -78,6 +83,10 @@ final class TUSAPI {
         let task = session.dataTask(request: request) { (result: Result<(Data?, HTTPURLResponse), Error>) in
             processResult(completion: completion) {
                 let (_, response) = try result.get()
+
+                guard (200...299).contains(response.statusCode) else {
+                    throw TUSAPIError.failedRequest(response)
+                }
 
                 guard let location = response.allHeaderFields[caseInsensitive: "location"] as? String,
                       let locationURL = URL(string: location, relativeTo: metaData.uploadURL) else {
@@ -104,6 +113,11 @@ final class TUSAPI {
             if let mimeType = metaData.mimeType, !mimeType.isEmpty {
                 metaDataDict["filetype"] = mimeType
             }
+
+            if let context = metaData.context {
+                metaDataDict = metaDataDict.merging(context) { _, new in new }
+            }
+
             return metaDataDict
         }
 
@@ -114,7 +128,7 @@ final class TUSAPI {
             for (key, value) in dict {
                 let appendingStr: String
                 if !str.isEmpty {
-                    str += ", "
+                    str += ","
                 }
                 appendingStr = "\(key) \(value.toBase64())"
                 str = str + appendingStr
@@ -169,6 +183,10 @@ final class TUSAPI {
             processResult(completion: completion) {
                 let (_, response) = try result.get()
 
+                guard (200...299).contains(response.statusCode) else {
+                    throw TUSAPIError.failedRequest(response)
+                }
+
                 guard let offsetStr = response.allHeaderFields[caseInsensitive: "upload-offset"] as? String,
                       let offset = Int(offsetStr) else {
                     throw TUSAPIError.couldNotRetrieveOffset

Sources/TUSKit/TUSBackground.swift

@@ -9,7 +9,6 @@ import Foundation
 import BackgroundTasks
 
 #if os(iOS)
-@available(iOS 13.0, *)
 /// Perform background uploading
 final class TUSBackground {