quick_openai 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29998848a279d5254494c77b0381b039d2e9dc0171f4740953cbeab517a9e9f6
-  data.tar.gz: 9d44c2630df9557fc3c26cfb9058ec4d4082c74d12df674187a7e4701fd9740a
+  metadata.gz: d0c8f01b890c1bac117c4ec75c84cc42cedec5f392ffb53427902da947f38dae
+  data.tar.gz: 7c099581a01de52fbebba1c57c3900f819d78ee38c93277dd8e370327bba3fcc
 SHA512:
-  metadata.gz: f05ad7ba4632fafb68cf8e2e156e18d5bd5af12e7e2fb4c96cc7e5430cce5ee46d7f34939e3503653fd9d25bfe8e125bbbfd6e93bea9d9d53e3eab16503f6186
-  data.tar.gz: 7b40b2825d4e0b5e4563f8dbeb91aa44e44e6f1952197899a190625789fda06e5079e6cb49d0c09925619e987bc25833ecccf32b4091d7f5727458f30fe8b197
+  metadata.gz: 2911d2d5aa90500dbb47d5b9abcbf82baec63d9698beb5f631d29692ec5adb1988c480dfaae8f64da4fb455b3b2d8151b2b6fd99acf2fe7d99fc52784c01d712
+  data.tar.gz: 2d6c7a326874c9ede4e62f39c1055f701b2fc53b1daf1ed8cce57bb5f710279c00ca2de147e50ab114b0537d10125fcaf24e7abd2a32ed924f996748e76ebca2

data/.env.test

@@ -1 +1 @@
-OPENAI_ACCESS_TOKEN=fakeopenaiaccesstoken
+OPENAI_ACCESS_TOKEN=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

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   Enabled: true

data/Gemfile

@@ -14,3 +14,5 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 
 gem "vcr", "~> 6"
+
+gem "webmock", "~> 3"

data/Gemfile.lock

@@ -1,66 +1,98 @@
 PATH
   remote: .
   specs:
-    quick_openai (0.1.2)
+    quick_openai (0.3.0)
       down (~> 5)
