voicemaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84b3811f8d8ef6084933654f41b1764c2e1c3eb1d59ac8a6e599d1c18a38bd7a
+  data.tar.gz: 91491d408b0884424c20771d4a4b9d230a7cd29dc05eb7d4f55caeb2ca8e5440
+SHA512:
+  metadata.gz: 98939ba36fb37cc71987060376422da98e064fab61074f08d8f853d5ce35a1f648db32d10ea7da5c25b9af67c908b4b901fff3b35244dfb96ee9b5d3b795e717
+  data.tar.gz: 1d4a1894a2f1eddbd30b93bb5c1226664079daaaba8c5f72510a6a5912efb65ad49e1b270a1ee628ce6b4e197285af59f5bcb65da3e70b7b2f2c3c0a4b7b5b84

data/README.md

@@ -0,0 +1,173 @@
+# Voicemaker API Library and Command Line
+
+[![Gem Version](https://badge.fury.io/rb/voicemaker.svg)](https://badge.fury.io/rb/voicemaker)
+[![Build Status](https://github.com/DannyBen/voicemaker/workflows/Test/badge.svg)](https://github.com/DannyBen/voicemaker/actions?query=workflow%3ATest)
+
+---
+
+This gem provides both a Ruby library and a command line interface for the 
+[Voicemaker][voicemaker] Text to Speech service.
+
+This gem is not affiliated with Voicemaker.
+
+---
+
+
+## Install
+
+```
+$ gem install voicemaker
+```
+
+## Features
+
+- Use as a Ruby library or from the command line
+- Show and search for available voices
+- Convert text to MP3 or WAV from a simple configuration file
+- Batch-convert multiple files
+
+
+## Usage
+
+### Initialization
+
+First, require and initialize with your Voicemaker API key:
+
+```ruby
+require 'voicemaker'
+api_key = '...'
+api = Voicemaker::API.new api_key
+```
+
+### Voices list
+
+Get the full voices list:
+
+```ruby
+result = api.voices
+```
+
+Search the voices list for one or more strings (AND search):
+
+```ruby
+result = api.voices ["en_US", "female"]
+```
+
+### Audio generation and download
+
+Make an API call and get the URL to the audio file in return:
+
+```ruby
+params = {
+  "Engine" => "neural",
+  "VoiceId" => "ai3-Jony",
+  "LanguageCode" => "en-US",
+  "OutputFormat" => "mp3",
+  "SampleRate" => "48000",
+  "Effect" => "default",
+  "MasterSpeed" => "0",
+  "MasterVolume" => "0",
+  "MasterPitch" => "0",
+  "Text" => "Hello world",
+}
+
+result = api.generate params
+```
+
+For convenience, you can call `#download` instead, to mak ethe API call and
+download the file:
+
+```ruby
+result = api.download "out.mp3', params
+```
+
+## Command line interface
+
+<!-- USAGE -->
+```
+$ voicemaker --help
+
+Voicemaker API
+
+  API Documentation:
+  https://developer.voicemaker.in/apidocs
+
+Usage:
+  voicemaker voices [--save PATH] [SEARCH...]
+  voicemaker new CONFIG
+  voicemaker generate CONFIG [OUTPUT]
+  voicemaker batch INDIR OUTDIR
+  voicemaker (-h|--help|--version)
+
+Commands:
+  voices
+    Get list of voices, optionally in a given language
+
+  new
+    Generate a sample config file
+
+  generate
+    Generate audio file. The output filename will be the same as the config
+    filename, with the proper mp3 or wav extension
+
+  batch
+    Generate multiple audio files from multiple config files
+
+Options:
+  -l --language LANG
+    Limit results to a specific language
+
+  -s --save PATH
+    Save output to output YAML file
+
+  -h --help
+    Show this help
+
+  --version
+    Show version number
+
+Parameters:
+  SEARCH
+    Provide one or more text strings to search for (case insensitive)
+
+  CONFIG
+    Path to config file
+
+  OUTPUT
+    Path to output mp3/wav file. If not provided, the filename will be the same
+    as the config file, with wav/mp3 extension
+
+  INDIR
+    Path to input directory, containing config YAML files
+
+  OURDIR
+    Path to output directory, where mp3/wav files will be saved
+
+Environment Variables:
+  VOICEMAKER_API_KEY
+    Your Voicemaker API key [required]
+
+  VOICEMAKER_API_HOST
+    Override the API host URL
+
+Examples:
+  voicemaker voices en-us
+  voicemaker voices --save out.yml en-us
+  voicemaker voices en-us female
+  voicemaker new test.yml
+  voicemaker generate test.yml out.mp3
+  voicemaker batch configs out
+
+```
+<!-- USAGE -->
+
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+
+
+[voicemaker]: https://voicemaker.in/
+[issues]: https://github.com/DannyBen/voicemaker/issues

data/bin/voicemaker

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require 'colsole'
+require 'voicemaker'
+require 'voicemaker/cli'
+include Colsole
+
+runner = Voicemaker::CLI.runner
+
+begin
+  exit runner.run ARGV
+
+rescue Interrupt
+  say "\nGoodbye"
+  exit 1  
+
+rescue => e
+  if ENV['DEBUG']
+    puts e.backtrace.reverse 
+    say ""
+  end
+  say "!undred!ERROR: #{e.class}"
+  say e.message
+  exit 1
+
+end

data/lib/sample.yml

@@ -0,0 +1,11 @@
+Engine: neural
+VoiceId: ai3-Jony
+LanguageCode: en-US
+OutputFormat: mp3
+SampleRate: 48000
+Effect: default
+MasterSpeed: "0"
+MasterVolume: "0"
+MasterPitch: "0"
+Text: |
+  Hello world

data/lib/voicemaker/api.rb

@@ -0,0 +1,66 @@
+require 'http'
+require 'down'
+
+module Voicemaker
+  class API
+    attr_reader :api_key
+
+    class << self
+      attr_writer :base_uri
+
+      def base_uri
+        @base_uri ||= ENV['VOICEMAKER_API_HOST'] || 'https://developer.voicemaker.in/voice'
+      end
+    end
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    # Returns a list of voices, with optional search criteria (array)
+    def voices(search = nil)
+      search = nil if search&.empty?
+      response = HTTP.auth(auth_header).get "#{base_uri}/list"
+      raise BadResponse, "#{response.status}\n#{response.body}" unless response.status.success?
+      voices = response.parse.dig 'data', 'voices_list'
+      raise BadResponse, "Unexpected response: #{response}" unless voices
+
+      if search
+        voices.select do |voice|
+          search_string = voice.values.join(' ').downcase
+          search.any? { |query| search_string.include? query.downcase }
+        end
+      else
+        voices
+      end
+    end
+
+    # Returns the URL for the generated file
+    def generate(params = {})
+      response = HTTP.auth(auth_header).post "#{base_uri}/api", json: params
+      if response.status.success?
+        response.parse['path']
+      else
+        raise BadResponse, "#{response.status}\n#{response.body}"
+      end
+    end
+
+    # Calls the API and saves the file
+    def download(outpath, params = {})
+      path = generate params
+      yield path if block_given?
+      Down.download path, destination: outpath
+    end
+
+  protected 
+
+    def base_uri
+      self.class.base_uri
+    end
+
+    def auth_header
+      "Bearer #{api_key}"
+    end
+
+  end
+end

data/lib/voicemaker/cli.rb

@@ -0,0 +1,10 @@
+require 'mister_bin'
+require 'voicemaker/command'
+
+module Voicemaker
+  class CLI
+    def self.runner
+      MisterBin::Runner.new handler: Command
+    end
+  end
+end

data/lib/voicemaker/command.rb

@@ -0,0 +1,111 @@
+require 'lp'
+require 'mister_bin'
+
+module Voicemaker
+  class Command < MisterBin::Command
+    help "Voicemaker API\n\n  API Documentation:\n  https://developer.voicemaker.in/apidocs"
+    version Voicemaker::VERSION
+
+    usage "voicemaker voices [--save PATH] [SEARCH...]"
+    usage "voicemaker new CONFIG"
+    usage "voicemaker generate CONFIG [OUTPUT]"
+    usage "voicemaker batch INDIR OUTDIR"
+    usage "voicemaker (-h|--help|--version)"
+
+    command "voices", "Get list of voices, optionally in a given language"
+    command "new", "Generate a sample config file"
+    command "generate", "Generate audio file. The output filename will be the same as the config filename, with the proper mp3 or wav extension"
+    command "batch", "Generate multiple audio files from multiple config files"
+
+    option "-l --language LANG", "Limit results to a specific language"
+    option "-s --save PATH", "Save output to output YAML file"
+
+    param "SEARCH", "Provide one or more text strings to search for (case insensitive)"
+    param "CONFIG", "Path to config file"
+    param "OUTPUT", "Path to output mp3/wav file. If not provided, the filename will be the same as the config file, with wav/mp3 extension"
+    param "INDIR", "Path to input directory, containing config YAML files"
+    param "OURDIR", "Path to output directory, where mp3/wav files will be saved"
+
+    environment "VOICEMAKER_API_KEY", "Your Voicemaker API key [required]"
+    environment "VOICEMAKER_API_HOST", "Override the API host URL"
+
+    example "voicemaker voices en-us"
+    example "voicemaker voices --save out.yml en-us"
+    example "voicemaker voices en-us female"
+    example "voicemaker new test.yml"
+    example "voicemaker generate test.yml out.mp3"
+    example "voicemaker batch configs out"
+
+    def voices_command
+      send_output api.voices(args['SEARCH'])
+    end
+
+    def new_command
+      template = File.expand_path "../sample.yml", __dir__
+      content = File.read template
+      File.write args['CONFIG'], content
+      say "Saved #{args['CONFIG']}"
+    end
+
+    def generate_command
+      config_path = args['CONFIG']
+      raise InputError, "Cannot find config file #{config_path}" unless File.exist? config_path
+      outpath = args['OUTPUT'] || outpath_from_config(config_path)
+      generate config_path, outpath
+    end
+
+    def batch_command
+      files = Dir["#{args['INDIR']}/*.yml"].sort
+      raise InputError, "No config files in #{args['INDIR']}" if files.empty?
+
+      files.each do |config_path|
+        extension = extension_from_config(config_path)
+        basename = File.basename config_path, '.yml'
+        outpath = "#{args['OUTDIR']}/#{basename}.#{extension}"
+        generate config_path, outpath
+        puts ""
+      end
+    end
+
+  private
+
+    def generate(config_path, outpath)
+      params = YAML.load_file config_path
+
+      say "Config : !txtgrn!#{config_path}"
+      api.download outpath, params do |url|
+        say "URL    : !txtblu!#{url}"
+      end
+
+      say "Path   : !txtblu!#{outpath}"
+    end
+
+    def send_output(data)
+      save = args['--save']
+      if save
+        say "Saved #{save}"
+        File.write save, data.to_yaml
+      else
+        lp data
+      end
+    end
+
+    def api
+      @api ||= Voicemaker::API.new(api_key)
+    end
+
+    def api_key
+      ENV['VOICEMAKER_API_KEY'] or raise MissingAuth, "Please set the 'VOICEMAKER_API_KEY' environment variable"
+    end
+
+    def outpath_from_config(config_path)
+      ext = extension_from_config config_path
+      config_path.gsub(/yml$/, ext)
+    end
+
+    def extension_from_config(config_path)
+      YAML.load_file(config_path)['OutputFormat']
+    end
+
+  end
+end

data/lib/voicemaker/exceptions.rb

@@ -0,0 +1,6 @@
+module Voicemaker
+  class VoicemakerError < StandardError; end
+  class BadResponse < VoicemakerError; end
+  class MissingAuth < VoicemakerError; end
+  class InputError < VoicemakerError; end
+end

data/lib/voicemaker/version.rb

@@ -0,0 +1,3 @@
+module Voicemaker
+  VERSION = "0.1.0"
+end

data/lib/voicemaker.rb

@@ -0,0 +1,5 @@
+require 'voicemaker/version'
+require 'voicemaker/exceptions'
+require 'voicemaker/api'
+
+require 'byebug' if ENV['BYEBUG']

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: voicemaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: lp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+description: Easy to use API for Voicemaker.in TTS service, with a command line interface
+email: db@dannyben.com
+executables:
+- voicemaker
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/voicemaker
+- lib/sample.yml
+- lib/voicemaker.rb
+- lib/voicemaker/api.rb
+- lib/voicemaker/cli.rb
+- lib/voicemaker/command.rb
+- lib/voicemaker/exceptions.rb
+- lib/voicemaker/version.rb
+homepage: https://github.com/DannyBen/voicemaker
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/voicemaker/issues
+  changelog_uri: https://github.com/DannyBen/voicemaker/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/DannyBen/voicemaker
+  source_code_uri: https://github.com/DannyBen/voicemaker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Voicemaker.in Text to Speech API Library and Command Line
+test_files: []