ai-chat 0.5.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f564a7f3f476e11c343959e35eaf035f5c3e384fbc6f6ed33cdd85513bd38dcf
-  data.tar.gz: d40af116bbbf374efa1b6be1370b94f7909d8de86fbf530a69bbabee86dbc21d
+  metadata.gz: 50c5c8743e007a3b5dee31d4d56e81073fd28b6bcf92fbb5d0fe0671bbbfac2e
+  data.tar.gz: 2cf832e2e5a211612f281e2058590bced4550fae4f60fc0410e7da37058cc010
 SHA512:
-  metadata.gz: 6c0360ac379bb0db811199fa379aa03c778647e449638bb58204780631ced200d5983efca20ccd44acde047d0de87da4ef1ecaeedb4f4a88656a98f1aa77a539
-  data.tar.gz: 664c82f27d85fec5ccf99122179902a4f910cf4854f50335638ac7458a61c4d9b3afc39f52aea69c0fc6856706cef25a17006f99904103bbf162a51e695ec8ee
+  metadata.gz: 53732280a8dc68de3bb9e90b174b6b3bf092f43e2fdfa997bbe499e253151570c713ee7166235a0c2e0494ae9b743b729ba8a7bea82e0aa26020baed16e14fd0
+  data.tar.gz: d0429dd257cc64fa91d31b0aa7543d21faa32aef74249f98d63810f71e63891bb32e878f571e2367e78b0bb098b9eaea79e8404ab1a380c0668124df37aa18e9

data/README.md