-      ruby-openai (~> 3)
+      ruby-openai (~> 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    dotenv (2.8.1)
-    down (5.4.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.1)
+    dotenv (3.1.8)
+    down (5.4.2)
       addressable (~> 2.8)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
-    json (2.6.3)
-    mini_mime (1.1.2)
-    multi_xml (0.6.0)
-    parallel (1.22.1)
-    parser (3.1.3.0)
+    event_stream_parser (1.0.0)
+    faraday (2.13.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    hashdiff (1.1.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    multipart-post (2.4.1)
+    net-http (0.6.0)
+      uri
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
+      racc
+    prism (1.4.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    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.12.0)
-    rspec-mocks (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.40.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.75.2)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    ruby-openai (3.0.3)
-      httparty (>= 0.18.1, < 0.22.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.3.0)
-    vcr (6.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-openai (8.1.0)
+      event_stream_parser (>= 0.3.0, < 2.0.0)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
+    ruby-progressbar (1.13.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.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  x86_64-freebsd-13
   x86_64-linux
 
 DEPENDENCIES
@@ -70,6 +102,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 1.21)
   vcr (~> 6)
+  webmock (~> 3)
 
 BUNDLED WITH
    2.3.12

data/README.md

@@ -4,17 +4,17 @@ This gem is a wrapper of [ruby-openai](https://github.com/alexrudall/ruby-openai
 
 ## Usage
 
-Quickly get results from GPT3:
+Quickly get results from GPT:
 
 ```ruby
-puts "Hello, what is your name?".gpt3
+puts "Hello, what is your name?".gpt
 # => My name is Aileen.
 ```
 
-Quickly get images from DALLE2:
+Quickly get images from DALLE:
 
 ```ruby
-"a drawing of a cat in a hat".dalle2.then { |tempfile|
+"a drawing of a cat in a hat".dalle.then { |tempfile|
   File.write('./cat.png', tempfile.read)
 }
 ```
@@ -44,14 +44,14 @@ require 'quick_openai'
 You can pass options supported by `ruby-openai` to the convenience methods:
 
 ```ruby
-"a drawing of a cat in a hat".dalle2(n: 2) # => An array of two tempfiles
+"a drawing of a cat in a hat".dalle(n: 2) # => An array of two tempfiles
 
-"count to ten in italian".gpt3(model: 'text-ada-001') # Use a different model
+"count to ten in italian".gpt(model: 'gpt-4.5-preview') # Use a different model
 
-"write me an essay on napoleon".gpt3(max_tokens: 2048) # Produce more or less output. The default is 2048.
+"write me an essay on napoleon".gpt(max_tokens: 2048) # Produce more or less output. The default is 2048.
 ```
 
-Read more about GPT3 models [here](https://beta.openai.com/docs/models/gpt-3).
+Read more about GPT models [here](https://beta.openai.com/docs/models/gpt-3).
 
 ## Development
 

data/lib/quick_openai/dalle.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module QuickOpenAI
+  module Dalle
+    class << self
+      def dalle2(prompt, **)
+        generic_dalle(prompt, **)
+      end
+
+      def dalle3(prompt, **)
+        default_size = "1024x1024"
+
+        generic_dalle(prompt, size: default_size, **)
+      end
+
+      alias dalle dalle3
+
+      private
+
+      def generic_dalle(prompt, **options)
+        parameters = {
+          prompt:,
+          **options
+        }
+
+        response = QuickOpenAI.fetch_response_from_client do |client|
+          client.images.generate(parameters:)
+        end
+
+        results = response.fetch("data")
+
+        tempfiles = results.map do |result|
+          url = result["url"]
+
+          Down.download(url)
+        end
+
+        if tempfiles.size == 1
+          tempfiles.first
+        else
+          tempfiles
+        end
+      end
+    end
+  end
+end

data/lib/quick_openai/extensions/string.rb

@@ -3,13 +3,17 @@
 module QuickOpenAI
   module Extensions
     module String
-      def gpt3(**options)
-        QuickOpenAI::Gpt3.gpt3(self, **options)
-      end
+      def gpt(**) = QuickOpenAI::Gpt.gpt(self, **)
 
-      def dalle2(**options)
-        QuickOpenAI::Dalle2.dalle2(self, **options)
-      end
+      def gpt3(**) = QuickOpenAI::Gpt.gpt3(self, **)
+
+      def gpt4(**) = QuickOpenAI::Gpt.gpt4(self, **)
+
+      def dalle(**) = QuickOpenAI::Dalle.dalle(self, **)
+
+      def dalle2(**) = QuickOpenAI::Dalle.dalle2(self, **)
+
+      def dalle3(**) = QuickOpenAI::Dalle.dalle3(self, **)
     end
   end
 end

data/lib/quick_openai/gpt.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module QuickOpenAI
+  module Gpt
+    class << self
+      def gpt3(prompt, **)
+        model = "gpt-3.5-turbo"
+
+        generic_gpt(prompt, model:, **)
+      end
+
+      def gpt4(prompt, **)
+        model = "gpt-4.1"
+
+        generic_gpt(prompt, model:, **)
+      end
+
+      alias gpt gpt4
+
+      private
+
+      def generic_gpt(prompt, **options)
+        parameters = {
+          max_tokens: 2048,
+          messages: [{ role: "user", content: prompt }],
+          **options
+        }
+
+        response = QuickOpenAI.fetch_response_from_client do |client|
+          client.chat(parameters:)
+        end
+
+        text = response.dig("choices", 0, "message", "content")
+
+        raise QuickOpenAI::Error, "Unable to parse response." if text.nil? || text.empty?
+
+        text.chomp.strip
+      end
+    end
+  end
+end

data/lib/quick_openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QuickOpenAI
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/lib/quick_openai.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "quick_openai/version"
-require_relative "quick_openai/dalle2"
-require_relative "quick_openai/gpt3"
+require_relative "quick_openai/dalle"
+require_relative "quick_openai/gpt"
 require_relative "quick_openai/extensions/string"
 
 module QuickOpenAI
@@ -10,7 +10,7 @@ module QuickOpenAI
 
   class << self
     def client
-      OpenAI::Client.new(access_token: ENV["OPENAI_ACCESS_TOKEN"])
+      OpenAI::Client.new(access_token:)
     end
 
     def fetch_response_from_client
@@ -40,6 +40,10 @@ module QuickOpenAI
 
       raise QuickOpenAI::Error, "Unable to fetch response: #{error}"
     end
+
+    def access_token
+      ENV.fetch("OPENAI_ACCESS_TOKEN")
+    end
   end
 end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: quick_openai
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - John DeSilva
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '8'
 description: Provides monkey patches for quick usage of GPT3 and DALLE2
 email:
 - desilvjo@umich.edu
@@ -55,19 +54,18 @@ files:
 - README.md
 - Rakefile
 - lib/quick_openai.rb
-- lib/quick_openai/dalle2.rb
+- lib/quick_openai/dalle.rb
 - lib/quick_openai/extensions/string.rb
-- lib/quick_openai/gpt3.rb
+- lib/quick_openai/gpt.rb
 - lib/quick_openai/version.rb
-- quick_openai.gemspec
 - sig/quick_openai.rbs
 homepage: https://github.com/Aesthetikx/quick_openai
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/Aesthetikx/quick_openai
   source_code_uri: https://github.com/Aesthetikx/quick_openai
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,15 +73,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Convenience extensions for using OpenAI with Ruby
 test_files: []

data/lib/quick_openai/dalle2.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module QuickOpenAI
-  module Dalle2
-    def self.dalle2(prompt, **options)
-      parameters = {
-        prompt: prompt,
-        **options
-      }
-
-      response = QuickOpenAI.fetch_response_from_client do |client|
-        client.images.generate(parameters: parameters)
-      end
-
-      results = response.fetch("data")
-
-      tempfiles = results.map do |result|
-        url = result["url"]
-
-        Down.download(url)
-      end
-
-      if tempfiles.size == 1
-        tempfiles.first
-      else
-        tempfiles
-      end
-    end
-  end
-end

data/lib/quick_openai/gpt3.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module QuickOpenAI
-  module Gpt3
-    def self.gpt3(prompt, **options)
-      parameters = {
-        model: "text-davinci-003",
-        max_tokens: 2048,
-        prompt: prompt,
-        **options
-      }
-
-      response = QuickOpenAI.fetch_response_from_client do |client|
-        client.completions(parameters: parameters)
-      end
-
-      text = response.dig("choices", 0, "text")
-
-      raise QuickOpenAI::Error, "Unable to parse response." if text.nil? || text.empty?
-
-      text.chomp.strip
-    end
-  end
-end

data/quick_openai.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/quick_openai/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "quick_openai"
-  spec.version = QuickOpenAI::VERSION
-  spec.authors = ["John DeSilva"]
-  spec.email = ["desilvjo@umich.edu"]
-
-  spec.summary = "Convenience extensions for using OpenAI with Ruby"
-  spec.description = "Provides monkey patches for quick usage of GPT3 and DALLE2"
-  spec.homepage = "https://github.com/Aesthetikx/quick_openai"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Aesthetikx/quick_openai"
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci|github)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "down", "~> 5"
-  spec.add_dependency "ruby-openai", "~> 3"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end