senior 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39730d334959dd50f95ebdf665ac8731d61fc15fda52692e61c6a521d1228b4b
-  data.tar.gz: e2d2bb32557f3d3c7c780ec7f4293f0c56f68d885e0ed792ce2e0fce69e00b2a
+  metadata.gz: 3d973cd43135daeb4de71d71a43f52500fe6ab39f6ba507b032833eb65402977
+  data.tar.gz: 4bf83499dae649941e881453fd376603faad6399fa49970b1375a843af0a987f
 SHA512:
-  metadata.gz: 30cabd4898ce92778b12e1bac480d6e6de51bf57af8a0f1356ab24f29626cbe1c778c89b89f073880bcb099e871ab45b65cbb0f162555b1a85db9014239f1342
-  data.tar.gz: 5654b395cf96a528179988edc566ca0f4eebaa2a8f521859ba64b56f9ba1ffe60ef8a457c71f7d5da3a9ed2920b96568245fe676b2a9711b2cd9ca105cb47c1f
+  metadata.gz: 9d6394a7b1b08fd32299b43febd26143128befb958f1af203106ce05c8e809ec07a3cdd7eec1cc16b0e1ddc369b2f94873b1e9addb91a9b8385231990dcd929f
+  data.tar.gz: 6655e71e4676e35cae26aedd96bce779202a33982d028a68f8cdb1ef257ae1fcae1b86755b8c11c70d6c70cfd7dff900da2fc74d4d9d6ba4e456209c84740228

data/.rubocop.yml

@@ -44,3 +44,6 @@ Metrics/MethodLength:
 
 RSpec/ExampleLength:
   Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4

data/CHANGELOG.md

@@ -2,9 +2,6 @@
 
 - Ability to wrap a method invocation. For example, `Senior.suggest_fix { my_broken_method(2) }`
 - Test generation `Senior.write_tests_for {}`
-- Configure API keys for the OpenAI
-- Use different OpenAI models
-- Parametrize the calls to OpenAI
 - See price per call
 - Set API calling and pricing limits
 - Use different AI APIs, not just OpenAI
@@ -13,6 +10,41 @@
 - 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
+- Added the ability to configure the gem with a block:
+```ruby
+Senior.configure do |config|
+  config.open_ai.access_token = ENV.fetch('OPEN_AI_ACCESS_TOKEN')
+  config.open_ai.organization_id = ENV.fetch('OPEN_AI_ORGANIZATION_ID') # Optional
+  config.open_ai.api_version = 'v1'
+  config.open_ai.max_tokens = 1024
+  config.open_ai.model = 'text-davinci-003'
+  config.open_ai.n = 1
+  config.open_ai.request_timeout = 120
+  config.open_ai.temperature = 0.7
+  config.open_ai.uri_base = 'https://api.openai.com/'
+end
+```
+These configurations are used as default values for the OpenAI API calls.
+
 ## [0.1.0] - 2023-04-10
 
 - 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

