chatgpt-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc49f5bb5b5d4862838cbb111ecd00bccf7a4adc3b7edb23b8f4e5157da2a8b
-  data.tar.gz: f4ec243a9aeeb0ee03c82b58241d9df097a2985ca7ba15a77707645b3922ff13
+  metadata.gz: 4fb132d30e599a50c8d7f9772fec8fed575883f5cfd3d3f42f91f0b9db9d345e
+  data.tar.gz: 68790d6783d57b4cbfaae685e0f8e6048f531959852bc91df4b62a8e61712532
 SHA512:
-  metadata.gz: 8b7edafba1fdf4d46adada02994ea92ced8c510b11bfe03fadcf4445e39813b169a594f4baae6ae5cddb44d2146d8111827a328f5e424174826ab4eecbb2d0c0
-  data.tar.gz: d5c1d54f84fe5c478bbffc2d85571e9f139072a460272152088dc85e84bbbfa8b24a5b53df3030602ba22de0cbcdad019fef0f7a5ef99f718c8d1e89d18bfbf5
+  metadata.gz: 9729ae2cea19ff37e8b7fe0c810bc4a2c05d273078aad4702effe989c8fa393690605114a59c4022b4e758aad5e0451fe6667b68ee688bfe8e6f5594a31574bb
+  data.tar.gz: 4d42361f982bb0448bc9cceba09646ef14fd83b03b1940e6fed650aaf695e677e2da5e3caefbec57253c9adf38d9fae4384c311fae5f5d1d8c4a764343769c51

data/README.md

@@ -1,131 +1,257 @@
 # ChatGPT Ruby
 
