From eb3b8d853fc9fa440619cab2eab288a16f987351 Mon Sep 17 00:00:00 2001 From: wowinter13 Date: Mon, 5 Feb 2024 23:16:19 +0100 Subject: [PATCH 1/4] feat(api_models): add client_secret type to payments --- crates/api_models/src/payments.rs | 110 ++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 3b85644553d..e3fa4e8eee8 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -8,6 +8,9 @@ use common_utils::{ }; use masking::Secret; use router_derive::Setter; +use serde::de::{self, Unexpected, Visitor}; +use serde::{Deserialize, Deserializer, Serialize, Serializer}; +use std::fmt; use time::PrimitiveDateTime; use url::Url; use utoipa::ToSchema; @@ -51,6 +54,113 @@ pub struct BankCodeResponse { pub eligible_connectors: Vec, } +#[derive(Debug, PartialEq)] +pub struct ClientSecret { + pub payment_id: String, + pub secret: String, +} + +impl<'de> Deserialize<'de> for ClientSecret { + fn deserialize(deserializer: D) -> Result + where + D: Deserializer<'de>, + { + struct ClientSecretVisitor; + + impl<'de> Visitor<'de> for ClientSecretVisitor { + type Value = ClientSecret; + + fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.write_str("a string in the format 'payment_id_secret_secret'") + // Note sure if this is the right format + } + + fn visit_str(self, value: &str) -> Result + where + E: de::Error, + { + let (payment_id, secret) = value.rsplit_once("_secret_").ok_or_else(|| { + E::invalid_value(Unexpected::Str(value), &"a string with '_secret_'") + })?; + + Ok(ClientSecret { + payment_id: payment_id.to_owned(), + secret: secret.to_owned(), + }) + } + } + + deserializer.deserialize_str(ClientSecretVisitor) + } +} + +impl Serialize for ClientSecret { + fn serialize(&self, serializer: S) -> Result + where + S: Serializer, + { + let combined = format!("{}_secret_{}", self.payment_id, self.secret); + serializer.serialize_str(&combined) + } +} + +#[cfg(test)] +mod client_secret_tests { + use super::*; + use serde_json; + + #[test] + fn test_serialize_client_secret() { + let client_secret1 = ClientSecret { + payment_id: "pay_3TgelAms4RQec8xSStjF".to_string(), + secret: "fc34taHLw1ekPgNh92qr".to_string(), + }; + let client_secret2 = ClientSecret { + payment_id: "pay_3Tgel__Ams4RQ_secret_ec8xSStjF".to_string(), + secret: "fc34taHLw1ekPgNh92qr".to_string(), + }; + + let expected_str1 = r#""pay_3TgelAms4RQec8xSStjF_secret_fc34taHLw1ekPgNh92qr""#; + let expected_str2 = r#""pay_3Tgel__Ams4RQ_secret_ec8xSStjF_secret_fc34taHLw1ekPgNh92qr""#; + + let actual_str1 = serde_json::to_string(&client_secret1).unwrap(); + let actual_str2 = serde_json::to_string(&client_secret2).unwrap(); + + assert_eq!(expected_str1, actual_str1); + assert_eq!(expected_str2, actual_str2); + } + + #[test] + fn test_deserialize_client_secret() { + let client_secret_str1 = r#""pay_3TgelAms4RQec8xSStjF_secret_fc34taHLw1ekPgNh92qr""#; + let client_secret_str2 = + r#""pay_3Tgel__Ams4RQ_secret_ec8xSStjF_secret_fc34taHLw1ekPgNh92qr""#; + let client_secret_str3 = + r#""pay_3Tgel__Ams4RQ_secret_ec8xSStjF_secret__secret_fc34taHLw1ekPgNh92qr""#; + + let expected1 = ClientSecret { + payment_id: "pay_3TgelAms4RQec8xSStjF".to_string(), + secret: "fc34taHLw1ekPgNh92qr".to_string(), + }; + let expected2 = ClientSecret { + payment_id: "pay_3Tgel__Ams4RQ_secret_ec8xSStjF".to_string(), + secret: "fc34taHLw1ekPgNh92qr".to_string(), + }; + let expected3 = ClientSecret { + payment_id: "pay_3Tgel__Ams4RQ_secret_ec8xSStjF_secret_".to_string(), + secret: "fc34taHLw1ekPgNh92qr".to_string(), + }; + + let actual1: ClientSecret = serde_json::from_str(client_secret_str1).unwrap(); + let actual2: ClientSecret = serde_json::from_str(client_secret_str2).unwrap(); + let actual3: ClientSecret = serde_json::from_str(client_secret_str3).unwrap(); + + assert_eq!(expected1, actual1); + assert_eq!(expected2, actual2); + assert_eq!(expected3, actual3); + } +} + #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct CustomerDetails { /// The identifier for the customer. From 1ed2cd7745e52c11dca5441d114b394c15e8662c Mon Sep 17 00:00:00 2001 From: wowinter13 Date: Sat, 10 Feb 2024 14:22:45 +0100 Subject: [PATCH 2/4] feat(api_models): address review comments + linters --- crates/api_models/src/payments.rs | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 6e6a6cb6d3b..abea3e24406 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1,4 +1,4 @@ -use std::num::NonZeroI64; +use std::{fmt, num::NonZeroI64}; use cards::CardNumber; use common_utils::{ @@ -8,9 +8,10 @@ use common_utils::{ }; use masking::Secret; use router_derive::Setter; -use serde::de::{self, Unexpected, Visitor}; -use serde::{Deserialize, Deserializer, Serialize, Serializer}; -use std::fmt; +use serde::{ + de::{self, Unexpected, Visitor}, + Deserialize, Deserializer, Serialize, Serializer, +}; use time::PrimitiveDateTime; use url::Url; use utoipa::ToSchema; @@ -71,8 +72,7 @@ impl<'de> Deserialize<'de> for ClientSecret { type Value = ClientSecret; fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { - formatter.write_str("a string in the format 'payment_id_secret_secret'") - // Note sure if this is the right format + formatter.write_str("a string in the format '{payment_id}_secret_{secret}'") } fn visit_str(self, value: &str) -> Result @@ -106,9 +106,10 @@ impl Serialize for ClientSecret { #[cfg(test)] mod client_secret_tests { - use super::*; use serde_json; + use super::*; + #[test] fn test_serialize_client_secret() { let client_secret1 = ClientSecret { From 3fe8a0eb6bcb2f19dbc259a428b030bb036f995b Mon Sep 17 00:00:00 2001 From: wowinter13 Date: Wed, 14 Feb 2024 21:34:39 +0100 Subject: [PATCH 3/4] feat(api_models): address clippy comments --- crates/api_models/src/payments.rs | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index abea3e24406..5e484f1e3ff 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -124,8 +124,10 @@ mod client_secret_tests { let expected_str1 = r#""pay_3TgelAms4RQec8xSStjF_secret_fc34taHLw1ekPgNh92qr""#; let expected_str2 = r#""pay_3Tgel__Ams4RQ_secret_ec8xSStjF_secret_fc34taHLw1ekPgNh92qr""#; - let actual_str1 = serde_json::to_string(&client_secret1).unwrap(); - let actual_str2 = serde_json::to_string(&client_secret2).unwrap(); + let actual_str1 = + serde_json::to_string(&client_secret1).expect("Failed to serialize client_secret1"); + let actual_str2 = + serde_json::to_string(&client_secret2).expect("Failed to serialize client_secret2"); assert_eq!(expected_str1, actual_str1); assert_eq!(expected_str2, actual_str2); @@ -152,9 +154,12 @@ mod client_secret_tests { secret: "fc34taHLw1ekPgNh92qr".to_string(), }; - let actual1: ClientSecret = serde_json::from_str(client_secret_str1).unwrap(); - let actual2: ClientSecret = serde_json::from_str(client_secret_str2).unwrap(); - let actual3: ClientSecret = serde_json::from_str(client_secret_str3).unwrap(); + let actual1: ClientSecret = serde_json::from_str(client_secret_str1) + .expect("Failed to deserialize client_secret_str1"); + let actual2: ClientSecret = serde_json::from_str(client_secret_str2) + .expect("Failed to deserialize client_secret_str2"); + let actual3: ClientSecret = serde_json::from_str(client_secret_str3) + .expect("Failed to deserialize client_secret_str3"); assert_eq!(expected1, actual1); assert_eq!(expected2, actual2); From 2c1a06a544ee6b7ea396046564d383af909c09ae Mon Sep 17 00:00:00 2001 From: Sanchith Hegde <22217505+SanchithHegde@users.noreply.github.com> Date: Thu, 15 Feb 2024 10:56:02 +0530 Subject: [PATCH 4/4] fix(tests): allow `clippy::expect_used` lint in unit test --- crates/api_models/src/payments.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index c6c96b4c137..1be9762c76c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -106,6 +106,8 @@ impl Serialize for ClientSecret { #[cfg(test)] mod client_secret_tests { + #![allow(clippy::expect_used)] + use serde_json; use super::*;