ruby_llm 0.1.0.pre20 → 0.1.0.pre21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c12d4699a9959fb454d21065bc5d666ef59873274f6bcaacb79c63cb7fdf9559
-  data.tar.gz: f391e7cb0970a1362238a5251bb7fc7316d5358af9542f059c112e84d0bed6cd
+  metadata.gz: 5e413abd8ebadc4f30b5dc080113d9e40405117128bc8156bb7d9b0086f76956
+  data.tar.gz: 9a6971f4f5d7f709a4783b9f816589ca2b7e11199d1189bd5c946a8154d2a529
 SHA512:
-  metadata.gz: c20e3a9addf60aaa9e475f433ac3ae707d5f07a89f7f4b95c785749f9ad051194d306d6f00ba9570c06cf9b0488ac711646c44251528899304ec2945883fb097
-  data.tar.gz: 9f9f1dca17a24b0c478d98755722721410706f3e5f2993d19290fc55c69da3d3cc3d058fe01826e92e828446e74a552a36b3ede40561d32a65ffd72237ce9a36
+  metadata.gz: bdc7ad9b3e63755d398cfcc514103532d065a72bbf0eb7219496fc4c278e62b80cede1c9cadc75f3dbdb194cb655fb843d04a77d9860fd5665f5af34419f68eb
+  data.tar.gz: c4056980199b29e41993e1f7b092d760328b21e6327c427ad1a9ef09f4e5521482bb9a3cc9c1d0eba3380b18127541b583ebbd7d4780057df1e838c9bba48793

data/README.md

@@ -19,9 +19,7 @@ Or install it yourself:
 gem install ruby_llm
 ```
 
-## Quick Start
-
-RubyLLM makes it dead simple to start chatting with AI models:
+## Configuration
 
 ```ruby
 require 'ruby_llm'
@@ -31,7 +29,13 @@ RubyLLM.configure do |config|
   config.openai_api_key = ENV['OPENAI_API_KEY']
   config.anthropic_api_key = ENV['ANTHROPIC_API_KEY']
 end
+```
+
+## Quick Start
+
+RubyLLM makes it dead simple to start chatting with AI models:
 
+```ruby
 # Start a conversation
 chat = RubyLLM.chat
 chat.ask "What's the best way to learn Ruby?"
@@ -169,6 +173,21 @@ chat.ask "What's 123 * 456?"
 # D, -- RubyLLM: Tool calculator returned: "56088"
 ```
 
+## Error Handling
+
+RubyLLM wraps provider errors in clear Ruby exceptions:
+
+```ruby
+begin
+  chat = RubyLLM.chat
+  chat.ask "Hello world!"
+rescue RubyLLM::UnauthorizedError
+  puts "Check your API credentials"
+rescue RubyLLM::BadRequestError => e
+  puts "Something went wrong: #{e.message}"
+end
+```
+
 ## Rails Integration
 
 RubyLLM comes with built-in Rails support that makes it dead simple to persist your chats and messages. Just create your tables and hook it up:

data/lib/ruby_llm/error.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  # Custom error class that wraps API errors from different providers
+  # into a consistent format with helpful error messages.
+  #
+  # Example:
+  #   begin
+  #     chat.ask "What's 2+2?"
+  #   rescue RubyLLM::Error => e
+  #     puts "Couldn't chat with AI: #{e.message}"
+  #   end
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response = nil, message = nil)
+      @response = response
+      super(message || response&.body.to_s)
+    end
+  end
+
+  class UnauthorizedError < Error; end
+  class BadRequestError < Error; end
+  class RateLimitError < Error; end
+  class ServerError < Error; end
+
+  # Faraday middleware that maps provider-specific API errors to RubyLLM errors.
+  # Uses provider's parse_error method to extract meaningful error messages.
+  class ErrorMiddleware < Faraday::Middleware
+    def initialize(app, provider: nil)
+      super(app)
+      @provider = provider
+    end
+
+    def call(env) # rubocop:disable Metrics/MethodLength
+      @app.call(env).on_complete do |response|
+        message = @provider&.parse_error(response)
+
+        case response.status
+        when 400
+          raise BadRequestError.new(response, message)
+        when 401
+          raise UnauthorizedError.new(response, 'Invalid API key - check your credentials')
+        when 429
+          raise RateLimitError.new(response, 'Rate limit exceeded - please wait a moment')
+        when 500..599
+          raise ServerError.new(response, 'API server error - please try again')
+        end
+      end
+    end
+  end
+end
+
+Faraday::Middleware.register_middleware(llm_errors: RubyLLM::ErrorMiddleware)

data/lib/ruby_llm/provider.rb

@@ -69,7 +69,7 @@ module RubyLLM
           f.request :json
           f.response :json
           f.adapter Faraday.default_adapter
-          f.use Faraday::Response::RaiseError
+          f.use :llm_errors, provider: self
           f.response :logger, RubyLLM.logger, { headers: false, bodies: true, errors: true, log_level: :debug }
         end
       end

data/lib/ruby_llm/providers/anthropic.rb

@@ -7,6 +7,10 @@ module RubyLLM
     class Anthropic # rubocop:disable Metrics/ClassLength
       include Provider
 
+      def parse_error(response)
+        JSON.parse(response.body).dig('error', 'message')
+      end
+
       private
 
       def api_base

data/lib/ruby_llm/providers/openai.rb

@@ -8,6 +8,10 @@ module RubyLLM
     class OpenAI # rubocop:disable Metrics/ClassLength
       include Provider
 
+      def parse_error(response)
+        JSON.parse(response.body).dig('error', 'message')
+      end
+
       private
 
       def api_base

data/lib/ruby_llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  VERSION = '0.1.0.pre20'
+  VERSION = '0.1.0.pre21'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre20
+  version: 0.1.0.pre21
 platform: ruby
 authors:
 - Carmine Paolino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -350,6 +350,7 @@ files:
 - lib/ruby_llm/chunk.rb
 - lib/ruby_llm/configuration.rb
 - lib/ruby_llm/embedding.rb
+- lib/ruby_llm/error.rb
 - lib/ruby_llm/message.rb
 - lib/ruby_llm/model_capabilities/anthropic.rb
 - lib/ruby_llm/model_capabilities/openai.rb