bunny_farm 0.1.2

data/examples/images/task_scheduler.svg

@@ -0,0 +1,140 @@
+<svg width="800" height="550" xmlns="http://www.w3.org/2000/svg">
+  <!-- Background transparent -->
+  <rect width="800" height="550" fill="transparent"/>
+  
+  <!-- Title -->
+  <text x="400" y="30" text-anchor="middle" font-family="Arial, sans-serif" font-size="18" font-weight="bold" fill="#e0e0e0">
+    Task Scheduler with Retry Logic
+  </text>
+  
+  <!-- Scheduler (Producer) -->
+  <g>
+    <rect x="50" y="70" width="150" height="100" rx="10" fill="#2d3748" stroke="#9f7aea" stroke-width="2"/>
+    <text x="125" y="95" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#9f7aea">SCHEDULER</text>
+    <text x="125" y="115" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Creates tasks with</text>
+    <text x="125" y="130" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">scheduled times</text>
+    <text x="125" y="145" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">⏰ schedule_for</text>
+    <text x="125" y="160" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">🔄 retry_count: 0</text>
+  </g>
+  
+  <!-- Worker (Consumer) -->
+  <g>
+    <rect x="600" y="70" width="150" height="100" rx="10" fill="#2d3748" stroke="#ed8936" stroke-width="2"/>
+    <text x="675" y="95" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#ed8936">WORKER</text>
+    <text x="675" y="115" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Executes scheduled</text>
+    <text x="675" y="130" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">tasks at right time</text>
+    <text x="675" y="145" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">⚡ Execute actions</text>
+    <text x="675" y="160" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">🔄 Handle retries</text>
+  </g>
+  
+  <!-- Task Types -->
+  <g>
+    <rect x="250" y="70" width="300" height="100" rx="10" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="400" y="95" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#68d391">Task Types</text>
+    
+    <g>
+      <rect x="270" y="110" width="60" height="25" rx="3" fill="#4299e1" stroke="#4299e1" stroke-width="1"/>
+      <text x="300" y="125" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">📧 Email</text>
+      
+      <rect x="340" y="110" width="60" height="25" rx="3" fill="#68d391" stroke="#68d391" stroke-width="1"/>
+      <text x="370" y="125" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">💾 Backup</text>
+      
+      <rect x="410" y="110" width="60" height="25" rx="3" fill="#ed8936" stroke="#ed8936" stroke-width="1"/>
+      <text x="440" y="125" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">📊 Report</text>
+      
+      <rect x="480" y="110" width="60" height="25" rx="3" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+      <text x="510" y="125" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">🧹 Cleanup</text>
+    </g>
+    
+    <text x="400" y="155" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#9ca3af">Different task types with specific logic</text>
+  </g>
+  
+  <!-- Execution Flow -->
+  <g>
+    <text x="400" y="210" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#f6e05e">Execution Flow</text>
+    
+    <!-- Execute -->
+    <rect x="100" y="230" width="100" height="60" rx="8" fill="#2d3748" stroke="#68d391" stroke-width="2"/>
+    <text x="150" y="250" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#68d391">EXECUTE</text>
+    <text x="150" y="265" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Check timing</text>
+    <text x="150" y="280" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Run task logic</text>
+    
+    <!-- Success -->
+    <rect x="250" y="230" width="100" height="60" rx="8" fill="#2d3748" stroke="#68d391" stroke-width="2"/>
+    <text x="300" y="250" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#68d391">✅ SUCCESS</text>
+    <text x="300" y="265" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Task completed</text>
+    <text x="300" y="280" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Send notifications</text>
+    
+    <!-- Retry -->
+    <rect x="450" y="230" width="100" height="60" rx="8" fill="#2d3748" stroke="#f6e05e" stroke-width="2"/>
+    <text x="500" y="250" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#f6e05e">🔄 RETRY</text>
+    <text x="500" y="265" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Exponential</text>
+    <text x="500" y="280" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">backoff delay</text>
+    
+    <!-- Failure -->
+    <rect x="600" y="230" width="100" height="60" rx="8" fill="#2d3748" stroke="#e53e3e" stroke-width="2"/>
+    <text x="650" y="250" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#e53e3e">❌ FAILURE</text>
+    <text x="650" y="265" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Max retries</text>
+    <text x="650" y="280" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Send alerts</text>
+  </g>
+  
+  <!-- Flow Arrows -->
+  <defs>
+    <marker id="arrow-green-2" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+      <polygon points="0 0, 10 3.5, 0 7" fill="#68d391"/>
+    </marker>
+    <marker id="arrow-yellow" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+      <polygon points="0 0, 10 3.5, 0 7" fill="#f6e05e"/>
+    </marker>
+    <marker id="arrow-red" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+      <polygon points="0 0, 10 3.5, 0 7" fill="#e53e3e"/>
+    </marker>
+  </defs>
+  
+  <!-- Execute to Success -->
+  <line x1="200" y1="250" x2="250" y2="250" stroke="#68d391" stroke-width="2" marker-end="url(#arrow-green-2)"/>
+  <text x="225" y="245" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#68d391">success</text>
+  
+  <!-- Execute to Retry -->
+  <line x1="200" y1="270" x2="450" y2="270" stroke="#f6e05e" stroke-width="2" marker-end="url(#arrow-yellow)"/>
+  <text x="325" y="285" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#f6e05e">error (retry < 3)</text>
+  
+  <!-- Retry back to Execute -->
+  <path d="M 500 230 Q 400 190 150 230" stroke="#f6e05e" stroke-width="2" fill="none" marker-end="url(#arrow-yellow)"/>
+  <text x="350" y="205" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#f6e05e">retry after delay</text>
+  
+  <!-- Retry to Failure -->
+  <line x1="550" y1="260" x2="600" y2="260" stroke="#e53e3e" stroke-width="2" marker-end="url(#arrow-red)"/>
+  <text x="575" y="255" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e53e3e">max retries</text>
+  
+  <!-- Retry Logic Details -->
+  <g>
+    <rect x="50" y="330" width="700" height="120" rx="10" fill="#2d3748" stroke="#f6e05e" stroke-width="2"/>
+    <text x="400" y="355" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#f6e05e">Retry Logic with Exponential Backoff</text>
+    
+    <g>
+      <text x="70" y="380" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#68d391">Attempt 1:</text>
+      <text x="140" y="380" font-family="Arial, sans-serif" font-size="12" fill="#e0e0e0">Execute immediately → Fail → Wait 2¹ = 2 seconds</text>
+      
+      <text x="70" y="400" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#f6e05e">Attempt 2:</text>
+      <text x="140" y="400" font-family="Arial, sans-serif" font-size="12" fill="#e0e0e0">Execute after delay → Fail → Wait 2² = 4 seconds</text>
+      
+      <text x="70" y="420" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#ed8936">Attempt 3:</text>
+      <text x="140" y="420" font-family="Arial, sans-serif" font-size="12" fill="#e0e0e0">Execute after delay → Fail → Give up, send alert</text>
+    </g>
+  </g>
+  
+  <!-- Code Example -->
+  <g>
+    <rect x="50" y="470" width="700" height="70" rx="10" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="400" y="490" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#9ca3af">Task Definition Example</text>
+    
+    <text x="60" y="510" font-family="monospace" font-size="10" fill="#f6e05e">task_type:</text>
+    <text x="120" y="510" font-family="monospace" font-size="10" fill="#e0e0e0">"email_reminder"</text>
+    <text x="250" y="510" font-family="monospace" font-size="10" fill="#f6e05e">scheduled_for:</text>
+    <text x="340" y="510" font-family="monospace" font-size="10" fill="#e0e0e0">"2024-01-01 14:30:00"</text>
+    
+    <text x="60" y="525" font-family="monospace" font-size="10" fill="#f6e05e">payload:</text>
+    <text x="110" y="525" font-family="monospace" font-size="10" fill="#e0e0e0">{ recipient: "user@example.com", subject: "Meeting reminder" }</text>
+  </g>
+</svg>

