raix 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56a4f5695ac0b5685715aa48e1bbb926efd05c5bd15b2f2198df3acda3ef30e4
-  data.tar.gz: e46d6284e3d4201fa6a8bc5b59403b41434d9e92ce131944d5d20d896925402f
+  metadata.gz: 9ae2cafb0dfef15674cc95ed9067309f158d88c24a2ea23581f6331f20a49063
+  data.tar.gz: 214e5257dc699b26f4fa529278b367cf9fa30f6b27e81de8225b3eecfb33a297
 SHA512:
-  metadata.gz: 07224f3ff3b8ea20b01d77bd149f7aa3afc597c145db34cf65ecf188a4e2fb2f366729cd8b8c671783346ce743106a234bbf8e551b2243f5a5f8fb9f652ed28b
-  data.tar.gz: ed03422c1168de36a21729ed75281ff6dcfabead31232cefc22201fb670a18bae57877fc4e440aa8bffaf0705c1288511369f0e040757e92198e702922c407be
+  metadata.gz: d6f319bb682d8ad3134aee647e1052dd63c46e5a899d370b6a25f846b02ca52de5b03008e006dcc9e9496788a68c3e19a3c05676715c9f5324b3a47e8faf11e6
+  data.tar.gz: e00be61584c497bcdef12ac42df9b21a10d724e2a50031490db225450d7cb0dc41818b21c50fc4718854e5f461aada2ee030b087819dec789f70e4abfa89c891

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [1.0.2] - 2025-07-16
+### Added
+- Added method to check for API client availability in Configuration
+
+### Changed
+- Updated ruby-openai dependency to ~> 8.1
+
+### Fixed
+- Fixed gemspec file reference
+
+## [1.0.1] - 2025-06-04
+### Fixed
+- Fixed PromptDeclarations module namespace - now properly namespaced under Raix
+- Removed Rails.logger dependencies from PromptDeclarations for non-Rails environments
+- Fixed documentation example showing incorrect `openai: true` usage (should be model string)
+- Added comprehensive tests for PromptDeclarations module
+
+### Changed
+- Improved error handling in PromptDeclarations to catch StandardError instead of generic rescue
+
 ## [1.0.0] - 2025-06-04
 ### Breaking Changes
 - **Deprecated `loop` parameter in ChatCompletion** - The system now automatically continues conversations after tool calls until the AI provides a text response. The `loop` parameter shows a deprecation warning but still works for backwards compatibility.

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in raix-rails.gemspec
+# Specify your gem's dependencies in raix.gemspec
 gemspec
 
 group :development do

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    raix (0.9.2)
+    raix (1.0.2)
       activesupport (>= 6.0)
       faraday-retry (~> 2.0)
       open_router (~> 0.2)
       ostruct
-      ruby-openai (~> 7)
+      ruby-openai (~> 8.1)
 
 GEM
   remote: https://rubygems.org/
@@ -148,7 +148,7 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
-    ruby-openai (7.1.0)
+    ruby-openai (8.1.0)
       event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)

data/README.md

@@ -460,7 +460,7 @@ class CustomPromptExample
 
   # Prompt using OpenAI directly
   prompt text: "Use OpenAI",
-        openai: true
+        openai: "gpt-4o"
 end
 ```
 
@@ -713,12 +713,27 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 If you are using the default OpenRouter API, Raix expects `Raix.configuration.openrouter_client` to initialized with the OpenRouter API client instance.
 
-You can add an initializer to your application's `config/initializers` directory:
+You can add an initializer to your application's `config/initializers` directory that looks like this example (setting up both providers, OpenRouter and OpenAI):
 
 ```ruby
   # config/initializers/raix.rb
+  OpenRouter.configure do |config|
+    config.faraday do |f|
+      f.request :retry, retry_options
+      f.response :logger, Logger.new($stdout), { headers: true, bodies: true, errors: true } do |logger|
+        logger.filter(/(Bearer) (\S+)/, '\1[REDACTED]')
+      end
+    end
+  end
+
   Raix.configure do |config|