@@ -238,7 +238,7 @@ See [OpenAI's model documentation](https://platform.openai.com/docs/models) for
 
 ### API key
 
-The gem by default looks for `AICHAT_API_KEY` first. If that is missing (or empty), it falls back to `OPENAI_API_KEY`.
+By default, the gem uses `OPENAI_API_KEY`. When proxy mode is enabled (`AICHAT_PROXY=true`), it uses `AICHAT_PROXY_KEY` instead.
 
 You can specify a different environment variable name:
 
@@ -404,7 +404,7 @@ AI::Chat.generate_schema!("A user profile with name (required), email (required)
 
 This method returns a String containing the JSON schema. The JSON schema also writes (or overwrites) to `schema.json` at the root of the project.
 
-Similar to generating messages with `AI::Chat` objects, this class method will look for `AICHAT_API_KEY` first, then fall back to `OPENAI_API_KEY` if needed. You can also pass the API key directly or choose a different environment variable key for it to use.
+This class method uses the same API key and proxy resolution as `AI::Chat.new`. You can also pass the API key directly or choose a different environment variable:
 
 ```rb
 # Passing the API key directly
@@ -414,7 +414,7 @@ AI::Chat.generate_schema!("A user with full name (required), first_name (require
 AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", api_key_env_var: "CUSTOM_KEY")
 ```
 
-`generate_schema!` also follows proxy defaults from the `AICHAT_PROXY` environment variable. Proxy is enabled only when `AICHAT_PROXY` is exactly `"true"`.
+`generate_schema!` also follows proxy defaults from the `AICHAT_PROXY` environment variable.
 
 ```bash
 export AICHAT_PROXY=true
@@ -617,28 +617,30 @@ message = chat.get_response(wait: true, timeout: 600)
 puts message[:content]
 ```
 
-## Proxying Through prepend.me
+## Proxying Through Prepend.me
 
-You can proxy API calls through [prepend.me](https://prepend.me/).
+You can proxy API calls through [Prepend.me](https://prepend.me/). When proxy mode is enabled, the gem uses the `AICHAT_PROXY_KEY` environment variable instead of `OPENAI_API_KEY`.
+
+You can enable proxy mode at construction time:
 
 ```rb
-chat = AI::Chat.new
-chat.proxy = true
-chat.user("Tell me a story")
-chat.generate!
-puts chat.last[:content]
-# => "Once upon a time..."
+chat = AI::Chat.new(proxy: true)
 ```
 
-You can also default proxy mode from the environment for both `AI::Chat.new` and `AI::Chat.generate_schema!`:
+Or default it from the environment (case-insensitive):
 
 ```bash
 export AICHAT_PROXY=true
 ```
 
-Proxy is enabled only when `AICHAT_PROXY` is exactly `"true"`. Any other value (including `"TRUE"` or `"1"`) leaves proxy disabled unless you explicitly set `chat.proxy = true` or pass `proxy: true`.
+Or toggle it on an existing instance:
+
+```rb
+chat = AI::Chat.new
+chat.proxy = true
+```
 
-When proxy is enabled, **you must use the API key provided by prepend.me** in place of a real OpenAI API key. Refer to [the section on API keys](#api-key) for options on how to set your key.
+When proxy is enabled, **you must set `AICHAT_PROXY_KEY`** with your API key from Prepend.me.
 
 ## Building Conversations Without API Calls
 
@@ -748,9 +750,7 @@ This is particularly useful for background mode workflows. If you want to retrie
 ```ruby
 require "openai"
 
-api_key = ENV["AICHAT_API_KEY"]
-api_key = ENV.fetch("OPENAI_API_KEY") if api_key.nil? || api_key.empty?
-client = OpenAI::Client.new(api_key: api_key)
+client = OpenAI::Client.new(api_key: ENV.fetch("OPENAI_API_KEY"))
 
 response_id = "resp_abc123..." # e.g., load from your database
 response = client.responses.retrieve(response_id)

data/ai-chat.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "ai-chat"
-  spec.version = "0.5.8"
+  spec.version = "0.6.0"
   spec.authors = ["Raghu Betina", "Jelani Woods"]
   spec.email = ["raghu@firstdraft.com", "jelani@firstdraft.com"]
   spec.homepage = "https://github.com/firstdraft/ai-chat"

data/lib/ai/chat.rb

@@ -22,10 +22,15 @@ module AI
     attr_reader :client, :last_response_id, :proxy, :schema, :schema_file, :verbosity
 
     BASE_PROXY_URL = "https://prepend.me/api.openai.com/v1"
-
-    def initialize(api_key: nil, api_key_env_var: nil)
-      @api_key = self.class.resolve_api_key(api_key: api_key, api_key_env_var: api_key_env_var)
-      @proxy = ENV["AICHAT_PROXY"] == "true"
+    PROXY_ENV = "AICHAT_PROXY"
+    PROXY_KEY_ENV = "AICHAT_PROXY_KEY"
+    OPENAI_KEY_ENV = "OPENAI_API_KEY"
+
+    def initialize(api_key: nil, api_key_env_var: nil, proxy: nil)
+      @api_key_arg = api_key
+      @api_key_env_var_arg = api_key_env_var
+      @proxy = proxy.nil? ? ENV[PROXY_ENV]&.downcase == "true" : !!proxy
+      @api_key = resolve_api_key
       @messages = []
       @reasoning_effort = nil
       @model = "gpt-5.2"
@@ -40,8 +45,8 @@ module AI
     end
 
     def self.generate_schema!(description, location: "schema.json", api_key: nil, api_key_env_var: nil, proxy: nil)
-      api_key = resolve_api_key(api_key: api_key, api_key_env_var: api_key_env_var)
-      proxy = ENV["AICHAT_PROXY"] == "true" if proxy.nil?
+      proxy = proxy.nil? ? ENV[PROXY_ENV]&.downcase == "true" : !!proxy
+      api_key = api_key || ENV.fetch(api_key_env_var || (proxy ? PROXY_KEY_ENV : OPENAI_KEY_ENV))
       prompt_path = File.expand_path("../prompts/schema_generator.md", __dir__)
       system_prompt = File.read(prompt_path)
 
@@ -73,16 +78,6 @@ module AI
       content
     end
 
-    def self.resolve_api_key(api_key: nil, api_key_env_var: nil)
-      return api_key if api_key
-      return ENV.fetch(api_key_env_var) if api_key_env_var
-
-      aichat_api_key = ENV["AICHAT_API_KEY"]
-      return aichat_api_key if aichat_api_key && !aichat_api_key.empty?
-
-      ENV.fetch("OPENAI_API_KEY")
-    end
-
     # :reek:TooManyStatements
     # :reek:NilCheck
     def add(content, role: "user", response: nil, status: nil, image: nil, images: nil, file: nil, files: nil)
@@ -169,15 +164,20 @@ module AI
     end
 
     def proxy=(value)
-      @proxy = value
-      @client = if value
-        OpenAI::Client.new(
-          api_key: @api_key,
-          base_url: BASE_PROXY_URL
-        )
-      else
-        OpenAI::Client.new(api_key: @api_key)
-      end
+      new_proxy = !!value
+      previous_proxy = @proxy
+      @proxy = new_proxy
+      new_key = resolve_api_key
+      client_options = {api_key: new_key}
+      client_options[:base_url] = BASE_PROXY_URL if new_proxy
+      new_client = OpenAI::Client.new(**client_options)
+
+      @api_key = new_key
+      @api_key_validated = false
+      @client = new_client
+    rescue => error
+      @proxy = previous_proxy
+      raise
     end
 
     def schema=(value)
@@ -262,6 +262,21 @@ module AI
 
     private
 
+    def resolve_api_key
+      env_var = @api_key_env_var_arg || (@proxy ? PROXY_KEY_ENV : OPENAI_KEY_ENV)
+      @api_key_arg || ENV.fetch(env_var) {
+        if @proxy
+          raise KeyError, "Proxy mode is enabled but #{PROXY_KEY_ENV} is not set. " \
+            "Create an environment variable called #{PROXY_KEY_ENV} " \
+            "with your API key from Prepend.me."
+        else
+          raise KeyError, "#{OPENAI_KEY_ENV} is not set. " \
+            "Create an environment variable called #{OPENAI_KEY_ENV} " \
+            "with your API key from https://platform.openai.com/api-keys."
+        end
+      }
+    end
+
     class InputClassificationError < StandardError; end
 
     class WrongAPITokenUsedError < StandardError; end
@@ -597,11 +612,11 @@ module AI
     rescue OpenAI::Errors::AuthenticationError
       message = if proxy
         <<~STRING
-          It looks like you're using an invalid API key. Proxying is enabled, so you must use an OpenAI API key from prepend.me. Please disable proxy or update your API key before generating a response.
+          Your API key was not accepted by Prepend.me. Since proxy mode is enabled, you need a valid API key from Prepend.me in the #{PROXY_KEY_ENV} environment variable.
         STRING
       else
         <<~STRING
-          It looks like you're using an invalid API key. Check to make sure your API key is valid before generating a response.
+          Your API key was not accepted by OpenAI. Make sure the #{OPENAI_KEY_ENV} environment variable contains a valid key from https://platform.openai.com/api-keys.
         STRING
       end
       raise WrongAPITokenUsedError, message, cause: nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ai-chat
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.6.0
 platform: ruby
 authors:
 - Raghu Betina