data/examples/order_processor.rb

@@ -0,0 +1,238 @@
+#!/usr/bin/env ruby
+# Order processing example with multiple actions and error handling
+
+require 'bundler/setup'
+require 'bunny_farm'
+require 'json'
+
+# Example of a more complex message class for order processing
+class OrderMessage < BunnyFarm::Message
+  # Define fields including nested structures
+  fields :order_id, :total_amount, :status,
+         { customer: [:name, :email, :phone] },
+         { items: [:product_id, :quantity, :price] },
+         :created_at
+  
+  # Define multiple actions for different stages of order processing
+  actions :validate, :process_payment, :ship, :cancel
+  
+  def validate(*args)
+    puts "\n📋 Validating order ##{@items[:order_id]}"
+    
+    # Check required fields
+    if @items[:customer][:email].nil? || @items[:customer][:email].empty?
+      failure("Customer email is required")
+      return
+    end
+    
+    if @items[:total_amount].to_f <= 0
+      failure("Invalid order amount: #{@items[:total_amount]}")
+      return
+    end
+    
+    # Simulate validation
+    sleep 0.5
+    
+    puts "   ✅ Order validation passed"
+    puts "   Customer: #{@items[:customer][:name]} (#{@items[:customer][:email]})"
+    puts "   Amount: $#{'%.2f' % @items[:total_amount]}"
+    
+    # Update status
+    @items[:status] = 'validated'
+    
+    # Publish next step
+    publish('process_payment')
+    
+    success!
+  end
+  
+  def process_payment(*args)
+    puts "\n💳 Processing payment for order ##{@items[:order_id]}"
+    
+    # Simulate payment processing
+    sleep 1
+    
+    # Randomly simulate payment success/failure for demo
+    if rand > 0.2  # 80% success rate
+      puts "   ✅ Payment successful: $#{'%.2f' % @items[:total_amount]}"
+      @items[:status] = 'paid'
+      
+      # Publish next step
+      publish('ship')
+      success!
+    else
+      puts "   ❌ Payment failed - insufficient funds"
+      @items[:status] = 'payment_failed'
+      
+      # Publish cancellation
+      publish('cancel')
+      failure("Payment processing failed")
+    end
+  end
+  
+  def ship(*args)
+    puts "\n📦 Shipping order ##{@items[:order_id]}"
+    puts "   To: #{@items[:customer][:name]}"
+    puts "   Email: #{@items[:customer][:email]}"
+    
+    # Simulate shipping process
+    sleep 0.5
+    
+    tracking_number = "TRK#{rand(100000..999999)}"
+    puts "   🚚 Tracking number: #{tracking_number}"
+    
+    @items[:status] = 'shipped'
+    @items[:tracking_number] = tracking_number
+    
+    # Send notification email (simulated)
+    send_notification('shipped')
+    
+    success!
+  end
+  
+  def cancel(*args)
+    puts "\n❌ Cancelling order ##{@items[:order_id]}"
+    puts "   Reason: #{@errors.last if @errors}"
+    
+    @items[:status] = 'cancelled'
+    
+    # Send cancellation email (simulated)
+    send_notification('cancelled')
+    
+    success!  # Even cancellation is handled successfully
+  end
+  
+  private
+  
+  def send_notification(type)
+    puts "   📧 Sending #{type} notification to #{@items[:customer][:email]}"
+  end
+end
+
+# Producer/Consumer combo for demonstration
+if __FILE__ == $0
+  require 'optparse'
+  
+  mode = nil
+  OptionParser.new do |opts|
+    opts.banner = "Usage: #{$0} [options]"
+    opts.on("-p", "--producer", "Run as producer") { mode = :producer }
+    opts.on("-c", "--consumer", "Run as consumer") { mode = :consumer }
+    opts.on("-h", "--help", "Show this help") do
+      puts opts
+      exit
+    end
+  end.parse!
+  
+  if mode.nil?
+    puts "Please specify --producer or --consumer mode"
+    exit 1
+  end
+  
+  # Configure BunnyFarm
+  BunnyFarm.config do
+    env 'development'
+    app_id mode == :producer ? 'order_producer' : 'order_consumer'
+    
+    if mode == :consumer
+      # Configure to receive all OrderMessage actions
+      bunny Hashie::Mash.new(
+        YAML.load(
+          ERB.new(
+            File.read(
+              File.join(BunnyFarm::CONFIG.config_dir, BunnyFarm::CONFIG.bunny_file)
+            )
+          ).result, aliases: true
+        )[BunnyFarm::CONFIG.env].merge(
+          'routing_key' => 'OrderMessage.*'
+        )
+      )
+    end
+  end
+  
+  if mode == :producer
+    puts "Order Processing Producer"
+    puts "=" * 40
+    
+    # Create sample orders
+    orders = [
+      {
+        order_id: "ORD-#{rand(1000..9999)}",
+        total_amount: 99.99,
+        status: 'new',
+        customer: {
+          name: 'John Doe',
+          email: 'john@example.com',
+          phone: '+1-555-0123'
+        },
+        items: [
+          { product_id: 'PROD-001', quantity: 2, price: 49.99 }
+        ],
+        created_at: Time.now.to_s
+      },
+      {
+        order_id: "ORD-#{rand(1000..9999)}",
+        total_amount: 149.50,
+        status: 'new',
+        customer: {
+          name: 'Jane Smith',
+          email: 'jane@example.com',
+          phone: '+1-555-0124'
+        },
+        items: [
+          { product_id: 'PROD-002', quantity: 1, price: 149.50 }
+        ],
+        created_at: Time.now.to_s
+      },
+      {
+        order_id: "ORD-#{rand(1000..9999)}",
+        total_amount: 0,  # This will fail validation
+        status: 'new',
+        customer: {
+          name: 'Bad Order',
+          email: '',  # This will also fail
+          phone: ''
+        },
+        items: [],
+        created_at: Time.now.to_s
+      }
+    ]
+    
+    orders.each do |order_data|
+      msg = OrderMessage.new
+      
+      # Populate message fields
+      order_data.each do |key, value|
+        msg[key] = value
+      end
+      
+      # Start the order processing workflow
+      if msg.publish('validate')
+        puts "✅ Sent order #{order_data[:order_id]} for validation"
+      else
+        puts "❌ Failed to send order: #{msg.errors.join(', ')}"
+      end
+      
+      sleep 1
+    end
+    
+    puts "\n📬 All orders sent for processing!"
+    
+  else  # consumer mode
+    puts "Order Processing Consumer"
+    puts "=" * 40
+    puts "Waiting for order messages..."
+    puts "Press Ctrl+C to exit"
+    
+    begin
+      BunnyFarm.manage(false)
+    rescue Interrupt
+      puts "\n\nShutting down order processor..."
+    end
+  end
+  
+  # Clean up
+  if BunnyFarm::CONFIG.connection && BunnyFarm::CONFIG.connection.open?
+    BunnyFarm::CONFIG.connection.close
+  end
+end

