Merge branch 'trunk' into issue/7976-products-onboarding-banner-ui

Author: rachelmcr

CHANGELOG.md

@@ -1,6 +1,9 @@
 <!--
 Contains editorialized release notes. Raw release notes should go into `RELEASE-NOTES.txt`.
 -->
+## 11.0
+Even though this release doesn’t have any surprising new features, we still put a lot of love into it! We fixed a few bugs and made several improvements to make your experience smoother. 
+
 ## 10.9
 This release includes a lot more stability fixes to help you log in much easier. You can now connect your WordPress.com account with Jetpack and access your store that much faster. We've also updated our app to support devices with iOS 15+ only. Please update your device to iOS 15 to continue to use the app.
 

Gemfile.lock

@@ -17,20 +17,20 @@ GEM
     ast (2.4.2)
     atomos (0.1.3)
     aws-eventstream (1.2.0)
-    aws-partitions (1.631.0)
-    aws-sdk-core (3.148.0)
+    aws-partitions (1.653.0)
+    aws-sdk-core (3.166.0)
       aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-kms (1.58.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
+    aws-sdk-kms (1.59.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.114.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
+    aws-sdk-s3 (1.117.1)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.4)
-    aws-sigv4 (1.5.1)
+    aws-sigv4 (1.5.2)
       aws-eventstream (~> 1, >= 1.0.2)
     babosa (1.0.4)
     bigdecimal (1.4.4)
@@ -94,7 +94,7 @@ GEM
     escape (0.0.4)
     ethon (0.15.0)
       ffi (>= 1.15.0)
-    excon (0.92.4)
+    excon (0.93.1)
     faraday (1.10.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -124,7 +124,7 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     fastimage (2.2.6)
-    fastlane (2.210.0)
+    fastlane (2.210.1)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.8, < 3.0.0)
       artifactory (~> 3.0)
@@ -164,8 +164,9 @@ GEM
       xcpretty (~> 0.3.0)
       xcpretty-travis-formatter (>= 0.0.3)
     fastlane-plugin-appcenter (1.11.1)
-    fastlane-plugin-sentry (1.11.1)
-    fastlane-plugin-wpmreleasetoolkit (5.5.0)
+    fastlane-plugin-sentry (1.14.0)
+      os (~> 1.1, >= 1.1.4)
+    fastlane-plugin-wpmreleasetoolkit (5.6.0)
       activesupport (~> 5)
       bigdecimal (~> 1.4)
       buildkit (~> 1.5)
@@ -188,9 +189,9 @@ GEM
     git (1.12.0)
       addressable (~> 2.8)
       rchardet (~> 1.8)
-    google-apis-androidpublisher_v3 (0.26.0)
-      google-apis-core (>= 0.7, < 2.a)
-    google-apis-core (0.7.2)
+    google-apis-androidpublisher_v3 (0.29.0)
+      google-apis-core (>= 0.9.0, < 2.a)
+    google-apis-core (0.9.1)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (>= 0.16.2, < 2.a)
       httpclient (>= 2.8.1, < 3.a)
@@ -199,27 +200,27 @@ GEM
       retriable (>= 2.0, < 4.a)
       rexml
       webrick
-    google-apis-iamcredentials_v1 (0.13.0)
-      google-apis-core (>= 0.7, < 2.a)
-    google-apis-playcustomapp_v1 (0.10.0)
-      google-apis-core (>= 0.7, < 2.a)
-    google-apis-storage_v1 (0.17.0)
-      google-apis-core (>= 0.7, < 2.a)
+    google-apis-iamcredentials_v1 (0.15.0)
+      google-apis-core (>= 0.9.0, < 2.a)
+    google-apis-playcustomapp_v1 (0.12.0)
+      google-apis-core (>= 0.9.1, < 2.a)
+    google-apis-storage_v1 (0.19.0)
+      google-apis-core (>= 0.9.0, < 2.a)
     google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
     google-cloud-errors (1.3.0)
-    google-cloud-storage (1.40.0)
+    google-cloud-storage (1.43.0)
       addressable (~> 2.8)
       digest-crc (~> 0.4)
       google-apis-iamcredentials_v1 (~> 0.1)
-      google-apis-storage_v1 (~> 0.17.0)
+      google-apis-storage_v1 (~> 0.19.0)
       google-cloud-core (~> 1.6)
       googleauth (>= 0.16.2, < 2.a)
       mini_mime (~> 1.0)
-    googleauth (1.2.0)
+    googleauth (1.3.0)
       faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
@@ -250,10 +251,10 @@ GEM
     nap (1.1.0)
     naturally (2.2.1)
     netrc (0.11.0)
-    nokogiri (1.13.8)
+    nokogiri (1.13.9)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-darwin)
+    nokogiri (1.13.9-x86_64-darwin)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)

