[V7] Add Encodable protocol for PayPal Vault

Braintree.xcodeproj/project.pbxproj

@@ -34,7 +34,6 @@
 		427F32E025D1D62D00435294 /* BTPayPalClient_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 427F32DF25D1D62D00435294 /* BTPayPalClient_Tests.swift */; };
 		428F48E42624C9B700EC8DB4 /* BTVenmoAppSwitchRedirectURL_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 428F48E32624C9B700EC8DB4 /* BTVenmoAppSwitchRedirectURL_Tests.swift */; };
 		428F976626727333001042E1 /* BTMockOpenURLContext.m in Sources */ = {isa = PBXBuildFile; fileRef = 428F976526727333001042E1 /* BTMockOpenURLContext.m */; };
-		42FC218B25CDE0290047C49A /* BTPayPalRequest_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 42FC218A25CDE0290047C49A /* BTPayPalRequest_Tests.swift */; };
 		42FC237125CE0E110047C49A /* BTPayPalCheckoutRequest_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 42FC237025CE0E110047C49A /* BTPayPalCheckoutRequest_Tests.swift */; };
 		451508362D400C050071E385 /* BTPayPalPaymentType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 451508352D400C050071E385 /* BTPayPalPaymentType.swift */; };
 		451508382D400C400071E385 /* BTPayPalRequestLandingPageType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 451508372D400C400071E385 /* BTPayPalRequestLandingPageType.swift */; };
@@ -47,6 +46,8 @@
 		4585707A2C34B1E1009CEF7A /* MockClientAuthorization.swift in Sources */ = {isa = PBXBuildFile; fileRef = 458570792C34B1E1009CEF7A /* MockClientAuthorization.swift */; };
 		4585707C2C34B7B5009CEF7A /* MockConfigurationLoader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4585707B2C34B7B5009CEF7A /* MockConfigurationLoader.swift */; };
 		45E8CE4C2D1F29BA00D7A2DC /* PayPalCheckoutPOSTBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45E8CE4B2D1F29BA00D7A2DC /* PayPalCheckoutPOSTBody.swift */; };
+		45E8CE4E2D28611700D7A2DC /* PayPalVaultPOSTBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45E8CE4D2D28611700D7A2DC /* PayPalVaultPOSTBody.swift */; };
+		45E8CE502D2C773600D7A2DC /* PayPalExperienceProfilePOSTBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45E8CE4F2D2C772000D7A2DC /* PayPalExperienceProfilePOSTBody.swift */; };
 		45E8CE522D2C920000D7A2DC /* LocalPaymentAccountsPOSTBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45E8CE512D2C91F000D7A2DC /* LocalPaymentAccountsPOSTBody.swift */; };
 		45EFC3972C2DBF32005E7F5B /* ConfigurationLoader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 45EFC3962C2DBF32005E7F5B /* ConfigurationLoader.swift */; };
 		460C0C220F594AE8EE205E57 /* Pods_Tests_BraintreeCoreTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9239C9FE850C3587DE61A3A2 /* Pods_Tests_BraintreeCoreTests.framework */; };
@@ -719,7 +720,6 @@
 		42F2FF2E2333D2B20083CA10 /* BTAuthenticationInsight_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTAuthenticationInsight_Tests.swift; sourceTree = "<group>"; };
 		42F75E5824D46DA2007DC5E7 /* BTThreeDSecureLookup_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureLookup_Tests.swift; sourceTree = "<group>"; };
 		42F75E5A24D48138007DC5E7 /* BTThreeDSecureClient_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTThreeDSecureClient_Tests.swift; sourceTree = "<group>"; };
-		42FC218A25CDE0290047C49A /* BTPayPalRequest_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTPayPalRequest_Tests.swift; sourceTree = "<group>"; };
 		42FC237025CE0E110047C49A /* BTPayPalCheckoutRequest_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTPayPalCheckoutRequest_Tests.swift; sourceTree = "<group>"; };
 		451508352D400C050071E385 /* BTPayPalPaymentType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTPayPalPaymentType.swift; sourceTree = "<group>"; };
 		451508372D400C400071E385 /* BTPayPalRequestLandingPageType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BTPayPalRequestLandingPageType.swift; sourceTree = "<group>"; };
@@ -732,6 +732,8 @@
 		458570792C34B1E1009CEF7A /* MockClientAuthorization.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockClientAuthorization.swift; sourceTree = "<group>"; };
 		4585707B2C34B7B5009CEF7A /* MockConfigurationLoader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockConfigurationLoader.swift; sourceTree = "<group>"; };
 		45E8CE4B2D1F29BA00D7A2DC /* PayPalCheckoutPOSTBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PayPalCheckoutPOSTBody.swift; sourceTree = "<group>"; };
+		45E8CE4D2D28611700D7A2DC /* PayPalVaultPOSTBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PayPalVaultPOSTBody.swift; sourceTree = "<group>"; };
+		45E8CE4F2D2C772000D7A2DC /* PayPalExperienceProfilePOSTBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PayPalExperienceProfilePOSTBody.swift; sourceTree = "<group>"; };
 		45E8CE512D2C91F000D7A2DC /* LocalPaymentAccountsPOSTBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LocalPaymentAccountsPOSTBody.swift; sourceTree = "<group>"; };
 		45EFC3962C2DBF32005E7F5B /* ConfigurationLoader.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConfigurationLoader.swift; sourceTree = "<group>"; };
 		463DED22C0F426A474E6D7E2 /* Pods-Tests-BraintreeCoreTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Tests-BraintreeCoreTests.release.xcconfig"; path = "Target Support Files/Pods-Tests-BraintreeCoreTests/Pods-Tests-BraintreeCoreTests.release.xcconfig"; sourceTree = "<group>"; };
@@ -1329,6 +1331,8 @@
 			isa = PBXGroup;
 			children = (
 				45E8CE4B2D1F29BA00D7A2DC /* PayPalCheckoutPOSTBody.swift */,
