openai_ruby 0.3.9 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71df1d565c7ff9b14d3778a6784e0a5d6264c4511986d4cd807fabcf040418ae
-  data.tar.gz: faeb2d15ab2a0263650650e3b1a5077c98f462c2e59f78e9eb58c0b303219f05
+  metadata.gz: f5873de02b645485ae0e1850fe232ac3a4825f083f227fc0eccd886a2ae9c6b1
+  data.tar.gz: 4e1fdaca2c2dd90aa5e1f20f7628d1896e3dfc0f0cf9a57682f44a622232268c
 SHA512:
-  metadata.gz: a532692845a6a896a835b3a38279b0443c5c133bc7a54a7bf9d55b1b666975b07966bd67ce0957e7e69e902a2562af150a5ac5ae65bded79ebb85056f666f9d1
-  data.tar.gz: 4b5b2b1c403a91f2448f75afeaecab7ccf4e0f638912783d60dc9e826cbdbb1dd8b8e1cdc311a9078c4b9ad596060ca26b522f2aeb9e70bce9f604b90d4e2487
+  metadata.gz: 3a608e43e0b62805b44a817db7a0000f219c2d6fe82bf742a0f2f5f176d4d2e536fb2a723071fef5e69520b193e4af7fa6b1a2834ac502438d2c39903a34681f
+  data.tar.gz: 691b0d2f5c0ca192a5e9079157407ee79d044d7fce237cc1eedacaf0eb02dd95bce07f89273f6e4580f4f0d259eb488eb9c0033b6bfc6599549da33518fef8cf

data/.rubocop.yml

@@ -19,4 +19,7 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 25

data/Gemfile

@@ -9,4 +9,5 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.12"
 
+gem "event_stream_parser"
 gem "rubocop", "~> 1.45"

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    openai_ruby (0.3.9)
+    openai_ruby (0.4.0)
+      event_stream_parser (~> 1.0)
       faraday (~> 2.7)
 
 GEM
@@ -9,6 +10,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    event_stream_parser (1.0.0)
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -56,6 +58,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  event_stream_parser
   openai_ruby!
   rake (~> 13.0)
   rspec (~> 3.12)

data/README.md

@@ -32,7 +32,7 @@ client = OpenAI::Client.new("your OpenAI key here")
 Or you can pass a hash of options to customize the connection:
 
 ```ruby
-client = OpenAI::Client.new("your OpenAI key here", { request: { timeout: 20 } })
+client = OpenAI::Client.new("your OpenAI key here", { base_uri: "https://example.com/", request: { timeout: 20 } })
 ```
 
 For more options check [here](https://lostisland.github.io/faraday/#/customization/connection-options)
@@ -71,15 +71,8 @@ If you set `stream` param to `true`, a block will be called with the chunk data:
 #   temperature: 1,
 #   stream: true,
 # }
-res = client.create_chat_completion(params) do |chunk, overall_received_bytes, env|
-  data = chunk[/data: (.*)\n\n$/, 1]
-  p data # {"id":"chatcmpl-6xcOWMQcilJUwJiosi7Rht6Fvuu3D","object":"chat.completion.chunk","created":1679666960,"model":"gpt-3.5-turbo-0301","choices":[{"delta":{"content":"Hello"},"index":0,"finish_reason":null}]}
-  if data == "[DONE]"
-    # the stream is end
-  else
-    response = JSON.parse(data)
-    p response.dig("choices", 0, "text")  # "Hello"
-  end
+res = client.create_chat_completion(params) do |data|
+  p data.dig("choices", 0, "delta", "content") # "Hello"
 end
 ```
 

data/lib/openai_ruby/client.rb

@@ -2,30 +2,40 @@
 
 module OpenAI
   class Client
-    BASE_URL = "https://api.openai.com"
+    DEFAULT_BASE_URI = "https://api.openai.com"
 
     attr_reader :api_key, :options
 
     def initialize(api_key, options = {})
       @api_key = api_key
       @options = options
+      @base_uri = options[:base_uri] || DEFAULT_BASE_URI
     end
 
     def create_completion(params = {})
       Faraday.post(
-        "#{BASE_URL}/v1/completions",
+        "#{base_uri}/v1/completions",
         params.to_json,
         headers
       )
     end
 
     def create_chat_completion(params = {})
+      parser = EventStreamParser::Parser.new
+
       params.deep_stringify_keys!
       if params["stream"]
         connection.post("/v1/chat/completions") do |req|
           req.body = params.to_json
-          req.options.on_data = proc do |chunk, overall_received_bytes, env|
-            yield(chunk, overall_received_bytes, env) if block_given?
+          req.options.on_data = proc do |chunk, _overall_received_bytes, env|
+            if env && env.status != 200
+              raise_error = Faraday::Response::RaiseError.new
+              raise_error.on_complete(env.merge(body: try_parse_json(chunk)))
+            end
+
+            parser.feed(chunk) do |_type, data|
+              yield(JSON.parse(data)) if block_given? && data != "[DONE]"
+            end
           end
         end
       else
@@ -35,7 +45,7 @@ module OpenAI
 
     def create_edit(params = {})
       Faraday.post(
-        "#{BASE_URL}/v1/edits",
+        "#{base_uri}/v1/edits",
         params.to_json,
         headers
       )
@@ -48,14 +58,20 @@ module OpenAI
     private
 
     def connection
-      Faraday.new({ url: BASE_URL, headers: headers }.merge(options))
+      Faraday.new({ url: base_uri, headers: headers }.merge(options))
     end
 
     def headers
       {
         "Content-Type" => "application/json",
-        "Authorization" => "Bearer #{api_key}"
+        "Authorization" => "Bearer #{api_key}",
       }
     end
+
+    def try_parse_json(maybe_json, default_value = nil)
+      JSON.parse(maybe_json)
+    rescue JSON::ParserError
+      default_value || maybe_json
+    end
   end
 end

data/lib/openai_ruby/version.rb

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

data/lib/openai_ruby.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openai_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.1
 platform: ruby
 authors:
 - Renny Ren
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-21 00:00:00.000000000 Z
+date: 2025-09-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: event_stream_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A Ruby wrapper for OpenAI API