smart_message 0.0.5 → 0.0.7

data/docs/getting-started.md

@@ -40,6 +40,11 @@ class WelcomeMessage < SmartMessage::Base
   # Add a description for the message class
   description "Welcomes new users after successful signup"
   
+  # Configure entity addressing
+  from 'user-service'           # Required: identifies sender
+  to 'notification-service'     # Optional: specific recipient
+  reply_to 'user-service'       # Optional: where responses go
+  
   # Define message properties
   property :user_name
   property :email
@@ -153,6 +158,9 @@ puts message._sm_header.uuid          # Unique identifier
 puts message._sm_header.message_class # "WelcomeMessage"
 puts message._sm_header.published_at  # Timestamp when published
 puts message._sm_header.publisher_pid # Process ID of publisher
+puts message._sm_header.from          # 'user-service'
+puts message._sm_header.to            # 'notification-service'
+puts message._sm_header.reply_to      # 'user-service'
 ```
 
 ### Transports
@@ -222,6 +230,36 @@ OrderMessage.subscribe("OrderService.process_order")
 - **Proc**: Reusable handlers that work across multiple message types
 - **Method**: Complex business logic organized in service classes
 
+### Entity Addressing
+
+SmartMessage supports entity-to-entity addressing for sophisticated messaging patterns:
+
+```ruby
+# Point-to-point messaging
+class PaymentMessage < SmartMessage::Base
+  from 'payment-service'    # Required: sender identity
+  to 'bank-gateway'         # Optional: specific recipient
+  reply_to 'payment-service' # Optional: where responses go
+  
+  property :amount, required: true
+end
+
+# Broadcast messaging (no 'to' field)
+class AnnouncementMessage < SmartMessage::Base
+  from 'admin-service'      # Required sender
+  # No 'to' = broadcast to all subscribers
+  
+  property :message, required: true
+end
+
+# Instance-level addressing override
+payment = PaymentMessage.new(amount: 100.00)
+payment.to('backup-gateway')  # Override destination
+payment.publish
+```
+
+For more details, see [Entity Addressing](addressing.md).
+
 ## Next Steps
 
 Now that you have the basics working, explore:

data/examples/01_point_to_point_orders.rb

@@ -92,7 +92,8 @@ class OrderService
       customer_id: customer_id,
       amount: amount,
       payment_method: payment_method,
-      items: items
+      items: items,
+      from: 'OrderService'
     )
     
     puts "🏪 OrderService: Sending order to payment processing..."
@@ -132,7 +133,8 @@ class PaymentService
       payment_id: payment_id,
       status: success ? 'success' : 'failed',
       message: success ? 'Payment processed successfully' : 'Insufficient funds',
-      processed_at: Time.now.iso8601
+      processed_at: Time.now.iso8601,
+      from: 'PaymentService'
     )
     
     puts "💳 PaymentService: Sending payment response..."

data/examples/02_publish_subscribe_events.rb

@@ -270,7 +270,8 @@ class UserManager
       user_email: user_email,
       user_name: user_name,
       timestamp: Time.now.iso8601,
-      metadata: metadata
+      metadata: metadata,
+      from: 'UserManager'
     )
     
     puts "👤 UserManager: Publishing #{event_type} event..."

data/examples/03_many_to_many_chat.rb

@@ -164,7 +164,8 @@ class HumanChatAgent
         message_type: 'user',
         timestamp: Time.now.iso8601,
         mentions: mentions,
-        metadata: { client: 'human_agent' }
+        metadata: { client: 'human_agent' },
+        from: @user_id
       )
       
       message.publish
@@ -228,7 +229,8 @@ class HumanChatAgent
       user_id: @user_id,
       command: command,
       parameters: parameters,
-      timestamp: Time.now.iso8601
+      timestamp: Time.now.iso8601,
+      from: @user_id
     )
     
     bot_command.publish
@@ -259,7 +261,8 @@ class HumanChatAgent
       notification_type: notification_type,
       content: content,
       timestamp: Time.now.iso8601,
-      metadata: { triggered_by: @user_id }
+      metadata: { triggered_by: @user_id },
+      from: @user_id
     )
     
     notification.publish
@@ -444,7 +447,8 @@ class BotAgent
       message_type: 'bot',
       timestamp: Time.now.iso8601,
       mentions: [],
-      metadata: { bot_type: 'service_bot' }
+      metadata: { bot_type: 'service_bot' },
+      from: @bot_id
     )
     
     message.publish
@@ -480,7 +484,8 @@ class RoomManager
       notification_type: 'room_created',
       content: "Room '#{name}' was created",
       timestamp: Time.now.iso8601,
-      metadata: { description: description }
+      metadata: { description: description },
+      from: 'RoomManager'
     )
     
     notification.publish

data/examples/04_redis_smart_home_iot.rb

@@ -234,7 +234,7 @@ class SmartThermostat
         @battery_level -= 0.1 if rand < 0.1   # Occasional battery drain
         
         # Publish sensor data
-        SensorDataMessage.new(
+        sensor_msg = SensorDataMessage.new(
           device_id: @device_id,
           device_type: 'thermostat',
           location: @location,
@@ -242,8 +242,11 @@ class SmartThermostat
           value: @current_temp.round(1),
           unit: 'celsius',
           timestamp: Time.now.iso8601,
-          battery_level: @battery_level.round(1)
-        ).publish
+          battery_level: @battery_level.round(1),
+          from: @device_id
+        )
+        puts "🌡️  #{@device_id}: Publishing temperature #{@current_temp.round(1)}°C"
+        sensor_msg.publish
 
         # Check for alerts
         if @current_temp > 28.0
@@ -255,7 +258,8 @@ class SmartThermostat
             location: @location,
             message: "Temperature too high: #{@current_temp.round(1)}°C",
             timestamp: Time.now.iso8601,
-            requires_action: true
+            requires_action: true,
+            from: @device_id
           ).publish
         end
 
@@ -325,7 +329,8 @@ class SecurityCamera
             value: true,
             unit: 'boolean',
             timestamp: Time.now.iso8601,
-            battery_level: @battery_level.round(1)
+            battery_level: @battery_level.round(1),
+            from: @device_id
           ).publish
 
           # Send security alert
@@ -337,7 +342,8 @@ class SecurityCamera
             location: @location,
             message: "Motion detected in #{@location}",
             timestamp: Time.now.iso8601,
-            requires_action: false
+            requires_action: false,
+            from: @device_id
           ).publish
           
           # Auto-start recording
@@ -346,7 +352,8 @@ class SecurityCamera
             command: 'start_recording',
             parameters: { duration: 30 },
             requested_by: 'motion_detector',
-            timestamp: Time.now.iso8601
+            timestamp: Time.now.iso8601,
+            from: @device_id
           ).publish
           
         elsif !motion_detected && @motion_detected
@@ -361,7 +368,8 @@ class SecurityCamera
             value: false,
             unit: 'boolean',
             timestamp: Time.now.iso8601,
-            battery_level: @battery_level.round(1)
+            battery_level: @battery_level.round(1),
+            from: @device_id
           ).publish
         end
 
@@ -424,7 +432,8 @@ class SmartDoorLock
           value: @locked ? 'locked' : 'unlocked',
           unit: 'string',
           timestamp: Time.now.iso8601,
-          battery_level: @battery_level.round(1)
+          battery_level: @battery_level.round(1),
+          from: @device_id
         ).publish
 
         # Check for low battery
@@ -437,7 +446,8 @@ class SmartDoorLock
             location: @location,
             message: "Door lock battery low: #{@battery_level.round(1)}%",
             timestamp: Time.now.iso8601,
-            requires_action: true
+            requires_action: true,
+            from: @device_id
           ).publish
         end
 
@@ -528,7 +538,8 @@ class IoTDashboard
           summary_stats: {
             total_devices: @@devices.size,
             avg_battery: @@devices.values.map { |d| d[:battery_level] || 100 }.sum / [@@devices.size, 1].max
-          }
+          },
+          from: 'IoTDashboard'
         ).publish
       end
     end
@@ -592,13 +603,16 @@ class SmartHomeDemo
     puts "\n🎛️  Sending some manual commands..."
     sleep(2)
     
-    DeviceCommandMessage.new(
+    cmd_msg = DeviceCommandMessage.new(
       device_id: "THERM-001",
       command: "set_temperature",
       parameters: { target: 24.0 },
       requested_by: "mobile_app",
-      timestamp: Time.now.iso8601
-    ).publish
+      timestamp: Time.now.iso8601,
+      from: 'SmartHomeDemo'
+    )
+    puts "🎛️  Publishing command: set_temperature for THERM-001"
+    cmd_msg.publish
     
     sleep(3)
     
@@ -607,7 +621,8 @@ class SmartHomeDemo
       command: "start_recording",
       parameters: { duration: 60 },
       requested_by: "security_schedule",
-      timestamp: Time.now.iso8601
+      timestamp: Time.now.iso8601,
+      from: 'SmartHomeDemo'
     ).publish
     
     sleep(2)
@@ -617,7 +632,8 @@ class SmartHomeDemo
       command: "get_status",
       parameters: {},
       requested_by: "mobile_app",
-      timestamp: Time.now.iso8601
+      timestamp: Time.now.iso8601,
+      from: 'SmartHomeDemo'
     ).publish
     
     puts "\n⏳ Monitoring for 30 seconds (watch the Redis channels!)..."

data/examples/05_proc_handlers.rb

@@ -137,7 +137,7 @@ notifications = [
 notifications.each_with_index do |notification_data, index|
   puts "\n📤 Publishing notification #{index + 1}: #{notification_data[:title]}"
 
-  notification = NotificationMessage.new(**notification_data)
+  notification = NotificationMessage.new(**notification_data, from: 'ProcHandlerDemo')
   notification.publish
 
   # Give time for all handlers to process
@@ -161,7 +161,8 @@ error_notification = NotificationMessage.new(
   title: 'Another Error',
   message: 'This error won\'t trigger the block handler',
   user_id: 'test_user',
-  timestamp: Time.now.iso8601
+  timestamp: Time.now.iso8601,
+  from: 'ProcHandlerDemo'
 )
 
 error_notification.publish

data/examples/06_custom_logger_example.rb

@@ -470,7 +470,7 @@ class PriorityOrderService
   
   def process_priority_order(order_data)
     # Create message with instance-level logger override
-    message = OrderProcessingMessage.new(**order_data)
+    message = OrderProcessingMessage.new(**order_data, from: 'PriorityOrderService')
     
     # Override the logger at instance level
     message.logger(@priority_logger)
@@ -506,7 +506,8 @@ class LoggerDemo
     DefaultLoggerMessage.subscribe
     default_msg = DefaultLoggerMessage.new(
       message: "Testing the built-in default logger",
-      level: "info"
+      level: "info",
+      from: 'LoggerDemo'
     )
     default_msg.publish
     sleep(0.5)
@@ -518,7 +519,8 @@ class LoggerDemo
       customer_id: "CUST-123",
       amount: 99.99,
       status: "pending",
-      items: ["Widget A", "Widget B"]
+      items: ["Widget A", "Widget B"],
+      from: 'LoggerDemo'
     )
     order1.publish
     sleep(0.5)
@@ -529,7 +531,8 @@ class LoggerDemo
       recipient: "customer@example.com",
       subject: "Order Confirmation",
       body: "Your order has been received",
-      priority: "normal"
+      priority: "normal",
+      from: 'LoggerDemo'
     )
     notification.publish
     sleep(0.5)
@@ -542,7 +545,8 @@ class LoggerDemo
       customer_id: "VIP-456",
       amount: 299.99,
       status: "urgent",
-      items: ["Premium Widget", "Express Shipping"]
+      items: ["Premium Widget", "Express Shipping"],
+      from: 'PriorityOrderService'
     )
     sleep(0.5)
     
@@ -555,7 +559,8 @@ class LoggerDemo
     # Create and send a message - watch for the Ruby logger output
     msg = StandardLoggerMessage.new(
       content: "Testing with Ruby's standard logger",
-      level: "info"
+      level: "info",
+      from: 'LoggerDemo'
     )
     
     # The logger will output to STDOUT using Ruby's standard format
@@ -573,7 +578,8 @@ class LoggerDemo
         order_id: nil,  # This might cause issues
         customer_id: "ERROR-TEST",
         amount: "invalid_amount",
-        status: "error_demo"
+        status: "error_demo",
+        from: 'LoggerDemo'
       )
       
       # Simulate an error during processing

data/examples/07_error_handling_scenarios.rb

@@ -167,7 +167,8 @@ class ErrorDemonstrator
       missing_user_id = UserRegistrationMessage.new(
         email: "john@example.com",
         age: 25,
-        username: "johndoe"
+        username: "johndoe",
+        from: 'ErrorDemonstrator'
       )
       puts "❌ ERROR: Should have failed but didn't!"
     rescue => e
@@ -181,7 +182,8 @@ class ErrorDemonstrator
     begin
       missing_multiple = UserRegistrationMessage.new(
         user_id: "USER-123",
-        username: "johndoe"
+        username: "johndoe",
+        from: 'ErrorDemonstrator'
       )
       puts "❌ ERROR: Should have failed but didn't!"
     rescue => e
@@ -197,7 +199,8 @@ class ErrorDemonstrator
         user_id: "USER-123",
         email: "john@example.com", 
         age: 25,
-        username: "johndoe"
+        username: "johndoe",
+        from: 'ErrorDemonstrator'
       )
       puts "✅ Message created successfully"
       puts "   User: #{valid_user.username} (#{valid_user.email})"
@@ -227,7 +230,8 @@ class ErrorDemonstrator
         user_id: "USER-124",
         email: "not-an-email",  # Invalid format
         age: 25,
-        username: "janedoe"
+        username: "janedoe",
+        from: 'ErrorDemonstrator'
       )
       puts "   Message created, now validating..."
       invalid_email.validate!  # Explicitly trigger validation
@@ -245,7 +249,8 @@ class ErrorDemonstrator
         user_id: "USER-125",
         email: "kid@example.com",
         age: 10,  # Too young (< 13)
-        username: "kiduser"
+        username: "kiduser",
+        from: 'ErrorDemonstrator'
       )
       puts "   Message created, now validating..."
       invalid_age.validate!  # Explicitly trigger validation
@@ -263,7 +268,8 @@ class ErrorDemonstrator
         user_id: "USER-126",
         email: "user@example.com",
         age: 30,
-        username: "user@123!"  # Contains invalid characters
+        username: "user@123!",  # Contains invalid characters
+        from: 'ErrorDemonstrator'
       )
       puts "   Message created, now validating..."
       invalid_username.validate!  # Explicitly trigger validation
@@ -282,7 +288,8 @@ class ErrorDemonstrator
         email: "user@example.com",
         age: 30,
         username: "validuser",
-        subscription_type: "platinum"  # Not in allowed list
+        subscription_type: "platinum",  # Not in allowed list
+        from: 'ErrorDemonstrator'
       )
       puts "   Message created, now validating..."
       invalid_subscription.validate!  # Explicitly trigger validation
@@ -301,7 +308,8 @@ class ErrorDemonstrator
         email: "valid@example.com",
         age: 25,
         username: "validuser123",
-        subscription_type: "premium"
+        subscription_type: "premium",
+        from: 'ErrorDemonstrator'
       )
       puts "   Message created, now validating..."
       valid_user.validate!  # Explicitly trigger validation
@@ -339,7 +347,8 @@ class ErrorDemonstrator
         user_id: "USER-V1-001",
         email: "v1user@example.com",
         age: 28,
-        username: "v1user"
+        username: "v1user",
+        from: 'ErrorDemonstrator'
       )
       puts "✅ V1 Message created (version #{v1_message._sm_header.version})"
       v1_message.publish
@@ -356,7 +365,8 @@ class ErrorDemonstrator
         email: "v2user@example.com",
         age: 32,
         username: "v2user",
-        phone_number: "+1234567890"
+        phone_number: "+1234567890",
+        from: 'ErrorDemonstrator'
       )
       puts "✅ V2 Message created (version #{v2_message._sm_header.version})"
       v2_message.publish
@@ -374,7 +384,8 @@ class ErrorDemonstrator
         user_id: "USER-MISMATCH-001",
         email: "mismatch@example.com",
         age: 35,
-        username: "mismatchuser"
+        username: "mismatchuser",
+        from: 'ErrorDemonstrator'
       )
       
       puts "✅ Original message created with version #{version_mismatch_message._sm_header.version}"
@@ -396,8 +407,8 @@ class ErrorDemonstrator
 
     # Test Case 4: Show version information
     puts "📊 Test Case 3D: Version information display"
-    v1_msg = UserRegistrationMessage.new(user_id: "INFO-V1", email: "info@example.com", age: 25, username: "infouser")
-    v2_msg = UserRegistrationMessageV2.new(user_id: "INFO-V2", email: "info@example.com", age: 25, username: "infouser", phone_number: "+1234567890")
+    v1_msg = UserRegistrationMessage.new(user_id: "INFO-V1", email: "info@example.com", age: 25, username: "infouser", from: 'ErrorDemonstrator')
+    v2_msg = UserRegistrationMessageV2.new(user_id: "INFO-V2", email: "info@example.com", age: 25, username: "infouser", phone_number: "+1234567890", from: 'ErrorDemonstrator')
     
     puts "📋 Version Information:"
     puts "   UserRegistrationMessage (V1):"
@@ -424,7 +435,7 @@ class ErrorDemonstrator
     puts "Expected: Ideally should report all missing fields"
     puts "Actual Hashie::Dash behavior:"
     begin
-      message = MultiRequiredMessage.new(optional_field: "present")
+      message = MultiRequiredMessage.new(optional_field: "present", from: 'ErrorDemonstrator')
       puts "❌ ERROR: Should have failed but didn't!"
     rescue => e
       puts "✅ Error caught: #{e.class.name}"
@@ -443,7 +454,7 @@ class ErrorDemonstrator
     test_data.each_with_index do |test_case, index|
       puts "   #{index + 1}. #{test_case[:name]}:"
       begin
-        message = MultiRequiredMessage.new(test_case[:data])
+        message = MultiRequiredMessage.new(test_case[:data].merge(from: 'ErrorDemonstrator'))
         puts "      ✅ Success: Message created"
       rescue => e
         field_name = e.message.match(/property '([^']+)'/)[1] rescue 'unknown'