sawara 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34bee8ad292b23c3f9263d82403ae7da181151e5bd066288c557804f11258882
-  data.tar.gz: 7891f97562dbbc91fc25f26f9c8fa964248cfd72b0c469c17f1760219973e95b
+  metadata.gz: 33c01867584475125d8830efce467704af83e4704ea7eefd8160f7884fd726fe
+  data.tar.gz: e5fa76b6f98772772bdaa27443c858acef19fad65c5cd7ad6fbf31331e771dc0
 SHA512:
-  metadata.gz: cc5e8e6127bdde3375dc1bf6955b6375937e9d98b202337ce6dbd1716ba404eecc21d89a23aaf4f0697e99622e0289543049c9454ce12c512e0fcd69022a645a
-  data.tar.gz: 894d27aa3d9218981c6f18462f2a5741de837872ea075ddd807c56747f7a0b6c5f188c34ae221a76ccfae555ad4c40f42967556d2f3ec31939fc9748c1944d97
+  metadata.gz: f38fcf4a2acff8d37828661a4dd5a44dd5f79ca357dca3fd9c22a19dff3e5dc526c99866351e15c00b21164382fc832014037a7c7b8cb4906faa12bbafb08ce4
+  data.tar.gz: 5cd70107c0d993abc2027478cccf5d3d293f087b1a6c10d6b7bb09aab5c50b58e71bd9961b3fa4999fabc4c912f8ccb1b1dca175a56ad167336b9cfe3a5e3aa8

data/Gemfile

@@ -10,3 +10,4 @@ gem 'rake'
 gem 'rspec'
 gem 'rubocop'
 gem 'ruby-openai'
+gem 'thor'

data/Gemfile.lock

@@ -45,6 +45,7 @@ GEM
     ruby-openai (3.5.0)
       httparty (>= 0.18.1)
     ruby-progressbar (1.13.0)
+    thor (1.2.1)
     unicode-display_width (2.4.2)
 
 PLATFORMS
@@ -56,6 +57,7 @@ DEPENDENCIES
   rspec
   rubocop
   ruby-openai
+  thor
 
 BUNDLED WITH
    2.4.7

data/README.md

@@ -1,6 +1,14 @@
 # Sawara
 
-Sawara is a Ruby Gem for using ChatGPT in your terminal via OpenAI API.
+![image](https://user-images.githubusercontent.com/33394676/224897066-0429c135-c1b0-49e4-8027-b96ebea93c6d.png)
+
+## Overview
+
+Sawara is a Ruby Gem and command-line interface (CLI) tool that enables you to use ChatGPT in your terminal via OpenAI API.
+
+With Sawara, you can easily create and manage multiple bots with different prompts, and have natural language conversations with them through the CLI.
+
+Of course, you can also start a conversation with a bot without setting a prompt in advance.
 
 ## Installation
 
@@ -9,15 +17,53 @@ Sawara is a Ruby Gem for using ChatGPT in your terminal via OpenAI API.
 ## Initial setup
 
 1. Get your API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)
-2. `$ sawara`
+2. `$ sawara call` or `$ sawara setkey`
 3. Enter your API Key.
 
 ## Usage
 
-Executing `sawara` initiates a conversation with ChatGPT.
-```
-$ sawara
-```
+### Call a bot
+
+    $ sawara call
+    $ sawara -c
+
+Use the `sawara call` command to start a conversation.
+
+### Call a registered bot
+
+    $ sawara call <bot_id>
+    $ sawara -c <bot_id>
+
+Use the `sawara call` command followed by the ID of the bot to start a conversation with the registered bot.
+
+### Add a bot
+
+    $ sawara add <bot_id>
+
+Use the `sawara add` command followed by the ID of the bot you want to register. You'll be asked to provide a name and a prompt for the bot.
+
+### Delete a bot
+
+    $ sawara delete <bot_id>
+
+Use the `sawara delete` command followed by the ID of the bot you want to remove.
+
+### List all bots
+
+    $ sawara list
+    $ sawara -l
+
+Use the `sawara list` command to list all the bots you've registered.
+
+### Set or update your OpenAI API key
+
+    $ sawara setkey
+
+Use the `sawara setkey` command to set or update your OpenAI API key.
+
+### Configuration file
+
+Configuration data will be saved in `~/.sawara.yml`.
 
 ## Development
 

data/exe/sawara

@@ -3,6 +3,4 @@
 
 require 'sawara'
 
-config = Sawara::Config.new
-client = Sawara::ChatClient.new(config)
-Sawara::Talk.new.start(client)
+Sawara::CLI.start

