ruby_llm 1.0.1 → 1.1.0rc2

data/.github/workflows/cicd.yml

@@ -1,158 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ "main" ]
-    paths:
-      - 'lib/**'
-      - 'spec/**'
-      - 'Gemfile'
-      - 'Rakefile'
-      - 'ruby_llm.gemspec'
-      - '.github/workflows/cicd.yml'
-  pull_request:
-    branches: [ "main" ]
-    paths:
-      - 'lib/**'
-      - 'spec/**'
-      - 'Gemfile'
-      - 'Rakefile'
-      - 'ruby_llm.gemspec'
-      - '.github/workflows/cicd.yml'
-  workflow_call:
-
-# Define default permissions for this workflow
-permissions:
-  contents: read
-  packages: write  # Needed for publishing to GitHub Packages
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['3.1']
-
-    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
-      env:
-        # For PRs, we use VCR cassettes
-        # For main branch, we use real API keys for verification
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-        ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-        GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
-        DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
-      run: bundle exec rspec
-
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v5
-      env:
-        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-      with:
-        files: ./coverage/coverage.xml
-        fail_ci_if_error: false
-
-  publish:
-    name: Build + Publish
-    needs: test
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '3.3'
-        bundler-cache: true
-
-    - name: Check if version has changed
-      id: check_version
-      run: |
-        VERSION=$(ruby -r ./lib/ruby_llm/version.rb -e "puts RubyLLM::VERSION")
-        echo "Current version: $VERSION"
-
-        # Try to fetch from RubyGems
-        PUBLISHED_VERSION=$(gem list ruby_llm -r | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+' || echo "0.0.0")
-        echo "Published version: $PUBLISHED_VERSION"
-
-        if [ "$VERSION" = "$PUBLISHED_VERSION" ]; then
-          echo "Version has not changed, skipping publish"
-          echo "version_changed=false" >> $GITHUB_OUTPUT
-        else
-          echo "Version has changed from $PUBLISHED_VERSION to $VERSION"
-          echo "version_changed=true" >> $GITHUB_OUTPUT
-        fi
-
-    - name: Test with real APIs before publishing
-      if: steps.check_version.outputs.version_changed == 'true'
-      run: |
-        echo "Removing all VCR cassettes to test against real APIs..."
-        rm -rf spec/fixtures/vcr_cassettes
-
-        echo "Running tests with real API calls..."
-        env -u CI bundle exec rspec
-      env:
-        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-        ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-        GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
-        DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
-
-    - name: Publish to GPR
-      if: steps.check_version.outputs.version_changed == 'true'
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        output=$(gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem 2>&1) || {
-          echo "$output"
-          if echo "$output" | grep -q "already been pushed"; then
-            echo "Version already exists, skipping"
-            exit 0
-          else
-            exit 1
-          fi
-        }
-      env:
-        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-        OWNER: ${{ github.repository_owner }}
-
-    - name: Publish to RubyGems
-      if: steps.check_version.outputs.version_changed == 'true'
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        output=$(gem push *.gem 2>&1) || {
-          echo "$output"
-          if echo "$output" | grep -q "Repushing of gem versions is not allowed"; then
-            echo "Version already exists, skipping"
-            exit 0
-          else
-            exit 1
-          fi
-        }
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/docs.yml

@@ -1,53 +0,0 @@
-name: Deploy docs
-
-on:
-  push:
-    branches: [main]
-    paths:
-      - 'docs/**'
-      - '.github/workflows/docs.yml'
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.3'
-          bundler-cache: true
-          working-directory: docs
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
-      - name: Build with Jekyll
-        working-directory: docs
-        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
-        env:
-          JEKYLL_ENV: production
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/_site
-
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4

data/.gitignore

@@ -1,59 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-.rspec_status
-
-# 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.*

data/.overcommit.yml

@@ -1,26 +0,0 @@
-PreCommit:
-  RuboCop:
-    enabled: true
-    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

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

data/.rubocop.yml

@@ -1,10 +0,0 @@
-plugins:
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.1
-  Exclude:
-    - docs/**/*
-    - vendor/**/*

data/.yardopts

@@ -1,12 +0,0 @@
---markup markdown
---markup-provider redcarpet
---title "RubyLLM API Documentation"
---protected
---private
---embed-mixins
---output-dir doc/yard
---readme README.md
-lib/**/*.rb
--
-LICENSE
-

data/CONTRIBUTING.md

@@ -1,207 +0,0 @@
-# Contributing to RubyLLM
-
-First off, thank you for considering contributing to RubyLLM! It's people like you that make RubyLLM such a great tool.
-
-## Development Setup
-
-Here's how to get started:
-
-```bash
-# Clone the repository
-gh repo clone crmne/ruby_llm
-cd ruby_llm
-
-# Install dependencies
-bundle install
-
-# Set up git hooks
-overcommit --install
-
-# Run the tests (uses VCR cassettes)
-bundle exec rspec
-```
-
-## Development Workflow
-
-We recommend using GitHub CLI to simplify the workflow:
-
-```bash
-# Create a new branch for your feature
-gh repo fork crmne/ruby_llm --clone
-cd ruby_llm
-
-# Find or make an issue for the feature on GitHub and then:
-gh issue develop 123 --checkout  # Substitute 123 with the issue number
-
-# Make your changes and test them
-# ...
-
-# Commit your changes
-git commit
-
-# Create a PR
-gh pr create --web
-```
-
-## Model Naming Convention & Provider Strategy
-
-When adding new providers to RubyLLM, please follow these guidelines:
-
-### Normalized Model IDs
-
-We use a consistent approach separating **what** (model) from **where** (provider):
-
-```ruby
-# Default way (from the native provider)
-chat = RubyLLM.chat(model: "claude-3-5-sonnet")
-
-# Same model via different provider
-chat = RubyLLM.chat(model: "claude-3-5-sonnet", provider: :bedrock)
-```
-
-### Implementing a Provider
-
-If you're adding a new provider:
-
-1. **Use normalized model IDs** - Don't include provider prefixes in the model ID itself
-2. **Add provider mapping** - Map the normalized IDs to your provider's specific format internally
-3. **Preserve capabilities** - Ensure models accessed through your provider report the same capabilities as their native counterparts
-4. **Update models.json** - Include your provider's models in models.json
-5. **Update aliases.json** - Add entries to aliases.json for models accessible through your provider
-6. **Implement refresh mechanism** - Ensure your provider supports the `list_models` method for refreshing
-
-### Model Aliases
-
-For providers that use complex model identifiers (like Bedrock's `anthropic.claude-3-5-sonnet-20241022-v2:0:200k`), add mappings to the global aliases.json file:
-
-```json
-{
-  "claude-3-5-sonnet": {
-    "anthropic": "claude-3-5-sonnet-20241022",
-    "bedrock": "anthropic.claude-3-5-sonnet-20241022-v2:0:200k",
-    "openrouter": "anthropic/claude-3.5-sonnet"
-  },
-  "gpt-4o": {
-    "openai": "gpt-4o-2024-05-13",
-    "bedrock": "anthropic.gpt-4o-2024-05-13",
-    "openrouter": "openai/gpt-4o"
-  }
-}
-```
-
-If a model can't be found with the provided ID and provider, a `ModelNotFoundError` will be raised with an informative message. Your implementation should make this error helpful by suggesting available alternatives.
-
-When the same model has multiple versions and context windows e.g.
-
-```
-anthropic.claude-3-5-sonnet-20240620-v1:0
-anthropic.claude-3-5-sonnet-20240620-v1:0:18k
-anthropic.claude-3-5-sonnet-20240620-v1:0:200k
-anthropic.claude-3-5-sonnet-20240620-v1:0:51k
-anthropic.claude-3-5-sonnet-20241022-v2:0
-anthropic.claude-3-5-sonnet-20241022-v2:0:18k
-anthropic.claude-3-5-sonnet-20241022-v2:0:200k
-anthropic.claude-3-5-sonnet-20241022-v2:0:51k
-```
-
-We default all aliases to the biggest context window, and the main alias (without date) to the latest version:
-
-```json
-  "claude-3-5-sonnet": {
-    "anthropic": "claude-3-5-sonnet-20241022",
-    "bedrock": "anthropic.claude-3-5-sonnet-20241022-v2:0:200k",
-    "openrouter": "anthropic/claude-3.5-sonnet"
-  },
-  "claude-3-5-sonnet-20241022": {
-    "anthropic": "claude-3-5-sonnet-20241022",
-    "bedrock": "anthropic.claude-3-5-sonnet-20241022-v2:0:200k",
-    "openrouter": "anthropic/claude-3.5-sonnet"
-  },
-  "claude-3-5-sonnet-20240620": {
-    "anthropic": "claude-3-5-sonnet-20240620",
-    "bedrock": "anthropic.claude-3-5-sonnet-20240620-v1:0:200k"
-  },
-```
-
-## Running Tests
-
-Tests automatically use VCR to record and replay HTTP interactions, so you don't need real API keys for testing:
-
-```bash
-# Run all tests (using existing VCR cassettes)
-bundle exec rspec
-
-# Run a specific test file
-bundle exec rspec spec/ruby_llm/chat_spec.rb
-```
-
-### Recording VCR Cassettes
-
-When you make changes that affect API interactions, you can record new VCR cassettes.
-
-If you have keys for all providers:
-
-```bash
-# Re-record all cassettes
-bundle exec rake vcr:record[all]
-```
-
-If you only have keys for specific providers (e.g., just OpenAI):
-
-```bash
-# Set the API keys you have
-export OPENAI_API_KEY=your_openai_key
-
-# Find and remove only cassettes for OpenAI, then run tests to re-record them
-bundle exec rake vcr:record[openai]
-
-# You can also specify multiple providers
-bundle exec rake vcr:record[openai,anthropic]
-```
-
-Important: After recording new cassettes, please **manually check** them for any sensitive information that might have been missed by the automatic filters.
-
-## Adding New Tests
-
-Tests automatically create VCR cassettes based on their descriptions, so make sure your test descriptions are unique and descriptive.
-
-## Coding Style
-
-We follow the [Standard Ruby](https://github.com/testdouble/standard) style. Please ensure your contributions adhere to this style.
-
-```bash
-# Check your code style
-bundle exec rubocop
-
-# Auto-fix style issues where possible
-bundle exec rubocop -A
-```
-
-## Documentation
-
-When adding new features, please include documentation updates:
-
-- Update relevant guides in the `docs/guides/` directory
-- Add inline documentation using YARD comments
-- Keep the README clean and focused on helping new users get started quickly
-
-## Philosophy
-
-RubyLLM follows certain design philosophies and conventions. Please refer to our [Philosophy Guide](https://rubyllm.com/philosophy) to ensure your contributions align with the project's vision.
-
-## Discussions and Issues
-
-- For questions and discussions, please use [GitHub Discussions](https://github.com/crmne/ruby_llm/discussions)
-- For bugs and feature requests, please use [GitHub Issues](https://github.com/crmne/ruby_llm/issues)
-
-## Release Process
-
-Gem versioning follows [Semantic Versioning](https://semver.org/):
-
-1. MAJOR version for incompatible API changes
-2. MINOR version for backwards-compatible functionality
-3. PATCH version for backwards-compatible bug fixes
-
-Releases are handled by the maintainers through the CI/CD pipeline.
-
-Thanks for helping make RubyLLM better!

data/Gemfile

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  # Rails integration dependencies
-  gem 'activerecord', '>= 6.0', '< 9.0'
-  gem 'activesupport', '>= 6.0', '< 9.0'
-
-  # Development dependencies
-  gem 'bundler', '>= 2.0'
-  gem 'codecov'
-  gem 'dotenv'
-  gem 'irb'
-  gem 'nokogiri'
-  gem 'overcommit', '>= 0.66'
-  gem 'pry', '>= 0.14'
-  gem 'rake', '>= 13.0'
-  gem 'rdoc'
-  gem 'reline'
-  gem 'rspec', '~> 3.12'
-  gem 'rubocop', '>= 1.0'
-  gem 'rubocop-rake', '>= 0.6'
-  gem 'rubocop-rspec'
-  gem 'simplecov', '>= 0.21'
-  gem 'simplecov-cobertura'
-  gem 'sqlite3'
-  gem 'vcr'
-  gem 'webmock', '~> 3.18'
-  gem 'yard', '>= 0.9'
-end

data/Rakefile

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rake/clean'
-
-Dir.glob('lib/tasks/**/*.rake').each { |r| load r }
-
-task default: %w[build]

data/bin/console

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'ruby_llm'
-require 'dotenv/load'
-
-require 'irb'
-
-RubyLLM.configure do |config|
-  config.openai_api_key = ENV.fetch('OPENAI_API_KEY', nil)
-  config.anthropic_api_key = ENV.fetch('ANTHROPIC_API_KEY', nil)
-  config.gemini_api_key = ENV.fetch('GEMINI_API_KEY', nil)
-  config.deepseek_api_key = ENV.fetch('DEEPSEEK_API_KEY', nil)
-end
-
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/ruby_llm.gemspec

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/ruby_llm/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'ruby_llm'
-  spec.version       = RubyLLM::VERSION
-  spec.authors       = ['Carmine Paolino']
-  spec.email         = ['carmine@paolino.me']
-
-  spec.summary       = 'Beautiful Ruby interface to modern AI'
-  spec.description   = 'A delightful Ruby way to work with AI. Chat in text, analyze and generate images, understand ' \
-                       'audio, and use tools through a unified interface to OpenAI, Anthropic, Google, and DeepSeek. ' \
-                       'Built for developer happiness with automatic token counting, proper streaming, and Rails ' \
-                       'integration. No wrapping your head around multiple APIs - just clean Ruby code that works.'
-  spec.homepage      = 'https://rubyllm.com'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.0')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/crmne/ruby_llm'
-  spec.metadata['changelog_uri'] = "#{spec.metadata['source_code_uri']}/commits/main"
-  spec.metadata['documentation_uri'] = spec.homepage
-  spec.metadata['bug_tracker_uri'] = "#{spec.metadata['source_code_uri']}/issues"
-
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # 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(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Runtime dependencies
-  spec.add_dependency 'base64'
-  spec.add_dependency 'event_stream_parser', '~> 1'
-  spec.add_dependency 'faraday', '~> 2'
-  spec.add_dependency 'faraday-multipart', '~> 1'
-  spec.add_dependency 'faraday-retry', '~> 2'
-  spec.add_dependency 'zeitwerk', '~> 2'
-end