data/examples/producer.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# Producer example - sends messages to RabbitMQ
+
+require 'bundler/setup'
+require 'bunny_farm'
+require_relative 'simple_message'
+
+# Configure BunnyFarm
+BunnyFarm.config do
+  env 'development'
+  app_id 'greeting_producer'
+end
+
+puts "BunnyFarm Producer Example"
+puts "=" * 40
+puts "Sending messages to RabbitMQ..."
+puts "Queue: #{BunnyFarm::CONFIG.bunny.queue_name}"
+puts "Exchange: #{BunnyFarm::CONFIG.bunny.exchange_name}"
+puts "=" * 40
+
+# Create and send hello messages
+3.times do |i|
+  msg = GreetingMessage.new
+  msg[:name] = "User #{i + 1}"
+  msg[:greeting_type] = 'hello'
+  msg[:timestamp] = Time.now.to_s
+  
+  if msg.publish('say_hello')
+    puts "✅ Sent hello message for User #{i + 1}"
+  else
+    puts "❌ Failed to send hello message: #{msg.errors.join(', ')}"
+  end
+  
+  sleep 0.5
+end
+
+# Create and send goodbye messages
+2.times do |i|
+  msg = GreetingMessage.new
+  msg[:name] = "Guest #{i + 1}"
+  msg[:greeting_type] = 'goodbye'
+  msg[:timestamp] = Time.now.to_s
+  
+  if msg.publish('say_goodbye')
+    puts "✅ Sent goodbye message for Guest #{i + 1}"
+  else
+    puts "❌ Failed to send goodbye message: #{msg.errors.join(', ')}"
+  end
+  
+  sleep 0.5
+end
+
+puts "\n📬 All messages sent!"
+puts "Run consumer.rb in another terminal to process them."
+
+# Clean up
+if BunnyFarm::CONFIG.connection && BunnyFarm::CONFIG.connection.open?
+  BunnyFarm::CONFIG.connection.close
+  puts "Connection closed."
+end

data/examples/simple_message.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# Simple message class example
+
+require 'bundler/setup'
+require 'bunny_farm'
+
+# Define a simple message class for processing greetings
+class GreetingMessage < BunnyFarm::Message
+  # Define the fields this message expects
+  fields :name, :greeting_type, :timestamp
+  
+  # Define the actions this message can handle
+  actions :say_hello, :say_goodbye
+  
+  def say_hello(*args)
+    puts "👋 Hello, #{@items[:name]}!"
+    puts "Received at: #{@items[:timestamp]}"
+    
+    # Simulate some processing
+    sleep 0.5
+    
+    # Mark as successful
+    success!
+  end
+  
+  def say_goodbye(*args)
+    puts "👋 Goodbye, #{@items[:name]}!"
+    puts "Until next time at: #{@items[:timestamp]}"
+    
+    # Simulate some processing
+    sleep 0.5
+    
+    # Mark as successful
+    success!
+  end
+end
+
+if __FILE__ == $0
+  puts "Simple Message Class Example"
+  puts "=" * 40
+  puts "This file defines the GreetingMessage class."
+  puts "Use producer.rb to send messages and consumer.rb to process them."
+end