+				45E8CE4F2D2C772000D7A2DC /* PayPalExperienceProfilePOSTBody.swift */,
+				45E8CE4D2D28611700D7A2DC /* PayPalVaultPOSTBody.swift */,
 			);
 			path = Models;
 			sourceTree = "<group>";
@@ -1922,7 +1926,6 @@
 				42FC237025CE0E110047C49A /* BTPayPalCheckoutRequest_Tests.swift */,
 				427F32DF25D1D62D00435294 /* BTPayPalClient_Tests.swift */,
 				BECB10C52B5999EE008D398E /* BTPayPalLineItem_Tests.swift */,
-				42FC218A25CDE0290047C49A /* BTPayPalRequest_Tests.swift */,
 				BEBA590E2BB1B5B9005FA8A2 /* BTPayPalReturnURL_Tests.swift */,
 				427F328F25D1A7B900435294 /* BTPayPalVaultRequest_Tests.swift */,
 				A9E5C1E424FD665D00EE691F /* Info.plist */,
@@ -3123,11 +3126,13 @@
 				BEF5D2E6294A18B300FFD56D /* BTPayPalLineItem.swift in Sources */,
 				BE349113294B798300D2CF68 /* BTPayPalRequest.swift in Sources */,
 				BE549F112BF5445F00B6F441 /* BTPayPalReturnURL.swift in Sources */,
+				45E8CE502D2C773600D7A2DC /* PayPalExperienceProfilePOSTBody.swift in Sources */,
 				57544F5C295254A500DEB7B0 /* BTJSON+PayPal.swift in Sources */,
 				3B7A261129C0CAA40087059D /* BTPayPalAnalytics.swift in Sources */,
 				451508382D400C400071E385 /* BTPayPalRequestLandingPageType.swift in Sources */,
 				BE8E5CEF294B6937001BF017 /* BTPayPalCheckoutRequest.swift in Sources */,
 				807D22F02C29A93A009FFEA4 /* BTPayPalBillingCycle.swift in Sources */,
+				45E8CE4E2D28611700D7A2DC /* PayPalVaultPOSTBody.swift in Sources */,
 				5754481E294A2A1D00DEB7B0 /* BTPayPalCreditFinancingAmount.swift in Sources */,
 				57D9436E2968A8080079EAB1 /* BTPayPalLocaleCode.swift in Sources */,
 				45E8CE4C2D1F29BA00D7A2DC /* PayPalCheckoutPOSTBody.swift in Sources */,
