Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[V2 Beta] Migration Guide and Card Vault API Cleanup #290

Merged
merged 30 commits into from
Nov 13, 2024
Merged

[V2 Beta] Migration Guide and Card Vault API Cleanup #290

merged 30 commits into from
Nov 13, 2024

Conversation

sshropshire
Copy link
Collaborator

@sshropshire sshropshire commented Nov 12, 2024 •
edited
Loading

Summary of changes

  • This PR finishes up the v2_MIGRATION_GUIDE for :CardPayments and :PayPalWebPayments modules
  • In addition, the following changes were made after using Docs Driven Development (DDD) to identify gaps in our SDK's API:
    • Rename ApproveOrderListener method onAuthorizationRequired() to onApproveOrderAuthorizationRequired()
    • Add CardVaultListener method onVaultAuthorizationRequired()
    • Remove authChallenge property from CardVaultResult

Checklist

  • Added a changelog entry

Authors

List GitHub usernames for everyone who contributed to this pull request.

Notes

I would recommend viewing the v2_MIGRATION_GUIDE directly to get a clear view of the changes that were made.

@sshropshire
Tweak v2_MIGRATION_GUIDE table of contents.
921637f
@sshropshire
Remove redundant word Module in section headings.
4a1eccd
@sshropshire
Tweak MIGRATION_GUIDE.
c73470d
@sshropshire
Update wording.
915bbdf
@sshropshire
Update MIGRATION_GUIDE.
e3f6046
@sshropshire
Add additional comments.
2891d69
@sshropshire
Update v2_MIGRATION_GUIDE format.
d577323
@sshropshire
Tweak migration guide formatting.
8a47350
@sshropshire
Tweak migration guide.
5ee15c9
@sshropshire
Tweak verbosity of migration guide.
f8f4333
@sshropshire
Update migration guide.
80b254e
@sshropshire
Clean up comments.
4bef33c
@sshropshire
Update details header.
a2d7251
@sshropshire
Remove unecessary punctuation.
324fbcf
@sshropshire
Update title description.
b7edfcd
@sshropshire
Rename onAuthorizationRequired to onApproveAuthorizationRequired.
7e5dc6d
@sshropshire
Update vault card integration.
4320051
@sshropshire
Update MIGRATION_GUIDE with latest interface.
9218812
@sshropshire
Add remove observers reference to MIGRATION_GUIDE.
a1d0766
@sshropshire
Add vault method reference in MIGRATION_GUIDE and co-locate Android l…
d4344e2 
…ifecycle methods.
@sshropshire
Update migration guide for PayPal migration.
20abe08
@sshropshire
Update CHANGELOG.
041abb4
@sshropshire
Add to migration guide.
1918230
@sshropshire
Fix broken unit test.
0424096
@sshropshire
Fix lint errors.
6403783
@sshropshire sshropshire changed the base branch from main to v2_beta November 12, 2024 19:49
@sshropshire sshropshire marked this pull request as ready for review November 12, 2024 21:51
@sshropshire sshropshire requested a review from a team as a code owner November 12, 2024 21:51
KunJeongPark
KunJeongPark reviewed Nov 13, 2024
View reviewed changes
CHANGELOG.md
@@ -14,6 +14,9 @@
* Add `CardPresentAuthChallengeResult` type
* Add `CardClient.completeAuthChallenge(Intent, String)` method
* Add `CardStatus` type
* Add `ApproveOrderListener.onApproveOrderAuthorizationRequired(CardAuthChallenge)` method
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it renaming?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is technically a rename, though the entire concept of this method is new in v2. Since we've never released it I chose to put "add" in the CHANGELOG.

