riffer 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a36bd54b70a03d93c4b955823477288bb7a52fc7f2be090dad466b8aa1ef5dd
-  data.tar.gz: 2d305b20b5f85dc3dfdb632624849cc83e9abc049739c703f03da1661fe342e8
+  metadata.gz: 12e6843cdf4824294d9c9470c2dad55125bfa490b49389530145bd334041ce15
+  data.tar.gz: 636133b4f5b2a046311a33a3b294ce2eb893bcb3a16292bd83198fc24f3dc500
 SHA512:
-  metadata.gz: 3d82cd6aff279eb94ff710c7c7d3462a81f17a97d93f19c6df9d93cc83749e0d30ac5e8956b4e802ac2e2097c5c816f315a8027be47ce98ed16e7382d1937437
-  data.tar.gz: e4d964bc0c1ad34c29639c8ba4a9b5b28a62376608d8b9b4e383127bf55d0948795a820f00f80ee3b71e2bbda61e78b5b6e6f4fc91534058f7069ad1fca3f025
+  metadata.gz: a26010e36c164851b3a9cbd6d3b7eebd9dcd935d4fdd405793998d2760b871b01a487724a8628eddc6bf366db164f924990ee12a2c93f99602e2c0f99c341d88
+  data.tar.gz: 18428555a37e27ee29c35d21c7b1f6f00f988a22e02e6a25141d6a3d6b9d0c49da43a7bf408886d28734e485fd7ac32015643ac7d1c9fe2406bffd6d9a6602d7

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.4.1"
+  ".": "0.5.0"
 }

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0](https://github.com/bottrall/riffer/compare/riffer/v0.4.2...riffer/v0.5.0) (2026-01-06)
+
+
+### Features
+
+* streaming via agents ([#63](https://github.com/bottrall/riffer/issues/63)) ([b4171c2](https://github.com/bottrall/riffer/commit/b4171c20f64a7ada1264ce90ab5278c19ff8a47a))
+
+## [0.4.2](https://github.com/bottrall/riffer/compare/riffer/v0.4.1...riffer/v0.4.2) (2025-12-29)
+
+
+### Bug Fixes
+
+* update README for clarity on provider usage and examples ([#60](https://github.com/bottrall/riffer/issues/60)) ([b12835c](https://github.com/bottrall/riffer/commit/b12835ce71c29e02074a0897551db50283ac8be6))
+
 ## [0.4.1](https://github.com/bottrall/riffer/compare/riffer/v0.4.0...riffer/v0.4.1) (2025-12-29)
 
 

data/README.md

@@ -17,7 +17,7 @@ Key concepts:
 ## Features
 
 - Minimal, well-documented core for building AI agents
-- Provider abstraction (OpenAI + test provider) for easy testing
+- Provider abstraction (OpenAI) for pluggable providers
 - Streaming support and structured stream events
 - Message converters and helpers for robust message handling
 
@@ -47,46 +47,33 @@ gem 'riffer', git: 'https://github.com/bottrall/riffer.git'
 
 ## Quick Start
 
-Basic usage with the built-in test provider:
+Basic usage with the OpenAI provider:
 
 ```ruby
 require 'riffer'
 
+# Configure OpenAI API key (recommended to use ENV)
+Riffer.configure do |config|
+  config.openai.api_key = ENV['OPENAI_API_KEY']
+end
+
 class EchoAgent < Riffer::Agent
   identifier 'echo'
-  model 'test/default' # provider/model
+  model 'openai/gpt-5-mini' # provider/model
   instructions 'You are an assistant that repeats what the user says.'
 end
 
 agent = EchoAgent.new
 puts agent.generate('Hello world')
-# => "Test response" (the test provider returns a canned response by default)
-```
-
-Using the test provider directly (useful for unit tests):
-
-```ruby
-provider = Riffer::Providers::Test.new
-provider.stub_response('Hello from test provider!')
-assistant = provider.generate_text(prompt: 'Say hi')
-puts assistant.content # => "Hello from test provider!"
-```
-
-Streaming example (provider-dependent):
-
-```ruby
-provider = Riffer::Providers::Test.new
-enum = provider.stream_text(prompt: 'Stream something')
-enum.each do |chunk|
-  puts chunk[:content]
-end
+# => "Hello world"
 ```
 
-Configuration example (OpenAI API key):
+Streaming example:
 
 ```ruby
-Riffer.configure do |config|
-  config.openai.api_key = ENV['OPENAI_API_KEY']
+agent = EchoAgent.new
+agent.stream('Tell me a story').each do |event|
+  print event.content
 end
 ```
 
@@ -136,7 +123,3 @@ Licensed under the MIT License. See `LICENSE.txt` for details.
 ## Maintainers
 
 - Jake Bottrall — https://github.com/bottrall
-
----
-
-If you'd like, I can add short usage examples to the documentation site or update the gemspec metadata (authors, homepage, summary).

data/lib/riffer/agent.rb

@@ -91,6 +91,31 @@ class Riffer::Agent
     extract_final_response
   end
 
+  # Streams a response from the agent
+  # @param prompt_or_messages [String, Array<Hash, Riffer::Messages::Base>]
+  # @return [Enumerator] an enumerator yielding stream events
+  def stream(prompt_or_messages)
+    initialize_messages(prompt_or_messages)
+
+    Enumerator.new do |yielder|
+      accumulated_content = ""
+
+      call_llm_stream.each do |event|
+        yielder << event
+
+        case event
+        when Riffer::StreamEvents::TextDelta
+          accumulated_content += event.content
+        when Riffer::StreamEvents::TextDone
+          accumulated_content = event.content
+        end
+      end
+
+      response = Riffer::Messages::Assistant.new(accumulated_content)
+      @messages << response
+    end
+  end
+
   private
 
   def initialize_messages(prompt_or_messages)
@@ -110,9 +135,13 @@ class Riffer::Agent
     provider_instance.generate_text(messages: @messages, model: @model_name)
   end
 
+  def call_llm_stream
+    provider_instance.stream_text(messages: @messages, model: @model_name)
+  end
+
   def provider_instance
     @provider_instance ||= begin
-      provider_class = Riffer::Providers::Base.find(@provider_name)
+      provider_class = Riffer::Providers::Repository.find(@provider_name)
       raise Riffer::ArgumentError, "Provider not found: #{@provider_name}" unless provider_class
       provider_class.new
     end

data/lib/riffer/providers/base.rb

@@ -4,32 +4,6 @@ class Riffer::Providers::Base
   include Riffer::Helpers::Dependencies
   include Riffer::Messages::Converter
 
-  class << self
-    def identifier(value = nil)
-      return @identifier if value.nil?
-
-      @identifier = value
-    end
-
-    # Finds a provider class by identifier
-    # @param identifier [String, Symbol] the identifier to search for
-    # @return [Class, nil] the provider class, or nil if not found
-    def find(identifier)
-      ensure_providers_loaded
-      subclasses.find { |provider_class| provider_class.identifier == identifier }
-    end
-
-    private
-
-    def ensure_providers_loaded
-      return if @providers_loaded
-
-      Zeitwerk::Loader.eager_load_namespace(Riffer::Providers)
-
-      @providers_loaded = true
-    end
-  end
-
   # Generates text using the provider.
   #
   # @param prompt [String, nil] the user prompt (required when `messages` is not provided)

data/lib/riffer/providers/open_ai.rb

@@ -3,8 +3,6 @@
 require "openai"
 
 class Riffer::Providers::OpenAI < Riffer::Providers::Base
-  identifier "openai"
-
   # Initializes the OpenAI provider.
   # @param options [Hash] optional client options. Use `:api_key` to override `Riffer.config.openai.api_key`.
   # @raise [Riffer::ArgumentError] if an API key is not provided either via `:api_key` or `Riffer.config.openai.api_key`.
@@ -78,19 +76,16 @@ class Riffer::Providers::OpenAI < Riffer::Providers::Base
   end
 
   def process_stream_events(stream, yielder)
-    stream.each do |event|
-      next unless should_process_event?(event)
+    stream.each do |raw_event|
+      event = convert_event(raw_event)
 
-      content = extract_event_content(event)
-      yielder << content if content
-    end
-  end
+      next unless event
 
-  def should_process_event?(event)
-    [:"response.output_text.delta", :"response.output_text.done"].include?(event.type)
+      yielder << event if event
+    end
   end
 
-  def extract_event_content(event)
+  def convert_event(event)
     case event.type
     when :"response.output_text.delta"
       Riffer::StreamEvents::TextDelta.new(event.delta)

data/lib/riffer/providers/repository.rb

@@ -0,0 +1,15 @@
+class Riffer::Providers::Repository
+  REPO = {
+    openai: -> { Riffer::Providers::OpenAI },
+    test: -> { Riffer::Providers::Test }
+  }.freeze
+
+  class << self
+    # Finds a provider class by identifier
+    # @param identifier [String, Symbol] the identifier to search for
+    # @return [Class, nil] the provider class, or nil if not found
+    def find(identifier)
+      REPO.fetch(identifier.to_sym, nil)&.call
+    end
+  end
+end

data/lib/riffer/providers/test.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 class Riffer::Providers::Test < Riffer::Providers::Base
-  identifier "test"
-
   attr_reader :calls
 
   def initialize(**options)
@@ -35,11 +33,14 @@ class Riffer::Providers::Test < Riffer::Providers::Base
     response = @stubbed_response || @responses[@current_index] || {role: "assistant", content: "Test response"}
     @current_index += 1
     Enumerator.new do |yielder|
-      content_parts = response[:content].split(". ").map { |part| part + (part.end_with?(".") ? "" : ".") }
+      full_content = response[:content]
+      content_parts = full_content.split(". ").map { |part| part + (part.end_with?(".") ? "" : ".") }
+
       content_parts.each do |part|
-        yielder << {role: "assistant", content: part + " "}
-        sleep 0.5
+        yielder << Riffer::StreamEvents::TextDelta.new(part + " ")
       end
+
+      yielder << Riffer::StreamEvents::TextDone.new(full_content)
     end
   end
 end

data/lib/riffer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riffer
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riffer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jake Bottrall
@@ -150,6 +150,7 @@ files:
 - lib/riffer/providers.rb
 - lib/riffer/providers/base.rb
 - lib/riffer/providers/open_ai.rb
+- lib/riffer/providers/repository.rb
 - lib/riffer/providers/test.rb
 - lib/riffer/stream_events.rb
 - lib/riffer/stream_events/base.rb