-    config.openrouter_client = OpenRouter::Client.new
+    config.openrouter_client = OpenRouter::Client.new(access_token: ENV.fetch("OR_ACCESS_TOKEN", nil))
+    config.openai_client = OpenAI::Client.new(access_token: ENV.fetch("OAI_ACCESS_TOKEN", nil)) do |f|
+      f.request :retry, retry_options
+      f.response :logger, Logger.new($stdout), { headers: true, bodies: true, errors: true } do |logger|
+        logger.filter(/(Bearer) (\S+)/, '\1[REDACTED]')
+      end
+    end
   end
 ```
 

data/lib/raix/configuration.rb

@@ -56,6 +56,10 @@ module Raix
       self.fallback = fallback
     end
 
+    def client?
+      !!(openrouter_client || openai_client)
+    end
+
     private
 
     attr_accessor :fallback

data/lib/raix/prompt_declarations.rb

@@ -5,172 +5,162 @@ require "ostruct"
 # This module provides a way to chain prompts and handle
 # user responses in a serialized manner, with support for
 # functions if the FunctionDispatch module is also included.
-module PromptDeclarations
-  extend ActiveSupport::Concern
+module Raix
+  # The PromptDeclarations module provides a way to chain prompts and handle
+  # user responses in a serialized manner, with support for
+  # functions if the FunctionDispatch module is also included.
+  module PromptDeclarations
+    extend ActiveSupport::Concern
+
+    module ClassMethods # rubocop:disable Style/Documentation
+      # Adds a prompt to the list of prompts. At minimum, provide a `text` or `call` parameter.
+      #
+      # @param system [Proc] A lambda that generates the system message.
+      # @param call [ChatCompletion] A callable class that includes ChatCompletion. Will be passed a context object when initialized.
+      # @param text Accepts 1) a lambda that returns the prompt text, 2) a string, or 3) a symbol that references a method.
+      # @param stream [Proc] A lambda stream handler
+      # @param success [Proc] The block of code to execute when the prompt is answered.
+      # @param params [Hash] Additional parameters for the completion API call
+      # @param if [Proc] A lambda that determines if the prompt should be executed.
+      def prompt(system: nil, call: nil, text: nil, stream: nil, success: nil, params: {}, if: nil, unless: nil, until: nil)
+        name = Digest::SHA256.hexdigest(text.inspect)[0..7]
+        prompts << OpenStruct.new({ name:, system:, call:, text:, stream:, success:, if:, unless:, until:, params: })
+
+        define_method(name) do |response|
+          return response if success.nil?
+          return send(success, response) if success.is_a?(Symbol)
+
+          instance_exec(response, &success)
+        end
+      end
 
-  module ClassMethods # rubocop:disable Style/Documentation
-    # Adds a prompt to the list of prompts. At minimum, provide a `text` or `call` parameter.
-    #
-    # @param system [Proc] A lambda that generates the system message.
-    # @param call [ChatCompletion] A callable class that includes ChatCompletion. Will be passed a context object when initialized.
-    # @param text Accepts 1) a lambda that returns the prompt text, 2) a string, or 3) a symbol that references a method.
-    # @param stream [Proc] A lambda stream handler
-    # @param success [Proc] The block of code to execute when the prompt is answered.
-    # @param params [Hash] Additional parameters for the completion API call
-    # @param if [Proc] A lambda that determines if the prompt should be executed.
-    def prompt(system: nil, call: nil, text: nil, stream: nil, success: nil, params: {}, if: nil, unless: nil, until: nil)
-      name = Digest::SHA256.hexdigest(text.inspect)[0..7]
-      prompts << OpenStruct.new({ name:, system:, call:, text:, stream:, success:, if:, unless:, until:, params: })
-
-      define_method(name) do |response|
-        puts "_" * 80
-        puts "PromptDeclarations#response:"
-        puts "#{text&.source_location} (#{name})"
-        puts response
-        puts "_" * 80
-
-        return response if success.nil?
-        return send(success, response) if success.is_a?(Symbol)
-
-        instance_exec(response, &success)
+      def prompts
+        @prompts ||= []
       end
     end
 
-    def prompts
-      @prompts ||= []
-    end
-  end
+    attr_reader :current_prompt, :last_response
+
+    MAX_LOOP_COUNT = 5
 
-  attr_reader :current_prompt, :last_response
-
-  MAX_LOOP_COUNT = 5
-
-  # Executes the chat completion process based on the class-level declared prompts.
-  # The response to each prompt is added to the transcript automatically and returned.
-  #
-  # Raises an error if there are not enough prompts defined.
-  #
-  # Uses system prompt in following order of priority:
-  #   - system lambda specified in the prompt declaration
-  #   - system_prompt instance method if defined
-  #   - system_prompt class-level declaration if defined
-  #
-  #  Prompts require a text lambda to be defined at minimum.
-  #  TODO: shortcut syntax passes just a string prompt if no other options are needed.
-  #
-  # @raise [RuntimeError] If no prompts are defined.
-  #
-  # @param prompt [String] The prompt to use for the chat completion.
-  # @param params [Hash] Parameters for the chat completion.
-  # @param raw [Boolean] Whether to return the raw response.
-  #
-  # TODO: SHOULD NOT HAVE A DIFFERENT INTERFACE THAN PARENT
-  def chat_completion(prompt = nil, params: {}, raw: false, openai: false)
-    raise "No prompts defined" unless self.class.prompts.present?
-
-    loop_count = 0
-
-    current_prompts = self.class.prompts.clone
-
-    while (@current_prompt = current_prompts.shift)
-      next if @current_prompt.if.present? && !instance_exec(&@current_prompt.if)
-      next if @current_prompt.unless.present? && instance_exec(&@current_prompt.unless)
-
-      input = case current_prompt.text
-              when Proc
-                instance_exec(&current_prompt.text)
-              when String
-                current_prompt.text
-              when Symbol
-                send(current_prompt.text)
-              else
-                last_response.presence || prompt
-              end
-
-      if current_prompt.call.present?
-        Rails.logger.debug "Calling #{current_prompt.call} with input: #{input}"
-        current_prompt.call.new(self).call(input).tap do |response|
-          if response.present?
-            transcript << { assistant: response }
-            @last_response = send(current_prompt.name, response)
+    # Executes the chat completion process based on the class-level declared prompts.
+    # The response to each prompt is added to the transcript automatically and returned.
+    #
+    # Raises an error if there are not enough prompts defined.
+    #
+    # Uses system prompt in following order of priority:
+    #   - system lambda specified in the prompt declaration
+    #   - system_prompt instance method if defined
+    #   - system_prompt class-level declaration if defined
+    #
+    #  Prompts require a text lambda to be defined at minimum.
+    #  TODO: shortcut syntax passes just a string prompt if no other options are needed.
+    #
+    # @raise [RuntimeError] If no prompts are defined.
+    #
+    # @param prompt [String] The prompt to use for the chat completion.
+    # @param params [Hash] Parameters for the chat completion.
+    # @param raw [Boolean] Whether to return the raw response.
+    #
+    # TODO: SHOULD NOT HAVE A DIFFERENT INTERFACE THAN PARENT
+    def chat_completion(prompt = nil, params: {}, raw: false, openai: false)
+      raise "No prompts defined" unless self.class.prompts.present?
+
+      loop_count = 0
+
+      current_prompts = self.class.prompts.clone
+
+      while (@current_prompt = current_prompts.shift)
+        next if @current_prompt.if.present? && !instance_exec(&@current_prompt.if)
+        next if @current_prompt.unless.present? && instance_exec(&@current_prompt.unless)
+
+        input = case current_prompt.text
+                when Proc
+                  instance_exec(&current_prompt.text)
+                when String
+                  current_prompt.text
+                when Symbol
+                  send(current_prompt.text)
+                else
+                  last_response.presence || prompt
+                end
+
+        if current_prompt.call.present?
+          current_prompt.call.new(self).call(input).tap do |response|
+            if response.present?
+              transcript << { assistant: response }
+              @last_response = send(current_prompt.name, response)
+            end
           end
+        else
+          __system_prompt = instance_exec(&current_prompt.system) if current_prompt.system.present? # rubocop:disable Lint/UnderscorePrefixedVariableName
+          __system_prompt ||= system_prompt if respond_to?(:system_prompt)
+          __system_prompt ||= self.class.system_prompt.presence
+          transcript << { system: __system_prompt } if __system_prompt
+          transcript << { user: instance_exec(&current_prompt.text) } # text is required
+
+          params = current_prompt.params.merge(params)
+
+          # set the stream if necessary
+          self.stream = instance_exec(&current_prompt.stream) if current_prompt.stream.present?
+
+          execute_ai_request(params:, raw:, openai:, transcript:, loop_count:)
         end
-      else
-        __system_prompt = instance_exec(&current_prompt.system) if current_prompt.system.present? # rubocop:disable Lint/UnderscorePrefixedVariableName
-        __system_prompt ||= system_prompt if respond_to?(:system_prompt)
-        __system_prompt ||= self.class.system_prompt.presence
-        transcript << { system: __system_prompt } if __system_prompt
-        transcript << { user: instance_exec(&current_prompt.text) } # text is required
 
-        params = current_prompt.params.merge(params)
+        next unless current_prompt.until.present? && !instance_exec(&current_prompt.until)
 
-        # set the stream if necessary
-        self.stream = instance_exec(&current_prompt.stream) if current_prompt.stream.present?
+        if loop_count >= MAX_LOOP_COUNT
+          warn "Max loop count reached in chat_completion. Forcing return."
 
-        execute_ai_request(params:, raw:, openai:, transcript:, loop_count:)
+          return last_response
+        else
+          current_prompts.unshift(@current_prompt) # put it back at the front
+          loop_count += 1
+        end
       end
 
-      next unless current_prompt.until.present? && !instance_exec(&current_prompt.until)
-
-      if loop_count >= MAX_LOOP_COUNT
-        Honeybadger.notify(
-          "Max loop count reached in chat_completion. Forcing return.",
-          context: {
-            current_prompts:,
-            prompt:,
-            usage_subject: usage_subject.inspect,
-            last_response: Current.or_response
-          }
-        )
-
-        return last_response
-      else
-        current_prompts.unshift(@current_prompt) # put it back at the front
-        loop_count += 1
-      end
+      last_response
     end
 
-    last_response
-  end
+    def execute_ai_request(params:, raw:, openai:, transcript:, loop_count:)
+      chat_completion_from_superclass(params:, raw:, openai:).then do |response|
+        transcript << { assistant: response }
+        @last_response = send(current_prompt.name, response)
+        self.stream = nil # clear it again so it's not used for the next prompt
+      end
+    rescue StandardError => e
+      # Bubbles the error up the stack if no loops remain
+      raise e if loop_count >= MAX_LOOP_COUNT
 
-  def execute_ai_request(params:, raw:, openai:, transcript:, loop_count:)
-    chat_completion_from_superclass(params:, raw:, openai:).then do |response|
-      transcript << { assistant: response }
-      @last_response = send(current_prompt.name, response)
-      self.stream = nil # clear it again so it's not used for the next prompt
+      sleep 1 # Wait before continuing
     end
-  rescue Conversation::StreamError => e
-    # Bubbles the error up the stack if no loops remain
-    raise Faraday::ServerError.new(nil, { status: e.status, body: e.response }) if loop_count >= MAX_LOOP_COUNT
-
-    sleep 1.second # Wait before continuing
-  end
 
-  # Returns the model parameter of the current prompt or the default model.
-  #
-  # @return [Object] The model parameter of the current prompt or the default model.
-  def model
-    @current_prompt.params[:model] || super
-  end
+    # Returns the model parameter of the current prompt or the default model.
+    #
+    # @return [Object] The model parameter of the current prompt or the default model.
+    def model
+      @current_prompt.params[:model] || super
+    end
 
-  # Returns the temperature parameter of the current prompt or the default temperature.
-  #
-  # @return [Float] The temperature parameter of the current prompt or the default temperature.
-  def temperature
-    @current_prompt.params[:temperature] || super
-  end
+    # Returns the temperature parameter of the current prompt or the default temperature.
+    #
+    # @return [Float] The temperature parameter of the current prompt or the default temperature.
+    def temperature
+      @current_prompt.params[:temperature] || super
+    end
 
-  # Returns the max_tokens parameter of the current prompt or the default max_tokens.
-  #
-  # @return [Integer] The max_tokens parameter of the current prompt or the default max_tokens.
-  def max_tokens
-    @current_prompt.params[:max_tokens] || super
-  end
+    # Returns the max_tokens parameter of the current prompt or the default max_tokens.
+    #
+    # @return [Integer] The max_tokens parameter of the current prompt or the default max_tokens.
+    def max_tokens
+      @current_prompt.params[:max_tokens] || super
+    end
 
-  protected
+    protected
 
-  # workaround for super.chat_completion, which is not available in ruby
-  def chat_completion_from_superclass(*, **kargs)
-    method(:chat_completion).super_method.call(*, **kargs)
+    # workaround for super.chat_completion, which is not available in ruby
+    def chat_completion_from_superclass(*, **kargs)
+      method(:chat_completion).super_method.call(*, **kargs)
+    end
   end
 end

data/lib/raix/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raix
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/raix.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-retry", "~> 2.0"
   spec.add_dependency "open_router", "~> 0.2"
   spec.add_dependency "ostruct"
-  spec.add_dependency "ruby-openai", "~> 7"
+  spec.add_dependency "ruby-openai", "~> 8.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: raix
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Obie Fernandez
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -71,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8.1'
 email:
 - obiefernandez@gmail.com
 executables: []
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby AI eXtensions
 test_files: []