ruby-gpt-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 987ea9cc94c099a4adc7c2b2bc497897b85cd0b90f31fc099abf7114c7aaced5
+  data.tar.gz: fc51db3d3114c685024eeb6e3a143dadbe615d1efce5801330315542581340d9
+SHA512:
+  metadata.gz: b963d76d4c8fdbd268f2ab45a845c910bcd554a6606b9a90a89d7c921fba11b6388e4dcb19b273a57457697039fdcf19ea194d56b4a2f1ce8ce471aa49d37b4d
+  data.tar.gz: d95e48c42094cef5f621c9d37d3e9ff4e93de9a229196bc216611029af463f58abdeef8a71fdf5072d87f833e67ef97986cd0367288b20b67937c6aa15443ad0

data/lib/ruby_gpt/client.rb

@@ -0,0 +1,44 @@
+require_relative 'fetcher'
+
+module RubyGPT
+  # The `RubyGPT::Client` class provides a simple interface for interacting
+  # with ChatGPT models. This class is initialized with an API key and
+  # includes methods to interact with the ChatGPT API.
+  class Client
+    OPEN_AI_COMPLETIONS_URL = 'https://api.openai.com/v1/chat/completions'.freeze
+    DEFAULT_MODEL = 'gpt-3.5-turbo'.freeze
+    DEFAULT_TEMPERATURE = 0.7
+
+    def initialize(api_key:)
+      raise ArgumentError, "The 'api_key' argument is required" unless api_key
+
+      @headers = Headers.new(api_key: api_key)
+      @fetcher = Fetcher.new
+    end
+
+    def completions(messages:, model: DEFAULT_MODEL, temperature: DEFAULT_TEMPERATURE)
+      validate_messages(messages)
+
+      body = {
+        messages: messages.map(&:to_h),
+        model: model,
+        temperature: temperature
+      }
+
+      @fetcher.post(OPEN_AI_COMPLETIONS_URL, @headers.get, body)
+    end
+
+    private
+
+    def validate_messages(messages)
+      if messages.nil? || messages.empty?
+        raise ArgumentError,
+              "The 'messages' parameter is required"
+      end
+
+      return if messages.all? { |message| message.is_a?(RubyGPT::Message) }
+
+      raise ArgumentError, 'All messages must be instances of RubyGPT::Message'
+    end
+  end
+end

data/lib/ruby_gpt/fetcher.rb

@@ -0,0 +1,45 @@
+require 'http'
+require_relative 'headers'
+
+module RubyGPT
+  # Fetcher is a private class responsible for handling the actual
+  # data retrieval process from the API.
+  class Fetcher
+    def post(endpoint, headers, body)
+      response = make_post_request(endpoint, headers, body)
+      parse_response(response)
+    end
+
+    private
+
+    def make_post_request(endpoint, headers, body)
+      HTTP.headers(headers).post(endpoint, json: body)
+    end
+
+    def parse_response(response)
+      parsed_body = JSON.parse(response.body)
+
+      if response.code.to_i >= 400 || parsed_body['error']
+        error_message = parsed_body['error'] ? parsed_body['error']['message'] : "HTTP Error: #{response.code}"
+        raise StandardError, error_message
+      end
+
+      parse_choices(parsed_body)
+    end
+
+    # Convert messages from the response into RubyGPT::Message instances
+    def parse_choices(body_json)
+      return body_json unless body_json.dig('choices', 0, 'message')
+
+      body_json['choices'].map! do |choice|
+        message = choice['message']
+        choice['message'] = RubyGPT::Message.new(role: message['role'], content: message['content'])
+        choice
+      end
+
+      body_json
+    end
+  end
+
+  private_constant :Fetcher
+end

data/lib/ruby_gpt/headers.rb

@@ -0,0 +1,18 @@
+module RubyGPT
+  # Headers is a private class responsible for generating HTTP request
+  # headers required for API requests.
+  class Headers
+    def initialize(api_key:)
+      @headers = {
+        'Authorization' => "Bearer #{api_key}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def get
+      @headers
+    end
+  end
+
+  private_constant :Headers
+end

data/lib/ruby_gpt/message.rb

@@ -0,0 +1,34 @@
+module RubyGPT
+  # The `RubyGPT::Message` class provides a simple interface for creating message objects [TODO].
+  class Message
+    VALID_ROLES = %w[user assistant system].freeze
+
+    attr_reader :role, :content
+
+    def initialize(role:, content:)
+      validate_role(role)
+      validate_content(content)
+
+      @role = role
+      @content = content
+    end
+
+    def to_h
+      { role: @role, content: @content }
+    end
+
+    private
+
+    def validate_role(role)
+      return if VALID_ROLES.include?(role)
+
+      raise ArgumentError, "Invalid role: #{role}. Valid roles are: #{VALID_ROLES.join(', ')}"
+    end
+
+    def validate_content(content)
+      return unless content.nil? || content.strip.empty?
+
+      raise ArgumentError, 'Content cannot be empty.'
+    end
+  end
+end

data/lib/ruby_gpt.rb

@@ -0,0 +1,3 @@
+require_relative 'ruby_gpt/version'
+require_relative 'ruby_gpt/client'
+require_relative 'ruby_gpt/message'

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: ruby-gpt-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- energywraith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-20 00:00:00.000000000 Z
+dependencies: []
+description: ChatGPT client written in Ruby.
+email: energywraith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ruby_gpt.rb
+- lib/ruby_gpt/client.rb
+- lib/ruby_gpt/fetcher.rb
+- lib/ruby_gpt/headers.rb
+- lib/ruby_gpt/message.rb
+homepage: https://github.com/energywraith/ruby-gpt
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ruby GPT Client - ChatGPT client written in Ruby
+test_files: []