Networking/Networking.xcodeproj/project.pbxproj

@@ -164,6 +164,8 @@
 		2670C3FE270F4E6A002FE931 /* sites-malformed.json in Resources */ = {isa = PBXBuildFile; fileRef = 2670C3FD270F4E6A002FE931 /* sites-malformed.json */; };
 		267313312559CC930026F7EF /* PaymentGateway.swift in Sources */ = {isa = PBXBuildFile; fileRef = 267313302559CC930026F7EF /* PaymentGateway.swift */; };
 		26731337255ACA850026F7EF /* PaymentGatewayListMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 26731336255ACA850026F7EF /* PaymentGatewayListMapper.swift */; };
+		2676F4CE290AE6BB00C7A15B /* EntityIDMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2676F4CD290AE6BB00C7A15B /* EntityIDMapper.swift */; };
+		2676F4D0290B0EC800C7A15B /* product-id-only.json in Resources */ = {isa = PBXBuildFile; fileRef = 2676F4CF290B0EC700C7A15B /* product-id-only.json */; };
 		2683D70E24456DB8002A1589 /* categories-empty.json in Resources */ = {isa = PBXBuildFile; fileRef = 2683D70D24456DB7002A1589 /* categories-empty.json */; };
 		2683D71024456EE4002A1589 /* categories-extra.json in Resources */ = {isa = PBXBuildFile; fileRef = 2683D70F24456EE4002A1589 /* categories-extra.json */; };
 		2685C0D2263B069500D9EE97 /* AddOnGroup.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2685C0D1263B069500D9EE97 /* AddOnGroup.swift */; };
@@ -887,6 +889,8 @@
 		2670C3FD270F4E6A002FE931 /* sites-malformed.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "sites-malformed.json"; sourceTree = "<group>"; };
 		267313302559CC930026F7EF /* PaymentGateway.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentGateway.swift; sourceTree = "<group>"; };
 		26731336255ACA850026F7EF /* PaymentGatewayListMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentGatewayListMapper.swift; sourceTree = "<group>"; };
+		2676F4CD290AE6BB00C7A15B /* EntityIDMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EntityIDMapper.swift; sourceTree = "<group>"; };
+		2676F4CF290B0EC700C7A15B /* product-id-only.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "product-id-only.json"; sourceTree = "<group>"; };
 		2683D70D24456DB7002A1589 /* categories-empty.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "categories-empty.json"; sourceTree = "<group>"; };
 		2683D70F24456EE4002A1589 /* categories-extra.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "categories-extra.json"; sourceTree = "<group>"; };
 		2685C0D1263B069500D9EE97 /* AddOnGroup.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AddOnGroup.swift; sourceTree = "<group>"; };
@@ -2083,6 +2087,7 @@
 				09885C7F27C3FFD200910A62 /* product-variations-bulk-update.json */,
 				451274A525276C82009911FF /* product-variation.json */,
 				CE0A0F1E223998A00075ED8D /* products-load-all.json */,
+				2676F4CF290B0EC700C7A15B /* product-id-only.json */,
 				CCF434652906C2A400B4475A /* products-ids-only.json */,
 				CCF434692906C9C300B4475A /* products-ids-only-empty.json */,
 				0282DD90233A120A006A5FDB /* products-search-photo.json */,
@@ -2215,6 +2220,7 @@
 				DE2095BE279583A100171F1C /* CouponReportListMapper.swift */,
 				45150A9D26836A57006922EA /* CountryListMapper.swift */,
 				B524193E21AC5FE400D6FC0A /* DotcomDeviceMapper.swift */,
+				2676F4CD290AE6BB00C7A15B /* EntityIDMapper.swift */,
 				24F98C572502EA8800F49B68 /* FeatureFlagMapper.swift */,
 				DE50295C28C6068B00551736 /* JetpackUserMapper.swift */,
 				AEF9458A27297FF6001DCCFB /* IgnoringResponseMapper.swift */,
