openai_ruby 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91361df72462f49209491acf92303a7fb6f47ab9a947303da373b8345b7736c4
-  data.tar.gz: 5bb2b48ff21f949605e2fe9072dfd9d324c0ce4803462fc6c3c83a19b8fd2d1a
+  metadata.gz: 594ce65bf8ef1e8ef1202b306b400a231bfd0977ca26677bbc2e4420fb8c8d72
+  data.tar.gz: 852da6bdffa4213f39eb830929377718b043d411a837cca4dc0fab134620ed0e
 SHA512:
-  metadata.gz: cb209a9bafe457eebd91e7467e96e3b87433d6e8807a0b0be2e9427fa4b1b4e7cd782ea8aaea21c6283009188aecf7721b025dd62414cc940bb8d03fe6de8888
-  data.tar.gz: '03186808fd04b88f991d53eed795f0fe56ca801d67bb4db7e7eae3f615cafe5473c6c7121d9b4d0d975acf450bd7e3bed587ffff6846dcd72e3a47aa82ea523f'
+  metadata.gz: 9496bd88696075720d6f1a79d7a15723f8eaa9663b8a629e74190248d6d4180ff8f51ff631bc66280acc74196ebaf305b087d49626a29c281a1e0449ec3515a9
+  data.tar.gz: 7aca0a20dd3bc82051aa2c101f2f4d407a108e55ad823aa893fe444b8ea140df579226c23b63b26b2a11b5ec795be76bc0cc8ba4a6b17854144be15f94db296a

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    openai_ruby (0.5.2)
+    openai_ruby (0.5.4)
       event_stream_parser (~> 1.0)
       faraday (~> 2.7)
+      faraday-multipart (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -14,8 +15,11 @@ GEM
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.2.0)
+      multipart-post (~> 2.0)
     faraday-net_http (3.0.2)
     json (2.6.3)
+    multipart-post (2.4.1)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)

data/README.md

@@ -92,8 +92,57 @@ p response.dig("choices", 0, "text")  # "What is the date today?\n"
 
 ### Image
 
+https://platform.openai.com/docs/api-reference/images
+
+Generate an image:
+
 ```ruby
+require "base64"
+
+res = client.images.generate(
+  model: "gpt-image-2",
+  prompt: "A watercolor painting of a ruby gem on a desk",
+  size: "1024x1024"
+)
+
+response = JSON.parse(res.body)
+image_data = response.dig("data", 0, "b64_json")
+
+File.binwrite("ruby-gem.png", Base64.decode64(image_data)) if image_data
+```
 
+Edit one or more images:
+
+```ruby
+require "base64"
+
+File.open("ruby-gem.png", "rb") do |image|
+  res = client.images.edit(
+    model: "gpt-image-2",
+    image: image,
+    prompt: "Add a small OpenAI logo sticker to the desk",
+    size: "1024x1024"
+  )
+
+  response = JSON.parse(res.body)
+  image_data = response.dig("data", 0, "b64_json")
+
+  File.binwrite("ruby-gem-edited.png", Base64.decode64(image_data)) if image_data
+end
+```
+
+You can also pass multiple images when editing:
+
+```ruby
+File.open("image-1.png", "rb") do |image_1|
+  File.open("image-2.png", "rb") do |image_2|
+    client.images.edit(
+      model: "gpt-image-2",
+      image: [image_1, image_2],
+      prompt: "Combine these images into one cohesive scene"
+    )
+  end
+end
 ```
 
 ## Development

data/lib/openai_ruby/client.rb

@@ -61,17 +61,15 @@ module OpenAI
     end
 
     def create_realtime_call(sdp_offer:, session: nil)
-      uri = "#{base_uri}/v1/realtime/calls"
-
       if session
         boundary, body = build_multipart_body(sdp_offer, session)
-        Faraday.post(uri) do |req|
+        connection.post("/v1/realtime/calls") do |req|
           req.headers["Authorization"] = "Bearer #{api_key}"
           req.headers["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
           req.body = body
         end
       else
-        Faraday.post(uri) do |req|
+        connection.post("/v1/realtime/calls") do |req|
           req.headers["Content-Type"] = "application/sdp"
           req.headers["Authorization"] = "Bearer #{api_key}"
           req.body = sdp_offer
@@ -82,7 +80,9 @@ module OpenAI
     private
 
     def connection
-      Faraday.new({ url: base_uri, headers: headers }.merge(options.except(:base_uri)))
+      Faraday.new({ url: base_uri, headers: headers }.merge(options.except(:base_uri))) do |faraday|
+        faraday.request :multipart
+      end
     end
 
     def headers

data/lib/openai_ruby/images.rb

@@ -9,5 +9,50 @@ module OpenAI
     def generate(params = {})
       connection.post("/v1/images/generations", params.to_json)
     end
+
+    def edit(params = {})
+      connection.post("/v1/images/edits") do |req|
+        req.headers.delete("Content-Type")
+        req.body = multipart_params(params)
+      end
+    end
+
+    private
+
+    def multipart_params(params)
+      params.each_with_object({}) do |(key, value), body|
+        if key.to_s == "image"
+          body[:image] = Array(value).map { |image| file_part(image) }
+        elsif file_like?(value)
+          body[key] = file_part(value)
+        elsif value.is_a?(Array)
+          body[key] = value
+        elsif !value.nil?
+          body[key] = value
+        end
+      end
+    end
+
+    def file_part(file)
+      return file if file.is_a?(Faraday::Multipart::FilePart)
+
+      if file.respond_to?(:path) && file.path
+        Faraday::Multipart::FilePart.new(file.path, content_type_for(file))
+      else
+        Faraday::Multipart::FilePart.new(file, content_type_for(file), filename_for(file))
+      end
+    end
+
+    def file_like?(value)
+      value.respond_to?(:read) || value.is_a?(Faraday::Multipart::FilePart)
+    end
+
+    def content_type_for(file)
+      file.respond_to?(:content_type) && file.content_type ? file.content_type : "application/octet-stream"
+    end
+
+    def filename_for(file)
+      file.respond_to?(:original_filename) && file.original_filename ? file.original_filename : "image.png"
+    end
   end
 end

data/lib/openai_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.5.2"
+  VERSION = "0.5.4"
 end

data/lib/openai_ruby.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "faraday/multipart"
 require "event_stream_parser"
 require "openai_ruby/client"
 require "openai_ruby/images"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: openai_ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Renny Ren
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -38,7 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-description:
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 email:
 - rennyrjh@gmail.com
 executables: []
@@ -66,7 +78,6 @@ metadata:
   homepage_uri: https://github.com/renny-ren/openai_ruby
   source_code_uri: https://github.com/renny-ren/openai_ruby
   changelog_uri: https://github.com/renny-ren/openai_ruby/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.11
 specification_version: 4
 summary: A Ruby wrapper for OpenAI API
 test_files: []