bdd_openai 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9ba274250360c79996a8892b04ee815fa9d56b6f86ef89fb1c358ef1d5947d5
+  data.tar.gz: 59d776ac2bdc32da4b925714088cb405151fd4be634e7377b32f6ae85ccf725f
+SHA512:
+  metadata.gz: 233a711547dd485ac98b58c6a69287e431a198b2f5cb566bd4712607afcb034ba053fb6b52476fd2642b1bd288c091b90df6270f2bc3f3d39c31ad8fc264ad54
+  data.tar.gz: 4b4fd9a050fc82eaedb572e1871b3d4152bc6a0cfe0cb81c1643c7af7296d49831d0103716796e00d709c479bb6161859b736f81561cd6265fa655e6ca8a8ce7

data/.env.sample

@@ -0,0 +1 @@
+OPENAI_API_KEY=put-your-openai-api-key-here

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--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/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2023-12-10
+
+### Added
+
+- Init the Gem project using RubyMine template
+- Create module BddOpenai::Files
+
+### Changed
+
+- N/A

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at brendon.dao@employmenthero.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Brendon Dao
+
+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,62 @@
+# BddOpenai
+
+This gem is a personal exercise to get familiar with Ruby and Gem creating. gem Gem include only one top level namespace of TestOpenai which you can find all you need inside. Starting by creating an instance of BddOpenai::Files::Client.
+
+For this exercise, the client will provide wrapper to some of OpenAI File APIs. API doc can bbe found here:
+- https://platform.openai.com/docs/api-reference/files
+
+Other reference links:
+- https://github.com/brendondaoateh/bdd_openai
+- https://rubygems.org/gems/bdd_openai
+- https://rubydoc.info/gems/bdd_openai
+
+## Installation
+
+You can install the gem normally through RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add bdd_openai
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install bdd_openai
+
+## Usage
+
+Visit `spec/bdd_openai/files/client_spec.rb` for full sample code. Or:
+
+You can direct interact with gem by:
+
+```ruby
+require "bdd_openai"
+
+client = BddOpenai::Files::Client.new(ENV["OPENAI_API_KEY"])
+
+client.list_files
+
+client.upload_file("assistants", "spec/fixtures/sample.pdf")
+
+client.delete_file("file-id")
+
+client.retrieve_file("file-id")
+```
+
+## Testing
+
+- Copy file `.env.sample` to `.env` and fill in your personal OpenAI API's key
+- Run
+```
+bundle install
+rspec
+```
+
+### Test coverage
+
+The repository is integrated with [SimpleCov](https://github.com/simplecov-ruby/simplecov) to generate test coverage report. You can find the report at `coverage/index.html` after running the test.
+
+![test_coverage_screenshot](docs/test_coverage_screenshot_231211_125800.png)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brendondaoateh/bdd_openai.

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/bdd_openai.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bdd_openai/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bdd_openai'
+  spec.version = BddOpenai::VERSION
+  spec.authors = ['Brendon Dao']
+  spec.email = ['brendon.dao@employmenthero.com']
+  spec.metadata['source_code_uri'] = 'https://github.com/brendondaoateh/bdd_openai'
+  spec.summary = 'Write a short summary, because RubyGems requires one.'
+  spec.description = 'Write a longer description or delete this line.'
+
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  # spec.metadata["allowed_push_host"] = "Set to your gem server 'https://example.com'"
+
+  spec.homepage = spec.metadata['source_code_uri']
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/brendondaoateh/bdd_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 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

data/lib/bdd_openai/clients/http.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module BddOpenai
+  # Namespace for all external clients
+  module Client
+    # An HTTP client
+    class HttpClient
+      # @param uri [String]
+      # @param headers [Hash]
+      # @param disable_ssl [Boolean]
+      # @return [Net::HTTPResponse]
+      def call_get(uri, headers, disable_ssl: false)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = disable_ssl ? false : true
+        request = Net::HTTP::Get.new(uri.path, headers)
+        http.request(request)
+      end
+
+      # @param uri [String]
+      # @param req_body [String] Request body in the form of JSON string.
+      # @param headers [Hash]
+      # @param disable_ssl [Boolean]
+      # @return [Net::HTTPResponse]
+      def call_post(uri, req_body, headers, disable_ssl: false)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = disable_ssl ? false : true
+        request = Net::HTTP::Post.new(uri.path, headers)
+        request.body = req_body unless req_body.nil?
+        http.request(request)
+      end
+
+      # @param fields [Hash] The fields to be sent in the request body
+      # @param file_fields [Hash] The file fields to be sent in the request body, with value as the file path.
+      # @return [String, String (frozen)] The request body and the boundary string
+      def create_multipart_body(fields, file_fields)
+        boundary = "----#{SecureRandom.hex(16)}"
+        body = +''
+        fields.each do |name, value|
+          body << "--#{boundary}\r\n"
+          body << "Content-Disposition: form-data; name=\"#{name}\"\r\n\r\n"
+          body << "#{value}\r\n"
+        end
+        file_fields.each do |name, file_path|
+          body << "--#{boundary}\r\n"
+          body << "Content-Disposition: form-data; name=\"#{name}\"; filename=\"#{File.basename(file_path)}\"\r\n"
+          body << "Content-Type: application/octet-stream\r\n\r\n"
+          body << "#{File.read(file_path)}\r\n"
+        end
+        body << "--#{boundary}--\r\n"
+        [body, boundary]
+      end
+
+      # @param uri [String]
+      # @param headers [Hash]
+      # @param disable_ssl [Boolean]
+      # @return [Net::HTTPResponse]
+      def call_delete(uri, headers, disable_ssl: false)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = disable_ssl ? false : true
+        request = Net::HTTP::Delete.new(uri.path, headers)
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/bdd_openai/error_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BddOpenai
+  # A error response of openai
+  class ErrorResponse
+    # @return [String] error message
+    attr_accessor :message
+    # @return [String] type of error
+    attr_accessor :type
+    # @return [String] parameter that caused the error
+    attr_accessor :param
+    # @return [String] error code of openai
+    attr_accessor :code
+
+    # @param response_body [String] The full response body of OpenAI API
+    # @return [BddOpenai::ErrorResponse]
+    def self.from_json(response_body)
+      data = JSON.parse(response_body)['error']
+      BddOpenai::ErrorResponse.new(
+        message: data['message'],
+        type: data['type'],
+        param: data['param'],
+        code: data['code']
+      )
+    end
+
+    def initialize(**args)
+      args.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+  end
+end

data/lib/bdd_openai/files/client.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module BddOpenai
+  # Module for OpenAI Files API
+  # Ref: https://platform.openai.com/docs/api-reference/files
+  module Files
+    # Client for OpenAI Files API
+    class Client
+      # @param api_key [String] The key of the OpenAI API
+      def initialize(api_key = '')
+        @http_client = BddOpenai::Client::HttpClient.new
+        @openai_api_domain = 'https://api.openai.com/v1'
+        @openai_api_key = api_key
+      end
+
+      def default_headers
+        {
+          "Authorization": "Bearer #{@openai_api_key}",
+          "Content-Type": 'application/json'
+        }
+      end
+
+      # @return [Array<BddOpenai::Files::File>, BddOpenai::ErrorResponse]
+      def list_files
+        uri = URI.parse("#{@openai_api_domain}/files")
+        response = @http_client.call_get(uri, default_headers)
+        return BddOpenai::ErrorResponse.from_json(response.body) unless response.code == '200'
+
+        JSON.parse(response.body)['data'].map do |file|
+          BddOpenai::Files::File.from_json(file.to_json)
+        end
+      end
+
+      # @param purpose [String] The intended purpose of the file. One of: "fine-tune", "assistants".
+      # @param file_path [String] The path of the file to upload
+      # @return [BddOpenai::Files::File, BddOpenai::ErrorResponse]
+      def upload_file(purpose, file_path)
+        uri = URI.parse("#{@openai_api_domain}/files")
+        body, boundary = @http_client.create_multipart_body({ purpose: purpose }, { file: file_path })
+        headers = default_headers
+                  .merge({
+                           "Content-Type": "multipart/form-data; boundary=#{boundary}"
+                         })
+        response = @http_client.call_post(uri, body, headers)
+        return BddOpenai::ErrorResponse.from_json(response.body) unless response.code == '200'
+
+        BddOpenai::Files::File.from_json(response.body)
+      end
+
+      # @param file_id [String] The id of the file to delete
+      # @return [true, BddOpenai::ErrorResponse]
+      def delete_file(file_id)
+        uri = URI.parse("#{@openai_api_domain}/files/#{file_id}")
+        response = @http_client.call_delete(uri, default_headers)
+        return BddOpenai::ErrorResponse.from_json(response.body) unless response.code == '200'
+
+        true
+      end
+
+      # @param file_id [String] The id of the file to retrieve
+      # @return [BddOpenai::Files::File, BddOpenai::ErrorResponse]
+      def retrieve_file(file_id)
+        uri = URI.parse("#{@openai_api_domain}/files/#{file_id}")
+        response = @http_client.call_get(uri, default_headers)
+        return BddOpenai::ErrorResponse.from_json(response.body) unless response.code == '200'
+
+        BddOpenai::Files::File.from_json(response.body)
+      end
+    end
+  end
+end

data/lib/bdd_openai/files/file.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BddOpenai
+  # Module for OpenAI Files API
+  # Ref: https://platform.openai.com/docs/api-reference/files
+  module Files
+    # The File object
+    # Ref: https://platform.openai.com/docs/api-reference/files/object
+    class File
+      # @return [String] The file identifier, which can be referenced in the API endpoints.
+      attr_accessor :id
+      # @return [Integer] The size of the file, in bytes.
+      attr_accessor :bytes
+      # @return [Integer] The Unix timestamp (in seconds) for when the file was created.
+      attr_accessor :created_at
+      # @return [String] The name of the file.
+      attr_accessor :filename
+      # @return [String] The object type, which is always "file".
+      attr_accessor :object
+      # @return [String] The intended purpose of the file. Supported values are \
+      #   "fine-tune", "fine-tune-results", "assistants", and "assistants_output".
+      attr_accessor :purpose
+
+      def self.from_json(json_string)
+        data = JSON.parse(json_string)
+        new(
+          id: data['id'],
+          bytes: data['bytes'],
+          created_at: data['created_at'],
+          filename: data['filename'],
+          object: data['object'],
+          purpose: data['purpose']
+        )
+      end
+
+      def initialize(**args)
+        args.each do |k, v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+    end
+  end
+end

data/lib/bdd_openai/version.rb

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

data/lib/bdd_openai.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'securerandom'
+require_relative 'bdd_openai/clients/http'
+require_relative 'bdd_openai/error_response'
+require_relative 'bdd_openai/files/client'
+require_relative 'bdd_openai/files/file'
+require_relative 'bdd_openai/version'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: bdd_openai
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brendon Dao
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-11 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+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"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bdd_openai.gemspec
+- docs/test_coverage_screenshot_231211_125800.png
+- lib/bdd_openai.rb
+- lib/bdd_openai/clients/http.rb
+- lib/bdd_openai/error_response.rb
+- lib/bdd_openai/files/client.rb
+- lib/bdd_openai/files/file.rb
+- lib/bdd_openai/version.rb
+homepage: https://github.com/brendondaoateh/bdd_openai
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/brendondaoateh/bdd_openai
+  homepage_uri: https://github.com/brendondaoateh/bdd_openai
+  changelog_uri: https://github.com/brendondaoateh/bdd_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: Write a short summary, because RubyGems requires one.
+test_files: []