Merge pull request #5322 from woocommerce/feature/stripe-sdk-2

[Mobile Payments] [SDK 2] Switch to SDK 2

Author: allendav

Hardware/Hardware.xcodeproj/project.pbxproj

@@ -46,8 +46,6 @@
 		D88303D525E44CD200C877F9 /* MockStripeCharge.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88303D425E44CD200C877F9 /* MockStripeCharge.swift */; };
 		D88303DB25E450E700C877F9 /* PaymentIntentTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88303DA25E450E700C877F9 /* PaymentIntentTests.swift */; };
 		D88303DF25E4512400C877F9 /* MockStripePaymentIntent.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88303DE25E4512400C877F9 /* MockStripePaymentIntent.swift */; };
-		D88ECCD9262091CF0094398A /* CardReaderSoftwareUpdate.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88ECCD8262091CF0094398A /* CardReaderSoftwareUpdate.swift */; };
-		D88ECCDF2620933D0094398A /* CardReaderSofware+Stripe.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88ECCDE2620933D0094398A /* CardReaderSofware+Stripe.swift */; };
 		D88ECCE3262095A10094398A /* UpdateTimeEstimate.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88ECCE2262095A10094398A /* UpdateTimeEstimate.swift */; };
 		D88ECCE7262096BD0094398A /* UpdateTimeEstimate+Stripe.swift in Sources */ = {isa = PBXBuildFile; fileRef = D88ECCE6262096BD0094398A /* UpdateTimeEstimate+Stripe.swift */; };
 		D88FDB0925DD216B00CB0DBD /* Hardware.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = D88FDAFF25DD216B00CB0DBD /* Hardware.framework */; };
@@ -90,6 +88,9 @@
 		E1CFC1662643EAA30089F86F /* SampleContent.swift in Sources */ = {isa = PBXBuildFile; fileRef = E1CFC1652643EAA30089F86F /* SampleContent.swift */; };
 		E1CFC16D2643EBCB0089F86F /* Hardware.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = D88FDAFF25DD216B00CB0DBD /* Hardware.framework */; };
 		E1CFC16E2643EBCB0089F86F /* Hardware.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = D88FDAFF25DD216B00CB0DBD /* Hardware.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
+		E1E125AC26EB582B0068A9B0 /* CardReaderSoftwareUpdateState.swift in Sources */ = {isa = PBXBuildFile; fileRef = E1E125AB26EB582B0068A9B0 /* CardReaderSoftwareUpdateState.swift */; };
+		E1E125AE26EB66B30068A9B0 /* FallibleCancelable.swift in Sources */ = {isa = PBXBuildFile; fileRef = E1E125AD26EB66B30068A9B0 /* FallibleCancelable.swift */; };
+		E1E125B026EB66EA0068A9B0 /* Cancelable+Stripe.swift in Sources */ = {isa = PBXBuildFile; fileRef = E1E125AF26EB66EA0068A9B0 /* Cancelable+Stripe.swift */; };
 		E1E4FA2F2653CFD5007B9D4F /* PrintingResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = E1E4FA2E2653CFD5007B9D4F /* PrintingResult.swift */; };
 /* End PBXBuildFile section */
 
