tool_tailor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 980dce0cfc15a14e6e39b90377871d631957a44166208d726accbcd1c15688de
+  data.tar.gz: 9a64314215aece1ce9ab8cd9fc6c200c874033ceff90f34fc45360299a16b335
+SHA512:
+  metadata.gz: f48609d013d82e51b124c54464dcb3f5267ad18d14d3870e3c394a022b6d005eb405a352a1c72561b818887e446f79bad7fee128567bb90686a7fe724d7e21f0
+  data.tar.gz: b1e42b9086973077c6de2eba1c82788be0d489f291bbe2251e332a67dd35bf78e43d4a4423526110e52143f16dbdfb7a14f0549c4d12389aff71a838dd122938

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kieranklaassen@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tool_tailor.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    tool_tailor (0.1.0)
+      yard (~> 0.9.36)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.1)
+    rake (12.3.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    yard (0.9.36)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  tool_tailor!
+
+BUNDLED WITH
+   2.3.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kieran Klaassen
+
+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 @@
+# ToolTailor
+
+ToolTailor is a Ruby gem that converts methods to OpenAI JSON schemas for use with tools, making it easier to integrate with OpenAI's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tool_tailor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tool_tailor
+
+## Usage
+
+```rb
+class TestClass
+  # Get the current weather in a given location.
+  #
+  # @param location [String] The city and state, e.g., San Francisco, CA.
+  # @param unit [String] The unit of temperature, either 'celsius' or 'fahrenheit'.
+  # @param api_key [Float] The API key for the weather service.
+  def get_current_weather(location, unit = 'celsius', api_key: nil)
+    # Function implementation goes here
+  end
+end
+
+TestClass.to_json_schema(:get_current_weather) # => {
+#   "type" => "function",
+#   "function" => {
+#     "name" => "get_current_weather",
+#     "description" => "Get the current weather in a given location.",
+#     "parameters" => {
+#       "type" => "object",
+#       "properties" => {
+#         "location" => {
+#           "type" => "string",
+#           "description" => "The city and state, e.g., San Francisco, CA."
+#         },
+#         "unit" => {
+#           "type" => "string",
+#           "description" => "The unit of temperature, either 'celsius' or 'fahrenheit'."
+#         },
+#         "api_key" => {
+#           "type" => "number",
+#           "description" => "The API key for the weather service."
+#         }
+#       },
+#       "required" => ["location", "unit", "api_key"]
+#     }
+#   }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/[USERNAME]/tool_tailor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tool_tailor/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tool_tailor"
+
+# 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/lib/tool_tailor/version.rb

@@ -0,0 +1,3 @@
+module ToolTailor
+  VERSION = "0.1.0"
+end

data/lib/tool_tailor.rb

@@ -0,0 +1,90 @@
+require "tool_tailor/version"
+require 'json'
+require 'yard'
+
+module ToolTailor
+  class Error < StandardError; end
+
+  # Converts a function to a JSON schema representation.
+  #
+  # @param function [Method] The function to convert.
+  # @return [String] The JSON schema representation of the function.
+  # @raise [ArgumentError] If the provided object is not a Method or UnboundMethod.
+  def self.convert(function)
+    unless function.is_a?(Method) || function.is_a?(UnboundMethod)
+      raise ArgumentError, "Unsupported object type: #{function.class}"
+    end
+
+    file_path, line_number = function.source_location
+    YARD.parse(file_path)
+
+    # Construct the correct identifier for the YARD object
+    method_path = "#{function.owner}##{function.name}"
+    yard_object = YARD::Registry.at(method_path)
+    raise "Documentation for #{method_path} not found." if yard_object.nil?
+
+    function_description = yard_object.docstring
+
+    parameters = yard_object.tags('param').map do |tag|
+      {
+        name: tag.name,
+        type: type_mapping(tag.types.first),
+        description: tag.text
+      }
+    end
+
+    {
+      type: "function",
+      function: {
+        name: function.name.to_s,
+        description: function_description,
+        parameters: {
+          type: "object",
+          properties: parameters.map do |param|
+            [
+              param[:name],
+              {
+                type: param[:type],
+                description: param[:description]
+              }
+            ]
+          end.to_h,
+          required: parameters.map { |param| param[:name].to_s }
+        }
+      }
+    }.to_json
+  end
+
+  # Maps Ruby types to JSON schema types.
+  #
+  # @param type [Class] The Ruby type to map.
+  # @return [String] The corresponding JSON schema type.
+  # @raise [ArgumentError] If the provided type is not supported.
+  def self.type_mapping(type)
+    case type
+    when "String"
+      'string'
+    when "Integer"
+      'integer'
+    when "Float"
+      'number'
+    when "TrueClass", "FalseClass"
+      'boolean'
+    when "Array"
+      'array'
+    when "Hash"
+      'object'
+    when "NilClass"
+      'null'
+    else
+      # raise ArgumentError, "Unsupported type: #{type} #{type.class}"
+      'string'
+    end
+  end
+end
+
+class Module
+  def to_json_schema(method_name)
+    ToolTailor.convert(instance_method(method_name))
+  end
+end

data/tool_tailor.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/tool_tailor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tool_tailor"
+  spec.version       = ToolTailor::VERSION
+  spec.authors       = ["Kieran Klaassen"]
+  spec.email         = ["kieranklaassen@gmail.com"]
+
+  spec.summary       = %q{A Gem to convert methods to openai JSON schemas for use with tools}
+  spec.description   = %q{ToolTailor is a Ruby gem that converts methods to OpenAI JSON schemas for use with tools, making it easier to integrate with OpenAI's API.}
+  spec.homepage      = "https://github.com/kieranklaassen/tool_tailor"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kieranklaassen/tool_tailor"
+  spec.metadata["changelog_uri"] = "https://github.com/kieranklaassen/tool_tailor/blob/master/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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "yard", "~> 0.9.36"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: tool_tailor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kieran Klaassen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+description: ToolTailor is a Ruby gem that converts methods to OpenAI JSON schemas
+  for use with tools, making it easier to integrate with OpenAI's API.
+email:
+- kieranklaassen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tool_tailor.rb
+- lib/tool_tailor/version.rb
+- tool_tailor.gemspec
+homepage: https://github.com/kieranklaassen/tool_tailor
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kieranklaassen/tool_tailor
+  source_code_uri: https://github.com/kieranklaassen/tool_tailor
+  changelog_uri: https://github.com/kieranklaassen/tool_tailor/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A Gem to convert methods to openai JSON schemas for use with tools
+test_files: []