chatgpt-ruby-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1442e13bb715ee366d5e090aa300f6030ba778ecd77555858c684e324d1a9c3c
+  data.tar.gz: ff99251132a3935c7b4ccd59e6b71359f661f34f8ffb3e47f45c1731689096cf
+SHA512:
+  metadata.gz: bab0eec5177b3cf83b2a8596e50799d8ea9f88e140c14222c3909b257a6d8c7f06d4f3447ea7f5c3f5bc0eac971f421eee0e72aa07a671e12cca4aae8a9d3623
+  data.tar.gz: 6e6321dbf6793abff3796f8949b327086cf02e018dcec4866523ff8621b52408ec1e5ae07d7dd8c277c3a2834f76399decaf22c3fe016f21bd0c3fb8f806ccc0

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.1.0] - 2025-03-22
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sanekhire
+
+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,97 @@
+# ChatGPT Client
+
+ChatGPT Client – это Ruby-гем, предназначенный для взаимодействия с API OpenAI. Позволяет отправлять запросы к модели ChatGPT и получать ответы, поддерживает использование прокси-серверов.
+
+## Установка
+
+Добавьте в `Gemfile` вашего проекта:
+
+`gem 'chatgpt-ruby-client'`
+
+Затем выполните команду:
+
+`bundle install`
+
+Или установите вручную:
+
+`gem install chatgpt-ruby-client`
+
+## Использование
+
+### Инициализация клиента
+
+```ruby
+require 'chatgpt-ruby-client'
+
+api_key = 'your_openai_api_key'
+client = Chatgpt::Client.new(api_key)
+```
+
+### Отправка запроса
+
+```ruby
+response = client.send_request("Напиши короткое стихотворение")
+puts response.dig('choices', 0, 'message', 'content')
+```
+
+### Настройка параметров
+
+Вы можете настроить различные параметры клиента:
+
+```ruby
+Chatgpt::Client.model = "gpt-4"
+Chatgpt::Client.temperature = 0.5
+Chatgpt::Client.system_message = "Ты – эксперт по программированию."
+Chatgpt::Client.prompt_prefix = "Перефразируй: "
+Chatgpt::Client.proxy = "socks5://user:password@proxyserver:1080"
+```
+
+### Использование прокси
+
+Вы можете передавать прокси в методе `send_request:`
+
+```ruby
+response = client.send_request("Как работает Ruby?", "<http://proxyserver:8080>")
+puts response.dig('choices', 0, 'message', 'content')
+```
+
+## Как это работает
+
+### Класс `Chatgpt::Client`
+
+Этот класс отвечает за создание запросов к API OpenAI. Он управляет настройками модели, заголовками и обработкой ответов.
+
+### Основные методы
+
+* `initialize(api_key)` – создаёт клиент с API-ключом.
+
+* `send_request(prompt, proxy = nil)` – отправляет запрос к ChatGPT.
+
+* `build_request_data(prompt)` – формирует данные для запроса.
+
+* `request_headers` – задаёт заголовки HTTP-запроса.
+
+* `parse_response(response)` – обрабатывает ответ API.
+
+### Класс `Chatgpt::ApiRequest`
+
+Этот класс отвечает за выполнение HTTP-запросов с использованием библиотеки `curb`.
+Основные методы:
+
+* `initialize(url:, data:, headers:, proxy: nil)` – принимает параметры запроса.
+
+* `post` – выполняет POST-запрос к API OpenAI.
+
+* `configure_proxy(curl, proxy)` – настраивает прокси-сервер, если он указан.
+
+### Ошибки и обработка
+
+Если при выполнении запроса возникает ошибка, она возвращается в виде хэша:
+
+```ruby
+{ "error" => "Описание ошибки" }
+```
+
+### Лицензия
+
+Этот проект распространяется под лицензией MIT.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/chatgpt/api_request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "curb"
+require "json"
+
+module Chatgpt
+  # Класс для выполнения HTTP-запросов к API OpenAI
+  class ApiRequest
+    attr_reader :url, :headers, :data, :proxy
+
+    # @param url [String] URL, к которому будет выполняться запрос
+    # @param data [String] Данные запроса в формате JSON
+    # @param headers [Hash] HTTP-заголовки запроса
+    # @param proxy [String, nil] Опциональный параметр для прокси-сервера
+    def initialize(url:, data:, headers:, proxy: nil)
+      @url = url
+      @headers = headers
+      @data = data
+      @proxy = proxy
+    end
+
+    # Выполняет POST-запрос к API
+    # @return [Curl::Easy, Hash] Ответ сервера или ошибка в виде хэша
+    def post
+      Curl::Easy.http_post(url, data) do |curl|
+        headers.each { |key, value| curl.headers[key] = value }
+        configure_proxy(curl, proxy) if proxy
+      end
+    rescue StandardError => e
+      { "error" => "Ошибка запроса: #{e.message}" }
+    end
+
+    private
+
+    # Конфигурирует параметры прокси-сервера для запроса
+    # @param curl [Curl::Easy] Объект запроса
+    # @param proxy [String] URL прокси в формате <protocol>://<login>:<password>@<host>:<port>
+    def configure_proxy(curl, proxy)
+      proxy_type, rest = proxy.split('://', 2)
+
+      if rest.include?('@')
+        user_pass, host = rest.split('@', 2)
+        curl.proxypwd = user_pass # Логин и пароль для прокси
+      else
+        host = rest # Только хост
+      end
+
+      curl.proxy_url = "#{proxy_type}://#{host}"
+
+      curl.proxy_type = case proxy_type
+                        when "socks5"
+                          Curl::CURLPROXY_SOCKS5
+                        when "http"
+                          Curl::CURLPROXY_HTTP
+                        when "https"
+                          curl.proxy_tunnel = true # HTTPS-прокси требует туннеля
+                          Curl::CURLPROXY_HTTPS
+                        else
+                          raise "Неизвестный тип прокси: #{proxy_type}"
+                        end
+    end
+  end
+end

