openai-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89cfd9978fd03cfbd1580f34402a26cf624e5f5b46267ad7983e86e9bbaa78bc
+  data.tar.gz: 5886fa8d3e043516ec07616c1559c2b5859914a374c438dd32cf92a714f81cf0
+SHA512:
+  metadata.gz: fca94f728f9a718ee9d68e979be51c2f845879ba9b07d6fe049f9de378c0462ab883f223dd3a11b63f430379d9200cba53273b94bb20b669ccd73041484370f6
+  data.tar.gz: bc9c9298f3734d40239eab52a33ed8642f1759dd0f5152f7ef6ac8490b055f4e8b2752e202cc075650a9d458e67c8eae34329e32df0fb6d6fb5bd8061d094896

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,202 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Checks that the indentation of method names for calls that span lines is relative to what the call is made on.
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+# Checks that there is exactly one space between a method and it's first argument when parentheses are not used.
+# Not enforced.
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+
+# Use spaces inside hash literal braces. Not enforced.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Maximum line length of 120 chars
+Layout/LineLength:
+  Max: 120
+
+# Disabled since MFA is not supported for internal rubygems
+Gemspec/RequireMFA:
+  Enabled: false
+
+# -------------------------------------------------------- Lint --------------------------------------------------------
+
+# Don't use assignment in conditions. Not enforced, since this is occasionally useful.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Lint/ScriptPermission:
+  Exclude:
+  - "Rakefile"
+
+# ------------------------------------------------------- Naming -------------------------------------------------------
+
+# Ensure numbered variables use snake_case, i.e. variable_1.
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: optional
+
+# ------------------------------------------------------- Metrics ------------------------------------------------------
+
+# Counts the number of assignments, branches (including method calls), and conditions, keeps it below a maximum.
+# Not enforced.
+Metrics/AbcSize:
+  Enabled: false
+
+# Avoid blocks longer than 25 lines of code, except for RSpec's DSL
+Metrics/BlockLength:
+  Max: 25
+  Exclude:
+  - "**/spec_helper.rb"
+  IgnoredMethods:
+  - after
+  - before
+  - context
+  - describe
+  - feature
+  - it
+  - let
+  - scenario
+  - shared_examples
+  - shared_examples_for
+
+# Restrict the number of lines in a class (not counting comments) to a maximum
+Metrics/ClassLength:
+  Max: 150
+
+# Avoid deep nesting
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Avoid methods longer than 30 lines of code
+Metrics/MethodLength:
+  Exclude:
+  - "spec/**/*"
+  Max: 30
+
+# Do not apply the module length check to spec files.
+Metrics/ModuleLength:
+  Exclude:
+  - "spec/**/*"
+
+# Avoid parameter lists longer than three or four parameters. Not enforced.
+Metrics/ParameterLists:
+  Enabled: false
+
+# Tries to score methods for complexity, with some special cases around case..when statements.
+# Not enforced (we use Metrics/CyclomaticComplexity instead).
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# ------------------------------------------------------- Style --------------------------------------------------------
+
+# Forces the use of the shortcut %() for single-line strings with interpolation and double quotes.
+# Not enforced.
+Style/BarePercentLiterals:
+  Enabled: false
+
+# Always use {} for single line blocks and do..end for multi-line blocks
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+
+# There are two styles for defining class/module hierarchies
+# class Alpha
+#   class Beta
+#   end
+# end
+#
+# class Alpha::Beta
+# end
+#
+# Allow both (not enforced).
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Forces consistent use of is_a? vs kind_of?
+# Not enforced.
+Style/ClassCheck:
+  Enabled: false
+
+# Document classes and non-namespace modules. Not enforced.
+Style/Documentation:
+  Enabled: false
+
+# Disallows !!variable to convert variable to a boolean
+# Not enforced.
+Style/DoubleNegation:
+  Enabled: false
+
+# Checks that empty method definitions have 'end' on a separate line.
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Disallows guard clauses.
+# Not enforced because it conflicts with removing Style/MultilineIfModifier.
+Style/GuardClause:
+  Enabled: false
+
+# Disallows trailing comments on any line with code in it.
+# Not enforced.
+Style/InlineComment:
+  Enabled: false
+
+# Favor unless over if for negative conditions (or control flow or). Not enforced.
+Style/NegatedIf:
+  Enabled: false
+
+# Checks that the next keyword is used rather than a condition to skip the body of a loop
+# Not enforced.
+Style/Next:
+  Enabled: false
+
+# Uses slashes for single-line regexes, and %r for multiline regexes or regexes with inner slashes.
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+# Always use 'raise' command, never 'fail'
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Use symbols as procs whenever possible. Instead of
+# arr.map { |x| x.id }
+# use
+# arr.map(&:id)
+# Not enforced.
+Style/SymbolProc:
+  Enabled: false
+
+# Use %w or %W for arrays of words. Not enforced.
+Style/WordArray:
+  Enabled: false
+  EnforcedStyle: percent
+
+# Call super to initialize state of the parent class.
+Lint/MissingSuper:
+  Enabled: false
+
+# ------------------------------------------------------- RSpec --------------------------------------------------------
+RSpec/MultipleMemoizedHelpers:
+  Max: 15
+
+# Disable "Maximum example group nesting exceeded"
+#   Disabling this will allow us to have more verbose specs, and easier to understand and structure
+RSpec/NestedGroups:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in openai-client.gemspec
+gemspec
+
+group :development, :test do
+  gem 'byebug'
+  gem 'faker', '~> 2.0'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.21'
+  gem 'rubocop-performance',   '~> 1.12'
+  gem 'rubocop-rspec',         '~> 2.6'
+  gem 'webmock',               '~> 3.12'
+  gem 'yard',                  '~> 0.9'
+end

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    openai-client (0.1.0)
+      faraday (~> 1.8)
+      faraday_middleware (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faker (2.23.0)
+      i18n (>= 1.8.11, < 2)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    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.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-22
+
+DEPENDENCIES
+  byebug
+  faker (~> 2.0)
+  openai-client!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance (~> 1.12)
+  rubocop-rspec (~> 2.6)
+  webmock (~> 3.12)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.4.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ihor Tykhonenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Openai::Client
+This gem is a wrapper for calling the OpenAI and GPT-3 APIs.
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'openai-client'
+```
+And then execute:
+```bash
+bundle
+```
+Or install it yourself as:
+```bash
+gem install openai-client
+```
+
+## Usage
+- API key (`access_token`) https://beta.openai.com/account/api-keys.
+- Organization ID (if needed) https://beta.openai.com/account/org-settings.
+
+```ruby
+require 'openai-client'
+
+Openai::Client.configure do |c|
+  c.access_token    = 'access_token'
+  c.organization_id = 'organization_id' # optional
+end
+
+# Models
+Openai::Client.models.list
+
+# Find a Model
+Openai::Client.models.find(model_id)
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/itikhonenko/openai-client.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/openai/client/configurable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    module Configurable
+      # @api public
+      # Public: Returns the instance of Configuration class
+      #
+      # @return [Openai::Client::Configuration] instance of Configuration class
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      # @api public
+      # Public: Allows to provide configuration values
+      #
+      # @return [Openai::Client::Configuration] instance of Configuration class
+      #
+      # Example:
+      #  Openai::Client.configure do |c|
+      #    c.logger          = Rails.logger
+      #    c.access_token    = 'access_token_goes_here'
+      #    c.organization_id = 'organization_id_goes_here'
+      #    c.openai_url      = 'https://api.openai.com/v1'
+      #  end
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+end

data/lib/openai/client/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Configuration
+      attr_accessor :logger, :access_token, :organization_id, :openai_url
+
+      def initialize
+        @openai_url      = 'https://api.openai.com/v1'
+        @access_token    = nil
+        @organization_id = nil
+        @organization_id = nil
+        @logger          = Logger.new($stdout)
+      end
+    end
+  end
+end

data/lib/openai/client/http.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Http
+      def initialize
+        @connection = Faraday.new(url: Openai::Client.configuration.openai_url, headers: headers) do |conn|
+          conn.response :json
+          conn.response :raise_error
+          conn.request :json
+        end
+        @logger = Openai::Client.configuration.logger
+      end
+
+      # @api public
+      # Public: Makes a GET request using the Faraday HTTP Client.
+      #
+      # @param [String] path API path
+      # @param [String] query_params query params
+      #
+      # @raise [Faraday::Error] on failure API call
+      #
+      # @return [Faraday::Response] instance of Faraday::Response class
+      def get(path, query_params = {})
+        connection.get(path, query_params)
+      rescue Faraday::Error => e
+        log_error(e) && raise
+      end
+
+      # @api public
+      # Public: Makes a POST request using the Faraday HTTP Client.
+      #
+      # @param [String] path API path
+      # @param [Hash] body request body
+      #
+      # @raise [Faraday::Error] on failure API call
+      #
+      # @return [Faraday::Response] instance of Faraday::Response class
+      def post(path, body = {})
+        connection.post(path, body)
+      rescue Faraday::Error => e
+        log_error(e) && raise
+      end
+
+      private
+
+      attr_reader :connection, :logger
+
+      # @api private
+      # Internal: Logs failure API calls.
+      #
+      # @param [Faraday::Error] e the error to log
+      def log_error(e)
+        logger.error("Error response, status: #{e.response[:status]}, body: #{e.response[:body]}")
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{Openai::Client.configuration.access_token}",
+          'OpenAI-Organization' => Openai::Client.configuration.organization_id
+        }
+      end
+    end
+  end
+end

