riffer 0.1.0 → 0.2.0

data/lib/riffer/providers/open_ai.rb

@@ -2,103 +2,100 @@
 
 require "openai"
 
-module Riffer::Providers
-  class OpenAI < Base
-    identifier "openai"
+class Riffer::Providers::OpenAI < Riffer::Providers::Base
+  identifier "openai"
 
-    def initialize(**options)
-      depends_on "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`.
+  def initialize(**options)
+    depends_on "openai"
 
-      api_key = options.fetch(:api_key, Riffer.config.openai.api_key)
-      raise ArgumentError, "OpenAI API key is required. Set it via Riffer.configure or pass :api_key option" if api_key.nil? || api_key.empty?
+    api_key = options.fetch(:api_key, Riffer.config.openai.api_key)
+    raise Riffer::ArgumentError, "OpenAI API key is required. Set it via Riffer.configure or pass :api_key option" if api_key.nil? || api_key.empty?
 
-      @client = ::OpenAI::Client.new(api_key: api_key, **options.except(:api_key))
-    end
-
-    private
+    @client = ::OpenAI::Client.new(api_key: api_key, **options.except(:api_key))
+  end
 
-    def perform_generate_text(messages, model:)
-      params = build_request_params(messages, model)
-      response = @client.responses.create(params)
+  private
 
-      output = response.output.find { |o| o.type == :message }
+  def perform_generate_text(messages, model:)
+    params = build_request_params(messages, model)
+    response = @client.responses.create(params)
 
-      if output.nil?
-        raise Riffer::Providers::Error, "No output returned from OpenAI API"
-      end
+    output = response.output.find { |o| o.type == :message }
 
-      content = output.content.find { |c| c.type == :output_text }
+    if output.nil?
+      raise Riffer::Error, "No output returned from OpenAI API"
+    end
 
-      if content.nil?
-        raise Riffer::Providers::Error, "No content returned from OpenAI API"
-      end
+    content = output.content.find { |c| c.type == :output_text }
 
-      if content.type == :refusal
-        raise Riffer::Providers::Error, "Request was refused: #{content.refusal}"
-      end
+    if content.nil?
+      raise Riffer::Error, "No content returned from OpenAI API"
+    end
 
-      if content.type != :output_text
-        raise Riffer::Providers::Error, "Unexpected content type: #{content.type}"
-      end
+    if content.type == :refusal
+      raise Riffer::Error, "Request was refused: #{content.refusal}"
+    end
 
-      Riffer::Messages::Assistant.new(content.text)
+    if content.type != :output_text
+      raise Riffer::Error, "Unexpected content type: #{content.type}"
     end
 
-    def perform_stream_text(messages, model:)
-      Enumerator.new do |yielder|
-        params = build_request_params(messages, model)
-        stream = @client.responses.stream(params)
+    Riffer::Messages::Assistant.new(content.text)
+  end
+
+  def perform_stream_text(messages, model:)
+    Enumerator.new do |yielder|
+      params = build_request_params(messages, model)
+      stream = @client.responses.stream(params)
 
-        process_stream_events(stream, yielder)
-      end
+      process_stream_events(stream, yielder)
     end
+  end
 
-    def build_request_params(messages, model)
-      {
-        model: model,
-        input: convert_message_to_openai_format(messages)
-      }
-    end
+  def build_request_params(messages, model)
+    {
+      model: model,
+      input: convert_message_to_openai_format(messages)
+    }
+  end
 
-    def convert_message_to_openai_format(messages)
-      messages.map do |message|
-        case message
-        when Riffer::Messages::System
-          {role: "developer", content: message.content}
-        when Riffer::Messages::User
-          {role: "user", content: message.content}
-        when Riffer::Messages::Assistant
-          {role: "assistant", content: message.content}
-        when Riffer::Messages::Tool
-          raise Riffer::Providers::InvalidInputError, "Tool messages are not supported by OpenAI provider yet"
-        when Hash
-          message
-        else
-          raise Riffer::Providers::InvalidInputError, "Unsupported message type: #{message.class}"
-        end
+  def convert_message_to_openai_format(messages)
+    messages.map do |message|
+      case message
+      when Riffer::Messages::System
+        {role: "developer", content: message.content}
+      when Riffer::Messages::User
+        {role: "user", content: message.content}
+      when Riffer::Messages::Assistant
+        {role: "assistant", content: message.content}
+      when Riffer::Messages::Tool
+        raise NotImplementedError, "Tool messages are not supported by OpenAI provider yet"
       end
     end
+  end
 
-    def process_stream_events(stream, yielder)
-      stream.each do |event|
-        next unless should_process_event?(event)
+  def process_stream_events(stream, yielder)
+    stream.each do |event|
+      next unless should_process_event?(event)
 
