ai-chat 0.3.2 → 0.5.0

data/ai-chat.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |spec|
   spec.name = "ai-chat"
-  spec.version = "0.3.2"
-  spec.authors = ["Raghu Betina"]
-  spec.email = ["raghu@firstdraft.com"]
+  spec.version = "0.5.0"
+  spec.authors = ["Raghu Betina", "Jelani Woods"]
+  spec.email = ["raghu@firstdraft.com", "jelani@firstdraft.com"]
   spec.homepage = "https://github.com/firstdraft/ai-chat"
   spec.summary = "A beginner-friendly Ruby interface for OpenAI's API"
   spec.license = "MIT"
@@ -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

@@ -1,4 +1,22 @@
 require "amazing_print"
+
+# Fix AmazingPrint's colorless method to strip HTML tags in addition to ANSI codes.
+# Without this, alignment is broken when html: true because colorless_size
+# doesn't account for <kbd> tag lengths.
+# TODO: Remove if https://github.com/amazing-print/amazing_print/pull/146 is merged.
+module AmazingPrint
+  module Formatters
+    class BaseFormatter
+      alias_method :original_colorless, :colorless
+
+      def colorless(string)
+        result = original_colorless(string)
+        result.gsub(/<kbd[^>]*>|<\/kbd>/, "")
+      end
+    end
+  end
+end
+
 # :reek:IrresponsibleModule
 module AmazingPrint
   module AI
@@ -27,33 +45,11 @@ module AmazingPrint
       end
     end
 
-    # :reek:DuplicateMethodCall
     # :reek:FeatureEnvy
-    # :reek:NilCheck
-    # :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|
-          truncated_msg = msg.dup
-          if msg[:content].is_a?(String) && msg[:content].length > 80
-            truncated_msg[:content] = msg[:content][0..77] + "..."
-          end
-          truncated_msg
-        end
-        vars << ["@messages", messages]
+      vars = chat.inspectable_attributes.map do |(name, value)|
+        [name.to_s, value]
       end
-      
-      # Add other variables (except sensitive ones)
-      skip_vars = [:@api_key, :@client, :@messages]
-      chat.instance_variables.sort.each do |var|
-        next if skip_vars.include?(var)
-        value = chat.instance_variable_get(var)
-        vars << [var.to_s, value] unless value.nil?
-      end
-
       format_object(chat, vars)
     end
 
@@ -65,10 +61,13 @@ module AmazingPrint
         "#{name}: #{inspector.awesome(value)}"
       end
 
+      lt = @options[:html] ? "&lt;" : "<"
+      gt = @options[:html] ? "&gt;" : ">"
+
       if @options[:multiline]
-        "#<#{object.class}\n#{data.map { |line| "  #{line}" }.join("\n")}\n>"
+        "##{lt}#{object.class}\n#{data.map { |line| "  #{line}" }.join("\n")}\n#{gt}"
       else
-        "#<#{object.class} #{data.join(', ')}>"
+        "##{lt}#{object.class} #{data.join(", ")}#{gt}"
       end
     end
   end

data/lib/ai/chat.rb

@@ -12,7 +12,6 @@ require "tty-spinner"
 require "timeout"
 
 require_relative "http"
-include AI::Http
 
 module AI
   # :reek:MissingSafeMethod { exclude: [ generate! ] }
@@ -21,20 +20,21 @@ module AI
   # :reek:InstanceVariableAssumption
   # :reek:IrresponsibleModule
   class Chat
+    include AI::Http
+
     # :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, :schema_file
+    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.2"
       @client = OpenAI::Client.new(api_key: @api_key)
-      @previous_response_id = nil
+      @last_response_id = nil
       @proxy = false
       @image_generation = false
       @image_folder = "./images"
@@ -43,15 +43,15 @@ module AI
     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: "gpt-5.1",
+          model: "gpt-5.2",
           input: [
             {role: :system, content: system_prompt},
-            {role: :user, content: description},
+            {role: :user, content: description}
           ],
           text: {format: {type: "json_object"}},
           reasoning: {effort: "high"}