data/lib/chatgpt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Chatgpt
+  VERSION = "0.1.0"
+end

data/lib/chatgpt.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "chatgpt/version"
+require_relative "chatgpt/api_request"
+
+module Chatgpt
+  class Client
+    # URL API, используемый для отправки запросов к ChatGPT
+    API_URL = "https://api.openai.com/v1/chat/completions"
+
+    class << self
+      # Настройки клиента (задаются глобально)
+      # model - Определяет используемую модель, например, "gpt-4o-mini".
+      # temperature - Контролирует степень случайности ответов модели (диапазон 0.0 - 1.0).
+      # system_message - Специальное сообщение, которое задает контекст модели.
+      # prompt_prefix - Префикс для запросов, полезен при массовых однотипных запросах.
+      # proxy - Прокси-сервер, указывается в формате <protocol>://<login>:<password>@<host>:<port>
+      attr_accessor :model, :temperature, :system_message, :prompt_prefix, :proxy
+    end
+
+    # Устанавливаем значения по умолчанию для класса
+    self.model = "gpt-4o-mini"
+    self.temperature = 0.7
+
+    # Конструктор класса
+    # @param api_key [String] API-ключ для аутентификации запросов к OpenAI
+    def initialize(api_key)
+      @chat_api_key = api_key
+      @model = self.class.model
+      @temperature =  self.class.temperature
+      @system_message = self.class.system_message
+      @prompt_prefix = self.class.prompt_prefix
+    end
+
+    # Отправляет запрос в API ChatGPT
+    # @param prompt [String] Текст запроса
+    # @param proxy [String, nil] Опционально: прокси-сервер для запроса
+    # @return [Hash] Ответ API или ошибка
+    def send_request(prompt, proxy = nil)
+      request_data = build_request_data(prompt)
+      response = ApiRequest.new(
+        url: API_URL,
+        headers: request_headers,
+        data: request_data,
+        proxy: proxy || self.class.proxy
+      ).post
+
+      parse_response(response)
+    rescue StandardError => e
+      { "error" => "Ошибка запроса: #{e.message}" }
+    end
+
+    # Формирует тело запроса для API
+    # @param prompt [String] Входной текст
+    # @return [String] JSON-представление данных запроса
+    def build_request_data(prompt)
+      messages = []
+      messages << { role: "user", content: @prompt_prefix.to_s + prompt }
+      messages << { role: "system", content: @system_message } if @system_message
+
+      {
+        "model" => @model,
+        "messages" => messages,
+        "temperature" => @temperature
+      }.to_json
+    end
+
+    # Генерирует заголовки для HTTP-запроса
+    # @return [Hash] Заголовки запроса
+    def request_headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{@chat_api_key}"
+      }
+    end
+
+    # Обрабатывает ответ API
+    # @param response [Object] HTTP-ответ от API
+    # @return [Hash] Распарсенный JSON-ответ или сообщение об ошибке
+    def parse_response(response)
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      { "error" => "Ошибка парсинга JSON" }
+    end
+  end
+end

data/sig/chatgpt.rbs

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: chatgpt-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sanekhire
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: Библиотека для работы с OpenAI API через Curb.
+email:
+- sanchoshire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chatgpt.rb
+- lib/chatgpt/api_request.rb
+- lib/chatgpt/version.rb
+- sig/chatgpt.rbs
+homepage: https://github.com/Sanekhire/chatgpt-ruby-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Sanekhire/chatgpt-ruby-client
+  source_code_uri: https://github.com/Sanekhire/chatgpt-ruby-client
+  changelog_uri: https://github.com/Sanekhire/chatgpt-ruby-client/blob/master/CHANGELOG.md
+  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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: ChatGPT API Client на основе Curb для уникализации текста.
+test_files: []