2.0.0 - Swift concurrency & authentication update

.swiftpm/xcode/xcshareddata/xcschemes/TraktKit.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1330"
+   LastUpgradeVersion = "1620"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,7 +26,19 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      systemAttachmentLifetime = "keepNever"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "TraktKit"
+            BuildableName = "TraktKit"
+            BlueprintName = "TraktKit"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
          <TestableReference
             skipped = "NO">

Common/DateParser.swift

@@ -23,32 +23,24 @@ internal extension Date {
 
     enum DateParserError: Error {
         case failedToParseDateFromString(String)
-        case typeUnhandled(Any?)
     }
 
     // MARK: - Class
 
-    static func dateFromString(_ string: Any?) throws -> Date {
-        if let dateString = string as? String {
-
-            let count = dateString.count
-            if count <= 10 {
-                ISO8601DateFormatter.dateFormat = "yyyy-MM-dd"
-            } else if count == 23 {
-                ISO8601DateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss ZZZ"
-            } else {
-                ISO8601DateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
-            }
+    static func dateFromString(_ dateString: String) throws(DateParserError) -> Date {
+        let count = dateString.count
+        if count <= 10 {
+            ISO8601DateFormatter.dateFormat = "yyyy-MM-dd"
+        } else if count == 23 {
+            ISO8601DateFormatter.dateFormat = "yyyy-MM-dd HH:mm:ss ZZZ"
+        } else {
+            ISO8601DateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
+        }
 
-            if let date = ISO8601DateFormatter.date(from: dateString) {
-                return date
-            } else {
-                throw DateParserError.failedToParseDateFromString("String to parse: \(dateString), date format: \(String(describing: ISO8601DateFormatter.dateFormat))")
-            }
-        } else if let date = string as? Date {
+        if let date = ISO8601DateFormatter.date(from: dateString) {
             return date
         } else {
-            throw DateParserError.typeUnhandled(string)
+            throw .failedToParseDateFromString("String to parse: \(dateString), date format: \(String(describing: ISO8601DateFormatter.dateFormat))")
         }
     }
 

Common/Extensions/URL+Extensions.swift

@@ -0,0 +1,39 @@
+//
+//  URL+Extensions.swift
+//  TraktKit
+//
+//  Created by Maximilian Litteral on 2/22/25.
+//
+
+import Foundation
+
+extension URL {
+    func queryDict() -> [String: Any] {
+        var info: [String: Any] = [String: Any]()
+        if let queryString = self.query{
+            for parameter in queryString.components(separatedBy: "&"){
+                let parts = parameter.components(separatedBy: "=")
+                if parts.count > 1 {
+                    let key = parts[0].removingPercentEncoding
+                    let value = parts[1].removingPercentEncoding
+                    if key != nil && value != nil{
+                        info[key!] = value
+                    }
+                }
+            }
+        }
+        return info
+    }
+
+    /// Compares components, which doesn't require query parameters to be in any particular order
+    public func compareComponents(_ url: URL) -> Bool {
+        guard let components = URLComponents(url: self, resolvingAgainstBaseURL: false),
+              let urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: false) else { return false }
+
+        return components.scheme == urlComponents.scheme &&
+        components.host == urlComponents.host &&
+        components.path == urlComponents.path &&
+        components.queryItems?.enumerated().compactMap { $0.element.name }.sorted() == urlComponents.queryItems?.enumerated().compactMap { $0.element.name }.sorted() &&
+        components.queryItems?.enumerated().compactMap { $0.element.value }.sorted() == urlComponents.queryItems?.enumerated().compactMap { $0.element.value }.sorted()
+    }
+}

Common/MLKeychain.swift

@@ -22,7 +22,8 @@ let kSecAttrAccessibleValue = kSecAttrAccessible as String
 let kSecAttrAccessibleAfterFirstUnlockValue = kSecAttrAccessibleAfterFirstUnlock as String
 
 public class MLKeychain {
-
+
+    @discardableResult
     class func setString(value: String, forKey key: String) -> Bool {
         let data = value.data(using: String.Encoding.utf8, allowLossyConversion: false)!
 

Common/Models/Authentication/AuthenticationInfo.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-public struct AuthenticationInfo: Decodable, Hashable {
+public struct AuthenticationInfo: TraktObject {
     public let accessToken: String
     public let tokenType: String
     public let expiresIn: TimeInterval

Common/Models/Authentication/DeviceCode.swift

@@ -5,36 +5,13 @@
 //  Copyright © 2020 Maximilian Litteral. All rights reserved.
 //
 
-#if canImport(UIKit)
-import UIKit
-#endif
-
-public struct DeviceCode: Codable {
+public struct DeviceCode: TraktObject {
     public let deviceCode: String
     public let userCode: String
     public let verificationURL: String
-    public let expiresIn: Int
-    public let interval: Int
-
-    #if canImport(UIKit)
-    #if canImport(CoreImage)
-    public func getQRCode() -> UIImage? {
-        let data = self.verificationURL.data(using: String.Encoding.ascii)
-
-        if let filter = CIFilter(name: "CIQRCodeGenerator") {
-            filter.setValue(data, forKey: "inputMessage")
-            let transform = CGAffineTransform(scaleX: 3, y: 3)
-
-            if let output = filter.outputImage?.transformed(by: transform) {
-                return UIImage(ciImage: output)
-            }
-        }
+    public let expiresIn: TimeInterval
+    public let interval: TimeInterval
 
-        return nil
-    }
-    #endif
-    #endif
-
     enum CodingKeys: String, CodingKey {
         case deviceCode = "device_code"
         case userCode = "user_code"
@@ -43,3 +20,26 @@ public struct DeviceCode: Codable {
         case interval
     }
 }
+
+#if canImport(UIKit) && canImport(CoreImage)
+import UIKit
+import CoreImage
+
+extension DeviceCode {
+    public func getQRCode(scale: CGFloat = 3) -> UIImage? {
+        guard
+            let data = "\(verificationURL)/\(userCode)".data(using: .ascii),
+            let filter = CIFilter(name: "CIQRCodeGenerator")
+        else { return nil }
+
+        filter.setValue(data, forKey: "inputMessage")
+
+        guard let output = filter.outputImage?.transformed(by: CGAffineTransform(scaleX: scale, y: scale)) else {
+            return nil
+        }
+
+        return UIImage(ciImage: output)
+    }
+}
+
+#endif

Common/Models/Authentication/OAuthBody.swift

@@ -0,0 +1,46 @@
+//
+//  OAuthBody.swift
+//  TraktKit
+//
+//  Created by Maximilian Litteral on 3/5/25.
+//
+
+struct OAuthBody: TraktObject {
+    let code: String?
+    let accessToken: String?
+    let refreshToken: String?
+
+    let clientId: String?
+    let clientSecret: String?
+
+    let redirectURI: String?
+    let grantType: String?
+
+    enum CodingKeys: String, CodingKey {
+        case code
+        case accessToken = "token"
+        case refreshToken = "refresh_token"
+        case clientId = "client_id"
+        case clientSecret = "client_secret"
+        case redirectURI = "redirect_uri"
+        case grantType = "grant_type"
+    }
+
+    init(
+        code: String? = nil,
+        accessToken: String? = nil,
+        refreshToken: String? = nil,
+        clientId: String? = nil,
+        clientSecret: String? = nil,
+        redirectURI: String? = nil,
+        grantType: String? = nil
+    ) {
+        self.code = code
+        self.accessToken = accessToken
+        self.refreshToken = refreshToken
+        self.clientId = clientId
+        self.clientSecret = clientSecret
+        self.redirectURI = redirectURI
+        self.grantType = grantType
+    }
+}

Common/Models/BodyPost.swift

@@ -9,21 +9,32 @@
 import Foundation
 
 /// Body data for endpoints like `/sync/history` that contains Trakt Ids.
-struct TraktMediaBody<ID: Encodable>: Encodable {
+struct TraktMediaBody<ID: EncodableTraktObject>: EncodableTraktObject {
     let movies: [ID]?
     let shows: [ID]?
     let seasons: [ID]?
     let episodes: [ID]?
     let ids: [Int]?
+    /// Cast and crew, not users
     let people: [ID]?
-
-    init(movies: [ID]? = nil, shows: [ID]? = nil, seasons: [ID]? = nil, episodes: [ID]? = nil, ids: [Int]? = nil, people: [ID]? = nil) {
+    let users: [ID]?
+
+    init(
+        movies: [ID]? = nil,
+        shows: [ID]? = nil,
+        seasons: [ID]? = nil,
+        episodes: [ID]? = nil,
+        ids: [Int]? = nil,
+        people: [ID]? = nil,
+        users: [ID]? = nil
+    ) {
         self.movies = movies
         self.shows = shows
         self.seasons = seasons
         self.episodes = episodes
         self.ids = ids
         self.people = people
+        self.users = users
     }
 }
 
@@ -55,37 +66,46 @@ class TraktCommentBody: TraktSingleObjectBody<SyncId> {
     }
 }
 
-/// ID used to sync with Trakt.
-public struct SyncId: Codable, Hashable {
+/**
+ Trakt or Slug ID to send to Trakt in POST requests related to media objects and users.
+ */
+public struct SyncId: TraktObject {
     /// Trakt id of the movie / show / season / episode
-    public let trakt: Int
-
+    public let trakt: Int?
+    /// Slug id for movie / show / season / episode / user
+    public let slug: String?
+
     enum CodingKeys: String, CodingKey {
         case ids
     }
 
     enum IDCodingKeys: String, CodingKey {
         case trakt
+        case slug
     }
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         var nested = container.nestedContainer(keyedBy: IDCodingKeys.self, forKey: .ids)
-        try nested.encode(trakt, forKey: .trakt)
+        try nested.encodeIfPresent(trakt, forKey: .trakt)
+        try nested.encodeIfPresent(slug, forKey: .slug)
     }
 
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let nested = try container.nestedContainer(keyedBy: IDCodingKeys.self, forKey: .ids)
-        self.trakt = try nested.decode(Int.self, forKey: .trakt)
+        self.trakt = try nested.decodeIfPresent(Int.self, forKey: .trakt)
+        self.slug = try nested.decodeIfPresent(String.self, forKey: .slug)
     }
 
-    public init(trakt: Int) {
+    public init(trakt: Int? = nil, slug: String? = nil) {
+        assert(!(trakt == nil && slug == nil), "One of the ids must be set.")
         self.trakt = trakt
+        self.slug = slug
     }
 }
 
-public struct AddToHistoryId: Encodable, Hashable {
+public struct AddToHistoryId: EncodableTraktObject {
     /// Trakt id of the movie / show / season / episode
     public let trakt: Int
     /// UTC datetime when the item was watched.
@@ -112,7 +132,7 @@ public struct AddToHistoryId: Encodable, Hashable {
     }
 }
 
-public struct RatingId: Encodable, Hashable {
+public struct RatingId: EncodableTraktObject {
     /// Trakt id of the movie / show / season / episode
     public let trakt: Int
     /// Between 1 and 10.
@@ -143,7 +163,7 @@ public struct RatingId: Encodable, Hashable {
     }
 }
 
-public struct CollectionId: Encodable, Hashable {
+public struct CollectionId: EncodableTraktObject {
     /// Trakt id of the movie / show / season / episode
     public let trakt: Int
     /// UTC datetime when the item was collected. Set to `released` to automatically use the inital release date.

Common/Models/Calendar/CalendarMovie.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-public struct CalendarMovie: Codable, Hashable {
+public struct CalendarMovie: TraktObject {
     public let released: Date
     public let movie: TraktMovie
 }

Common/Models/Calendar/CalendarShow.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-public struct CalendarShow: Codable, Hashable {
+public struct CalendarShow: TraktObject {
     public let firstAired: Date
     public let episode: TraktEpisode
     public let show: TraktShow

Common/Models/Certifications/Certification.swift

@@ -8,14 +8,14 @@
 
 import Foundation
 
-public struct Certifications: Codable, Hashable {
+public struct Certifications: TraktObject {
     public let us: [Certification]
 
     enum CodingKeys: String, CodingKey {
         case us
     }
 
-    public struct Certification: Codable, Hashable {
+    public struct Certification: TraktObject {
         public let name: String
         public let slug: String
         public let description: String