juspay/hyperswitch

[REFACTOR] Integrate the card expiration month/year and security code newtypes in request/response types

Open

#1,012 opened on Apr 27, 2023

View on GitHub
 (5 comments) (0 reactions) (2 assignees)Rust (42,690 stars) (4,676 forks)batch import
A-frameworkC-refactorE-easyP-mediumgood first issuehelp wanted

Description

Feature Description

Our API models (request/response types) need to be refactored to use the card security code and expiry month/year newtypes added in PR #874.

2 such locations in our codebase are:

https://github.com/juspay/hyperswitch/blob/897250ebc3ee57392aae7e2e926d8c635ac9fc4f/crates/api_models/src/payments.rs#L152

https://github.com/juspay/hyperswitch/blob/897250ebc3ee57392aae7e2e926d8c635ac9fc4f/crates/api_models/src/payment_methods.rs#L77-L83

In other types, the fields might be called cvc, cvv, expiry_month, expiry_year, exp_month, exp_year, etc.

For external contributors, clarify any questions you may have, and let us know that you're interested in picking this up. We'll assign this issue to you to reduce duplication of effort on the same task.

Contributor guide

Tech stack
rust
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of Rust newtypesFamiliarity with payment card fieldsUnderstanding of API model structures
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
First, identify all occurrences of fields like cvc, cvv, expiry month, expiry year, exp month, exp year in the request/response types. Then, replace their types with the newtypes defined in PR #874. Ensure to update imports and any usage in tests. The specific files to modify are crates/api models/src/payments.rs and crates/api models/src/payment methods.rs, but also search across the crate for all variants. After changes, verify compilation and run relevant tests.