openai-toolable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0087364577f6cf8ca019db6c85e945f22268215cfeec1645d2057f65e521f2e6'
+  data.tar.gz: 85d1280a72de872827da87f64269310537a8673b7e85d950732dd60db527dd46
+SHA512:
+  metadata.gz: 6d03ff67dd8d3da0a2cfb0110ce25143c975cd4468704e432d7fab474887a5e4da43764ed28f9575a05c2d7174d4ed3f89afaf97eee640d259b4e8bbf57fd24b
+  data.tar.gz: 4f79f0fde24df17c8c76e86e9cba087ba81700f551c7d0f67f8a05c1656303f1550f6666fa864fbf6fff5b1361e4bf3dc9fb41d5f47e083ea8431a0bd937a04a

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in openai-toolable.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    openai-toolable (0.1.0)
+      openai (~> 0.16.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.5.3)
+    minitest (5.25.5)
+    openai (0.16.0)
+      connection_pool
+    rake (13.3.0)
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  openai-toolable!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Van Curen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# OpenAI Toolable
+
+`openai-toolable` is a Ruby gem that extends the official `openai` gem to provide a simple and flexible way to use tools with the OpenAI API. It allows you to define tools, including their names, descriptions, and parameters, and then easily integrate them into your chat completion requests.
+
+This gem is built on top of the `openai-ruby` gem and is designed to be a lightweight and intuitive extension for developers who want to leverage function calling in their Ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openai-toolable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install openai-toolable
+
+## Usage
+
+Here's a simple example of how to use `openai-toolable` to define a tool and use it with the OpenAI API:
+
+```ruby
+require "openai/toolable"
+
+# Define a tool
+weather_tool = Openai::Toolable::ToolFactory.build(
+  name: "get_weather",
+  description: "Get the current weather in a given location",
+  parameters: [
+    { name: "location", type: :string, description: "The city and state, e.g. San Francisco, CA" },
+    { name: "unit", type: :string, description: "The unit of temperature, e.g. celsius or fahrenheit" }
+  ]
+)
+
+# Create a tool handler and register the tool
+tool_handler = Openai::Toolable::ToolHandler.new
+tool_handler.register(
+  name: "get_weather",
+  lambda: ->(location:, unit:) { puts "Getting the weather in #{location} (#{unit})..." }
+)
+
+# Create a client
+client = OpenAI::Client.new
+
+# Create a chat completion
+response = client.chat(
+  parameters: {
+    model: "gpt-3.5-turbo",
+    messages: [{ role: "user", content: "What's the weather like in Boston?" }],
+    tools: [weather_tool.to_json]
+  }
+)
+
+# Handle the response
+tool_handler.handle(response: response)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vancuren/openai-toolable.
+
+## Acknowledgments
+
+This gem is an extension of the official `openai-ruby` gem. We are grateful to the maintainers of the `openai-ruby` for their excellent work.

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "openai/toolable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/simple.rb

@@ -0,0 +1,33 @@
+require "openai/toolable"
+
+# Define a tool
+weather_tool = Openai::Toolable::ToolFactory.build(
+  name: "get_weather",
+  description: "Get the current weather in a given location",
+  parameters: [
+    { name: "location", type: :string, description: "The city and state, e.g. San Francisco, CA" },
+    { name: "unit", type: :string, description: "The unit of temperature, e.g. celsius or fahrenheit" }
+  ]
+)
+
+# Create a tool handler and register the tool
+tool_handler = Openai::Toolable::ToolHandler.new
+tool_handler.register(
+  name: "get_weather",
+  lambda: ->(location:, unit:) { puts "Getting the weather in #{location} (#{unit})..." }
+)
+
+# Create a client
+client = OpenAI::Client.new
+
+# Create a chat completion
+response = client.chat(
+  parameters: {
+    model: "gpt-3.5-turbo",
+    messages: [{ role: "user", content: "What's the weather like in Boston?" }],
+    tools: [weather_tool.to_json]
+  }
+)
+
+# Handle the response
+tool_handler.handle(response: response)

data/lib/openai/toolable/parameter.rb

@@ -0,0 +1,14 @@
+module Openai
+  module Toolable
+    class Parameter
+      attr_reader :name, :type, :description, :required
+
+      def initialize(name:, type:, description:, required: false)
+        @name = name
+        @type = type
+        @description = description
+        @required = required
+      end
+    end
+  end
+end

data/lib/openai/toolable/tool_handler.rb

@@ -0,0 +1,25 @@
+require "json"
+
+module Openai
+  module Toolable
+    class ToolHandler
+      def initialize
+        @tools = {}
+      end
+
+      def register(name:, lambda:)
+        @tools[name] = lambda
+      end
+
+      def handle(response:)
+        tool_call = response.dig("choices", 0, "message", "tool_calls", 0)
+        return unless tool_call
+
+        function_name = tool_call.dig("function", "name")
+        arguments = JSON.parse(tool_call.dig("function", "arguments"))
+
+        @tools[function_name]&.call(**arguments.transform_keys(&:to_sym))
+      end
+    end
+  end
+end

data/lib/openai/toolable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Openai
+  module Toolable
+    VERSION = "0.1.0"
+  end
+end

data/lib/openai/toolable.rb

@@ -0,0 +1,46 @@
+require_relative "toolable/version"
+require_relative "toolable/parameter"
+require_relative "toolable/tool_handler"
+
+module Openai
+  module Toolable
+    class Error < StandardError; end
+    
+    class Tool
+      attr_reader :name, :description, :parameters
+
+      def initialize(name:, description:, parameters: [])
+        @name = name
+        @description = description
+        @parameters = parameters.map do |param|
+          Parameter.new(
+            name: param[:name],
+            type: param[:type],
+            description: param[:description],
+            required: param.fetch(:required, false)
+          )
+        end
+      end
+
+      def to_json
+        {
+          name: name,
+          description: description,
+          parameters: {
+            type: :object,
+            properties: parameters.each_with_object({}) do |param, hash|
+            hash[param.name] = { type: param.type, description: param.description }
+          end,
+          required: parameters.select(&:required).map(&:name)
+          }
+        }
+      end
+    end
+
+    class ToolFactory
+      def self.build(name:, description:, parameters: [])
+        Tool.new(name: name, description: description, parameters: parameters)
+      end
+    end
+  end
+end

data/sig/openai/toolable.rbs

@@ -0,0 +1,6 @@
+module Openai
+  module Toolable
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: openai-toolable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Russell Van Curen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: This gem provides a simple and flexible way to define and use tools with
+  the OpenAI API.
+email:
+- russell@vancuren.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/simple.rb
+- lib/openai/toolable.rb
+- lib/openai/toolable/parameter.rb
+- lib/openai/toolable/tool_handler.rb
+- lib/openai/toolable/version.rb
+- sig/openai/toolable.rbs
+homepage: https://github.com/vancuren/openai-toolable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/vancuren/openai-toolable
+  source_code_uri: https://github.com/vancuren/openai-toolable
+  changelog_uri: https://github.com/vancuren/openai-toolable/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: A Ruby gem that extends the OpenAI SDK to support function calling.
+test_files: []