askcii 0.3.0 → 0.4.0

data/lib/askcii/errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Askcii
+  # Base error class for all Askcii errors
+  class Error < StandardError; end
+
+  # Raised when configuration is invalid or missing
+  class ConfigurationError < Error; end
+
+  # Raised when session operations fail
+  class SessionError < Error; end
+
+  # Raised when validation fails
+  class ValidationError < Error; end
+end

data/lib/askcii/models/chat.rb

@@ -4,9 +4,12 @@ module Askcii
   class Chat < Sequel::Model(Askcii.database[:chats])
     one_to_many :messages, class: 'Askcii::Message', key: :chat_id
 
-    def to_llm
-      current_config = Askcii::Config.current_configuration
-      provider_symbol = current_config['provider'] ? current_config['provider'].to_sym : :openai
+    # Converts this Chat to a RubyLLM::Chat object with message history
+    # @param config [Hash] Configuration hash with provider and model settings
+    # @return [RubyLLM::Chat]
+    def to_llm(config)
+      provider = config[:provider] || config['provider'] || 'openai'
+      provider_symbol = provider.to_sym
 
       @chat = RubyLLM.chat(
         model: model_id,

data/lib/askcii/models/config.rb

@@ -37,13 +37,14 @@ module Askcii
       []
     end
 
-    def self.add_configuration(name, api_key, api_endpoint, model_id, provider)
+    def self.add_configuration(name:, api_key:, api_endpoint:, model_id:, provider:, system_instruction: nil)
       config_data = {
         'name' => name,
         'api_key' => api_key,
         'api_endpoint' => api_endpoint,
         'model_id' => model_id,
-        'provider' => provider
+        'provider' => provider,
+        'system_instruction' => system_instruction || default_system_instruction
       }
 
       # Find the next available ID
@@ -101,14 +102,21 @@ module Askcii
           'api_key' => api_key,
           'api_endpoint' => api_endpoint,
           'model_id' => model_id,
-          'provider' => 'openai'
+          'provider' => 'openai',
+          'system_instruction' => default_system_instruction
         }
       else
-        # Ensure provider is set for backward compatibility
+        # Ensure provider and system_instruction are set for backward compatibility
         config ||= {}
         config['provider'] ||= 'openai'
+        config['system_instruction'] ||= default_system_instruction
         config
       end
     end
+
+    def self.default_system_instruction
+      'You are a command line application. Provide concise, terminal-friendly responses. ' \
+        'Assume technical proficiency. Minimize explanations unless requested.'
+    end
   end
 end

