openai_helper_gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95b6f0c9a4e8ac865a75b836fe47e24af0e2f55842ca4b61693b024173f25141
+  data.tar.gz: b3839baaebd14496259c50847bd95cb437b89bef635106f53dd6173509445c7d
+SHA512:
+  metadata.gz: 6d5e9d057dc8d9fa200a0b3f99ca769203af14b6b32e8914b3da08ee06404a3fe8b8fcc8560ba39ac77a53793c1fd7c0e5a5a06c406a94c14be532ea9ad72568
+  data.tar.gz: a0e02ec7bc677431b0a00a9268647d8f9740d9573288e50e5135e02587be3de13b7c08410af792ac9c4bd0c05eb291aa2d248dc326702fc067bacdb287efc5ed

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Miguel Regedor
+
+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,127 @@
+# OpenAIHelperGem
+
+`OpenAIHelperGem` is a Ruby module designed to simplify interactions with OpenAI's API. It provides functionality to upload files, send messages with structured outputs, generate speech from text, and automatically play the resulting audio on macOS.
+
+## Features
+
+- **File Upload:** Upload files to OpenAI and retrieve `file_id` for further use.
+- **Text-to-Speech (TTS):** Convert text to high-quality speech and save the audio locally.
+- **Autoplay Audio:** Automatically play the generated audio after saving (configurable).
+- **Structured Output Extraction:** Send messages and extract structured outputs from OpenAI responses.
+- **Custom Notifications:** Handle errors with notifications (macOS, terminal output, or none).
+
+## Installation
+
+Add the module to your project:
+
+```ruby
+require_relative 'path_to_openai_helper_gem/openai_helper_gem'
+```
+
+Ensure you have the following environment variables set:
+
+- `OPENAI_API_KEY`: Your OpenAI API key.
+- `GPT_MODEL` (optional): The OpenAI model you wish to use (defaults to gpt-3.5-turbo).
+- `OPENAI_AUDIO_PATH` (optional): Custom path to save generated audio (defaults to the user's home directory).
+
+## Usage
+
+### Basic Example
+
+Send a message and extract structured output:
+
+```ruby
+require_relative 'openai_helper_gem'
+
+messages = [{ role: 'user', content: 'Tell me a joke.' }]
+schema = {
+  type: "object",
+  properties: {
+    joke: { type: "string" }
+  },
+  required: ["joke"]
+}
+
+response = OpenAIHelperGem::Client.perform_request(messages, schema)
+puts response['joke']
+```
+
+### File Upload
+
+Upload a file to OpenAI and retrieve the `file_id`:
+
+```ruby
+file_id = OpenAIHelperGem::Client.upload_file('path_to_your_file.pdf')
+```
+
+### Generate Speech
+
+Generate speech from text and automatically play the audio:
+
+```ruby
+OpenAIHelperGem::Client.generate_speech("This is a test message.")
+```
+
+Generate speech without playing it immediately:
+
+```ruby
+OpenAIHelperGem::Client.generate_speech("This is a test message.", "output.mp3", autoplay: false)
+```
+
+### Notifications
+
+Customize how errors and other notifications are handled:
+
+Use terminal output:
+
+```ruby
+OpenAIHelperGem::Client.notification_method = :puts
+```
+
+Disable notifications:
+
+```ruby
+OpenAIHelperGem::Client.notification_method = :none
+```
+
+### Default Paths
+
+The module saves generated audio files to a default directory in the user's home folder:
+
+```ruby
+OpenAIHelperGem::Client.default_audio_path = ENV['OPENAI_AUDIO_PATH'] || File.join(Dir.home, 'Local Resources', 'API Logs', 'OpenAI Whisper')
+```
+
+## Complex Example
+
+Here’s a more comprehensive example that combines file upload, schema validation, and text-to-speech generation:
+
+```ruby
+require_relative 'openai_helper_gem'
+
+# Step 1: Define messages and schema
+messages = [
+  { role: 'user', content: 'Please summarize the attached document.' }
+]
+
+schema = {
+  type: "object",
+  properties: {
+    summary: { type: "string" }
+  },
+  required: ["summary"]
+}
+
+# Step 2: Send message with the file and extract structured output
+response = OpenAIHelperGem::Client.perform_request(messages, schema, 'path_to_your_document.pdf')
+
+# Step 3: Output the summary
+puts response['summary']
+
+# Step 4: Convert the summary to speech and save it as an audio file
+OpenAIHelperGem::Client.generate_speech(response['summary'], "document_summary.mp3")
+```
+
+## License
+
+This module is free to use and modify under the MIT License. See the `LICENSE.txt` file for more details.

data/lib/openai_helper_gem/client.rb

@@ -0,0 +1,129 @@
+require 'net/http'
+require 'json'
+require 'uri'
+require 'fileutils'
+
+module OpenAIHelperGem
+  class Client
+    @notification_method = :mac_os
+    @default_audio_path = ENV['OPENAI_AUDIO_PATH'] || File.join(Dir.home, 'Local Resources', 'API Logs', 'OpenAI Whisper')
+    @api_key = ENV['OPENAI_API_KEY']
+    @tts_api_endpoint = URI('https://api.openai.com/v1/audio/speech')
+    @file_upload_endpoint = URI('https://api.openai.com/v1/files')
+    @chat_completion_endpoint = URI('https://api.openai.com/v1/chat/completions')
+
+    class << self
+      attr_accessor :notification_method, :default_audio_path, :api_key
+
+      def upload_file(file_path)
+        file = File.open(file_path, 'rb')
+        request_data = { purpose: 'assistant', file: file }
+
+        begin
+          http = Net::HTTP.new(@file_upload_endpoint.host, @file_upload_endpoint.port)
+          http.use_ssl = true
+          request = Net::HTTP::Post.new(@file_upload_endpoint.path, { 'Authorization': "Bearer #{@api_key}" })
+          request.set_form([['file', file]], 'multipart/form-data')
+          response = http.request(request)
+          file.close
+          result = JSON.parse(response.body)
+          if result['error']
+            notify_error("File Upload Failed", result['error']['message'])
+            exit 1
+          end
+          result['id']
+        rescue StandardError => e
+          notify_error("File Upload Error", e.message)
+          exit 1
+        end
+      end
+
+      def send_message_with_file(messages, file_id)
+        request_data = { model: ENV['GPT_MODEL'] || 'gpt-3.5-turbo', messages: messages, file_ids: [file_id] }
+
+        begin
+          http = Net::HTTP.new(@chat_completion_endpoint.host, @chat_completion_endpoint.port)
+          http.use_ssl = true
+          request = Net::HTTP::Post.new(@chat_completion_endpoint.path, {
+            'Content-Type': 'application/json',
+            'Authorization': "Bearer #{@api_key}"
+          })
+          request.body = request_data.to_json
+          response = http.request(request)
+          JSON.parse(response.body)
+        rescue StandardError => e
+          notify_error("API Request Failed", e.message)
+          exit 1
+        end
+      end
+
+      def generate_speech(text, output_file_name = "output.mp3", autoplay: true)
+        request_data = { model: 'tts-1-hd', voice: 'alloy', input: text }
+
+        begin
+          http = Net::HTTP.new(@tts_api_endpoint.host, @tts_api_endpoint.port)
+          http.use_ssl = true
+          request = Net::HTTP::Post.new(@tts_api_endpoint.path, {
+            'Content-Type': 'application/json',
+            'Authorization': "Bearer #{@api_key}"
+          })
+          request.body = request_data.to_json
+          response = http.request(request)
+
+          output_path = File.join(@default_audio_path, output_file_name)
+          FileUtils.mkdir_p(File.dirname(output_path))
+          File.open(output_path, 'wb') { |file| file.write(response.body) }
+
+          puts "Audio saved to #{output_path}"
+          play_audio(output_path) if autoplay
+        rescue StandardError => e
+          notify_error("Text-to-Speech Error", e.message)
+          exit 1
+        end
+      end
+
+      def play_audio(file_path)
+        system("afplay '#{file_path}'")
+      end
+
+      def extract_structured_output(response)
+        if response['error']
+          notify_error("API Error", response['error']['message'])
+          exit 1
+        end
+
+        function_call = response.dig('choices', 0, 'message', 'function_call')
+        unless function_call && function_call['arguments']
+          notify_error("Invalid Response", "No structured output found in the response.")
+          exit 1
+        end
+
+        begin
+          JSON.parse(function_call['arguments'])
+        rescue JSON::ParserError => e
+          notify_error("JSON Parsing Error", e.message)
+          exit 1
+        end
+      end
+
+      def perform_request(messages, schema, file_path = nil)
+        file_id = upload_file(file_path) if file_path
+        response = send_message_with_file(messages, file_id) if file_id
+        extract_structured_output(response)
+      end
+
+      def notify_error(title, message)
+        case @notification_method
+        when :mac_os
+          system("osascript -e 'display notification \"#{message}\" with title \"#{title}\"'")
+        when :puts
+          puts "[#{title}] #{message}"
+        when :none
+          # No output
+        else
+          puts "[Unknown Notification Method] #{title}: #{message}"
+        end
+      end
+    end
+  end
+end

data/lib/openai_helper_gem/version.rb

@@ -0,0 +1,3 @@
+module OpenAIHelperGem
+  VERSION = "0.1.0"
+end

data/lib/openai_helper_gem.rb

@@ -0,0 +1,6 @@
+require "openai_helper_gem/version"
+require "openai_helper_gem/client"
+
+module OpenAIHelperGem
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: openai_helper_gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miguel Regedor
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: OpenAIHelper is a Ruby module designed to enhance productivity by integrating
+  OpenAI's capabilities into local scripts. It allows file uploads, structured output
+  extraction, text-to-speech generation, and automatic audio playback.
+email:
+- miguelregedor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/openai_helper_gem.rb
+- lib/openai_helper_gem/client.rb
+- lib/openai_helper_gem/version.rb
+homepage: http://example.com/openai_helper_gem
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: A Ruby module to simplify interactions with OpenAI's API.
+test_files: []