openai.rb 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36b209f6540c340ca79cfa0e245d373db12c20b1d33f4fdd418c56bfa33961d
-  data.tar.gz: a30abc667ce81ffa59ec3a65c260193554cff814d03805921f745ec9140f2942
+  metadata.gz: 7504d7c806b7add3642cac52f2dede494dfd4b7ed13b4990001e7dbcf6fc3229
+  data.tar.gz: a128b968928677a1153fb59dae4a25f4138ca5517579183b9c40032ff5eb607b
 SHA512:
-  metadata.gz: 0aacdfd81c1a7bbd88c2fceed1e9c3aaf38f7cc948467b45a2c3e607d5eaf6bafa084ba2a8accd08aa7430c67b08df4da810ef2e07349359b601258c9f14c550
-  data.tar.gz: c6c89ccafded9440f5a472afbcee736307e7f2daa4f82b2028515cec86cd22a224e3006bd1d858c7faa7b495e7d889691c4af76ea4720972b50022890b01d18a
+  metadata.gz: 1d1fa68746301c4ebe256e2c97f66f3616bb34e082df040feead4ce9281569dc804c2e0bc32a78e720a3bad5fe0646fbef263699130823424dc869f34615e6db
+  data.tar.gz: b1f24c37e0fe70344c4eac77e9943d84740e33544a8cd1eb934f167da737a25a14682aa7297327258d8f5947fc668423a45310bcb7120930fddae0e31ca94451

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         http_version: ['~> 4.4', '~> 5.1']
-        ruby_version: ['2.7.8']
+        ruby_version: ['3.2.2']
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  NewCops: enable
+
 Metrics/AbcSize:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.7.7
+3.2.2

data/Gemfile

@@ -15,8 +15,8 @@ group :lint do
   gem 'rubocop-rspec', '~> 2.11.1'
 end
 
-gem 'pry', '~> 0.13.1'
-gem 'pry-byebug', '3.9.0'
+gem 'pry'
+gem 'pry-byebug'
 
 gem 'dotenv', '~> 2.8'
 

data/Gemfile.lock

@@ -8,7 +8,7 @@ PATH
       http (>= 4.4, < 6.0)
       ice_nine (~> 0.11.x)
       memoizable (~> 0.4.2)
-      tiktoken_ruby (~> 0.0.3)
+      tiktoken_ruby (~> 0.0.6)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
     adamantium (0.2.0)
       ice_nine (~> 0.11.0)
       memoizable (~> 0.4.0)
-    addressable (2.8.2)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     anima (0.3.2)
       abstract_type (~> 0.0.7)
@@ -34,7 +34,7 @@ GEM
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
     equalizer (0.0.11)
-    ffi (1.15.5)
+    ffi (1.16.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
@@ -53,34 +53,36 @@ GEM
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
     method_source (1.0.0)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
-    pry (0.13.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    public_suffix (5.0.1)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.3)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rb_sys (0.9.70)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    rb_sys (0.9.82)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (1.31.2)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -91,18 +93,20 @@ GEM
       rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.13.0)
     slop (4.10.1)
     thread_safe (0.3.6)
-    tiktoken_ruby (0.0.4)
+    tiktoken_ruby (0.0.6)
+      rb_sys (~> 0.9.68)
+    tiktoken_ruby (0.0.6-arm64-darwin)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -112,8 +116,8 @@ DEPENDENCIES
   dotenv (~> 2.8)
   http (~> 4.4)
   openai.rb!
-  pry (~> 0.13.1)
-  pry-byebug (= 3.9.0)
+  pry
+  pry-byebug
   rb_sys (~> 0.9.70)
   rspec (~> 3.12)
   rubocop (~> 1.31.1)
@@ -121,7 +125,7 @@ DEPENDENCIES
   slop (~> 4.10)
 
 RUBY VERSION
-   ruby 2.7.7p221
+   ruby 3.2.2p53
 
 BUNDLED WITH
    2.3.9

data/lib/openai/api/cache.rb

@@ -6,7 +6,7 @@ class OpenAI
       include Concord.new(:client, :cache)
 
       def get(route)
-        read_cache_or_apply(verb: :get, route: route) do
+        read_cache_or_apply(verb: :get, route:) do
           client.get(route)
         end
       end
@@ -18,13 +18,13 @@ class OpenAI
       end
 
       def post(route, **body)
-        read_cache_or_apply(verb: :post, route: route, body: body, format: :json) do
+        read_cache_or_apply(verb: :post, route:, body:, format: :json) do
           client.post(route, **body)
         end
       end
 
       def post_form_multipart(route, **body)
