Your account is ready.
' ) ``` ### Example 4: Check Simulator Status ```bash # Using curl curl http://localhost:8000/api/simulator/health ``` ```python # Using requests import requests response = requests.get('http://localhost:8000/api/simulator/health') print(response.json()) ``` ### Example 5: Reset Simulator ```bash # Using curl curl http://localhost:8000/api/simulator/reset ``` ```python # Using requests import requests response = requests.get('http://localhost:8000/api/simulator/reset') print(response.json()) ``` ## Testing Workflow ### Step 1: Start Development Server ```bash python manage.py runserver ``` ### Step 2: Enable Simulator Update `.env` file with simulator URLs (see Configuration section). ### Step 3: Run Python Script ```python # test_simulator.py from apps.notifications.services import NotificationService # Test email print("Testing email...") email_log = NotificationService.send_email_via_api( message='Test email from simulator', email='your-email@example.com', subject='Simulator Test' ) print(f"Email: {email_log.status}") # Test SMS print("\nTesting SMS...") sms_log = NotificationService.send_sms_via_api( message='Test SMS from simulator', phone='+966501234567' ) print(f"SMS: {sms_log.status}") # Check health import requests health = requests.get('http://localhost:8000/api/simulator/health').json() print(f"\nStatistics: {health['statistics']}") ``` ### Step 4: Verify Results - **Email**: Check your email inbox (or mailcatcher if using console backend) - **SMS**: Check terminal for formatted SMS output - **Logs**: Check `logs/px360.log` for detailed logs ## Integration with External API Service The simulator is fully integrated with the external API notification service. When you enable the simulator URLs in `.env`, the `NotificationService` automatically uses the simulator endpoints. ### Switching Between Simulator and Real APIs **Using Simulator** (for development/testing): ```bash EMAIL_API_ENABLED=true EMAIL_API_URL=http://localhost:8000/api/simulator/send-email SMS_API_ENABLED=true SMS_API_URL=http://localhost:8000/api/simulator/send-sms ``` **Using Real APIs** (for production): ```bash EMAIL_API_ENABLED=true EMAIL_API_URL=https://api.yourservice.com/send-email SMS_API_ENABLED=true SMS_API_URL=https://api.yourservice.com/send-sms ``` **No code changes required!** Just update the URLs in `.env`. ## Request Logging All simulator requests are logged to: 1. **Terminal**: Immediate feedback during development 2. **File Log**: `logs/px360.log` - permanent record 3. **Request History**: In-memory last 10 requests (accessible via health check) ### Log Format ``` [INFO] [Simulator] EMAIL Request #1: sent [INFO] [Email Simulator] Sending email to user@example.com: Test Subject [INFO] [Email Simulator] Email sent successfully to user@example.com ``` ## Error Handling The simulator handles various error scenarios gracefully: ### Missing Fields **Request**: ```json { "to": "user@example.com" // Missing "subject" and "message" } ``` **Response**: ```json { "success": false, "error": "Missing required fields: subject, message" } ``` ### Invalid JSON **Request**: Malformed JSON **Response**: ```json { "success": false, "error": "Invalid JSON format" } ``` ### Email Sending Errors If Django SMTP fails to send the email, the error is caught and returned: **Response**: ```json { "success": false, "error": "SMTP error details..." } ``` ## Troubleshooting ### Issue: Email not received **Possible Causes**: 1. SMTP not configured correctly 2. Email in spam folder 3. Invalid recipient address **Solutions**: 1. Check `.env` email settings 2. Check `logs/px360.log` for errors 3. Use mailcatcher for local testing: ```bash pip install mailcatcher mailcatcher # Update .env: EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend # EMAIL_HOST=localhost, EMAIL_PORT=1025 ``` ### Issue: SMS not showing in terminal **Possible Causes**: 1. Server not running in terminal 2. Output redirected to file **Solutions**: 1. Ensure `python manage.py runserver` is running in visible terminal 2. Check `logs/px360.log` for SMS logs ### Issue: Simulator endpoints returning 404 **Possible Causes**: 1. Simulator app not in INSTALLED_APPS 2. URL not included in main urls.py 3. Server not restarted after adding app **Solutions**: 1. Check `config/settings/base.py` includes `'apps.simulator'` 2. Check `config/urls.py` includes simulator URLs 3. Restart server: `python manage.py runserver` ### Issue: Health check shows 0 requests **Possible Causes**: 1. Simulator not enabled in `.env` 2. Requests using wrong URLs **Solutions**: 1. Check `EMAIL_API_ENABLED` and `SMS_API_ENABLED` are `true` 2. Verify URLs point to `localhost:8000/api/simulator/...` ## Advanced Usage ### Custom SMS Formatting You can modify the SMS output format in `apps/simulator/views.py`. Look for the `sms_simulator` function and adjust the print statements. ### Request Middleware Add custom middleware to intercept all simulator requests: ```python # Create apps/simulator/middleware.py class SimulatorLoggingMiddleware: def __init__(self, get_response): self.get_response = get_response def __call__(self, request): if '/api/simulator/' in request.path: # Custom logging logic pass return self.get_response(request) ``` ### Batch Testing Test multiple notifications at once: ```python from apps.notifications.services import NotificationService test_data = [ {'email': 'user1@example.com', 'subject': 'Test 1'}, {'email': 'user2@example.com', 'subject': 'Test 2'}, ] for data in test_data: NotificationService.send_email_via_api( message=f'Test email for {data["email"]}', email=data['email'], subject=data['subject'] ) ``` ## Performance Considerations - **Email Sending**: Each email makes an SMTP request (network latency) - **SMS Printing**: Instant, no network overhead - **Request History**: Limited to last 10 requests to prevent memory issues - **Logging**: Rotating file handler prevents disk space issues ## Security Considerations - **No Authentication Required**: Simulator endpoints are public by design - **CSRF Exempt**: All endpoints exempt from CSRF checks - **Production Use**: Disable simulator in production by not using simulator URLs - **Sensitive Data**: Simulator logs may contain PII (phone numbers, emails) ## Best Practices 1. **Development Only**: Use simulator only in development/testing environments 2. **Environment-Specific Config**: Keep simulator URLs only in `.env.local` or `.env.development` 3. **Regular Resets**: Reset simulator counters between test runs 4. **Log Monitoring**: Check logs for any unexpected errors 5. **Test Coverage**: Include simulator tests in your test suite ## Related Documentation - [External API Notification Service](EXTERNAL_API_NOTIFICATION.md) - [Notification Service](../apps/notifications/README.md) - [Environment Configuration](../config/settings/base.py) ## Support For issues or questions: 1. Check logs: `logs/px360.log` 2. Verify `.env` configuration 3. Test endpoints with curl/Postman 4. Check simulator health: `GET /api/simulator/health` ## License Part of the PX360 project. See project LICENSE for details.