data/lib/askcii/provider_config.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Askcii
+  # Manages provider-specific configuration metadata
+  class ProviderConfig
+    # Provider metadata including default endpoints and requirements
+    PROVIDERS = {
+      'openai' => {
+        name: 'OpenAI',
+        endpoint: 'https://api.openai.com/v1',
+        requires_key: true,
+        example_models: ['gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo']
+      },
+      'anthropic' => {
+        name: 'Anthropic',
+        endpoint: 'https://api.anthropic.com',
+        requires_key: true,
+        example_models: ['claude-3-5-sonnet-20241022', 'claude-3-opus-20240229']
+      },
+      'gemini' => {
+        name: 'Google Gemini',
+        endpoint: 'https://generativelanguage.googleapis.com/v1',
+        requires_key: true,
+        example_models: ['gemini-pro', 'gemini-pro-vision']
+      },
+      'deepseek' => {
+        name: 'DeepSeek',
+        endpoint: 'https://api.deepseek.com/v1',
+        requires_key: true,
+        example_models: ['deepseek-chat', 'deepseek-coder']
+      },
+      'openrouter' => {
+        name: 'OpenRouter',
+        endpoint: 'https://openrouter.ai/api/v1',
+        requires_key: true,
+        example_models: ['openai/gpt-4', 'anthropic/claude-3-opus']
+      },
+      'ollama' => {
+        name: 'Ollama',
+        endpoint: 'http://localhost:11434/v1',
+        requires_key: false,
+        example_models: ['llama2', 'mistral', 'codellama']
+      }
+    }.freeze
+
+    class << self
+      # Lists all available provider identifiers
+      # @return [Array<String>]
+      def list
+        PROVIDERS.keys
+      end
+
+      # Lists all provider names for display
+      # @return [Array<String>]
+      def names
+        PROVIDERS.values.map { |p| p[:name] }
+      end
+
+      # Gets provider metadata
+      # @param provider [String] Provider identifier
+      # @raise [ConfigurationError] if provider is unknown
+      # @return [Hash] Provider metadata
+      def get(provider)
+        PROVIDERS[provider.to_s.downcase] or
+          raise ConfigurationError, "Unknown provider: #{provider}"
+      end
+
+      # Gets default endpoint for a provider
+      # @param provider [String] Provider identifier
+      # @return [String] Default API endpoint URL
+      def default_endpoint(provider)
+        get(provider)[:endpoint]
+      end
+
+      # Gets display name for a provider
+      # @param provider [String] Provider identifier
+      # @return [String] Human-readable provider name
+      def display_name(provider)
+        get(provider)[:name]
+      end
+
+      # Checks if provider requires an API key
+      # @param provider [String] Provider identifier
+      # @return [Boolean]
+      def requires_key?(provider)
+        get(provider)[:requires_key]
+      end
+
+      # Gets example model IDs for a provider
+      # @param provider [String] Provider identifier
+      # @return [Array<String>] Example model identifiers
+      def example_models(provider)
+        get(provider)[:example_models]
+      end
+
+      # Checks if a provider identifier is valid
+      # @param provider [String] Provider identifier
+      # @return [Boolean]
+      def valid?(provider)
+        PROVIDERS.key?(provider.to_s.downcase)
+      end
+
+      # Gets provider metadata as a formatted string
+      # @param provider [String] Provider identifier
+      # @return [String] Formatted provider information
+      def info(provider)
+        metadata = get(provider)
+        info = "#{metadata[:name]}\n"
+        info += "Endpoint: #{metadata[:endpoint]}\n"
+        info += "API Key: #{metadata[:requires_key] ? 'Required' : 'Not required'}\n"
+        info += "Example models: #{metadata[:example_models].join(', ')}"
+        info
+      end
+    end
+  end
+end

data/lib/askcii/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Askcii
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/askcii.rb

@@ -4,9 +4,11 @@ require 'sequel'
 require 'fileutils'
 require 'ruby_llm'
 require_relative './askcii/version'
+require_relative './askcii/errors'
+require_relative './askcii/config_validator'
+require_relative './askcii/provider_config'
 
 module Askcii
-  class Error < StandardError; end
 
   def self.database
     @@database ||= Sequel.amalgalite(db_path)
@@ -53,44 +55,80 @@ module Askcii
   end
 
   def self.configure_llm(selected_config = nil)
+    # Validate configuration before attempting to use it
+    if selected_config
+      ConfigValidator.validate!(selected_config)
+    else
+      # Try legacy configuration with proper error handling
+      selected_config = load_legacy_config
+      ConfigValidator.validate!(selected_config) if selected_config
+    end
+
+    raise ConfigurationError, "No configuration available. Run 'askcii -c' to configure." unless selected_config
+
     RubyLLM.configure do |config|
       config.log_file = '/dev/null'
 
-      if selected_config
-        provider = selected_config['provider'] || 'openai'
-        api_key = selected_config['api_key']
-
-        # Set the appropriate API key based on provider
-        case provider.downcase
-        when 'openai'
-          config.openai_api_key = api_key || 'blank'
-          config.openai_api_base = selected_config['api_endpoint'] || 'https://api.openai.com/v1'
-        when 'anthropic'
-          config.anthropic_api_key = api_key || 'blank'
-        when 'gemini'
-          config.gemini_api_key = api_key || 'blank'
-        when 'deepseek'
-          config.deepseek_api_key = api_key || 'blank'
-        when 'openrouter'
-          config.openrouter_api_key = api_key || 'blank'
-        when 'ollama'
-          # Ollama doesn't need an API key
-          config.openai_api_base = selected_config['api_endpoint'] || 'http://localhost:11434/v1'
-        end
+      provider = selected_config[:provider] || selected_config['provider']
+      api_key = selected_config[:api_key] || selected_config['api_key']
+      api_endpoint = selected_config[:api_endpoint] || selected_config['api_endpoint']
+
+      # Set the appropriate API key based on provider
+      case provider.to_s.downcase
+      when 'openai'
+        config.openai_api_key = api_key
+        config.openai_api_base = api_endpoint
+      when 'anthropic'
+        config.anthropic_api_key = api_key
+      when 'gemini'
+        config.gemini_api_key = api_key
+      when 'deepseek'
+        config.deepseek_api_key = api_key
+      when 'openrouter'
+        config.openrouter_api_key = api_key
+      when 'ollama'
+        # Ollama doesn't need an API key, just endpoint
+        config.ollama_api_base = api_endpoint
       else