@@ -2,9 +2,24 @@
 
 [![Gem Version](https://badge.fury.io/rb/senior.svg)](https://badge.fury.io/rb/senior)
 [![Tests](https://github.com/wilsonsilva/senior/actions/workflows/main.yml/badge.svg)](https://github.com/wilsonsilva/senior/actions/workflows/main.yml)
+[![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
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Auto-debugging a broken method](#auto-debugging-a-broken-method)
+  - [Suggesting a fix for a broken method](#suggesting-a-fix-for-a-broken-method)
+- [Development](#development)
+  - [Type checking](#type-checking)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -18,13 +33,27 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Before using Senior, ensure that the environment variables `OPEN_AI_ACCESS_TOKEN` and `OPEN_AI_ORGANIZATION_ID` are
-defined. These variables are used by the gem to authenticate and access OpenAI's language model.
+- Get your API key from https://platform.openai.com/account/api-keys
+- (optional) If you belong to multiple organizations, you can get your Organization ID from https://platform.openai.com/account/org-settings
+- Configure the library by passing your OpenAI API credentials:
+
+```ruby
+Senior.configure do |config|
+  config.open_ai.access_token = ENV.fetch('OPEN_AI_ACCESS_TOKEN')
+  config.open_ai.organization_id = ENV.fetch('OPEN_AI_ORGANIZATION_ID') # Optional
+end
+```
+
+Note that `OPEN_AI_ACCESS_TOKEN` and `OPEN_AI_ORGANIZATION_ID` are environment variables that should be set in your
+environment. You should never hardcode your API credentials directly in your code, as this is a security risk.
+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 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
@@ -34,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
@@ -48,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
@@ -45,8 +56,8 @@ module Senior
       #
       def open_ai_client
         @open_ai_client ||= ::OpenAI::Client.new(
-          access_token: ENV.fetch('OPEN_AI_ACCESS_TOKEN'),
-          organization_id: ENV.fetch('OPEN_AI_ORGANIZATION_ID')
+          access_token: Senior.configuration.open_ai.access_token,
+          organization_id: Senior.configuration.open_ai.organization_id
         )
       end
 
@@ -55,19 +66,18 @@ module Senior
       # @api private
       #
       # @param prompt [String] The prompt for which to generate a completion
-      # @param max_tokens [Integer] The maximum number of tokens to generate in the completion. Default value is 1024
       #
-      # @return [String] The create completion
+      # @return [String] The created completion
       #
-      def request_completion(prompt, max_tokens = 1024)
+      def request_completion(prompt)
         response = open_ai_client.completions(
           parameters: {
-            model: 'text-davinci-003',
+            model: defaults.model,
             prompt:,
-            max_tokens:,
-            n: 1,
+            max_tokens: defaults.max_tokens,
+            n: defaults.n,
             stop: nil,
-            temperature: 0.7
+            temperature: defaults.temperature
           }
         )
 
@@ -75,6 +85,43 @@ 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
+      #
+      # @return [Senior::Configuration::OpenAI] The default configuration object for the OpenAI brain.
+      #
+      def defaults
+        Senior.configuration.open_ai
+      end
     end
   end
 end

data/lib/senior/configuration/main.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'senior/configuration/open_ai'
+
+module Senior
+  module Configuration
+    # Index file for all configurations of the gem
+    #
+    # @api public
+    #
+    class Main
+      # The OpenAI configuration
+      #
+      # @api public
+      #
+      #
+      # @example
+      #   configuration = Senior::Configuration::Main.new
+      #   configuration.open_ai # => #<Configuration::OpenAI:0x00007fa2a61a63d8>
+      #
+      # @return [Configuration::OpenAI] The OpenAI configuration
+      #
+      attr_accessor :open_ai
+
+      # Initializes a new instance of the configuration for the Senior gem
+      #
+      # @api public
+      #
+      # @example
+      #   configuration = Senior::Configuration::Main.new
+      #
+      def initialize
+        @open_ai = Configuration::OpenAI.new
+      end
+    end
+  end
+end

data/lib/senior/configuration/open_ai.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module Senior
+  module Configuration
+    # Encapsulates the OpenAI configuration
+    #
+    # @api public
+    class OpenAI
+      # The OpenAI access token
+      #
+      # @return [String, nil] The OpenAI access token, or nil if not set
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.access_token = 'your_openai_api_key'
+      attr_writer :access_token
+
+      # The OpenAI API version
+      #
+      # @return [String] The OpenAI API version
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.api_version = 'v1'
+      attr_accessor :api_version
+
+      # The maximum number of tokens to use in the OpenAI API request
+      #
+      # @return [Integer] The maximum number of tokens to use in the OpenAI API request
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.max_tokens = 1024
+      attr_accessor :max_tokens
+
+      # The OpenAI model to use
+      #
+      # @return [String] The OpenAI model to use
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.model = 'text-davinci-003'
+      attr_accessor :model
+
+      # The number of responses to generate
+      #
+      # @return [Integer] The number of responses to generate
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.n = 1
+      attr_accessor :n
+
+      # The OpenAI organization ID
+      #
+      # @return [String, nil] The OpenAI organization ID, or nil if not set
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.organization_id = 'your_organization_id'
+      attr_accessor :organization_id
+
+      # The maximum amount of time to wait for an OpenAI API request to complete
+      #
+      # @return [Integer] The maximum amount of time to wait for an OpenAI API request to complete
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.request_timeout = 120
+      attr_accessor :request_timeout
+
+      # The temperature to use in the OpenAI API request
+      #
+      # @return [Float] The temperature to use in the OpenAI API request
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.temperature = 0.7
+      attr_accessor :temperature
+
+      # The OpenAI URI base
+      #
+      # @return [String] The OpenAI URI base
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.uri_base = 'https://api.openai.com/'
+      attr_accessor :uri_base
+
+      # The default OpenAI API version
+      DEFAULT_API_VERSION = 'v1'
+
+      # The default maximum number of tokens to use in the OpenAI API request
+      DEFAULT_MAX_TOKENS = 1024
+
+      # The default OpenAI model to use
+      DEFAULT_MODEL = 'text-davinci-003'
+
+      # The default number of responses to generate
+      DEFAULT_N = 1
+
+      # The default maximum amount of time to wait for an OpenAI API request to complete
+      DEFAULT_REQUEST_TIMEOUT = 120
+
+      # The default temperature to use in the OpenAI API request
+      DEFAULT_TEMPERATURE = 0.7
+
+      # The default OpenAI URI base
+      DEFAULT_URI_BASE = 'https://api.openai.com/'
+
+      # Initializes a new instance of the OpenAI configuration for the Senior gem
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #
+      def initialize
+        @access_token = nil
+        @api_version = DEFAULT_API_VERSION
+        @max_tokens = DEFAULT_MAX_TOKENS
+        @model = DEFAULT_MODEL
+        @n = DEFAULT_N
+        @organization_id = nil
+        @request_timeout = DEFAULT_REQUEST_TIMEOUT
+        @temperature = DEFAULT_TEMPERATURE
+        @uri_base = DEFAULT_URI_BASE
+      end
+
+      # Gets the OpenAI access token, raising an error if it is not set
+      #
+      # @raise [ConfigurationError] If the OpenAI access token is not set
+      #
+      # @return [String] The OpenAI access token.
+      #
+      # @example
+      #   configuration = Senior::Configuration::OpenAI.new
+      #   configuration.access_token # => raises ConfigurationError if access token is not set
+      #
+      def access_token
+        return @access_token if @access_token
+
+        error_text = 'OpenAI access token missing! See https://github.com/wilsonsilva/senior#usage'
+        raise ConfigurationError, error_text
+      end
+    end
+  end
+end

data/lib/senior/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Senior
+  # Base class for all Senior's errors
+  class Error < StandardError; end
+
+  # Raised when the gem's configuration is faulty
+  class ConfigurationError < Error; end
+end

data/lib/senior/version.rb

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

data/lib/senior.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'senior/errors'
+require_relative 'senior/configuration/main'
 require_relative 'senior/brains/open_ai'
 require_relative 'senior/agent'
 require_relative 'senior/version'
@@ -56,4 +58,32 @@ module Senior
   def self.agent
     @agent ||= Agent.new
   end
+
+  # Returns the configuration object for the Senior gem
+  #
+  # @api private
+  #
+  # @return [Senior::Configuration::Main] The configuration object for the Senior gem
+  #
+  def self.configuration
+    @configuration ||= Configuration::Main.new
+  end
+
+  # Provides a way to configure the Senior gem
+  #
+  # @api public
+  #
+  # @yield [configuration] A block to configure the Senior gem
+  # @yieldparam configuration [Senior::Configuration::Main] The configuration object for the Senior gem
+  #
+  # @example Configuring the Senior gem
+  #   Senior.configure do |config|
+  #     config.open_ai.access_token = 'your_openai_api_key'
+  #   end
+  #
+  # @return [void]
+  #
+  def self.configure
+    yield(configuration)
+  end
 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
@@ -8,7 +12,9 @@ module Senior
       private
 
       def open_ai_client: -> untyped
-      def request_completion: (String prompt, ?Integer max_tokens) -> String
+      def request_completion: (String prompt) -> String
+      def request_chat_completion: (String prompt) -> String
+      def defaults: -> Senior::Configuration::OpenAI
     end
   end
 end

data/sig/senior/configuration/main.rbs

@@ -0,0 +1,7 @@
+module Senior
+  module Configuration
+    class Main
+      attr_accessor open_ai: Configuration::OpenAI
+    end
+  end
+end

data/sig/senior/configuration/open_ai.rbs

@@ -0,0 +1,26 @@
+module Senior
+  module Configuration
+    class OpenAI
+      DEFAULT_API_VERSION: String
+      DEFAULT_MAX_TOKENS: Integer
+      DEFAULT_MODEL: String
+      DEFAULT_N: Integer
+      DEFAULT_REQUEST_TIMEOUT: Integer
+      DEFAULT_TEMPERATURE: Float
+      DEFAULT_URI_BASE: String
+
+      attr_writer access_token: String?|nil
+      attr_accessor api_version: String
+      attr_accessor max_tokens: Integer
+      attr_accessor model: String
+      attr_accessor n: Integer
+      attr_accessor organization_id: String?|nil
+      attr_accessor request_timeout: Integer
+      attr_accessor temperature: Float
+      attr_accessor uri_base: String
+
+      def initialize: -> void
+      def access_token: -> String?
+    end
+  end
+end

data/sig/senior/errors.rbs

@@ -0,0 +1,7 @@
+module Senior
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+end

data/sig/senior.rbs

@@ -1,12 +1,11 @@
 module Senior
   VERSION: String
+  self.@configuration: Configuration::Main
   self.@agent: Agent
 
   def self.auto_debug: (Method broken_method, untyped args, String? | nil broken_method_source) -> untyped
-
   def self.suggest_fix: (Method broken_method, untyped args) -> String
-
-  private
-
+  def self.configuration: -> Configuration::Main
+  def self.configure: -> untyped
   def self.agent: -> Agent
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: senior
 version: !ruby/object:Gem::Version
-  version: 0.1.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 GPT4 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: []
@@ -387,6 +388,9 @@ files:
 - lib/senior.rb
 - lib/senior/agent.rb
 - lib/senior/brains/open_ai.rb
+- lib/senior/configuration/main.rb
+- lib/senior/configuration/open_ai.rb
+- lib/senior/errors.rb
 - lib/senior/version.rb
 - sig/gems/method_source/method.rbs
 - sig/gems/ruby-openai/client.rbs
@@ -394,6 +398,9 @@ files:
 - sig/senior/agent.rbs
 - sig/senior/brains/i_brain.rbs
 - sig/senior/brains/open_ai.rbs
+- sig/senior/configuration/main.rbs
+- sig/senior/configuration/open_ai.rbs
+- sig/senior/errors.rbs
 homepage: https://github.com/wilsonsilva/senior
 licenses:
 - MIT
@@ -421,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: []