[v7] Remove cardAddChallenge (#1487)

* Remove cardAddChallenge and BTThreeDSecureCardAddChallenge
* Update properties to be constants
* Update unit tests

Braintree.xcodeproj/project.pbxproj

@@ -206,7 +206,6 @@
 		BE01A83F29D32CA0000DFA24 /* BTThreeDSecureV2Provider.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE01A83E29D32CA0000DFA24 /* BTThreeDSecureV2Provider.swift */; };
 		BE01A84129D32CE1000DFA24 /* BTThreeDSecureAuthenticateJWT.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE01A84029D32CE1000DFA24 /* BTThreeDSecureAuthenticateJWT.swift */; };
 		BE01A84329D32EA9000DFA24 /* BTThreeDSecureError.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE01A84229D32EA9000DFA24 /* BTThreeDSecureError.swift */; };
-		BE01A84929D4C529000DFA24 /* BTThreeDSecureCardAddChallenge.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE01A84829D4C529000DFA24 /* BTThreeDSecureCardAddChallenge.swift */; };
 		BE0AF6B929AFD50500245C2C /* BTVenmoAppSwitchReturnURL.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE0AF6B829AFD50500245C2C /* BTVenmoAppSwitchReturnURL.swift */; };
 		BE0AF6BB29AFD53300245C2C /* BTVenmoError.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE0AF6BA29AFD53300245C2C /* BTVenmoError.swift */; };
 		BE0AF6BD29AFDCD100245C2C /* BTVenmoAppSwitchRedirectURL.swift in Sources */ = {isa = PBXBuildFile; fileRef = BE0AF6BC29AFDCD100245C2C /* BTVenmoAppSwitchRedirectURL.swift */; };
@@ -896,7 +895,6 @@
 		BE01A83E29D32CA0000DFA24 /* BTThreeDSecureV2Provider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureV2Provider.swift; sourceTree = "<group>"; };
 		BE01A84029D32CE1000DFA24 /* BTThreeDSecureAuthenticateJWT.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureAuthenticateJWT.swift; sourceTree = "<group>"; };
 		BE01A84229D32EA9000DFA24 /* BTThreeDSecureError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureError.swift; sourceTree = "<group>"; };
-		BE01A84829D4C529000DFA24 /* BTThreeDSecureCardAddChallenge.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureCardAddChallenge.swift; sourceTree = "<group>"; };
 		BE0AF6B829AFD50500245C2C /* BTVenmoAppSwitchReturnURL.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTVenmoAppSwitchReturnURL.swift; sourceTree = "<group>"; };
 		BE0AF6BA29AFD53300245C2C /* BTVenmoError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTVenmoError.swift; sourceTree = "<group>"; };
 		BE0AF6BC29AFDCD100245C2C /* BTVenmoAppSwitchRedirectURL.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTVenmoAppSwitchRedirectURL.swift; sourceTree = "<group>"; };
@@ -1793,7 +1791,6 @@
 				BE01A83C29D23833000DFA24 /* BTThreeDSecureAdditionalInformation.swift */,
 				3BEB03C429FD55CA001133D5 /* BTThreeDSecureAnalytics.swift */,
 				BE01A84029D32CE1000DFA24 /* BTThreeDSecureAuthenticateJWT.swift */,
-				BE01A84829D4C529000DFA24 /* BTThreeDSecureCardAddChallenge.swift */,
 				80D1638529E75766001D880E /* BTThreeDSecureClient.swift */,
 				BE01A84229D32EA9000DFA24 /* BTThreeDSecureError.swift */,
 				BE01A82C29CCCDE9000DFA24 /* BTThreeDSecureLookup.swift */,
@@ -3325,7 +3322,6 @@
 				BE80C00129C4BFD700793A6C /* BTThreeDSecureV2BaseCustomization.swift in Sources */,
 				80482F8429D3A1D9007E5F50 /* BTThreeDSecureAccountType.swift in Sources */,
 				80482F8629D3A498007E5F50 /* BTThreeDSecureShippingMethod.swift in Sources */,
-				BE01A84929D4C529000DFA24 /* BTThreeDSecureCardAddChallenge.swift in Sources */,
 				80482F8829D3A571007E5F50 /* BTThreeDSecureRequestedExemptionType.swift in Sources */,
 				BE01A84329D32EA9000DFA24 /* BTThreeDSecureError.swift in Sources */,
 				3BEB03C529FD55CA001133D5 /* BTThreeDSecureAnalytics.swift in Sources */,

CHANGELOG.md

@@ -21,6 +21,7 @@
   * BraintreeThreeDSecure
     * Update `BTThreeDSecureRequest` to make all properties accessible on the initializer only vs via the dot syntax.  
     * Update `BTThreeDSecureRequest.amount` to be a `String`
+    * Remove `cardAddChallenge` - use `cardAddChallengeRequested` instead
   * BraintreeCore
     * Remove `fetchPaymentMethodNonces` methods and parser
   * BraintreePayPal

Sources/BraintreeThreeDSecure/BTThreeDSecureClient.swift

