Skip to content

Commit

Permalink
Update PayPalInternalClient to use Pairing ID as Client Metadata ID (#…
Browse files Browse the repository at this point in the history 
…983)

* Update PayPalInternalClient to use pairing ID as client metadata ID by default.

* Set applicationGuid for data collector request

* Add unit tests for ba_token and token url param parsing from PayPal redirect URL.

* Fix unit tests for PayPal Native Checkout.

---------

Co-authored-by: Sai <[email protected]>
  • Loading branch information
@sshropshire @saperi22
sshropshire and saperi22 authored May 24, 2024
1 parent bbd03ac commit 598ace5
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 35 deletions.
34 changes: 25 additions & 9 deletions PayPal/src/main/java/com/braintreepayments/api/PayPalInternalClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,27 @@ public void onResult(String responseBody, Exception httpError) {
String redirectUrl = paypalPaymentResource.getRedirectUrl();
if (redirectUrl != null) {
Uri parsedRedirectUri = Uri.parse(redirectUrl);

String pairingIdKey = isBillingAgreement ? "ba_token" : "token";
String pairingId = parsedRedirectUri.getQueryParameter(pairingIdKey);
String clientMetadataId = payPalRequest.getRiskCorrelationId() != null
? payPalRequest.getRiskCorrelationId() : payPalDataCollector.getClientMetadataId(context, configuration, payPalRequest.hasUserLocationConsent());
String pairingId = findPairingId(parsedRedirectUri);

String clientMetadataId = payPalRequest.getRiskCorrelationId();
if (clientMetadataId == null) {
PayPalDataCollectorInternalRequest dataCollectorRequest =
new PayPalDataCollectorInternalRequest(payPalRequest.hasUserLocationConsent())
.setApplicationGuid(payPalDataCollector.getPayPalInstallationGUID(context));

if (pairingId != null) {
dataCollectorRequest.setRiskCorrelationId(pairingId);
}
clientMetadataId = payPalDataCollector.getClientMetadataId(context, dataCollectorRequest, configuration);
}

if (pairingId != null) {
payPalResponse
.pairingId(pairingId)
.clientMetadataId(clientMetadataId);
payPalResponse.pairingId(pairingId);
}

payPalResponse.approvalUrl(parsedRedirectUri.toString());
payPalResponse
.clientMetadataId(clientMetadataId)
.approvalUrl(parsedRedirectUri.toString());
}
callback.onResult(payPalResponse, null);

Expand Down Expand Up @@ -122,4 +130,12 @@ public void onResult(JSONObject tokenizationResponse, Exception exception) {
}
});
}

private String findPairingId(Uri redirectUri) {
String pairingId = redirectUri.getQueryParameter("ba_token");
if (pairingId == null) {
pairingId = redirectUri.getQueryParameter("token");
}
return pairingId;
}
}
103 changes: 82 additions & 21 deletions PayPal/src/test/java/com/braintreepayments/api/PayPalInternalClientUnitTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -409,8 +409,6 @@ public void sendRequest_withPayPalCheckoutRequest_omitsEmptyLineItems() throws J

@Test
public void sendRequest_whenRiskCorrelationIdNotNull_setsClientMetadataIdToRiskCorrelationId() {
when(payPalDataCollector.getClientMetadataId(context, configuration, false)).thenReturn("sample-client-metadata-id");

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
.authorizationSuccess(clientToken)
Expand All @@ -432,8 +430,62 @@ public void sendRequest_whenRiskCorrelationIdNotNull_setsClientMetadataIdToRiskC
}

@Test
public void sendRequest_whenRiskCorrelationIdNull_setsClientMetadataIdFromPayPalDataCollector() {
when(payPalDataCollector.getClientMetadataId(context, configuration, false)).thenReturn("sample-client-metadata-id");
public void sendRequest_whenRiskCorrelationIdNull_setsClientMetadataIdToBATokenParamFromApprovalURL() {
when(
payPalDataCollector.getClientMetadataId(same(context), any(PayPalDataCollectorInternalRequest.class), same(configuration))
).thenReturn("ba-token-cmid");

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
.authorizationSuccess(clientToken)
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE_WITH_BA_TOKEN_PARAM)
.build();

PayPalInternalClient sut = new PayPalInternalClient(braintreeClient, payPalDataCollector, apiClient);

PayPalCheckoutRequest payPalRequest = new PayPalCheckoutRequest("1.00");

sut.sendRequest(context, payPalRequest, payPalInternalClientCallback);

ArgumentCaptor<PayPalResponse> captor = ArgumentCaptor.forClass(PayPalResponse.class);
verify(payPalInternalClientCallback).onResult(captor.capture(), (Exception) isNull());

PayPalResponse payPalResponse = captor.getValue();
assertNull(payPalRequest.getRiskCorrelationId());
assertEquals("ba-token-cmid", payPalResponse.getClientMetadataId());
}

@Test
public void sendRequest_whenRiskCorrelationIdNullAndBATokenParamDoesNotExist_setsClientMetadataIdToTokenParamFromApprovalURL() {
when(
payPalDataCollector.getClientMetadataId(same(context), any(PayPalDataCollectorInternalRequest.class), same(configuration))
).thenReturn("token-cmid");

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
.authorizationSuccess(clientToken)
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE_WITH_TOKEN_PARAM)
.build();

PayPalInternalClient sut = new PayPalInternalClient(braintreeClient, payPalDataCollector, apiClient);

PayPalCheckoutRequest payPalRequest = new PayPalCheckoutRequest("1.00");

sut.sendRequest(context, payPalRequest, payPalInternalClientCallback);

ArgumentCaptor<PayPalResponse> captor = ArgumentCaptor.forClass(PayPalResponse.class);
verify(payPalInternalClientCallback).onResult(captor.capture(), (Exception) isNull());

PayPalResponse payPalResponse = captor.getValue();
assertNull(payPalRequest.getRiskCorrelationId());
assertEquals("token-cmid", payPalResponse.getClientMetadataId());
}

@Test
public void sendRequest_whenRiskCorrelationIdNullAndBATokenAndTokenParamDoNotExist_setsClientMetadataIdFromPayPalDataCollector() {
when(
payPalDataCollector.getClientMetadataId(same(context), any(PayPalDataCollectorInternalRequest.class), same(configuration))
).thenReturn("magnes-generated-cmid");

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
Expand All @@ -452,7 +504,7 @@ public void sendRequest_whenRiskCorrelationIdNull_setsClientMetadataIdFromPayPal

PayPalResponse payPalResponse = captor.getValue();
assertNull(payPalRequest.getRiskCorrelationId());
assertEquals("sample-client-metadata-id", payPalResponse.getClientMetadataId());
assertEquals("magnes-generated-cmid", payPalResponse.getClientMetadataId());
}

@Test
Expand Down Expand Up @@ -481,13 +533,15 @@ public void sendRequest_withPayPalCheckoutRequest_whenRequestBillingAgreementFal

@Test
public void sendRequest_withPayPalVaultRequest_callsBackPayPalResponseOnSuccess() {
when(payPalDataCollector.getClientMetadataId(context, configuration, false)).thenReturn("sample-client-metadata-id");
when(
payPalDataCollector.getClientMetadataId(same(context), any(PayPalDataCollectorInternalRequest.class), same(configuration))
).thenReturn("ba-token-cmid");

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
.authorizationSuccess(clientToken)
.returnUrlScheme("sample-scheme")
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_BILLING_AGREEMENT_RESPONSE)
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE_WITH_BA_TOKEN_PARAM)
.build();

PayPalInternalClient sut = new PayPalInternalClient(braintreeClient, payPalDataCollector, apiClient);
Expand All @@ -500,24 +554,26 @@ public void sendRequest_withPayPalVaultRequest_callsBackPayPalResponseOnSuccess(
ArgumentCaptor<PayPalResponse> captor = ArgumentCaptor.forClass(PayPalResponse.class);
verify(payPalInternalClientCallback).onResult(captor.capture(), (Exception) isNull());

String expectedUrl = "https://checkout.paypal.com/one-touch-login-sandbox/index.html?action=create_payment_resource&authorization_fingerprint=63cc461306c35080ce674a3372bffe1580b4130c7fd33d33968aa76bb93cdd06%7Ccreated_at%3D2015-10-13T18%3A49%3A48.371382792%2B0000%26merchant_id%3Ddcpspy2brwdjr3qn%26public_key%3D9wwrzqk3vr3t4nc8&cancel_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fcancel&controller=client_api%2Fpaypal_hermes&experience_profile%5Baddress_override%5D=false&experience_profile%5Bno_shipping%5D=false&merchant_id=dcpspy2brwdjr3qn&return_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fsuccess&ba_token=EC-HERMES-SANDBOX-EC-TOKEN&offer_paypal_credit=true&version=1";
String expectedUrl = "https://checkout.paypal.com/one-touch-login-sandbox/index.html?ba_token=fake-ba-token\u0026action=create_payment_resource\u0026amount=1.00\u0026authorization_fingerprint=63cc461306c35080ce674a3372bffe1580b4130c7fd33d33968aa76bb93cdd06%7Ccreated_at%3D2015-10-13T18%3A49%3A48.371382792%2B0000%26merchant_id%3Ddcpspy2brwdjr3qn%26public_key%3D9wwrzqk3vr3t4nc8\u0026cancel_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fcancel\u0026controller=client_api%2Fpaypal_hermes\u0026currency_iso_code=USD\u0026experience_profile%5Baddress_override%5D=false\u0026experience_profile%5Bno_shipping%5D=false\u0026merchant_id=dcpspy2brwdjr3qn\u0026return_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fsuccess\u0026offer_paypal_credit=true\u0026version=1";
PayPalResponse payPalResponse = captor.getValue();
assertTrue(payPalResponse.isBillingAgreement());
assertEquals("sample-merchant-account-id", payPalResponse.getMerchantAccountId());
assertEquals("sample-scheme://onetouch/v1/success", payPalResponse.getSuccessUrl());
assertEquals("EC-HERMES-SANDBOX-EC-TOKEN", payPalResponse.getPairingId());
assertEquals("sample-client-metadata-id", payPalResponse.getClientMetadataId());
assertEquals("fake-ba-token", payPalResponse.getPairingId());
assertEquals("ba-token-cmid", payPalResponse.getClientMetadataId());
assertEquals(expectedUrl, payPalResponse.getApprovalUrl());
}

@Test
public void sendRequest_withPayPalCheckoutRequest_callsBackPayPalResponseOnSuccess() {
when(payPalDataCollector.getClientMetadataId(context, configuration, false)).thenReturn("sample-client-metadata-id");
when(
payPalDataCollector.getClientMetadataId(same(context), any(PayPalDataCollectorInternalRequest.class), same(configuration))
).thenReturn("token-cmid");

BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
.authorizationSuccess(clientToken)
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE)
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE_WITH_TOKEN_PARAM)
.returnUrlScheme("sample-scheme")
.build();

Expand All @@ -533,14 +589,14 @@ public void sendRequest_withPayPalCheckoutRequest_callsBackPayPalResponseOnSucce
ArgumentCaptor<PayPalResponse> captor = ArgumentCaptor.forClass(PayPalResponse.class);
verify(payPalInternalClientCallback).onResult(captor.capture(), (Exception) isNull());

String expectedUrl = "https://checkout.paypal.com/one-touch-login-sandbox/index.html?action=create_payment_resource&amount=1.00&authorization_fingerprint=63cc461306c35080ce674a3372bffe1580b4130c7fd33d33968aa76bb93cdd06%7Ccreated_at%3D2015-10-13T18%3A49%3A48.371382792%2B0000%26merchant_id%3Ddcpspy2brwdjr3qn%26public_key%3D9wwrzqk3vr3t4nc8&cancel_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fcancel&controller=client_api%2Fpaypal_hermes&currency_iso_code=USD&experience_profile%5Baddress_override%5D=false&experience_profile%5Bno_shipping%5D=false&merchant_id=dcpspy2brwdjr3qn&return_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fsuccess&token=EC-HERMES-SANDBOX-EC-TOKEN&offer_paypal_credit=true&version=1";
String expectedUrl = "https://checkout.paypal.com/one-touch-login-sandbox/index.html?token=fake-token\u0026action=create_payment_resource\u0026amount=1.00\u0026authorization_fingerprint=63cc461306c35080ce674a3372bffe1580b4130c7fd33d33968aa76bb93cdd06%7Ccreated_at%3D2015-10-13T18%3A49%3A48.371382792%2B0000%26merchant_id%3Ddcpspy2brwdjr3qn%26public_key%3D9wwrzqk3vr3t4nc8\u0026cancel_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fcancel\u0026controller=client_api%2Fpaypal_hermes\u0026currency_iso_code=USD\u0026experience_profile%5Baddress_override%5D=false\u0026experience_profile%5Bno_shipping%5D=false\u0026merchant_id=dcpspy2brwdjr3qn\u0026return_url=com.braintreepayments.api.test.braintree%3A%2F%2Fonetouch%2Fv1%2Fsuccess\u0026offer_paypal_credit=true\u0026version=1";
PayPalResponse payPalResponse = captor.getValue();
assertFalse(payPalResponse.isBillingAgreement());
assertEquals("authorize", payPalResponse.getIntent());
assertEquals("sample-merchant-account-id", payPalResponse.getMerchantAccountId());
assertEquals("sample-scheme://onetouch/v1/success", payPalResponse.getSuccessUrl());
assertEquals("EC-HERMES-SANDBOX-EC-TOKEN", payPalResponse.getPairingId());
assertEquals("sample-client-metadata-id", payPalResponse.getClientMetadataId());
assertEquals("fake-token", payPalResponse.getPairingId());
assertEquals("token-cmid", payPalResponse.getClientMetadataId());
assertEquals(expectedUrl, payPalResponse.getApprovalUrl());
}

