ruby_llm-providers-apfel 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 691f6aca0f671994fe947ed562e4b35720453513152f8b5d959023266679bc97
-  data.tar.gz: 87e2c3d286eb1e31575cfc661a66f95015a36fc5f5a39ed02404e82925a86043
+  metadata.gz: a8e88420fe62866b9da1771c2e574267f9e6ee8a31638b3b4731d490714c94f4
+  data.tar.gz: 8aa4dd1476384cad4b1330634d19da240a619e4c8add5a68d040e24d6278885c
 SHA512:
-  metadata.gz: 6db0f5d2633e80c9897733b133b77fdd472dfad063449a4b10361788ae2b7192649f8a440922a926c1404025b7654301c2291bbb8c9124fbd352d0831c742d3c
-  data.tar.gz: 3178067325ab285c5b62e8bd1e78ed32c65990b9fbd509ed4b8a0cabcf06dedebe83f4db8b21850da37b71a43498dd3d69265ceb30a100cd498c6e77c1e7a835
+  metadata.gz: 80e08d7afcfab3104c5dd001f710f61d428279b101a5eab8b90c760b24ea7a11855280c68004474e2fc5ccbda49174569116aa9b5a57952429bf070a3aaa634e
+  data.tar.gz: '0964193abab2e686630ecc6c59d7a7013c941cf3c2dcdeef84ebdd781862c9254841bce5891c5e35296038a9236b2ba1f0c8a73f22cddfc8ed51561beb573239'

data/.github/workflows/ci.yml

@@ -16,7 +16,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ["3.1", "3.2", "3.3", "3.4", "4.0"]
+        # Non-EOL Rubies only; must match the gemspec's required_ruby_version.
+        ruby-version: ["3.3", "3.4", "4.0"]
     steps:
       - uses: actions/checkout@v6
 
@@ -26,7 +27,3 @@ jobs:
           bundler-cache: true
 
       - run: bundle exec rake
-        if: matrix.ruby-version != '3.1'
-
-      - run: bundle exec rake rubocop flay spec
-        if: matrix.ruby-version == '3.1'

data/.rubocop.yml

@@ -5,7 +5,7 @@ plugins:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
   Exclude:
     - Archspec.rb
     - vendor/**/*

data/README.md

@@ -41,21 +41,24 @@ Add this line to your application's Gemfile:
 gem 'ruby_llm-providers-apfel', require: 'ruby_llm/providers/apfel'
 ```
 
-Then configure the provider to point at your local Apfel server:
+The provider works out of the box against Apfel's default address
+(`http://127.0.0.1:11434/v1`) with no API key, so no configuration is required:
 
 ```ruby
 require 'ruby_llm/providers/apfel'
+```
+
+Configure it only to override the defaults:
 
+```ruby
 RubyLLM.configure do |config|
-  config.apfel_api_base = ENV.fetch('APFEL_API_BASE', 'http://127.0.0.1:11434/v1')
+  # Only needed when the server listens somewhere else
+  config.apfel_api_base = ENV.fetch('APFEL_API_BASE', nil)
   # Only needed if you started `apfel --serve --token <value>`
-  config.apfel_api_key = ENV['APFEL_API_KEY']
+  config.apfel_api_key = ENV.fetch('APFEL_API_KEY', nil)
 end
 ```
 