@@ -2821,6 +2827,7 @@
 				68CB801628D8A39700E169F8 /* customer.json in Resources */,
 				03EB99982907F4AA00F06A39 /* just-in-time-message-list-multiple.json in Resources */,
 				451A97DE260B59870059D135 /* shipping-label-packages-success.json in Resources */,
+				2676F4D0290B0EC800C7A15B /* product-id-only.json in Resources */,
 				31D27C8F2602B553002EDB1D /* plugins.json in Resources */,
 				261CF1B4255AD6B30090D8D3 /* payment-gateway-list.json in Resources */,
 				268B68FB24C87384007EBF1D /* leaderboards-products.json in Resources */,
@@ -3240,6 +3247,7 @@
 				029BA53B255DFABD006171FD /* ShippingLabelPrintDataMapper.swift in Sources */,
 				0359EA0D27AAC5F80048DE2D /* WCPayChargeStatus.swift in Sources */,
 				CE430674234BA6AD0073CBFF /* RefundMapper.swift in Sources */,
+				2676F4CE290AE6BB00C7A15B /* EntityIDMapper.swift in Sources */,
 				CE0A0F1B223989670075ED8D /* ProductsRemote.swift in Sources */,
 				0359EA1527AAC7460048DE2D /* WCPayCardBrand.swift in Sources */,
 				2665032E261F4FBF0079A159 /* ProductAddOnOption.swift in Sources */,

Networking/Networking/Mapper/EntityIDMapper.swift

@@ -0,0 +1,30 @@
+import Foundation
+
+/// Mapper: Single Entity ID
+///
+struct EntityIDMapper: Mapper {
+
+    /// (Attempts) to convert an instance of Data into an into an ID
+    ///
+    func map(response: Data) throws -> Int64 {
+        let decoder = JSONDecoder()
+
+        return try decoder.decode(EntityIDEnvelope.self, from: response).id
+    }
+}
+
+/// Disposable Entity:
+/// Allows us to parse a product ID with JSONDecoder.
+///
+private struct EntityIDEnvelope: Decodable {
+    private let data: [String: Int64]
+
+    // Extracts the entity ID from the underlying data
+    var id: Int64 {
+        data["id"] ?? .zero
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case data = "data"
+    }
+}

Networking/Networking/Model/Product/ProductStatus.swift

@@ -8,6 +8,7 @@ public enum ProductStatus: Codable, Hashable, GeneratedFakeable {
     case draft
     case pending
     case privateStatus  // `private` is a reserved keyword
+    case autoDraft
     case custom(String) // in case there are extensions modifying product statuses
 }
 
@@ -28,6 +29,8 @@ extension ProductStatus: RawRepresentable {
             self = .pending
         case Keys.privateStatus:
             self = .privateStatus
+        case Keys.autoDraft:
+            self = .autoDraft
         default:
             self = .custom(rawValue)
         }
@@ -41,6 +44,7 @@ extension ProductStatus: RawRepresentable {
         case .draft:                return Keys.draft
         case .pending:              return Keys.pending
         case .privateStatus:        return Keys.privateStatus
+        case .autoDraft:            return Keys.autoDraft
         case .custom(let payload):  return payload
         }
     }
@@ -57,6 +61,8 @@ extension ProductStatus: RawRepresentable {
             return NSLocalizedString("Pending review", comment: "Display label for the product's pending status")
         case .privateStatus:
             return NSLocalizedString("Privately published", comment: "Display label for the product's private status")
+        case .autoDraft:
+            return "Auto Draft" // We don't need to localize this now.
         case .custom(let payload):
             return payload // unable to localize at runtime.
         }
@@ -71,4 +77,5 @@ private enum Keys {
     static let draft         = "draft"
     static let pending       = "pending"
     static let privateStatus = "private"
+    static let autoDraft     = "auto-draft"
 }

Networking/Networking/Remote/ProductsRemote.swift

