pleasegpt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3fe6ac1bdc94405d7be4ae85189cc4f7b55e4d0ebb8805b64848aa4ad457b57
+  data.tar.gz: 8454842d82d428d31e5c9de69ef3dabcefc471c6222063d865b701f72b2c941e
+SHA512:
+  metadata.gz: c06a7d1921370d80d3a63ac34ea8bb9c5f1d21aa2c4e9368fb388e5074c809fa7b592bb4f2eec4f1e02e86a431a4ae87bc98f0f761439aa49cbc73df8350ca52
+  data.tar.gz: ac5ec1c168ec08883c5c44a424058e1ab94e5b57adcd111fd9ce1e97a95804904fc2756b12d14f80f03c69eb1b11096c21044e267718af0d41a3d01ad25a9307

data/bin/pleasegpt

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pleasegpt'
+require 'pleasegpt/cli'
+require 'openai'
+
+case ARGV[0]
+when 'load-key'
+  PleaseGPT::Api.load_api_key
+when 'help'
+  puts <<-HELP
+PleaseGPT - A command-line tool for OpenAI's GPT-3 API
+
+Usage:
+  pleasegpt [input]           # Generate text based on input
+  pleasegpt load-key          # Save OpenAI API key
+  pleasegpt help              # Show this help message
+  HELP
+else
+  PleaseGPT::CLI.new.start(ARGV)
+end

data/lib/pleasegpt/cli.rb

@@ -0,0 +1,16 @@
+require 'pleasegpt'
+require 'colorize'
+
+module PleaseGPT
+  # CLI class for the command-line tool interface
+  class CLI
+    def start(args)
+      if args.empty?
+        puts '>>> Please enter a valid command <<<'
+      else
+        input = args.join(' ')
+        puts Api.generate_text(input).to_s.colorize(:green)
+      end
+    end
+  end
+end

data/lib/pleasegpt.rb

@@ -0,0 +1,76 @@
+require 'ruby/openai'
+require 'openai'
+require 'highline/import'
+require 'dotenv/load'
+require 'dotenv'
+
+# Main module for PleaseGPT gem
+module PleaseGPT
+  autoload :CLI, 'pleasegpt/cli'
+
+  # API class for OpenAI API requests and responses
+  module Api
+    def self.load_api_key
+      key = ask('Please paste your OpenAI API key:  ')
+      if key.nil? || key.empty?
+        puts 'API Key cannot be empty. Please try again.'
+      else
+        save_api_key(key)
+        puts 'API key saved to file'
+        env_variable(key)
+      end
+    end
+
+    def self.gem_dir
+      File.expand_path('..', __dir__)
+    end
+
+    def self.join_lib_dir_with_file
+      File.join(gem_dir, 'lib', '.openai')
+    end
+
+    def self.save_api_key(key)
+      File.write(join_lib_dir_with_file, "OPENAI_API_KEY=#{key}")
+    end
+
+    def self.env_variable(key)
+      File.open(join_lib_dir_with_file, 'w') do |f|
+        f.puts "OPENAI_API_KEY=#{key}"
+      end
+    end
+
+    def self.openai_client
+      Dotenv.load(join_lib_dir_with_file)
+      raise 'OPENAI_API_KEY not set' unless ENV['OPENAI_API_KEY']
+
+      OpenAI::Client.new(access_token: ENV['OPENAI_API_KEY'])
+    end
+
+    def self.generate_text(input)
+      response = openai_client.completions(
+        parameters: {
+          model: 'text-davinci-003',
+          prompt: input,
+          max_tokens: 300,
+          temperature: 0.5,
+          n: 1,
+          stop: '.'
+        }
+      )
+      Error.check_response(response)
+    end
+  end
+
+  # Error class for OpenAI API requests and response errors
+  class Error < StandardError
+    def self.check_response(response)
+      if response['choices'].nil? || response['choices'].empty?
+        raise PleaseGPT::Error, 'Request returned empty response'
+      elsif response['choices'][0]['text'].nil?
+        raise PleaseGPT::Error, 'Request returned nil text'
+      else
+        response['choices'][0]['text'].strip
+      end
+    end
+  end
+end

data/spec/bin/pleasegpt_test.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe "pleasegpt executable" do
+  it "runs with the given arguments" do
+    expect { system('bin/pleasegpt what is the capital of France?') }
+      .to output(/\S/).to_stdout
+      .and output(String).to_stdout
+  end
+end

data/spec/lib/cli_test.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'pleasegpt/cli'
+require 'colorize'
+
+RSpec.describe PleaseGPT::CLI do
+  describe "#start" do
+    context "when given a valid command receives a response in blue" do
+      let(:args) { ["how much is 2+2?"] }
+
+      before do
+        allow(PleaseGPT::Api).to receive(:generate_text).with(args.join(' ')) do
+          'The answer is 4.'
+        end
+      end
+
+      it "returns a non-empty response from the OpenAI API with blue colour" do
+        expect { subject.start(args) }.to output(/.*\n/).to_stdout
+        expect { subject.start(args) }.to output(/\S/).to_stdout
+        expect { subject.start(args) }.to output(/\e\[0;34;49m.*\e\[0m\n/).to_stdout
+      end
+    end
+  end
+end

data/spec/lib/pleasegpt_test.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'pleasegpt'
+
+RSpec.describe PleaseGPT::Api do
+  describe '#generate_text' do
+    let(:input) { 'Some prompt for GPT' }
+    let(:response_text) { 'Generated text' }
+
+    before do
+      allow_any_instance_of(OpenAI::Client)
+        .to receive(:completions)
+        .and_return('choices' => [{ 'text' => response_text }])
+    end
+
+    it 'returns a non-empty response' do
+      response = PleaseGPT::Api.generate_text(input)
+      expect(response).not_to be_empty
+      expect(response).to eq(response_text)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'pleasegpt'
+require 'dotenv/load'
+
+unless ENV['OPENAI_API_KEY']
+  # Prompt the user to enter their API key
+  puts 'Please enter your OpenAI API key: '
+  api_key = gets.chomp
+
+  # Set the environment variable for the current process
+  ENV['OPENAI_API_KEY'] = api_key
+end
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: pleasegpt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael Moreira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description:
+email:
+- rafamsilva@gmail.com
+executables:
+- pleasegpt
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/pleasegpt
+- lib/pleasegpt.rb
+- lib/pleasegpt/cli.rb
+- spec/bin/pleasegpt_test.rb
+- spec/lib/cli_test.rb
+- spec/lib/pleasegpt_test.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rafaover/pleasegpt
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A simple wrapper around the OpenAI GPT-3 API
+test_files: []