test_openai 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c763fe9842a24a0bcede6e6ee36c0f0bff8549dd167fbaa11b30e693e6c5fc9
+  data.tar.gz: 534bcc0f10976d5781f02f25e887c3f30c7c884f02b92dcb491aaa49ef09f764
+SHA512:
+  metadata.gz: 38d267fef20413d1617afcfb8cb3c92e09f091d39f8286a020d377921e09317c503ba7610dec039c772579c0d21e8197a5de56c55bdee3f8876237ecaa377920
+  data.tar.gz: 24bdef5502603dc7393c3620e8ab0ec773ddd171c1243d4e211200481f36340d5e983130d8fa921de11188944709de72837f1d3d33265cee0713d413a020a143

data/.env.sample

@@ -0,0 +1,2 @@
+OPENAI_API_HOST=https://api.openai.com/v1
+OPENAI_API_KEY=YOUR_API_KEY

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop-https---raw-githubusercontent-com-Thinkei-Thinkei-master--rubocop-default-v1-yml

@@ -0,0 +1,299 @@
+########################################
+# EmploymentHero Shared Rubocop Config #
+########################################
+# rubocop ~> 1.15.0
+
+AllCops:
+  Exclude:
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+  EnabledByDefault: false
+  DisabledByDefault: false
+  NewCops: disable
+
+Bundler:
+  Severity: warning
+
+Bundler/OrderedGems:
+  Description: >-
+                 Gems within groups in the Gemfile should be alphabetically sorted.
+  Enabled: false
+  VersionAdded: '0.46'
+  VersionChanged: '0.47'
+  TreatCommentsAsGroupSeparators: true
+  Include:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'
+
+Gemspec:
+  Severity: warning
+
+Layout/ClassStructure:
+  Severity: warning
+  Description: 'Enforces a configured order of definitions within a class body.'
+  StyleGuide: 'https://github.com/rubocop-hq/ruby-style-guide#consistent-classes'
+  Enabled: true
+  VersionAdded: '0.52'
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - public_methods
+      - protected_methods
+      - private_methods
+
+Metrics:
+  Severity: warning
+
+Metrics/BlockLength:
+  Description: 'Avoid long blocks with many lines.'
+  Enabled: true
+  VersionAdded: '0.44'
+  VersionChanged: '0.58'
+  CountComments: false  # count full line comments?
+  Max: 25
+  IgnoredMethods:
+    # By default, exclude the `#refine` method, as it tends to have larger
+    # associated blocks.
+    - configure
+    - included
+    - refine
+    - transaction
+    # rake methods
+    - namespace
+    - task
+    # rails methods
+    - create_table
+    - update_table
+    - setup
+    # grape api methods
+    - helpers
+    - group
+    - resource
+    - resources
+    - segment
+    - get
+    - post
+    - put
+    - patch
+    - delete
+    - route_param
+    # rspec methods
+    - after
+    - let
+    - let!
+    - before
+    - context
+    - describe
+    - describe_api
+    - feature
+    - shared_context
+    - shared_examples
+    - shared_examples_for
+    # factory_bot methods
+    - define
+    - factory
+    # cucumber methods
+    - scenario
+    - then
+    - when
+    - within
+    # pundit spec methods
+    - permissions
+    # Benchmark methods
+    - measure
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 200 lines of code.'
+  Enabled: true
+  VersionAdded: '0.25'
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongly correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: true
+  VersionAdded: '0.25'
+  Max: 10
+
+Layout/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  StyleGuide: '#80-character-limits'
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '0.46'
+  Max: 120
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: true
+  # The IgnoredPatterns option is a list of !ruby/regexp and/or string
+  # elements. Strings will be converted to Regexp objects. A line that matches
+  # any regular expression listed in this option will be ignored by LineLength.
+  IgnoredPatterns: []
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 15 lines of code.'
+  StyleGuide: '#short-methods'
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '0.59.2'
+  CountComments: false  # count full line comments?
+  Max: 15
+  IgnoredMethods: []
+
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 200 lines of code.'
+  Enabled: true
+  VersionAdded: '0.31'
+  CountComments: false  # count full line comments?
+  Max: 200
+
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: true
+  VersionAdded: '0.25'
+  Max: 10
+
+Security:
+  Severity: warning
+
+Style/Alias:
+  Description: 'Use alias instead of alias_method.'
+  StyleGuide: '#alias-method'
+  Enabled: false
+  VersionAdded: '0.9'
+  VersionChanged: '0.36'
+  EnforcedStyle: prefer_alias
+  SupportedStyles:
+    - prefer_alias
+    - prefer_alias_method
+
+Style/AndOr:
+  Severity: true
+  Description: 'Use &&/|| instead of and/or.'
+  StyleGuide: '#no-and-or-or'
+  Enabled: true
+  VersionAdded: '0.9'
+  VersionChanged: '0.25'
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  EnforcedStyle: conditionals
+  SupportedStyles:
+    - always
+    - conditionals
+
+Style/BlockDelimiters:
+  Severity: warning
+  Description: >-
+                Avoid using {...} for multi-line blocks (multiline chaining is
+                always ugly).
+                Prefer {...} over do...end for single-line blocks.
+  StyleGuide: '#single-line-blocks'
+  Enabled: true
+  VersionAdded: '0.30'
+  VersionChanged: '0.35'
+  EnforcedStyle: braces_for_chaining
+  SupportedStyles:
+    # The `line_count_based` style enforces braces around single line blocks and
+    # do..end around multi-line blocks.
+    - line_count_based
+    # The `semantic` style enforces braces around functional blocks, where the
+    # primary purpose of the block is to return a value and do..end for
+    # procedural blocks, where the primary purpose of the block is its
+    # side-effects.
+    #
+    # This looks at the usage of a block's method to determine its type (e.g. is
+    # the result of a `map` assigned to a variable or passed to another
+    # method) but exceptions are permitted in the `ProceduralMethods`,
+    # `FunctionalMethods` and `IgnoredMethods` sections below.
+    - semantic
+    # The `braces_for_chaining` style enforces braces around single line blocks
+    # and do..end around multi-line blocks, except for multi-line blocks whose
+    # return value is being chained with another method (in which case braces
+    # are enforced).
+    - braces_for_chaining
+  ProceduralMethods:
+    # Methods that are known to be procedural in nature but look functional from
+    # their usage, e.g.
+    #
+    #   time = Benchmark.realtime do
+    #     foo.bar
+    #   end
+    #
+    # Here, the return value of the block is discarded but the return value of
+    # `Benchmark.realtime` is used.
+    - benchmark
+    - bm
+    - bmbm
+    - create
+    - each_with_object
+    - measure
+    - new
+    - realtime
+    - tap
+    - with_object
+  FunctionalMethods:
+    # Methods that are known to be functional in nature but look procedural from
+    # their usage, e.g.
+    #
+    #   let(:foo) { Foo.new }
+    #
+    # Here, the return value of `Foo.new` is used to define a `foo` helper but
+    # doesn't appear to be used from the return value of `let`.
+    - let
+    - let!
+    - subject
+    - watch
+  IgnoredMethods:
+    # Methods that can be either procedural or functional and cannot be
+    # categorised from their usage alone, e.g.
+    #
+    #   foo = lambda do |x|
+    #     puts "Hello, #{x}"
+    #   end
+    #
+    #   foo = lambda do |x|
+    #     x * 100
+    #   end
+    #
+    # Here, it is impossible to tell from the return value of `lambda` whether
+    # the inner block's return value is significant.
+    - lambda
+    - proc
+    - it
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+  VersionAdded: '0.9'
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Style/MultipleComparison:
+  Description: >-
+                 Avoid comparing a variable with multiple items in a conditional,
+                 use Array#include? instead.
+  Enabled: false
+  VersionAdded: '0.49'

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/Thinkei/Thinkei/master/.rubocop_default_v1.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Change Log
+
+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).
+
+## [Unreleased]
+
+### Added
+- New feature or enhancement X.
+- Another feature Y.
+
+### Changed
+- Improvements to existing functionality.
+- Modifications to behavior.
+
+### Fixed
+- Bug fixes.
+- Addressed issues ABC and XYZ.
+
+## [1.0.0] - 2023-11-01
+
+### Added
+- Initial release.