data/lib/sawara/api_key.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sawara
+  class ApiKey
+    def read
+      UserConfig.read['api_key']
+    end
+
+    def update
+      api_key = await_api_key
+      return if api_key.nil?
+
+      UserConfig.save('api_key', api_key)
+    end
+
+    private
+
+    def await_api_key
+      puts 'Please enter your OpenAI API Key🔑'
+      input = $stdin.gets
+      return if input.nil?
+
+      api_key = input.chomp
+      api_key.empty? ? await_api_key : api_key
+    end
+  end
+end

data/lib/sawara/bot.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'readline'
+
+module Sawara
+  class Bot
+    def initialize
+      @bots = UserConfig.read['bots']
+    end
+
+    def list
+      puts
+      if @bots.empty?
+        puts 'No bots are registered🫥'
+        puts 'To register a bot, use `sawara add [NAME]`.'
+      else
+        @bots.each do |id, profile|
+          puts "#{profile['name']}(#{id}):"
+          puts "  \"#{profile['prompt']}\""
+        end
+      end
+    end
+
+    def create(id)
+      return unless id_is_valid?(id)
+
+      name = await_name
+      return if name.nil?
+
+      prompt = await_prompt
+      return if prompt.empty?
+
+      @bots[id] = { 'name' => name, 'prompt' => prompt }
+      UserConfig.save('bots', @bots)
+      puts
+      puts "#{id}'s default prompt registration was successful🎉"
+      puts "To begin a conversation with #{id}, use `sawara -c #{id}`."
+    end
+
+    def find(id)
+      if exists?(id)
+        profile = @bots[id]
+        puts
+        puts "Loaded the bot \"#{profile['name']}\". The prompt is as follows:"
+        puts profile['prompt']
+        profile
+      else
+        puts "The bot has id \"#{id}\" does not exist in the registered bots."
+      end
+    end
+
+    def delete(id)
+      if exists?(id)
+        puts "⚠️Are you sure you want to delete #{id}? (y/n)"
+        return unless await_confirm
+
+        @bots.delete(id)
+        UserConfig.save('bots', @bots)
+        puts
+        puts "\"#{id}\" has been deleted."
+      else
+        puts "The bot has id \"#{id}\" does not exist in the registered bots."
+      end
+    end
+
+    private
+
+    def await_name
+      puts
+      puts 'Please enter the name of your bot😉'
+      line = Readline.readline
+      return if line.nil?
+
+      name = line.chomp
+      name.empty? ? await_name : name
+    end
+
+    def await_prompt
+      puts
+      puts 'Please enter the prompt of your bot📜'
+      lines = []
+      while (line = Readline.readline)
+        lines << ("#{line}\n")
+      end
+      lines.join.gsub(/^\n+|\n+$/, '')
+    end
+
+    def await_confirm
+      line = Readline.readline
+      return if line.nil?
+
+      confirm = line.chomp.downcase
+      confirm == 'y'
+    end
+
+    def id_is_valid?(id)
+      if id.empty?
+        puts 'Bot id must have at least one character.'
+        false
+      elsif exists?(id)
+        puts "\"#{id}\" is already registered id."
+        false
+      else
+        true
+      end
+    end
+
+    def exists?(id)
+      @bots.key?(id)
+    end
+  end
+end

data/lib/sawara/chat_client.rb

@@ -4,8 +4,7 @@ require 'openai'
 
 module Sawara
   class ChatClient
-    def initialize(user_config)
-      api_key = user_config.api_key
+    def initialize(api_key)
       OpenAI.configure do |config|
         config.access_token = api_key
       end
@@ -16,7 +15,7 @@ module Sawara
       response = @openai_client.chat(
         parameters: { model: 'gpt-3.5-turbo', messages: }
       )
-      response.dig('choices', 0, 'message', 'content')
+      response.dig('choices', 0, 'message', 'content').sub(/^\n*/, '')
     end
   end
 end

data/lib/sawara/cli.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Sawara
+  class CLI < Thor
+    desc 'call [ID], -c [ID]',
+         'Start a conversation (If [ID] is there, preload the prompt of the bot specified by [ID])'
+    map '-c' => :call
+    def call(id = nil)
+      client = launch_client
+      if id.nil?
+        Talk.new.start(client)
+      else
+        profile = Bot.new.find(id)
+        return if profile.nil?
+
+        talk = Talk.new(profile)
+        talk.start(client)
+      end
+    end
+
+    desc 'setkey', 'Register or update an API key for OpenAI API'
+    def setkey
+      ApiKey.new.update
+    end
+
+    desc 'add [ID]', 'Register a new bot with name and prompt'
+    def add(id)
+      Bot.new.create(id)
+    end
+
+    desc 'delete [ID]', 'Delete the bot specified by [ID]'
+    def delete(id)
+      Bot.new.delete(id)
+    end
+
+    desc 'list, -l', 'List all bots with their names and prompts'
+    map '-l' => :list
+    def list
+      Bot.new.list
+    end
+
+    desc 'version, -v', 'Print version'
+    map %w[-v --version] => :version
+    def version
+      puts VERSION
+    end
+
+    private
+
+    def launch_client
+      api_key = ApiKey.new
+      api_key.update if api_key.read.empty?
+      ChatClient.new(api_key.read)
+    end
+  end
+end