@@ -3441,7 +3446,6 @@
 			buildActionMask = 2147483647;
 			files = (
 				427F32E025D1D62D00435294 /* BTPayPalClient_Tests.swift in Sources */,
-				42FC218B25CDE0290047C49A /* BTPayPalRequest_Tests.swift in Sources */,
 				42FC237125CE0E110047C49A /* BTPayPalCheckoutRequest_Tests.swift in Sources */,
 				BEDEAF112AC1D049004EA970 /* BTPayPalAccountNonce_Tests.swift in Sources */,
 				427F329025D1A7B900435294 /* BTPayPalVaultRequest_Tests.swift in Sources */,

Sources/BraintreeCore/BTPostalAddress.swift

@@ -1,7 +1,7 @@
 import Foundation
 
 ///  Generic postal address
-@objcMembers public class BTPostalAddress: NSObject {
+@objcMembers public class BTPostalAddress: NSObject, Encodable {
 
     // Property names follow the `Braintree_Address` convention as documented at:
     // https://developer.paypal.com/braintree/docs/reference/request/address/create
@@ -27,4 +27,14 @@ import Foundation
 
     /// Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.
     public var region: String?
+
+    enum CodingKeys: String, CodingKey {
+        case countryCodeAlpha2 = "country_code"
+        case extendedAddress = "line2"
+        case locality = "city"
+        case postalCode = "postal_code"
+        case region = "state"
+        case recipientName = "recipient_name"
+        case streetAddress = "line1"
+    }
 }

Sources/BraintreePayPal/BTPayPalCheckoutRequest.swift

@@ -56,7 +56,7 @@ import BraintreeCore
 }
 
 /// Options for the PayPal Checkout flow.
-@objcMembers public class BTPayPalCheckoutRequest: NSObject, PayPalRequest {
+@objcMembers public class BTPayPalCheckoutRequest: NSObject, BTPayPalRequest {
 
     // MARK: - Internal Properties
 
@@ -149,92 +149,14 @@ import BraintreeCore
         self.userAuthenticationEmail = userAuthenticationEmail
         self.userPhoneNumber = userPhoneNumber
     }
-
+    
     // MARK: Internal Methods
-
-    // swiftlint:disable cyclomatic_complexity
-    func parameters(
-        with configuration: BTConfiguration,
-        universalLink: URL? = nil,
-        isPayPalAppInstalled: Bool = false
-    ) -> [String: Any] {
-        var experienceProfile: [String: Any] = [:]
-
-        experienceProfile["no_shipping"] = !isShippingAddressRequired
-        experienceProfile["brand_name"] = displayName != nil ? displayName : configuration.json?["paypal"]["displayName"].asString()
-
-        if let landingPageType = landingPageType?.stringValue {
-            experienceProfile["landing_page_type"] = landingPageType
-        }
-
-        if let localeCode = localeCode?.stringValue {
-            experienceProfile["locale_code"] = localeCode
-        }
-
-        experienceProfile["address_override"] = shippingAddressOverride != nil ? !isShippingAddressEditable : false
-
-        var baseParameters: [String: Any] = [:]
-
-        if let merchantAccountID {
-            baseParameters["merchant_account_id"] = merchantAccountID
-        }
-
-        if let riskCorrelationID {
-            baseParameters["correlation_id"] = riskCorrelationID
-        }
-
-        if let lineItems, !lineItems.isEmpty {
-            let lineItemsArray = lineItems.compactMap { $0.requestParameters() }
-            baseParameters["line_items"] = lineItemsArray
-        }
-
-        if let userAuthenticationEmail, !userAuthenticationEmail.isEmpty {
-            baseParameters["payer_email"] = userAuthenticationEmail
-        }
-
-        if let userPhoneNumberDict = try? userPhoneNumber?.toDictionary() {
-            baseParameters["phone_number"] = userPhoneNumberDict
-        }
-
-        baseParameters["return_url"] = BTCoreConstants.callbackURLScheme + "://\(Self.callbackURLHostAndPath)success"
-        baseParameters["cancel_url"] = BTCoreConstants.callbackURLScheme + "://\(Self.callbackURLHostAndPath)cancel"
-        baseParameters["experience_profile"] = experienceProfile
-
-        var checkoutParameters: [String: Any] = [
-            "intent": intent.stringValue,
-            "amount": amount,
-            "offer_pay_later": offerPayLater
-        ]
-
-        let currencyCode = currencyCode != nil ? currencyCode : configuration.json?["paypal"]["currencyIsoCode"].asString()
-
-        if let currencyCode {
-            checkoutParameters["currency_iso_code"] = currencyCode
-        }
-
-        if userAction != .none, var experienceProfile = baseParameters["experience_profile"] as? [String: Any] {
-            experienceProfile["user_action"] = userAction.stringValue
-            baseParameters["experience_profile"] = experienceProfile
-        }
-
-        if requestBillingAgreement {
-            checkoutParameters["request_billing_agreement"] = requestBillingAgreement
-
-            if billingAgreementDescription != nil {
-                checkoutParameters["billing_agreement_details"] = ["description": billingAgreementDescription]
-            }
-        }
-
-        if let shippingAddressOverride {
-            checkoutParameters["line1"] = shippingAddressOverride.streetAddress
-            checkoutParameters["line2"] = shippingAddressOverride.extendedAddress
-            checkoutParameters["city"] = shippingAddressOverride.locality
-            checkoutParameters["state"] = shippingAddressOverride.region
-            checkoutParameters["postal_code"] = shippingAddressOverride.postalCode
-            checkoutParameters["country_code"] = shippingAddressOverride.countryCodeAlpha2
-            checkoutParameters["recipient_name"] = shippingAddressOverride.recipientName
-        }
-
-        return baseParameters.merging(checkoutParameters) { $1 }
+
+    func encodedPostBodyWith(
+        configuration: BTConfiguration,
+        isPayPalAppInstalled: Bool = false,
+        universalLink: URL? = nil
+    ) -> Encodable {
+        PayPalCheckoutPOSTBody(payPalRequest: self, configuration: configuration)
     }
 }

Sources/BraintreePayPal/BTPayPalClient.swift

@@ -29,7 +29,7 @@ import BraintreeDataCollector
     var clientMetadataID: String?
 
     /// Exposed for testing the intent associated with this request
-    var payPalRequest: PayPalRequest?
+    var payPalRequest: BTPayPalRequest?
 
     /// Exposed for testing, the ASWebAuthenticationSession instance used for the PayPal flow
     var webAuthenticationSession: BTWebAuthenticationSession
@@ -331,7 +331,7 @@ import BraintreeDataCollector
     // MARK: - Private Methods
 
     private func tokenize(
-        request: PayPalRequest,
+        request: BTPayPalRequest,
         completion: @escaping (BTPayPalAccountNonce?, Error?) -> Void
     ) {
         linkType = (request as? BTPayPalVaultRequest)?.enablePayPalAppSwitch == true ? .universal : .deeplink
@@ -343,26 +343,29 @@ import BraintreeDataCollector
                 return
             }
 
-            guard let configuration, let json = configuration.json else {
+            guard let configuration else {
                 self.notifyFailure(with: BTPayPalError.fetchConfigurationFailed, completion: completion)
                 return
             }
 
             self.isConfigFromCache = configuration.isFromCache
 
-            guard json["paypalEnabled"].isTrue else {
+            guard configuration.isPayPalEnabled else {
                 self.notifyFailure(with: BTPayPalError.disabled, completion: completion)
                 return
             }
 
             self.payPalRequest = request
+
+            let parameters = request.encodedPostBodyWith(
+                configuration: configuration,
+                isPayPalAppInstalled: self.application.isPayPalAppInstalled(),
+                universalLink: self.universalLink
+            )
+
             self.apiClient.post(
                 request.hermesPath,
-                parameters: request.parameters(
-                    with: configuration,
-                    universalLink: self.universalLink,
-                    isPayPalAppInstalled: self.application.isPayPalAppInstalled()
-                )
+                parameters: parameters
             ) { body, _, error in
                 if let error = error as? NSError {
                     guard let jsonResponseBody = error.userInfo[BTCoreConstants.jsonResponseBodyKey] as? BTJSON else {

Sources/BraintreePayPal/BTPayPalLineItem.swift

@@ -146,47 +146,4 @@ import Foundation
         case upcType = "upc_type"
         case url
     }
-
-    // MARK: - Internal Methods
-
-    /// Returns the line item in a dictionary.
-    /// - Returns: A dictionary with the line item information formatted for a request.
-    func requestParameters() -> [String: String] {
-        var requestParameters = [
-            "quantity": quantity,
-            "unit_amount": unitAmount,
-            "name": name,
-            "kind": kind == .debit ? "debit" : "credit"
-        ]
-
-        if let unitTaxAmount, !unitTaxAmount.isEmpty {
-            requestParameters["unit_tax_amount"] = unitAmount
-        }
-
-        if let itemDescription, !itemDescription.isEmpty {
-            requestParameters["description"] = itemDescription
-        }
-
-        if let productCode, !productCode.isEmpty {
-            requestParameters["product_code"] = productCode
-        }
-
-        if let url, url != URL(string: "") {
-            requestParameters["url"] = url.absoluteString
-        }
-
-        if let imageURL, imageURL != URL(string: "") {
-            requestParameters["image_url"] = imageURL.absoluteString
-        }
-
-        if let upcCode, !upcCode.isEmpty {
-            requestParameters["upc_code"] = upcCode
-        }
-
-        if upcType.stringValue != nil {
-            requestParameters["upc_type"] = upcType.stringValue
-        }
-
-        return requestParameters
-    }
 }