data/README.md

@@ -0,0 +1,31 @@
+# TestOpenai
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/test_openai`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/test_openai.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/client.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+require 'net/http'
+require 'rest-client'
+
+module TestOpenai
+  class Client
+    attr_accessor :openai_host, :openai_key
+
+    # @param openai_host [String] The host of the OpenAI API
+    # @param openai_key [String] The key of the OpenAI API
+    # @return [TestOpenai::Client] A new instance of TestOpenai::OpenAIClient
+    def initialize(openai_host = 'https://api.openai.com', openai_key = '')
+      @openai_host = openai_host
+      @openai_key = openai_key
+    end
+
+    # @return [TestOpenai::ListFilesResp] The list of files
+    def list_files
+      url = "#{openai_host}/files"
+      headers = {
+        Authorization: "Bearer #{openai_key}"
+      }
+      res = RestClient.get(url, headers)
+
+      response_data = JSON.parse(res.body)
+      file_data = response_data['data']
+      TestOpenai::ListFilesResp.new(
+        object: response_data['object'],
+        has_more: response_data['has_more'],
+        data: file_data.map do |file|
+          parse_as_file(file)
+        end
+      )
+    end
+
+    # @param file_path [String] The path of the file to upload
+    # @return [TestOpenai::File] The file uploaded
+    def upload_file(file_path)
+      url = "#{openai_host}/files"
+      headers = {
+        Authorization: "Bearer #{openai_key}"
+      }
+      params = {
+        purpose: 'assistants',
+        file: ::File.new(file_path)
+      }
+      res = RestClient.post(url, params, headers)
+      parse_as_file(JSON.parse(res.body))
+    end
+
+    # @param file_id [String] The id of the file to delete
+    # @return [TestOpenai::DeleteFileResp] The response of the deletion
+    def delete_file(file_id)
+      url = "#{openai_host}/files/#{file_id}"
+      headers = {
+        Authorization: "Bearer #{openai_key}"
+      }
+      res = RestClient.delete(url, headers)
+      response_data = JSON.parse(res.body)
+      TestOpenai::DeleteFileResp.new(
+        object: response_data['object'],
+        id: response_data['id'],
+        deleted: response_data['deleted']
+      )
+    end
+
+    # @param file_id [String] The id of the file to get
+    # @return [TestOpenai::File] The file gotten
+    def get_file(file_id)
+      url = "#{openai_host}/files/#{file_id}"
+      headers = {
+        Authorization: "Bearer #{openai_key}"
+      }
+      res = RestClient.get(url, headers)
+      parse_as_file(JSON.parse(res.body))
+    end
+
+    def get_file_content(file_id)
+      url = "#{openai_host}/files/#{file_id}/content"
+      headers = {
+        Authorization: "Bearer #{openai_key}"
+      }
+      res = RestClient.get(url, headers)
+      res.body
+    end
+
+    # @private
+    def parse_as_file(data)
+      TestOpenai::File.new(
+        object: data['object'],
+        id: data['id'],
+        purpose: data['purpose'],
+        filename: data['filename'],
+        bytes: data['bytes'],
+        created_at: data['created_at']
+      )
+    end
+  end
+end

data/lib/models.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+require 'net/http'
+require 'rest-client'
+
+module TestOpenai
+  # The file object used by OpenAI API
+  class File
+    # @return [String] Type of the data. Always: 'file'.
+    attr_accessor :object
+    # @return [String] The id of the data.
+    attr_accessor :id
+    # @return [String] The purpose of the data.
+    attr_accessor :purpose
+    # @return [String] Original filename.
+    attr_accessor :filename
+    # @return [Integer] Size of the file in bytes.
+    attr_accessor :bytes
+    # @return [Integer] Timestamp in seconds of creation time of the file.
+    attr_accessor :created_at
+
+    def initialize(**args)
+      @object = args[:object]
+      @id = args[:id]
+      @purpose = args[:purpose]
+      @filename = args[:filename]
+      @bytes = args[:bytes]
+      @created_at = args[:created_at]
+    end
+  end
+
+  class ListFilesResp
+    # @return [String] Type of the data. Ex: 'list'.
+    attr_accessor :object
+    # @return [Boolean] Whether there are more data to load.
+    attr_accessor :has_more
+    # @return [Array<TestOpenai::File>] The list of files.
+    attr_accessor :data
+
+    def initialize(**args)
+      @object = args.fetch(:object, 'list')
+      @has_more = args.fetch(:has_more, false)
+      @data = args.fetch(:data, [])
+    end
+  end
+
+  class DeleteFileResp
+    # @return [String] Type of the data. Ex: 'file'.
+    attr_accessor :object
+    # @return [String] The id of the data.
+    attr_accessor :id
+    # @return [true, false] Whether the data was deleted.
+    attr_accessor :deleted
+
+    def initialize(**args)
+      @object = args.fetch(:object, 'file')
+      @id = args.fetch(:id, '')
+      @deleted = args.fetch(:deleted, false)
+    end
+  end
+end

data/lib/test_openai/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TestOpenai
+  VERSION = '0.1.2'
+end

data/sig/test_openai.rbs

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

data/test_openai.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/test_openai/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'test_openai'
+  spec.version = TestOpenai::VERSION
+  spec.authors = ['Brendon Dao']
+  spec.email = ['brendon.dao@employmenthero.com']
+  spec.metadata['source_code_uri'] = 'https://github.com/brendondaoateh/test_openai'
+
+  spec.summary = 'A sample gem to call OpenAI API'
+  spec.description = 'A sample gem to call OpenAI API'
+  spec.homepage = spec.metadata['source_code_uri']
+  spec.required_ruby_version = '>= 2.7.0'
+  spec.license = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/brendondaoateh/test_openai/blob/main/CHANGELOG.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|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: test_openai
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Brendon Dao
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-27 00:00:00.000000000 Z
+dependencies: []
+description: A sample gem to call OpenAI API
+email:
+- brendon.dao@employmenthero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".rspec"
+- ".rubocop-https---raw-githubusercontent-com-Thinkei-Thinkei-master--rubocop-default-v1-yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/client.rb
+- lib/models.rb
+- lib/test_openai/version.rb
+- sig/test_openai.rbs
+- test_openai.gemspec
+homepage: https://github.com/brendondaoateh/test_openai
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/brendondaoateh/test_openai
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/brendondaoateh/test_openai
+  changelog_uri: https://github.com/brendondaoateh/test_openai/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A sample gem to call OpenAI API
+test_files: []