stateset-core 1.22.0

Core domain models and business logic for StateSet iCommerce
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
//! Fraud detection domain models
//!
//! Provides signal-based fraud assessment with configurable rules and
//! manual review workflows.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use stateset_primitives::{FraudRuleId, OrderId};
use strum::{Display, EnumString};

/// Types of fraud signals that can be detected
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Display, EnumString)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[non_exhaustive]
pub enum FraudSignalType {
    /// Unusually high order velocity for this customer
    VelocitySpike,
    /// Billing and shipping addresses don't match
    AddressMismatch,
    /// First order from this customer is unusually high value
    HighValueFirstOrder,
    /// Customer IP geolocates to a different country than billing address
    GeoIpAnomaly,
    /// Card BIN country doesn't match billing country
    BinCountryMismatch,
    /// Known suspicious device fingerprint
    DeviceFingerprint,
    /// Connection through proxy or VPN
    ProxyVpn,
    /// Email address matches disposable email pattern
    DisposableEmail,
    /// Multiple failed payment attempts
    PaymentRetries,
    /// Unusual time of day for this customer's locale
    UnusualTime,
}

/// Fraud assessment decision
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default, Display, EnumString,
)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case", ascii_case_insensitive)]
#[non_exhaustive]
pub enum FraudDecision {
    /// Order is considered safe, proceed normally
    #[default]
    Accept,
    /// Order needs manual review before proceeding
    Review,
    /// Order is considered fraudulent, reject it
    Reject,
}

/// A single fraud signal detected for an order
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FraudSignal {
    /// Order this signal relates to
    pub order_id: OrderId,
    /// Type of signal detected
    pub signal_type: FraudSignalType,
    /// Confidence score (0.0 = no confidence, 1.0 = certain)
    pub score: f64,
    /// Human-readable details about the signal
    pub details: String,
    /// When the signal was detected
    pub detected_at: DateTime<Utc>,
}

/// Aggregate fraud assessment for an order
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FraudAssessment {
    /// Order being assessed
    pub order_id: OrderId,
    /// Overall risk score (0.0 = safe, 1.0 = high risk)
    pub risk_score: f64,
    /// Individual signals that contributed to the assessment
    pub signals: Vec<FraudSignal>,
    /// Final decision
    pub decision: FraudDecision,
    /// Who reviewed (None if automated)
    pub reviewed_by: Option<String>,
    /// Optional reviewer notes
    pub review_notes: Option<String>,
    /// When the assessment was created
    pub created_at: DateTime<Utc>,
    /// When the assessment was last updated
    pub updated_at: DateTime<Utc>,
}

/// A configurable fraud detection rule
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FraudRule {
    /// Unique rule ID
    pub id: FraudRuleId,
    /// Rule name
    pub name: String,
    /// Description of what this rule detects
    pub description: Option<String>,
    /// Signal type this rule evaluates
    pub signal_type: FraudSignalType,
    /// Score threshold to trigger this rule (0.0-1.0)
    pub threshold: f64,
    /// Action to take when rule triggers
    pub action: FraudDecision,
    /// Whether this rule is currently active
    pub enabled: bool,
    /// When the rule was created
    pub created_at: DateTime<Utc>,
    /// When the rule was last updated
    pub updated_at: DateTime<Utc>,
}

/// Input for creating a fraud assessment
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFraudAssessment {
    /// Order to assess
    pub order_id: OrderId,
    /// Signals detected
    pub signals: Vec<CreateFraudSignal>,
}

/// Input for creating a fraud signal
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFraudSignal {
    /// Signal type
    pub signal_type: FraudSignalType,
    /// Confidence score
    pub score: f64,
    /// Details
    pub details: String,
}

/// Input for creating a fraud rule
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFraudRule {
    /// Rule name
    pub name: String,
    /// Description
    pub description: Option<String>,
    /// Signal type
    pub signal_type: FraudSignalType,
    /// Threshold
    pub threshold: f64,
    /// Action
    pub action: FraudDecision,
}

/// Input for updating a fraud rule
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct UpdateFraudRule {
    /// Updated name
    pub name: Option<String>,
    /// Updated description
    pub description: Option<Option<String>>,
    /// Updated threshold
    pub threshold: Option<f64>,
    /// Updated action
    pub action: Option<FraudDecision>,
    /// Updated enabled status
    pub enabled: Option<bool>,
}

