agent99 0.0.1 → 0.0.3

data/lib/agent99/base.rb

@@ -36,14 +36,6 @@ class Agent99::Base
   include Agent99::MessageProcessing
 
   MESSAGE_TYPES = %w[request response control]
-  
-  CONTROL_HANDLERS = {
-    'shutdown' => :handle_shutdown,
-    'pause' => :handle_pause,
-    'resume' => :handle_resume,
-    'update_config' => :handle_update_config,
-    'status' => :handle_status_request
-  }
 
   attr_reader :id, :capabilities, :name, :payload, :header, :logger, :queue
   attr_accessor :registry_client, :message_client
@@ -56,6 +48,12 @@ class Agent99::Base
     logger.error "#{message}: #{error.message}"
     logger.debug error.backtrace.join("\n")
   end
+
+
+  # the final rescue block
+  rescue StandardError => e
+    handle_error("Unhandled error in Agent99::Base", e)
+    exit(2)
 end
 
 

data/lib/agent99/control_actions.rb

@@ -1,56 +1,89 @@
 # lib/agent99/control_actions.rb
 
 
-module Agent99::ControlActions
-
-
-  ################################################
-  private
-  
-  # Handles the shutdown control message.
-  #
-  def handle_shutdown
-    logger.info "Received shutdown command. Initiating graceful shutdown..."
-    send_control_response("Shutting down")
-    fini
-    exit(0)
-  end
+module Agent99
+  CONTROL_HANDLERS = {
+    'shutdown'      => :handle_shutdown,
+    'pause'         => :handle_pause,
+    'resume'        => :handle_resume,
+    'update_config' => :handle_update_config,
+    'status'        => :handle_status_request,
+    'response'      => :handle_control_response,
+  }
 
-  # Handles the pause control message.
-  #
-  def handle_pause
-    @paused = true
-    logger.info "Agent paused"
-    send_control_response("Paused")
-  end
+  module ControlActions
 
-  # Handles the resume control message.
-  #
-  def handle_resume
-    @paused = false
-    logger.info "Agent resumed"
-    send_control_response("Resumed")
-  end
 
-  # Handles the update_config control message.
-  #
-  def handle_update_config
-    new_config = payload[:config]
-    @config = new_config
-    logger.info "Configuration updated: #{@config}"
-    send_control_response("Configuration updated")
-  end
+    ################################################
+    private
+    
+    def handle_control_response
+      logger.info "Received control response: #{payload}"
+      response_type = payload.dig(:data, :type)
+      response_data = payload[:data]
+
+      case response_type
+      when 'status'
+        logger.info "Status update from agent: #{response_data}"
+      when 'error'
+        logger.error "Error from agent: #{response_data[:error]}"
+      else
+        logger.info "Generic control response: #{payload[:message]}"
+      end
+    end
+
+
+    # Handles the shutdown control message.
+    #
+    def handle_shutdown
+      logger.info "Received shutdown command. Initiating graceful shutdown..."
+      send_control_response("Shutting down")
+      fini
+      exit(0)
+    end
+
 
-  # Handles the status request control message.
-  #
-  def handle_status_request
-    status = {
-      id: @id,
-      name: @name,
-      paused: @paused,
-      config: @config,
-      uptime: (Time.now - @start_time).to_i
-    }
-    send_control_response("Status", status)
+    # Handles the pause control message.
+    #
+    def handle_pause
+      @paused = true
+      logger.info "Agent paused"
+      send_control_response("Paused")
+    end
+
+
+    # Handles the resume control message.
+    #
+    def handle_resume
+      @paused = false
+      logger.info "Agent resumed"
+      send_control_response("Resumed")
+    end
+
+
+    # Handles the update_config control message.
+    #
+    def handle_update_config
+      new_config = payload[:config]
+      @config = new_config
+      logger.info "Configuration updated: #{@config}"
+      send_control_response("Configuration updated")
+    end
+
+
+    # Handles the status request control message.
+    #
+    def handle_status_request
+      status = {
+        type: 'status',
+        id: @id,
+        name: @name,
+        paused: @paused,
+        config: @config,
+        uptime: (Time.now - @start_time).to_i
+      }
+      send_control_response(status)
+    end
   end
 end