@@ -172,8 +173,6 @@
 		D88303D425E44CD200C877F9 /* MockStripeCharge.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockStripeCharge.swift; sourceTree = "<group>"; };
 		D88303DA25E450E700C877F9 /* PaymentIntentTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentIntentTests.swift; sourceTree = "<group>"; };
 		D88303DE25E4512400C877F9 /* MockStripePaymentIntent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockStripePaymentIntent.swift; sourceTree = "<group>"; };
-		D88ECCD8262091CF0094398A /* CardReaderSoftwareUpdate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardReaderSoftwareUpdate.swift; sourceTree = "<group>"; };
-		D88ECCDE2620933D0094398A /* CardReaderSofware+Stripe.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "CardReaderSofware+Stripe.swift"; sourceTree = "<group>"; };
 		D88ECCE2262095A10094398A /* UpdateTimeEstimate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UpdateTimeEstimate.swift; sourceTree = "<group>"; };
 		D88ECCE6262096BD0094398A /* UpdateTimeEstimate+Stripe.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UpdateTimeEstimate+Stripe.swift"; sourceTree = "<group>"; };
 		D88FDAFF25DD216B00CB0DBD /* Hardware.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Hardware.framework; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -221,6 +220,9 @@
 		E1CFC14F2643E9EE0089F86F /* ReceiptSettingsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReceiptSettingsView.swift; sourceTree = "<group>"; };
 		E1CFC1562643E9EE0089F86F /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		E1CFC1652643EAA30089F86F /* SampleContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SampleContent.swift; sourceTree = "<group>"; };
+		E1E125AB26EB582B0068A9B0 /* CardReaderSoftwareUpdateState.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardReaderSoftwareUpdateState.swift; sourceTree = "<group>"; };
+		E1E125AD26EB66B30068A9B0 /* FallibleCancelable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FallibleCancelable.swift; sourceTree = "<group>"; };
+		E1E125AF26EB66EA0068A9B0 /* Cancelable+Stripe.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Cancelable+Stripe.swift"; sourceTree = "<group>"; };
 		E1E4FA2E2653CFD5007B9D4F /* PrintingResult.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PrintingResult.swift; sourceTree = "<group>"; };
 		E9F0AC202B287C1221EA2C99 /* Pods_Hardware.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Hardware.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		F45592A33DEE569C9775EEE7 /* Pods-PrinterPlayground.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-PrinterPlayground.release.xcconfig"; path = "Target Support Files/Pods-PrinterPlayground/Pods-PrinterPlayground.release.xcconfig"; sourceTree = "<group>"; };
@@ -379,6 +381,7 @@
 				D89B8F0725DDC8F60001C726 /* Charge.swift */,
 				D89B8F0B25DDC9D30001C726 /* ChargeStatus.swift */,
 				D88FDB2525DD21B000CB0DBD /* PaymentIntent.swift */,
+				E1E125AD26EB66B30068A9B0 /* FallibleCancelable.swift */,
 				D89B8F0125DDC7500001C726 /* PaymentIntentStatus.swift */,
 				D88FDB2325DD21B000CB0DBD /* PaymentIntentParameters.swift */,
 				D88FDB2025DD21AF00CB0DBD /* PaymentStatus.swift */,
@@ -390,7 +393,7 @@
 				D845BDB7262D97B300A3E40F /* ReceiptDetails.swift */,
 				D80B4659260E1E160092EDC0 /* StatementDescriptor.swift */,
 				D88ECCE2262095A10094398A /* UpdateTimeEstimate.swift */,
-				D88ECCD8262091CF0094398A /* CardReaderSoftwareUpdate.swift */,
+				E1E125AB26EB582B0068A9B0 /* CardReaderSoftwareUpdateState.swift */,
 				D845BDC1262D98C400A3E40F /* CardBrand.swift */,
 				D845BDD9262DAADB00A3E40F /* PaymentMethod.swift */,
 			);
@@ -414,10 +417,10 @@
 				D88FDB3825DD21D300CB0DBD /* DefaultConnectionTokenProvider.swift */,
 				D81AE85925E6A62800D9CFD3 /* StripeCardReaderDiscoveryCache.swift */,
 				D854FC21260A34B000A219CD /* UnderlyingError+Stripe.swift */,
-				D88ECCDE2620933D0094398A /* CardReaderSofware+Stripe.swift */,
 				D88ECCE6262096BD0094398A /* UpdateTimeEstimate+Stripe.swift */,
 				D845BDCF262D9C6C00A3E40F /* ReceiptDetails+Stripe.swift */,
 				D845BDDD262DAB8300A3E40F /* PaymentMethod+Stripe.swift */,
+				E1E125AF26EB66EA0068A9B0 /* Cancelable+Stripe.swift */,
 			);
 			path = StripeCardReader;
 			sourceTree = "<group>";
@@ -740,10 +743,12 @@
 				D845BDDE262DAB8300A3E40F /* PaymentMethod+Stripe.swift in Sources */,
 				D89B8F0C25DDC9D30001C726 /* ChargeStatus.swift in Sources */,
 				E140F61C2668CDC900FDB5FF /* Logging.swift in Sources */,
+				E1E125AC26EB582B0068A9B0 /* CardReaderSoftwareUpdateState.swift in Sources */,
 				D88FDB3125DD21B000CB0DBD /* CardReader.swift in Sources */,
 				D845BDDA262DAADB00A3E40F /* PaymentMethod.swift in Sources */,
 				D81AE85A25E6A62800D9CFD3 /* StripeCardReaderDiscoveryCache.swift in Sources */,
 				D865C61E261CE001006717B8 /* CardReaderEvent+Stripe.swift in Sources */,
