gtts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c8688d9e696c00721372aab8096f5e8f18b7f28117b337fc71152d01e1273fd
+  data.tar.gz: 48f07c2ebf32d2efe08a12b372fd6610babcdc9825fd6d07af0a0eeacb073ea6
+SHA512:
+  metadata.gz: a84f45da1703ddb17a4422a99d8da7e6688cefe2bd4fa30a5724c75b5507d6f58b17e3c63ad3a3fdae1a656e724a7498ccdd4d1e889cc14c031bd7e578d8689e
+  data.tar.gz: 04622f38048774ee15ffcb08f3dacfd478880af8804f12a419ffb07225bf0bd4dd751d70cccee7acafba8ee914dbd130c945c7d22912e9a992b6d39841cacea8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dinko Azema
+
+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,104 @@
+# GTTS Ruby
+
+A Ruby library and CLI tool to interface with Google Translate's Text-to-Speech API. This is a Ruby port of the Python [gTTS](https://github.com/pndurette/gTTS) library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gtts'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install gtts
+```
+
+## Usage
+
+### As a Library
+
+```ruby
+require 'gtts'
+
+# Simple example
+tts = Gtts::GTTS.new("Hello World")
+tts.save("hello.mp3")
+
+# More options
+tts = Gtts::GTTS.new(
+  "Hola Mundo",
+  lang: "es",     # Language
+  tld: "com.mx",  # Top-level domain
+  slow: true      # Slower speed
+)
+tts.save("hola.mp3")
+
+# Stream the audio data
+tts.stream do |audio_chunk|
+  # Process audio data chunks
+  # For example, write to a file
+  File.open("output.mp3", "ab") { |f| f.write(audio_chunk) }
+end
+
+# Check supported languages
+Gtts.languages.each do |code, name|
+  puts "#{code}: #{name}"
+end
+
+# Check if a language is supported
+puts Gtts.language_supported?("es") # true
+puts Gtts.language_supported?("xx") # false
+```
+
+### Command Line Tool
+
+The gem comes with a command-line tool called `gtts-cli`:
+
+```bash
+# Basic usage
+gtts-cli "Hello World" -o hello.mp3
+
+# Specify language
+gtts-cli "Hola Mundo" -l es -o hola.mp3
+
+# Read from file
+gtts-cli -f input.txt -o output.mp3
+
+# List available languages
+gtts-cli --list-langs
+
+# Show all options
+gtts-cli --help
+```
+
+### CLI Options
+
+- `-f, --file FILE` : Read text from file
+- `-o, --output FILE` : Output file (default: output.mp3)
+- `-l, --lang LANG` : Language (default: en)
+- `-t, --tld TLD` : Top-level domain for Google Translate
+- `-s, --slow` : Speak more slowly
+- `--list-langs` : List available languages
+- `--debug` : Debug mode
+- `-h, --help` : Show help message
+
+## Supported Languages
+
+The library supports multiple languages. Use `gtts-cli --list-langs` to see all available languages or check `Gtts.languages` in your code.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/gtts-cli

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "gtts"
+require "optparse"
+
+options = {
+  tld: "com",
+  lang: "en",
+  slow: false,
+  lang_check: true,
+  output: "output.mp3"
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: gtts-cli [options] 'text to speak'"
+
+  opts.on("-f", "--file FILE", "Read text from file") do |file|
+    options[:file] = file
+  end
+
+  opts.on("-o", "--output FILE", "Output file (default: output.mp3)") do |file|
+    options[:output] = file
+  end
+
+  opts.on("-l", "--lang LANG", "Language (default: en)") do |lang|
+    options[:lang] = lang
+  end
+
+  opts.on("-t", "--tld TLD", "Top-level domain for google translate (default: com)") do |tld|
+    options[:tld] = tld
+  end
+
+  opts.on("-s", "--slow", "Speak more slowly") do
+    options[:slow] = true
+  end
+
+  opts.on("--list-langs", "List available languages") do
+    puts "\nLanguage codes:"
+    Gtts.languages.each do |code, name|
+      puts "#{code}\t#{name}"
+    end
+    exit
+  end
+
+  opts.on("--debug", "Debug mode") do
+    options[:debug] = true
+  end
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+begin
+  text = if options[:file]
+    File.read(options[:file])
+  elsif !ARGV.empty?
+    ARGV.join(" ")
+  else
+    puts "Error: No text provided. Use --help for usage information."
+    exit 1
+  end
+
+  tts = Gtts::GTTS.new(
+    text,
+    tld: options[:tld],
+    lang: options[:lang],
+    slow: options[:slow],
+    lang_check: options[:lang_check]
+  )
+
+  tts.save(options[:output])
+  puts "Successfully saved to #{options[:output]}"
+
+rescue Gtts::GttsError, ArgumentError => e
+  puts "Error: #{e.message}"
+  exit 1
+rescue StandardError => e
+  puts "Unknown error: #{e.message}"
+  puts e.backtrace if options[:debug]
+  exit 1
+end

data/gtts.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/gtts/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gtts"
+  spec.version = Gtts::VERSION
+  spec.authors = ["rocket4ce"]
+  spec.email = ["rocket4ce@gmail.com"]
+
+  spec.summary = "Ruby implementation of gTTS (Google Text-to-Speech)"
+  spec.description = "gTTS (Google Text-to-Speech) is a Ruby library and CLI tool to interface with Google Translate text-to-speech API"
+  spec.homepage = "https://github.com/rocket4ce/gTTS_ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rocket4ce/gTTS_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/rocket4ce/gTTS_ruby/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Include all files in the gem
+  spec.files = Dir.glob(%w[
+    lib/**/*.rb
+    exe/**/*
+    *.gemspec
+    README.md
+    LICENSE.txt
+  ])
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_dependency "http", "~> 5.1"  # For making HTTP requests
+  spec.add_dependency "json", "~> 2.6"  # For JSON handling
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+end

data/lib/gtts/lang.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Gtts
+  module Lang
+    LANGUAGES = {
+      "af" => "Afrikaans",
+      "ar" => "Arabic",
+      "bg" => "Bulgarian",
+      "bn" => "Bengali",
+      "bs" => "Bosnian",
+      "ca" => "Catalan",
+      "cs" => "Czech",
+      "cy" => "Welsh",
+      "da" => "Danish",
+      "de" => "German",
+      "el" => "Greek",
+      "en" => "English",
+      "eo" => "Esperanto",
+      "es" => "Spanish",
+      "et" => "Estonian",
+      "fi" => "Finnish",
+      "fr" => "French",
+      "gu" => "Gujarati",
+      "hi" => "Hindi",
+      "hr" => "Croatian",
+      "hu" => "Hungarian",
+      "hy" => "Armenian",
+      "id" => "Indonesian",
+      "is" => "Icelandic",
+      "it" => "Italian",
+      "ja" => "Japanese",
+      "jw" => "Javanese",
+      "km" => "Khmer",
+      "kn" => "Kannada",
+      "ko" => "Korean",
+      "la" => "Latin",
+      "lv" => "Latvian",
+      "mk" => "Macedonian",
+      "ml" => "Malayalam",
+      "mr" => "Marathi",
+      "my" => "Myanmar (Burmese)",
+      "ne" => "Nepali",
+      "nl" => "Dutch",
+      "no" => "Norwegian",
+      "pl" => "Polish",
+      "pt" => "Portuguese",
+      "ro" => "Romanian",
+      "ru" => "Russian",
+      "si" => "Sinhala",
+      "sk" => "Slovak",
+      "sq" => "Albanian",
+      "sr" => "Serbian",
+      "su" => "Sundanese",
+      "sv" => "Swedish",
+      "sw" => "Swahili",
+      "ta" => "Tamil",
+      "te" => "Telugu",
+      "th" => "Thai",
+      "tl" => "Filipino",
+      "tr" => "Turkish",
+      "uk" => "Ukrainian",
+      "ur" => "Urdu",
+      "vi" => "Vietnamese",
+      "zh-CN" => "Chinese"
+    }.freeze
+
+    def self.tts_langs
+      LANGUAGES
+    end
+
+    def self.supported?(lang_code)
+      LANGUAGES.key?(lang_code)
+    end
+  end
+end

data/lib/gtts/tts.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "http"
+require "json"
+require "base64"
+require "logger"
+require "cgi"
+require "uri"
+
+module Gtts
+  class Speed
+    SLOW = true
+    NORMAL = nil
+  end
+
+  class GttsError < StandardError
+    attr_reader :tts, :response
+
+    def initialize(msg = nil, tts: nil, response: nil)
+      @tts = tts
+      @response = response
+      @msg = msg || infer_msg
+      super(@msg)
+    end
+
+    private
+
+    def infer_msg
+      cause = "Unknown"
+
+      if @response.nil?
+        premise = "Failed to connect"
+        cause = "Host '#{_translate_url}' is not reachable" if @tts&.tld != "com"
+      else
+        status = @response.status
+        reason = @response.reason
+
+        premise = "#{status} (#{reason}) from TTS API"
+
+        cause = case status
+               when 403 then "Bad token or upstream API changes"
+               when 404 then @tts&.tld != "com" ? "Unsupported tld '#{@tts.tld}'" : "Not found"
+               when 200 then "No audio stream in response. Unsupported language '#{@tts.lang}'" unless @tts&.lang_check
+               when 500..599 then "Upstream API error. Try again later."
+               end
+      end
+
+      "#{premise}. Probable cause: #{cause}"
+    end
+  end
+
+  class GTTS
+    GOOGLE_TTS_MAX_CHARS = 100
+    GOOGLE_TTS_HEADERS = {
+      "Referer" => "http://translate.google.com/",
+      "User-Agent" => "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.106 Safari/537.36",
+      "Content-Type" => "application/x-www-form-urlencoded;charset=utf-8"
+    }.freeze
+    GOOGLE_TTS_RPC = "jQ1olc"
+
+    attr_reader :text, :tld, :lang, :lang_check, :speed
+
+    def initialize(text, tld: "com", lang: "en", slow: false, lang_check: true)
+      raise ArgumentError, "No text to speak" if text.nil? || text.empty?
+
+      @text = text
+      @tld = tld
+      @lang_check = lang_check
+      @lang = lang
+      @speed = slow ? Speed::SLOW : Speed::NORMAL
+
+      validate_language if @lang_check
+    end
+
+    def stream
+      prepared_requests.each_with_index do |request, idx|
+        client = HTTP.headers(GOOGLE_TTS_HEADERS)
+
+        begin
+          response = client.post(request[:url], form: {"f.req" => request[:body]})
+
+          unless response.status.success?
+            raise GttsError.new(tts: self, response: response)
+          end
+
+          response.body.to_s.each_line do |line|
+            decoded_line = line.force_encoding("UTF-8")
+            if decoded_line.include?("jQ1olc")
+              if (audio_match = decoded_line.match(/jQ1olc","\[\\"(.*?)\\"\]/))
+                as_bytes = audio_match[1].encode("ASCII")
+                yield Base64.decode64(as_bytes)
+              else
+                raise GttsError.new(tts: self, response: response)
+              end
+            end
+          end
+        rescue HTTP::Error => e
+          raise GttsError.new(tts: self, response: response)
+        end
+      end
+    end
+
+    def save(filename)
+      File.open(filename, "wb") do |file|
+        stream { |chunk| file.write(chunk) }
+      end
+    end
+
+    private
+
+    def validate_language
+      return unless @lang_check
+
+      unless Lang.supported?(@lang)
+        raise ArgumentError, "Language not supported: #{@lang}"
+      end
+    end
+
+    def prepared_requests
+      text_parts = tokenize(@text)
+      raise GttsError.new("No text to send to TTS API") if text_parts.empty?
+
+      text_parts.map do |part|
+        {
+          url: translate_url,
+          body: package_rpc(part)
+        }
+      end
+    end
+
+    def tokenize(text)
+      # Simple tokenization for now - split by maximum character length
+      # TODO: Implement more sophisticated tokenization like the Python version
+      text.scan(/.{1,#{GOOGLE_TTS_MAX_CHARS}}/m)
+    end
+
+    def translate_url
+      "https://translate.google.#{@tld}/_/TranslateWebserverUi/data/batchexecute"
+    end
+
+    def package_rpc(text)
+      params = [text, @lang, @speed, "null"]
+      escaped_params = params.to_json
+
+      rpc = [[[GOOGLE_TTS_RPC, escaped_params, nil, "generic"]]]
+      rpc.to_json
+    end
+  end
+end

data/lib/gtts/version.rb

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

data/lib/gtts.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "gtts/version"
+require_relative "gtts/lang"
+require_relative "gtts/tts"
+
+module Gtts
+  class Error < StandardError; end
+
+  # Shortcut for creating a new GTTS instance
+  def self.create(text, **options)
+    GTTS.new(text, **options)
+  end
+
+  # Get list of supported languages
+  def self.languages
+    Lang.tts_langs
+  end
+
+  # Check if a language is supported
+  def self.language_supported?(lang_code)
+    Lang.supported?(lang_code)
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: gtts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rocket4ce
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: gTTS (Google Text-to-Speech) is a Ruby library and CLI tool to interface
+  with Google Translate text-to-speech API
+email:
+- rocket4ce@gmail.com
+executables:
+- gtts-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/gtts-cli
+- gtts.gemspec
+- lib/gtts.rb
+- lib/gtts/lang.rb
+- lib/gtts/tts.rb
+- lib/gtts/version.rb
+homepage: https://github.com/rocket4ce/gTTS_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rocket4ce/gTTS_ruby
+  source_code_uri: https://github.com/rocket4ce/gTTS_ruby
+  changelog_uri: https://github.com/rocket4ce/gTTS_ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ruby implementation of gTTS (Google Text-to-Speech)
+test_files: []