Create encodable for credit cards post #1488

warmkesselj · 2024-12-16T20:02:59Z

Summary of changes

Move /credit_cards POST to Encodable.

Checklist

Added a changelog entry
Tested and confirmed payment flows affected by this change are functioning as expected

Authors

@warmkesselj
@jwarmkessel

…dingKeys for the rest body

…ion of parameters

Sources/BraintreeCard/BTCard.swift

Sources/BraintreeCard/CreditCardGraphQLBody.swift

Sources/BraintreeCard/CreditCardPOSTBody.swift

Sources/BraintreePayPal/Models/PayPalCheckoutPOSTBody.swift

UnitTests/BraintreeCardTests/BTCardClient_Tests.swift

Sources/BraintreeCard/CreditCardGraphQLBody.swift

Sources/BraintreeCard/CreditCardPOSTBody.swift

Sources/BraintreeCard/CreditCardGraphQLBody.swift

…create-encodable-for-credit-cards-post # Conflicts: # Sources/BraintreePayPal/Models/PayPalCheckoutPOSTBody.swift

jaxdesmarais · 2025-02-07T14:26:06Z

Sources/BraintreeCard/CreditCardGraphQLBody.swift

+
+import Foundation
+
+struct CreditCardGraphQLBody: Encodable {


Can we move this swiftlint disable here instead:

Suggested change

struct CreditCardGraphQLBody: Encodable {

// swiftlint:disable nesting

struct CreditCardGraphQLBody: Encodable {

jaxdesmarais · 2025-02-07T14:27:43Z

Sources/BraintreeCard/CreditCardPOSTBody.swift

@@ -0,0 +1,139 @@
+// swiftlint:disable nesting


I think we can remove this since we have it below as well

jaxdesmarais · 2025-02-07T14:28:43Z

Sources/BraintreeCard/CreditCardGraphQLBody.swift

+
+import Foundation
+
+struct CreditCardGraphQLBody: Encodable {


Can we add a docstring for this? Can use /// The POST body for <endpoint_here> like we have in other files.

jaxdesmarais · 2025-02-07T14:28:53Z

Sources/BraintreeCard/CreditCardPOSTBody.swift

+#endif
+
+// swiftlint:disable nesting
+struct CreditCardPOSTBody: Encodable {


Can we add a docstring for this? Can use /// The POST body for <endpoint_here> like we have in other files.

jaxdesmarais · 2025-02-07T14:29:47Z

Sources/BraintreeCard/CreditCardPOSTBody.swift

+        }
+    }
+
+    /// POST Body Model


Take it or leave it but not sure this comment is helpful. Can likely remove once we add the one to the top of this struct.

jaxdesmarais · 2025-02-07T14:30:50Z

UnitTests/BraintreeCardTests/BTCard_Tests.swift

-        ] as [String: Any] as NSObject)
+        let params = card.graphQLParameters()
+
+        XCTAssertEqual(params.variables.input.options.validate,  false)


Suggested change

XCTAssertEqual(params.variables.input.options.validate, false)

XCTAssertEqual(params.variables.input.options.validate, false)

jaxdesmarais · 2025-02-07T14:31:37Z

UnitTests/BraintreeCardTests/BTCard_Tests.swift

+        XCTAssertEqual(params.variables.input.creditCard.number, "6111111111111111")
+        XCTAssertEqual(params.operationName, "TokenizeCreditCard")
+        XCTAssertNotNil(params.query)
+        XCTAssertEqual(params.variables.input.options.validate,  false)


Suggested change

XCTAssertEqual(params.variables.input.options.validate, false)

XCTAssertEqual(params.variables.input.options.validate, false)

jaxdesmarais · 2025-02-07T14:32:42Z

UnitTests/BraintreeCardTests/BTCard_Tests.swift

-            ]
-        ] as [String: Any] as NSObject)
+        let params = card.graphQLParameters()
+        printEncodableObject(params)


Do we need this? It doesn't look like we are using the output.

jaxdesmarais · 2025-02-07T14:33:01Z

UnitTests/BraintreeCardTests/BTCard_Tests.swift

+        XCTAssertEqual(params.variables.input.creditCard.number, "8111111111111111")
+        XCTAssertEqual(params.operationName, "TokenizeCreditCard")
+        XCTAssertNotNil(params.query)
+        XCTAssertEqual(params.variables.input.options.validate,  false)


Suggested change

XCTAssertEqual(params.variables.input.options.validate, false)

XCTAssertEqual(params.variables.input.options.validate, false)

jaxdesmarais · 2025-02-07T14:34:42Z

UnitTests/BraintreeTestShared/MockAPIClient.swift