+				E1E125B026EB66EA0068A9B0 /* Cancelable+Stripe.swift in Sources */,
 				D80B4656260E1B290092EDC0 /* CurrencyCode.swift in Sources */,
 				D81AE86425E6B77F00D9CFD3 /* CardReaderServiceError.swift in Sources */,
 				D8DF5F4E25DD9F91008AFE25 /* CardReaderType+Stripe.swift in Sources */,
@@ -759,7 +764,6 @@
 				D80B464E260E18930092EDC0 /* Email.swift in Sources */,
 				D89B8F0225DDC7500001C726 /* PaymentIntentStatus.swift in Sources */,
 				D8652E2A2630520300350F37 /* CardPresentReceiptParameters.swift in Sources */,
-				D88ECCD9262091CF0094398A /* CardReaderSoftwareUpdate.swift in Sources */,
 				D89B8F1E25DDCD3D0001C726 /* PaymentIntent+Stripe.swift in Sources */,
 				D89B8F1625DDCC810001C726 /* ChargeStatus+Stripe.swift in Sources */,
 				030338102705F7D400764131 /* ReceiptTotalLine.swift in Sources */,
@@ -777,8 +781,8 @@
 				D88FDB3025DD21B000CB0DBD /* CardReaderService.swift in Sources */,
 				D88FDB2C25DD21B000CB0DBD /* CardReaderStatus.swift in Sources */,
 				D89B8F2425DDCD800001C726 /* PaymentIntentStatus+Stripe.swift in Sources */,
+				E1E125AE26EB66B30068A9B0 /* FallibleCancelable.swift in Sources */,
 				D88FDB3A25DD21D300CB0DBD /* DefaultConnectionTokenProvider.swift in Sources */,
