chat_cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47cba710877b2f94d6daee3ae4293332b6b20f6f0fcaa3aad86cf7784a9b452f
+  data.tar.gz: 1b6e4e19714957e34750e3ac729ae4192b42a943fb51512761270103096dee6f
+SHA512:
+  metadata.gz: ab486fef807c217e654b697ec1f6e4b526edcf7bd50cdc70b6c90249c02c25f4da4ca55635e282d5991e528c0ccbdb46defcc2c860ee29e3c7dbe287377a38b9
+  data.tar.gz: af0d7c43b6bc89257fd833b929cb8f9139dff6196b8d57d5407c5df8ea781972511a747d03003a8eb419a0aa51a878fd524bb3289b6265cfa6e058982e3b1db1

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chat_cli.gemspec
+gemspec
+
+gem "rake", "~> 12.3"

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    chat_cli (0.1.0)
+      dotenv (~> 2.8)
+      ruby-openai (~> 3.6)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.8.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    ruby-openai (3.7.0)
+      httparty (>= 0.18.1)
+    thor (1.2.1)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  chat_cli!
+  rake (~> 12.3)
+
+BUNDLED WITH
+   2.4.9

data/README.md

@@ -0,0 +1,35 @@
+# ChatCLI
+
+OpenAI APIを利用し、GPT-3.5-turboへ質問を投げかけることができるCLIアプリケーションです。  
+※利用者自身のAPI Keyを使用して、OpenAI APIへリクエストを送ります。
+
+## 推奨環境
+- Mac (Intel)
+- MacOS (Monterey v12.6.1)
+- Ruby (2.6.10p210)
+- Bundler (2.4.9)
+
+## Installation
+
+1. gemのインストール
+`sudo gem install chat_cli -n /usr/loca/bin`
+
+## Usage
+
+`$sudo chat_cli init`  
+下記サイトで作成したシークレットAPIキーを記録します。  
+https://platform.openai.com/account/api-keys
+
+`$chat_cli chat {message}`   
+GPT-3.5へメッセージを送ります。返答まで最大240秒待つ必要があり、これ以上返答に時間がかかる場合は返答を短くするような質問にしなければいけません。 
+
+`$chat_cli usage`
+現在のAPI利用量を下記サイトから閲覧することができます。   
+https://platform.openai.com/account/usage
+
+## Dependencies
+
+利用したパッケージは以下の通りです
+- [ruby-openai](https://github.com/alexrudall/ruby-openai)
+- [thor](https://github.com/rails/thor)
+- [dotenv](https://github.com/bkeepers/dotenv)

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/exe/chat_cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "chat_cli"
+
+ChatCli::CLI.start

data/lib/chat_cli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChatCli
+  VERSION = "0.1.0"
+end

data/lib/chat_cli.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'openai'
+require 'dotenv/load'
+
+require_relative "chat_cli/version"
+
+module ChatCli
+  class Error < StandardError; end
+  
+  class CLI < Thor
+    LOADING_CHAR = ['\\', '-', '/', '|']
+
+    desc("chat [MESSAGE]", "Sends a message to ChatGPT. ex) $chat_cli chat ペットにとっての優しい世界を実現するにはどうすれば良いでしょうか？")
+    long_desc <<-LONGDESC
+        `chat_cli chat [Message]` sends a message to ChatGPT and print its response.
+
+        The model that made this response is `gpt-3.5-turbo-0301`.
+        In addition, the timeout period for response is 240 seconds. 
+        Messages that take longer than this to respond cannot be sent.
+
+        ex)
+        > $ chat_cli chat ペットにとっての優しい世界を実現するにはどうすれば良いでしょうか？
+    LONGDESC
+    def chat(question)
+        Dotenv.load(File.expand_path("../.env", __dir__))
+        token = ENV['OPENAI_ACCESS_TOKEN']
+        if token.nil?
+            say "The following command must be executed to set the secret API key.\n" \
+            "> $sudo chat_cli init", :yellow
+            return
+        end
+        client = OpenAI::Client.new(access_token: ENV['OPENAI_ACCESS_TOKEN'])
+        response = nil
+        thread = Thread.new {
+            response = client.chat(
+                parameters: {
+                    model: "gpt-3.5-turbo-0301",
+                    messages: [{ role: "user", "content": question }],
+                })
+        }
+        1.upto(1200) do |i|
+            say "\r[#{LOADING_CHAR[i % 4]}]", nil, false
+            sleep 0.2
+            break unless thread.alive?
+        end
+        if response&.has_key? "error"
+            say("\r[ERROR] Invalid Secret API Key.\n" \
+            "Please set the correct secret API key again from the following command.\n" \
+            "> $sudo chat_cli init", :red); return if response&.dig("error", "code") == "invalid_api_key"
+
+            say "\r[ERROR] Unknown Error", :red
+            return
+        end
+        say "\rYou: #{question}"
+        say "GPT: #{response&.dig("choices", 0, "message", "content")}"
+    end
+
+    desc "init", "Set the Secret API Key."
+    def init()
+        token = ask "Please enter your Secret API Key.\n" \
+        "If it has not been issued yet, please go to the following site to issue a new API key.\n" \
+        "  https://platform.openai.com/account/api-keys\n" \
+        "API Key:"
+        File.open(File.expand_path("../.env", __dir__), "w") do |file|
+            file.write("OPENAI_ACCESS_TOKEN = #{token}")
+        end
+    end
+
+    desc "usage", "Check API usage"
+    def usage()
+        say "Please check bellow Web Site.\n" \
+        "  https://platform.openai.com/account/usage"
+    end
+
+    def self.exit_on_failure?
+        true
+    end
+  end
+end

data/sig/chat_cli.rbs

@@ -0,0 +1,4 @@
+module ChatCli
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: chat_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- M01tyan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: Chat-GPT Command Line Tools
+email:
+- M01tyan@users.noreply.github.com
+executables:
+- chat_cli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- exe/chat_cli
+- lib/chat_cli.rb
+- lib/chat_cli/version.rb
+- sig/chat_cli.rbs
+homepage: https://rubygems.org/gems/chat_cli
+licenses: []
+metadata:
+  homepage_uri: https://rubygems.org/gems/chat_cli
+  source_code_uri: https://github.com/M01tyan/chat_cli
+  allowed_push_host: https://rubygems.org/gems/chat_cli
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: This is Chat-GPT CLI.
+test_files: []