-[![Gem Version](https://badge.fury.io/rb/chatgpt-ruby.svg)](https://badge.fury.io/rb/chatgpt-ruby) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Maintainability](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/maintainability)](https://codeclimate.com/github/nagstler/chatgpt-ruby/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/test_coverage)](https://codeclimate.com/github/nagstler/chatgpt-ruby/test_coverage) [![CI](https://github.com/nagstler/chatgpt-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/nagstler/chatgpt-ruby/actions/workflows/ci.yml) [![GitHub contributors](https://img.shields.io/github/contributors/nagstler/chatgpt-ruby)](https://github.com/nagstler/chatgpt-ruby/graphs/contributors)
-
-The `chatgpt-ruby` is a Ruby SDK for the OpenAI API, providing methods for generating text and completing prompts using the ChatGPT model.
+[![Gem Version](https://badge.fury.io/rb/chatgpt-ruby.svg)](https://badge.fury.io/rb/chatgpt-ruby)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Maintainability](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/maintainability)](https://codeclimate.com/github/nagstler/chatgpt-ruby/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/08c7e7b58e9fbe7156eb/test_coverage)](https://codeclimate.com/github/nagstler/chatgpt-ruby/test_coverage)
+[![CI](https://github.com/nagstler/chatgpt-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/nagstler/chatgpt-ruby/actions/workflows/ci.yml)
+
+🤖💎 A comprehensive Ruby SDK for OpenAI's GPT APIs, providing a robust, feature-rich interface for AI-powered applications.
+
+📚 [Check out the Integration Guide](https://github.com/nagstler/chatgpt-ruby/wiki) to get started!
+
+## Features
+
+- 🚀 Full support for GPT-3.5-Turbo and GPT-4 models
+- 📡 Streaming responses support
+- 🔧 Function calling and JSON mode
+- 🎨 DALL-E image generation
+- 🔄 Fine-tuning capabilities
+- 📊 Token counting and validation
+- ⚡ Async operations support
+- 🛡️ Built-in rate limiting and retries
+- 🎯 Type-safe responses
+- 📝 Comprehensive logging
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+- [Core Features](#core-features)
+  - [Chat Completions](#chat-completions)
+  - [Function Calling](#function-calling)
+  - [Image Generation (DALL-E)](#image-generation-dall-e)
+  - [Fine-tuning](#fine-tuning)
+  - [Token Management](#token-management)
+  - [Error Handling](#error-handling)
+- [Advanced Usage](#advanced-usage)
+  - [Async Operations](#async-operations)
+  - [Batch Operations](#batch-operations)
+  - [Response Objects](#response-objects)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'chatgpt-ruby'
 ```
 
-And then execute:
+Or install directly:
 
-```ruby
-$ bundle install
+```bash
+$ gem install chatgpt-ruby
 ```
 
-Or install it yourself as:
+## Quick Start
 
 ```ruby
-$ gem install chatgpt-ruby
-```
+require 'chatgpt'
 
-## Usage
+# Initialize with API key
+client = ChatGPT::Client.new(ENV['OPENAI_API_KEY'])
 
-To use the ChatGPT API SDK, you will need an API key from OpenAI. You can obtain an API key by signing up for the [OpenAI API beta program](https://beta.openai.com/signup/) .
+# Chat API (Recommended for GPT-3.5-turbo, GPT-4)
+response = client.chat([
+  { role: "user", content: "What is Ruby?" }
+])
 
-Once you have an API key, you can create a new `ChatGPT::Client` instance with your API key:
+puts response.dig("choices", 0, "message", "content")
 
-```ruby
-require 'chatgpt/client'
+# Completions API (For GPT-3.5-turbo-instruct)
+response = client.completions("What is Ruby?")
+puts response.dig("choices", 0, "text")
 
-api_key = 'your-api-key'
-client = ChatGPT::Client.new(api_key)
 ```
 
-## Completions
-
-To generate completions given a prompt, you can use the `completions` method:
+## Configuration
 
 ```ruby
-prompt = 'Hello, my name is'
-completions = client.completions(prompt)
-
-# Output: an array of completion strings
+ChatGPT.configure do |config|
+  config.api_key = ENV['OPENAI_API_KEY']
+  config.api_version = 'v1'
+  config.default_engine = 'gpt-3.5-turbo'
+  config.request_timeout = 30
+  config.max_retries = 3
+  config.default_parameters = {
+    max_tokens: 16,
+    temperature: 0.5,
+    top_p: 1.0,
+    n: 1
+  }
+end
 ```
 
-You can customize the generation process by passing in additional parameters as a hash:
+## Core Features
+
+### Chat Completions
 
 ```ruby
-params = {
-  engine: 'text-davinci-002',
-  max_tokens: 50,
-  temperature: 0.7
-}
-completions = client.completions(prompt, params)
-
-puts completions["choices"].map { |c| c["text"] }
-# Output: an array of completion strings
+# Chat with system message
+response = client.chat([
+  { role: "system", content: "You are a helpful assistant." },
+  { role: "user", content: "Hello!" }
+])
+
+# With streaming
+client.chat_stream([
+  { role: "user", content: "Tell me a story" }
+]) do |chunk|
+  print chunk.dig("choices", 0, "delta", "content")
+end
 ```
 
-## Chat
+### Function Calling
 
-The `chat` method allows for a dynamic conversation with the GPT model. It requires an array of messages where each message is a hash with two properties: `role` and `content`.
+```ruby
+functions = [
+  {
+    name: "get_weather",
+    description: "Get current weather",
+    parameters: {
+      type: "object",
+      properties: {
+        location: { type: "string" },
+        unit: { type: "string", enum: ["celsius", "fahrenheit"] }
+      }
+    }
+  }
+]
 
-`role` can be: 
-- `'system'`: Used for instructions that guide the conversation. 
-- `'user'`: Represents the user's input. 
-- `'assistant'`: Represents the model's output.
+response = client.chat(
+  messages: [{ role: "user", content: "What's the weather in London?" }],
+  functions: functions,
+  function_call: "auto"
+)
+```
 
-`content` contains the text message from the corresponding role.
+### Image Generation (DALL-E)
 
-Here is how you would start a chat:
+```ruby
+# Generate image
+image = client.images.generate(
+  prompt: "A sunset over mountains",
+  size: "1024x1024",
+  quality: "hd"
+)
+
+# Create variations
+variation = client.images.create_variation(
+  image: File.read("input.png"),
+  n: 1
+)
+```
+
+### Fine-tuning
 
 ```ruby
+# Create fine-tuning job
+job = client.fine_tunes.create(
+  training_file: "file-abc123",
+  model: "gpt-3.5-turbo"
+)
 
-# Define the conversation messages
-messages = [
-  {
-    role: "system",
-    content: "You are a helpful assistant."
-  },
-  {
-    role: "user",
-    content: "Who won the world series in 2020?"
-  }
-]
+# List fine-tuning jobs
+jobs = client.fine_tunes.list
 
-# Start a chat
-response = client.chat(messages)
+# Get job status
+status = client.fine_tunes.retrieve(job.id)
 ```
 
-The response will be a hash containing the model's message(s). You can extract the assistant's message like this:
+### Token Management
 
 ```ruby
+# Count tokens
+count = client.tokens.count("Your text here", model: "gpt-4")
 
-puts response['choices'][0]['message']['content'] # Outputs the assistant's message
+# Validate token limits
+client.tokens.validate_messages(messages, max_tokens: 4000)
 ```
 
-The conversation can be continued by extending the `messages` array and calling the `chat` method again:
+### Error Handling
 
 ```ruby
+begin
+  response = client.chat(messages: [...])
+rescue ChatGPT::RateLimitError => e
+  puts "Rate limit hit: #{e.message}"
+rescue ChatGPT::APIError => e
+  puts "API error: #{e.message}"
+rescue ChatGPT::TokenLimitError => e
+  puts "Token limit exceeded: #{e.message}"
+end
+```
+
+## Advanced Usage
+
+### Async Operations
+
+```ruby
+client.async do
+  response1 = client.chat(messages: [...])
+  response2 = client.chat(messages: [...])
+  [response1, response2]
+end
+```
 
-messages << {role: "user", content: "Tell me more about it."}
+### Batch Operations
 
-response = client.chat(messages)
-puts response['choices'][0]['message']['content'] # Outputs the assistant's new message
+```ruby
+responses = client.batch do |batch|
+  batch.add_chat(messages: [...])
+  batch.add_chat(messages: [...])
+end
 ```
 
-With this method, you can build an ongoing conversation with the model.
+### Response Objects
+
+```ruby
+response = client.chat(messages: [...])
+
+response.content  # Main response content
+response.usage   # Token usage information
+response.finish_reason  # Why the response ended
+response.model   # Model used
+```
 
 ## 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.
+```bash
+# Run tests
+bundle exec rake test
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+# Run linter
+bundle exec rubocop
+
+# Generate documentation
+bundle exec yard doc
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/nagstler/chatgpt-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nagstler/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Add tests for your feature
+4. Make your changes
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin feature/my-new-feature`)
+7. Create a new Pull Request
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Chatgpt::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nagstler/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
+Released under the MIT License. See [LICENSE](LICENSE.txt) for details.

data/lib/chatgpt/client.rb

@@ -1,111 +1,125 @@
+# frozen_string_literal: true
+
+# lib/chatgpt/client.rb
 require 'rest-client'
 require 'json'
 
 module ChatGPT
   class Client
-    # Initialize the client with the API key
-    #
-    # @param api_key [String] The API key for the GPT-3 service
-    def initialize(api_key)
-      @api_key = api_key
-      # Base endpoint for the OpenAI API
+    def initialize(api_key = nil)
+      @api_key = api_key || ChatGPT.configuration.api_key
       @endpoint = 'https://api.openai.com/v1'
+      @config = ChatGPT.configuration
     end
 
-    # Prepare headers for the API request
-    #
-    # @return [Hash] The headers for the API request
-    def headers
-      {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
-    end
-
-    # Generate completions based on a given prompt
-    #
-    # @param prompt [String] The prompt to be completed
-    # @param params [Hash] Additional parameters for the completion request
-    #
-    # @return [Hash] The completion results from the API
     def completions(prompt, params = {})
-      # Set default parameters
-      engine = params[:engine] || 'text-davinci-002'
-      max_tokens = params[:max_tokens] || 16
-      temperature = params[:temperature] || 0.5
-      top_p = params[:top_p] || 1.0
-      n = params[:n] || 1
-
-      # Construct the URL for the completion request
+      engine = params[:engine] || @config.default_engine
       url = "#{@endpoint}/engines/#{engine}/completions"
-      
-      # Prepare the data for the request
-      data = {
+
+      data = @config.default_parameters.merge(
         prompt: prompt,
-        max_tokens: max_tokens,
-        temperature: temperature,
-        top_p: top_p,
-        n: n
-      }
-      
-      # Make the request to the API
+        max_tokens: params[:max_tokens],
+        temperature: params[:temperature],
+        top_p: params[:top_p],
+        n: params[:n]
+      ).compact
+
       request_api(url, data)
     end
 
-
-    # This method sends a chat message to the API
-    #
-    # @param messages [Array<Hash>] The array of messages for the conversation. 
-    # Each message is a hash with a `role` and `content` key. The `role` key can be 'system', 'user', or 'assistant',
-    # and the `content` key contains the text of the message.
-    #
-    # @param params [Hash] Optional parameters for the chat request. This can include the 'model' key to specify 
-    # the model to be used for the chat. If no 'model' key is provided, 'gpt-3.5-turbo' is used by default.
-    #
-    # @return [Hash] The response from the API.
     def chat(messages, params = {})
-      # Set default parameters
-      model = params[:model] || 'gpt-3.5-turbo'
-
-      # Construct the URL for the chat request
       url = "#{@endpoint}/chat/completions"
 
-      # Prepare the data for the request. The data is a hash with 'model' and 'messages' keys.
-      data = {
-        model: model,
-        messages: messages
-      }
-      
-      # Make the API request and return the response.
+      data = @config.default_parameters.merge(
+        model: params[:model] || 'gpt-3.5-turbo',
+        messages: messages,
+        temperature: params[:temperature],
+        top_p: params[:top_p],
+        n: params[:n],
+        stream: params[:stream] || false
+      ).compact
+
       request_api(url, data)
     end
 
+    def chat_stream(messages, params = {}, &block)
+      raise ArgumentError, 'Block is required for streaming' unless block_given?
+
+      url = "#{@endpoint}/chat/completions"
+      data = @config.default_parameters.merge(
+        model: params[:model] || 'gpt-3.5-turbo',
+        messages: messages,
+        stream: true
+      ).compact
+
+      request_streaming(url, data, &block)
+    end
 
     private
-    # Make a request to the API
-    #
-    # @param url [String] The URL for the request
-    # @param data [Hash] The data to be sent in the request
-    # @param method [Symbol] The HTTP method for the request (:post by default)
-    #
-    # @return [Hash] The response from the API
-    #
-    # @raise [RestClient::ExceptionWithResponse] If the API request fails
-    def request_api(url, data, method = :post)
-      begin
-        # Execute the request
-        response = RestClient::Request.execute(method: method, url: url, payload: data.to_json, headers: headers)
-        
-        # Parse and return the response body
-        JSON.parse(response.body)
-      rescue RestClient::ExceptionWithResponse => e
-        # Parse the error message from the API response
-        error_msg = JSON.parse(e.response.body)['error']['message']
-        
-        # Raise an exception with the API error message
-        raise RestClient::ExceptionWithResponse.new("#{e.message}: #{error_msg} (#{e.http_code})"), nil, e.backtrace
+
+    def request_api(url, data)
+      response = RestClient::Request.execute(
+        method: :post,
+        url: url,
+        payload: data.to_json,
+        headers: {
+          'Authorization' => "Bearer #{@api_key}",
+          'Content-Type' => 'application/json'
+        },
+        timeout: @config.request_timeout
+      )
+      JSON.parse(response.body)
+    rescue RestClient::ExceptionWithResponse => e
+      handle_error(e)
+    end
+
+    def handle_error(error)
+      error_response = JSON.parse(error.response.body)
+      error_message = error_response['error']['message']
+      status_code = error.response.code
+
+      case status_code
+      when 401
+        raise ChatGPT::AuthenticationError.new(error_message, status_code)
+      when 429
+        raise ChatGPT::RateLimitError.new(error_message, status_code)
+      when 400
+        raise ChatGPT::InvalidRequestError.new(error_message, status_code)
+      else
+        raise ChatGPT::APIError.new(error_message, status_code)
+      end
+    end
+
+    def request_streaming(url, data)
+      RestClient::Request.execute(  # Remove the response = assignment
+        method: :post,
+        url: url,
+        payload: data.to_json,
+        headers: {
+          'Authorization' => "Bearer #{@api_key}",
+          'Content-Type' => 'application/json'
+        },
+        timeout: @config.request_timeout,
+        stream_to_buffer: true
+      ) do |chunk, _x, _z|
+        if chunk.include?('data: ')
+          chunk.split("\n").each do |line|
+            next unless line.start_with?('data: ')
+
+            data = line.sub(/^data: /, '')
+            next if data.strip == '[DONE]'
+
+            begin
+              parsed = JSON.parse(data)
+              yield parsed if block_given?
+            rescue JSON::ParserError
+              next
+            end
+          end
+        end
       end
+    rescue RestClient::ExceptionWithResponse => e
+      handle_error(e)
     end
-  
   end
 end

data/lib/chatgpt/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# lib/chatgpt/configuration.rb
+module ChatGPT
+  class Configuration
+    attr_accessor :api_key, :api_version, :default_engine,
+                  :request_timeout, :max_retries, :default_parameters
+
+    def initialize
+      @api_version = 'v1'
+      @default_engine = 'text-davinci-002'
+      @request_timeout = 30
+      @max_retries = 3
+      @default_parameters = {
+        max_tokens: 16,
+        temperature: 0.5,
+        top_p: 1.0,
+        n: 1
+      }
+    end
+  end
+end

data/lib/chatgpt/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# lib/chatgpt/errors.rb
+module ChatGPT
+  class Error < StandardError; end
+
+  class APIError < Error
+    attr_reader :status_code, :error_type
+
+    def initialize(message = nil, status_code = nil, error_type = nil)
+      @status_code = status_code
+      @error_type = error_type
+      super(message)
+    end
+  end
+
+  class AuthenticationError < APIError; end
+  class RateLimitError < APIError; end
+  class InvalidRequestError < APIError; end
+  class TokenLimitError < APIError; end
+end

data/lib/chatgpt/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# lib/chatgpt/version.rb
+module ChatGPT
+  VERSION = "2.1.0"
+end

data/lib/chatgpt.rb

@@ -0,0 +1,23 @@
+# lib/chatgpt.rb
+# frozen_string_literal: true
+
+require_relative 'chatgpt/version'
+require_relative 'chatgpt/errors'
+require_relative 'chatgpt/configuration'
+require_relative 'chatgpt/client'
+
+module ChatGPT
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -1,57 +1,163 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-08 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: This gem provides a Ruby SDK for interacting with the OpenAI API, including
-  methods for generating text, completing prompts, and more.
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: A Ruby SDK for OpenAI's ChatGPT API
 email:
 - nagendra.dhanakeerthi@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".rubocop.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
+- lib/chatgpt.rb
 - lib/chatgpt/client.rb
-- lib/chatgpt/ruby.rb
-- lib/chatgpt/ruby/version.rb
-- sig/chatgpt/ruby.rbs
-homepage: https://github.com/nagstler/chatgpt-ruby.git
+- lib/chatgpt/configuration.rb
+- lib/chatgpt/errors.rb
+- lib/chatgpt/version.rb
+homepage: https://github.com/nagstler/chatgpt-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/nagstler/chatgpt-ruby.git
-  source_code_uri: https://github.com/nagstler/chatgpt-ruby.git
+  homepage_uri: https://github.com/nagstler/chatgpt-ruby
+  source_code_uri: https://github.com/nagstler/chatgpt-ruby
   changelog_uri: https://github.com/nagstler/chatgpt-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -60,15 +166,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: A Ruby SDK for the OpenAI API
+summary: Ruby client for OpenAI's ChatGPT API
 test_files: []

data/.codeclimate.yml

@@ -1,8 +0,0 @@
-version: "2"
-checks:
-  rubocop:
-    enabled: true
-    channel: "stable"
-plugins:
-  test-reporter:
-    enabled: true

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/CHANGELOG.md

@@ -1,19 +0,0 @@
-## [2.0.0] - 2023-07-08
-
-### Added
-
-- Added support for chat interactions with the GPT-3.5-turbo model.
-- Introduced a new `chat` method to the `ChatGPT::Client` class, which sends an array of chat messages to the API and receives the generated messages in return.
-- Updated the README to provide usage instructions for the new `chat` method.
-
-## [1.0.0] - 2023-04-30
-
-### Added
-
-- Initial release of the `chatgpt-ruby` gem.
-- Implements ChatGPT Client with methods for completions, search, classification, summary, and answer generation.
-- Includes unit tests for each method.
-
-## [0.1.0] - 2023-03-22
-
-- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# 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 nagendra.dhanakeerthi@gmail.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/Gemfile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in chatgpt-ruby.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-
-gem "rubocop", "~> 1.21"
-
-gem 'rest-client'
-
-group :test do
-    gem 'simplecov', require: false
-    gem 'simplecov_json_formatter', require: false
-end
-  
-  

data/Gemfile.lock

@@ -1,72 +0,0 @@
-PATH
-  remote: .
-  specs:
-    chatgpt-ruby (1.0.0)
-      rest-client
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    http-accept (1.7.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
-    json (2.6.3)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.0218.1)
-    minitest (5.18.0)
-    netrc (0.11.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rexml (3.2.5)
-    rubocop (1.48.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.26.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  arm64-darwin-21
-
-DEPENDENCIES
-  chatgpt-ruby!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  rest-client
-  rubocop (~> 1.21)
-  simplecov
-  simplecov_json_formatter
-
-BUNDLED WITH
-   2.3.26

data/Rakefile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.pattern = 'test/**/*_test.rb'
-  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/chatgpt/ruby/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Chatgpt
-  module Ruby
-    VERSION = "2.0.0"
-  end
-end

data/lib/chatgpt/ruby.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "ruby/version"
-
-module Chatgpt
-  module Ruby
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end

data/sig/chatgpt/ruby.rbs

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