# jookies/jasmin architecture

> Architecture diagram of the GitHub repository jookies/jasmin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jookies/jasmin
- Repository: https://github.com/jookies/jasmin

## Overview

##### Main Components Identification

a. Protocol Interfaces:
- SMPP Server/Client interface
- HTTP Server interface
- CLI (Command Line Interface)
- REST API interface

b. Core Components:
- Router (Message routing engine)
- Interceptor system
- DLR (Delivery Receipt) handling system
- Billing system

c. Storage Systems:
- Redis (for DLR tracking and billing)
- AMQP Broker (RabbitMQ for message queuing)

**[External Clients Layer]**

**[Protocol Interfaces Layer]**

**[Core Processing Layer]**

**[Persistence Layer]**

##### Specific Implementation Details

a. Message Flow:
- Incoming messages through SMPP/HTTP
- Routing through the core system
- Queue management via AMQP
- DLR handling
- Final delivery paths

b. Management Layer:
- CLI management interface
- REST API endpoints
- Configuration management

c. Monitoring & Observability:
- Prometheus metrics
- Grafana dashboards
- Logging system

##### Key Integration Points

Highlight:
- SMPP client connections to external SMSCs
- HTTP API endpoints for client applications
- Redis connection for DLR tracking
- AMQP broker integration points
- Management interfaces

##### Additional Elements

Include:
- Version information
- System requirements
- Key dependencies (Twisted, Python, etc.)
- Scaling points

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Clients Layer
    subgraph Clients
        SMS_Client["SMS Client"]:::external
        Web_Client["Web Client"]:::external
        Admin_Client["Admin Client"]:::external
    end

    %% Protocol Interfaces Layer
    subgraph Protocols
        SMPP["SMPP Server/Client"]:::protocol
        HTTP["HTTP Server"]:::protocol
        CLI["CLI Interface"]:::protocol
        REST["REST API"]:::protocol
        Validation["Protocol Validation"]:::protocol
    end

    %% Core Processing Layer
    subgraph Core
        Router["Router Engine"]:::core
        Interceptor["Interceptor System"]:::core
        DLR_Handler["DLR Handler"]:::core
        DLR_Lookup["DLR Lookup Service"]:::core
        Billing["Billing System"]:::core
        
        subgraph Tables
            RT["Routing Tables"]:::table
            IT["Interception Tables"]:::table
            Filters["Message Filters"]:::table
        end
        
        subgraph Management
            ClientMgmt["Client Management"]:::mgmt
            ConfigMgmt["Configuration Management"]:::mgmt
            Metrics["Metrics/Stats Collection"]:::mgmt
        end
    end

    %% Persistence Layer
    subgraph Storage
        Redis["Redis"]:::storage
        AMQP["AMQP Broker"]:::storage
        Queues["Queue Management"]:::storage
    end

    %% Relationships
    SMS_Client --> SMPP
    Web_Client --> HTTP
    Admin_Client --> |Management| CLI
    Admin_Client --> |API| REST

    SMPP --> Validation
    HTTP --> Validation
    REST --> Validation

    Validation --> Router
    Router --> RT
    Router --> Filters
    Router --> Interceptor
    Interceptor --> IT
    
    Router --> DLR_Handler
    DLR_Handler --> DLR_Lookup
    DLR_Lookup --> Redis
    
    Router --> Billing
    Billing --> Redis
    
    Router --> Queues
    Queues --> AMQP

    ClientMgmt --> Router
    ConfigMgmt --> Router
    Metrics --> Router

    %% Styles
    classDef external fill:#9370DB
    classDef protocol fill:#90EE90
    classDef core fill:#87CEEB
    classDef storage fill:#FFA500
    classDef table fill:#FFE4B5
    classDef mgmt fill:#D3D3D3

    %% Click Events
    click SMPP "https://github.com/jookies/jasmin/tree/master/jasmin/protocols/smpp/"
    click HTTP "https://github.com/jookies/jasmin/tree/master/jasmin/protocols/http/"
    click CLI "https://github.com/jookies/jasmin/tree/master/jasmin/protocols/cli/"
    click REST "https://github.com/jookies/jasmin/tree/master/jasmin/protocols/rest/"
    click Router "https://github.com/jookies/jasmin/blob/master/jasmin/routing/router.py"
    click Interceptor "https://github.com/jookies/jasmin/tree/master/jasmin/interceptor/"
    click DLR_Handler "https://github.com/jookies/jasmin/blob/master/jasmin/bin/dlrd.py"
    click DLR_Lookup "https://github.com/jookies/jasmin/blob/master/jasmin/bin/dlrlookupd.py"
    click Billing "https://github.com/jookies/jasmin/blob/master/jasmin/routing/Bills.py"
    click Redis "https://github.com/jookies/jasmin/tree/master/jasmin/redis/"
    click Queues "https://github.com/jookies/jasmin/tree/master/jasmin/queues/"
    click RT "https://github.com/jookies/jasmin/blob/master/jasmin/routing/RoutingTables.py"
    click IT "https://github.com/jookies/jasmin/blob/master/jasmin/routing/InterceptionTables.py"
    click Filters "https://github.com/jookies/jasmin/blob/master/jasmin/routing/Filters.py"
    click ClientMgmt "https://github.com/jookies/jasmin/blob/master/jasmin/managers/clients.py"
    click ConfigMgmt "https://github.com/jookies/jasmin/tree/master/jasmin/config/"
    click Metrics "https://github.com/jookies/jasmin/blob/master/jasmin/tools/stats.py"
    click Validation "https://github.com/jookies/jasmin/blob/master/jasmin/protocols/validation.py"
```