-        content = extract_event_content(event)
-        yielder << content if content
-      end
+      content = extract_event_content(event)
+      yielder << content if content
     end
+  end
 
-    def should_process_event?(event)
-      [:"response.output_text.delta", :"response.output_text.done"].include?(event.type)
-    end
+  def should_process_event?(event)
+    [:"response.output_text.delta", :"response.output_text.done"].include?(event.type)
+  end
 
-    def extract_event_content(event)
-      case event.type
-      when :"response.output_text.delta"
-        Riffer::StreamEvents::TextDelta.new(event.delta)
-      when :"response.output_text.done"
-        Riffer::StreamEvents::TextDone.new(event.text)
-      end
+  def extract_event_content(event)
+    case event.type
+    when :"response.output_text.delta"
+      Riffer::StreamEvents::TextDelta.new(event.delta)
+    when :"response.output_text.done"
+      Riffer::StreamEvents::TextDone.new(event.text)
     end
   end
 end

data/lib/riffer/providers/test.rb

@@ -1,46 +1,44 @@
 # frozen_string_literal: true
 
-module Riffer::Providers
-  class Test < Base
-    identifier "test"
+class Riffer::Providers::Test < Riffer::Providers::Base
+  identifier "test"
 
-    attr_reader :calls
+  attr_reader :calls
 
-    def initialize(**options)
-      @responses = options[:responses] || []
-      @current_index = 0
-      @calls = []
-      @stubbed_response = nil
-    end
+  def initialize(**options)
+    @responses = options[:responses] || []
+    @current_index = 0
+    @calls = []
+    @stubbed_response = nil
+  end
 
-    def stub_response(content, tool_calls: [])
-      @stubbed_response = {role: "assistant", content: content, tool_calls: tool_calls}
-    end
+  def stub_response(content, tool_calls: [])
+    @stubbed_response = {role: "assistant", content: content, tool_calls: tool_calls}
+  end
 
-    private
+  private
 
-    def perform_generate_text(messages, model: nil)
-      @calls << {messages: messages.map(&:to_h)}
-      response = @stubbed_response || @responses[@current_index] || {role: "assistant", content: "Test response"}
-      @current_index += 1
+  def perform_generate_text(messages, model: nil)
+    @calls << {messages: messages.map(&:to_h)}
+    response = @stubbed_response || @responses[@current_index] || {role: "assistant", content: "Test response"}
+    @current_index += 1
 
-      if response.is_a?(Hash)
-        Riffer::Messages::Assistant.new(response[:content], tool_calls: response[:tool_calls] || [])
-      else
-        response
-      end
+    if response.is_a?(Hash)
+      Riffer::Messages::Assistant.new(response[:content], tool_calls: response[:tool_calls] || [])
+    else
+      response
     end
+  end
 
-    def perform_stream_text(messages, model: nil)
-      @calls << {messages: messages.map(&:to_h)}
-      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?(".") ? "" : ".") }
-        content_parts.each do |part|
-          yielder << {role: "assistant", content: part + " "}
-          sleep 0.5
-        end
+  def perform_stream_text(messages, model: nil)
+    @calls << {messages: messages.map(&:to_h)}
+    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?(".") ? "" : ".") }
+      content_parts.each do |part|
+        yielder << {role: "assistant", content: part + " "}
+        sleep 0.5
       end
     end
   end

data/lib/riffer/providers.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 
 module Riffer::Providers
-  class Error < StandardError; end
-  class InvalidInputError < Error; end
 end

data/lib/riffer/stream_events/base.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-module Riffer::StreamEvents
-  class Base
-    attr_reader :role
+class Riffer::StreamEvents::Base
+  attr_reader :role
 
-    def initialize(role: "assistant")
-      @role = role
-    end
+  def initialize(role: "assistant")
+    @role = role
+  end
 
-    def to_h
-      raise NotImplementedError, "Subclasses must implement #to_h"
-    end
+  def to_h
+    raise NotImplementedError, "Subclasses must implement #to_h"
   end
 end

data/lib/riffer/stream_events/text_delta.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-module Riffer::StreamEvents
-  class TextDelta < Base
-    attr_reader :content
+class Riffer::StreamEvents::TextDelta < Riffer::StreamEvents::Base
+  attr_reader :content
 
-    def initialize(content, role: "assistant")
-      super(role: role)
-      @content = content
-    end
+  def initialize(content, role: "assistant")
+    super(role: role)
+    @content = content
+  end
 
-    def to_h
-      {role: @role, content: @content}
-    end
+  def to_h
+    {role: @role, content: @content}
   end
 end

data/lib/riffer/stream_events/text_done.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-module Riffer::StreamEvents
-  class TextDone < Base
-    attr_reader :content
+class Riffer::StreamEvents::TextDone < Riffer::StreamEvents::Base
+  attr_reader :content
 