-        read_cache_or_apply(verb: :post, route: route, body: body, format: :form) do
+        read_cache_or_apply(verb: :post, route:, body:, format: :form) do
           client.post_form_multipart(route, **body)
         end
       end
@@ -49,11 +49,11 @@ class OpenAI
 
       def cache_target(verb:, route:, body: nil, format: nil)
         Target.new(
-          verb: verb,
+          verb:,
           api_key: client.api_key,
-          route: route,
-          body: body,
-          format: format
+          route:,
+          body:,
+          format:
         )
       end
 

data/lib/openai/api/resource.rb

@@ -31,7 +31,7 @@ class OpenAI
         chunk_response_type: full_response_type,
         **kwargs
       )
-        payload = kwargs.merge(stream: stream)
+        payload = kwargs.merge(stream:)
 
         raise 'Streaming responses require a block' if stream && !block_given?
         raise 'Non-streaming responses do not support blocks' if !stream && block_given?
@@ -54,7 +54,7 @@ class OpenAI
       def create(model:, **kwargs, &block)
         create_and_maybe_stream(
           '/v1/completions',
-          model: model,
+          model:,
           full_response_type: Response::Completion,
           **kwargs,
           &block
@@ -66,8 +66,8 @@ class OpenAI
       def create(model:, messages:, **kwargs, &block)
         create_and_maybe_stream(
           '/v1/chat/completions',
-          model: model,
-          messages: messages,
+          model:,
+          messages:,
           full_response_type: Response::ChatCompletion,
           chunk_response_type: Response::ChatCompletionChunk,
           **kwargs,
@@ -79,7 +79,7 @@ class OpenAI
     class Embedding < Resource
       def create(model:, input:, **kwargs)
         Response::Embedding.from_json(
-          post('/v1/embeddings', model: model, input: input, **kwargs)
+          post('/v1/embeddings', model:, input:, **kwargs)
         )
       end
     end
@@ -99,7 +99,7 @@ class OpenAI
     class Moderation < Resource
       def create(input:, model:)
         Response::Moderation.from_json(
-          post('/v1/moderations', input: input, model: model)
+          post('/v1/moderations', input:, model:)
         )
       end
     end
@@ -107,7 +107,7 @@ class OpenAI
     class Edit < Resource
       def create(model:, instruction:, **kwargs)
         Response::Edit.from_json(
-          post('/v1/edits', model: model, instruction: instruction, **kwargs)
+          post('/v1/edits', model:, instruction:, **kwargs)
         )
       end
     end
@@ -115,7 +115,7 @@ class OpenAI
     class File < Resource
       def create(file:, purpose:)
         Response::File.from_json(
-          post_form_multipart('/v1/files', file: form_file(file), purpose: purpose)
+          post_form_multipart('/v1/files', file: form_file(file), purpose:)
         )
       end
 
@@ -151,7 +151,7 @@ class OpenAI
 
       def create(training_file:, **kwargs)
         Response::FineTune.from_json(
-          post('/v1/fine-tunes', training_file: training_file, **kwargs)
+          post('/v1/fine-tunes', training_file:, **kwargs)
         )
       end
 
@@ -177,23 +177,20 @@ class OpenAI
     class Image < Resource
       def create(prompt:, **kwargs)
         Response::ImageGeneration.from_json(
-          post('/v1/images/generations', prompt: prompt, **kwargs)
+          post('/v1/images/generations', prompt:, **kwargs)
         )
       end
 
       def create_variation(image:, **kwargs)
         Response::ImageVariation.from_json(
-          post_form_multipart('/v1/images/variations', {
-                                image: form_file(image),
-                                **kwargs
-                              })
+          post_form_multipart('/v1/images/variations', image: form_file(image), **kwargs)
         )
       end
 
       def edit(image:, prompt:, mask: nil, **kwargs)
         params = {
           image: form_file(image),
-          prompt: prompt,
+          prompt:,
           **kwargs
         }
 
@@ -211,7 +208,7 @@ class OpenAI
           post_form_multipart(
             '/v1/audio/transcriptions',
             file: form_file(file),
-            model: model,
+            model:,
             **kwargs
           )
         )
@@ -222,7 +219,7 @@ class OpenAI
           post_form_multipart(
             '/v1/audio/translations',
             file: form_file(file),
-            model: model,
+            model:,
             **kwargs
           )
         )

data/lib/openai/api/response.rb

@@ -41,7 +41,7 @@ class OpenAI
         register_field(name)
 
         define_method(name) do
-          field(path, wrapper: wrapper)
+          field(path, wrapper:)
         end
       end
 
@@ -49,7 +49,7 @@ class OpenAI
         register_field(name)
 
         define_method(name) do
-          optional_field(path, wrapper: wrapper)
+          optional_field(path, wrapper:)
         end
       end
 