@sshropshire sshropshire merged commit a2da541 into v2_beta Nov 13, 2024
6 checks passed
@sshropshire sshropshire deleted the v2_beta__migration_guide branch November 13, 2024 19:37
sshropshire added a commit that referenced this pull request Nov 19, 2024
@sshropshire
Merge V2 Beta Branch into Main (#293)
ef559fd 
* Remove PayPalNativePayments (#275)

* Remove PayPalNativePayments module from project.

* Remove Cardinal from build.gradle.

* Bump to latest version of actions/download-artifact in GitHub Actions workflow.

* Remove native checkout references.

* Remove additional Native XO referenced classes from Demo app.

* Fix lint errors.

* Migrate all GitHub actions to v4.

* Bump gson version.

* Fix versions after rebasing.

* Fix dependency error.

* Fix rebase CHANGELOG merge error.

* Add CHANGELOG update.

* V2 Beta Auth Challenge Migration (#276)

* Migrate CardClient away from observers.

* Remove activity from constructor parameters.

* Update Card and PayPal browser switch flows to include auth challenge types.

* Remove commented code.

* Remove commented code.

* Move CardPresentAuthChallengeResult to its own file.

* Move PayPalPresentAuthChallengeResult into its own file.

* Migrate all activity reference types to ComponentActivity.

* Fix compilation error.

* Modify tests to use new BrowserSwitch methods.

* Fix :Card module unit tests after refactoring.

* Fix PayPalWebCheckoutClient unit tests.

* Update PayPalWeb module unit tests.

* Fix detekt errors.

* Refactor Demo app method naming.

* Update gradle build plugin.

* Fix versions after rebasing.

* Fix detekt version catalog errors.

* Outline table of contents.

* Update migration guide with summary block.

* Update MIGRATION_GUIDE for CardClient.

* Try details region for v2/v1 snippets.

* Update markdown.

* Tweak formatting.

* Tweak formatting again.

* Make diff.

* Implement CardClient migration guide on constructor.

* Update migration guide.

* Try adding collapsable section.

* Add addtional expandable sections.

* Try h5.

* Update styling again.

* Tweak styling agaaain.

* Re-word docs.

* Re-arrange sections.

* Reword migration guide content.

* Update migration guide wording.

* Rephrase card client migration again.

* Lead with code in the migration guide.

* Use diff syntax.

* Add collapsable sections.

* Add collapsable sections.

* Reduce collapsable title verbosity.

* Update migration guide.

* Tweak collapsed layout.

* Simplify collapsed state in migration guide.

* Add approve order details to MIGRATION_GUIDE.

* Clean up migration guide.

* Update docs.

* Adjust comment again.

* Add sample activity callout.{

* Adjust naming.

* Add additional information on the approve order flow.

* Add additional information to migration guide on approve order.

* Rephrase approve order v1 details.

* Add TODO to migration guide.

* Add hyper links to table of contents.

* Update CHANGELOG.

* Browser Switch Bugfix (#281)

* Add browser switch request codes to launcher logic.

* Update Browser switch code.

* Update CardAuthLauncher to use request codes to differentiate browser switch results.

* Add request codes to browser switch requests.

* Fix build error with new CardStatus and PayPalWebStatus.

* Update BOM for Jetpack Compose.

* Update unit tests for CardAuthLauncher to include request code.

* Update unit test for browser switch options.

* Update PayPalWebLauncherUnitTest.

* Implement test for when browser switch fails.

* Add additional tests to PayPalWebLauncherUnitTest.

* Fix detekt lint errors.

* Update CHANGELOG.

* Remove metadata that's no longer needed.

* Remove request type from metadata.

* [V2 Beta] Migration Guide and Card Vault API Cleanup (#290)

* Tweak v2_MIGRATION_GUIDE table of contents.

* Remove redundant word Module in section headings.

* Tweak MIGRATION_GUIDE.

* Update wording.

* Update MIGRATION_GUIDE.

* Add additional comments.

* Update v2_MIGRATION_GUIDE format.

* Tweak migration guide formatting.

* Tweak migration guide.

* Tweak verbosity of migration guide.

* Update migration guide.

* Clean up comments.

* Update details header.

* Remove unecessary punctuation.

* Update title description.

* Rename onAuthorizationRequired to onApproveAuthorizationRequired.

* Update vault card integration.

* Update MIGRATION_GUIDE with latest interface.

* Add remove observers reference to MIGRATION_GUIDE.

* Add vault method reference in MIGRATION_GUIDE and co-locate Android lifecycle methods.

* Update migration guide for PayPal migration.

* Update CHANGELOG.

* Add to migration guide.

* Fix broken unit test.

* Fix lint errors.

* Update migration guide with PayPalWebCheckoutClient details.

* Add emoji to section headers.

* Fix section header font format.

* Fix wording.

* Update CHANGELOG.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KunJeongPark KunJeongPark KunJeongPark approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sshropshire @KunJeongPark