limiteron 0.2.4

Unified flow control framework for Rust
Documentation 
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

// Copyright (c) 2026 Kirky.X
// SPDX-License-Identifier: MIT
//! BanRecordEntity - DBNexus entity for ban records
//!
//! This entity is used by DBNexusBanStorageAdapter to store ban records
//! with support for IP bans, user ID bans, and MAC address bans.

use dbnexus::db_entity;
use sea_orm::entity::prelude::DateTimeUtc;
use sea_orm::entity::prelude::*;

/// Ban record model
#[db_entity(table_name = "limiteron_bans", primary_key = "id")]
#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "limiteron_bans")]
pub struct Model {
    /// Primary key - unique ban ID
    #[sea_orm(primary_key)]
    pub id: i64,
    /// Target type: "ip", "user", "mac"
    #[sea_orm(column_type = "Text")]
    pub target_type: String,
    /// Target value (IP address, user ID, or MAC address)
    #[sea_orm(column_name = "target_value")]
    pub target_value: String,
    /// Composite unique key for efficient lookups
    #[sea_orm(unique)]
    #[sea_orm(column_name = "target_key")]
    pub target_key: String,
    /// Number of times this target has been banned
    pub ban_times: u32,
    /// Ban duration in seconds
    pub duration: i64,
    /// When the ban was applied (UTC)
    pub banned_at: DateTimeUtc,
    /// When the ban expires (UTC)
    pub expires_at: DateTimeUtc,
    /// Whether this is a manual ban (true) or automatic (false)
    pub is_manual: bool,
    /// Reason for the ban
    pub reason: String,
    /// Creation timestamp (UTC)
    pub created_at: DateTimeUtc,
    /// Last update timestamp (UTC)
    pub updated_at: DateTimeUtc,
}

/// Relations for the entity
#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub enum Relation {}

/// Create table DDL for BanRecordEntity
pub fn create_table_ddl() -> &'static str {
    r#"
    CREATE TABLE IF NOT EXISTS limiteron_bans (
        id BIGSERIAL PRIMARY KEY,
        target_type VARCHAR(50) NOT NULL,
        target_value TEXT NOT NULL,
        target_key VARCHAR(511) NOT NULL UNIQUE,
        ban_times INTEGER NOT NULL DEFAULT 1,
        duration BIGINT NOT NULL,
        banned_at TIMESTAMP WITH TIME ZONE NOT NULL,
        expires_at TIMESTAMP WITH TIME ZONE NOT NULL,
        is_manual BOOLEAN NOT NULL DEFAULT FALSE,
        reason TEXT NOT NULL,
        created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
        updated_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
    )
    "#
}

/// Helper to create target key from type and value
pub fn create_target_key(target_type: &str, target_value: &str) -> String {
    format!("{}:{}", target_type, target_value)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_create_target_key() {
        assert_eq!(create_target_key("ip", "192.168.1.1"), "ip:192.168.1.1");
        assert_eq!(create_target_key("user", "user123"), "user:user123");
        assert_eq!(
            create_target_key("mac", "aa:bb:cc:dd:ee:ff"),
            "mac:aa:bb:cc:dd:ee:ff"
        );
    }

    #[test]
    fn test_create_table_ddl() {
        let ddl = create_table_ddl();
        assert!(ddl.contains("limiteron_bans"));
        assert!(ddl.contains("target_type"));
        assert!(ddl.contains("target_value"));
        assert!(ddl.contains("expires_at"));
    }
}