data/lib/openai/chat.rb

@@ -5,8 +5,9 @@ class OpenAI
     include Anima.new(:messages, :api_settings, :openai, :config)
     using Util::Colorize
 
-    def initialize(messages:, settings: {}, config: Config.create, **kwargs)
-      messages = messages.map do |msg|
+    def initialize(opts)
+      opts = { settings: {}.freeze, config: Config.create }.merge(opts)
+      messages = opts.fetch(:messages).map do |msg|
         if msg.is_a?(Hash)
           Message.new(msg)
         else
@@ -15,10 +16,10 @@ class OpenAI
       end
 
       super(
-        messages: messages,
-        api_settings: settings,
-        config: config,
-        **kwargs
+        messages:,
+        api_settings: opts.fetch(:settings),
+        config: opts.fetch(:config),
+        openai: opts.fetch(:openai)
       )
     end
 
@@ -90,7 +91,7 @@ class OpenAI
     end
 
     def add_message(role, content)
-      with_message(role: role, content: content)
+      with_message(role:, content:)
     end
 
     def with_message(message)

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class OpenAI
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/openai.rb

@@ -64,7 +64,7 @@ class OpenAI
   def chat(model:, history: [], **kwargs)
     Chat.new(
       openai: self,
-      settings: kwargs.merge(model: model),
+      settings: kwargs.merge(model:),
       messages: history
     )
   end

data/openai.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
   spec.executables   = []
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.2'
 
   spec.add_dependency 'abstract_type', '~> 0.0.7'
   spec.add_dependency 'anima',         '~> 0.3'
@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'http',          '>= 4.4', '< 6.0'
   spec.add_dependency 'ice_nine',      '~> 0.11.x'
   spec.add_dependency 'memoizable',    '~> 0.4.2'
-  spec.add_dependency 'tiktoken_ruby', '~> 0.0.3'
+  spec.add_dependency 'tiktoken_ruby', '~> 0.0.6'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/shared/api_resource_context.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 RSpec.shared_context 'an API Resource' do
-  let(:api)                  { OpenAI::API.new(api_client)                   }
-  let(:api_client)           { OpenAI::API::Client.new('sk-123', http: http) }
+  let(:api)                  { OpenAI::API.new(api_client) }
+  let(:api_client)           { OpenAI::API::Client.new('sk-123', http:) }
   let(:http)                 { class_spy(HTTP)                               }
   let(:response_status_code) { 200                                           }
 

data/spec/unit/openai/api/audio_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe OpenAI::API, '#audio' do
   context 'when transcribing audio' do
     let(:response_body) do
       {
-        "text": "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that."
+        text: "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that."
       }
     end
 
@@ -42,7 +42,7 @@ RSpec.describe OpenAI::API, '#audio' do
 
     let(:response_body) do
       {
-        "text": 'Hello, my name is Wolfgang and I come from Germany. Where are you heading today?'
+        text: 'Hello, my name is Wolfgang and I come from Germany. Where are you heading today?'
       }
     end
 

data/spec/unit/openai/api/chat_completions_spec.rb

