ruby_llm 0.1.0.pre → 0.1.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c616dc84f656d17df731cee4f7ee6a0eb20793d9c1b32df549ba21fbc8c913
-  data.tar.gz: 2bc73cc3304cc21c1e27b97c3702cec24cdca443ca81d613fe3850fefa7224da
+  metadata.gz: d1e5d243e58cd5fc884ef6a8ed5078df18e7659523296f175c55dff24c116079
+  data.tar.gz: 9a0cebfd7392a92e05b4f98974735ffab608e96a9af2caa2c5886af92584e0e7
 SHA512:
-  metadata.gz: '0080ab8908d42eb938d0a357910c95d9b344a30e95319c53803944d7b6d6876cce30df9926a30e9387b870cb713224665d6edc57e8e07def08fd1d995f4ab056'
-  data.tar.gz: ee65b82281d0207027ed345e751b0e19d3de9e7ff3bfa6d2b8e05831906c4cd6323da3790d82d3c961658fb6904ba879e806bb2cf39336866494c2894bf96f6f
+  metadata.gz: 3df37307db5c36064502f476c714c893717a38fb73136e57c9e395386e8354cce62b47ad12da7cd6fe1c666a8c6e55faf333cd2808cfc280ae775bb96c181d23
+  data.tar.gz: df0f1a5cff449264a3868ac463ada43a94eddc712ed1b3de23802b5188ae217e86b8b48314cb99b24468bbdf2cb9970886908156e3a72642d7967b9a4088db40

data/.github/workflows/gem-push.yml

@@ -7,7 +7,11 @@ on:
     branches: [ "main" ]
 
 jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
   build:
+    needs: test # This ensures tests must pass before building/publishing
     name: Build + Publish
     runs-on: ubuntu-latest
     permissions:
@@ -16,10 +20,12 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Ruby 3.3
+
+    - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.3.x
+        ruby-version: '3.3'
+        bundler-cache: true
 
     - name: Publish to GPR
       run: |
@@ -42,4 +48,4 @@ jobs:
         gem build *.gemspec
         gem push *.gem
       env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Install dependencies
+      run: bundle install
+
+    # - name: Check code format
+    #   run: bundle exec rubocop
+
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+repomix-output.txt

data/.overcommit.yml

@@ -0,0 +1,26 @@
+PreCommit:
+  RuboCop:
+    enabled: false
+    auto_correct: true
+    on_warn: fail # Treat all warnings as failures
+
+  Flay:
+    enabled: true
+
+  RSpec:
+    enabled: true
+    command: ['bundle', 'exec', 'rspec']
+    on_warn: fail
+
+  TrailingWhitespace:
+    enabled: true
+    auto_correct: true
+    exclude:
+     - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+
+PostCheckout:
+  ALL: # Special hook name that customizes all hooks of this type
+    quiet: true # Change all post-checkout hooks to only display output on failure
+
+  IndexTags:
+    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -10,7 +10,8 @@ RubyLLM provides a unified interface for interacting with various LLM providers
 ## Features
 
 - 🤝 Unified interface for multiple LLM providers (OpenAI, Anthropic, etc.)
-- 🛠️ Tool/Function calling support
+- 📋 Comprehensive model listing and capabilities detection
+- 🛠️ Simple and flexible tool/function calling
 - 📊 Automatic token counting and tracking
 - 🔄 Streaming support
 - 🚂 Seamless Rails integration
@@ -44,10 +45,34 @@ require 'ruby_llm'
 RubyLLM.configure do |config|
   config.openai_api_key = ENV['OPENAI_API_KEY']
   config.anthropic_api_key = ENV['ANTHROPIC_API_KEY']
-  config.default_model = 'gpt-4'
+  config.default_model = 'gpt-4o-mini'
 end
 ```
 
+### Listing Available Models
+
+```ruby
+client = RubyLLM.client
+
+# List models from all providers
+all_models = client.list_models
+
+# List models from a specific provider
+openai_models = client.list_models(:openai)
+anthropic_models = client.list_models(:anthropic)
+
+# Access model information
+model = openai_models.first
+puts model.display_name
+puts "Context window: #{model.context_window}"
+puts "Maximum tokens: #{model.max_tokens}"
+puts "Input price per million tokens: $#{model.input_price_per_million}"
+puts "Output price per million tokens: $#{model.output_price_per_million}"
+puts "Supports vision: #{model.supports_vision}"
+puts "Supports function calling: #{model.supports_functions}"
+puts "Supports JSON mode: #{model.supports_json_mode}"
+```
+
 ### Simple Chat
 
 ```ruby
@@ -60,22 +85,15 @@ response = client.chat([
 puts response.content
 ```
 
-### Streaming
-
-```ruby
-client.chat([
-  { role: :user, content: "Count to 10 slowly" }
-], stream: true) do |chunk|
-  print chunk.content
-end
-```
+### Tools (Function Calling)
 
-### Tool Usage
+RubyLLM supports tools/functions with a simple, flexible interface. You can create tools using blocks or wrap existing methods:
 
 ```ruby
+# Using a block
 calculator = RubyLLM::Tool.new(
   name: "calculator",
-  description: "Perform mathematical calculations",
+  description: "Performs mathematical calculations",
   parameters: {
     expression: {
       type: "string",
@@ -87,9 +105,46 @@ calculator = RubyLLM::Tool.new(
   eval(args[:expression]).to_s
 end
 
+# Using an existing method
+class MathUtils
+  def arithmetic(x, y, operation)
+    case operation
+    when 'add' then x + y
+    when 'subtract' then x - y
+    when 'multiply' then x * y
+    when 'divide' then x.to_f / y
+    else
+      raise ArgumentError, "Unknown operation: #{operation}"
+    end
+  end
+end
+
+math_tool = RubyLLM::Tool.from_method(
+  MathUtils.instance_method(:arithmetic),
+  description: "Performs basic arithmetic operations",
+  parameter_descriptions: {
+    x: "First number in the operation",
+    y: "Second number in the operation",
+    operation: "Operation to perform (add, subtract, multiply, divide)"
+  }
+)
+
+# Use tools in conversations
 response = client.chat([
   { role: :user, content: "What is 123 * 456?" }
 ], tools: [calculator])
+
+puts response.content
+```
+
+### Streaming
+
+```ruby
+client.chat([
+  { role: :user, content: "Count to 10 slowly" }
+], stream: true) do |chunk|
+  print chunk.content
+end
 ```
 
 ## Rails Integration

data/Rakefile

@@ -1,4 +1,6 @@
-require "bundler/gem_tasks"
-require "rake/clean"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/clean'
 
 task default: %w[build]

data/bin/console

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
-require "bundler/setup"
-require "ruby_llm"
+# frozen_string_literal: true
 
-require "irb"
+require 'bundler/setup'
+require 'ruby_llm'
+require 'dotenv/load'
+
+require 'irb'
 IRB.start(__FILE__)

data/lib/ruby_llm/active_record/acts_as.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 module RubyLLM
   module ActiveRecord
+    # Provides ActsAs functionality for LLM-related models
     module ActsAs
-      def acts_as_llm_model(options = {})
+      def acts_as_llm_model(_options = {})
         include ModelMethods
       end
 
-      def acts_as_llm_conversation(options = {})
+      def acts_as_llm_conversation(_options = {})
         include ConversationMethods
         has_many :messages, -> { order(created_at: :asc) }
       end
 
-      def acts_as_llm_message(options = {})
+      def acts_as_llm_message(_options = {})
         include MessageMethods
         belongs_to :conversation
       end
     end
 
+    # Methods for LLM model functionality
     module ModelMethods
       extend ActiveSupport::Concern
 
@@ -31,6 +35,7 @@ module RubyLLM
       end
     end
 
+    # Methods for LLM conversation handling
     module ConversationMethods
       extend ActiveSupport::Concern
 
@@ -40,26 +45,33 @@ module RubyLLM
 
       def send_message(content, model: nil)
         transaction do
-          message = messages.create!(
-            role: :user,
-            content: content
-          )
-
-          response = RubyLLM.client.chat(
-            conversation_messages,
-            model: model || current_model
-          )
-
-          messages.create!(
-            role: :assistant,
-            content: response.content,
-            token_count: response.token_count
-          )
+          create_user_message(content)
+          create_assistant_response(model)
         end
       end
 
       private
 
+      def create_user_message(content)
+        messages.create!(
+          role: :user,
+          content: content
+        )
+      end
+
+      def create_assistant_response(model)
+        response = RubyLLM.client.chat(
+          conversation_messages,
+          model: model || current_model
+        )
+
+        messages.create!(
+          role: :assistant,
+          content: response.content,
+          token_count: response.token_count
+        )
+      end
+
       def conversation_messages
         messages.map(&:to_llm_format)
       end
@@ -69,6 +81,7 @@ module RubyLLM
       end
     end
 
+    # Methods for LLM message handling
     module MessageMethods
       extend ActiveSupport::Concern
 

data/lib/ruby_llm/client.rb

@@ -1,38 +1,54 @@
+# frozen_string_literal: true
+
 module RubyLLM
+  # Client class for handling LLM provider interactions
   class Client
     def initialize
       @providers = {}
-      @conversations = {}
     end
 
-    def chat(messages, model: nil, temperature: 1.0, stream: false, &block)
+    def chat(messages, model: nil, temperature: 0.7, stream: false, tools: nil, &block)
+      # Convert any hash messages to Message objects
+      formatted_messages = messages.map do |msg|
+        msg.is_a?(Message) ? msg : Message.new(**msg)
+      end
+
       provider = provider_for(model)
-      response = provider.chat(
-        messages,
+      provider.chat(
+        formatted_messages,
         model: model,
         temperature: temperature,
         stream: stream,
+        tools: tools,
         &block
       )
-      response
     end
 
-    def create_conversation(tools: [])
-      conversation = Conversation.new(tools: tools)
-      @conversations[conversation.id] = conversation
-      conversation
+    def list_models(provider = nil)
+      if provider
+        provider_for(nil, provider).list_models
+      else
+        all_providers.flat_map(&:list_models)
+      end
     end
 
     private
 
-    def provider_for(model)
-      provider_name = detect_provider(model)
+    def all_providers
+      [
+        provider_for(nil, :openai),
+        provider_for(nil, :anthropic)
+      ]
+    end
+
+    def provider_for(model, specific_provider = nil)
+      provider_name = specific_provider || detect_provider(model)
       @providers[provider_name] ||= case provider_name
-      when :openai then Providers::OpenAI.new
-      when :anthropic then Providers::Anthropic.new
-      else
-        raise Error, "Unsupported provider: #{provider_name}"
-      end
+                                    when :openai then Providers::OpenAI.new
+                                    when :anthropic then Providers::Anthropic.new
+                                    else
+                                      raise Error, "Unsupported provider: #{provider_name}"
+                                    end
     end
 
     def detect_provider(model)

data/lib/ruby_llm/configuration.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module RubyLLM
+  # Configuration class for RubyLLM settings
   class Configuration
-    attr_accessor :openai_api_key, :anthropic_api_key
-    attr_accessor :default_provider, :default_model
-    attr_accessor :request_timeout
+    attr_accessor :openai_api_key, :anthropic_api_key, :default_provider, :default_model, :request_timeout
 
     def initialize
       @request_timeout = 30
@@ -18,6 +19,7 @@ module RubyLLM
     end
   end
 
+  # Settings specific to individual LLM providers
   class ProviderSettings
     attr_accessor :api_key, :api_version, :default_model, :base_url
   end

data/lib/ruby_llm/conversation.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module RubyLLM
+  # Represents a conversation with an LLM
   class Conversation
     attr_reader :id, :messages, :tools
 

data/lib/ruby_llm/message.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module RubyLLM
   class Message
     VALID_ROLES = %i[system user assistant tool].freeze
 
-    attr_reader :role, :content, :tool_calls, :tool_results
+    attr_reader :role, :content, :tool_calls, :tool_results, :token_usage, :model_id
 
-    def initialize(role:, content: nil, tool_calls: nil, tool_results: nil)
+    def initialize(role:, content: nil, tool_calls: nil, tool_results: nil, token_usage: nil, model_id: nil)
       @role = role.to_sym
       @content = content
       @tool_calls = tool_calls
       @tool_results = tool_results
+      @token_usage = token_usage
+      @model_id = model_id
       validate!
     end
 
@@ -17,7 +21,9 @@ module RubyLLM
         role: role,
         content: content,
         tool_calls: tool_calls,
-        tool_results: tool_results
+        tool_results: tool_results,
+        token_usage: token_usage,
+        model_id: model_id
       }.compact
     end
 
@@ -25,8 +31,11 @@ module RubyLLM
 
     def validate!
       unless VALID_ROLES.include?(role)
-        raise ArgumentError, "Invalid role: #{role}. Must be one of: #{VALID_ROLES.join(', ')}"
+        raise ArgumentError,
+              "Invalid role: #{role}. Must be one of: #{VALID_ROLES.join(', ')}"
       end
+      raise ArgumentError, 'Content cannot be nil' if content.nil?
+      raise ArgumentError, 'Content cannot be empty' if content.empty?
     end
   end
 end

data/lib/ruby_llm/model_capabilities/anthropic.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module ModelCapabilities
+    class Anthropic < Base
+      def determine_context_window(model_id)
+        case model_id
+        when /claude-3-5-sonnet/, /claude-3-5-haiku/,
+             /claude-3-opus/, /claude-3-sonnet/, /claude-3-haiku/
+          200_000
+        else
+          100_000
+        end
+      end
+
+      def determine_max_tokens(model_id)
+        case model_id
+        when /claude-3-5-sonnet/, /claude-3-5-haiku/
+          8_192
+        when /claude-3-opus/, /claude-3-sonnet/, /claude-3-haiku/
+          4_096
+        else
+          4_096
+        end
+      end
+
+      def get_input_price(model_id)
+        case model_id
+        when /claude-3-5-sonnet/
+          3.0     # $3.00 per million tokens
+        when /claude-3-5-haiku/
+          0.80    # $0.80 per million tokens
+        when /claude-3-opus/
+          15.0    # $15.00 per million tokens
+        when /claude-3-sonnet/
+          3.0     # $3.00 per million tokens
+        when /claude-3-haiku/
+          0.25    # $0.25 per million tokens
+        else
+          3.0
+        end
+      end
+
+      def get_output_price(model_id)
+        case model_id
+        when /claude-3-5-sonnet/
+          15.0    # $15.00 per million tokens
+        when /claude-3-5-haiku/
+          4.0     # $4.00 per million tokens
+        when /claude-3-opus/
+          75.0    # $75.00 per million tokens
+        when /claude-3-sonnet/
+          15.0    # $15.00 per million tokens
+        when /claude-3-haiku/
+          1.25    # $1.25 per million tokens
+        else
+          15.0
+        end
+      end
+
+      def supports_vision?(model_id)
+        case model_id
+        when /claude-3-5-haiku/
+          false
+        when /claude-2/, /claude-1/
+          false
+        else
+          true
+        end
+      end
+
+      def supports_functions?(model_id)
+        model_id.include?('claude-3')
+      end
+
+      def supports_json_mode?(model_id)
+        model_id.include?('claude-3')
+      end
+    end
+  end
+end

data/lib/ruby_llm/model_capabilities/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module ModelCapabilities
+    class Base
+      def determine_context_window(_model_id)
+        raise NotImplementedError
+      end
+
+      def determine_max_tokens(_model_id)
+        raise NotImplementedError
+      end
+
+      def get_input_price(_model_id)
+        raise NotImplementedError
+      end
+
+      def get_output_price(_model_id)
+        raise NotImplementedError
+      end
+
+      def supports_vision?(_model_id)
+        raise NotImplementedError
+      end
+
+      def supports_functions?(_model_id)
+        raise NotImplementedError
+      end
+
+      def supports_json_mode?(_model_id)
+        raise NotImplementedError
+      end
+    end
+  end
+end