chatgpt-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca17c95688832308817de8b5b620a4ac0d0a2f3a0899ad611dc897fef95b8b3c
-  data.tar.gz: d6e9c97daa3e6ed5c393b9aafdee36b40493e04d1ec1da2f3371e791a6d0d19d
+  metadata.gz: 94d035b49642b3f0c7ca90ef2443711f8b50007bde2ab538cb27a79db6d2198e
+  data.tar.gz: 6013d9bf6c37d54da4c1b9c4686b2576605d394db5881c5d6db4b64ff3223bfa
 SHA512:
-  metadata.gz: b36305d061100c22443212a342414237f6a12ce2ebba2a7b13534b0e00941ce76eb59ea37438cab29b08fac00ebecc6238dfbd2b723d7064dcb32e3b9b400c6f
-  data.tar.gz: 0f53b700e3b9daeabb43a27690c488db5ad11638a1854dc31d14381c4765a7abc91ff3de688527a2cec4bb6732068a34ff24f81a08b024e6ec02e5b1dc6aabf7
+  metadata.gz: fc802fd52f248b26f40352188b5f8876ffedba0dde39fa8a09655cf9716e50dc3f43c4ee1021187ad146aee5612f59411afa66cfd14eb254c69470b4f25b21b7
+  data.tar.gz: 596422eebcc85c58b2c8800c0ddfdb5d00d1397f67c530f3c732523483dfbf90c88e0eeb420becf325a073f8801dc3dd7a390ce7b726b65dabeb009a3f09ab2c

data/Gemfile

@@ -10,5 +10,3 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
-
-gem "httparty", "~> 0.21.0"

data/Gemfile.lock

@@ -2,19 +2,13 @@ PATH
   remote: .
   specs:
     chatgpt-ruby (0.1.0)
-      httparty (~> 0.18)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
     json (2.6.3)
-    mini_mime (1.1.2)
     minitest (5.18.0)
-    multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.2.1.1)
       ast (~> 2.4.1)
@@ -42,7 +36,6 @@ PLATFORMS
 
 DEPENDENCIES
   chatgpt-ruby!
-  httparty (~> 0.21.0)
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)

data/README.md

@@ -1,22 +1,46 @@
-# Chatgpt::Ruby
+# ChatGPTRuby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chatgpt/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+The `chatgpt-ruby` gem is a simple Ruby SDK for accessing the OpenAI ChatGPT API. This client makes it easy to integrate the ChatGPT API into your Ruby applications.
 
-TODO: Delete this and the text above, and describe your gem
+### Bundler
 
-## Installation
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem "chatgpt-ruby"
+```
 
-    $ bundle add chatgpt-ruby
+And then execute:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+$ bundle install
 
-    $ gem install chatgpt-ruby
+### Gem install
+
+Or install with:
+
+$ gem install chatgpt-ruby
 
 ## Usage
 
-TODO: Write usage instructions here
+To use the gem in a Ruby script or application, simply require it and initialize the client:
+```ruby
+require 'chatgpt_client'
+
+client = ChatGPTClient::Client.new('your_api_key')
+response = client.chat('Please translate the following English text to French: "Hello, how are you?"')
+puts response
+```
+
+Replace 'your_api_key' with your actual ChatGPT API key.
+
+### Parameters
+
+The `chat` method accepts a mandatory `prompt` parameter and an optional `options` parameter.
+
+The `prompt` parameter is a string representing the input you want to send to the ChatGPT API.
+
+The `options` parameter is a hash that can include the following keys: 
+- `max_tokens`: The maximum number of tokens
 
 ## Development
 

data/lib/chatgpt/client.rb

@@ -0,0 +1,45 @@
+# chatgpt_client.rb
+require 'httparty'
+require 'json'
+
+module ChatGPTRuby
+  class Client
+    include HTTParty
+    base_uri 'https://api.openai.com/v1'
+
+    def initialize(api_key)
+      @api_key = api_key
+      @headers = {
+        'Authorization' => "Bearer #{@api_key}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    # Methods to interact with the API
+    def generate(prompt, options = {})
+      body = {
+        'prompt' => prompt,
+        'max_tokens' => options.fetch(:max_tokens, 100),
+        'n' => options.fetch(:n, 1),
+        'stop' => options.fetch(:stop, nil),
+        'temperature' => options.fetch(:temperature, 1.0),
+        'top_p' => options.fetch(:top_p, 1.0),
+        'frequency_penalty' => options.fetch(:frequency_penalty, 0.0),
+        'presence_penalty' => options.fetch(:presence_penalty, 0.0),
+      }.to_json
+
+      response = self.class.post('/davinci-codex/completions', headers: @headers, body: body)
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      if response.code == 200
+        JSON.parse(response.body)
+      else
+        raise "Error: #{response.code} - #{response.message}"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
@@ -9,22 +9,8 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2023-03-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-description: Write a longer description or delete this line. [WIP]
+dependencies: []
+description: Write a longer description or delete this line.
 email:
 - nagendra.dhanakeerthi@gmail.com
 executables: []
@@ -39,16 +25,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- 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
+homepage:
 licenses:
 - MIT
-metadata:
-  homepage_uri: https://github.com/nagstler/chatgpt-ruby.git
-  source_code_uri: https://github.com/nagstler/chatgpt-ruby.git
-  changelog_uri: https://github.com/nagstler/chatgpt-ruby/blob/main/CHANGELOG.md
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -67,5 +51,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one. [WIP]
+summary: Write a short summary, because RubyGems requires one.
 test_files: []