data/lib/openai/client/models.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    class Models
+      PATH = 'models'
+
+      # @api public
+      # Public: Makes an API call to return all models.
+      #
+      # @return [Hash] a hash with models
+      def list
+        Http.new.get(PATH).body
+      rescue StandardError
+        nil
+      end
+
+      # @api public
+      # Public: Makes an API call to find the model by the ID.
+      #
+      # @param [String] id model id
+      #
+      # @return [Hash] found model or nil
+      def find(id)
+        Http.new.get("#{PATH}/#{id}").body
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/openai/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Openai
+  module Client
+    VERSION = '0.1.0'
+  end
+end

data/lib/openai/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'logger'
+
+require 'openai/client/version'
+require 'openai/client/configuration'
+require 'openai/client/configurable'
+require 'openai/client/http'
+require 'openai/client/models'
+
+module Openai
+  module Client
+    extend Configurable
+
+    ATTRS = ['models'].freeze
+
+    class << self
+      ATTRS.each do |attr|
+        define_method(attr) do
+          instance_variable_get("@#{attr}") || instance_variable_set("@#{attr}",
+                                                                     const_get(attr.capitalize, self).new)
+        end
+      end
+    end
+  end
+end

data/openai-client.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/openai/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'openai-client'
+  spec.version = Openai::Client::VERSION
+  spec.authors = ['itikhonenko']
+  spec.email = ['tikhonenkoigor@gmail.com']
+
+  spec.summary = 'A Ruby gem for the OpenAI GPT-3 API'
+  spec.homepage = 'https://github.com/itikhonenko/openai-client'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/README.md"
+
+  # 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|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('faraday', '~> 1.8')
+  spec.add_dependency('faraday_middleware', '~> 1.2')
+end

data/sig/openai/client.rbs

@@ -0,0 +1,6 @@
+module Openai
+  module Client
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: openai-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- itikhonenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description:
+email:
+- tikhonenkoigor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/openai/client.rb
+- lib/openai/client/configurable.rb
+- lib/openai/client/configuration.rb
+- lib/openai/client/http.rb
+- lib/openai/client/models.rb
+- lib/openai/client/version.rb
+- openai-client.gemspec
+- sig/openai/client.rbs
+homepage: https://github.com/itikhonenko/openai-client
+licenses: []
+metadata:
+  homepage_uri: https://github.com/itikhonenko/openai-client
+  source_code_uri: https://github.com/itikhonenko/openai-client
+  changelog_uri: https://github.com/itikhonenko/openai-client/blob/main/README.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A Ruby gem for the OpenAI GPT-3 API
+test_files: []