wappa 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

wappa/cli/examples/redis_cache_example/app/main.py

@@ -0,0 +1,234 @@
+"""
+Redis Cache Example - SOLID Architecture Implementation
+
+This is the main initialization file following SOLID principles:
+- Single Responsibility: Pure initialization and configuration
+- Open/Closed: Extensible through score module registration
+- Liskov Substitution: Compatible with Wappa framework interface
+- Interface Segregation: Clean dependency interfaces
+- Dependency Inversion: Abstractions injected into concrete implementations
+
+SETUP REQUIRED:
+1. Create a .env file with your WhatsApp Business API credentials:
+    WP_ACCESS_TOKEN=your_access_token_here
+    WP_PHONE_ID=your_phone_number_id_here
+    WP_BID=your_business_id_here
+
+2. Set up Redis:
+    REDIS_URL=redis://localhost:6379
+
+DEMO FEATURES:
+- SOLID architecture with separated concerns
+- Master event orchestrator with score modules
+- User management, message history, and state commands
+- Cache statistics and monitoring
+- Professional logging and error handling
+
+USAGE:
+- Direct Python: python -m app.main (from project root)
+- FastAPI-style: uvicorn app.main:app --reload (from project root)
+- Wappa CLI: wappa dev app.main (when CLI is available)
+"""
+
+# Import core Wappa components
+from wappa import Wappa, __version__
+from wappa.core.config.settings import settings
+from wappa.core.logging import get_logger
+
+logger = get_logger(__name__)
+
+# Import our SOLID architecture WappaEventHandler implementation
+from .master_event import RedisCacheExampleHandler
+
+
+def validate_configuration() -> bool:
+    """
+    Validate required configuration settings.
+    
+    Returns:
+        True if configuration is valid, False otherwise
+    """
+    
+    # Check required WhatsApp credentials
+    missing_configs = []
+    
+    if not settings.wp_access_token:
+        missing_configs.append("WP_ACCESS_TOKEN")
+    
+    if not settings.wp_phone_id:
+        missing_configs.append("WP_PHONE_ID")
+        
+    if not settings.wp_bid:
+        missing_configs.append("WP_BID")
+        
+    if not settings.has_redis:
+        missing_configs.append("REDIS_URL")
+    
+    if missing_configs:
+        logger.error(f"❌ Missing required configuration: {', '.join(missing_configs)}")
+        logger.error("💡 Create a .env file with the required credentials")
+        return False
+    
+    logger.info("✅ Configuration validation passed")
+    return True
+
+
+def display_startup_information() -> None:
+    """
+    Display startup information and demo features.
+    
+    Shows configuration status, architecture overview,
+    and available demo features.
+    """
+    print(f"🚀 Wappa v{__version__} - Redis Cache Example (SOLID Architecture)")
+    print("=" * 80)
+    print()
+    
+    print("🏗️ *SOLID ARCHITECTURE IMPLEMENTATION:*")
+    print("  • Single Responsibility: Each score module has one specific concern")
+    print("  • Open/Closed: New score modules can be added without modification")
+    print("  • Liskov Substitution: All scores implement the same interface")
+    print("  • Interface Segregation: Clean, focused interfaces for each concern")
+    print("  • Dependency Inversion: Dependencies injected through abstractions")
+    print()
+    
+    print("📋 *CONFIGURATION STATUS:*")
+    print(f"  • Access Token: {'✅ Configured' if settings.wp_access_token else '❌ Missing'}")
+    print(f"  • Phone ID: {settings.wp_phone_id if settings.wp_phone_id else '❌ Missing'}")
+    print(f"  • Business ID: {'✅ Configured' if settings.wp_bid else '❌ Missing'}")
+    print(f"  • Redis URL: {'✅ Configured' if settings.has_redis else '❌ Missing'}")
+    print(f"  • Environment: {'🛠️ Development' if settings.is_development else '🚀 Production'}")
+    print()
+    
+    print("🎯 *SCORE MODULES (BUSINESS LOGIC):*")
+    print("  • UserManagementScore: User profile and caching logic")
+    print("  • MessageHistoryScore: Message logging and /HISTORY command")
+    print("  • StateCommandsScore: /WAPPA and /EXIT command processing")  
+    print("  • CacheStatisticsScore: Cache monitoring and /STATS command")
+    print()
+    
+    print("🧪 *DEMO FEATURES:*")
+    print("  1. Send any message → User profile created/updated + message logged")
+    print("  2. Send '/WAPPA' → Enter special state with cache management")
+    print("  3. While in WAPPA state → All messages replied with 'Hola Wapp@ ;)'")
+    print("  4. Send '/EXIT' → Leave special state with session summary")
+    print("  5. Send '/HISTORY' → View your last 20 messages with timestamps")
+    print("  6. Send '/STATS' → View comprehensive cache statistics")
+    print()
+    
+    print("💎 *REDIS CACHE ARCHITECTURE:*")
+    print("  • user_cache: User profiles with dependency injection")
+    print("  • table_cache: Message history with BaseModel auto-serialization")  
+    print("  • state_cache: Command state management with TTL")
+    print("  • Comprehensive error handling and logging")
+    print()
+    
+    print("🔧 *TECHNICAL FEATURES:*")
+    print("  • Dependency injection with interface abstractions")
+    print("  • Score module registry with automatic discovery")
+    print("  • Professional error handling and recovery")
+    print("  • Performance monitoring and statistics")
+    print("  • Comprehensive logging with structured output")
+    print("  • Proper WappaEventHandler implementation with all required methods")
+    print()
+
+
+def create_wappa_application() -> Wappa:
+    """
+    Create and configure the Wappa application.
+    
+    This function follows Single Responsibility Principle by focusing
+    only on application creation and initial configuration.
+    
+    Returns:
+        Configured Wappa application instance
+    """
+    
+    try:
+        # Create Wappa instance with Redis cache
+        logger.info("🏗️ Creating Wappa application with Redis cache...")
+        app = Wappa(cache="redis")
+        
+        logger.info("✅ Wappa application created successfully")
+        return app
+        
+    except Exception as e:
+        logger.error(f"❌ Failed to create Wappa application: {e}")
+        raise
+
+
+def main() -> None:
+    """
+    Main application entry point.
+    
+    Demonstrates SOLID principles in action:
+    - Single Responsibility: Each function has one clear purpose
+    - Dependency Inversion: Dependencies flow from abstractions
+    - Open/Closed: System is open for extension via score modules
+    """
+    
+    logger.info("🚀 Starting Redis Cache Example with SOLID Architecture")
+    
+    try:
+        # Display startup information
+        display_startup_information()
+        
+        # Validate configuration before proceeding
+        if not validate_configuration():
+            logger.error("❌ Configuration validation failed - cannot start application")
+            return
+        
+        # Create Wappa application
+        app = create_wappa_application()
+        
+        # Create and set the SOLID WappaEventHandler implementation
+        handler = RedisCacheExampleHandler()
+        app.set_event_handler(handler)
+        
+        logger.info("✅ Application initialization completed with SOLID WappaEventHandler")
+        
+        print("🌐 Starting SOLID Redis cache demo server...")
+        print("💡 Press CTRL+C to stop the server")
+        print("=" * 80)
+        print()
+        
+        # Start the application
+        # The framework will handle dependency injection automatically
+        app.run()
+        
+    except KeyboardInterrupt:
+        logger.info("👋 Application stopped by user")
+        print("\n👋 Redis cache demo stopped by user")
+        
+    except Exception as e:
+        logger.error(f"❌ Application startup error: {e}", exc_info=True)
+        print(f"\n❌ Server error: {e}")
+        
+    finally:
+        logger.info("🏁 Redis cache demo completed")
+        print("🏁 Redis cache demo completed")
+
+
+# Module-level app instance for uvicorn compatibility
+# This enables: uvicorn main:app --reload
+
+# Set up basic logging for module-level initialization
+
+
+try:
+    logger.info("📦 Creating module-level Wappa application instance")
+    app = Wappa(cache="redis")
+    
+    # Create and set the SOLID WappaEventHandler implementation
+    handler = RedisCacheExampleHandler()
+    app.set_event_handler(handler)
+    
+    logger.info("✅ Module-level application instance ready with SOLID WappaEventHandler")
+    
+except Exception as e:
+    logger.error(f"❌ Failed to create module-level app instance: {e}")
+    raise
+
+
+if __name__ == "__main__":
+    main()

