ag-ui-protocol 0.1.0

data/lib/ag_ui_protocol/encoder/event_encoder.rb

@@ -0,0 +1,83 @@
+# typed: true
+# frozen_string_literal: true
+
+require "json"
+require "sorbet-runtime"
+
+module AgUiProtocol
+  # The Agent User Interaction Protocol uses a streaming approach to send events
+  # from agents to clients. The `EventEncoder` class provides the functionality to
+  # encode events into a format that can be sent over HTTP.
+  module Encoder
+    # Media type for AGUI events
+    AGUI_MEDIA_TYPE = "application/vnd.ag-ui.event+proto"
+
+    # The `EventEncoder` class is responsible for encoding `BaseEvent` objects into
+    # string representations that can be transmitted to clients.
+    #
+    # ```ruby
+    #
+    # require "ag_ui_protocol"
+    #
+    # encoder = AgUiProtocol::EventEncoder.new
+    #
+    # event = AgUiProtocol::Core::Events::TextMessageContentEvent.new(
+    #   message_id: "msg_123",
+    #   delta: "Hello, world!"
+    # )
+    #
+    # encoded = encoder.encode(event)
+    #
+    # ```
+    #
+    # ### Usage
+    #
+    # The `EventEncoder` is typically used in HTTP handlers to convert event objects
+    # into a stream of data. The current implementation encodes events as Server-Sent
+    # Events (SSE), which can be consumed by clients using the EventSource API.
+    #
+    # ### Implementation Details
+    #
+    # Internally, the encoder converts events to JSON and formats them as Server-Sent
+    # Events with the following structure:
+    #
+    # ```
+    # data: {json-serialized event}\n\n
+    # ```
+    #
+    # This format allows clients to receive a continuous stream of events and process
+    # them as they arrive.
+    #
+    class EventEncoder
+      extend T::Sig
+
+      # Creates a new encoder instance.
+      #
+      # @param accept [String, nil] Media type of the request
+      # @return [void]
+      sig { params(accept: T.nilable(String)).void }
+      def initialize(accept: nil)
+        @accept = accept
+      end
+
+      # Returns the content type of the encoder.
+      #
+      # @return [String] The content type of the encoder
+      sig { returns(String) }
+      def content_type
+        @accept || "text/event-stream"
+      end
+
+      # Encodes an event into a string representation.
+      #
+      # @param event [Object] The event to encode
+      # @return [String] A string representation of the event in SSE format.
+      sig { params(event: AgUiProtocol::Core::Types::Model).returns(String) }
+      def encode(event)
+        payload = event.as_json
+
+        "data: #{JSON.generate(payload)}\n\n"
+      end
+    end
+  end
+end

data/lib/ag_ui_protocol/util.rb

@@ -0,0 +1,76 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "json"
+
+module AgUiProtocol
+  # Utility methods for encoding events.
+  module Util
+    extend T::Sig
+    module_function
+
+    # @param value [Object]
+    # @return [Object]
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def normalize_value(value)
+      if value.is_a?(AgUiProtocol::Core::Types::Model)
+        value.to_h
+      else
+        value
+      end
+    end
+
+    # @param key [Object]
+    # @return [String]
+    sig { params(key: T.untyped).returns(String) }
+    def camelize_key(key)
+      str = key.to_s
+      parts = str.split("_")
+      return str if parts.length <= 1
+
+      parts[0] + parts[1..].map { |p| p.empty? ? "" : (p[0].upcase + p[1..]) }.join
+    end
+
+    # @param value [Object]
+    # @return [Object]
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def deep_compact(value)
+      value = normalize_value(value)
+      case value
+      when Hash
+        value.transform_values { |v| deep_compact(v) unless v.nil? }.tap(&:compact!)
+      when Array
+        tmp1 = value.map { |v| deep_compact(v) }
+        tmp1.reject!(&:nil?)
+        tmp1
+      else
+        value
+      end
+    end
+
+    # @param value [Object]
+    # @return [Object]
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def deep_transform_keys_to_camel(value)
+      value = normalize_value(value)
+      case value
+      when Hash
+        value.each_with_object({}) do |(k, v), acc|
+          acc[camelize_key(k)] = deep_transform_keys_to_camel(v)
+        end
+      when Array
+        value.map { |v| deep_transform_keys_to_camel(v) }
+      else
+        value
+      end
+    end
+
+    # @param value [Object]
+    # @return [String]
+    sig { params(value: T.untyped).returns(String) }
+    def dump_json(value)
+      JSON.generate(value)
+    end
+  end
+end

data/lib/ag_ui_protocol/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AgUiProtocol
+  # The version of the protocol.
+  VERSION = "0.1.0"
+end

data/lib/ag_ui_protocol.rb

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require_relative "ag_ui_protocol/version"
+require_relative "ag_ui_protocol/util"
+require_relative "ag_ui_protocol/core/types"
+require_relative "ag_ui_protocol/core/events"
+require_relative "ag_ui_protocol/encoder/event_encoder"
+
+module AgUiProtocol
+  AGUI_MEDIA_TYPE = Encoder::AGUI_MEDIA_TYPE
+  EventEncoder = Encoder::EventEncoder
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: ag-ui-protocol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Buk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.12392
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.12392
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.12392
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.12392
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: Ruby SDK for AG-UI protocol - standardizing agent-user interactions through
+  event-based communication
+email:
+- contacto@buk.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ag_ui_protocol.rb
+- lib/ag_ui_protocol/core/events.rb
+- lib/ag_ui_protocol/core/types.rb
+- lib/ag_ui_protocol/encoder/event_encoder.rb
+- lib/ag_ui_protocol/util.rb
+- lib/ag_ui_protocol/version.rb
+homepage: https://docs.ag-ui.com/introduction
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/ag-ui-protocol/ag-ui
+  documentation_uri: https://github.com/ag-ui-protocol/ag-ui/tree/main/docs/sdk/ruby
+  changelog_uri: https://github.com/ag-ui-protocol/ag-ui/tree/main/sdks/community/ruby/CHANGELOG.md
+  homepage_uri: https://docs.ag-ui.com/introduction
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: Ruby SDK for AG-UI protocol
+test_files: []