use crate::errors::ValidationError;
use crate::traits::{PrimitiveValue, ValueObject};
pub type ApiKeyInput = String;
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(try_from = "String", into = "String"))]
pub struct ApiKey(String);
impl ValueObject for ApiKey {
type Input = ApiKeyInput;
type Error = ValidationError;
fn new(value: Self::Input) -> Result<Self, Self::Error> {
let trimmed = value.trim().to_owned();
if trimmed.is_empty() {
return Err(ValidationError::empty("ApiKey"));
}
Ok(Self(trimmed))
}
fn into_inner(self) -> Self::Input {
self.0
}
}
impl PrimitiveValue for ApiKey {
type Primitive = String;
fn value(&self) -> &String {
&self.0
}
}
impl ApiKey {
pub fn last_four(&self) -> &str {
let len = self.0.len();
if len <= 4 {
&self.0
} else {
&self.0[len - 4..]
}
}
pub fn masked(&self) -> String {
let len = self.0.len();
let mask_len = len.saturating_sub(4);
format!("{}{}", "*".repeat(mask_len), self.last_four())
}
}
impl std::fmt::Display for ApiKey {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.masked())
}
}
impl TryFrom<String> for ApiKey {
type Error = ValidationError;
fn try_from(s: String) -> Result<Self, Self::Error> {
Self::new(s)
}
}
#[cfg(feature = "serde")]
impl From<ApiKey> for String {
fn from(v: ApiKey) -> String {
v.0
}
}
impl TryFrom<&str> for ApiKey {
type Error = ValidationError;
fn try_from(value: &str) -> Result<Self, Self::Error> {
Self::new(value.to_owned())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn accepts_valid_key() {
let key = ApiKey::new("sk-1234567890abcd".into()).unwrap();
assert_eq!(key.value(), "sk-1234567890abcd");
}
#[test]
fn trims_whitespace() {
let key = ApiKey::new(" mykey ".into()).unwrap();
assert_eq!(key.value(), "mykey");
}
#[test]
fn rejects_empty() {
assert!(ApiKey::new(String::new()).is_err());
}
#[test]
fn rejects_whitespace_only() {
assert!(ApiKey::new(" ".into()).is_err());
}
#[test]
fn last_four() {
let key = ApiKey::new("sk-1234567890abcd".into()).unwrap();
assert_eq!(key.last_four(), "abcd");
}
#[test]
fn last_four_short_key() {
let key = ApiKey::new("abc".into()).unwrap();
assert_eq!(key.last_four(), "abc");
}
#[test]
fn masked_display() {
let key = ApiKey::new("sk-1234567890abcd".into()).unwrap();
assert_eq!(key.to_string(), "*************abcd");
}
#[test]
fn display_masks_key() {
let key = ApiKey::new("secret".into()).unwrap();
let displayed = key.to_string();
assert!(displayed.ends_with("cret"));
assert!(displayed.starts_with("**"));
}
#[cfg(feature = "serde")]
#[test]
fn serde_roundtrip() {
let v = ApiKey::try_from("sk-test-1234567890abcdef").unwrap();
let json = serde_json::to_string(&v).unwrap();
let back: ApiKey = serde_json::from_str(&json).unwrap();
assert_eq!(v, back);
}
#[cfg(feature = "serde")]
#[test]
fn serde_deserialize_validates() {
let result: Result<ApiKey, _> = serde_json::from_str("\"\"");
assert!(result.is_err());
}
}