translation_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b64c85dab791be051f77b9e20ad887cfe8c7ee817ae6099641633642d0291680
+  data.tar.gz: 66c9c79aba80565a03875bca2d4fdf64bc64a9b315b39faf3a8f5a06f8645855
+SHA512:
+  metadata.gz: ccad42571b28c04503c8f8d6d256e1a54a711305d1fd186b1522f85f68dd57b4a0f1b816572c860ca1907ad01f7b94989d638fd6272cd655d6533ee286cb0784
+  data.tar.gz: ff862ecc8885bbc7f5f8ba25a7a31ab57f920340a09b7f23e0f412d05b0f390625ac46f18cdcc5a4ab9e29a30ddd7128e850db2cb36fda22a6c0385b9a4002a6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: true
+  Max: 20
+
+Lint/ScriptPermission:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-29
+
+- Initial release
+
+## [1.0.0] - 2024-09-30
+
+- ログの出力をするかどうかと除外する単語をオプションとして追加
+
+## [1.0.2] - 2024-09-30
+
+- リファクタリングのみ
+
+## [1.1.0] - 2024-10-4
+
+- 日本語以外に翻訳できるように、`exchange_language`オプションを追加
+  - それに伴い、翻訳のメソッド名を`translate_to_jp` -> `translate`に変更
+- 空白文字はそのまま返すように変更
+
+## [0.1.0] - 2024-11-12
+
+- 他のAPIに対応できるようにリファクタリング
+
+## [0.1.1] - 2025-03-31
+
+- ライブラリの更新

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 milkeclair
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# TranslationAPI
+
+Translate using APIs.  
+Requires api key.  
+
+## For OpenAI
+
+1. `touch .env`
+2. Add `OPENAI_API_KEY=YOUR_API_KEY`  
+3. Optional: `ENV["OPENAI_MODEL"]`(default: gpt-4o-mini)
+4. `TranslationAPI::Mediator.new.translate("text")`
+
+### Init Options
+
+* output_logs (default: true)  
+* language (default: "japanese")  
+* agent (default: :openai)  
+* except_words (default: [])  
+
+### Output
+
+* Translated_text
+* Used Tokens
+* Cost Spent(https://openai.com/api/pricing/)
+
+## Example
+
+Exec `ruby example.rb "text"`

data/Rakefile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
+require_relative "rake_helper"
+
+desc "analysis"
+task :analysis do
+  sh "bundle install"
+
+  RakeHelper.init_rake_tasks
+
+  puts "--- rspec ---"
+  Rake::Task[:spec].invoke
+
+  puts "--- rubocop ---"
+  Rake::Task[:rubocop].invoke
+
+  puts "--- yard ---"
+  Rake::Task[:yard].invoke
+end
+
+desc "push to github packages and rubygems"
+task :push do
+  sh "bundle install"
+
+  puts "--- build ---"
+  RakeHelper.build_gem
+
+  puts "--- push to github packages ---"
+  RakeHelper.push_to_github_packages
+
+  puts "--- push to rubygems ---"
+  RakeHelper.push_to_rubygems
+end
+
+task default: :analysis

data/example.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "lib/translation_api/mediator"
+
+if ARGV.empty?
+  puts "引数が必要です: ruby example.rb \"text\""
+  exit
+end
+
+text = ARGV.join(" ")
+translator =
+  TranslationAPI::Mediator.new(
+    output_logs: true,
+    language: "japanese",
+    agent: :openai,
+    except_words: %w[hoge fuga]
+  )
+translated_text = translator.translate(text)
+p translated_text

data/how_to_publish.txt

@@ -0,0 +1,10 @@
+some code change
+version.rb change
+changelog.md change
+
+$rake analysis
+
+$git commit
+$git push
+
+$rake push

data/lib/translation_api/calculator.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "writer"
+
+module TranslationAPI
+  class Calculator
+    class ArgumentError < StandardError; end
+    MODEL_ERROR_MESSAGE =
+      "設定に無いモデルです。.envを確認してください。"
+
+    # トークン数から利用料金を計算する
+    #
+    # @param [Integer] used_tokens 使用したトークン数
+    # @param [String] token_type トークンの種類
+    # @return [Float] 利用料金
+    def self.calc_total_cost(used_tokens, token_type)
+      model = ENV["OPENAI_MODEL"] || "gpt-4o-mini"
+      rate = get_token_rate(model, token_type)
+      used_tokens * rate
+    end
+
+    # モデルとトークンの種類からトークンの単価を取得する
+    # モデルが設定に無い場合はエラーを投げる
+    #
+    # @param [String] model モデル名
+    # @param [String] token_type トークンの種類
+    # @return [Float] トークンの単価
+    def self.get_token_rate(model, token_type)
+      token_rate = token_rate_hash
+      validate_model(model, token_rate)
+      token_rate[model][token_type.to_sym]
+    end
+
+    # トークン単価のハッシュを返す
+    #
+    # @return [Hash] トークン単価のハッシュ
+    def self.token_rate_hash
+      one_million = 1_000_000
+      {
+        "gpt-4o" => {
+          input: 5.0 / one_million,
+          output: 15.0 / one_million
+        },
+        "gpt-4o-2024-08-06" => {
+          input: 2.5 / one_million,
+          output: 10.0 / one_million
+        },
+        "gpt-4o-mini" => {
+          input: 0.15 / one_million,
+          output: 0.6 / one_million
+        }
+      }
+    end
+
+    # モデルが存在するかどうかを確認する
+    #
+    # @param [String] model モデル名
+    # @param [Hash] token_rate トークンレートのハッシュ
+    # @raise [Calculator::ArgumentError] モデルが存在しない場合
+    def self.validate_model(model, token_rate)
+      return if token_rate.key?(model)
+
+      raise Calculator::ArgumentError, MODEL_ERROR_MESSAGE
+    end
+  end
+end

data/lib/translation_api/deepl.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "dotenv"
+require "deepl"
+
+module TranslationAPI
+  class DeepL
+    SYSTEM_CONTENT_BASE = <<~TEXT
+      Keep symbols
+    TEXT
+
+    def initialize(output_logs: true, except_words: [], language: "japanese", pro: false)
+      Dotenv.load
+      setup_deepl_config!(pro: pro)
+      @supported_languages = fetch_supported_languages
+      validate_supported!(language)
+      @system_content = SYSTEM_CONTENT_BASE + except_option_text(except_words)
+      @language = @supported_languages[language.to_sym]
+    end
+
+    def translate(text)
+      return text if text.strip.empty?
+
+      p ::DeepL.translate(text, nil, @language, context: @system_content).text
+    end
+
+    private
+
+    def setup_deepl_config!(pro:)
+      validate_api_key!
+
+      ::DeepL.configure do |config|
+        config.auth_key = ENV["DEEPL_API_KEY"] || ENV["DEEPL_AUTH_KEY"]
+        config.host = pro ? "https://api.deepl.com" : "https://api-free.deepl.com"
+      end
+    end
+
+    def validate_supported!(lang)
+      raise "This language is unsupported by DeepL" unless supported?(lang)
+    end
+
+    def validate_api_key!
+      raise "API key is not found" unless ENV["DEEPL_API_KEY"] || ENV["DEEPL_AUTH_KEY"]
+    end
+
+    def fetch_supported_languages
+      ::DeepL.languages.to_h { |lang| [lang.name.downcase.to_sym, lang.code] }
+    end
+
+    def supported?(lang)
+      @supported_languages.key?(lang.to_sym)
+    end
+
+    def except_option_text(except_words)
+      return "" if except_words.empty?
+
+      <<~TEXT
+        Words listed next are not translated: [#{except_words.join(", ")}]
+      TEXT
+    end
+  end
+end

data/lib/translation_api/mediator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "writer"
+require_relative "openai"
+require_relative "deepl"
+
+module TranslationAPI
+  class Mediator
+    # @param [Boolean] output_logs ログを出力するかどうか
+    # @param [String] language 翻訳先の言語
+    # @param [Symbol] agent 翻訳エージェント
+    # @param [Array<String>] except_words 除外する単語のリスト
+    # @return [TranslationAPI::Mediator]
+    def initialize(
+      output_logs: true, language: "japanese", agent: :openai, except_words: []
+    )
+      @output_logs = output_logs
+      @language = language
+      @agent = agent
+      @except_words = except_words
+    end
+
+    # テキストを翻訳する
+    #
+    # @param [String] text 翻訳するテキスト
+    # @return [String] 翻訳されたテキスト
+    def translate(text)
+      agent = init_agent
+      agent.translate(text)
+    end
+
+    # エージェントのインスタンスを初期化する
+    #
+    # @return [Object] 翻訳エージェントのインスタンス
+    def init_agent
+      agent_class.new(
+        output_logs: @output_logs, except_words: @except_words, language: @language
+      )
+    end
+
+    # エージェントのクラスを返す
+    #
+    # @return [Class] エージェントのクラス
+    def agent_class
+      case @agent
+      when :openai
+        OpenAI
+      when :deepl
+        DeepL
+      else
+        class_name = camelize(@agent.to_s)
+        Object.const_get("TranslationAPI::#{class_name}")
+      end
+    end
+
+    # スネークケースの文字列をキャメルケースに変換する
+    #
+    # @param [String] str スネークケースの文字列
+    # @return [String] キャメルケースの文字列
+    def camelize(str)
+      str.split("_").map(&:capitalize).join
+    end
+  end
+end

data/lib/translation_api/openai.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "dotenv"
+require "openai"
+require_relative "writer"
+
+module TranslationAPI
+  class OpenAI
+    SYSTEM_CONTENT_BASE = <<~TEXT
+      Translate only.
+      Return result only, no extra info
+      Keep symbols
+    TEXT
+
+    # OpenAI APIを使用してテキストを翻訳する
+    #
+    # @param [Boolean] output_logs ログを出力するかどうか
+    # @param [Array<String>] except_words 除外する単語のリスト
+    # @param [String] language 翻訳先の言語
+    # @return [void]
+    def initialize(output_logs: true, except_words: [], language: "japanese")
+      # 環境変数の読み込み
+      Dotenv.load
+      raise "API key is not found" unless ENV["OPENAI_API_KEY"]
+
+      @client = ::OpenAI::Client.new(
+        access_token: ENV["OPENAI_API_KEY"],
+        log_errors: true # 好み
+      )
+      @output_logs = output_logs
+      @system_content = SYSTEM_CONTENT_BASE + except_option_text(except_words)
+      @language = language
+    end
+
+    # テキストを日本語に翻訳し、結果をファイルに書き込む
+    #
+    # @param [String] text 翻訳するテキスト
+    # @return [void]
+    def translate(text)
+      # 空白文字は翻訳する必要がない
+      return text if text.strip.empty?
+
+      response = chat_to_api(text)
+      Writer.write_logs(self, response) if @output_logs
+
+      response["choices"][0]["message"]["content"]
+    end
+
+    # レスポンスから使用したトークン数を取得する
+    #
+    # @param [Hash] response OpenAI APIからのレスポンス
+    # @param [String] token_type トークンの種類 (input or output)
+    # @return [Integer] 使用したトークン数
+    def self.dig_used_tokens(response, token_type)
+      if token_type == "input"
+        response["usage"]["prompt_tokens"]
+      elsif token_type == "output"
+        response["usage"]["completion_tokens"]
+      end
+    end
+
+    private
+
+    # OpenAI APIにテキストを送信し、翻訳結果を取得する
+    #
+    # @param [String] text 翻訳するテキスト
+    # @return [Hash] OpenAI APIからのレスポンス
+    def chat_to_api(text)
+      @client.chat(
+        parameters: {
+          model: ENV["OPENAI_MODEL"] || "gpt-4o-mini",
+          messages: [
+            { role: "system", content: @system_content },
+            { role: "user", content: user_prompt_text(text) }
+          ]
+        }
+      )
+    end
+
+    # 除外する単語を指定するプロンプト
+    #
+    # @param [Array<String>] except_words 除外する単語のリスト
+    # @return [String] 除外する単語を指定するテキスト
+    def except_option_text(except_words)
+      return "" if except_words.empty?
+
+      <<~TEXT
+        Words listed next are not translated: [#{except_words.join(", ")}]
+      TEXT
+    end
+
+    # ユーザー入力のプロンプト
+    #
+    # @param [String] text テキスト
+    # @return [String] ユーザー入力のプロンプト
+    def user_prompt_text(text)
+      <<~TEXT
+        Please translate this text to #{@language}: #{text}
+      TEXT
+    end
+  end
+end

data/lib/translation_api/version.rb

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

data/lib/translation_api/writer.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require_relative "calculator"
+require_relative "openai"
+
+module TranslationAPI
+  class Writer
+    @agent = nil
+
+    # ログをファイルに書き込む
+    #
+    # @param [Object] agent 翻訳エージェントのインスタンス
+    # @param [Hash] response 翻訳した結果
+    # @return [void]
+    def self.write_logs(agent, response)
+      # 例: "Hoge::Fuga" => "fuga"
+      @agent = agent.class.to_s.split("::").last.downcase
+      handle_agent(response)
+    end
+
+    # エージェントに対応したログ書き込み用メソッドを呼び出す
+    #
+    # @param [Hash] response 翻訳した結果
+    # @return [void]
+    def self.handle_agent(response)
+      method_name = "write_#{@agent}_logs"
+      send(method_name, response)
+    end
+
+    # OpenAIのログをファイルに書き込む
+    #
+    # @param [Hash] response OpenAI APIからのレスポンス
+    # @return [void]
+    def self.write_openai_logs(response)
+      input_tokens = OpenAI.dig_used_tokens(response, "input")
+      output_tokens = OpenAI.dig_used_tokens(response, "output")
+
+      write_translated_text(response["choices"][0]["message"]["content"])
+      write_used_tokens(input_tokens, output_tokens)
+      write_total_cost(input_tokens, output_tokens)
+    end
+
+    # 出力先のテキストファイルのパスを返す
+    # example.rbから見たパスで指定している
+    #
+    # @param [String] under_logs_path translator_logsディレクトリ配下のパス
+    # @return [String] 出力先のテキストファイルのパス
+    def self.text_path(under_logs_path)
+      output_dir = "translator_logs/#{@agent}"
+      FileUtils.mkdir_p(output_dir) unless File.directory?(output_dir)
+      File.join(output_dir, under_logs_path)
+    end
+
+    # 翻訳されたテキストをファイルに書き込み、ターミナルに出力する
+    # テキストはファイルの末尾に追記される
+    #
+    # @param [Hash] translated_text 翻訳されたテキスト
+    # @return [void]
+    def self.write_translated_text(translated_text)
+      log_file_path = text_path("translated_text.txt")
+      File.open(log_file_path, "a") do |file|
+        file.puts(translated_text)
+      end
+    end
+
+    # 使用したトークン数をファイルに書き込む
+    # ファイルのテキストは上書きされる
+    #
+    # @param [Integer] input_tokens 入力トークン数
+    # @param [Integer] output_tokens 出力トークン数
+    # @return [void]
+    def self.write_used_tokens(input_tokens, output_tokens)
+      log_file_path = text_path("tokens.txt")
+      existing_input_tokens, existing_output_tokens = read_existing_tokens(log_file_path)
+
+      total_input_tokens = existing_input_tokens + input_tokens
+      total_output_tokens = existing_output_tokens + output_tokens
+
+      File.open(log_file_path, "w") do |file|
+        file.puts("input: #{total_input_tokens}")
+        file.puts("output: #{total_output_tokens}")
+      end
+    end
+
+    # ファイルにあるトークン数を読み込む
+    #
+    # @param [String] log_file_path トークン数が書かれたファイルのパス
+    # @return [Array<Integer>] 入力トークン数と出力トークン数
+    def self.read_existing_tokens(log_file_path)
+      existing_input_tokens, existing_output_tokens = 0, 0
+
+      if File.exist?(log_file_path)
+        File.readlines(log_file_path).each do |line|
+          existing_input_tokens = line.split(":").last.strip.to_i if line.start_with?("input:")
+          existing_output_tokens = line.split(":").last.strip.to_i if line.start_with?("output:")
+        end
+      end
+
+      [existing_input_tokens, existing_output_tokens]
+    end
+
+    # トークン数から利用料金を計算し、ファイルにある合計金額に加算して書き込む
+    # ファイルのテキストは上書きされる
+    #
+    # @param [Integer] input_tokens 入力トークン数
+    # @param [Integer] output_tokens 出力トークン数
+    # @return [void]
+    def self.write_total_cost(input_tokens, output_tokens)
+      log_file_path = text_path("cost.txt")
+      this_cost =
+        Calculator.calc_total_cost(input_tokens, "input") + Calculator.calc_total_cost(output_tokens, "output")
+      existing_cost =
+        if File.exist?(log_file_path)
+          File.read(log_file_path).gsub("$", "").to_f
+        else
+          0.0
+        end
+      total_cost = this_cost + existing_cost
+
+      File.open(log_file_path, "w") do |file|
+        # 小数点以下8桁まで表示
+        file.puts("$#{format("%.8f", total_cost)}")
+      end
+    end
+  end
+end

data/lib/translation_api.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "translation_api/version"
+require_relative "translation_api/mediator"
+
+module TranslationAPI; end

data/rake_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class RakeHelper
+  GITHUB_PACKAGES_PUSH_COMMAND =
+    "gem push --key github --host https://rubygems.pkg.github.com/milkeclair " \
+    "pkg/translation_api-#{TranslationAPI::VERSION}.gem".freeze
+
+  RUBYGEMS_PUSH_COMMAND =
+    "gem push --host https://rubygems.org " \
+    "pkg/translation_api-#{TranslationAPI::VERSION}.gem".freeze
+
+  def self.init_rake_tasks
+    RSpec::Core::RakeTask.new(:spec) { |task| task.verbose = false }
+    RuboCop::RakeTask.new
+    YARD::Rake::YardocTask.new
+  end
+
+  def self.build_gem
+    abort("gemのビルドに失敗しました") unless system("rake build")
+  end
+
+  def self.push_to_github_packages
+    abort("githubへのgemのpushに失敗しました") unless system(GITHUB_PACKAGES_PUSH_COMMAND)
+  end
+
+  def self.push_to_rubygems
+    abort("rubygemsへのgemのpushに失敗しました") unless system(RUBYGEMS_PUSH_COMMAND)
+  end
+end

data/sig/translation_api.rbs

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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: translation_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- milkeclair
+bindir: exe
+cert_chain: []
+date: 2025-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: translate
+email:
+- milkeclair.noreply@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- example.rb
+- how_to_publish.txt
+- lib/translation_api.rb
+- lib/translation_api/calculator.rb
+- lib/translation_api/deepl.rb
+- lib/translation_api/mediator.rb
+- lib/translation_api/openai.rb
+- lib/translation_api/version.rb
+- lib/translation_api/writer.rb
+- rake_helper.rb
+- sig/translation_api.rbs
+homepage: https://github.com/milkeclair/translation_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/milkeclair/translation_api
+  source_code_uri: https://github.com/milkeclair/translation_api/blob/main
+  changelog_uri: https://github.com/milkeclair/translation_api/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: translate
+test_files: []