ruby-openai 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9f91687f2b4e37ef74018f8454392416afbe43ad08f5f8d671a1a9dc8feba82
-  data.tar.gz: 902a8bbd495d8ee56800f695aa3a264a8ded26475c11874040871b4765c8dacf
+  metadata.gz: 50fc900251b1e7c0c1a9f1f18c779871cba3691c9e3cd32a022286f6ee5978f2
+  data.tar.gz: '015428f6b586a0c504f839c6b38eb6842bd7c964805049ec8af706bf18fe8307'
 SHA512:
-  metadata.gz: 5b631c7f78b6de8d7c20acc61e4fc22eca4f372e488ba55e10267cedfd91c9b340334c69403fd28a26c71cfaa52678e7ea9c8410121139e9069abdadf5f37cf8
-  data.tar.gz: 40cb9e2f2848a954e5f786979d207a08b698ef6c5fb787afd564cd7945e5e758555ec2d99967a507bd2ae05b63ee8a7b518a197d8b2b6d39b19839c4398caf48
+  metadata.gz: ab310b17e7282ba6885b468373b10d27f33ef50effff6b61d07d5d677e2b4153346ca355c66803521dc55bed87c8799a1da1513dd04ff8e4d36a53ec382b9d77
+  data.tar.gz: f29975d47364d66ca01ffebdf6adfeb2b660b808ec4cf704f35aaa775be73bfb0aff09673a3b0ee540dd8c35e70c2af24e909ba336c8cdbe22a2f9c6bd868781

data/.rubocop.yml

@@ -12,9 +12,7 @@ Layout/LineLength:
 
 Metrics/BlockLength:
   Exclude:
