openai-chat 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356c73f7aa65e6bbb6a89fcb8c1764232a764f22c412d646405a2e05f112fefc
-  data.tar.gz: 6b6b842391c42aa797e6199ef65875fe7b35121fa65985e141ce6aeffb30023c
+  metadata.gz: 82f44ec692941bead59c002656f2bf520b4bfa61228ece8e885e2c96fb946e1a
+  data.tar.gz: e88e9127a305b73a6407f8cbb34725187c1c30f981c1008c672a8c18146673cd
 SHA512:
-  metadata.gz: d94a2829fc56f46a2a485b3b3a4d0260a60d9eba88acb24cdafff5294a3760098ca0f85821fb8a844359bcb25268aacb73a7c89455fe05c67f57431a4ac8f0b4
-  data.tar.gz: 00eb5dd473c308f75727d8bce37cb87ce753e7482406183fd9c8f189a6c2f0fb0b956bb6a8b69363954aa4f3da89df5b262f1953915e125986adf2a4b27dd999
+  metadata.gz: bacb325cadef5c7d6846d550041b11e207e26681707d0ef399926d6e87196594bf06a29211dc4825b0134d4b9067c5129f9422e0260a6c78d2f127d02b665f56
+  data.tar.gz: 13f1ffa286c1627c2777390177d84dc5dfc96b33293a072370e938de0b18e9fbb898e4cfcd080118231502b3fb107e47b11370fae6e753cef589b632a9e286c7

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.standard.yml

@@ -0,0 +1,11 @@
+ruby_version: 2.0
+fix: true
+parallel: true
+
+ignore:
+  - 'vendor/**/*'
+  - 'spec/fixtures/**/*'
+  - 'spec/vcr_cassettes/**/*'
+  - '*.md'
+  - '*.markdown'
+  - 'LICENSE*'

data/Gemfile.lock

@@ -1,17 +1,129 @@
 PATH
   remote: .
   specs:
-    openai-chat (0.0.2)
+    openai-chat (0.0.3)
+      mime-types (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    factory_bot (6.5.1)
+      activesupport (>= 6.1.0)
+    hashdiff (1.1.2)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    mime-types (3.6.0)
+      logger
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2025.0304)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.69.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    standard (1.43.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.69.1)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
+  factory_bot (~> 6.2)
   openai-chat!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  standard (~> 1.32)
+  vcr (~> 6.1)
+  webmock (~> 3.18)
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -2,7 +2,40 @@
 
 This gem provides a class called `OpenAI::Chat` that is intended to make it as easy as possible to use OpenAI's Chat Completions endpoint.
 
-For example:
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "openai-chat", github: "firstdraft/openai-chat"
+```
+
+And then, at a command prompt:
+
+```
+bundle install
+```
+
+Or, install it directly with:
+
+```
+gem install openai-chat
+```
+
+## Configuration
+
+- By default, the gem assumes you have an environment variable called exactly `OPENAI_TOKEN`. If not, you can also provide your token when instantiating a chat:
+
+    ```ruby
+    x = OpenAI::Chat.new(api_token: "your-token-goes-here")
+    ```
+- By default, the gem uses the `gpt-4o` model. If you want something else, you can set it:
+
+    ```ruby
+    x.model = "o3-mini"
+    ```
+
+## Simplest usage
 
 ```ruby
 x = OpenAI::Chat.new
@@ -16,7 +49,9 @@ x.assistant!
 # => "Ah, the fair and bustling city of Chicago, renowned for its deep-dish delight that hath captured hearts and stomachs aplenty. Amongst the many offerings of this great city, 'tis often said that Lou Malnati's and Giordano's art the titans of the deep-dish realm. Lou Malnati's crust is praised for its buttery crispness, whilst Giordano's doth boast a stuffed creation that is nigh unto legendary. Yet, I encourage thee to embark upon thine own quest and savor the offerings of these famed establishments, for in the tasting lies the truth of which thy palate prefers. Enjoy the gastronomic adventure, my friend."
 ```
 
-Or, with Structured Output (I suggest using [OpenAI's handy tool for generating the JSON Schema](https://platform.openai.com/docs/guides/structured-outputs)):
+## 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)):
 
 ```ruby
 x = OpenAI::Chat.new
