Rewrite WordPressOrgRestApi (#724)

Author: crazytonyli

CHANGELOG.md

@@ -34,7 +34,7 @@ _None._
 
 ### Breaking Changes
 
-_None._
+- Rewrite `WordPressOrgRestApi` to support self hosted sites and WordPress.com sites. [#724]
 
 ### New Features
 

WordPressKit.xcodeproj/project.pbxproj

@@ -1,8 +1,8 @@
 import Foundation
 
 public class BlockEditorSettingsServiceRemote {
-    let remoteAPI: WordPressRestApi
-    public init(remoteAPI: WordPressRestApi) {
+    let remoteAPI: WordPressOrgRestApi
+    public init(remoteAPI: WordPressOrgRestApi) {
         self.remoteAPI = remoteAPI
     }
 }
@@ -11,30 +11,15 @@ public class BlockEditorSettingsServiceRemote {
 public extension BlockEditorSettingsServiceRemote {
     typealias EditorThemeCompletionHandler = (Swift.Result<RemoteEditorTheme?, Error>) -> Void
 
-    func fetchTheme(forSiteID siteID: Int?, _ completion: @escaping EditorThemeCompletionHandler) {
+    func fetchTheme(completion: @escaping EditorThemeCompletionHandler) {
         let requestPath = "/wp/v2/themes"
-        let parameters: [String: AnyObject] = ["status": "active" as AnyObject]
-        let modifiedPath = remoteAPI.requestPath(fromOrgPath: requestPath, with: siteID)
-        remoteAPI.GET(modifiedPath, parameters: parameters) { [weak self] (result, _) in
-            guard let `self` = self else { return }
-            switch result {
-            case .success(let response):
-                self.processEditorThemeResponse(response) { editorTheme in
-                    completion(.success(editorTheme))
-                }
-            case .failure(let error):
-                completion(.failure(error))
-            }
-        }
-    }
-
-    private func processEditorThemeResponse(_ response: Any, completion: (_ editorTheme: RemoteEditorTheme?) -> Void) {
-        guard let responseData = try? JSONSerialization.data(withJSONObject: response, options: []),
-              let editorThemes = try? JSONDecoder().decode([RemoteEditorTheme].self, from: responseData) else {
-            completion(nil)
-            return
+        let parameters = ["status": "active"]
+        Task { @MainActor in
+            let result = await self.remoteAPI.get(path: requestPath, parameters: parameters, type: [RemoteEditorTheme].self)
+                .map { $0.first }
+                .mapError { error -> Error in error }
+            completion(result)
         }
-        completion(editorThemes.first)
     }
 
 }
@@ -43,30 +28,18 @@ public extension BlockEditorSettingsServiceRemote {
 public extension BlockEditorSettingsServiceRemote {
     typealias BlockEditorSettingsCompletionHandler = (Swift.Result<RemoteBlockEditorSettings?, Error>) -> Void
 
-    func fetchBlockEditorSettings(forSiteID siteID: Int?, _ completion: @escaping BlockEditorSettingsCompletionHandler) {
-        let requestPath = "/wp-block-editor/v1/settings"
-        let parameters: [String: AnyObject] = ["context": "mobile" as AnyObject]
-        let modifiedPath = remoteAPI.requestPath(fromOrgPath: requestPath, with: siteID)
-
-        remoteAPI.GET(modifiedPath, parameters: parameters) { [weak self] (result, _) in
-            guard let `self` = self else { return }
-            switch result {
-            case .success(let response):
-                self.processBlockEditorSettingsResponse(response) { blockEditorSettings in
-                    completion(.success(blockEditorSettings))
+    func fetchBlockEditorSettings(completion: @escaping BlockEditorSettingsCompletionHandler) {
+        Task { @MainActor in
+            let result = await self.remoteAPI.get(path: "/wp-block-editor/v1/settings", parameters: ["context": "mobile"], type: RemoteBlockEditorSettings.self)
+                .map { settings -> RemoteBlockEditorSettings? in settings }
+                .flatMapError { original in
+                    if case let .unparsableResponse(response, _, underlyingError) = original, response?.statusCode == 200, underlyingError is DecodingError {
+                        return .success(nil)
+                    }
+                    return .failure(original)
                 }
-            case .failure(let error):
-                completion(.failure(error))
-            }
-        }
-    }
-
-    private func processBlockEditorSettingsResponse(_ response: Any, completion: (_ editorTheme: RemoteBlockEditorSettings?) -> Void) {
-        guard let responseData = try? JSONSerialization.data(withJSONObject: response, options: []),
-              let blockEditorSettings = try? JSONDecoder().decode(RemoteBlockEditorSettings.self, from: responseData) else {
-            completion(nil)
-            return
+                .mapError { error -> Error in error }
+            completion(result)
         }
-        completion(blockEditorSettings)
     }
 }

WordPressKit/Authenticator.swift

@@ -162,10 +162,11 @@ extension WordPressAPIResult {
     }
 
     func decodeSuccess<NewSuccess: Decodable, E: LocalizedError>(
-        _ decoder: JSONDecoder = JSONDecoder()
+        _ decoder: JSONDecoder = JSONDecoder(),
+        type: NewSuccess.Type = NewSuccess.self
     ) -> WordPressAPIResult<NewSuccess, E> where Success == HTTPAPIResponse<Data>, Failure == WordPressAPIError<E> {
         mapSuccess {
-            try decoder.decode(NewSuccess.self, from: $0.body)
+            try decoder.decode(type, from: $0.body)
         }
     }
 

WordPressKit/BlockEditorSettingsServiceRemote.swift

@@ -57,6 +57,22 @@ extension HTTPURLResponse {
         return Self.value(ofParameter: parameterName, inHeaderValue: headerValue, stripQuotes: stripQuotes)
     }
 
+    func value(forHTTPHeaderField field: String, withoutParameters: Bool) -> String? {
+        guard withoutParameters else {
+            return value(forHTTPHeaderField: field)
+        }
+
+        guard let headerValue = value(forHTTPHeaderField: field) else {
+            return nil
+        }
+
+        guard let firstSemicolon = headerValue.firstIndex(of: ";") else {
+            return headerValue
+        }
+
+        return String(headerValue[headerValue.startIndex..<firstSemicolon])
+    }
+
     static func value(ofParameter parameterName: String, inHeaderValue headerValue: String, stripQuotes: Bool = true) -> String? {
         // Find location of '<parameter>=' string in the header.
         guard let location = headerValue.range(of: parameterName + "=", options: .caseInsensitive) else {

WordPressKit/HTTPClient.swift

@@ -51,6 +51,23 @@ final class HTTPRequestBuilder {
         return self
     }
 
+    /// Append path and query to the original URL.
+    ///
+    /// Some may call API client using a string that contains path and query, like `api.get("post?id=1")`.
+    /// This function can be used to support those use cases.
+    func appendURLString(_ string: String) -> Self {
+        let urlString = Self.join("https://w.org", string)
+        guard let url = URL(string: urlString),
+              let urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: true)
+        else {
+            assertionFailure("Illegal URL string: \(string)")
+            return self
+        }
+
+        return append(percentEncodedPath: urlComponents.percentEncodedPath)
+            .append(query: urlComponents.queryItems ?? [])
+    }
+
     func header(name: String, value: String?) -> Self {
         headers[name] = value
         return self