ask-llm-providers 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f67f89691195dda7f5119ee70567669cd823d76c0c5217e686314194d01ac14
-  data.tar.gz: 214aa37bd2027d77634fbae6781748bbe48774e57cdc8881b32156af431b0515
+  metadata.gz: 83d9430295753c63779ef81db7fbbc4e9c56c3e1848f44e53a763c70c43cc1f8
+  data.tar.gz: a9ea83f80669da1e5869204a42af7bc52e071d81f355da80df26002246d3b828
 SHA512:
-  metadata.gz: ca101bc63e0132be44fe4c21ff87768ddb961fded211ee1a471f276aef7d04717b8afb4a1b54bcf4d849513317f07bc6f3bd71e68a72a0ea3f71bf9f0e26baca
-  data.tar.gz: c7985c3ebd71b7b628510c75cf8b5b1cfc4901ff9de8051de5f5244698c215f003f91a2c69d9f419601612e13af5dde49270e94ca654a46067d82b196125d131
+  metadata.gz: 870a8543f6810948e62f65b18b39f0924a78ec393108f74e992ecff25cfe8e14ae8331d287d436afdb88f3792379c778598b3188642c4c5a002bb374f56a0c8e
+  data.tar.gz: 211593c5668424aab22e2f03c6230d6ad791a4f7f6002b60b8e26e879f2ae8d6e28782b29790611c796c8fa2d0edab1494e1a9d61ec638a4b78fde1fbba639a2

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.5.0] — 2026-07-17
+
+### Added
+
+- **OpenAI-compatible provider registry** (`Ask::LLM::OPENAI_COMPATIBLE`) — 12 providers defined as data, not classes. Adding a new OpenAI-compatible API (Groq, Together, Fireworks, etc.) is one line in the registry. No new file, no subclass.
+- **`Ask::Providers::OpenAICompatible` class** — single class handling all registered providers by reading from the registry. Each provider gets an anonymous subclass with its slug, api_base, env var mapping, and quirks (reasoning_content, extra_headers) set from config.
+- **Unified test** — `OpenAICompatibleTest` dynamically tests every registered provider: identity, slug, capabilities, api_base, env var resolution, request building, response parsing, streaming, and tool formatting.
+
+### Removed
+
+- **5 subclass files** — `deepseek.rb`, `openrouter.rb`, `opencode.rb`, `opencode_go.rb`, `mimo.rb` deleted. Replaced by registry entries.
+- **DeepSeek-specific test file** — covered by the unified test.
+
 ## [0.4.0] — 2026-07-16
 
 ### Added

