pleasegpt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3fe6ac1bdc94405d7be4ae85189cc4f7b55e4d0ebb8805b64848aa4ad457b57
-  data.tar.gz: 8454842d82d428d31e5c9de69ef3dabcefc471c6222063d865b701f72b2c941e
+  metadata.gz: 80324ce62390d5faf8471f67c5224454feb99960993e0d596cc5b420e1c57c25
+  data.tar.gz: 8c7aff7f3c3f0b6f4e012da47c1d808c1b2b112a83df4bc7d9981e98b8a8a580
 SHA512:
-  metadata.gz: c06a7d1921370d80d3a63ac34ea8bb9c5f1d21aa2c4e9368fb388e5074c809fa7b592bb4f2eec4f1e02e86a431a4ae87bc98f0f761439aa49cbc73df8350ca52
-  data.tar.gz: ac5ec1c168ec08883c5c44a424058e1ab94e5b57adcd111fd9ce1e97a95804904fc2756b12d14f80f03c69eb1b11096c21044e267718af0d41a3d01ad25a9307
+  metadata.gz: 3216455a7dac511673f8cb1499d1749d56eb3a8c9aaed765136f70a764acdfebf91c8b6b0b13fbcfbbf41ad67d4d4b467ef2a658701b054995950210074da945
+  data.tar.gz: c4f60381dd7553bc7ad9e4249b0b1e90f0c66bf40ef39e684b301751acea7709dfc105139e34ab7b3364f5c2476861023f0f65c4655991a9fb6a32ed86fac296

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pleasegpt'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/pleasegpt

@@ -9,13 +9,17 @@ 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
+  puts <<~HELP
+    PleaseGPT - A command-line tool for OpenAI's GPT-3 API.
+    Using special characters in your command is not supported. In this case, please use double quotes.
 
-Usage:
-  pleasegpt [input]           # Generate text based on input
-  pleasegpt load-key          # Save OpenAI API key
-  pleasegpt help              # Show this help message
+      Usage:
+        pleasegpt help                        Show all commands
+        pleasegpt load-key                    Save OpenAI key in a Env file. (Required)
+        pleasegpt "any text or question"      Reply your request
+        pleasegpt -c "your question"          When requesting a command, will reply only the command.
+        pleasegpt autocomplete "your-text"    Complete your partial request
+        pleasegpt suggest "your-text"         Suggest a new text based on your request
   HELP
 else
   PleaseGPT::CLI.new.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pleasegpt/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pleasegpt'
 require 'colorize'
 
@@ -7,6 +9,9 @@ module PleaseGPT
     def start(args)
       if args.empty?
         puts '>>> Please enter a valid command <<<'
+      elsif args[0] == '-c'
+        input = args[1..].join(' ')
+        puts Api.generate_command(input).to_s.colorize(:green)
       else
         input = args.join(' ')
         puts Api.generate_text(input).to_s.colorize(:green)

data/lib/pleasegpt/gems.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'ruby/openai'
+require 'openai'
+require 'highline/import'
+require 'dotenv/load'
+require 'dotenv'

data/lib/pleasegpt/openai_api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'dotenv'
+require 'openai'
+
+# rubocop:disable Metrics/MethodLength
+
+# Main module for OpenAI Client
+module OpenaiClient
+  def self.openai_response(prompt, max_tokens, temperature, responses_qty, stop)
+    response = openai_client_new.completions(
+      parameters: {
+        model: 'text-davinci-003',
+        prompt: prompt,
+        max_tokens: max_tokens,
+        temperature: temperature,
+        n: responses_qty,
+        stop: stop
+      }
+    )
+    PleaseGPT::Error.check_response(response)
+  end
+
+  def self.openai_client_new
+    Dotenv.load(PleaseGPT::Api.join_lib_dir_with_file)
+    raise PleaseGPT::Error, 'OPENAI_API_KEY not set' unless ENV['OPENAI_API_KEY']
+
+    OpenAI::Client.new(access_token: ENV['OPENAI_API_KEY'])
+  end
+end
+
+# rubocop:enable Metrics/MethodLength

data/lib/pleasegpt/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Gem Version
+module Pleasegpt
+  VERSION = '0.2.0'
+end

data/lib/pleasegpt.rb

@@ -1,14 +1,27 @@
-require 'ruby/openai'
-require 'openai'
-require 'highline/import'
-require 'dotenv/load'
-require 'dotenv'
+# frozen_string_literal: true
+
+require_relative 'pleasegpt/version'
+require_relative 'pleasegpt/gems'
+require_relative 'pleasegpt/openai_api'
 
 # Main module for PleaseGPT gem
 module PleaseGPT
   autoload :CLI, 'pleasegpt/cli'
 
-  # API class for OpenAI API requests and responses
+  # 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
+
+  # Main module for Dirs and loading/Saving API key
   module Api
     def self.load_api_key
       key = ask('Please paste your OpenAI API key:  ')
@@ -39,38 +52,12 @@ module PleaseGPT
       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)
+      OpenaiClient.openai_response(input, 300, 0.5, 1, '.')
     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