@@ -55,6 +56,7 @@ public class MockAPIClient: BTAPIClient {
    public override func post(_ path: String, parameters: Encodable, headers: [String: String]? = nil, httpType: BTAPIClientHTTPService = .gateway, completion completionBlock: ((BTJSON?, HTTPURLResponse?, Error?) -> Void)? = nil) {
        lastPOSTPath = path
        lastPOSTParameters = try? parameters.toDictionary()
+        lastPOSTEncodableParameters = parameters


General question. Do we need this? I think the other encodable PRs were using lastPOSTParameters which converts the Encodable class to a dictionary so we wouldn't need to change tests. Just trying to make sure I understand why we needed to make large changes to the tests here but not in the other PRs.

jaxdesmarais · 2025-02-07T14:35:43Z

Sources/BraintreeCard/CreditCardGraphQLBody.swift

+
+struct CreditCardGraphQLBody: Encodable {
+
+    // MARK: - Internal Properties


imo we can remove this

jaxdesmarais · 2025-02-07T19:02:15Z

Sources/BraintreeCard/CreditCardGraphQLBody.swift

+                var number: String?
+                var expirationMonth: String?
+                var cvv: String?
+                var options: Options?


This line is causing your integration test failures. CreditCard.options does not exist in the API. This should be removed and it's correlating struct below. Right now you have options in 2 places and it actually only exists in Input at the API layer.

warmkesselj added 14 commits November 7, 2024 11:26

Add new codable struct

1bf3167

Model encodable object

048e1bb

Update BTCreditCardBody

b75543c

Add BTCreditCardGraphQLBody

ab0b715

Update to use new encodable objects

c0872bd

Move auth insight property

8fc4325

Update BTCreditCardGraphQLBody

63512a7

Update the encodable objects. Remove dynamic keys and use the enum co…

4630b44

…dingKeys for the rest body

Clean up

36d3bf8

Identify failing tests for updating

f271a67

Updates to Encodable body

b1b46af

Conform encodable objects to NSObject

8a72b11

Fix unit tests

9062d97

Merge branch 'main' into create-encodable-for-credit-cards-post

d1e9d9b

warmkesselj added do not merge do not review labels Dec 16, 2024

warmkesselj added 8 commits December 16, 2024 12:07

Remove commented out code

f0f72e7

Refactor for linting

69c963a

Linting

9d525fa

Disable lint in Encodable files

22340e2

Unit tests update

c57f551

Check if not equal to nil and sets the billing address properties

6152ee9

Update unit tests BTCard_tests

ba01e6d

Updates to unit tests

6197b1d

warmkesselj removed the do not review label Jan 14, 2025

warmkesselj and others added 5 commits January 15, 2025 13:51

Updating naming, and use structs

f963037

Update names

15f3ccd

Move card post body init to BTCard parameters method, move instantiat…

8d8c768

…ion of parameters

Encapsulate logic to build CreditCardGraphQLBody

fcaa1e7

Use let over var

2607562

warmkesselj added 12 commits January 30, 2025 12:23

BillingAddress only if name

4f2dc63

Unit tests

e38acfd

Unit tests

38be363

Update CreditCardGraphQLBody

651ce42

Re-add lastPOSTParameters

730cfb0

Update unit tests

4d0addd

Changed Id to ID

c568526

Pass the entire metadata field into CreditCardPOSTBody

c4e9b8c

Update to use ID instead of Id syntax

3fe7c4c

disable swiftlint cyclomatic_complexity on PayPalCheckoutPOSTBody

7a6d3ea

Update to merchantAccountID in unit tests.

2c62305

Add compiler directive to check if BraintreeCore can be imported

2015365

jaxdesmarais reviewed Feb 4, 2025

View reviewed changes

warmkesselj added 2 commits February 4, 2025 16:32

PR comments

95f1b03

PR comments

fc06112

scannillo reviewed Feb 5, 2025

View reviewed changes

Sources/BraintreeCard/CreditCardGraphQLBody.swift Show resolved Hide resolved

Update unit tests

7b2c1a8

jaxdesmarais reviewed Feb 6, 2025

View reviewed changes

warmkesselj added 2 commits February 6, 2025 09:44

PR comments and swift lint

09d3ab1

Update swiftlint rule to disable nesting

e4d2019

richherrera reviewed Feb 6, 2025

View reviewed changes

Sources/BraintreeCard/CreditCardGraphQLBody.swift Outdated Show resolved Hide resolved

Sources/BraintreeCard/CreditCardGraphQLBody.swift Outdated Show resolved Hide resolved

warmkesselj added 6 commits February 6, 2025 09:58

Merge branch 'v7' of https://github.com/braintree/braintree_ios into …

7528172

…create-encodable-for-credit-cards-post # Conflicts: # Sources/BraintreePayPal/Models/PayPalCheckoutPOSTBody.swift

Swiftlint issues

3cc172b

Remove uneeded guard for authenticationInsightRequested

0076cb6

Remove uneeded guard

71c807b

Omitting checks for each of the properties

f4829c4

Update unit test due to change in contract

b11ef64

jaxdesmarais reviewed Feb 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create encodable for credit cards post #1488

Create encodable for credit cards post #1488

warmkesselj commented Dec 16, 2024 •

edited

Loading

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

jaxdesmarais Feb 7, 2025

	struct CreditCardGraphQLBody: Encodable {
	// swiftlint:disable nesting
	struct CreditCardGraphQLBody: Encodable {

	XCTAssertEqual(params.variables.input.options.validate, false)
	XCTAssertEqual(params.variables.input.options.validate, false)


		struct CreditCardGraphQLBody: Encodable {

		// MARK: - Internal Properties

Create encodable for credit cards post #1488

Are you sure you want to change the base?

Create encodable for credit cards post #1488

Conversation

warmkesselj commented Dec 16, 2024 • edited Loading

Summary of changes

Checklist

Authors

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

warmkesselj commented Dec 16, 2024 •

edited

Loading