Merge pull request #51 from makinosp:develop

refact

Author: makinosp

Package.swift

@@ -6,7 +6,10 @@ import PackageDescription
 let package = Package(
     name: "VRCKit",
     platforms: [
-        .macOS(.v12)
+        .macOS(.v12),
+        .iOS(.v15),
+        .tvOS(.v15),
+        .watchOS(.v6)
     ],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.

Sources/VRCKit/Client.swift

@@ -24,9 +24,8 @@ public struct ErrorResponse: Codable, Error {
 //
 // MARK: API Client
 //
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
-public class APIClient {
+@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+public final class APIClient {
     typealias HTTPResponse = (data: Data, response: HTTPURLResponse)
 
     private var username: String?
@@ -41,26 +40,49 @@ public class APIClient {
         case json = "application/json"
     }
 
+    /// Initializes the API client with optional username and password.
+    /// - Parameters:
+    ///   - username: The username for basic authentication.
+    ///   - password: The password for basic authentication.
     public init(username: String? = nil, password: String? = nil) {
         self.username = username
         self.password = password
     }
 
+    /// Retrieves the cookies stored for the VRChat API domain.
+    /// - Returns: An array of `HTTPCookie` objects.
     public var cookies: [HTTPCookie] {
-        HTTPCookieStorage.shared.cookies(for: domainUrl) ?? []
+        guard let cookies = HTTPCookieStorage.shared.cookies(for: domainUrl) else { return [] }
+        return cookies
     }
 
+    /// Deletes all cookies stored for the VRChat API domain.
     public func deleteCookies() {
-        for cookie in cookies {
-            HTTPCookieStorage.shared.deleteCookie(cookie)
-        }
+        cookies.forEach { HTTPCookieStorage.shared.deleteCookie($0) }
     }
 
-    var encodedAuthorization: String {
-        "Basic \(((username ?? "") + ":" + (password ?? "")).data(using: .utf8)!.base64EncodedString())"
+    /// Encodes the given username and password into a Basic Authentication token.
+    /// - Parameters:
+    ///   - username: The username for authentication.
+    ///   - password: The password associated with the username.
+    /// - Returns: A Basic Authentication token string.
+    /// - Throws: `VRCKitError.unexpectedError` if the username and password cannot be converted to UTF-8 data.
+    func encodeAuthorization(_ username: String, _ password: String) throws -> String {
+        let authString = "\(username):\(password)"
+        guard let payload = authString.data(using: .utf8) else {
+            throw VRCKitError.unexpectedError
+        }
+        return "Basic \(payload.base64EncodedString())"
     }
 
-    /// Request to API
+    /// Sends a request to the API.
+    /// - Parameters:
+    ///   - url: The URL for the request.
+    ///   - httpMethod: The HTTP method to use for the request.
+    ///   - basic: Whether to include basic authorization.
+    ///   - httpBody: The HTTP body to include in the request.
+    /// - Returns: A tuple containing the data and the HTTP response.
+    /// - Throws: `VRCKitError` if an error occurs during the request.
     func request(
         url: URL,
         httpMethod: HttpMethod,
@@ -70,15 +92,16 @@ public class APIClient {
         var request = URLRequest(url: url)
         request.httpMethod = httpMethod.description
 
-        // Authorization
-        if basic {
-            request.addValue(encodedAuthorization, forHTTPHeaderField: "Authorization")
+        // Add authorization header if required.
+        if basic, let username = username, let password = password {
+            let authorizationHeader = try encodeAuthorization(username, password)
+            request.addValue(authorizationHeader, forHTTPHeaderField: "Authorization")
         }
 
-        // Cookie
+        // Add cookies to the request headers.
         request.allHTTPHeaderFields = HTTPCookie.requestHeaderFields(with: cookies)
 
-        // HTTP Body
+        // Add HTTP body and content type if body is provided.
         if let httpBody = httpBody {
             request.addValue(ContentType.json.rawValue, forHTTPHeaderField: "Content-Type")
             request.httpBody = httpBody
@@ -92,8 +115,7 @@ public class APIClient {
     }
 }
 
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
+@available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 extension APIClient.HttpMethod: CustomStringConvertible {
     var description: String {
         self.rawValue.uppercased()

Sources/VRCKit/Errors.swift

@@ -7,22 +7,31 @@
 
 import Foundation
 
+/// An enumeration that represents various errors that can occur in the VRCKit framework.
+/// Conforms to the `Error` and `LocalizedError` protocols for better error handling and localization.
 public enum VRCKitError: Error, LocalizedError {
-    public typealias RawValue = String
+    private typealias RawValue = String
 
+    /// Represents an error from the API with details.
     case apiError(_ details: String)
+
+    /// Represents an error indicating that the client has been deallocated.
     case clientDeallocated
-    case encodingError
+
+    /// Represents an error indicating an invalid response was received.
     case invalidResponseError
+
+    /// Represents an error indicating an invalid request with additional details.
     case invalidRequest(_ details: String)
+
+    /// Represents an unexpected error.
     case unexpectedError
 
+    /// Provides a localized description of the error.
     public var errorDescription: String? {
         switch self {
         case .apiError(let _):
             "API Error"
-        case .encodingError:
-            "Encoding Error"
         case .clientDeallocated:
             "Client Deallocated"
         case .invalidResponseError:
@@ -34,6 +43,7 @@ public enum VRCKitError: Error, LocalizedError {
         }
     }
 
+    /// Provides a localized failure reason for the error.
     public var failureReason: String? {
         switch self {
         case .apiError(let details), .invalidRequest(let details):

Sources/VRCKit/Protocols/LocationProtocol.swift

@@ -5,15 +5,14 @@
 //  Created by makinosp on 2024/06/16.
 //
 
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
+/// Represents a type that has a location string.
 public protocol LocationRepresentable {
     var location: String { get }
+    var isVisible: Bool { get }
 }
 
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
 public extension LocationRepresentable {
+    /// Determines if the location is visible based on predefined criteria.
     var isVisible: Bool {
         !["private", "offline", "traveling"].contains(location)
     }

Sources/VRCKit/Protocols/ProfileProtocols.swift

@@ -7,9 +7,9 @@
 
 import Foundation
 
-/// Common properties the 3 structures User, Friend, and UserDetail
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
+/// A protocol representing common properties for user profile elements.
+/// This protocol can be adopted by structures such as User, Friend, and UserDetail.
+@available(iOS 13.0, *)
 public protocol ProfileElementRepresentable: Hashable, Identifiable {
     var bio: String? { get }
     var bioLinks: [String]? { get }
@@ -28,16 +28,15 @@ public protocol ProfileElementRepresentable: Hashable, Identifiable {
     var friendKey: String { get }
 }
 
-/// Common properties the 2 structures User and UserDetail
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
+/// A protocol representing detailed profile properties for users.
+/// This protocol extends ProfileElementRepresentable and can be adopted by structures like User and UserDetail.
+@available(iOS 13.0, *)
 public protocol ProfileDetailRepresentable: ProfileElementRepresentable {
     var dateJoined: String { get }
     var lastActivity: Date { get }
 }
 
-@available(macOS 12.0, *)
-@available(iOS 15.0, *)
+@available(iOS 13.0, *)
 public extension ProfileElementRepresentable {
     var thumbnailUrl: URL? {
         if let userIcon = userIcon, !userIcon.isEmpty {

Sources/VRCKit/Util.swift

@@ -1,6 +1,6 @@
 //
 //  Util.swift
-//  
+//
 //
 //  Created by makinosp on 2024/03/10.
 //
@@ -12,20 +12,30 @@ public final class Util {
     private var decoder = JSONDecoder()
     private var encoder = JSONEncoder()
 
-    public init() {
+    /// Initializes the `Util` class, setting up custom encoding and decoding strategies.
+    init() {
         decoder.dateDecodingStrategy = .formatted(.iso8601Full)
         decoder.keyDecodingStrategy = .convertFromSnakeCase
         encoder.dateEncodingStrategy = .formatted(.iso8601Full)
     }
 
-    public func urlComponents(_ string: String) throws -> URLComponents {
+    /// Creates URL components from a given string.
+    /// - Parameter string: The URL string to be converted into `URLComponents`.
+    /// - Throws: `VRCKitError.invalidRequest` if the URL string is invalid.
+    /// - Returns: A `URLComponents` object created from the input string.
+    func urlComponents(_ string: String) throws -> URLComponents {
         guard let urlComponents = URLComponents(string: string) else {
             throw VRCKitError.invalidRequest("Bad URL: \(string)")
         }
         return urlComponents
     }
 
-    public func decode<T: Decodable>(_ data: Data) throws -> T {
+    /// Decodes JSON data into a specified `Decodable` type.
+    /// - Parameter data: The JSON data to decode.
+    /// - Throws: `VRCKitError.apiError` if the decoded data contains an API error.
+    /// - Throws: `DecodingError` if the decoding process fails.
+    /// - Returns: The decoded object of type `T`.
+    func decode<T: Decodable>(_ data: Data) throws -> T {
         do {
             return try decoder.decode(T.self, from: data)
         } catch {
@@ -44,7 +54,11 @@ public final class Util {
         }
     }
 
-    public func encode(_ data: Encodable) throws -> Data {
+    /// Encodes an `Encodable` object into JSON data.
+    /// - Parameter data: The object to encode.
+    /// - Throws: An error if the encoding process fails.
+    /// - Returns: The encoded JSON data.
+    func encode(_ data: Encodable) throws -> Data {
         try encoder.encode(data)
     }
 }