+    def self.generate_command(input)
+      OpenaiClient.openai_response(input, 100, 0.5, 1, '\n')
     end
   end
 end

data/spec/bin/pleasegpt_test.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 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
+RSpec.describe 'pleasegpt executable' do
+  it 'runs with the given arguments' do
+    output = `bin/pleasegpt what is the capital of France?`
+    expect(output).to_not be_empty
   end
 end

data/spec/lib/cli_test.rb

@@ -1,11 +1,21 @@
+# frozen_string_literal: true
+
 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?"] }
+  describe '#start' do
+    context 'when given empty args' do
+      let(:args) { [] }
+
+      it 'returns an error message' do
+        expected_output = ">>> Please enter a valid command <<<\n"
+        expect { subject.start(args) }.to output(expected_output).to_stdout
+      end
+    end
+
+    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
@@ -13,10 +23,9 @@ RSpec.describe PleaseGPT::CLI do
         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
+      it 'returns the response from the OpenAI API with blue colour' do
+        expected_output = "\e[0;32;49mThe answer is 4.\e[0m\n"
+        expect { subject.start(args) }.to output(expected_output).to_stdout
       end
     end
   end

data/spec/lib/pleasegpt_test.rb

@@ -1,21 +1,68 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'pleasegpt'
 
+# rubocop:disable Metrics/BlockLength
+
 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 }])
+  describe 'Api' do
+    context 'when API key is valid' do
+      let(:key) { 'valid_key' }
+
+      before do
+        allow(PleaseGPT::Api).to receive(:ask).and_return(key)
+        allow(File).to receive(:write)
+        allow(File).to receive(:open)
+        allow(Dotenv).to receive(:load)
+      end
+
+      it 'saves the API key to the file' do
+        expect(PleaseGPT::Api).to receive(:save_api_key).with(key)
+        PleaseGPT::Api.load_api_key
+      end
+
+      it 'sets the OPENAI_API_KEY environment variable' do
+        expect(PleaseGPT::Api).to receive(:env_variable).with(key)
+        PleaseGPT::Api.load_api_key
+      end
+    end
+
+    context 'when API key is empty' do
+      it 'does not save the API key to the file' do
+        allow(PleaseGPT::Api).to receive(:ask).and_return('')
+        expect { PleaseGPT::Api.load_api_key }.to output("API Key cannot be empty. Please try again.\n").to_stdout
+      end
     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)
+    describe '.generate_text' do
+      before do
+        allow(PleaseGPT::Api).to receive(:openai_client).and_return(client)
+        allow(PleaseGPT::Error).to receive(:check_response).and_return('output text')
+      end
+
+      let(:client) { double('client') }
+
+      it 'returns generated text' do
+        expect(client).to receive(:completions)
+        expect(PleaseGPT::Api.generate_text('prompt')).to eq('output text')
+      end
+    end
+
+    describe '.openai_client' do
+      let(:api_key) { 'key123' }
+      let(:client) { double('client') }
+
+      before do
+        ENV['OPENAI_API_KEY'] = api_key
+        allow(OpenAI::Client).to receive(:new).and_return(client)
+      end
+
+      it 'returns a new instance of OpenAI::Client' do
+        expect(PleaseGPT::Api.openai_client).to eq(client)
+      end
     end
   end
 end
+
+# rubocop:enable Metrics/BlockLength

data/spec/pleasegpt_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Pleasegpt do
+  it 'has a version number' do
+    expect(Pleasegpt::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -1,17 +1,20 @@
+# frozen_string_literal: true
+
 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
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
 
-  # Set the environment variable for the current process
-  ENV['OPENAI_API_KEY'] = api_key
-end
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 
-RSpec.configure do |config|
   config.color = true
   config.formatter = :documentation
 end

metadata

@@ -1,29 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: pleasegpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rafael Moreira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ruby-openai
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.8.1
+- !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: openai
   requirement: !ruby/object:Gem::Requirement
@@ -39,73 +73,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
-description:
-email:
-- rafamsilva@gmail.com
+        version: '3.7'
+description: |
+  A Ruby gem that provides a wrapper around the OpenAI API.
+  It allows you to generate natural language text based on a given prompt.
+email: rafamsilva@gmail.com
 executables:
 - pleasegpt
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/console
 - bin/pleasegpt
+- bin/setup
 - lib/pleasegpt.rb
 - lib/pleasegpt/cli.rb
+- lib/pleasegpt/gems.rb
+- lib/pleasegpt/openai_api.rb
+- lib/pleasegpt/version.rb
 - spec/bin/pleasegpt_test.rb
 - spec/lib/cli_test.rb
 - spec/lib/pleasegpt_test.rb
+- spec/pleasegpt_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rafaover/pleasegpt
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: Thanks for installing! Please run `pleasegpt load-key` to configure
+  the gem.
 rdoc_options: []
 require_paths:
 - lib
@@ -113,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -123,5 +173,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A simple wrapper around the OpenAI GPT-3 API
+summary: A wrapper around the OpenAI API Chat Model
 test_files: []