+

data/lib/agent99/header_management.rb

@@ -4,7 +4,7 @@ module Agent99::HeaderManagement
 
 
   ################################################
-  private
+  # private
   
   def header      = @payload[:header]
   def to_uuid     = header[:to_uuid]
@@ -14,9 +14,11 @@ module Agent99::HeaderManagement
   def type        = header[:type]
 
   def return_address
-    header.merge(
-      to_uuid:    from_uuid,
-      from_uuid:  to_uuid,
+    return_address = payload[:header].dup
+
+    return_address.merge(
+      to_uuid:    return_address[:from_uuid],
+      from_uuid:  return_address[:to_uuid],
       timestamp:  Agent99::Timestamp.new.to_i,
       type:       'response'
     )

data/lib/agent99/header_schema.rb

@@ -13,3 +13,8 @@ class Agent99::HeaderSchema < SimpleJsonSchemaBuilder::Base
     integer :timestamp,   required: true, examples: [Agent99::Timestamp.new.to_i]
   end
 end
+
+__END__
+
+    string :type, required: true, enum: %w[request response control]
+

data/lib/agent99/message_processing.rb

@@ -16,14 +16,15 @@ module Agent99::MessageProcessing
   #
   def dispatcher
     @start_time = Time.now
-    @paused = false
-    @config = {}
+    @paused     = false
+    @config     = {}
+
 
     message_client.listen_for_messages(
       queue,
-      request_handler: ->(message) { process_request(message) unless paused? },
+      request_handler:  ->(message) { process_request(message) unless paused? },
       response_handler: ->(message) { process_response(message) unless paused? },
-      control_handler: ->(message) { process_control(message) }
+      control_handler:  ->(message) { process_control(message) }
     )
   end
 
@@ -33,8 +34,8 @@ module Agent99::MessageProcessing
   # @param message [Hash] The incoming message
   #
   def process_request(message)
-    @payload = message
-    @header = payload[:header]
+    @payload  = message
+    @header   = payload[:header]
     return unless validate_schema.empty?
     receive_request
   end
@@ -54,11 +55,14 @@ module Agent99::MessageProcessing
   #
   def process_control(message)
     @payload = message
-    receive_control
+    if payload[:action] == 'response'
+      receive_response
+    else
+      receive_control
+    end
   end
 
 
-
   # Handles incoming request messages (to be overridden by subclasses).
   #
   def receive_request
@@ -78,8 +82,9 @@ module Agent99::MessageProcessing
   # @raise [StandardError] If there's an error processing the control message
   #
   def receive_control
-    action = payload[:action]
-    handler = CONTROL_HANDLERS[action]
+
+    action  = payload[:action]
+    handler = Agent99::CONTROL_HANDLERS[action]
     
     if handler
       send(handler)
@@ -89,7 +94,7 @@ module Agent99::MessageProcessing
   
   rescue StandardError => e
     logger.error "Error processing control message: #{e.message}"
-    send_control_response("Error", { error: e.message })
+    send_control_response({ error: e.message })
   end
 
 
@@ -108,15 +113,16 @@ module Agent99::MessageProcessing
   # @param message [String] The response message
   # @param data [Hash, nil] Additional data to include in the response
   #
-  def send_control_response(message, data = nil)
+  def send_control_response(data)
     response = {
       header: return_address.merge(type: 'control'),
-      message: message,
+      action: 'response',
       data: data
     }
     @message_client.publish(response)
   end
 
+
   # Validates the incoming message against the defined schema.
   #
   # @return [Array] An array of validation errors, empty if validation succeeds
@@ -135,6 +141,7 @@ module Agent99::MessageProcessing
     e.messages
   end
 
+
   # Retrieves a field from the payload or returns a default value.
   #
   # @param field [Symbol] The field to retrieve
@@ -144,6 +151,7 @@ module Agent99::MessageProcessing
     payload[field] || default(field)
   end
 
+
   # Returns the default value for a field from the schema.
   #
   # @param field [Symbol] The field to get the default for

data/lib/agent99/registry_client.rb

@@ -35,6 +35,12 @@ class Agent99::RegistryClient
     send_request(request)
   end
 
+
+  def fetch_all_agents
+    request = create_request(:get, "/")
+    response = send_request(request)
+  end
+
   ################################################
   private
 
@@ -48,9 +54,11 @@ class Agent99::RegistryClient
     response = @http_client.request(request)
 
     handle_response(response)
+  
   rescue JSON::ParserError => e
     logger.error "JSON parsing error: #{e.message}"
     nil
+  
   rescue StandardError => e
     logger.error "Request error: #{e.message}"
     nil

data/lib/agent99/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Agent99
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 
   def self.version  = VERSION
 end

data/lib/agent99.rb

@@ -3,6 +3,10 @@
 require 'debug_me'
 include DebugMe
 
+require 'json'
+require 'json_schema'
+require 'securerandom'
+
 module Agent99; end  # Establish a namespace
 
 require_relative 'agent99/base'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: agent99
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ai_client
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: nats-pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nats-pure
+  name: simple_json_schema_builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_json_schema_builder
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,13 +152,43 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- docs/todo.md
+- docs/README.md
+- docs/advanced_features.md
+- docs/agent_discovery.md
+- docs/agent_lifecycle.md
+- docs/agent_registry_processes.md
+- docs/api_reference.md
+- docs/architecture.md
+- docs/configuration.md
+- docs/control_actions.md
+- docs/custom_agent_implementation.md
+- docs/diagrams/agent_registry_processes.dot
+- docs/diagrams/agent_registry_processes.png
+- docs/diagrams/high_level_architecture.dot
+- docs/diagrams/high_level_architecture.png
+- docs/diagrams/request_flow.dot
+- docs/diagrams/request_flow.png
+- docs/error_handling_and_logging.md
+- docs/extending_the_framework.md
+- docs/message_processing.md
+- docs/messaging_system.md
+- docs/preformance_considerations.md
+- docs/schema_definition.md
+- docs/security.md
+- docs/troubleshooting.md
 - examples/README.md
-- examples/hello_world.rb
-- examples/hello_world_client.rb
-- examples/hello_world_request.rb
+- examples/agent_watcher.rb
+- examples/agents/.keep
+- examples/chief_agent.rb
+- examples/control.rb
+- examples/diagram.dot
+- examples/diagram.png
+- examples/example_agent.rb
+- examples/kaos_spy.rb
+- examples/maxwell_agent86.rb
+- examples/maxwell_request.rb
 - examples/registry.rb
-- examples/start_agents.sh
+- examples/start_rabbitmq_and_registry.sh
 - lib/agent99.rb
 - lib/agent99/.irbrc
 - lib/agent99/agent_discovery.rb

data/docs/todo.md

@@ -1,66 +0,0 @@
-# Documentation
-
-TODO: Lets get some more detailed documentation underway that can be linked to from the main README.md file.
-
-Here are some key areas that should be covered in comprehensive documentation files:
-
-1. Architecture Overview:
-   - Explain the overall structure of the AiAgent framework
-   - Describe the roles of different components (Base, MessageClient, RegistryClient, etc.)
-   - Illustrate how agents communicate and interact within the system
-
-2. Agent Lifecycle:
-   - Detail the process of creating, initializing, running, and shutting down an agent
-   - Explain the registration and withdrawal process with the registry service
-
-3. Message Processing:
-   - Describe the different types of messages (request, response, control)
-   - Explain how messages are routed and processed
-   - Detail the schema validation process for incoming messages
-
-4. Agent Discovery:
-   - Explain how agents can discover other agents based on capabilities
-   - Describe the process of querying the registry for available agents
-
-5. Control Actions:
-   - List and explain all available control actions (shutdown, pause, resume, etc.)
-   - Describe how to implement custom control actions
-
-6. Configuration:
-   - Detail all configuration options available for agents
-   - Explain how to use environment variables for configuration
-
-7. Error Handling and Logging:
-   - Describe the error handling mechanisms in place
-   - Explain how to configure and use the logging system effectively
-
-8. Messaging Systems:
-   - Provide details on both AMQP and NATS messaging systems
-   - Explain how to switch between different messaging backends
-
-9. Custom Agent Implementation:
-   - Provide a step-by-step guide on creating a custom agent
-   - Explain how to define capabilities, handle requests, and send responses
-
-10. Schema Definition:
-    - Explain how to define and use request and response schemas
-    - Provide examples of complex schema definitions
-
-11. Performance Considerations:
-    - Discuss any performance optimizations in the framework
-    - Provide guidelines for writing efficient agents
-
-12. Security:
-    - Explain any security measures in place (if any)
-    - Provide best practices for securing agent communications
-
-13. Extending the Framework:
-    - Describe how to add new features or modify existing functionality
-    - Explain the plugin system (if one exists)
-
-14. Troubleshooting:
-    - Provide a list of common issues and their solutions
-    - Explain how to debug agents effectively
-
-15. API Reference:
-    - Provide a comprehensive API reference for all public methods and classes

data/examples/hello_world_client.rb

@@ -1,70 +0,0 @@
-#!/usr/bin/env ruby
-# examples/hello_world_client.rb
-
-require 'json'
-require 'json_schema'
-require 'securerandom'
-require_relative '../lib/agent99'
-
-class HelloWorldClient < Agent99::Base
-  def init
-    send_request
-  end
-
-  def send_request
-    to_uuid = discover_agent(capability: 'greeter', how_many: 1).first[:uuid]
-
-    request = build_request(
-                to_uuid:,
-                greeting: 'Hey',
-                name:     'MadBomber'
-              )
-
-    result = @message_client.publish(request)
-    logger.info "Sent request: #{request.inspect}; status? #{result.inspect}"
-  end
-
-  def build_request(
-                to_uuid:,
-                greeting: 'Hello',
-                name:     'World'
-              )
-
-    {
-      header: {
-        type:       'request',
-        from_uuid:  @id,
-        to_uuid:,
-        event_uuid: SecureRandom.uuid,
-        timestamp:  Agent99::Timestamp.new.to_i
-      },
-      greeting:,
-      name:
-    }
-  end
-
-
-  def receive_response
-    logger.info "Received response: #{payload.inspect}"
-    result = payload[:result]
-
-    puts
-    puts `echo "#{result}" | boxes -d info`
-    puts
-
-    exit(0)
-  end
-
-  #####################################################
-  private
-
-  def capabilities
-    ['hello_world_client']
-  end
-end
-
-
-# Example usage
-client = HelloWorldClient.new
-client.run
-

data/examples/start_agents.sh

@@ -1,20 +0,0 @@
-#!/bin/bash
-
-# Start the registry server
-echo "Starting registry server..."
-# Assuming the registry server is a separate process, replace with actual command
-# e.g., ruby registry_server.rb &
-# Replace 'registry_server_command' with the actual command to start your registry server
-# Example: ruby registry_server.rb &
-./registry.rb &
-
-# Start the HelloWorld agent
-echo "Starting HelloWorld agent..."
-./hello_world.rb &
-
-# Start the HelloWorldClient agent
-echo "Starting HelloWorldClient agent..."
-./hello_world_client.rb &
-
-# Wait for all background processes to finish
-wait