Merge pull request alexrudall#167 from kmcphillips/main

Remove the ::Ruby::OpenAI module and move everything under top level ::OpenAI module

Author: alexrudall

README.md

@@ -1,4 +1,4 @@
-# Ruby::OpenAI
+# Ruby OpenAI
 
 [![Gem Version](https://badge.fury.io/rb/ruby-openai.svg)](https://badge.fury.io/rb/ruby-openai)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/ruby-openai/blob/main/LICENSE.txt)
@@ -32,9 +32,16 @@ $ gem install ruby-openai
 and require with:
 
 ```ruby
-    require "ruby/openai"
+    require "openai"
 ```
 
+## Upgrading
+
+The `::Ruby::OpenAI` module has been removed and all classes have been moved under the top level `::OpenAI` module.
+
+However, a transitional `::Ruby::OpenAI` module has been added with aliases to the new location of the classes and constants. For now this compatibility layer is available when the gem is loaded with `require 'ruby/openai'` or by default with bundler, but are _not_ available when the gem is loaded with `require 'openai'` or `gem 'ruby-openai', require: 'openai'`. This will be removed in future versions.
+
+
 ## Usage
 
 - Get your API key from [https://beta.openai.com/account/api-keys](https://beta.openai.com/account/api-keys)
@@ -53,7 +60,7 @@ For a quick test you can pass your token directly to a new client:
 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
-    Ruby::OpenAI.configure do |config|
+    OpenAI.configure do |config|
         config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
         config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID') # Optional.
     end
@@ -274,4 +281,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ruby::OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ruby OpenAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexrudall/ruby-openai/blob/main/CODE_OF_CONDUCT.md).

bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "ruby/openai"
+require "openai"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

lib/openai.rb

@@ -0,0 +1,45 @@
+require "httparty"
+
+require_relative "openai/client"
+require_relative "openai/files"
+require_relative "openai/finetunes"
+require_relative "openai/images"
+require_relative "openai/models"
+require_relative "openai/version"
+
+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

lib/ruby/openai/client.rb renamed to lib/openai/client.rb

@@ -3,8 +3,8 @@ class Client
     URI_BASE = "https://api.openai.com/".freeze
 
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def completions(parameters: {})
@@ -70,14 +70,14 @@ def self.delete(path:)
     end
 
     private_class_method def self.uri(path:)
-      URI_BASE + Ruby::OpenAI.configuration.api_version + path
+      URI_BASE + 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
+        "Authorization" => "Bearer #{OpenAI.configuration.access_token}",
+        "OpenAI-Organization" => OpenAI.configuration.organization_id
       }
     end
   end

lib/openai/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module OpenAI
+    VERSION = ::OpenAI::VERSION
+
+    Error = ::OpenAI::Error
+    ConfigurationError = ::OpenAI::ConfigurationError
+    Configuration = ::OpenAI::Configuration
+  end
+end

lib/ruby/openai/files.rb renamed to lib/openai/files.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Files
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def list

lib/ruby/openai/finetunes.rb renamed to lib/openai/finetunes.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Finetunes
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def list

lib/ruby/openai/images.rb renamed to lib/openai/images.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Images
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def generate(parameters: {})

lib/ruby/openai/models.rb renamed to lib/openai/models.rb

@@ -1,8 +1,8 @@
 module OpenAI
   class Models
     def initialize(access_token: nil, organization_id: nil)
-      Ruby::OpenAI.configuration.access_token = access_token if access_token
-      Ruby::OpenAI.configuration.organization_id = organization_id if organization_id
+      OpenAI.configuration.access_token = access_token if access_token
+      OpenAI.configuration.organization_id = organization_id if organization_id
     end
 
     def list

lib/openai/version.rb

@@ -0,0 +1,3 @@
+module OpenAI
+  VERSION = "3.2.0".freeze
+end

lib/ruby/openai.rb

@@ -1,46 +1,2 @@
-require "httparty"
-require "ruby/openai/client"
-require "ruby/openai/files"
-require "ruby/openai/finetunes"
-require "ruby/openai/images"
-require "ruby/openai/models"
-require "ruby/openai/version"
-
-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
+require_relative "../openai"
+require_relative "../openai/compatibility"

lib/ruby/openai/version.rb

@@ -1,8 +1,8 @@
-require_relative "lib/ruby/openai/version"
+require_relative "lib/openai/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ruby-openai"
-  spec.version       = Ruby::OpenAI::VERSION
+  spec.version       = OpenAI::VERSION
   spec.authors       = ["Alex"]
   spec.email         = ["[email protected]"]
 

ruby-openai.gemspec

@@ -0,0 +1,33 @@
+RSpec.describe "compatibility" do
+  context "for moved constants" do
+    describe "::Ruby::OpenAI::VERSION" do
+      it "is mapped to ::OpenAI::VERSION" do
+        expect(::Ruby::OpenAI::VERSION).to eq(::OpenAI::VERSION)
+      end
+    end
+
+    describe "::Ruby::OpenAI::Error" do
+      it "is mapped to ::OpenAI::Error" do
+        expect(::Ruby::OpenAI::Error).to eq(::OpenAI::Error)
+        expect(::Ruby::OpenAI::Error.new).to be_a(::OpenAI::Error)
+        expect(::OpenAI::Error.new).to be_a(::Ruby::OpenAI::Error)
+      end
+    end
+
+    describe "::Ruby::OpenAI::ConfigurationError" do
+      it "is mapped to ::OpenAI::ConfigurationError" do
+        expect(::Ruby::OpenAI::ConfigurationError).to eq(::OpenAI::ConfigurationError)
+        expect(::Ruby::OpenAI::ConfigurationError.new).to be_a(::OpenAI::ConfigurationError)
+        expect(::OpenAI::ConfigurationError.new).to be_a(::Ruby::OpenAI::ConfigurationError)
+      end
+    end
+
+    describe "::Ruby::OpenAI::Configuration" do
+      it "is mapped to ::OpenAI::Configuration" do
+        expect(::Ruby::OpenAI::Configuration).to eq(::OpenAI::Configuration)
+        expect(::Ruby::OpenAI::Configuration.new).to be_a(::OpenAI::Configuration)
+        expect(::OpenAI::Configuration.new).to be_a(::Ruby::OpenAI::Configuration)
+      end
+    end
+  end
+end

spec/compatibility_spec.rb

@@ -1,6 +1,6 @@
-RSpec.describe Ruby::OpenAI do
+RSpec.describe OpenAI do
   it "has a version number" do
-    expect(Ruby::OpenAI::VERSION).not_to be nil
+    expect(OpenAI::VERSION).not_to be nil
   end
 
   describe "#configure" do
@@ -9,24 +9,24 @@
     let(:organization_id) { "def456" }
 
     before do
-      Ruby::OpenAI.configure do |config|
+      OpenAI.configure do |config|
         config.access_token = access_token
         config.api_version = api_version
         config.organization_id = organization_id
       end
     end
 
     it "returns the config" do
-      expect(Ruby::OpenAI.configuration.access_token).to eq(access_token)
-      expect(Ruby::OpenAI.configuration.api_version).to eq(api_version)
-      expect(Ruby::OpenAI.configuration.organization_id).to eq(organization_id)
+      expect(OpenAI.configuration.access_token).to eq(access_token)
+      expect(OpenAI.configuration.api_version).to eq(api_version)
+      expect(OpenAI.configuration.organization_id).to eq(organization_id)
     end
 
     context "without an access token" do
       let(:access_token) { nil }
 
       it "raises an error" do
-        expect { OpenAI::Client.new.completions }.to raise_error(Ruby::OpenAI::ConfigurationError)
+        expect { OpenAI::Client.new.completions }.to raise_error(OpenAI::ConfigurationError)
       end
     end
   end

spec/ruby/openai/client/client_spec.rb renamed to spec/openai/client/client_spec.rb

@@ -1,6 +1,7 @@
 require "bundler/setup"
 require "dotenv/load"
-require "ruby/openai"
+require "openai"
+require "openai/compatibility"
 require "vcr"
 
 Dir[File.expand_path("spec/support/**/*.rb")].sort.each { |f| require f }
@@ -10,8 +11,8 @@
   c.cassette_library_dir = "spec/fixtures/cassettes"
   c.default_cassette_options = { record: ENV["NO_VCR"] == "true" ? :all : :new_episodes,
                                  match_requests_on: [:method, :uri, VCRMultipartMatcher.new] }
-  c.filter_sensitive_data("<OPENAI_ACCESS_TOKEN>") { Ruby::OpenAI.configuration.access_token }
-  c.filter_sensitive_data("<OPENAI_ORGANIZATION_ID>") { Ruby::OpenAI.configuration.organization_id }
+  c.filter_sensitive_data("<OPENAI_ACCESS_TOKEN>") { OpenAI.configuration.access_token }
+  c.filter_sensitive_data("<OPENAI_ORGANIZATION_ID>") { OpenAI.configuration.organization_id }
 end
 
 RSpec.configure do |c|
@@ -26,7 +27,7 @@
   end
 
   c.before(:all) do
-    Ruby::OpenAI.configure do |config|
+    OpenAI.configure do |config|
       config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
     end
   end