Define CoreAPI package (#782)

Author: mokagio

.swiftlint.yml

@@ -3,6 +3,9 @@ swiftlint_version: 0.54.0
 parent_config: https://raw.githubusercontent.com/Automattic/swiftlint-config/0f8ab6388bd8d15a04391825ab125f80cfb90704/.swiftlint.yml
 remote_timeout: 10.0
 
+excluded:
+  .build # `swift build` etc. output folder
+
 opt_in_rules:
   - overridden_super_call
   - discarded_notification_center_observer

Package.resolved

@@ -4,12 +4,46 @@ import PackageDescription
 
 let package = Package(
     name: "WordPressKit",
-    platforms: [.iOS(.v13)],
+    platforms: [
+        .iOS(.v13),
+        // The package(s) are meant for iOS only, but the use of the SwiftLint plugin down the dependency chain requires specifying a compatible macOS version.
+        .macOS(.v12),
+    ],
     products: [
         .library(name: "APIInterface", targets: ["APIInterface"]),
+        .library(name: "CoreAPI", targets: ["CoreAPI"]),
+    ],
+    dependencies: [
+        // .package(url: "https://github.com/wordpress-mobile/WordPress-iOS-Shared.git", from: "2.3.1"),
+        // See https://github.com/wordpress-mobile/WordPress-iOS-Shared/pull/354
+        .package(url: "https://github.com/wordpress-mobile/WordPress-iOS-Shared.git", branch: "mokagio/swiftlint-read-as-dependency"),
+        .package(url: "https://github.com/wordpress-mobile/wpxmlrpc", from: "0.10.0"),
+        // Test dependencies
+        .package(url: "https://github.com/AliSoftware/OHHTTPStubs", from: "9.1.0"),
+        .package(url: "https://github.com/Alamofire/Alamofire", from: "5.8.1"),
     ],
-    dependencies: [],
     targets: [
-        .target(name: "APIInterface")
+        .target(name: "APIInterface"),
+        .target(
+            name: "CoreAPI",
+            dependencies: [
+                .target(name: "APIInterface"),
+                .product(name: "WordPressShared", package: "WordPress-iOS-Shared"),
+                "wpxmlrpc"
+            ]
+        ),
+        .testTarget(
+            name: "CoreAPITests",
+            dependencies: [
+                .target(name: "CoreAPI"),
+                .product(name: "OHHTTPStubs", package: "OHHTTPStubs"),
+                .product(name: "OHHTTPStubsSwift", package: "OHHTTPStubs"),
+                "Alamofire",
+            ],
+            path: "Tests/CoreAPITests",
+            resources: [
+                .process("Stubs") // Relative to path
+            ]
+        ),
     ]
 )

Package.swift

@@ -0,0 +1,60 @@
+#import <Foundation/Foundation.h>
+#if SWIFT_PACKAGE
+#import "WordPressComRESTAPIVersionedPathBuilder.h"
+#import "WordPressComRESTAPIVersion.h"
+#else
+#import "WordPressKit/WordPressComRESTAPIVersionedPathBuilder.h"
+#endif
+
+static NSString* const WordPressComRESTApiVersionStringInvalid = @"invalid_api_version";
+static NSString* const WordPressComRESTApiVersionString_1_0 = @"rest/v1";
+static NSString* const WordPressComRESTApiVersionString_1_1 = @"rest/v1.1";
+static NSString* const WordPressComRESTApiVersionString_1_2 = @"rest/v1.2";
+static NSString* const WordPressComRESTApiVersionString_1_3 = @"rest/v1.3";
+static NSString* const WordPressComRESTApiVersionString_2_0 = @"wpcom/v2";
+
+@implementation WordPressComRESTAPIVersionedPathBuilder
+
++ (NSString *)pathForEndpoint:(NSString *)endpoint 
+                  withVersion:(WordPressComRESTAPIVersion)apiVersion
+{
+    NSString *apiVersionString = [self apiVersionStringWithEnumValue:apiVersion];
+
+    return [NSString stringWithFormat:@"%@/%@", apiVersionString, endpoint];
+}
+
++ (NSString *)apiVersionStringWithEnumValue:(WordPressComRESTAPIVersion)apiVersion
+{
+    NSString *result = nil;
+
+    switch (apiVersion) {
+        case WordPressComRESTAPIVersion_1_0:
+            result = WordPressComRESTApiVersionString_1_0;
+            break;
+
+        case WordPressComRESTAPIVersion_1_1:
+            result = WordPressComRESTApiVersionString_1_1;
+            break;
+
+        case WordPressComRESTAPIVersion_1_2:
+            result = WordPressComRESTApiVersionString_1_2;
+            break;
+
+        case WordPressComRESTAPIVersion_1_3:
+            result = WordPressComRESTApiVersionString_1_3;
+            break;
+
+        case WordPressComRESTAPIVersion_2_0:
+            result = WordPressComRESTApiVersionString_2_0;
+            break;
+
+        default:
+            NSAssert(NO, @"This should never by executed");
+            result = WordPressComRESTApiVersionStringInvalid;
+            break;
+    }
+
+    return result;
+}
+
+@end

Sources/APIInterface/WordPressComRESTAPIVersionedPathBuilder.m

@@ -0,0 +1,14 @@
+#import <Foundation/Foundation.h>
+#if SWIFT_PACKAGE
+#import "WordPressComRESTAPIVersion.h"
+#else
+#import <WordPressKit/WordPressComRESTAPIVersion.h>
+#endif
+
+@interface WordPressComRESTAPIVersionedPathBuilder: NSObject
+
++ (NSString *)pathForEndpoint:(NSString *)endpoint
+                  withVersion:(WordPressComRESTAPIVersion)apiVersion
+NS_SWIFT_NAME(path(forEndpoint:withVersion:));
+
+@end

Sources/APIInterface/include/WordPressComRESTAPIVersionedPathBuilder.h

@@ -0,0 +1,9 @@
+#import <Foundation/Foundation.h>
+
+/// Error domain of `NSError` instances that are converted from `WordPressComRestApiEndpointError`
+/// and `WordPressAPIError<WordPressComRestApiEndpointError>` instances.
+///
+/// This matches the compiler generated value and is used to ensure consistent error domain across error types and SPM or Framework build modes.
+///
+/// See `extension WordPressComRestApiEndpointError: CustomNSError` in CoreAPI package for context.
+static NSString *const _Nonnull WordPressComRestApiErrorDomain = @"WordPressKit.WordPressComRestApiError";

Sources/APIInterface/include/WordPressComRestApiErrorDomain.h

@@ -15,6 +15,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  *  @brief      The API object to use for communications.
  */
+// TODO: This needs to go before being able to put this ObjC in a package.
 @property (nonatomic, strong, readonly) WordPressComRestApi *wordPressComRestApi;
 
 /**

Sources/WordPressKit/Services/ServiceRemoteWordPressComREST.h renamed to Sources/BasicBlogAPIObjc/ServiceRemoteWordPressComREST.h

@@ -0,0 +1,29 @@
+#import "ServiceRemoteWordPressComREST.h"
+#import "WPKit-Swift.h"
+
+@implementation ServiceRemoteWordPressComREST
+
+- (instancetype)initWithWordPressComRestApi:(WordPressComRestApi *)wordPressComRestApi {
+
+    NSParameterAssert([wordPressComRestApi isKindOfClass:[WordPressComRestApi class]]);
+
+    self = [super init];
+    if (self) {
+        _wordPressComRestApi = wordPressComRestApi;
+        _wordPressComRESTAPI = wordPressComRestApi;
+    }
+    return self;
+}
+
+#pragma mark - Request URL construction
+
+- (NSString *)pathForEndpoint:(NSString *)resourceUrl
+                  withVersion:(WordPressComRESTAPIVersion)apiVersion
+{
+    NSParameterAssert([resourceUrl isKindOfClass:[NSString class]]);
+
+    return [WordPressComRESTAPIVersionedPathBuilder pathForEndpoint:resourceUrl
+                                                        withVersion:apiVersion];
+}
+
+@end

Sources/BasicBlogAPIObjc/ServiceRemoteWordPressComREST.m

@@ -1,3 +1,5 @@
+import Foundation
+
 extension Date {
 
     /// Parses a date string