-    - "Rakefile"
-    - "**/*.rake"
-    - "spec/**/*.rb"
+    - "spec/**/*"
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - 2022-12-26
+
+### Added
+
+- Add ability to set access_token via gem configuration.
+- Thanks [@grjones](https://github.com/grjones) and [@aquaflamingo](https://github.com/aquaflamingo) for raising this and [@feministy](https://github.com/feministy) for the [excellent guide](https://github.com/feministy/lizabinante.com/blob/stable/source/2016-01-30-creating-a-configurable-ruby-gem.markdown#configuration-block-the-end-goal) to adding config to a gem.
+
+### Removed
+
+- [BREAKING] Remove ability to include access_token directly via ENV vars.
+- [BREAKING] Remove deprecated answers, classifications, embeddings, engines and search endpoints.
+- [BREAKING] Remove ability to pass engine to completions and embeddings outside of the parameters hash.
+- [BREAKING] Remove ability to pass API version directly to endpoints.
+
 ## [2.3.0] - 2022-12-23
 
 ### Added

data/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "byebug", "~> 11.1.3"
+gem "dotenv", "~> 2.8.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.12"
 gem "rubocop", "~> 1.41.1"

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (2.3.0)
-      dotenv (>= 2.7.6, < 2.9.0)
+    ruby-openai (3.0.0)
       httparty (>= 0.18.1, < 0.21.0)
 
 GEM
@@ -71,6 +70,7 @@ PLATFORMS
 
 DEPENDENCIES
   byebug (~> 11.1.3)
+  dotenv (~> 2.8.1)
   rake (~> 13.0)
   rspec (~> 3.12)
   rubocop (~> 1.41.1)

data/README.md

@@ -40,30 +40,29 @@ and require with:
 - Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
 - If you belong to multiple organizations, you can get your Organization ID from [https://beta.openai.com/account/org-settings](https://beta.openai.com/account/org-settings)
 
-### With dotenv
+### Quickstart
 
-If you're using [dotenv](https://github.com/motdotla/dotenv), you can add your secret keys to your .env file:
+For a quick test you can pass your token directly to a new client:
 
-```
-    OPENAI_ACCESS_TOKEN=access_token_goes_here
-    OPENAI_ORGANIZATION_ID=organization_id_goes_here # Optional.
+```ruby
+    client = OpenAI::Client.new(access_token: "access_token_goes_here")
 ```
 
-And create a client:
+### With Config
+
+For a more robust setup, you can configure the gem with your API keys, for example in an `openai.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
 
 ```ruby
-    client = OpenAI::Client.new
+    Ruby::OpenAI.configure do |config|
+        config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
+        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID') # Optional.
+    end
 ```
 
-### Without dotenv
-
-Alternatively you can pass your key directly to a new client:
+Then you can create a client like this:
 
 ```ruby
-    client = OpenAI::Client.new(
-        access_token: "access_token_goes_here",
-        organization_id: "organization_id_goes_here"
-    )
+    client = OpenAI::Client.new
 ```
 
 ### Models

data/lib/ruby/openai/client.rb

@@ -1,80 +1,111 @@
 module OpenAI
   class Client
-    include HTTParty
-    base_uri "https://api.openai.com"
+    URI_BASE = "https://api.openai.com/".freeze
 
     def initialize(access_token: nil, organization_id: nil)
-      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
-      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
+      Ruby::OpenAI.configuration.access_token = access_token if access_token
+      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def answers(version: default_version, parameters: {})
+    def answers(parameters: {})
       warn "[DEPRECATION WARNING] [ruby-openai] `Client#answers` is deprecated and will
       be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
       More information: https://help.openai.com/en/articles/6233728-answers-transition-guide"
 
-      post(url: "/#{version}/answers", parameters: parameters)
+      OpenAI::Client.post(path: "/answers", parameters: parameters)
     end
 
-    def classifications(version: default_version, parameters: {})
+    def classifications(parameters: {})
       warn "[DEPRECATION WARNING] [ruby-openai] `Client#classifications` is deprecated and will
       be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
       More information: https://help.openai.com/en/articles/6272941-classifications-transition-guide"
 
-      post(url: "/#{version}/classifications", parameters: parameters)
+      OpenAI::Client.post(path: "/classifications", parameters: parameters)
     end
 
-    def completions(engine: nil, version: default_version, parameters: {})
+    def completions(engine: nil, parameters: {})
       parameters = deprecate_engine(engine: engine, method: "completions", parameters: parameters)
 
-      post(url: "/#{version}/completions", parameters: parameters)
+      OpenAI::Client.post(path: "/completions", parameters: parameters)
     end
 
-    def edits(version: default_version, parameters: {})
-      post(url: "/#{version}/edits", parameters: parameters)
+    def edits(parameters: {})
+      OpenAI::Client.post(path: "/edits", parameters: parameters)
     end
 
-    def embeddings(engine: nil, version: default_version, parameters: {})
+    def embeddings(engine: nil, parameters: {})
       parameters = deprecate_engine(engine: engine, method: "embeddings", parameters: parameters)
 
-      post(url: "/#{version}/embeddings", parameters: parameters)
+      OpenAI::Client.post(path: "/embeddings", parameters: parameters)
     end
 
     def engines
       warn "[DEPRECATION WARNING] [ruby-openai] `Client#engines` is deprecated and will
       be removed from ruby-openai v3.0. Use `Client#models` instead."
 
-      @engines ||= OpenAI::Engines.new(access_token: @access_token,
-                                       organization_id: @organization_id)
+      @engines ||= OpenAI::Engines.new
     end
 
     def files
-      @files ||= OpenAI::Files.new(access_token: @access_token, organization_id: @organization_id)
+      @files ||= OpenAI::Files.new
     end
 
     def finetunes
-      @finetunes ||= OpenAI::Finetunes.new(access_token: @access_token,
-                                           organization_id: @organization_id)
+      @finetunes ||= OpenAI::Finetunes.new
     end
 
     def images
-      @images ||= OpenAI::Images.new(access_token: @access_token, organization_id: @organization_id)
+      @images ||= OpenAI::Images.new
     end
 
     def models
-      @models ||= OpenAI::Models.new(access_token: @access_token, organization_id: @organization_id)
+      @models ||= OpenAI::Models.new
     end
 
-    def moderations(version: default_version, parameters: {})
-      post(url: "/#{version}/moderations", parameters: parameters)
+    def moderations(parameters: {})
+      OpenAI::Client.post(path: "/moderations", parameters: parameters)
     end
 
-    def search(engine:, version: default_version, parameters: {})
+    def search(engine:, parameters: {})
       warn "[DEPRECATION WARNING] [ruby-openai] `Client#search` is deprecated and will
       be removed from the OpenAI API on 3 December 2022 and from ruby-openai v3.0.
       More information: https://help.openai.com/en/articles/6272952-search-transition-guide"
 
-      post(url: "/#{version}/engines/#{engine}/search", parameters: parameters)
+      OpenAI::Client.post(path: "/engines/#{engine}/search", parameters: parameters)
+    end
+
+    def self.get(path:)
+      HTTParty.get(
+        uri(path: path),
+        headers: headers
+      )
+    end
+
+    def self.post(path:, parameters: nil)
+      HTTParty.post(
+        uri(path: path),
+        headers: headers,
+        body: parameters.to_json
+      )
+    end
+
+    def self.delete(path:)
+      HTTParty.delete(
+        uri(path: path),
+        headers: headers
+      )
+    end
+
+    private_class_method def self.uri(path:)
+      URI_BASE + Ruby::OpenAI.configuration.api_version + path
+    end
+
+    private_class_method def self.headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{Ruby::OpenAI.configuration.access_token}",
+        "OpenAI-Organization" => Ruby::OpenAI.configuration.organization_id
+      }
     end
 
     private
@@ -91,24 +122,8 @@ module OpenAI
       parameters
     end
 
-    def default_version
-      "v1".freeze
-    end
-
     def documents_or_file(documents: nil, file: nil)
       documents ? { documents: documents } : { file: file }
     end
-
-    def post(url:, parameters:)
-      self.class.post(
-        url,
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        },
-        body: parameters.to_json
-      )
-    end
   end
 end