@@ -27,50 +62,72 @@ x.assistant!
 # => {"fat"=>15, "protein"=>5, "carbs"=>50, "total_calories"=>350}
 ```
 
-More details:
+## Include images
 
-- By default, the gem assumes you have an environment variable called exactly `OPENAI_TOKEN`. If not, you can also provide your token when instantiating a chat:
+You can include images in your chat messages using the `user` method with the `image` or `images` parameter:
 
-    ```ruby
-    x = OpenAI::Chat.new(api_token: "your-token-goes-here")
-    ```
-- By default, the gem uses the `gpt-4o` model. If you want something else, you can set it:
+```ruby
+# Send a single image
+x.user("What's in this image?", image: "path/to/local/image.jpg")
 
-    ```ruby
-    x.model = "o3-mini"
-    ```
-- You can call `.messages` to get an array containing the conversation so far.
-- You can manually set the assistant message
-    ```rb
-    x.assistant("Greetings, good sir or madam! How dost thou fare on this fine day? Pray, tell me how I may be of service to thee.")
-    ```
+# Send multiple images
+x.user("What are these images showing?", images: ["path/to/image1.jpg", "https://example.com/image2.jpg"])
+```
 
-Enjoy!
+The gem supports three types of image inputs:
 
-## Installation
+- URLs: Pass an image URL starting with `http://` or `https://`.
+- File paths: Pass a string with a path to a local image file.
+- File-like objects: Pass an object that responds to `read` (like `File.open("image.jpg")` or a Rails uploaded file).
 
-Add this line to your application's Gemfile:
+You can send multiple images, and place them between bits of text, in a single user message:
 
 ```ruby
-gem "openai-chat", github: "firstdraft/openai-chat"
+z = OpenAI::Chat.new
+z.user(
+  [
+    {"image" => "https://upload.wikimedia.org/wikipedia/commons/thumb/6/6a/Eubalaena_glacialis_with_calf.jpg/215px-Eubalaena_glacialis_with_calf.jpg"},
+    {"text" => "What is in the above image? What is in the below image?"},
+    {"image" => "https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/Elephant_Diversity.jpg/305px-Elephant_Diversity.jpg"},
+    {"text" => "What are the differences between the images?"}
+  ]
+)
+z.assistant!
 ```
 
-And then, at a command prompt:
+Both string and symbol keys are supported for the hash items:
 
-```
-bundle install
+```ruby
+z = OpenAI::Chat.new
+z.user(
+  [
+    {image: "https://upload.wikimedia.org/wikipedia/commons/thumb/6/6a/Eubalaena_glacialis_with_calf.jpg/215px-Eubalaena_glacialis_with_calf.jpg"},
+    {text: "What is in the above image? What is in the below image?"},
+    {image: "https://upload.wikimedia.org/wikipedia/commons/thumb/1/1a/Elephant_Diversity.jpg/305px-Elephant_Diversity.jpg"},
+    {text: "What are the differences between the images?"}
+  ]
+)
+z.assistant!
 ```
 
-Or, install it directly with:
+## Set assistant messages manually
 
+You can manually add assistant messages:
+
+```rb
+x.assistant("Greetings, good sir or madam! How dost thou fare on this fine day? Pray, tell me how I may be of service to thee.")
 ```
-gem install openai-chat
-```
+
+Useful if you are reconstructing old messages from a chat that has already happened.
+
+## Getting and setting messages directly
+
+- You can call `.messages` to get an array containing the conversation so far.
+- TODO: Setting `.messages` will replace the conversation with the provided array.
 
 ## TODOs
 
 - Add a `reasoning_effort` parameter.
-- Add the ability to send images.
 - Add the ability to set all messages at once, ideally with an ActiveRecord Relation.
 - Add a way to access the whole API response body (rather than just the message content).
 - Add specs.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run standardrb and rspec tests"
+task default: [:standard, :spec]

data/lib/openai/chat/version.rb

@@ -2,6 +2,6 @@
 
 module OpenAI
   class Chat
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/openai/chat.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require "openai/chat/version"
-require "net/http"
-require "uri"
-require "json"
+# All dependencies are now required in the main openai-chat.rb file
 
 module OpenAI
   class Chat
@@ -19,8 +16,78 @@ module OpenAI
       messages.push({role: "system", content: content})
     end
 
