senior 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448f1287d6404de5d6a2168f69b2517605310f99865992d7e4db5ffee9fc538a
-  data.tar.gz: f7d0392887141cd1ee232438483cebc274a6b39607d81c93a5b9033312c62415
+  metadata.gz: 3d973cd43135daeb4de71d71a43f52500fe6ab39f6ba507b032833eb65402977
+  data.tar.gz: 4bf83499dae649941e881453fd376603faad6399fa49970b1375a843af0a987f
 SHA512:
-  metadata.gz: be9c24e647fe23cbb5e5e8580d775ab0822672856b2bc4f1bc0567a61ad9677e455b08e73aad7e95f51a1a3835809abd640220fcb6c8c249f6276376f5203021
-  data.tar.gz: 8210280b84ae3c47b5442a1a7ae8b6cdf23cd9bdc7b255701d8b6808f7864267e855bc730b424e567abd44d5de8607f7a324256ef5e1762b9a3c92599be81b2d
+  metadata.gz: 9d6394a7b1b08fd32299b43febd26143128befb958f1af203106ce05c8e809ec07a3cdd7eec1cc16b0e1ddc369b2f94873b1e9addb91a9b8385231990dcd929f
+  data.tar.gz: 6655e71e4676e35cae26aedd96bce779202a33982d028a68f8cdb1ef257ae1fcae1b86755b8c11c70d6c70cfd7dff900da2fc74d4d9d6ba4e456209c84740228

data/CHANGELOG.md

@@ -10,6 +10,18 @@
 - RBS Signatures
 - Domain exceptions
 
+## [0.3.0] - 2023-04-11
+
+### Added
+- Added support for OpenAI's Chat Completion API. Setting `Senior.configuration.open_ai.model`
+to any value of `Senior::Brains::OpenAI::CHAT_MODELS` will cause API requests to be sent to `/chat/completions`.
+Whereas setting `Senior.configuration.open_ai.model` to any value of `Senior::Brains::OpenAI::COMPLETION_MODELS`
+will cause API requests to be sent to `/completions`.
+
+### Changed
+- Updated the gem's summary and description to match the idea of the gem - A senior software engineer assistant.
+- Updated the `bin/setup` script to copy the `.env.example` file to `.env`
+
 ## [0.2.0] - 2023-04-10
 
 ### Added
@@ -33,5 +45,6 @@ These configurations are used as default values for the OpenAI API calls.
 
 - Initial release
 
+[0.3.0]: https://github.com/wilsonsilva/senior/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/wilsonsilva/senior/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/wilsonsilva/senior/compare/eecec20...v0.1.0

data/README.md

