ruby_llm-responses_api 0.1.0

data/lib/ruby_llm/providers/openai_responses.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module Providers
+    # OpenAI Responses API provider for RubyLLM.
+    # Implements the new Responses API which provides built-in tools,
+    # stateful conversations, background mode, and MCP support.
+    class OpenAIResponses
+      include OpenAIResponses::Chat
+      include OpenAIResponses::Streaming
+      include OpenAIResponses::Tools
+      include OpenAIResponses::Models
+      include OpenAIResponses::Media
+
+      def api_base
+        @config.openai_api_base || 'https://api.openai.com/v1'
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{@config.openai_api_key}",
+          'OpenAI-Organization' => @config.openai_organization_id,
+          'OpenAI-Project' => @config.openai_project_id
+        }.compact
+      end
+
+      # Retrieve a stored response by ID
+      # @param response_id [String] The response ID to retrieve
+      # @return [Hash] The response data
+      def retrieve_response(response_id)
+        response = @connection.get(Background.retrieve_url(response_id))
+        response.body
+      end
+
+      # Cancel a background response
+      # @param response_id [String] The response ID to cancel
+      # @return [Hash] The cancellation result
+      def cancel_response(response_id)
+        response = @connection.post(Background.cancel_url(response_id), {})
+        response.body
+      end
+
+      # Delete a stored response
+      # @param response_id [String] The response ID to delete
+      # @return [Hash] The deletion result
+      def delete_response(response_id)
+        response = @connection.delete(Background.retrieve_url(response_id))
+        response.body
+      end
+
+      # List input items for a response
+      # @param response_id [String] The response ID
+      # @return [Hash] The input items
+      def list_input_items(response_id)
+        response = @connection.get(Background.input_items_url(response_id))
+        response.body
+      end
+
+      # Poll a background response until completion
+      # @param response_id [String] The response ID to poll
+      # @param interval [Float] Polling interval in seconds
+      # @param timeout [Float, nil] Maximum time to wait in seconds
+      # @yield [Hash] Called with response data on each poll
+      # @return [Hash] The final response data
+      def poll_response(response_id, interval: 1.0, timeout: nil)
+        start_time = Time.now
+        loop do
+          response_data = retrieve_response(response_id)
+          yield response_data if block_given?
+
+          return response_data if Background.complete?(response_data)
+
+          raise Error, "Polling timeout after #{timeout} seconds" if timeout && (Time.now - start_time) > timeout
+
+          sleep interval
+        end
+      end
+
+      class << self
+        def capabilities
+          OpenAIResponses::Capabilities
+        end
+
+        def configuration_requirements
+          %i[openai_api_key]
+        end
+
+        def slug
+          :openai_responses
+        end
+      end
+    end
+  end
+end

data/lib/ruby_llm-responses_api.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Alias for rubyllm_responses_api to match gem naming convention
+require_relative 'rubyllm_responses_api'

data/lib/rubyllm_responses_api.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'ruby_llm'
+
+# Provider class must be loaded first to define the class
+require_relative 'ruby_llm/providers/openai_responses/base'
+
+# Core modules
+require_relative 'ruby_llm/providers/openai_responses/capabilities'
+require_relative 'ruby_llm/providers/openai_responses/media'
+require_relative 'ruby_llm/providers/openai_responses/tools'
+require_relative 'ruby_llm/providers/openai_responses/models'
+require_relative 'ruby_llm/providers/openai_responses/streaming'
+require_relative 'ruby_llm/providers/openai_responses/chat'
+
+# Advanced features
+require_relative 'ruby_llm/providers/openai_responses/built_in_tools'
+require_relative 'ruby_llm/providers/openai_responses/state'
+require_relative 'ruby_llm/providers/openai_responses/background'
+require_relative 'ruby_llm/providers/openai_responses/message_extension'
+require_relative 'ruby_llm/providers/openai_responses/model_registry'
+require_relative 'ruby_llm/providers/openai_responses/active_record_extension'
+
+# Include all modules in the provider class
+require_relative 'ruby_llm/providers/openai_responses'
+
+# Register the provider
+RubyLLM::Provider.register :openai_responses, RubyLLM::Providers::OpenAIResponses
+
+# Register models for this provider
+RubyLLM::Providers::OpenAIResponses::ModelRegistry.register_all!
+
+# Extend RubyLLM module with ResponsesAPI namespace
+module RubyLLM
+  # ResponsesAPI namespace for direct access to helpers and version
+  module ResponsesAPI
+    VERSION = '0.1.0'
+
+    # Shorthand access to built-in tool helpers
+    BuiltInTools = Providers::OpenAIResponses::BuiltInTools
+    State = Providers::OpenAIResponses::State
+    Background = Providers::OpenAIResponses::Background
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: ruby_llm-responses_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hasinski
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_llm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A RubyLLM provider that implements OpenAI's Responses API, providing
+  access to built-in tools (web search, code interpreter, file search), stateful conversations,
+  background mode, and MCP support.
+email:
+- krzysztof.hasinski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/ruby_llm-responses_api.rb
+- lib/ruby_llm/providers/openai_responses.rb
+- lib/ruby_llm/providers/openai_responses/active_record_extension.rb
+- lib/ruby_llm/providers/openai_responses/background.rb
+- lib/ruby_llm/providers/openai_responses/base.rb
+- lib/ruby_llm/providers/openai_responses/built_in_tools.rb
+- lib/ruby_llm/providers/openai_responses/capabilities.rb
+- lib/ruby_llm/providers/openai_responses/chat.rb
+- lib/ruby_llm/providers/openai_responses/media.rb
+- lib/ruby_llm/providers/openai_responses/message_extension.rb
+- lib/ruby_llm/providers/openai_responses/model_registry.rb
+- lib/ruby_llm/providers/openai_responses/models.rb
+- lib/ruby_llm/providers/openai_responses/state.rb
+- lib/ruby_llm/providers/openai_responses/streaming.rb
+- lib/ruby_llm/providers/openai_responses/tools.rb
+- lib/rubyllm_responses_api.rb
+homepage: https://github.com/khasinski/ruby_llm-responses_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/khasinski/ruby_llm-responses_api
+  source_code_uri: https://github.com/khasinski/ruby_llm-responses_api
+  changelog_uri: https://github.com/khasinski/ruby_llm-responses_api/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.2
+specification_version: 4
+summary: OpenAI Responses API provider for RubyLLM
+test_files: []