wappa/cli/examples/redis_cache_example/app/master_event.py

@@ -0,0 +1,419 @@
+"""
+Master Event Handler - WappaEventHandler implementation following SOLID principles.
+
+This module defines the main WappaEventHandler that:
+- Extends WappaEventHandler with proper method signatures
+- Coordinates multiple score modules using dependency injection
+- Follows Single Responsibility Principle for event handling
+- Uses Open/Closed Principle for score module extensibility
+- Implements Liskov Substitution for handler compatibility
+- Uses Interface Segregation with focused score interfaces
+- Follows Dependency Inversion with injected dependencies
+"""
+
+import logging
+from typing import Any, Dict
+
+from .scores import AVAILABLE_SCORES, ScoreBase, ScoreDependencies
+from .scores.score_base import ScoreRegistry
+from .utils.message_utils import extract_user_data, sanitize_message_text
+from wappa import WappaEventHandler
+from wappa.webhooks import ErrorWebhook, IncomingMessageWebhook, StatusWebhook
+
+
+class RedisCacheExampleHandler(WappaEventHandler):
+    """
+    Main WappaEventHandler implementation for Redis cache example following SOLID principles.
+    
+    This handler serves as the main entry point for the Wappa framework and demonstrates:
+    - Proper WappaEventHandler method implementations
+    - SOLID architecture with score module orchestration
+    - Dependency injection and lifecycle management
+    - Professional error handling and logging
+    """
+    
+    def __init__(self):
+        """Initialize the Redis cache example handler."""
+        super().__init__()
+        
+        # Score module registry (following Open/Closed Principle)
+        self.score_registry = ScoreRegistry()
+        
+        # Processing statistics
+        self._total_messages = 0
+        self._successful_processing = 0
+        self._failed_processing = 0
+        
+        # Master handler state
+        self._initialized = False
+        
+        self.logger.info("🎯 RedisCacheExampleHandler initialized - ready for SOLID architecture setup")
+    
+    async def process_message(self, webhook: IncomingMessageWebhook) -> None:
+        """
+        Main message processing method required by WappaEventHandler.
+        
+        This method orchestrates score modules following SOLID principles and
+        demonstrates proper webhook processing with dependency injection.
+        
+        Args:
+            webhook: Incoming message webhook to process
+        """
+        self._total_messages += 1
+        start_time = self._get_current_timestamp()
+        
+        try:
+            # Initialize SOLID architecture on first message if not already done
+            if not self._initialized:
+                await self._initialize_solid_architecture()
+            
+            # Extract basic user information for logging
+            user_data = extract_user_data(webhook)
+            user_id = user_data['user_id']
+            message_text = webhook.get_message_text() or "[NON-TEXT MESSAGE]"
+            
+            self.logger.info(
+                f"📨 Processing message from {user_id}: "
+                f"{sanitize_message_text(message_text)[:50]}..."
+            )
+            
+            # Execute score module processing pipeline
+            processing_result = await self._execute_score_pipeline(webhook)
+            
+            # Record processing results
+            if processing_result['success']:
+                self._successful_processing += 1
+                processing_time = self._get_current_timestamp() - start_time
+                
+                self.logger.info(
+                    f"✅ Message processed successfully in {processing_time:.2f}s "
+                    f"(processed by {processing_result['processed_count']} score modules)"
+                )
+            else:
+                self._failed_processing += 1
+                self.logger.warning(
+                    f"⚠️ Message processing completed with issues: "
+                    f"{processing_result.get('error', 'Unknown error')}"
+                )
+                
+                # Send fallback response to user
+                await self._send_error_response(webhook, processing_result.get('error', 'Processing error'))
+            
+        except Exception as e:
+            self._failed_processing += 1
+            self.logger.error(f"❌ Critical error in message processing: {e}", exc_info=True)
+            await self._send_error_response(webhook, f"System error: {str(e)}")
+    
+    async def process_status(self, webhook: StatusWebhook) -> None:
+        """
+        Process status webhooks from WhatsApp Business API.
+        
+        Args:
+            webhook: Status webhook containing delivery status information
+        """
+        try:
+            status_value = webhook.status.value
+            recipient = webhook.recipient_id
+            
+            self.logger.info(f"📊 Message status: {status_value.upper()} for {recipient}")
+            
+            # You can add custom status processing logic here
+            # For example, updating delivery statistics or handling failed deliveries
+            
+        except Exception as e:
+            self.logger.error(f"❌ Error processing status webhook: {e}", exc_info=True)
+    
+    async def process_error(self, webhook: ErrorWebhook) -> None:
+        """
+        Process error webhooks from WhatsApp Business API.
+        
+        Args:
+            webhook: Error webhook containing error information
+        """
+        try:
+            error_count = webhook.get_error_count()
+            primary_error = webhook.get_primary_error()
+            
+            self.logger.error(
+                f"🚨 WhatsApp API error: {error_count} errors, "
+                f"primary: {primary_error.error_code} - {primary_error.error_title}"
+            )
+            
+            # Record error in statistics
+            self._failed_processing += 1
+            
+            # You can add custom error handling logic here
+            # For example, alerting systems or retry mechanisms
+            
+        except Exception as e:
+            self.logger.error(f"❌ Error processing error webhook: {e}", exc_info=True)
+    
+    async def _initialize_solid_architecture(self) -> None:
+        """
+        Initialize SOLID architecture with score modules and dependency injection.
+        
+        This method demonstrates Dependency Inversion Principle by injecting
+        abstractions and follows Single Responsibility Principle.
+        """
+        try:
+            if not self.validate_dependencies():
+                self.logger.error("❌ Dependencies not properly injected - cannot initialize SOLID architecture")
+                return
+                
+            if not self.cache_factory:
+                self.logger.error("❌ Cache factory not available - cannot initialize SOLID architecture")
+                return
+            
+            # Create cache instances from factory (Dependency Inversion)
+            user_cache = self.cache_factory.create_user_cache()
+            table_cache = self.cache_factory.create_table_cache()
+            state_cache = self.cache_factory.create_state_cache()
+            
+            # Create dependencies container
+            dependencies = ScoreDependencies(
+                messenger=self.messenger, 
+                user_cache=user_cache,
+                table_cache=table_cache,
+                state_cache=state_cache,
+                logger=self.logger
+            )
+            
+            # Auto-register all available score modules (Open/Closed Principle)
+            registered_count = 0
+            for score_class in AVAILABLE_SCORES:
+                try:
+                    # Instantiate score with dependency injection
+                    score_instance = score_class(dependencies)
+                    self.score_registry.register_score(score_instance)
+                    registered_count += 1
+                    
+                    self.logger.info(
+                        f"✅ Registered score module: {score_instance.score_name}"
+                    )
+                    
+                except Exception as e:
+                    self.logger.error(
+                        f"❌ Failed to register {score_class.__name__}: {e}"
+                    )
+            
+            self._initialized = True
+            self.logger.info(
+                f"🎯 SOLID architecture initialized successfully: {registered_count} score modules registered"
+            )
+            
+        except Exception as e:
+            self.logger.error(f"❌ Critical error initializing SOLID architecture: {e}", exc_info=True)
+            raise
+    
+    async def _execute_score_pipeline(self, webhook: IncomingMessageWebhook) -> Dict[str, Any]:
+        """
+        Execute the score module processing pipeline.
+        
+        Processes webhook through all applicable score modules following
+        the Chain of Responsibility pattern.
+        
+        Args:
+            webhook: Webhook to process
+            
+        Returns:
+            Processing result with success status and metadata
+        """
+        try:
+            if not self._initialized:
+                return {
+                    'success': False,
+                    'error': 'SOLID architecture not initialized',
+                    'processed_count': 0
+                }
+            
+            scores = self.score_registry.get_scores()
+            processed_count = 0
+            processing_errors = []
+            
+            # Process webhook through all applicable score modules
+            for score in scores:
+                try:
+                    # Check if score can handle this webhook (Interface Segregation)
+                    can_handle = await score.can_handle(webhook)
+                    
+                    if can_handle:
+                        self.logger.debug(f"🎯 Processing with {score.score_name}")
+                        
+                        # Process with the score module
+                        success = await score.process(webhook)
+                        
+                        if success:
+                            processed_count += 1
+                            self.logger.debug(f"✅ {score.score_name} completed successfully")
+                        else:
+                            processing_errors.append(f"{score.score_name}: Processing failed")
+                            self.logger.warning(f"⚠️ {score.score_name} reported processing failure")
+                    else:
+                        self.logger.debug(f"⏭️ {score.score_name} skipped (cannot handle this webhook)")
+                    
+                except Exception as score_error:
+                    processing_errors.append(f"{score.score_name}: {str(score_error)}")
+                    self.logger.error(
+                        f"❌ Error in {score.score_name}: {score_error}",
+                        exc_info=True
+                    )
+            
+            # Determine overall success
+            overall_success = processed_count > 0 and len(processing_errors) == 0
+            
+            return {
+                'success': overall_success,
+                'processed_count': processed_count,
+                'total_scores': len(scores),
+                'errors': processing_errors if processing_errors else None,
+                'message': (
+                    f"Processed by {processed_count}/{len(scores)} score modules"
+                    + (f" with {len(processing_errors)} errors" if processing_errors else "")
+                )
+            }
+            
+        except Exception as e:
+            self.logger.error(f"❌ Critical error in score pipeline: {e}", exc_info=True)
+            return {
+                'success': False,
+                'processed_count': 0,
+                'error': f"Pipeline error: {str(e)}"
+            }
+    
+    async def _send_error_response(self, webhook: IncomingMessageWebhook, error_details: str) -> None:
+        """
+        Send user-friendly error response when processing fails.
+        
+        Args:
+            webhook: Original webhook that failed to process
+            error_details: Details about the error for logging
+        """
+        try:
+            user_data = extract_user_data(webhook)
+            user_id = user_data['user_id']
+            
+            error_message = (
+                "🚨 SOLID Redis Cache Example\n\n"
+                "❌ An error occurred while processing your message.\n"
+                "Our team has been notified and will resolve this issue soon.\n\n"
+                "Please try again later or contact support if the problem persists."
+            )
+            
+            result = await self.messenger.send_text(
+                recipient=user_id,
+                text=error_message,
+                reply_to_message_id=webhook.message.message_id
+            )
+            
+            if result.success:
+                self.logger.info(f"🚨 Error response sent to {user_id}")
+            else:
+                self.logger.error(f"❌ Failed to send error response: {result.error}")
+            
+        except Exception as e:
+            self.logger.error(f"❌ Error sending error response: {e}")
+    
+    def _get_current_timestamp(self) -> float:
+        """Get current timestamp for performance measurement."""
+        import time
+        return time.time()
+    
+    async def get_handler_statistics(self) -> Dict[str, Any]:
+        """
+        Get comprehensive handler and score module statistics.
+        
+        Returns:
+            Dictionary with processing statistics and score module metrics
+        """
+        try:
+            # Calculate success rate
+            success_rate = (
+                (self._successful_processing / self._total_messages)
+                if self._total_messages > 0 else 0.0
+            )
+            
+            # Get score-specific statistics if initialized
+            score_stats = {}
+            if self._initialized:
+                score_stats = self.score_registry.get_score_stats()
+            
+            return {
+                'handler_status': 'initialized' if self._initialized else 'pending_initialization',
+                'total_messages': self._total_messages,
+                'successful_processing': self._successful_processing,
+                'failed_processing': self._failed_processing,
+                'success_rate': success_rate,
+                'registered_scores': len(self.score_registry.get_scores()) if self._initialized else 0,
+                'score_modules': score_stats
+            }
+            
+        except Exception as e:
+            self.logger.error(f"❌ Error collecting handler statistics: {e}")
+            return {
+                'error': f"Statistics collection failed: {str(e)}"
+            }
+    
+    async def validate_system_health(self) -> Dict[str, Any]:
+        """
+        Validate system health including all score modules and dependencies.
+        
+        Returns:
+            Health check results for the entire system
+        """
+        try:
+            health_results = {
+                'overall_healthy': True,
+                'initialized': self._initialized,
+                'components': {},
+                'registered_scores': len(self.score_registry.get_scores()) if self._initialized else 0
+            }
+            
+            # Check core dependencies
+            core_components = {
+                'messenger': self.messenger,
+                'cache_factory': self.cache_factory
+            }
+            
+            for component_name, component in core_components.items():
+                if component is not None:
+                    health_results['components'][component_name] = 'Available'
+                else:
+                    health_results['components'][component_name] = 'Missing'
+                    health_results['overall_healthy'] = False
+            
+            # Check score modules if initialized
+            if self._initialized:
+                scores = self.score_registry.get_scores()
+                for score in scores:
+                    try:
+                        # Basic validation check
+                        is_valid = await score.validate_dependencies()
+                        health_results['components'][score.score_name] = (
+                            'Healthy' if is_valid else 'Dependency Issues'
+                        )
+                        if not is_valid:
+                            health_results['overall_healthy'] = False
+                            
+                    except Exception as e:
+                        health_results['components'][score.score_name] = f'Error: {str(e)}'
+                        health_results['overall_healthy'] = False
+            
+            return health_results
+            
+        except Exception as e:
+            self.logger.error(f"❌ Error validating system health: {e}")
+            return {
+                'overall_healthy': False,
+                'error': f"Health check failed: {str(e)}"
+            }
+    
+    def __str__(self) -> str:
+        """String representation of the handler."""
+        return (
+            f"RedisCacheExampleHandler("
+            f"messages={self._total_messages}, "
+            f"success_rate={self._successful_processing/max(1, self._total_messages):.2%}, "
+            f"scores={len(self.score_registry.get_scores()) if self._initialized else 'pending'}, "
+            f"initialized={self._initialized}"
+            f")"
+        )