-        # Legacy configuration fallback
-        config.openai_api_key = begin
-          Askcii::Config.api_key || ENV['ASKCII_API_KEY'] || 'blank'
-        rescue StandardError
-          ENV['ASKCII_API_KEY'] || 'blank'
-        end
-
-        config.openai_api_base = begin
-          Askcii::Config.api_endpoint || ENV['ASKCII_API_ENDPOINT'] || 'http://localhost:11434/v1'
-        rescue StandardError
-          ENV['ASKCII_API_ENDPOINT'] || 'http://localhost:11434/v1'
-        end
+        raise ConfigurationError, "Unknown provider: #{provider}"
+      end
+    end
+  end
+
+  # Loads legacy configuration from database or environment variables
+  # @return [Hash, nil] Configuration hash or nil if not available
+  def self.load_legacy_config
+    # Try loading from Config model (requires model to be loaded)
+    return nil unless defined?(Askcii::Config)
+
+    begin
+      api_key = Askcii::Config.api_key
+      api_endpoint = Askcii::Config.api_endpoint
+      model_id = Askcii::Config.model_id
+
+      # If we got values from the database, use them
+      if api_key || api_endpoint || model_id
+        return {
+          provider: 'openai', # Legacy default
+          api_key: api_key,
+          api_endpoint: api_endpoint || ProviderConfig.default_endpoint('openai'),
+          model_id: model_id || 'gpt-3.5-turbo'
+        }
       end
+    rescue Sequel::DatabaseError, NoMethodError => e
+      # Database or model not available, fall through to env vars
+    end
+
+    # Fall back to environment variables
+    if ENV['ASKCII_API_KEY']
+      {
+        provider: 'openai', # Legacy default
+        api_key: ENV['ASKCII_API_KEY'],
+        api_endpoint: ENV['ASKCII_API_ENDPOINT'] || ProviderConfig.default_endpoint('openai'),
+        model_id: ENV['ASKCII_MODEL_ID'] || 'gpt-3.5-turbo'
+      }
+    else
+      nil
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: askcii
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Roel Bondoc
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -125,14 +126,29 @@ files:
 - bin/askcii
 - bin/console
 - bin/setup
+- completions/README.md
+- completions/askcii.bash
+- completions/askcii.zsh
 - lib/askcii.rb
 - lib/askcii/application.rb
+- lib/askcii/chat_factory.rb
 - lib/askcii/chat_session.rb
 - lib/askcii/cli.rb
+- lib/askcii/commands/base_command.rb
+- lib/askcii/commands/chat_command.rb
+- lib/askcii/commands/clear_history_command.rb
+- lib/askcii/commands/configure_command.rb
+- lib/askcii/commands/help_command.rb
+- lib/askcii/commands/history_command.rb
+- lib/askcii/commands/last_response_command.rb
+- lib/askcii/commands/list_sessions_command.rb
+- lib/askcii/config_validator.rb
 - lib/askcii/configuration_manager.rb
+- lib/askcii/errors.rb
 - lib/askcii/models/chat.rb
 - lib/askcii/models/config.rb
 - lib/askcii/models/message.rb
+- lib/askcii/provider_config.rb
 - lib/askcii/version.rb
 homepage: https://github.com/roelbondoc/askcii
 licenses: