Add RSpec configuration, tests, and update client functionality

Author: crmne

.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.6
+        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}}"

.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

.overcommit.yml

@@ -1,20 +1,3 @@
-# Use this file to configure the Overcommit hooks you wish to use. This will
-# extend the default configuration defined in:
-# https://github.com/sds/overcommit/blob/master/config/default.yml
-#
-# At the topmost level of this YAML file is a key representing type of hook
-# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
-# customize each hook, such as whether to only run it on certain files (via
-# `include`), whether to only display output if it fails (via `quiet`), etc.
-#
-# For a complete list of hooks, see:
-# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
-#
-# For a complete list of options that you can use to customize hooks, see:
-# https://github.com/sds/overcommit#configuration
-#
-# Uncomment the following lines to make the configuration take effect.
-
 PreCommit:
   RuboCop:
     enabled: true
@@ -24,6 +7,13 @@ PreCommit:
   Flay:
     enabled: true
 
+  RSpec:
+    enabled: true
+    command: ['bundle', 'exec', 'rspec']
+    on_warn: fail
+    include:
+      - 'spec/**/*_spec.rb'
+
   TrailingWhitespace:
     enabled: true
     auto_correct: true
@@ -35,4 +25,4 @@ PostCheckout:
     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
+    enabled: true # Generate a tags file with `ctags` each time HEAD changes

.rspec

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

README.md

@@ -10,7 +10,7 @@ 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
+- 🛠️ Simple and flexible tool/function calling
 - 📊 Automatic token counting and tracking
 - 🔄 Streaming support
 - 🚂 Seamless Rails integration
@@ -60,22 +60,15 @@ response = client.chat([
 puts response.content
 ```
 
-### Streaming
+### Tools (Function Calling)
 
-```ruby
-client.chat([
-  { role: :user, content: "Count to 10 slowly" }
-], stream: true) do |chunk|
-  print chunk.content
-end
-```
-
-### 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 +80,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

bin/console

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require 'bundler/setup'
 require 'ruby_llm'
 require 'dotenv/load'

lib/ruby_llm.rb

@@ -3,6 +3,8 @@
 require 'zeitwerk'
 require 'faraday'
 require 'json'
+require 'securerandom'
+require 'logger'
 
 # Main module for RubyLLM functionality
 module RubyLLM
@@ -23,16 +25,34 @@ def client
     def loader
       @loader ||= begin
         loader = Zeitwerk::Loader.for_gem
+        loader.push_dir(File.expand_path('..', __dir__))
         loader.inflector.inflect(
           'llm' => 'LLM',
           'openai' => 'OpenAI',
           'api' => 'API'
         )
+
+        # Log the paths being loaded in development
+        loader.logger = Logger.new($stdout) if ENV['RUBY_LLM_DEBUG']
+
         loader.setup
         loader
       end
     end
   end
 end
 
+# Setup Zeitwerk loader first
 RubyLLM.loader
+
+# Then require core files explicitly
+require_relative 'ruby_llm/configuration'
+require_relative 'ruby_llm/message'
+require_relative 'ruby_llm/tool'
+require_relative 'ruby_llm/providers/base'
+require_relative 'ruby_llm/client'
+require_relative 'ruby_llm/conversation'
+
+# Load providers
+require_relative 'ruby_llm/providers/openai'
+require_relative 'ruby_llm/providers/anthropic'

lib/ruby_llm/client.rb

@@ -5,26 +5,25 @@ module RubyLLM
   class Client
     def initialize
       @providers = {}
-      @conversations = {}
     end
 
-    def chat(messages, model: nil, temperature: 0.7, 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)
       provider.chat(
-        messages,
+        formatted_messages,
         model: model,
         temperature: temperature,
         stream: stream,
+        tools: tools,
         &block
       )
     end
 
-    def create_conversation(tools: [])
-      conversation = Conversation.new(tools: tools)
-      @conversations[conversation.id] = conversation
-      conversation
-    end
-
     private
 
     def provider_for(model)