/// Filter for listing fraud assessments
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct FraudAssessmentFilter {
    /// Filter by decision
    pub decision: Option<FraudDecision>,
    /// Filter by minimum risk score
    pub min_risk_score: Option<f64>,
    /// Only unreviewed assessments
    pub unreviewed_only: Option<bool>,
    /// Maximum results
    pub limit: Option<u32>,
    /// Offset for pagination
    pub offset: Option<u32>,
}

/// Filter for listing fraud rules
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct FraudRuleFilter {
    /// Filter by signal type
    pub signal_type: Option<FraudSignalType>,
    /// Filter by action
    pub action: Option<FraudDecision>,
    /// Filter by enabled status
    pub enabled: Option<bool>,
    /// Maximum results
    pub limit: Option<u32>,
    /// Offset for pagination
    pub offset: Option<u32>,
}

impl FraudAssessment {
    /// Calculate the overall risk score from signals
    pub fn calculate_risk_score(signals: &[FraudSignal]) -> f64 {
        if signals.is_empty() {
            return 0.0;
        }
        // Use max signal score as the primary risk indicator
        signals.iter().map(|s| s.score).fold(0.0_f64, f64::max)
    }

    /// Determine the decision based on risk score and rules
    #[must_use]
    pub fn decide(risk_score: f64, rules: &[FraudRule], signals: &[FraudSignal]) -> FraudDecision {
        let mut decision = FraudDecision::Accept;

        for rule in rules.iter().filter(|r| r.enabled) {
            let matching_signal = signals
                .iter()
                .find(|s| s.signal_type == rule.signal_type && s.score >= rule.threshold);

            if matching_signal.is_some() {
                match rule.action {
                    FraudDecision::Reject => return FraudDecision::Reject,
                    FraudDecision::Review if decision == FraudDecision::Accept => {
                        decision = FraudDecision::Review;
                    }
                    _ => {}
                }
            }
        }

        // Fallback: high risk score triggers review
        if risk_score >= 0.8 && decision == FraudDecision::Accept {
            decision = FraudDecision::Review;
        }

        decision
    }