-				D88ECCDF2620933D0094398A /* CardReaderSofware+Stripe.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

Hardware/Hardware/CardReader/CardReader.swift

@@ -24,6 +24,9 @@ public struct CardReader {
 
     /// The type of card reader
     public let readerType: CardReaderType
+
+    /// The CardReader location id
+    public let locationId: String?
 }
 
 

Hardware/Hardware/CardReader/CardReaderConfigProvider.swift

@@ -1,6 +1,16 @@
 /// Abstraction provided by Hardware so that clients of this library
 /// can model a way to provide a connection token.
 /// It is meant to abstract an implementation of the [adapter pattern](https://en.wikipedia.org/wiki/Adapter_pattern)
-public protocol CardReaderConfigProvider {
+
+public protocol ReaderTokenProvider {
     func fetchToken(completion: @escaping(String?, Error?) -> Void)
 }
+
+public protocol ReaderLocationProvider {
+    func fetchDefaultLocationID(completion: @escaping(String?, Error?) -> Void)
+}
+
+public protocol CardReaderConfigProvider: ReaderLocationProvider {
+    func fetchToken(completion: @escaping(String?, Error?) -> Void)
+    func fetchDefaultLocationID(completion: @escaping(String?, Error?) -> Void)
+}

Hardware/Hardware/CardReader/CardReaderEvent.swift

@@ -21,12 +21,6 @@ public enum CardReaderEvent {
     /// Low battery warning resolved.
     case lowBatteryResolved
 
-    /// A software update is available.
-    case softwareUpdateNeeded
-
-    /// Software is up to date.
-    case softwareUpToDate
-
     /// The card reader disconnected.
     case disconnected
 }

Hardware/Hardware/CardReader/CardReaderService.swift

@@ -22,8 +22,8 @@ public protocol CardReaderService {
     /// The Publisher that emits reader events
     var readerEvents: AnyPublisher<CardReaderEvent, Never> { get }
 
-    /// The Publisher that emits software update progress. Values are in the range [0, 1]
-    var softwareUpdateEvents: AnyPublisher<Float, Never> { get }
+    /// The Publisher that emits software update state changes
+    var softwareUpdateEvents: AnyPublisher<CardReaderSoftwareUpdateState, Never> { get }
 
     // MARK: - Commands
 
@@ -36,7 +36,7 @@ public protocol CardReaderService {
 
     /// Connects to a card reader
     /// - Parameter reader: The card reader we want to connect to.
-    func connect(_ reader: CardReader) -> Future <CardReader, Error>
+    func connect(_ reader: CardReader) -> AnyPublisher <CardReader, Error>
 
     /// Disconnects from the currently connected reader
     func disconnect() -> Future <Void, Error>
@@ -52,13 +52,8 @@ public protocol CardReaderService {
     /// Cancels a PaymentIntent
     func cancelPaymentIntent() -> Future<Void, Error>
 
-    /// Checks for firmware updates.
-    func checkForUpdate() -> Future<CardReaderSoftwareUpdate?, Error>
-
-    /// Triggers a software update. This method requires that checkForUpdates
-    /// has been completed successfully
+    /// Triggers a software update.
     ///
-    /// The returned publisher will periodically publish the fraction of progress during the software update
-    /// and it will complete when it's finished, unless there is any error.
-    func installUpdate() -> AnyPublisher<Float, Error>
+    /// To check the progress of the update, observe the softwareUpdateEvents publisher.
+    func installUpdate() -> Void
 }

Hardware/Hardware/CardReader/CardReaderServiceError.swift

@@ -28,7 +28,7 @@ public enum CardReaderServiceError: Error {
     case paymentCancellation(underlyingError: UnderlyingError = .internalServiceError)
 
     /// Error thrown while updating the reader firmware
-    case softwareUpdate(underlyingError: UnderlyingError = .internalServiceError)
+    case softwareUpdate(underlyingError: UnderlyingError = .internalServiceError, batteryLevel: Double?)
 
     /// The user has denied the app permission to use Bluetooth
     case bluetoothDenied
@@ -51,7 +51,7 @@ extension CardReaderServiceError: LocalizedError {
             return underlyingError.errorDescription
         case .paymentCancellation(let underlyingError):
             return underlyingError.errorDescription
-        case .softwareUpdate(let underlyingError):
+        case .softwareUpdate(let underlyingError, _):
             return underlyingError.errorDescription
         case .bluetoothDenied:
             return NSLocalizedString(
@@ -194,6 +194,23 @@ public enum UnderlyingError: Error {
     case internalServiceError
 }
 
+extension UnderlyingError {
+    /// Returns true if the error is related to card reader software updates
+    ///
+    public var isSoftwareUpdateError: Bool {
+        switch self {
+        case .readerSoftwareUpdateFailed,
+             .readerSoftwareUpdateFailedReader,
+             .readerSoftwareUpdateFailedServer,
+             .readerSoftwareUpdateFailedInterrupted,
+             .readerSoftwareUpdateFailedBatteryLow:
+            return true
+        default:
+            return false
+        }
+    }
+}
+
 extension UnderlyingError: LocalizedError {
     public var errorDescription: String? {
         switch self {

Hardware/Hardware/CardReader/CardReaderSoftwareUpdate.swift

@@ -0,0 +1,20 @@
+/// A type that represents the possible states for software update
+public enum CardReaderSoftwareUpdateState {
+    /// An optional update is available
+    case available
+
+    /// A mandatory update has started
+    case started(cancelable: FallibleCancelable?)
+
+    /// The update is being installed
+    case installing(progress: Float)
+
+    /// The update failed to install
+    case failed(error: Error)
+
+    /// The update has finished installing
+    case completed
+
+    /// No update available
+    case none
+}

Hardware/Hardware/CardReader/CardReaderSoftwareUpdateState.swift

@@ -1,10 +1,10 @@
 /// Card reader type. Indicates if a reader is meant to be used
 /// handheld or as a countertop device
 public enum CardReaderType {
-    /// Handled reader for use with mobile applications
-    case mobile
-    /// Counter top reader
-    case counterTop
-    /// Reader not supported
-    case notSupported
+    /// Chipper
+    case chipper
+    /// Stripe M2
+    case stripeM2
+    /// Other
+    case other
 }

Hardware/Hardware/CardReader/CardReaderType.swift

@@ -0,0 +1,6 @@
+/// A protocol indicating that an activity or action supports cancellation, where that cancelation might fail.
+/// Not to be confused with Combine.Cancellable
+public protocol FallibleCancelable {
+    /// Cancel the activity.
+    func cancel(completion: @escaping (Result<Void, Error>) -> Void)
+}