@@ -6,34 +6,34 @@ RSpec.describe OpenAI::API, '#chat_completions' do
   let(:resource) { api.chat_completions }
   let(:response_body) do
     {
-      "id": 'chatcmpl-123',
-      "object": 'chat.completion',
-      "created": 1_677_652_288,
-      "choices": [
+      id: 'chatcmpl-123',
+      object: 'chat.completion',
+      created: 1_677_652_288,
+      choices: [
         {
-          "index": 0,
-          "message": {
-            "role": 'assistant',
-            "content": "\n\nHello there, how may I assist you today?"
+          index: 0,
+          message: {
+            role: 'assistant',
+            content: "\n\nHello there, how may I assist you today?"
           },
-          "finish_reason": 'stop'
+          finish_reason: 'stop'
         }
       ],
-      "usage": {
-        "prompt_tokens": 9,
-        "completion_tokens": 12,
-        "total_tokens": 21
+      usage: {
+        prompt_tokens: 9,
+        completion_tokens: 12,
+        total_tokens: 21
       }
     }
   end
 
   let(:completion) do
     messages = [
-      { "text": 'Hello there!', "user": 'customer' },
-      { "text": 'Can you help me with my order?', "user": 'customer' },
-      { "text": 'Sure, what would you like to do?', "user": 'assistant' }
+      { text: 'Hello there!', user: 'customer' },
+      { text: 'Can you help me with my order?', user: 'customer' },
+      { text: 'Sure, what would you like to do?', user: 'assistant' }
     ]
-    resource.create(model: 'text-davinci-002', messages: messages)
+    resource.create(model: 'text-davinci-002', messages:)
   end
 
   it 'can create a chat completion' do
@@ -64,10 +64,10 @@ RSpec.describe OpenAI::API, '#chat_completions' do
   context 'when streaming is enabled' do
     let(:response_chunks) do
       [
-        chunk(role: 'assistant'),
-        chunk(content: 'He'),
-        chunk(content: 'llo,'),
-        chunk(content: ' world'),
+        chunk({ role: 'assistant' }),
+        chunk({ content: 'He' }),
+        chunk({ content: 'llo,' }),
+        chunk({ content: ' world' }),
         chunk({ content: '!' }, finish_reason: 'stop')
       ]
     end
@@ -102,7 +102,7 @@ RSpec.describe OpenAI::API, '#chat_completions' do
         object: 'chat.completion.chunk',
         created: 1_679_780_213,
         model: 'gpt-3.5-turbo-0301',
-        choices: [delta: delta, index: 0, finish_reason: finish_reason]
+        choices: [delta:, index: 0, finish_reason:]
       }
 
       "data: #{JSON.dump(data)}"

data/spec/unit/openai/api/completions_spec.rb

@@ -7,22 +7,22 @@ RSpec.describe OpenAI::API, '#completions' do
 
   let(:response_body) do
     {
-      "id": 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7',
-      "object": 'text_completion',
-      "created": 1_589_478_378,
-      "model": 'text-davinci-003',
-      "choices": [
+      id: 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7',
+      object: 'text_completion',
+      created: 1_589_478_378,
+      model: 'text-davinci-003',
+      choices: [
         {
-          "text": "\n\nThis is indeed a test",
-          "index": 0,
-          "logprobs": nil,
-          "finish_reason": 'length'
+          text: "\n\nThis is indeed a test",
+          index: 0,
+          logprobs: nil,
+          finish_reason: 'length'
         }
       ],
-      "usage": {
-        "prompt_tokens": 5,
-        "completion_tokens": 7,
-        "total_tokens": 12
+      usage: {
+        prompt_tokens: 5,
+        completion_tokens: 7,
+        total_tokens: 12
       }
     }
   end
@@ -91,16 +91,16 @@ RSpec.describe OpenAI::API, '#completions' do
 
     def chunk(text, finish_reason: nil)
       data = {
-        "id": 'cmpl-6y5B6Ak8wBk2nKsqVtSlFeJAG1dUM',
-        "object": 'text_completion',
-        "created": 1_679_777_604,
-        "choices": [{
-          "text": text,
-          "index": 0,
-          "logprobs": nil,
-          "finish_reason": finish_reason
+        id: 'cmpl-6y5B6Ak8wBk2nKsqVtSlFeJAG1dUM',
+        object: 'text_completion',
+        created: 1_679_777_604,
+        choices: [{
+          text:,
+          index: 0,
+          logprobs: nil,
+          finish_reason:
         }],
-        "model": 'text-davinci-002'
+        model: 'text-davinci-002'
       }
 
       "data: #{JSON.dump(data)}"

data/spec/unit/openai/api/edits_spec.rb

@@ -6,18 +6,18 @@ RSpec.describe OpenAI::API, '#edits' do
   let(:resource) { api.edits }
   let(:response_body) do
     {
-      "object": 'edit',
-      "created": 1_589_478_378,
-      "choices": [
+      object: 'edit',
+      created: 1_589_478_378,
+      choices: [
         {
-          "text": 'What day of the week is it?',
-          "index": 0
+          text: 'What day of the week is it?',
+          index: 0
         }
       ],
-      "usage": {
-        "prompt_tokens": 25,
-        "completion_tokens": 32,
-        "total_tokens": 57
+      usage: {
+        prompt_tokens: 25,
+        completion_tokens: 32,
+        total_tokens: 57
       }
     }
   end

data/spec/unit/openai/api/embeddings_spec.rb

@@ -6,22 +6,22 @@ RSpec.describe OpenAI::API, '#embeddings' do
   let(:resource) { api.embeddings }
   let(:response_body) do
     {
-      "object": 'list',
-      "data": [
+      object: 'list',
+      data: [
         {
-          "object": 'embedding',
-          "embedding": [
+          object: 'embedding',
+          embedding: [
             0.0023064255,
             -0.009327292,
             -0.0028842222
           ],
-          "index": 0
+          index: 0
         }
       ],
-      "model": 'text-embedding-ada-002',
-      "usage": {
-        "prompt_tokens": 8,
-        "total_tokens": 8
+      model: 'text-embedding-ada-002',
+      usage: {
+        prompt_tokens: 8,
+        total_tokens: 8
       }
     }
   end