-Since Apfel runs locally with no API key required, `apfel_api_key` can be left unset unless you
-started the server with `--token`.
-
 ## Usage
 
 ```ruby

data/lib/ruby_llm/providers/apfel/version.rb

@@ -5,7 +5,7 @@ module RubyLLM
     # Version of the ruby_llm-providers-apfel gem. Kept in its own file so the
     # gemspec can read the literal without loading the provider.
     class Apfel < Provider
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
 
       def self.version
         VERSION

data/lib/ruby_llm/providers/apfel.rb

@@ -6,8 +6,14 @@ require 'ruby_llm/providers/apfel/connection_guard'
 
 module RubyLLM
   module Providers
-    # Apfel API integration.
+    # Apfel — Apple's on-device Foundation Model (AFM) exposed as a local
+    # OpenAI-compatible server by the `apfel` CLI (`apfel --serve`).
+    # Works out of the box against http://127.0.0.1:11434/v1 — no API key
+    # required (set apfel_api_key only when the server was started with
+    # `apfel --serve --token <value>`).
     class Apfel < Provider
+      DEFAULT_API_BASE = 'http://127.0.0.1:11434/v1'
+
       # Apfel's ChatCompletions protocol.
       class ChatCompletions < Protocols::ChatCompletions
         def models_url
@@ -23,10 +29,12 @@ module RubyLLM
       end
 
       def api_base
-        @config.apfel_api_base || 'https://api.example.com/v1'
+        @config.apfel_api_base || DEFAULT_API_BASE
       end
 
       def headers
+        return {} unless @config.apfel_api_key
+
         { 'Authorization' => "Bearer #{@config.apfel_api_key}" }
       end
 
@@ -36,7 +44,11 @@ module RubyLLM
         end
 
         def configuration_requirements
-          %i[apfel_api_key]
+          []
+        end
+
+        def local?
+          true
         end
 
         # Use this only when the provider has no model-listing endpoint.

data/spec/ruby_llm/providers/apfel_spec.rb

@@ -22,11 +22,30 @@ RSpec.describe RubyLLM::Providers::Apfel do
 
   it 'declares provider configuration' do
     expect(described_class.configuration_options).to eq(%i[apfel_api_key apfel_api_base])
-    expect(described_class.configuration_requirements).to eq(%i[apfel_api_key])
+  end
+
+  it 'requires no configuration — Apfel runs locally without an API key' do
+    expect(described_class.configuration_requirements).to eq([])
+  end
+
+  it 'is a local provider' do
+    expect(described_class.local?).to be(true)
   end
 
   it 'uses configured API base and bearer token' do
     expect(provider.api_base).to eq('https://example.test/v1')
     expect(provider.headers).to eq('Authorization' => 'Bearer test-key')
   end
+
+  context 'without any configuration' do
+    let(:config) { RubyLLM::Configuration.new }
+
+    it 'defaults to the local apfel server' do
+      expect(provider.api_base).to eq('http://127.0.0.1:11434/v1')
+    end
+
+    it 'sends no Authorization header when no token is configured' do
+      expect(provider.headers).to eq({})
+    end
+  end
 end

data/spec/support/rubyllm_configuration.rb

@@ -3,8 +3,8 @@
 RSpec.shared_context 'with configured RubyLLM' do
   before do
     RubyLLM.configure do |config|
-      config.apfel_api_key = ENV.fetch('APFEL_API_KEY', 'test')
-      config.apfel_api_base = ENV.fetch('APFEL_API_BASE', 'https://api.example.com/v1')
+      config.apfel_api_key = ENV.fetch('APFEL_API_KEY', nil)
+      config.apfel_api_base = ENV.fetch('APFEL_API_BASE', RubyLLM::Providers::Apfel::DEFAULT_API_BASE)
       config.max_retries = 0
       config.retry_backoff_factor = 0
       config.retry_interval = 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-providers-apfel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - madbomber
@@ -35,7 +35,6 @@ files:
 - ".flayignore"
 - ".github/workflows/ci.yml"
 - ".github/workflows/gitleaks.yml"
-- ".github/workflows/release.yml"
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -77,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/release.yml

@@ -1,36 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - "v*"
-
-permissions:
-  contents: read
-
-jobs:
-  publish:
-    name: Build and publish
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.4"
-          bundler-cache: true
-
-      - run: bundle exec rake
-
-      - name: Build gem
-        run: gem build ruby_llm-providers-apfel.gemspec
-
-      - name: Publish to RubyGems
-        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 push ruby_llm-providers-apfel-*.gem
-        env:
-          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}