prompt_builder 0.1.0

data/lib/prompt_builder.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "prompt_builder/errors"
+
+# Top-level module for the PromptBuilder gem. Provides a DSL for constructing
+# Open Responses API request payloads and parsing responses.
+module PromptBuilder
+  autoload :Content, "prompt_builder/content"
+  autoload :Items, "prompt_builder/items"
+  autoload :Response, "prompt_builder/response"
+  autoload :Session, "prompt_builder/session"
+  autoload :ToolRegistry, "prompt_builder/tool_registry"
+  autoload :Usage, "prompt_builder/usage"
+  autoload :Serializers, "prompt_builder/serializers"
+  autoload :Tools, "prompt_builder/tools"
+
+  VERSION = File.read(File.join(__dir__, "../VERSION")).strip
+
+  class << self
+    # Convert a value to a JSON-safe structure by deep-stringifying Hash keys
+    # and converting Symbols to Strings.
+    #
+    # @param value [Object] the value to convert
+    # @return [Object] the JSON-safe value
+    def jsonify(value)
+      case value
+      when Hash
+        value.each_with_object({}) { |(k, v), h| h[k.to_s] = jsonify(v) }
+      when Array
+        value.map { |v| jsonify(v) }
+      when Symbol
+        value.to_s
+      else
+        value
+      end
+    end
+
+    # Construct a base64-encoded data URL from raw binary data and a content type.
+    #
+    # @param data [String] the raw binary data
+    # @param content_type [String] the MIME content type (e.g. "image/png", "application/pdf")
+    # @return [String] a data URL in the form "data:<content_type>;base64,<encoded_data>"
+    def data_url(data, content_type)
+      "data:#{content_type};base64,#{[data].pack("m0")}"
+    end
+
+    # Parse a data URL into its media type and base64-encoded data.
+    #
+    # @param url [String, nil] a URL that may be a data URL
+    # @return [Array(String, String), nil] a two-element array of +[media_type, data]+
+    #   or nil if the URL is not a data URL
+    def parse_data_url(url)
+      return nil unless url
+      match = url.match(/\Adata:([^;]+);base64,(.*)\z/m)
+      return nil unless match
+      [match[1], match[2]]
+    end
+
+    # Returns the global tool registry singleton.
+    #
+    # @return [ToolRegistry]
+    def tool_registry
+      @tool_registry ||= ToolRegistry.new
+    end
+
+    # Register a tool in the global registry.
+    #
+    # @param name [String] the tool name
+    # @param description [String, nil] the tool description
+    # @param parameters [Hash, nil] the JSON Schema for parameters
+    # @param strict [Boolean] whether strict mode is enabled
+    # @yield [Hash] the parsed arguments when the tool is invoked
+    # @yieldreturn [Object] the tool output (String, Hash, Array, or any object)
+    # @return [Tools::Definition] the registered definition
+    def register_tool(name, description: nil, parameters: nil, strict: false, &handler)
+      tool_registry.register(name, description: description, parameters: parameters, strict: strict, &handler)
+    end
+
+    # Reset the global tool registry. Primarily used in tests.
+    #
+    # @return [void]
+    def reset_tool_registry!
+      @tool_registry = ToolRegistry.new
+    end
+  end
+end

data/prompt_builder.gemspec

@@ -0,0 +1,41 @@
+Gem::Specification.new do |spec|
+  spec.name = "prompt_builder"
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
+
+  spec.summary = "Ruby DSL for building and parsing LLM API requests across OpenAI Responses, OpenAI Chat Completions, Anthropic Messages, Google Gemini, and Bedrock Converse formats"
+
+  spec.homepage = "https://github.com/bdurand/prompt_builder"
+  spec.license = "MIT"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_files = %w[
+    .
+    AGENTS.md
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    bin/
+    gemfiles/
+    spec/
+    test_app/
+  ]
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.add_development_dependency "bundler"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: prompt_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Durand
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- VERSION
+- lib/prompt_builder.rb
+- lib/prompt_builder/content.rb
+- lib/prompt_builder/content/base.rb
+- lib/prompt_builder/content/input_file.rb
+- lib/prompt_builder/content/input_image.rb
+- lib/prompt_builder/content/input_text.rb
+- lib/prompt_builder/content/input_video.rb
+- lib/prompt_builder/content/output_text.rb
+- lib/prompt_builder/content/reasoning_text.rb
+- lib/prompt_builder/content/refusal_content.rb
+- lib/prompt_builder/content/summary_text.rb
+- lib/prompt_builder/content/text.rb
+- lib/prompt_builder/errors.rb
+- lib/prompt_builder/items.rb
+- lib/prompt_builder/items/base.rb
+- lib/prompt_builder/items/compaction.rb
+- lib/prompt_builder/items/function_call.rb
+- lib/prompt_builder/items/function_call_output.rb
+- lib/prompt_builder/items/item_reference.rb
+- lib/prompt_builder/items/message.rb
+- lib/prompt_builder/items/reasoning.rb
+- lib/prompt_builder/response.rb
+- lib/prompt_builder/serializers.rb
+- lib/prompt_builder/serializers/base.rb
+- lib/prompt_builder/serializers/chat_completion.rb
+- lib/prompt_builder/serializers/chat_completion/request.rb
+- lib/prompt_builder/serializers/chat_completion/response.rb
+- lib/prompt_builder/serializers/converse.rb
+- lib/prompt_builder/serializers/converse/request.rb
+- lib/prompt_builder/serializers/converse/response.rb
+- lib/prompt_builder/serializers/gemini.rb
+- lib/prompt_builder/serializers/gemini/request.rb
+- lib/prompt_builder/serializers/gemini/response.rb
+- lib/prompt_builder/serializers/messages.rb
+- lib/prompt_builder/serializers/messages/request.rb
+- lib/prompt_builder/serializers/messages/response.rb
+- lib/prompt_builder/serializers/open_responses.rb
+- lib/prompt_builder/serializers/open_responses/request.rb
+- lib/prompt_builder/serializers/open_responses/response.rb
+- lib/prompt_builder/session.rb
+- lib/prompt_builder/tool_registry.rb
+- lib/prompt_builder/tools.rb
+- lib/prompt_builder/tools/definition.rb
+- lib/prompt_builder/usage.rb
+- prompt_builder.gemspec
+homepage: https://github.com/bdurand/prompt_builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bdurand/prompt_builder
+  source_code_uri: https://github.com/bdurand/prompt_builder
+  changelog_uri: https://github.com/bdurand/prompt_builder/blob/main/CHANGELOG.md
+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: 4.0.3
+specification_version: 4
+summary: Ruby DSL for building and parsing LLM API requests across OpenAI Responses,
+  OpenAI Chat Completions, Anthropic Messages, Google Gemini, and Bedrock Converse
+  formats
+test_files: []