chatgpt-ruby 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa91296be7cab7d9f1f5f1b2b6e55fa784c4a8760fabebbaac3cf903268da1d
-  data.tar.gz: cd8a13397002dec2a38da0ad766ce3b9301ca3d6bc5efa2669b30851d3ebc4ca
+  metadata.gz: 6a246b757af45ec2b58fd7fad4cda501d6408f273f62c697705a4b85b824c07e
+  data.tar.gz: b314a13e482bf33e88d2dd7adec626850612cb1da247ed0a247492dc40bd09af
 SHA512:
-  metadata.gz: adf9e9cdc0e6b3e834d86e388b2c6319a42292c302333cc4a039817c9b4136e1394e00dff859c9f2359674728bf550171a22d64387089accdf48aed2d023658f
-  data.tar.gz: f1d0932b4ad810440543fa9b538a52190f6355ef892356519373748eb002f94a4d3de35f234fbd120c0bcd959b1f609fd6f35bbd27cd2125009a0b84e11dd8bd
+  metadata.gz: 2cd02878303337251add7d71e82bd9d29504313217dfeb6bcc2228a9d61f14abe0306523e55374465d431e65f438106b8054936b22d9d2a6de9aaa7b1d1e8a29
+  data.tar.gz: b30e1470736ccfd7ebd26c380792eb1759707bb630bbb3d4ad2dc446968d6e414c3ace6ac3164e7681ff57f07445a50d9025e72b5c497f77e6b3de949a537b79

data/.codeclimate.yml

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

data/Gemfile

@@ -11,4 +11,11 @@ gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
 
-gem 'rest-client'
+gem 'rest-client'
+
+group :test do
+    gem 'simplecov', require: false
+    gem 'simplecov_json_formatter', require: false
+end
+  
+  

data/Gemfile.lock

@@ -8,6 +8,7 @@ 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)
@@ -44,6 +45,12 @@ GEM
     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)
@@ -58,6 +65,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rest-client
   rubocop (~> 1.21)
+  simplecov
+  simplecov_json_formatter
 
 BUNDLED WITH
    2.3.26

data/README.md

@@ -1,6 +1,8 @@
-# ChatGPTRuby
+# ChatGPT Ruby
 
-The `chatgpt-ruby` is a Ruby SDK for the OpenAI API, including methods for generating text, completing prompts, and more.
+[![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, including methods for generating text, completing prompts, and more ❤️
 
 ## Installation
 
@@ -33,7 +35,7 @@ To use the ChatGPT API SDK, you will need an API key from OpenAI. You can obtain
 Once you have an API key, you can create a new `ChatGPT::Client` instance with your API key:
 
 ```ruby
-require 'chatgpt_api'
+require 'chatgpt/client'
 
 api_key = 'your-api-key'
 client = ChatGPT::Client.new(api_key)
@@ -161,11 +163,11 @@ answer = client.generate_answers(prompt, documents)
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
+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).
 
 ## License
 
@@ -173,4 +175,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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/[USERNAME]/chatgpt-ruby/blob/main/CODE_OF_CONDUCT.md).
+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).

data/Rakefile

@@ -3,8 +3,10 @@
 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
@@ -14,3 +16,4 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]
+

data/lib/chatgpt/client.rb

@@ -10,6 +10,15 @@ module ChatGPT
       @endpoint = 'https://api.openai.com/v1'
     end
 
+    # Helper method to prepare headers
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{@api_key}"
+      }
+    end
+
+    # Completion-related methods
     def completions(prompt, params = {})
       engine = params[:engine] || 'text-davinci-002'
       max_tokens = params[:max_tokens] || 16
@@ -18,10 +27,6 @@ module ChatGPT
       n = params[:n] || 1
 
       url = "#{@endpoint}/engines/#{engine}/completions"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
       data = {
         prompt: prompt,
         max_tokens: max_tokens,
@@ -29,44 +34,38 @@ module ChatGPT
         top_p: top_p,
         n: n
       }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)
+      request_api(url, data)
     end
 
+    # Search-related methods
     def search(documents, query, params = {})
       engine = params[:engine] || 'ada'
       max_rerank = params[:max_rerank] || 200
 
       url = "#{@endpoint}/engines/#{engine}/search"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
       data = {
         documents: documents,
         query: query,
         max_rerank: max_rerank
       }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['data']
+      response = request_api(url, data)
+      response['data']
     end
 
+    # Classification-related methods
     def classify(text, params = {})
       model = params[:model] || 'text-davinci-002'
 
       url = "#{@endpoint}/classifications/#{model}"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
       data = {
         model: model,
         input: text
       }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['data'][0]['label']
+      response = request_api(url, data)
+      response['data'][0]['label']
     end
 
+    # Summary-related methods
     def generate_summaries(documents, params = {})
       model = params[:model] || 'text-davinci-002'
       max_tokens = params[:max_tokens] || 60
@@ -76,10 +75,6 @@ module ChatGPT
       presence_penalty = params[:presence_penalty] || 0.0
 
       url = "#{@endpoint}/engines/#{model}/generate"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
       data = {
         prompt: '',
         max_tokens: max_tokens,
@@ -89,26 +84,36 @@ module ChatGPT
         presence_penalty: presence_penalty,
         documents: documents
       }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['choices'][0]['text']
+      response = request_api(url, data)
+      response['choices'][0]['text']
     end
 
+    # Answer-generation-related methods
     def generate_answers(prompt, documents, params = {})
       model = params[:model] || 'text-davinci-002'
       max_tokens = params[:max_tokens] || 5
 
       url = "#{@endpoint}/engines/#{model}/answers"
-      headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{@api_key}"
-      }
       data = {
         prompt: prompt,
         documents: documents,
         max_tokens: max_tokens
       }
-      response = RestClient.post(url, data.to_json, headers)
-      JSON.parse(response.body)['data'][0]['answer']
+      response = request_api(url, data)
+      response['data'][0]['answer']
+    end
+
+    private
+
+    # Helper method to make API requests
+    def request_api(url, data)
+      begin
+        response = RestClient.post(url, data.to_json, headers)
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        error_msg = JSON.parse(e.response.body)['error']['message']
+        raise RestClient::ExceptionWithResponse.new("#{e.message}: #{error_msg} (#{e.http_code})"), nil, e.backtrace
+      end
     end
   end
 end

data/lib/chatgpt/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module Chatgpt
   module Ruby
-    VERSION = "0.6.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nagendra Dhanakeerthi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md