@@ -5,8 +5,9 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/87e6e2167d3283e3b79b/test_coverage)](https://codeclimate.com/github/wilsonsilva/senior/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/87e6e2167d3283e3b79b/maintainability)](https://codeclimate.com/github/wilsonsilva/senior/maintainability)
 
-Provides AI-powered debugging and automatic suggestion of code fixes. It makes use of OpenAI's language model to analyze
-and modify the source code of broken methods, allowing them to be fixed automatically.
+An AI-powered pair programmer. Provides a user-friendly interface for using AI API's to automatically repair broken code
+and suggest improvements. Simply provide the faulty code as input, and the gem will generate a corrected version using
+advanced machine learning techniques.
 
 ## Table of Contents
 
@@ -48,12 +49,11 @@ environment. You should never hardcode your API credentials directly in your cod
 Instead, store your API credentials securely, such as using environment variables or a separate configuration file that
 is excluded from source control.
 
-Once you have configured the library, you can use the Senior module to interact with the OpenAI API.
+Once you have configured the gem, you can use the `Senior` module to interact with the OpenAI API.
 
 ### Auto-debugging a broken method
-To debug a broken method, call Senior.auto_debug and pass in the broken method, its arguments, and optionally its
-source code. The method will be called repeatedly, with modifications made to its source code each time, until it no
-longer raises exceptions.
+To debug a broken method, call `Senior.auto_debug` and pass in the broken method and its arguments. The method will be
+called repeatedly, with modifications made to its source code each time, until it no longer raises exceptions.
 
 ```ruby
 def square(n) = n * y
@@ -63,7 +63,7 @@ puts result # => 4
 ```
 
 ### Suggesting a fix for a broken method
-To suggest a fix for a broken method, call Senior.suggest_fix and pass in the broken method and its arguments.
+To suggest a fix for a broken method, call `Senior.suggest_fix` and pass in the broken method and its arguments.
 The method will be analyzed and a fix will be suggested in the form of modified source code.
 
 ```ruby
@@ -77,6 +77,9 @@ puts suggestion # => "def square(n) = n * n"
 
 After checking out the repo, run `bin/setup` to install dependencies.
 
+Set your OpenAI API credentials in the environment variables `OPEN_AI_ACCESS_TOKEN` and `OPEN_AI_ORGANIZATION_ID`.
+Either in your machine's environment or in a `.env` file in the root of the project.
+
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/senior/brains/open_ai.rb

@@ -10,6 +10,11 @@ module Senior
     # @api private
     #
     class OpenAI
+      CHAT_MODELS = %w[gpt-4 gpt-4-0314 gpt-4-32k gpt-4-32k-0314 gpt-3.5-turbo gpt-3.5-turbo-0301].freeze
+      COMPLETION_MODELS = %w[text-davinci-003 text-davinci-002 text-curie-001 text-babbage-001 text-ada-001
+                             davinci curie babbage ada].freeze
+      CHAT_SYSTEM_PROMPT = "You're a Ruby dev. Only reply with plain code, no explanations."
+
       # Suggests a fix for a broken method
       #
       # @api private
@@ -32,7 +37,13 @@ module Senior
           ## Updated source:
         PROMPT
 
-        request_completion(prompt)
+        if CHAT_MODELS.include?(defaults.model)
+          request_chat_completion(prompt)
+        elsif COMPLETION_MODELS.include?(defaults.model)
+          request_completion(prompt)
+        else
+          raise "Unknown model '#{defaults.model}'. If this is a mistake, open a PR in github.com/wilsonsilva/senior"
+        end
       end
 
       private
@@ -56,7 +67,7 @@ module Senior
       #
       # @param prompt [String] The prompt for which to generate a completion
       #
-      # @return [String] The create completion
+      # @return [String] The created completion
       #
       def request_completion(prompt)
         response = open_ai_client.completions(
@@ -75,6 +86,33 @@ module Senior
         response.dig('choices', 0, 'text').strip
       end
 
+      # Creates a chat completion in OpenAI's API
+      #
+      # @api private
+      #
+      # @param prompt [String] The prompt for which to generate a chat completion
+      #
+      # @return [String] The created chat completion
+      #
+      def request_chat_completion(prompt)
+        response = open_ai_client.chat(
+          parameters: {
+            model: defaults.model,
+            max_tokens: defaults.max_tokens,
+            n: defaults.n,
+            temperature: defaults.temperature,
+            messages: [
+              { role: 'system', content: CHAT_SYSTEM_PROMPT },
+              { role: 'user', content: prompt }
+            ]
+          }
+        )
+
+        raise 'No chat completion found' unless response['choices'].any?
+
+        response.dig('choices', 0, 'message', 'content').strip
+      end
+
       # Returns the default configuration object for the OpenAI brain
       #
       # @api private

data/lib/senior/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Senior
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/sig/senior/brains/open_ai.rbs

@@ -1,6 +1,10 @@
 module Senior
   module Brains
     class OpenAI
+      CHAT_MODELS: Array[String]
+      COMPLETION_MODELS: Array[String]
+      CHAT_SYSTEM_PROMPT: String
+
       @open_ai_client: untyped
 
       def suggest_fix: (erroneous_source: String, exception_backtrace: String) -> String
@@ -9,6 +13,7 @@ module Senior
 
       def open_ai_client: -> untyped
       def request_completion: (String prompt) -> String
+      def request_chat_completion: (String prompt) -> String
       def defaults: -> Senior::Configuration::OpenAI
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senior
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -361,8 +361,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: |-
-  This gem provides a simple interface to OpenAI's GPT API for code repair. Given a piece of broken
-      code, the gem generates a corrected version.
+  An AI-powered pair programmer. Provides a user-friendly interface for using AI API's to
+      automatically repair broken code and suggest improvements. Simply provide the faulty code as input, and the gem will
+      generate a corrected version using advanced machine learning techniques.
 email:
 - wilson.dsigns@gmail.com
 executables: []
@@ -427,5 +428,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: AI coding companion
+summary: An AI-powered pair programmer
 test_files: []