-    def user(content)
-      messages.push({role: "user", content: content})
+    def user(content, image: nil, images: nil)
+      if content.is_a?(Array)
+        processed_content = content.map do |item|
+          if item.key?("image") || item.key?(:image)
+            image_value = item.fetch("image") { item.fetch(:image) }
+            {
+              type: "image_url",
+              image_url: {
+                url: process_image(image_value)
+              }
+            }
+          elsif item.key?("text") || item.key?(:text)
+            text_value = item.fetch("text") { item.fetch(:text) }
+            {
+              type: "text",
+              text: text_value
+            }
+          else
+            item
+          end
+        end
+
+        messages.push(
+          {
+            role: "user",
+            content: processed_content
+          }
+        )
+      elsif image.nil? && images.nil?
+        messages.push(
+          {
+            role: "user",
+            content: content
+          }
+        )
+      else
+        text_and_images_array = [
+          {
+            type: "text",
+            text: content
+          }
+        ]
+
+        if images && !images.empty?
+          images_array = images.map do |image|
+            {
+              type: "image_url",
+              image_url: {
+                url: process_image(image)
+              }
+            }
+          end
+
+          text_and_images_array += images_array
+        else
+          text_and_images_array.push(
+            {
+              type: "image_url",
+              image_url: {
+                url: process_image(image)
+              }
+            }
+          )
+        end
+
+        messages.push(
+          {
+            role: "user",
+            content: text_and_images_array
+          }
+        )
+      end
     end
 
     def assistant(content)
@@ -30,7 +97,7 @@ module OpenAI
     def assistant!
       request_headers_hash = {
         "Authorization" => "Bearer #{@api_token}",
-        "content-type" => "application/json",
+        "content-type" => "application/json"
       }
 
       response_format = if schema.nil?
@@ -71,5 +138,73 @@ module OpenAI
     def inspect
       "#<#{self.class.name} @messages=#{messages.inspect} @model=#{@model.inspect} @schema=#{@schema.inspect}>"
     end
+
+    private
+
+    # Custom exception class for input classification errors.
+    class InputClassificationError < StandardError; end
+
+    def classify_obj(obj)
+      if obj.is_a?(String)
+        # Attempt to parse as a URL.
+        begin
+          uri = URI.parse(obj)
+          if uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+            return :url
+          end
+        rescue URI::InvalidURIError
+          # Not a valid URL; continue to check if it's a file path.
+        end
+
+        # Check if the string represents a local file path (must exist on disk).
+        if File.exist?(obj)
+          :file_path
+        else
+          raise InputClassificationError,
+            "String provided is neither a valid URL (must start with http:// or https://) nor an existing file path on disk. Received value: #{obj.inspect}"
+        end
+      elsif obj.respond_to?(:read)
+        # For non-String objects, check if it behaves like a file.
+        :file_like
+      else
+        raise InputClassificationError,
+          "Object provided is neither a String nor file-like (missing :read method). Received value: #{obj.inspect}"
+      end
+    end
+
+    def process_image(obj)
+      case classify_obj(obj)
+      when :url
+        obj
+      when :file_path
+        file_path = obj
+
+        mime_type = MIME::Types.type_for(file_path).first.to_s
+
+        image_data = File.binread(file_path)
+
+        base64_string = Base64.strict_encode64(image_data)
+
+        "data:#{mime_type};base64,#{base64_string}"
+      when :file_like
+        filename = if obj.respond_to?(:path)
+          obj.path
+        elsif obj.respond_to?(:original_filename)
+          obj.original_filename
+        else
+          "unknown"
+        end
+
+        mime_type = MIME::Types.type_for(filename).first.to_s
+        mime_type = "image/jpeg" if mime_type.empty?
+
+        image_data = obj.read
+        obj.rewind if obj.respond_to?(:rewind)
+
+        base64_string = Base64.strict_encode64(image_data)
+
+        "data:#{mime_type};base64,#{base64_string}"
+      end
+    end
   end
 end

data/lib/openai-chat.rb

@@ -1 +1,11 @@
+# All gem dependencies
+require "mime/types"
+require "base64"
+require "json"
+require "net/http"
+require "pathname"
+require "uri"
+
+# Internal gem files
+require "openai/chat/version"
 require "openai/chat"

metadata

@@ -1,16 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: openai-chat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Raghu Betina
 - Jelani Woods
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-01 00:00:00.000000000 Z
-dependencies: []
+date: 2025-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
 description: This gem provides a class called `OpenAI::Chat` that is intended to make
   it as easy as possible to use OpenAI's Chat Completions endpoint. Supports Structured
   Output.
@@ -21,12 +118,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
 - lib/openai-chat.rb
 - lib/openai/chat.rb
 - lib/openai/chat/version.rb
@@ -37,7 +137,6 @@ metadata:
   homepage_uri: https://github.com/firstdraft/openai-chat
   source_code_uri: https://github.com/firstdraft/openai-chat
   changelog_uri: https://github.com/firstdraft/openai-chat/blob/main/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
 summary: This gem provides a class called `OpenAI::Chat` that is intended to make
   it as easy as possible to use OpenAI's Chat Completions endpoint.