data/lib/sawara/talk.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
-require 'byebug'
+require 'readline'
 
 module Sawara
   class Talk
-    def initialize
+    def initialize(profile = nil)
       @messages = []
+      if profile.nil?
+        @name = 'Sawara'
+      else
+        @name = profile['name']
+        @messages << { role: 'system', content: profile['prompt'] }
+      end
     end
 
     def start(client)
@@ -36,15 +42,22 @@ module Sawara
     def await_user_content
       puts
       puts 'You:'
-      content = $stdin.readlines.join.sub(/\n*$/, '')
+
+      lines = []
+      while (line = Readline.readline)
+        lines << ("#{line}\n")
+      end
+
+      content = lines.join
       @messages << { role: 'user', content: }
       content
     end
 
     def await_assistant_content(client)
       puts
-      puts 'Sawara:'
-      content = client.fetch(@messages).sub(/^\n*/, '')
+      puts "#{@name}:"
+
+      content = client.fetch(@messages)
       @messages << { role: 'assistant', content: }
       puts content
     end

data/lib/sawara/user_config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'yaml/store'
+
+module Sawara
+  class UserConfig
+    CONFIG_PATH = "#{Dir.home}/.sawara.yml".freeze
+
+    class << self
+      def read
+        create_config_file unless File.exist?(CONFIG_PATH)
+        YAML.load_file(CONFIG_PATH)
+      end
+
+      def save(key, value)
+        store = YAML::Store.new(CONFIG_PATH)
+        store.transaction do
+          store[key] = value
+        end
+      end
+
+      private
+
+      def create_config_file
+        File.new(CONFIG_PATH, 'w')
+        save('api_key', '')
+        save('bots', {})
+      end
+    end
+  end
+end

data/lib/sawara/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sawara
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 end

data/lib/sawara.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'sawara/api_key'
 require_relative 'sawara/chat_client'
-require_relative 'sawara/config'
+require_relative 'sawara/cli'
+require_relative 'sawara/bot'
+require_relative 'sawara/user_config'
 require_relative 'sawara/talk'
 require_relative 'sawara/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sawara
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - yocajii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies: []
 description: Sawara is a comannd-line tool for using ChatGPT via OpenAI API.
 email:
@@ -29,11 +29,13 @@ files:
 - Rakefile
 - exe/sawara
 - lib/sawara.rb
+- lib/sawara/api_key.rb
+- lib/sawara/bot.rb
 - lib/sawara/chat_client.rb
-- lib/sawara/config.rb
+- lib/sawara/cli.rb
 - lib/sawara/talk.rb
+- lib/sawara/user_config.rb
 - lib/sawara/version.rb
-- sawara.gemspec
 - sig/chatgpt_cli.rbs
 homepage: https://github.com/yocajii/sawara
 licenses:

data/lib/sawara/config.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'yaml/store'
-
-module Sawara
-  class Config
-    CONFIG_PATH = "#{Dir.home}/.sawara".freeze
-
-    def initialize
-      unless File.exist?(CONFIG_PATH)
-        File.new(CONFIG_PATH, 'w')
-        update_config
-      end
-      @config = load_config
-    end
-
-    def api_key
-      @config['api_key']
-    end
-
-    private
-
-    def load_config
-      YAML.load_file(CONFIG_PATH)
-    end
-
-    def update_config
-      puts 'Enter your OpenAI API Key.'
-      api_key = $stdin.gets
-      store = YAML::Store.new(CONFIG_PATH)
-      store.transaction do
-        store['api_key'] = api_key
-      end
-    end
-  end
-end

data/sawara.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/sawara/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'sawara'
-  spec.version = Sawara::VERSION
-  spec.authors = ['yocajii']
-  spec.email = ['yocajii@stone.sakura.ne.jp']
-
-  spec.summary = 'This is ChatGPT CLI.'
-  spec.description = 'Sawara is a comannd-line tool for using ChatGPT via OpenAI API.'
-
-  spec.homepage = 'https://github.com/yocajii/sawara'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.1.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/yocajii/sawara'
-  spec.metadata['changelog_uri'] = 'https://github.com/yocajii/sawara/blob/main/CHANGELOG.md'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency 'example-gem', '~> 1.0'
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end