Expand Down Expand Up @@ -663,11 +719,11 @@ public void tokenize_onTokenizeError_returnsErrorToCallback() {
public void payPalDataCollector_passes_correct_arguments_to_getClientMetadataId() throws Exception {
Configuration configuration = Configuration.fromJson(Fixtures.CONFIGURATION_WITH_LIVE_PAYPAL);
BraintreeClient braintreeClient = new MockBraintreeClientBuilder()
.configuration(configuration)
.authorizationSuccess(clientToken)
.returnUrlScheme("sample-scheme")
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE)
.build();
.configuration(configuration)
.authorizationSuccess(clientToken)
.returnUrlScheme("sample-scheme")
.sendPOSTSuccessfulResponse(Fixtures.PAYPAL_HERMES_RESPONSE)
.build();

PayPalInternalClient sut = new PayPalInternalClient(braintreeClient, payPalDataCollector, apiClient);

Expand All @@ -677,6 +733,11 @@ public void payPalDataCollector_passes_correct_arguments_to_getClientMetadataId(

sut.sendRequest(context, payPalRequest, payPalInternalClientCallback);

verify(payPalDataCollector).getClientMetadataId(context, configuration, true);
ArgumentCaptor<PayPalDataCollectorInternalRequest> captor =
ArgumentCaptor.forClass(PayPalDataCollectorInternalRequest.class);
verify(payPalDataCollector).getClientMetadataId(same(context), captor.capture(), same(configuration));

PayPalDataCollectorInternalRequest dataCollectorRequest = captor.getValue();
assertTrue(dataCollectorRequest.getHasUserLocationConsent());
}
}
5 changes: 2 additions & 3 deletions ...eCheckout/src/main/java/com/braintreepayments/api/PayPalNativeCheckoutInternalClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,9 @@ void sendRequest(final Context context, final PayPalNativeRequest payPalRequest,
String clientMetadataId = payPalRequest.getRiskCorrelationId() != null
? payPalRequest.getRiskCorrelationId() : payPalDataCollector.getClientMetadataId(context, configuration, payPalRequest.hasUserLocationConsent());

payPalResponse.clientMetadataId(clientMetadataId);
if (pairingId != null) {
payPalResponse
.pairingId(pairingId)
.clientMetadataId(clientMetadataId);
payPalResponse.pairingId(pairingId);
}
}
callback.onResult(payPalResponse, null);
Expand Down
2 changes: 1 addition & 1 deletion ...t/src/test/java/com/braintreepayments/api/PayPalNativeCheckoutInternalClientUnitTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ public void sendRequest_withPayPalCheckoutRequest_callsBackPayPalResponseOnSucce
assertFalse(payPalResponse.isBillingAgreement());
assertEquals("authorize", payPalResponse.getIntent());
assertEquals("sample-merchant-account-id", payPalResponse.getMerchantAccountId());
assertEquals("EC-HERMES-SANDBOX-EC-TOKEN", payPalResponse.getPairingId());
assertNull(payPalResponse.getPairingId());
assertEquals("sample-client-metadata-id", payPalResponse.getClientMetadataId());
}

Expand Down
Loading

0 comments on commit 598ace5

Please sign in to comment.