data/lib/ask/llm/openai_compatible.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Ask
+  module LLM
+    # Registry of OpenAI-compatible providers (data, not classes).
+    #
+    # Each entry is configuration for {Ask::Providers::OpenAICompatible}.
+    # To add a new provider, add one line here — no new file, no subclass.
+    #
+    # @example Adding Groq
+    #   groq: { api_base: "https://api.groq.com/openai/v1", api_key_env: "GROQ_API_KEY" }
+    #
+    OPENAI_COMPATIBLE = {
+      deepseek:    { api_base: "https://api.deepseek.com",                      api_key_env: "DEEPSEEK_API_KEY",
+                     reasoning_content: true,
+                     capabilities: { chat: true, streaming: true, tool_calls: true, thinking: true } },
+
+      openrouter:  { api_base: "https://openrouter.ai/api/v1",                  api_key_env: "OPENROUTER_API_KEY",
+                     extra_headers: { "HTTP-Referer" => "https://github.com/ask-rb",
+                                      "X-Title" => "ask-rb" },
+                     capabilities: { chat: true, streaming: true, tool_calls: true, vision: true,
+                                     thinking: true, structured_output: true } },
+
+      opencode:    { api_base: "https://opencode.ai/zen/v1",                    api_key_env: "OPENCODE_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true } },
+
+      opencode_go: { api_base: "https://opencode.ai/zen/go/v1",                 api_key_env: "OPENCODE_GO_API_KEY",
+                     alternate_env: "OPENCODE_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true } },
+
+      mimo:        { api_base: "https://token-plan-sgp.xiaomimimo.com/v1",      api_key_env: "MIMO_API_KEY",
+                     capabilities: { chat: true, streaming: true } },
+
+      groq:        { api_base: "https://api.groq.com/openai/v1",                api_key_env: "GROQ_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true, vision: true } },
+
+      together:    { api_base: "https://api.together.xyz/v1",                   api_key_env: "TOGETHER_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true } },
+
+      fireworks:   { api_base: "https://api.fireworks.ai/inference/v1",         api_key_env: "FIREWORKS_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true } },
+
+      perplexity:  { api_base: "https://api.perplexity.ai",                     api_key_env: "PERPLEXITY_API_KEY",
+                     capabilities: { chat: true, streaming: true } },
+
+      cerebras:    { api_base: "https://api.cerebras.ai/v1",                    api_key_env: "CEREBRAS_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true } },
+
+      xai:         { api_base: "https://api.x.ai/v1",                           api_key_env: "XAI_API_KEY",
+                     capabilities: { chat: true, streaming: true, tool_calls: true, vision: true,
+                                     thinking: true } },
+
+      moonshot:    { api_base: "https://api.moonshot.ai/v1",                    api_key_env: "MOONSHOT_API_KEY",
+                     capabilities: { chat: true, streaming: true } }
+    }.freeze
+  end
+end

data/lib/ask/llm/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module LLM
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/ask/provider/openai_compatible.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Ask
+  module Providers
+    # Single class for all OpenAI-compatible providers.
+    #
+    # Reads its behavior from {Ask::LLM::OPENAI_COMPATIBLE} via the class-level
+    # +compat_config+ that gets set at registration time. Each registered
+    # provider is an anonymous subclass with its own compat_config.
+    #
+    # This eliminates one subclass file per provider — adding a new
+    # OpenAI-compatible API is a one-line config entry.
+    class OpenAICompatible < Ask::Providers::OpenAI
+      class << self
+        attr_reader :compat_config
+
+        def slug
+          compat_config[:slug].to_s
+        end
+
+        def capabilities
+          compat_config[:capabilities] || { chat: true, streaming: true, tool_calls: true }
+        end
+
+        def configuration_options
+          %i[api_key base_url]
+        end
+
+        def configuration_requirements
+          %i[api_key]
+        end
+
+        def configured?(config)
+          key = config.respond_to?(:api_key) ? config.api_key : nil
+          key ||= ENV[compat_config[:api_key_env].to_s]
+          key ||= ENV[compat_config[:alternate_env].to_s] if compat_config[:alternate_env]
+          key.to_s.length > 0
+        end
+
+        def assume_models_exist?
+          false
+        end
+      end
+
+      def initialize(config = {})
+        @compat_cfg = self.class.compat_config || {}
+        config = normalize_compat_config(config)
+        super(config)
+      end
+
+      def api_base
+        @config.base_url || @compat_cfg[:api_base] || super
+      end
+
+      def headers
+        h = { "Content-Type" => "application/json" }
+        key = @config.api_key
+        h["Authorization"] = "Bearer #{key}" if key
+        if (extra = @compat_cfg[:extra_headers])
+          extra.each { |k, v| h[k] = v }
+        end
+        h
+      end
+
+      def format_messages(messages)
+        result = super
+        if @compat_cfg[:reasoning_content]
+          result.each { |fm| fm[:reasoning_content] ||= "" if fm[:role] == "assistant" && fm[:tool_calls] }
+        end
+        result
+      end
+
+      private
+
+      def normalize_compat_config(config)
+        return config unless config.is_a?(Hash)
+
+        slug = self.class.slug
+        api_key = config[:api_key] || config["api_key"] ||
+                  config[:"#{slug}_api_key"] ||
+                  ENV[@compat_cfg[:api_key_env].to_s] ||
+                  (ENV[@compat_cfg[:alternate_env].to_s] if @compat_cfg[:alternate_env]) ||
+                  ENV["#{slug.upcase}_API_KEY"]
+
+        base_url = config[:base_url] || config["base_url"] ||
+                   ENV["#{slug.upcase}_API_BASE"] ||
+                   @compat_cfg[:api_base]
+
+        Ask::LLM::Config.new(api_key:, base_url:)
+      end
+    end
+  end
+end

data/lib/ask-llm-providers.rb

@@ -17,21 +17,20 @@ require_relative "ask/llm/aliases"
 # Provider transformation contract
 require_relative "ask/llm/provider_config"
 
+# OpenAI-compatible provider registry (data, not classes)
+require_relative "ask/llm/openai_compatible"
+
 # Load providers
 require_relative "ask/provider/openai"
+require_relative "ask/provider/openai_compatible"
 require_relative "ask/provider/anthropic"
 require_relative "ask/provider/google"
 require_relative "ask/provider/bedrock"
 require_relative "ask/provider/ollama"
 require_relative "ask/provider/mistral"
 require_relative "ask/provider/cloudflare"
-require_relative "ask/provider/opencode"
-require_relative "ask/provider/opencode_go"
-require_relative "ask/provider/mimo"
-require_relative "ask/provider/deepseek"
-require_relative "ask/provider/openrouter"
 
-# Register providers with the Ask::Provider registry
+# Register canonical providers
 Ask::Provider.register(:openai, Ask::Providers::OpenAI)
 Ask::Provider.register(:anthropic, Ask::Providers::Anthropic)
 Ask::Provider.register(:gemini, Ask::Providers::Google)
@@ -39,11 +38,13 @@ Ask::Provider.register(:bedrock, Ask::Providers::Bedrock)
 Ask::Provider.register(:ollama, Ask::Providers::Ollama)
 Ask::Provider.register(:mistral, Ask::Providers::Mistral)
 Ask::Provider.register(:cloudflare, Ask::Providers::Cloudflare)
-Ask::Provider.register(:opencode, Ask::Providers::OpenCode)
-Ask::Provider.register(:opencode_go, Ask::Providers::OpenCodeGo)
-Ask::Provider.register(:mimo, Ask::Providers::Mimo)
-Ask::Provider.register(:deepseek, Ask::Providers::DeepSeek)
-Ask::Provider.register(:openrouter, Ask::Providers::OpenRouter)
+
+# Register OpenAI-compatible providers from the registry (data → classes)
+Ask::LLM::OPENAI_COMPATIBLE.each do |name, cfg|
+  klass = Class.new(Ask::Providers::OpenAICompatible)
+  klass.define_singleton_method(:compat_config) { cfg.merge(slug: name.to_s) }
+  Ask::Provider.register(name, klass)
+end
 
 # Load bundled model catalog into Ask::ModelCatalog
 Ask::LLM::Catalog.load!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-llm-providers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kaka Ruto
@@ -194,21 +194,18 @@ files:
 - lib/ask/llm/models/opencode_go.json
 - lib/ask/llm/models/openrouter.json
 - lib/ask/llm/models_schema.json
+- lib/ask/llm/openai_compatible.rb
 - lib/ask/llm/provider_config.rb
 - lib/ask/llm/sse_buffer.rb
 - lib/ask/llm/version.rb
 - lib/ask/provider/anthropic.rb
 - lib/ask/provider/bedrock.rb
 - lib/ask/provider/cloudflare.rb
-- lib/ask/provider/deepseek.rb
 - lib/ask/provider/google.rb
-- lib/ask/provider/mimo.rb
 - lib/ask/provider/mistral.rb
 - lib/ask/provider/ollama.rb
 - lib/ask/provider/openai.rb
-- lib/ask/provider/opencode.rb
-- lib/ask/provider/opencode_go.rb
-- lib/ask/provider/openrouter.rb
+- lib/ask/provider/openai_compatible.rb
 - lib/ask/skills/providers.model_select/SKILL.md
 homepage: https://github.com/ask-rb/ask-llm-providers
 licenses:

data/lib/ask/provider/deepseek.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Providers
-    # DeepSeek API — an OpenAI-compatible provider at api.deepseek.com.
-    # Supports DeepSeek V2, V3, V4 Chat, R1 reasoning, and all DeepSeek models
-    # via the OpenAI-compatible endpoint.
-    #
-    # Configuration via environment:
-    #   DEEPSEEK_API_KEY  — required, your DeepSeek API key
-    #   DEEPSEEK_API_BASE — optional, base URL (default: https://api.deepseek.com)
-    class DeepSeek < OpenAI
-      def api_base
-        @config.base_url || ENV["DEEPSEEK_API_BASE"] || "https://api.deepseek.com"
-      end
-
-      def headers
-        key = @config.api_key || ENV["DEEPSEEK_API_KEY"]
-        h = { "Content-Type" => "application/json" }
-        h["Authorization"] = "Bearer #{key}" if key
-        h
-      end
-
-      # DeepSeek requires reasoning_content in every assistant message
-      # that includes tool_calls. Override format_messages to inject it.
-      def format_messages(messages)
-        super.map do |fm|
-          if fm[:role] == "assistant" && fm[:tool_calls]
-            fm[:reasoning_content] = fm[:reasoning_content] || ""
-          end
-          fm
-        end
-      end
-
-      class << self
-        def slug; "deepseek"; end
-        def configuration_options; %i[api_key base_url]; end
-        def configuration_requirements; %i[api_key]; end
-        def configured?(config)
-          key = config.respond_to?(:api_key) ? config.api_key : nil
-          key ||= ENV["DEEPSEEK_API_KEY"]
-          key.to_s.length > 0
-        end
-      end
-    end
-  end
-end

data/lib/ask/provider/mimo.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Providers
-    # Mimo API — an OpenAI-compatible provider
-    class Mimo < OpenAI
-      def api_base
-        @config.base_url || ENV["MIMO_API_BASE"] || "https://token-plan-sgp.xiaomimimo.com/v1"
-      end
-
-      def headers
-        key = @config.api_key || ENV["MIMO_API_KEY"]
-        h = { "Content-Type" => "application/json" }
-        h["Authorization"] = "Bearer #{key}" if key
-        h
-      end
-
-      class << self
-        def slug; "mimo"; end
-        def configuration_options; %i[api_key base_url]; end
-        def configuration_requirements; %i[api_key]; end
-        def configured?(config)
-          key = config.respond_to?(:api_key) ? config.api_key : nil
-          key ||= ENV["MIMO_API_KEY"]
-          key.to_s.length > 0
-        end
-      end
-    end
-  end
-end

data/lib/ask/provider/opencode.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Providers
-    # OpenCode API — an OpenAI-compatible provider at opencode.ai
-    class OpenCode < OpenAI
-      def api_base
-        @config.base_url || ENV["OPENCODE_API_BASE"] || "https://opencode.ai/zen/v1"
-      end
-
-      def headers
-        key = @config.api_key || ENV["OPENCODE_API_KEY"]
-        h = { "Content-Type" => "application/json" }
-        h["Authorization"] = "Bearer #{key}" if key
-        h
-      end
-
-      class << self
-        def slug; "opencode"; end
-        def configuration_options; %i[api_key base_url]; end
-        def configuration_requirements; %i[api_key]; end
-        def configured?(config)
-          key = config.respond_to?(:api_key) ? config.api_key : nil
-          key ||= ENV["OPENCODE_API_KEY"]
-          key.to_s.length > 0
-        end
-      end
-    end
-  end
-end

data/lib/ask/provider/opencode_go.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Providers
-    # OpenCode Go API — an OpenAI-compatible provider at opencode.ai/zen/go
-    class OpenCodeGo < OpenAI
-      def api_base
-        @config.base_url || ENV["OPENCODE_GO_API_BASE"] || "https://opencode.ai/zen/go/v1"
-      end
-
-      def headers
-        key = @config.api_key || ENV["OPENCODE_API_KEY"] || ENV["OPENCODE_GO_API_KEY"]
-        h = { "Content-Type" => "application/json" }
-        h["Authorization"] = "Bearer #{key}" if key
-        h
-      end
-
-      class << self
-        def slug; "opencode_go"; end
-        def configuration_options; %i[api_key base_url]; end
-        def configuration_requirements; %i[api_key]; end
-        def configured?(config)
-          key = config.respond_to?(:api_key) ? config.api_key : nil
-          key ||= ENV["OPENCODE_API_KEY"] || ENV["OPENCODE_GO_API_KEY"]
-          key.to_s.length > 0
-        end
-      end
-    end
-  end
-end

data/lib/ask/provider/openrouter.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Ask
-  module Providers
-    # OpenRouter API — an OpenAI-compatible aggregator at openrouter.ai.
-    # Provides access to many models through a single endpoint.
-    #
-    # Configuration via environment:
-    #   OPENROUTER_API_KEY  — required, your OpenRouter API key
-    #   OPENROUTER_API_BASE — optional, base URL (default: https://openrouter.ai/api/v1)
-    class OpenRouter < OpenAI
-      def api_base
-        @config.base_url || ENV["OPENROUTER_API_BASE"] || "https://openrouter.ai/api/v1"
-      end
-
-      def headers
-        h = super
-        key = @config.api_key || ENV["OPENROUTER_API_KEY"]
-        h["Authorization"] = "Bearer #{key}" if key
-        h["HTTP-Referer"] = ENV["OPENROUTER_REFERER"] || "https://github.com/ask-rb"
-        h["X-Title"] = ENV["OPENROUTER_APP_TITLE"] || "ask-rb"
-        h
-      end
-
-      class << self
-        def slug; "openrouter"; end
-        def configuration_options; %i[api_key base_url]; end
-        def configuration_requirements; %i[api_key]; end
-        def configured?(config)
-          key = config.respond_to?(:api_key) ? config.api_key : nil
-          key ||= ENV["OPENROUTER_API_KEY"]
-          key.to_s.length > 0
-        end
-      end
-    end
-  end
-end