rule_engine

Rule Engine with AST Implementation

A sophisticated rule engine using Abstract Syntax Tree (AST) for complex business rule evaluation. This project is developed as part of the Zeotap Intern Assignment, featuring a modern web interface for rule management and evaluation.

📋 Table of Contents

Overview
Features
Architecture
Setup
Usage
API
Progress

🎯 Overview

A modern 3-tier application that enables:

Complex rule creation and evaluation
Dynamic rule combinations
Real-time data assessment
Easy rule management through web interface

✨ Features Implemented

Core Features

✅ Dynamic rule creation and modification
✅ Real-time rule evaluation
✅ Rule combination using AST
✅ MongoDB data persistence
✅ Modern React UI

Enhanced Features

✅ Visual Rule Builder with interactive components
✅ Real-time rule validation
✅ Performance analytics and metrics
✅ Rule templates system
✅ Advanced error handling with detailed feedback

Technical Features

✅ AST implementation
✅ Efficient rule traversal
✅ RESTful API design
✅ Error handling
✅ Input validation
✅ Component-based architecture
✅ Modular code structure
✅ Real-time validation service
✅ Analytics tracking
✅ Advanced UI components

🏗️ Architecture

AST Structure

class Node:
    type: str        # "operator" or "comparison"
    left: Node       # Left child node
    right: Node      # Right child for operators
    field: str       # Field name for comparisons
    operator: str    # Comparison operator
    value: Any       # Comparison value

Project Structure

rule_engine/
├── app/
│   ├── services/
│   │   ├── rule_validation.py
│   │   └── rule_analytics.py
│   ├── static/
│   │   ├── css/
│   │   └── js/
│   │       └── components/
│   │           ├── core/
│   │           │   ├── RuleEngineUI.jsx
│   │           │   └── RuleBuilder.jsx
│   │           ├── shared/
│   │           │   ├── AlertMessage.jsx
│   │           │   └── LoadingSpinner.jsx
│   │           └── tabs/
│   │               ├── CreateTab.jsx
│   │               ├── ManageTab.jsx
│   │               ├── EvaluateTab.jsx
│   │               └── CombineTab.jsx
│   ├── routes/
│   │   └── api.py
│   ├── main.py
│   ├── database.py
│   └── rule_engine.py
├── tests/
│   ├── test_api.py
│   ├── test_rule_engine.py
│   └── test_rule_validation.py
├── requirements.txt
└── README.md

🛠️ Technology Stack

Frontend: React, Tailwind CSS, Lucide Icons
Backend: FastAPI, Python 3.7+
Database: MongoDB
Validation: Pydantic
Testing: Pytest

🚀 Setup

Prerequisites

- Python 3.7+
- MongoDB
- Node.js and npm

Installation

Clone repository:

git clone https://github.com/AryanBV/rule_engine.git
cd rule_engine

Create virtual environment:

python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

Install dependencies:
```
pip install -r requirements.txt
```

Configure MongoDB:

# Create .env file with:
MONGODB_URL=mongodb://localhost:27017/rule_engine

Start server:
```
uvicorn app.main:app --reload
```

Host name:

http://localhost:8000/static/index.html

📖 Usage

Rule Creation Example

# Simple Rule
age > 30 AND department = 'Sales'

# Complex Rule
((age > 30 AND department = 'Marketing')) AND (salary > 20000 OR experience > 5)

Data Evaluation Example

{
  "age": 35,
  "department": "Sales",
  "salary": 75000,
  "experience": 7
}

📡 API Reference

Rule Management

POST   /api/rules/                    # Create rule
GET    /api/rules/                    # List rules
GET    /api/rules/{rule_id}           # Get rule
PUT    /api/rules/{rule_id}           # Update rule
DELETE /api/rules/{rule_id}           # Delete rule

Rule Operations

POST   /api/rules/evaluate/{rule_id}  # Evaluate rule
POST   /api/rules/combine             # Combine rules
POST   /api/rules/validate            # Validate rule syntax
GET    /api/rules/{rule_id}/analytics # Get rule analytics

🧪 Testing

Run tests:

pytest

📈 Current Progress

Completed

✅ Core engine implementation
✅ AST evaluation logic
✅ MongoDB integration
✅ CRUD operations
✅ Modern UI
✅ Enhanced validation
✅ Visual rule builder
✅ Performance analytics
✅ Component architecture
✅ Real-time feedback

In Development

🔄 Enhanced error handling
🔄 UI/UX improvements
🔄 Performance optimizations

Planned

📋 User authentication
📋 Rule versioning
📋 Advanced visualizations
📋 Batch evaluations

📚 Documentation

API Docs: http://localhost:8000/docs
Components: app/static/js/components/
Core Logic: app/rule_engine.py

🤝 Contributing

Fork repository
Create feature branch
Commit changes
Push to branch
Submit pull request

Test Coverage

Unit tests
API tests
Integration tests
Validation tests
Component tests