@@ -424,10 +424,8 @@ import BraintreeCore
             requestParameters["customFields"] = customFields
         }
 
-        if request._cardAddChallenge == .requested || request.cardAddChallengeRequested == true {
+        if request.cardAddChallengeRequested {
             requestParameters["cardAdd"] = true
-        } else if request._cardAddChallenge == .notRequested {
-            requestParameters["cardAdd"] = false
         }
 
         var additionalInformation: [String: String?] = [

Sources/BraintreeThreeDSecure/BTThreeDSecureRequest.swift

@@ -6,52 +6,33 @@ import BraintreeCore
 
 /// Used to initialize a 3D Secure payment flow
 @objcMembers public class BTThreeDSecureRequest: NSObject {
-
-    // MARK: - Internal Properties
-
-    var amount: String
-    var nonce: String
-    var accountType: BTThreeDSecureAccountType
-    var additionalInformation: BTThreeDSecureAdditionalInformation?
-    var billingAddress: BTThreeDSecurePostalAddress?
-    var cardAddChallengeRequested: Bool
-    var challengeRequested: Bool
-    var customFields: [String: String]?
-    var dataOnlyRequested: Bool
-    var dfReferenceID: String?
-    var email: String?
-    var exemptionRequested: Bool
-    var mobilePhoneNumber: String?
-    var renderTypes: [BTThreeDSecureRenderType]?
-    var requestedExemptionType: BTThreeDSecureRequestedExemptionType
-    var shippingMethod: BTThreeDSecureShippingMethod
-    var uiType: BTThreeDSecureUIType
-    var v2UICustomization: BTThreeDSecureV2UICustomization?
-    var requestorAppURL: String?
-
-    // NEXT_MAJOR_VERSION remove cardAddChallenge in favor of cardAddChallengeRequested
-    /// Optional. An authentication created using this property should only be used for adding a payment method to the merchant's vault and not for creating transactions.
-    ///
-    /// Defaults to `.unspecified.`
-    ///
-    /// If set to `.challengeRequested`, the authentication challenge will be requested from the issuer to confirm adding new card to the merchant's vault.
-    /// If set to `.notRequested` the authentication challenge will not be requested from the issuer.
-    /// If set to `.unspecified`, when the amount is 0, the authentication challenge will be requested from the issuer.
-    /// If set to `.unspecified`, when the amount is greater than 0, the authentication challenge will not be requested from the issuer.
-    @available(*, deprecated, renamed: "cardAddChallengeRequested", message: "Use the `cardAddChallengeRequested` boolean property instead")
-    public var cardAddChallenge: BTThreeDSecureCardAddChallenge {
-        get { _cardAddChallenge }
-        set { _cardAddChallenge = newValue }
-    }
-
-    // swiftlint:disable identifier_name
-    /// Internal property for `cardAddChallenge`. Created to avoid deprecation warnings upon accessing
-    /// `cardAddChallenge` directly within our SDK. Use this value internally instead.
-    var _cardAddChallenge: BTThreeDSecureCardAddChallenge = .unspecified
 
     /// A delegate for receiving information about the ThreeDSecure payment flow.
     public weak var threeDSecureRequestDelegate: BTThreeDSecureRequestDelegate?
+
+    // MARK: - Internal Properties
 
+    let amount: String
+    let nonce: String
+    let accountType: BTThreeDSecureAccountType
+    let additionalInformation: BTThreeDSecureAdditionalInformation?
+    let billingAddress: BTThreeDSecurePostalAddress?
+    let cardAddChallengeRequested: Bool
+    let challengeRequested: Bool
+    let customFields: [String: String]?
+    let dataOnlyRequested: Bool
+    let email: String?
+    let exemptionRequested: Bool
+    let mobilePhoneNumber: String?
+    let renderTypes: [BTThreeDSecureRenderType]?
+    let requestedExemptionType: BTThreeDSecureRequestedExemptionType
+    let shippingMethod: BTThreeDSecureShippingMethod
+    let uiType: BTThreeDSecureUIType
+    let v2UICustomization: BTThreeDSecureV2UICustomization?
+    let requestorAppURL: String?
+
+    var dfReferenceID: String?
+
     // MARK: - Initializer
 
     /// Creates a `BTThreeDSecureRequest`
@@ -82,7 +63,6 @@ import BraintreeCore
         accountType: BTThreeDSecureAccountType = .unspecified,
         additionalInformation: BTThreeDSecureAdditionalInformation? = nil,
         billingAddress: BTThreeDSecurePostalAddress? = nil,
-        _cardAddChallenge: BTThreeDSecureCardAddChallenge = .unspecified,
         cardAddChallengeRequested: Bool = false,
         challengeRequested: Bool = false,
         customFields: [String: String]? = nil,
@@ -103,7 +83,6 @@ import BraintreeCore
         self.accountType = accountType
         self.additionalInformation = additionalInformation
         self.billingAddress = billingAddress
-        self._cardAddChallenge = _cardAddChallenge
         self.cardAddChallengeRequested = cardAddChallengeRequested
         self.challengeRequested = challengeRequested
         self.customFields = customFields

UnitTests/BraintreeThreeDSecureTests/BTThreeDSecureClient_Tests.swift

@@ -46,7 +46,6 @@ class BTThreeDSecureClient_Tests: XCTestCase {
             nonce: "fake-card-nonce",
             accountType: .credit,
             billingAddress: billingAddress,
-            _cardAddChallenge: .requested,
             cardAddChallengeRequested: true,
             challengeRequested: true,
             dataOnlyRequested: true,
@@ -92,8 +91,7 @@ class BTThreeDSecureClient_Tests: XCTestCase {
     func testPerformThreeDSecureLookup_whenDefaultsArePassed_buildsRequestWithNilValues() {
         let expectation = expectation(description: "willCallCompletion")
 
-        threeDSecureRequest.nonce = "fake-card-nonce"
-        threeDSecureRequest.amount = "9.99"
+        let threeDSecureRequest = BTThreeDSecureRequest(amount: "9.99", nonce: "fake-card-nonce")
 
         client.performThreeDSecureLookup(threeDSecureRequest) { _, _ in
             XCTAssertEqual(self.mockAPIClient.lastPOSTParameters!["amount"] as! String, "9.99")
@@ -108,26 +106,6 @@ class BTThreeDSecureClient_Tests: XCTestCase {
         waitForExpectations(timeout: 1)
     }
 
-    func testPerformThreeDSecureLookup_whenCardAddChallengeNotRequested_sendsCardAddFalse() {
-        let expectation = self.expectation(description: "willCallCompletion")
-
-        threeDSecureRequest = BTThreeDSecureRequest(
-            amount: "9.97",
-            nonce: "fake-card-nonce",
-            _cardAddChallenge: .notRequested,
-            cardAddChallengeRequested: false,
-            dfReferenceID: "df-reference-id"
-        )
-
-        client.performThreeDSecureLookup(threeDSecureRequest) { (lookup, error) in
-            XCTAssertFalse(self.mockAPIClient.lastPOSTParameters!["cardAdd"] as! Bool)
-
-            expectation.fulfill()
-        }
-
-        waitForExpectations(timeout: 1, handler: nil)
-    }
-
     func testPerformThreeDSecureLookup_whenCardAddChallengeRequestedNotSet_doesNotSendCardAddParameter() {
         let expectation = self.expectation(description: "willCallCompletion")
 
@@ -285,12 +263,10 @@ class BTThreeDSecureClient_Tests: XCTestCase {
     func testStartPaymentFlow_whenAmountIsEmpty_throwsError() {
         mockAPIClient.cannedConfigurationResponseBody = mockConfiguration
 
-        let request = BTThreeDSecureRequest(amount: "10.00", nonce: "fake-card-nonce")
-        request.amount = ""
-
-        let expectation = self.expectation(description: "Callback envoked")
+        threeDSecureRequest = BTThreeDSecureRequest(amount: "", nonce: "fake-card-nonce")
+        let expectation = self.expectation(description: "Callback invoked")
 
-        client.startPaymentFlow(request) { result, error in
+        client.startPaymentFlow(threeDSecureRequest) { result, error in
             XCTAssertNil(result)
             XCTAssertEqual(error?.localizedDescription, "BTThreeDSecureRequest amount can not be nil or NaN.")
             expectation.fulfill()
@@ -640,7 +616,6 @@ class BTThreeDSecureClient_Tests: XCTestCase {
         mockAPIClient.cannedConfigurationResponseBody = mockConfiguration
         let expectation = expectation(description: "willCallCompletion")
 
-        threeDSecureRequest.nonce = "fake-card-nonce"
         threeDSecureRequest.dfReferenceID = "fake-df-reference-id"
 
         client.prepareLookup(threeDSecureRequest) { clientData, error in
@@ -668,7 +643,6 @@ class BTThreeDSecureClient_Tests: XCTestCase {
         let client = BTThreeDSecureClient(apiClient: MockAPIClient(authorization: "sandbox_9dbg82cq_dcpspy2brwdjr3qn")!)
         let expectation = expectation(description: "willCallCompletion")
 
-        threeDSecureRequest.nonce = "fake-card-nonce"
         threeDSecureRequest.dfReferenceID = "fake-df-reference-id"
 
         client.prepareLookup(threeDSecureRequest) { _, error in

UnitTests/BraintreeThreeDSecureTests/BTThreeDSecureRequest_Tests.swift

@@ -7,11 +7,8 @@ class BTThreeDSecureRequest_Tests: XCTestCase {
 
     // MARK: - accountTypeAsString
 
-    func testCustomFields_notNil() {
-        let request = BTThreeDSecureRequest(amount: "10.0", nonce: "fake-nonce")
-        XCTAssertNil(request.customFields)
-
-        request.customFields = ["test": "test"]
+    func testCustomFields_whenCustomFieldsExist_notNil() {
+        let request = BTThreeDSecureRequest(amount: "10.0", nonce: "fake-nonce", customFields: ["test": "test"])
         XCTAssertNotNil(request.customFields)
     }