data/lib/ruby/openai/engines.rb

@@ -1,39 +1,16 @@
 module OpenAI
   class Engines
-    include HTTParty
-    base_uri "https://api.openai.com"
-
     def initialize(access_token: nil, organization_id: nil)
-      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
-      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
-    end
-
-    def list(version: default_version)
-      self.class.get(
-        "/#{version}/engines",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+      Ruby::OpenAI.configuration.access_token = access_token if access_token
+      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def retrieve(id:, version: default_version)
-      self.class.get(
-        "/#{version}/engines/#{id}",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def list
+      OpenAI::Client.get(path: "/engines")
     end
 
-    private
-
-    def default_version
-      "v1".freeze
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/engines/#{id}")
     end
   end
 end

data/lib/ruby/openai/files.rb

@@ -1,66 +1,33 @@
 module OpenAI
   class Files
-    include HTTParty
-    base_uri "https://api.openai.com"
-
     def initialize(access_token: nil, organization_id: nil)
-      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
-      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
+      Ruby::OpenAI.configuration.access_token = access_token if access_token
+      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def list(version: default_version)
-      self.class.get(
-        "/#{version}/files",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def list
+      OpenAI::Client.get(path: "/files")
     end
 
-    def upload(version: default_version, parameters: {})
+    def upload(parameters: {})
       validate(file: parameters[:file])
 
-      self.class.post(
-        "/#{version}/files",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        },
-        body: parameters.merge(file: File.open(parameters[:file]))
+      OpenAI::Client.post(
+        path: "/files",
+        parameters: parameters.merge(file: File.open(parameters[:file]))
       )
     end
 
-    def retrieve(id:, version: default_version)
-      self.class.get(
-        "/#{version}/files/#{id}",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/files/#{id}")
     end
 
-    def delete(id:, version: default_version)
-      self.class.delete(
-        "/#{version}/files/#{id}",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def delete(id:)
+      OpenAI::Client.delete(path: "/files/#{id}")
     end
 
     private
 
-    def default_version
-      "v1".freeze
-    end
-
     def validate(file:)
       File.open(file).each_line.with_index do |line, index|
         JSON.parse(line)

data/lib/ruby/openai/finetunes.rb

@@ -1,73 +1,28 @@
 module OpenAI
   class Finetunes
-    include HTTParty
-    base_uri "https://api.openai.com"
-
     def initialize(access_token: nil, organization_id: nil)
-      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
-      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
-    end
-
-    def list(version: default_version)
-      self.class.get(
-        "/#{version}/fine-tunes",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+      Ruby::OpenAI.configuration.access_token = access_token if access_token
+      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def create(version: default_version, parameters: {})
-      self.class.post(
-        "/#{version}/fine-tunes",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        },
-        body: parameters.to_json
-      )
+    def list
+      OpenAI::Client.get(path: "/fine-tunes")
     end
 
-    def retrieve(id:, version: default_version)
-      self.class.get(
-        "/#{version}/fine-tunes/#{id}",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def create(parameters: {})
+      OpenAI::Client.post(path: "/fine-tunes", parameters: parameters.to_json)
     end
 
-    def cancel(id:, version: default_version)
-      self.class.post(
-        "/#{version}/fine-tunes/#{id}/cancel",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/fine-tunes/#{id}")
     end
 
-    def events(id:, version: default_version)
-      self.class.get(
-        "/#{version}/fine-tunes/#{id}/events",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def cancel(id:)
+      OpenAI::Client.post(path: "/fine-tunes/#{id}/cancel")
     end
 
-    private
-
-    def default_version
-      "v1".freeze
+    def events(id:)
+      OpenAI::Client.get(path: "/fine-tunes/#{id}/events")
     end
   end
 end

data/lib/ruby/openai/images.rb

@@ -1,59 +1,24 @@
 module OpenAI
   class Images
-    include HTTParty
-    base_uri "https://api.openai.com"
-
     def initialize(access_token: nil, organization_id: nil)
-      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
-      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
+      Ruby::OpenAI.configuration.access_token = access_token if access_token
+      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def generate(version: default_version, parameters: {})
-      self.class.post(
-        "/#{version}/images/generations",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        },
-        body: parameters.to_json
-      )
+    def generate(parameters: {})
+      OpenAI::Client.post(path: "/images/generations", parameters: parameters.to_json)
     end
 
-    def edit(version: default_version, parameters: {})
-      parameters = open_files(parameters)
-
-      self.class.post(
-        "/#{version}/images/edits",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        },
-        body: parameters
-      )
+    def edit(parameters: {})
+      OpenAI::Client.post(path: "/images/edits", parameters: open_files(parameters))
     end
 
-    def variations(version: default_version, parameters: {})
-      parameters = open_files(parameters)
-
-      self.class.post(
-        "/#{version}/images/variations",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        },
-        body: parameters
-      )
+    def variations(parameters: {})
+      OpenAI::Client.post(path: "/images/variations", parameters: open_files(parameters))
     end
 
     private
 
-    def default_version
-      "v1".freeze
-    end
-
     def open_files(parameters)
       parameters = parameters.merge(image: File.open(parameters[:image]))
       parameters = parameters.merge(mask: File.open(parameters[:mask])) if parameters[:mask]

data/lib/ruby/openai/models.rb

@@ -1,39 +1,16 @@
 module OpenAI
   class Models
-    include HTTParty
-    base_uri "https://api.openai.com"
-
     def initialize(access_token: nil, organization_id: nil)
-      @access_token = access_token || ENV.fetch("OPENAI_ACCESS_TOKEN")
-      @organization_id = organization_id || ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
-    end
-
-    def list(version: default_version)
-      self.class.get(
-        "/#{version}/models",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+      Ruby::OpenAI.configuration.access_token = access_token if access_token
+      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
-    def retrieve(id:, version: default_version)
-      self.class.get(
-        "/#{version}/models/#{id}",
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{@access_token}",
-          "OpenAI-Organization" => @organization_id
-        }
-      )
+    def list
+      OpenAI::Client.get(path: "/models")
     end
 
-    private
-
-    def default_version
-      "v1".freeze
+    def retrieve(id:)
+      OpenAI::Client.get(path: "/models/#{id}")
     end
   end
 end

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "2.3.0".freeze
+    VERSION = "3.0.0".freeze
   end
 end

data/lib/ruby/openai.rb

@@ -1,15 +1,47 @@
 require "httparty"
+require "ruby/openai/client"
 require "ruby/openai/engines"
 require "ruby/openai/files"
 require "ruby/openai/finetunes"
 require "ruby/openai/images"
 require "ruby/openai/models"
-require "ruby/openai/client"
 require "ruby/openai/version"
-require "dotenv/load"
 
 module Ruby
   module OpenAI
     class Error < StandardError; end
+    class ConfigurationError < Error; end
+
+    class Configuration
+      attr_writer :access_token
+      attr_accessor :api_version, :organization_id
+
+      DEFAULT_API_VERSION = "v1".freeze
+
+      def initialize
+        @access_token = nil
+        @api_version = DEFAULT_API_VERSION
+        @organization_id = nil
+      end
+
+      def access_token
+        return @access_token if @access_token
+
+        error_text = "OpenAI access token missing! See https://github.com/alexrudall/ruby-openai#usage"
+        raise ConfigurationError, error_text
+      end
+    end
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= OpenAI::Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
   end
 end

data/ruby-openai.gemspec

@@ -25,6 +25,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "dotenv", ">= 2.7.6", "< 2.9.0"
   spec.add_dependency "httparty", ">= 0.18.1", "< 0.21.0"
 end

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2022-12-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.7.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement