ai-chat 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e76b862d3664f09a8c4173bdbc68365501336acc0d48b4542da4ca142b3f59e
-  data.tar.gz: cf353470145cd1039ad7030973e06e038ddfc3cf940a3d607d6ff35060769f51
+  metadata.gz: 975e7f80044ac46d72ad1c08e290d7fa71b43048fe76d68784d3961c36efde95
+  data.tar.gz: cf0a2b5fcee3e6ee413580419c992efe6c50e5935be875f2e82d8a740c7d15fb
 SHA512:
-  metadata.gz: 7411d60fc191ab8066948e0a37fd0cd37a08f109b4af3ae62b0a863138a54dd6f7a168db65452f4af1de1935429d45bd636511672d1d3ba90c11f9307683a122
-  data.tar.gz: 4268e53f60035aa998eb8b4bd83a5d300543a1ff00d44a4253832780f848aae45cfb18880fee3d29c5090595496dac56df06c5dc7c540dee8fadd755afc61d94
+  metadata.gz: fe727e64a0388922db85c3085dea85c6622b88c886cbb25fc660dc9bad8291205a1904a19f611457ac83cbe673a299db4d97f0b658e236de0e3ccccb46f44aac
+  data.tar.gz: 4be9d9a80ea39e20ef2c11d8142f9403b7b43f46c8f4ccc5a80f88a027980be11b1e882165e67e0380d2a8982e0e4bbd3489585cac3c4a0a291d46a75813d53d

data/README.md

@@ -26,19 +26,19 @@ The `examples/` directory contains focused examples for specific features:
 
 - `01_quick.rb` - Quick overview of key features
 - `02_core.rb` - Core functionality (basic chat, messages, responses)
-- `03_configuration.rb` - Configuration options (API keys, models, reasoning effort)
-- `04_multimodal.rb` - Basic file and image handling
-- `05_file_handling_comprehensive.rb` - Advanced file handling (PDFs, text files, Rails uploads)
-- `06_structured_output.rb` - Basic structured output with schemas
-- `07_structured_output_comprehensive.rb` - All 6 supported schema formats
-- `08_advanced_usage.rb` - Advanced patterns (chaining, web search)
-- `09_edge_cases.rb` - Error handling and edge cases
-- `10_additional_patterns.rb` - Less common usage patterns (direct add method, web search + schema, etc.)
-- `11_mixed_content.rb` - Combining text and images in messages
-- `12_image_generation.rb` - Using the image generation tool
-- `13_code_interpreter.rb` - Using the code interpreter tool
-- `14_background_mode.rb` - Running responses in background mode
-- `15_conversation_features_comprehensive.rb` - All conversation features (auto-creation, inspection, loading, forking)
+- `03_multimodal.rb` - Basic file and image handling
+- `04_file_handling_comprehensive.rb` - Advanced file handling (PDFs, text files, Rails uploads)
+- `05_structured_output.rb` - Basic structured output with schemas
+- `06_structured_output_comprehensive.rb` - All 6 supported schema formats
+- `07_edge_cases.rb` - Error handling and edge cases
+- `08_additional_patterns.rb` - Less common usage patterns (direct add method, web search + schema, etc.)
+- `09_mixed_content.rb` - Combining text and images in messages
+- `10_image_generation.rb` - Using the image generation tool
+- `11_code_interpreter.rb` - Using the code interpreter tool
+- `12_background_mode.rb` - Running responses in background mode
+- `13_conversation_features_comprehensive.rb` - Conversation features (auto-creation, continuity, inspection)
+- `14_schema_generation.rb` - Generate JSON schemas from natural language
+- `15_proxy.rb` - Proxy support for student accounts
 
 Each example is self-contained and can be run individually:
 ```bash
@@ -93,7 +93,7 @@ a.generate! # => { :role => "assistant", :content => "Matz is nice and so we are
 pp a.messages
 # => [
 #      {:role=>"user", :content=>"If the Ruby community had an official motto, what might it be?"},
-#      {:role=>"assistant", :content=>"Matz is nice and so we are nice", :response => { id=resp_abc... model=gpt-4.1-nano tokens=12 } }
+#      {:role=>"assistant", :content=>"Matz is nice and so we are nice", :response => { id=resp_abc... model=gpt-5.1 tokens=12 } }
 #    ]
 
 # Continue the conversation
@@ -113,7 +113,7 @@ That's it! You're building something like this:
 [
   {:role => "system", :content => "You are a helpful assistant"},
   {:role => "user", :content => "Hello!"},
-  {:role => "assistant", :content => "Hi there! How can I help you today?", :response => { id=resp_abc... model=gpt-4.1-nano tokens=12 } }
+  {:role => "assistant", :content => "Hi there! How can I help you today?", :response => { id=resp_abc... model=gpt-5.1 tokens=12 } }
 ]
 ```
 
@@ -183,25 +183,14 @@ d.generate!                         # Generate a response
 
 ### Model
 
-By default, the gem uses OpenAI's `gpt-4.1-nano` model. If you want to use a different model, you can set it:
+By default, the gem uses OpenAI's `gpt-5.1` model. If you want to use a different model, you can set it:
 
 ```ruby
 e = AI::Chat.new
-e.model = "o4-mini"
+e.model = "gpt-4o"
 ```
 
-As of 2025-07-29, the list of chat models that you probably want to choose from are:
-
-#### Foundation models 
-
-- gpt-4.1-nano
-- gpt-4.1-mini
-- gpt-4.1
-
-#### Reasoning models
-
-- o4-mini
-- o3
+See [OpenAI's model documentation](https://platform.openai.com/docs/models) for available models.
 
 ### API key
 
@@ -248,7 +237,7 @@ h.last[:content]
 
 ## Web Search
 
-To give the model access to real-time information from the internet, you can enable web searching. This uses OpenAI's built-in `web_search_preview` tool.
+To give the model access to real-time information from the internet, you can enable web searching. This uses OpenAI's built-in `web_search` tool.
 
 ```ruby
 m = AI::Chat.new
@@ -257,17 +246,6 @@ m.user("What are the latest developments in the Ruby language?")
 m.generate! # This may use web search to find current information
 ```
 
-**Note:** This feature requires a model that supports the `web_search_preview` tool, such as `gpt-4o` or `gpt-4o-mini`. The gem will attempt to use a compatible model if you have `web_search` enabled.
-
-If you don't want the model to use web search, set `web_search` to `false` (this is the default):
-
-```ruby
-m = AI::Chat.new
-m.web_search = false
-m.user("What are the latest developments in the Ruby language?")
-m.generate! # This definitely won't use web search to find current information
-```
-
 ## Structured Output
 
 Get back Structured Output by setting the `schema` attribute (I suggest using [OpenAI's handy tool for generating the JSON Schema](https://platform.openai.com/docs/guides/structured-outputs)):
@@ -362,6 +340,40 @@ i.schema = '{"name":"nutrition_values","strict":true,"schema":{...}}'
 i.schema = '{"type":"object","properties":{...}}'
 ```
 
+### Generating a Schema
+
+You can call the class method `AI::Chat.generate_schema!` to use OpenAI to generate a JSON schema for you given a `String` describing the schema you want.
+
+```rb
+AI::Chat.generate_schema!("A user profile with name (required), email (required), age (number), and bio (optional text).")
+# => "{ ... }"
+```
+
+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 assume that you have an API key called `OPENAI_API_KEY` defined. You can also pass the API key directly or choose a different environment variable key for it to use.
+
+```rb
+# Passing the API key directly
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", api_key: "MY_SECRET_API_KEY")
+
+# Choosing a different API key name
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", api_key_env_var: "CUSTOM_KEY")
+```
+
+You can choose a location for the schema to save by using the `location` keyword argument.
+
+```rb
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", location: "my_schemas/user.json")
+```
+
+If you don't want to write the output to a file, you can pass `false` to `location`.
+
+```rb
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", location: false)
+# => { ... }
+```
+
 ### Schema Notes
 
 - The keys can be `String`s or `Symbol`s.
@@ -440,27 +452,6 @@ l.generate!
 
 **Note**: Images should use `image:`/`images:` parameters, while documents should use `file:`/`files:` parameters.
 
-## Re-sending old images and files
-
-Note: if you generate another API request using the same chat, old images and files in the conversation history will not be re-sent by default. If you really want to re-send old images and files, then you must set `previous_response_id` to `nil`:
-
-```ruby
-a = AI::Chat.new
-a.user("What color is the object in this photo?", image: "thing.png")
-a.generate! # => "Red"
-a.user("What is the object in the photo?")
-a.generate! # => { :content => "I don't see a photo", ... }
-
-b = AI::Chat.new
-b.user("What color is the object in this photo?", image: "thing.png")
-b.generate! # => "Red"
-b.user("What is the object in the photo?")
-b.previous_response_id = nil
-b.generate! # => { :content => "An apple", ... }
-```
-
-If you don't set `previous_response_id` to `nil`, the model won't have the old image(s) to work with.
-
 ## Image generation
 
 You can enable OpenAI's image generation tool:
@@ -574,25 +565,24 @@ puts response
 
 With this, you can loop through any conversation's history (perhaps after retrieving it from your database), recreate an `AI::Chat`, and then continue it.
 
-## Reasoning Models
+## Reasoning Effort
 
-When using reasoning models like `o3` or `o4-mini`, you can specify a reasoning effort level to control how much reasoning the model does before producing its final response:
+You can control how much reasoning the model does before producing its response:
 
 ```ruby
 l = AI::Chat.new
-l.model = "o3-mini"
-l.reasoning_effort = "medium" # Can be "low", "medium", or "high"
+l.reasoning_effort = "low" # Can be "low", "medium", or "high"
 
 l.user("What does this error message mean? <insert error message>")
 l.generate!
 ```
 
-The `reasoning_effort` parameter guides the model on how many reasoning tokens to generate before creating a response to the prompt. Options are:
+The `reasoning_effort` parameter guides the model on how many reasoning tokens to generate. Options are:
 - `"low"`: Favors speed and economical token usage.
-- `"medium"`: (Default) Balances speed and reasoning accuracy.
+- `"medium"`: Balances speed and reasoning accuracy.
 - `"high"`: Favors more complete reasoning.
 
-Setting to `nil` disables the reasoning parameter.
+By default, `reasoning_effort` is `nil`, which means no reasoning parameter is sent to the API. For `gpt-5.1` (the default model), this is equivalent to `"none"` reasoning.
 
 ## Advanced: Response Details
 
@@ -608,13 +598,13 @@ pp t.messages.last
 # => {
 #      :role => "assistant",
 #      :content => "Hello! How can I help you today?",
-#      :response => { id=resp_abc... model=gpt-4.1-nano tokens=12 }
+#      :response => { id=resp_abc... model=gpt-5.1 tokens=12 }
 #    }
 
 # Access detailed information
 response = t.last[:response]
 response[:id]           # => "resp_abc123..."
-response[:model]        # => "gpt-4.1-nano"
+response[:model]        # => "gpt-5.1"
 response[:usage]        # => {:prompt_tokens=>5, :completion_tokens=>7, :total_tokens=>12}
 ```
 
@@ -624,26 +614,24 @@ This information is useful for:
 - Understanding which model was actually used.
 - Future features like cost tracking.
 
-You can also, if you know a response ID, continue an old conversation by setting the `previous_response_id`:
+### Last Response ID
+
+In addition to the `response` object inside each message, the `AI::Chat` instance also provides a convenient reader, `last_response_id`, which always holds the ID of the most recent response.
 
 ```ruby
-t = AI::Chat.new
-t.user("Hello!")
-t.generate!
-old_id = t.last[:response][:id] # => "resp_abc123..."
+chat = AI::Chat.new
+chat.user("Hello")
+chat.generate!
 
-# Some time in the future...
+puts chat.last_response_id # => "resp_abc123..."
 
-u = AI::Chat.new
-u.previous_response_id = "resp_abc123..."
-u.user("What did I just say?")
-u.generate! # Will have context from the previous conversation}
-#    ]
-u.user("What should we do next?")
-u.generate!
+chat.user("Goodbye")
+chat.generate!
+
+puts chat.last_response_id # => "resp_xyz789..." (a new ID)
 ```
 
-Unless you've stored the previous messages somewhere yourself, this technique won't bring them back. But OpenAI remembers what they were, so that you can at least continue the conversation. (If you're using a reasoning model, this technique also preserves all of the model's reasoning.)
+This is particularly useful for managing background tasks. When you make a request in background mode, you can immediately get the `last_response_id` to track, retrieve, or cancel that specific job later from a different process.
 
 ### Automatic Conversation Management
 
@@ -673,8 +661,6 @@ chat.user("Continue our discussion")
 chat.generate!  # Uses the loaded conversation
 ```
 
-**Note on forking:** If you want to "fork" a conversation (create a branch), you can still use `previous_response_id`. If both `conversation_id` and `previous_response_id` are set, the gem will use `previous_response_id` and warn you.
-
 ## Inspecting Conversation Details
 
 The gem provides two methods to inspect what happened during a conversation:
@@ -778,9 +764,36 @@ q.messages = [
 
 ## Other Features Being Considered
 
-- **Session management**: Save and restore conversations by ID
 - **Streaming responses**: Real-time streaming as the AI generates its response
 - **Cost tracking**: Automatic calculation and tracking of API costs
+- **Token usage helpers**: Convenience methods like `total_tokens` to sum usage across all responses in a conversation
+
+## TODO: Missing Test Coverage
+
+The following gem-specific logic would benefit from additional RSpec test coverage:
+
+1. **Schema format normalization** - The `wrap_schema_if_needed` method detects and wraps 3 different input formats (raw, named, already-wrapped). This complex conditional logic could silently regress.
+
+2. **Multimodal content array building** - The `add` method builds nested structures when images/files are provided, handling `image`/`images` and `file`/`files` parameters with specific ordering (text → images → files).
+
+3. **File classification and processing** - `classify_obj` and `process_file_input` distinguish URLs vs file paths vs file-like objects, with MIME type detection determining encoding behavior.
+
+4. **Message preparation after response** - `prepare_messages_for_api` has slicing logic that only sends messages after the last response, preventing re-sending entire conversation history.
+
+These are all gem-specific transformations (not just OpenAI pass-through) that could regress without proper test coverage.
+
+## TODO: Code Quality
+
+Address Reek warnings (`bundle exec reek`). Currently 29 warnings for code smells like:
+
+- `TooManyStatements` in several methods
+- `DuplicateMethodCall` in `extract_and_save_files`, `verbose`, etc.
+- `RepeatedConditional` for `proxy` checks
+- `FeatureEnvy` in `parse_response` and `wait_for_response`
+
+These don't affect functionality but indicate areas for refactoring.
+
+Then, add `quality` back as a CI check.
 
 ## Testing with Real API Calls
 

data/ai-chat.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "ai-chat"
-  spec.version = "0.3.1"
+  spec.version = "0.4.0"
   spec.authors = ["Raghu Betina"]
   spec.email = ["raghu@firstdraft.com"]
   spec.homepage = "https://github.com/firstdraft/ai-chat"
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 3.2"
   spec.add_runtime_dependency "openai", "~> 0.34"
   spec.add_runtime_dependency "marcel", "~> 1.0"
-  spec.add_runtime_dependency "base64",  "~> 0.1", "> 0.1.1"
+  spec.add_runtime_dependency "base64", "~> 0.1", "> 0.1.1"
   spec.add_runtime_dependency "json", "~> 2.0"
   spec.add_runtime_dependency "ostruct", "~> 0.2"
   spec.add_runtime_dependency "tty-spinner", "~> 0.9.3"

data/lib/ai/amazing_print.rb

@@ -33,7 +33,7 @@ module AmazingPrint
     # :reek:TooManyStatements
     def format_ai_chat(chat)
       vars = []
-      
+
       # Format messages with truncation
       if chat.instance_variable_defined?(:@messages)
         messages = chat.instance_variable_get(:@messages).map do |msg|
@@ -45,7 +45,7 @@ module AmazingPrint
         end
         vars << ["@messages", messages]
       end
-      
+
       # Add other variables (except sensitive ones)
       skip_vars = [:@api_key, :@client, :@messages]
       chat.instance_variables.sort.each do |var|
@@ -68,7 +68,7 @@ module AmazingPrint
       if @options[:multiline]
         "#<#{object.class}\n#{data.map { |line| "  #{line}" }.join("\n")}\n>"
       else
-        "#<#{object.class} #{data.join(', ')}>"
+        "#<#{object.class} #{data.join(", ")}>"
       end
     end
   end

data/lib/ai/chat.rb

@@ -22,36 +22,35 @@ module AI
   # :reek:IrresponsibleModule
   class Chat
     # :reek:Attribute
-    attr_accessor :background, :code_interpreter, :conversation_id, :image_generation, :image_folder, :messages, :model, :proxy, :previous_response_id, :web_search
-    attr_reader :reasoning_effort, :client, :schema
+    attr_accessor :background, :code_interpreter, :conversation_id, :image_generation, :image_folder, :messages, :model, :proxy, :reasoning_effort, :web_search
+    attr_reader :client, :last_response_id, :schema, :schema_file
 
-    VALID_REASONING_EFFORTS = [:low, :medium, :high].freeze
-    PROXY_URL = "https://prepend.me/".freeze
+    PROXY_URL = "https://prepend.me/"
 
     def initialize(api_key: nil, api_key_env_var: "OPENAI_API_KEY")
       @api_key = api_key || ENV.fetch(api_key_env_var)
       @messages = []
       @reasoning_effort = nil
-      @model = "gpt-4.1-nano"
+      @model = "gpt-5.1"
       @client = OpenAI::Client.new(api_key: @api_key)
-      @previous_response_id = nil
+      @last_response_id = nil
       @proxy = false
       @image_generation = false
       @image_folder = "./images"
     end
 
-    def self.generate_schema!(description, api_key: nil, api_key_env_var: "OPENAI_API_KEY", proxy: false)
+    def self.generate_schema!(description, location: "schema.json", api_key: nil, api_key_env_var: "OPENAI_API_KEY", proxy: false)
       api_key ||= ENV.fetch(api_key_env_var)
       prompt_path = File.expand_path("../prompts/schema_generator.md", __dir__)
-      system_prompt = File.open(prompt_path).read
+      system_prompt = File.read(prompt_path)
 
       json = if proxy
         uri = URI(PROXY_URL + "api.openai.com/v1/responses")
         parameters = {
-          model: "o4-mini",
+          model: "gpt-5.1",
           input: [
             {role: :system, content: system_prompt},
-            {role: :user, content: description},
+            {role: :user, content: description}
           ],
           text: {format: {type: "json_object"}},
           reasoning: {effort: "high"}
@@ -61,7 +60,7 @@ module AI
       else
         client = OpenAI::Client.new(api_key: api_key)
         response = client.responses.create(
-          model: "o4-mini",
+          model: "gpt-5.1",
           input: [
             {role: :system, content: system_prompt},
             {role: :user, content: description}
@@ -73,7 +72,13 @@ module AI
         output_text = response.output_text
         JSON.parse(output_text)
       end
-      JSON.pretty_generate(json)
+      content = JSON.pretty_generate(json)
+      if location
+        path = Pathname.new(location)
+        FileUtils.mkdir_p(path.dirname) if path.dirname != "."
+        File.binwrite(location, content)
+      end
+      content
     end
 
     # :reek:TooManyStatements
@@ -146,7 +151,7 @@ module AI
       response = create_response
       parse_response(response)
 
-      self.previous_response_id = last.dig(:response, :id) unless (conversation_id && !background)
+      @last_response_id = last.dig(:response, :id)
       last
     end
 
@@ -158,29 +163,11 @@ module AI
       response = if wait
         wait_for_response(timeout)
       else
-        retrieve_response(previous_response_id)
+        retrieve_response(last_response_id)
       end
       parse_response(response)
     end
 
-    # :reek:NilCheck
-    # :reek:TooManyStatements
-    def reasoning_effort=(value)
-      if value.nil?
-        @reasoning_effort = nil
-        return
-      end
-
-      normalized_value = value.to_sym
-
-      if VALID_REASONING_EFFORTS.include?(normalized_value)
-        @reasoning_effort = normalized_value
-      else
-        valid_values = VALID_REASONING_EFFORTS.map { |valid_value| ":#{valid_value} or \"#{valid_value}\"" }.join(", ")
-        raise ArgumentError, "Invalid reasoning_effort value: '#{value}'. Must be one of: #{valid_values}"
-      end
-    end
-
     def schema=(value)
       if value.is_a?(String)
         parsed = JSON.parse(value, symbolize_names: true)
@@ -192,6 +179,12 @@ module AI
       end
     end
 
+    def schema_file=(path)
+      content = File.read(path)
+      @schema_file = path
+      self.schema = content
+    end
+
     def last
       messages.last
     end
@@ -200,12 +193,12 @@ module AI
       raise "No conversation_id set. Call generate! first to create a conversation." unless conversation_id
 
       if proxy
-        uri = URI(PROXY_URL + "api.openai.com/v1/conversations/#{conversation_id}/items?order=#{order.to_s}")
+        uri = URI(PROXY_URL + "api.openai.com/v1/conversations/#{conversation_id}/items?order=#{order}")
         response_hash = send_request(uri, content_type: "json", method: "get")
 
         if response_hash.key?(:data)
           response_hash.dig(:data).map do |hash|
-            # Transform values to allow expected symbols that non-proxied request returns 
+            # Transform values to allow expected symbols that non-proxied request returns
 
             hash.transform_values! do |value|
               if hash.key(value) == :type
@@ -283,6 +276,7 @@ module AI
     private
 
     class InputClassificationError < StandardError; end
+
     class WrongAPITokenUsedError < StandardError; end
 
     # :reek:FeatureEnvy
@@ -320,16 +314,8 @@ module AI
       parameters[:text] = schema if schema
       parameters[:reasoning] = {effort: reasoning_effort} if reasoning_effort
 
-      if previous_response_id && conversation_id
-        warn "Both conversation_id and previous_response_id are set. Using previous_response_id for forking. Only set one."
-        parameters[:previous_response_id] = previous_response_id
-      elsif previous_response_id
-        parameters[:previous_response_id] = previous_response_id
-      elsif conversation_id
-        parameters[:conversation] = conversation_id
-      else
-        create_conversation
-      end
+      create_conversation unless conversation_id
+      parameters[:conversation] = conversation_id
 
       messages_to_send = prepare_messages_for_api
       parameters[:input] = strip_responses(messages_to_send) unless messages_to_send.empty?
@@ -367,7 +353,7 @@ module AI
         if response.key?(:conversation)
           self.conversation_id = response.dig(:conversation, :id)
         end
-      else        
+      else
         text_response = response.output_text
         response_id = response.id
         response_status = response.status
@@ -419,16 +405,16 @@ module AI
     end
 
     def cancel_request
-      client.responses.cancel(previous_response_id)
+      client.responses.cancel(last_response_id)
     end
 
     def prepare_messages_for_api
-      return messages unless previous_response_id
+      return messages unless last_response_id
 
-      previous_response_index = messages.find_index { |message| message.dig(:response, :id) == previous_response_id }
+      last_response_index = messages.find_index { |message| message.dig(:response, :id) == last_response_id }
 
-      if previous_response_index
-        messages[(previous_response_index + 1)..] || []
+      if last_response_index
+        messages[(last_response_index + 1)..] || []
       else
         messages
       end
@@ -564,7 +550,7 @@ module AI
     def tools
       tools_list = []
       if web_search
-        tools_list << {type: "web_search_preview"}
+        tools_list << {type: "web_search"}
       end
       if image_generation
         tools_list << {type: "image_generation"}
@@ -605,12 +591,12 @@ module AI
     def extract_and_save_images(response)
       image_filenames = []
 
-      if proxy
-        image_outputs = response.dig(:output).select { |output|
+      image_outputs = if proxy
+        response.dig(:output).select { |output|
           output.dig(:type) == "image_generation_call"
         }
-      else       
-        image_outputs = response.output.select { |output|
+      else
+        response.output.select { |output|
           output.respond_to?(:type) && output.type == :image_generation_call
         }
       end
@@ -694,7 +680,7 @@ module AI
         message_outputs = response.dig(:output).select do |output|
           output.dig(:type) == "message"
         end
-  
+
         outputs_with_annotations = message_outputs.map do |message|
           message.dig(:content).find do |content|
             content.dig(:annotations).length.positive?
@@ -704,7 +690,7 @@ module AI
         message_outputs = response.output.select do |output|
           output.respond_to?(:type) && output.type == :message
         end
-  
+
         outputs_with_annotations = message_outputs.map do |message|
           message.content.find do |content|
             content.respond_to?(:annotations) && content.annotations.length.positive?
@@ -723,12 +709,12 @@ module AI
             annotation.key?(:filename)
           end
         end.compact
-  
+
         annotations.each do |annotation|
           container_id = annotation.dig(:container_id)
           file_id = annotation.dig(:file_id)
           filename = annotation.dig(:filename)
-  
+
           warn_if_file_fails_to_save do
             file_content = retrieve_file(file_id, container_id: container_id)
             file_path = File.join(subfolder_path, filename)
@@ -742,18 +728,16 @@ module AI
             annotation.respond_to?(:filename)
           end
         end.compact
-  
+
         annotations.each do |annotation|
           container_id = annotation.container_id
           file_id = annotation.file_id
           filename = annotation.filename
-  
+
           warn_if_file_fails_to_save do
             file_content = retrieve_file(file_id, container_id: container_id)
             file_path = File.join(subfolder_path, filename)
-            File.open(file_path, "wb") do |file|
-              file.write(file_content.read)
-            end
+            File.binwrite(file_path, file_content.read)
             filenames << file_path
           end
         end
@@ -776,53 +760,53 @@ module AI
         yield
       end
     rescue Timeout::Error
-      client.responses.cancel(previous_response_id)
+      client.responses.cancel(last_response_id)
     end
 
     # :reek:DuplicateMethodCall
     # :reek:TooManyStatements
     def wait_for_response(timeout)
-        spinner = TTY::Spinner.new("[:spinner] Thinking ...", format: :dots)
-        spinner.auto_spin
-        api_response = retrieve_response(previous_response_id)
-        number_of_times_polled = 0
-        response = timeout_request(timeout) do
+      spinner = TTY::Spinner.new("[:spinner] Thinking ...", format: :dots)
+      spinner.auto_spin
+      api_response = retrieve_response(last_response_id)
+      number_of_times_polled = 0
+      response = timeout_request(timeout) do
+        status = if api_response.respond_to?(:status)
+          api_response.status
+        else
+          api_response.dig(:status)&.to_sym
+        end
+
+        while status != :completed
+          some_amount_of_seconds = calculate_wait(number_of_times_polled)
+          sleep some_amount_of_seconds
+          number_of_times_polled += 1
+          api_response = retrieve_response(last_response_id)
           status = if api_response.respond_to?(:status)
             api_response.status
-          else 
+          else
             api_response.dig(:status)&.to_sym
           end
-
-          while status != :completed
-            some_amount_of_seconds = calculate_wait(number_of_times_polled)
-            sleep some_amount_of_seconds
-            number_of_times_polled += 1
-            api_response = retrieve_response(previous_response_id)
-            status = if api_response.respond_to?(:status)
-              api_response.status
-            else
-              api_response.dig(:status)&.to_sym
-            end
-          end
-          api_response
-        end
-        
-        status = if api_response.respond_to?(:status)
-          api_response.status
-        else 
-          api_response.dig(:status).to_sym
         end
-        exit_message = status == :cancelled ? "request timed out" : "done!"
-        spinner.stop(exit_message)
-        response
+        api_response
+      end
+
+      status = if api_response.respond_to?(:status)
+        api_response.status
+      else
+        api_response.dig(:status).to_sym
+      end
+      exit_message = (status == :cancelled) ? "request timed out" : "done!"
+      spinner.stop(exit_message)
+      response
     end
 
-    def retrieve_response(previous_response_id)
+    def retrieve_response(response_id)
       if proxy
-        uri = URI(PROXY_URL + "api.openai.com/v1/responses/#{previous_response_id}")
+        uri = URI(PROXY_URL + "api.openai.com/v1/responses/#{response_id}")
         send_request(uri, content_type: "json", method: "get")
       else
-        client.responses.retrieve(previous_response_id)
+        client.responses.retrieve(response_id)
       end
     end
 
@@ -832,7 +816,7 @@ module AI
         send_request(uri, method: "get")
       else
         container_content = client.containers.files.content
-        file_content = container_content.retrieve(file_id, container_id: container_id)
+        container_content.retrieve(file_id, container_id: container_id)
       end
     end
   end

data/lib/ai/http.rb

@@ -1,7 +1,7 @@
 require "net/http"
 module AI
   module Http
-    def send_request(uri, content_type: nil, parameters: nil, method:)
+    def send_request(uri, method:, content_type: nil, parameters: nil)
       Net::HTTP.start(uri.host, 443, use_ssl: true) do |http|
         headers = {
           "Authorization" => "Bearer #{@api_key}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ai-chat
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Raghu Betina
 bindir: bin
 cert_chain: []
-date: 2025-11-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openai
@@ -146,8 +146,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - LICENSE
 - README.md
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A beginner-friendly Ruby interface for OpenAI's API
 test_files: []