-    def initialize(content, role: "assistant")
-      super(role: role)
-      @content = content
-    end
+  def initialize(content, role: "assistant")
+    super(role: role)
+    @content = content
+  end
 
-    def to_h
-      {role: @role, content: @content}
-    end
+  def to_h
+    {role: @role, content: @content}
   end
 end

data/lib/riffer/version.rb

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

data/lib/riffer.rb

@@ -2,6 +2,15 @@
 
 require "zeitwerk"
 
+# :nodoc:
+# Riffer is the main module for the Riffer AI framework.
+#
+# Provides configuration, error classes, and versioning for the gem.
+#
+# @see Riffer::Config
+# @see Riffer::Agent
+# @see Riffer::Providers
+# @see Riffer::Messages
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   "open_ai" => "OpenAI"
@@ -9,19 +18,35 @@ loader.inflector.inflect(
 loader.setup
 
 module Riffer
+  # Base error for Riffer
+  # @api public
   class Error < StandardError; end
 
+  # Argument error for Riffer
+  # @api public
+  class ArgumentError < ::ArgumentError; end
+
+  # Provides configuration and versioning methods for Riffer
+  #
+  # @!group Configuration
   class << self
+    # Returns the Riffer configuration
+    # @return [Riffer::Config]
     def config
       @config ||= Config.new
     end
 
+    # Yields the configuration for block-based setup
+    # @yieldparam config [Riffer::Config] the configuration object
+    # @return [void]
     def configure
       yield config if block_given?
     end
-  end
 
-  Agent = Agents::Base
-  Tool = Tools::Base
-  Provider = Providers::Base
+    # Returns the gem version
+    # @return [String] the version string
+    def version
+      VERSION
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riffer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jake Bottrall
@@ -44,61 +44,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.42.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -113,20 +113,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
 description: Riffer is a comprehensive Ruby framework designed to simplify the development
   of AI-powered applications and agents. It provides a complete toolkit for integrating
   artificial intelligence capabilities into your Ruby projects.
@@ -136,25 +122,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop_rspec.yml"
 - ".ruby-version"
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/riffer.rb
-- lib/riffer/agents.rb
-- lib/riffer/agents/base.rb
+- lib/riffer/agent.rb
 - lib/riffer/config.rb
 - lib/riffer/core.rb
-- lib/riffer/dependency_helper.rb
+- lib/riffer/helpers/dependencies.rb
+- lib/riffer/helpers/validations.rb
 - lib/riffer/messages.rb
 - lib/riffer/messages/assistant.rb
 - lib/riffer/messages/base.rb
+- lib/riffer/messages/converter.rb
 - lib/riffer/messages/system.rb
 - lib/riffer/messages/tool.rb
 - lib/riffer/messages/user.rb
@@ -162,14 +146,10 @@ files:
 - lib/riffer/providers/base.rb
 - lib/riffer/providers/open_ai.rb
 - lib/riffer/providers/test.rb
-- lib/riffer/storage.rb
-- lib/riffer/storage/base.rb
 - lib/riffer/stream_events.rb
 - lib/riffer/stream_events/base.rb
 - lib/riffer/stream_events/text_delta.rb
 - lib/riffer/stream_events/text_done.rb
-- lib/riffer/tools.rb
-- lib/riffer/tools/base.rb
 - lib/riffer/version.rb
 - sig/riffer.rbs
 homepage: https://riffer.ai

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop_rspec.yml

@@ -1,6 +0,0 @@
-plugins:
-  - rubocop-rspec
-
-RSpec/MultipleExpectations:
-  Enabled: true
-  Max: 1

data/Guardfile

@@ -1,70 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # Feel free to open issues for suggestions and improvements
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-
-  # Rails files
-  rails = dsl.rails(view_extensions: %w[erb haml slim])
-  dsl.watch_spec_files_for(rails.app_files)
-  dsl.watch_spec_files_for(rails.views)
-
-  watch(rails.controllers) do |m|
-    [
-      rspec.spec.call("routing/#{m[1]}_routing"),
-      rspec.spec.call("controllers/#{m[1]}_controller"),
-      rspec.spec.call("acceptance/#{m[1]}")
-    ]
-  end
-
-  # Rails config changes
-  watch(rails.spec_helper) { rspec.spec_dir }
-  watch(rails.routes) { "#{rspec.spec_dir}/routing" }
-  watch(rails.app_controller) { "#{rspec.spec_dir}/controllers" }
-
-  # Capybara features specs
-  watch(rails.view_dirs) { |m| rspec.spec.call("features/#{m[1]}") }
-  watch(rails.layouts) { |m| rspec.spec.call("features/#{m[1]}") }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
-  end
-end