@@ -42,6 +42,7 @@ public protocol ProductsRemoteProtocol {
     func updateProduct(product: Product, completion: @escaping (Result<Product, Error>) -> Void)
     func updateProductImages(siteID: Int64, productID: Int64, images: [ProductImage], completion: @escaping (Result<Product, Error>) -> Void)
     func loadProductIDs(for siteID: Int64, pageNumber: Int, pageSize: Int, completion: @escaping (Result<[Int64], Error>) -> Void)
+    func createTemplateProduct(for siteID: Int64, template: ProductsRemote.TemplateType, completion: @escaping (Result<Int64, Error>) -> Void)
 }
 
 extension ProductsRemoteProtocol {
@@ -348,6 +349,19 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
 
         enqueue(request, mapper: mapper, completion: completion)
     }
+
+    /// Creates a product using the provided template.
+    /// Finishes with a completion block with the product ID.
+    /// The created product has an `auto-draft` status.
+    ///
+    public func createTemplateProduct(for siteID: Int64, template: ProductsRemote.TemplateType, completion: @escaping (Result<Int64, Error>) -> Void) {
+        let parameters = [ParameterKey.templateName: template.rawValue]
+        let path = Path.templateProducts
+        let request = JetpackRequest(wooApiVersion: .wcAdmin, method: .post, siteID: siteID, path: path, parameters: parameters)
+        let mapper = EntityIDMapper()
+
+        enqueue(request, mapper: mapper, completion: completion)
+    }
 }
 
 
@@ -364,6 +378,16 @@ public extension ProductsRemote {
         case descending
     }
 
+    /// Supported types for creating a template product.
+    ///
+    enum TemplateType: String {
+        case physical
+        case digital
+        case variable
+        case external
+        case grouped
+    }
+
     enum Default {
         public static let pageSize: Int   = 25
         public static let pageNumber: Int = Remote.Default.firstPageNumber
@@ -372,6 +396,7 @@ public extension ProductsRemote {
 
     private enum Path {
         static let products   = "products"
+        static let templateProducts   = "onboarding/tasks/create_product_from_template"
     }
 
     private enum ParameterKey {
@@ -392,6 +417,7 @@ public extension ProductsRemote {
         static let fields: String     = "_fields"
         static let images: String = "images"
         static let id: String         = "id"
+        static let templateName: String = "template_name"
     }
 
     private enum ParameterValues {

Networking/Networking/Settings/WooAPIVersion.swift

@@ -43,6 +43,10 @@ public enum WooAPIVersion: String {
     ///
     case wcTelemetry = "wc-telemetry"
 
+    /// WooCommerce Admin.
+    ///
+    case wcAdmin = "wc-admin"
+
     /// Returns the path for the current API Version
     ///
     var path: String {

Networking/NetworkingTests/Remote/ProductsRemoteTests.swift

@@ -620,6 +620,23 @@ final class ProductsRemoteTests: XCTestCase {
         // Then
         XCTAssertTrue(result.isFailure)
     }
+
+    func test_create_template_product_returns_product_id() throws {
+        // Given
+        let remote = ProductsRemote(network: network)
+        network.simulateResponse(requestUrlSuffix: "onboarding/tasks/create_product_from_template", filename: "product-id-only")
+
+        // When
+        let result = waitFor { promise in
+            remote.createTemplateProduct(for: self.sampleSiteID, template: .physical) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        let productID = try XCTUnwrap(result.get())
+        XCTAssertEqual(productID, 3946)
+    }
 }
 
 // MARK: - Private Helpers

Networking/NetworkingTests/Responses/product-id-only.json

@@ -0,0 +1,5 @@
+{
+    "data": {
+        "id": 3946
+    }
+}

Podfile

@@ -65,7 +65,7 @@ target 'WooCommerce' do
   pod 'Gridicons', '~> 1.2.0'
 
   # To allow pod to pick up beta versions use -beta. E.g., 1.1.7-beta.1
-  pod 'WordPressAuthenticator', '~> 3.3.0-beta.2'
+  pod 'WordPressAuthenticator', '~> 4.0.0'
   # pod 'WordPressAuthenticator', :git => 'https://github.com/wordpress-mobile/WordPressAuthenticator-iOS.git', :commit => ''
   # pod 'WordPressAuthenticator', :git => 'https://github.com/wordpress-mobile/WordPressAuthenticator-iOS.git', :branch => ''
   # pod 'WordPressAuthenticator', :path => '../WordPressAuthenticator-iOS'