    /// Whether this assessment needs human review
    #[must_use]
    pub fn needs_review(&self) -> bool {
        self.decision == FraudDecision::Review && self.reviewed_by.is_none()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::Utc;
    use stateset_primitives::{FraudRuleId, OrderId};

    fn make_signal(signal_type: FraudSignalType, score: f64) -> FraudSignal {
        FraudSignal {
            order_id: OrderId::new(),
            signal_type,
            score,
            details: "test signal".to_string(),
            detected_at: Utc::now(),
        }
    }

    fn make_rule(signal_type: FraudSignalType, threshold: f64, action: FraudDecision) -> FraudRule {
        FraudRule {
            id: FraudRuleId::new(),
            name: "test rule".to_string(),
            description: None,
            signal_type,
            threshold,
            action,
            enabled: true,
            created_at: Utc::now(),
            updated_at: Utc::now(),
        }
    }

    fn make_assessment(decision: FraudDecision, reviewed_by: Option<String>) -> FraudAssessment {
        FraudAssessment {
            order_id: OrderId::new(),
            risk_score: 0.5,
            signals: vec![],
            decision,
            reviewed_by,
            review_notes: None,
            created_at: Utc::now(),
            updated_at: Utc::now(),
        }
    }

    // ---- calculate_risk_score ----

    #[test]
    fn calculate_risk_score_returns_zero_for_empty_signals() {
        assert_eq!(FraudAssessment::calculate_risk_score(&[]), 0.0);
    }

    #[test]
    fn calculate_risk_score_returns_max_signal_score() {
        let order_id = OrderId::new();
        let signals = vec![
            FraudSignal {
                order_id,
                signal_type: FraudSignalType::VelocitySpike,
                score: 0.3,
                details: String::new(),
                detected_at: Utc::now(),
            },
            FraudSignal {
                order_id,
                signal_type: FraudSignalType::AddressMismatch,
                score: 0.7,
                details: String::new(),
                detected_at: Utc::now(),
            },
            FraudSignal {
                order_id,
                signal_type: FraudSignalType::GeoIpAnomaly,
                score: 0.5,
                details: String::new(),
                detected_at: Utc::now(),
            },
        ];
        assert!((FraudAssessment::calculate_risk_score(&signals) - 0.7).abs() < f64::EPSILON);
    }

    // ---- decide ----

    #[test]
    fn decide_returns_accept_with_no_rules() {
        let signals = vec![make_signal(FraudSignalType::VelocitySpike, 0.5)];
        let decision = FraudAssessment::decide(0.3, &[], &signals);
        assert_eq!(decision, FraudDecision::Accept);
    }

    #[test]
    fn decide_returns_reject_when_rule_triggers_reject() {
        let signals = vec![make_signal(FraudSignalType::VelocitySpike, 0.9)];
        let rules = vec![make_rule(FraudSignalType::VelocitySpike, 0.8, FraudDecision::Reject)];
        let decision = FraudAssessment::decide(0.9, &rules, &signals);
        assert_eq!(decision, FraudDecision::Reject);
    }

    #[test]
    fn decide_returns_review_when_rule_triggers_review() {
        let signals = vec![make_signal(FraudSignalType::AddressMismatch, 0.6)];
        let rules = vec![make_rule(FraudSignalType::AddressMismatch, 0.5, FraudDecision::Review)];
        let decision = FraudAssessment::decide(0.6, &rules, &signals);
        assert_eq!(decision, FraudDecision::Review);
    }

    #[test]
    fn decide_returns_review_on_high_risk_score_fallback() {
        // No rules match, but risk_score >= 0.8 triggers review fallback
        let decision = FraudAssessment::decide(0.85, &[], &[]);
        assert_eq!(decision, FraudDecision::Review);
    }

    #[test]
    fn decide_disabled_rule_is_ignored() {
        let signals = vec![make_signal(FraudSignalType::VelocitySpike, 0.9)];
        let mut rule = make_rule(FraudSignalType::VelocitySpike, 0.8, FraudDecision::Reject);
        rule.enabled = false;
        let decision = FraudAssessment::decide(0.5, &[rule], &signals);
        // Disabled rule should not trigger; risk_score < 0.8 so no fallback review
        assert_eq!(decision, FraudDecision::Accept);
    }

    // ---- needs_review ----

    #[test]
    fn needs_review_returns_true_when_review_decision_and_no_reviewer() {
        let assessment = make_assessment(FraudDecision::Review, None);
        assert!(assessment.needs_review());
    }

    #[test]
    fn needs_review_returns_false_when_already_reviewed() {
        let assessment = make_assessment(FraudDecision::Review, Some("admin".to_string()));
        assert!(!assessment.needs_review());
    }

    #[test]
    fn needs_review_returns_false_when_decision_is_accept() {
        let assessment = make_assessment(FraudDecision::Accept, None);
        assert!(!assessment.needs_review());
    }

    // ---- enum Display / FromStr round-trips ----

    #[test]
    fn fraud_signal_type_display_fromstr_roundtrip() {
        for signal_type in [
            FraudSignalType::VelocitySpike,
            FraudSignalType::AddressMismatch,
            FraudSignalType::HighValueFirstOrder,
            FraudSignalType::GeoIpAnomaly,
            FraudSignalType::BinCountryMismatch,
            FraudSignalType::DeviceFingerprint,
            FraudSignalType::ProxyVpn,
            FraudSignalType::DisposableEmail,
            FraudSignalType::PaymentRetries,
            FraudSignalType::UnusualTime,
        ] {
            let s = signal_type.to_string();
            let parsed: FraudSignalType = s.parse().unwrap();
            assert_eq!(parsed, signal_type, "round-trip failed for {s}");
        }
    }

    #[test]
    fn fraud_decision_display_fromstr_roundtrip() {
        for decision in [FraudDecision::Accept, FraudDecision::Review, FraudDecision::Reject] {
            let s = decision.to_string();
            let parsed: FraudDecision = s.parse().unwrap();
            assert_eq!(parsed, decision, "round-trip failed for {s}");
        }
    }

    // ---- Defaults ----

    #[test]
    fn fraud_decision_default_is_accept() {
        assert_eq!(FraudDecision::default(), FraudDecision::Accept);
    }
}