bdd_openai 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ba274250360c79996a8892b04ee815fa9d56b6f86ef89fb1c358ef1d5947d5
-  data.tar.gz: 59d776ac2bdc32da4b925714088cb405151fd4be634e7377b32f6ae85ccf725f
+  metadata.gz: 56cdede8702f4004ca214db560794e5d37773889ebf0b3c09a8cd6b87fc63940
+  data.tar.gz: 1fbffb02950082c214b189e6505465bde18eb07b020b9ead9f47e3a95bdb44a4
 SHA512:
-  metadata.gz: 233a711547dd485ac98b58c6a69287e431a198b2f5cb566bd4712607afcb034ba053fb6b52476fd2642b1bd288c091b90df6270f2bc3f3d39c31ad8fc264ad54
-  data.tar.gz: 4b4fd9a050fc82eaedb572e1871b3d4152bc6a0cfe0cb81c1643c7af7296d49831d0103716796e00d709c479bb6161859b736f81561cd6265fa655e6ca8a8ce7
+  metadata.gz: eec6abbce93c90bad22bf7fe8c6b8d8878f4cffa2588e92d0ca635ca78ba17ccbb506e45e4e37c599022d9ec3b921c5ab9bb065695923053f18ec3d79ec2e485
+  data.tar.gz: 29502804936673dfda3d9a708df7ad65c6741363e7f79d98381a6b3419ed7e6846efb2646fc00864b0e68eb8d64a3b6b37bf81dc8d54568e906a023557c9f195

data/CHANGELOG.md

@@ -2,13 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.0] - 2023-12-13
+
+### Changed
+
+- Move BddOpenai::Files::Client to BddOpenai::FileClient
+
 ## [1.0.0] - 2023-12-10
 
 ### Added
 
 - Init the Gem project using RubyMine template
 - Create module BddOpenai::Files
-
-### Changed
-
-- N/A

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+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::FileClient.
 
 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
@@ -31,7 +31,7 @@ You can direct interact with gem by:
 ```ruby
 require "bdd_openai"
 
-client = BddOpenai::Files::Client.new(ENV["OPENAI_API_KEY"])
+client = BddOpenai::FileClient.new(ENV["OPENAI_API_KEY"])
 
 client.list_files
 

data/lib/bdd_openai/clients/http.rb

@@ -5,26 +5,26 @@ module BddOpenai
   module Client
     # An HTTP client
     class HttpClient
-      # @param uri [String]
+      # @param uri [URI::Generic]
       # @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 = Net::HTTP.new(uri.host || '', uri.port)
         http.use_ssl = disable_ssl ? false : true
-        request = Net::HTTP::Get.new(uri.path, headers)
+        request = Net::HTTP::Get.new(uri.path || '', headers)
         http.request(request)
       end
 
-      # @param uri [String]
+      # @param uri [URI::Generic]
       # @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 = Net::HTTP.new(uri.host || '', uri.port)
         http.use_ssl = disable_ssl ? false : true
-        request = Net::HTTP::Post.new(uri.path, headers)
+        request = Net::HTTP::Post.new(uri.path || '', headers)
         request.body = req_body unless req_body.nil?
         http.request(request)
       end
@@ -50,14 +50,14 @@ module BddOpenai
         [body, boundary]
       end
 
-      # @param uri [String]
+      # @param uri [URI::Generic]
       # @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 = Net::HTTP.new(uri.host || '', uri.port)
         http.use_ssl = disable_ssl ? false : true
-        request = Net::HTTP::Delete.new(uri.path, headers)
+        request = Net::HTTP::Delete.new(uri.path || '', headers)
         http.request(request)
       end
     end

data/lib/bdd_openai/file_client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'services/files/delete'
+require_relative 'services/files/list'
+require_relative 'services/files/retrieve'
+require_relative 'services/files/upload'
+
+module BddOpenai
+  # Client for OpenAI Files API
+  # Ref: https://platform.openai.com/docs/api-reference/files
+  class FileClient
+    # @param api_key [String] The key of the OpenAI API
+    attr_accessor :api_key
+
+    def initialize(api_key = '')
+      @api_key = api_key
+    end
+
+    # @return [Array<BddOpenai::Mapper::File>, BddOpenai::ErrorResponse]
+    def list_files
+      BddOpenai::Services::Files::List.new(@api_key).list_files
+    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.rb
+    # @return [BddOpenai::Mapper::File, BddOpenai::ErrorResponse]
+    def upload_file(purpose, file_path)
+      BddOpenai::Services::Files::Upload.new(@api_key).upload_files(purpose, file_path)
+    end
+
+    # @param file_id [String] The id of the file to delete
+    # @return [true, BddOpenai::ErrorResponse]
+    def delete_file(file_id)
+      BddOpenai::Services::Files::Delete.new(@api_key).delete_file(file_id)
+    end
+
+    # @param file_id [String] The id of the file to retrieve
+    # @return [BddOpenai::Mapper::File, BddOpenai::ErrorResponse]
+    def retrieve_file(file_id)
+      BddOpenai::Services::Files::Retrieve.new(@api_key).retrieve_file(file_id)
+    end
+  end
+end

data/lib/bdd_openai/{files → mappers}/file.rb

@@ -3,7 +3,7 @@
 module BddOpenai
   # Module for OpenAI Files API
   # Ref: https://platform.openai.com/docs/api-reference/files
-  module Files
+  module Mapper
     # The File object
     # Ref: https://platform.openai.com/docs/api-reference/files/object
     class File

data/lib/bdd_openai/services/files/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BddOpenai
+  module Services
+    module Files
+      class Base
+        # @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
+      end
+    end
+  end
+end

data/lib/bdd_openai/services/files/delete.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module BddOpenai
+  module Services
+    module Files
+      class Delete < Base
+        # @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
+      end
+    end
+  end
+end

data/lib/bdd_openai/services/files/list.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module BddOpenai
+  module Services
+    module Files
+      class List < Base
+        # @return [Array<BddOpenai::Mapper::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::Mapper::File.from_json(file.to_json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bdd_openai/services/files/retrieve.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module BddOpenai
+  module Services
+    module Files
+      class Retrieve < Base
+        # @param file_id [String] The id of the file to retrieve
+        # @return [BddOpenai::Mapper::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::Mapper::File.from_json(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/bdd_openai/services/files/upload.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module BddOpenai
+  module Services
+    module Files
+      class Upload < Base
+        # @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.rb
+        # @return [BddOpenai::Mapper::File, BddOpenai::ErrorResponse]
+        def upload_files(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::Mapper::File.from_json(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/bdd_openai/version.rb

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

data/lib/bdd_openai.rb

@@ -5,6 +5,6 @@ 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/file_client'
+require_relative 'bdd_openai/mappers/file'
 require_relative 'bdd_openai/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bdd_openai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brendon Dao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies: []
 description: Write a longer description or delete this line.
 email:
@@ -32,8 +32,13 @@ files:
 - 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/file_client.rb
+- lib/bdd_openai/mappers/file.rb
+- lib/bdd_openai/services/files/base.rb
+- lib/bdd_openai/services/files/delete.rb
+- lib/bdd_openai/services/files/list.rb
+- lib/bdd_openai/services/files/retrieve.rb
+- lib/bdd_openai/services/files/upload.rb
 - lib/bdd_openai/version.rb
 homepage: https://github.com/brendondaoateh/bdd_openai
 licenses:

data/lib/bdd_openai/files/client.rb

@@ -1,71 +0,0 @@
-# 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