@@ -61,7 +61,7 @@ module AI
       else
         client = OpenAI::Client.new(api_key: api_key)
         response = client.responses.create(
-          model: "gpt-5.1",
+          model: "gpt-5.2",
           input: [
             {role: :system, content: system_prompt},
             {role: :user, content: description}
@@ -77,9 +77,7 @@ module AI
       if location
         path = Pathname.new(location)
         FileUtils.mkdir_p(path.dirname) if path.dirname != "."
-        File.open(location, "wb") do |file|
-          file.write(content)
-        end
+        File.binwrite(location, content)
       end
       content
     end
@@ -87,15 +85,12 @@ module AI
     # :reek:TooManyStatements
     # :reek:NilCheck
     def add(content, role: "user", response: nil, status: nil, image: nil, images: nil, file: nil, files: nil)
-      if image.nil? && images.nil? && file.nil? && files.nil?
-        message = {
-          role: role,
-          content: content,
-          response: response
-        }
-        message[:content] = content if content
-        message[:status] = status if status
-        messages.push(message)
+      message = if image.nil? && images.nil? && file.nil? && files.nil?
+        msg = Message[role: role]
+        msg[:content] = content if content
+        msg[:response] = response if response
+        msg[:status] = status if status
+        msg
       else
         text_and_files_array = [
           {
@@ -125,14 +120,15 @@ module AI
           text_and_files_array.push(process_file_input(file))
         end
 
-        messages.push(
-          {
-            role: role,
-            content: text_and_files_array,
-            status: status
-          }
-        )
+        Message[
+          role: role,
+          content: text_and_files_array,
+          status: status
+        ]
       end
+
+      messages.push(message)
+      message
     end
 
     def system(message)
@@ -154,7 +150,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
 
@@ -166,29 +162,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)
@@ -201,7 +179,7 @@ module AI
     end
 
     def schema_file=(path)
-      content = File.open(path).read
+      content = File.read(path)
       @schema_file = path
       self.schema = content
     end
@@ -210,16 +188,16 @@ module AI
       messages.last
     end
 
-    def items(order: :asc)
+    def get_items(order: :asc)
       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}")
+      raw_items = if proxy
+        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
@@ -236,67 +214,56 @@ module AI
       else
         client.conversations.items.list(conversation_id, order: order)
       end
+
+      Items.new(raw_items, conversation_id: conversation_id)
     end
 
-    def verbose
-      page = items
+    def inspectable_attributes
+      attrs = []
+
+      # 1. Model and reasoning (configuration)
+      attrs << [:@model, @model]
+      attrs << [:@reasoning_effort, @reasoning_effort]
+
+      # 2. Conversation state
+      attrs << [:@conversation_id, @conversation_id]
+      attrs << [:@last_response_id, @last_response_id] if @last_response_id
+
+      # 3. Messages (the main content, without response details)
+      display_messages = @messages.map { |msg| msg.except(:response) }
+      attrs << [:@messages, display_messages]
 
-      box_width = 78
-      inner_width = box_width - 4
+      # 4. Optional features (only if enabled/changed from default)
+      attrs << [:@proxy, @proxy] if @proxy != false
+      attrs << [:@image_generation, @image_generation] if @image_generation != false
+      attrs << [:@image_folder, @image_folder] if @image_folder != "./images"
 
-      puts
-      puts "┌#{"─" * (box_width - 2)}┐"
-      puts "│ Conversation: #{conversation_id.ljust(inner_width - 14)} │"
-      puts "│ Items: #{page.data.length.to_s.ljust(inner_width - 7)} │"
-      puts "└#{"─" * (box_width - 2)}┘"
-      puts
+      # 5. Optional state (only if set)
+      attrs << [:@background, @background] if @background
+      attrs << [:@code_interpreter, @code_interpreter] if @code_interpreter
+      attrs << [:@web_search, @web_search] if @web_search
+      attrs << [:@schema, @schema] if @schema
+      attrs << [:@schema_file, @schema_file] if @schema_file
 
-      ap page.data, limit: 10, indent: 2
+      attrs
     end
 
     def inspect
-      "#<#{self.class.name} @messages=#{messages.inspect} @model=#{@model.inspect} @schema=#{@schema.inspect} @reasoning_effort=#{@reasoning_effort.inspect}>"
+      ai(plain: !$stdout.tty?, multiline: true)
     end
 
-    # Support for Ruby's pp (pretty print)
-    # :reek:TooManyStatements
-    # :reek:NilCheck
-    # :reek:FeatureEnvy
-    # :reek:DuplicateMethodCall
-    # :reek:UncommunicativeParameterName
-    def pretty_print(q)
-      q.group(1, "#<#{self.class}", ">") do
-        q.breakable
-
-        # Show messages with truncation
-        q.text "@messages="
-        truncated_messages = @messages.map do |msg|
-          truncated_msg = msg.dup
-          if msg[:content].is_a?(String) && msg[:content].length > 80
-            truncated_msg[:content] = msg[:content][0..77] + "..."
-          end
-          truncated_msg
-        end
-        q.pp truncated_messages
-
-        # Show other instance variables (except sensitive ones)
-        skip_vars = [:@messages, :@api_key, :@client]
-        instance_variables.sort.each do |var|
-          next if skip_vars.include?(var)
-          value = instance_variable_get(var)
-          unless value.nil?
-            q.text ","
-            q.breakable
-            q.text "#{var}="
-            q.pp value
-          end
-        end
-      end
+    def to_html
+      AI.wrap_html(ai(html: true, multiline: true))
+    end
+
+    def pretty_inspect
+      "#{inspect}\n"
     end
 
     private
 
     class InputClassificationError < StandardError; end
+
     class WrongAPITokenUsedError < StandardError; end
 
     # :reek:FeatureEnvy
@@ -332,18 +299,10 @@ module AI
       parameters[:background] = background if background
       parameters[:tools] = tools unless tools.empty?
       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
+      parameters[:reasoning] = {effort: reasoning_effort, summary: "auto"} if reasoning_effort
+
+      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?
@@ -381,7 +340,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
@@ -415,12 +374,12 @@ module AI
         message.dig(:response, :id) == response_id
       end
 
-      message = {
+      message = Message[
         role: "assistant",
         content: response_content,
         response: chat_response,
         status: response_status
-      }
+      ]
 
       message.store(:images, image_filenames) unless image_filenames.empty?
 
@@ -428,21 +387,22 @@ module AI
         messages[existing_message_position] = message
       else
         messages.push(message)
-        message
       end
+
+      message
     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
@@ -578,7 +538,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"}
@@ -619,12 +579,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
@@ -708,7 +668,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?
@@ -718,7 +678,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?
@@ -737,12 +697,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)
@@ -756,18 +716,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
@@ -790,53 +748,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
 
@@ -846,7 +804,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}"