voicemaker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b3811f8d8ef6084933654f41b1764c2e1c3eb1d59ac8a6e599d1c18a38bd7a
-  data.tar.gz: 91491d408b0884424c20771d4a4b9d230a7cd29dc05eb7d4f55caeb2ca8e5440
+  metadata.gz: ef73c119c97b71f1114e095357f7bfc04d20e73081752fa5bae226c390911622
+  data.tar.gz: 116b47aaa08211a962702f2f2cf1db1134992468a7cb4d296a454f8e23b0f264
 SHA512:
-  metadata.gz: 98939ba36fb37cc71987060376422da98e064fab61074f08d8f853d5ce35a1f648db32d10ea7da5c25b9af67c908b4b901fff3b35244dfb96ee9b5d3b795e717
-  data.tar.gz: 1d4a1894a2f1eddbd30b93bb5c1226664079daaaba8c5f72510a6a5912efb65ad49e1b270a1ee628ce6b4e197285af59f5bcb65da3e70b7b2f2c3c0a4b7b5b84
+  metadata.gz: ba494699349745471825e4e9af8c92282f5c075b533ae1a9392f6058a9885f617f61e7d3faab48c1a3b3de4f7ea51b29760bf4985d510a3c50d82017d24be93b
+  data.tar.gz: 912165db465f663a2c062206c712bfd35fdc27b5b558fa5a34ee3084618d7565f35bab41cd7e2e02d4c97d9f92808ea2e6def4a923bd3721fc98e6d38944d310

data/README.md

@@ -2,6 +2,7 @@
 
 [![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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b1977ee0d60affeba3d4/maintainability)](https://codeclimate.com/github/DannyBen/voicemaker/maintainability)
 
 ---
 
@@ -35,8 +36,7 @@ First, require and initialize with your Voicemaker API key:
 
 ```ruby
 require 'voicemaker'
-api_key = '...'
-api = Voicemaker::API.new api_key
+Voicemaker::API.key = 'your api key'
 ```
 
 ### Voices list
@@ -44,13 +44,14 @@ api = Voicemaker::API.new api_key
 Get the full voices list:
 
 ```ruby
-result = api.voices
+voices = Voicemaker::Voices.new
+result = voices.all
 ```
 
 Search the voices list for one or more strings (AND search):
 
 ```ruby
-result = api.voices ["en_US", "female"]
+result = voices.search "en-us", "female"
 ```
 
 ### Audio generation and download
@@ -58,90 +59,221 @@ result = api.voices ["en_US", "female"]
 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
+tts = Voicemaker::TTS.new voice: 'Jony', text: 'Hello world'
+url = tts.url
+tts.save "output.mp3"
 ```
 
-For convenience, you can call `#download` instead, to mak ethe API call and
-download the file:
+or with the full list of available parameters:
 
 ```ruby
-result = api.download "out.mp3', params
+params = {
+  voice: "Jony",
+  output_format: "mp3",
+  sample_rate: 48000,
+  effect: "default",
+  master_speed: 0,
+  master_volume: 0,
+  master_pitch: 0,
+  text: "Hello world"
+}
+
+tts = Voicemaker::TTS.new params
+url = tts.url
 ```
 
+As the `voice` parameter, you may use either the voice ID (`ai3-Jony`) or the 
+voice web name (`Jony`). Just note that some voices have the same webname (for
+example, Emily), so in these cases it is best to use the full voice ID.
+
 ## Command line interface
 
 <!-- USAGE -->
+### `$ voicemaker `
+
+
 ```
-$ voicemaker --help
+Voicemaker Text-to-Speech
+
+Commands:
+  voices   Get a list of available voices
+  tts      Generate audio files from text
+  new      Create a new config file or a project directory
+  project  Create multiple audio files
+
+API Documentation: https://developer.voicemaker.in/apidocs
 
-Voicemaker API
+```
 
-  API Documentation:
-  https://developer.voicemaker.in/apidocs
+### `$ voicemaker voices --help`
+
+
+```
+Get a list of available voices
 
 Usage:
-  voicemaker voices [--save PATH] [SEARCH...]
-  voicemaker new CONFIG
-  voicemaker generate CONFIG [OUTPUT]
-  voicemaker batch INDIR OUTDIR
-  voicemaker (-h|--help|--version)
+  voicemaker voices [--save PATH --count --compact] [SEARCH...]
+  voicemaker voices (-h|--help)
 
-Commands:
-  voices
-    Get list of voices, optionally in a given language
+Options:
+  -s --save PATH
+    Save output to output YAML file
+
+  -t --compact
+    Show each voice in a single line
 
-  new
-    Generate a sample config file
+  -c --count
+    Add number of voices to the result
 
-  generate
-    Generate audio file. The output filename will be the same as the config
-    filename, with the proper mp3 or wav extension
+  -h --help
+    Show this help
 
-  batch
-    Generate multiple audio files from multiple config files
+Parameters:
+  SEARCH
+    Provide one or more text strings to search for (case insensitive AND search)
+
+Environment Variables:
+  VOICEMAKER_API_KEY
+    Your Voicemaker API key [required]
+
+  VOICEMAKER_API_HOST
+    Override the API host URL
+
+  VOICEMAKER_CACHE_DIR
+    API cache diredctory [default: cache]
+
+  VOICEMAKER_CACHE_LIFE
+    API cache life. These formats are supported:
+    off - No cache
+    20s - 20 seconds
+    10m - 10 minutes
+    10h - 10 hours
+    10d - 10 days
+
+Examples:
+  voicemaker voices en-us
+  voicemaker voices --save out.yml en-us
+  voicemaker voices en-us female
+  voicemaker voices en-us --compact
+
+```
+
+### `$ voicemaker tts --help`
+
+
+```
+Generate audio files from text
+
+Usage:
+  voicemaker tts [options]
+  voicemaker tts (-h|--help)
 
 Options:
-  -l --language LANG
-    Limit results to a specific language
+  -v --voice NAME
+    Voice ID or Webname
+
+  -t --text TEXT
+    Text to say
+
+  -f --file PATH
+    Load text from file
+
+  -c --config PATH
+    Use a YAML configuration file
 
   -s --save PATH
-    Save output to output YAML file
+    Save audio file.
+    If not provided, a URL to the audio file will be printed instead.
+    When used with the --config option, omit the file extension, as it will be
+    determined based on the config file.
+
+  -d --debug
+    Show API parameters
 
   -h --help
     Show this help
 
-  --version
-    Show version number
+Environment Variables:
+  VOICEMAKER_API_KEY
+    Your Voicemaker API key [required]
+
+  VOICEMAKER_API_HOST
+    Override the API host URL
+
+  VOICEMAKER_CACHE_DIR
+    API cache diredctory [default: cache]
+
+  VOICEMAKER_CACHE_LIFE
+    API cache life. These formats are supported:
+    off - No cache
+    20s - 20 seconds
+    10m - 10 minutes
+    10h - 10 hours
+    10d - 10 days
+
+Examples:
+  voicemaker tts --voice ai3-Jony --text "Hello world" --save out.mp3
+  voicemaker tts -v ai3-Jony --file hello.txt --save out.mp3
+  voicemaker tts --config english-female.yml -f text.txt -s outfile
+
+```
+
+### `$ voicemaker new --help`
+
+
+```
+Create a new config file or a project directory
+
+Usage:
+  voicemaker new config PATH
+  voicemaker new project DIR
+  voicemaker new (-h|--help)
+
+Commands:
+  config
+    Create a config file to be used with the 'voicemaker tts' command
+
+  project
+    Generate a project directory to be used with the 'voicemaker project'
+    command
+
+Options:
+  -h --help
+    Show this help
 
 Parameters:
-  SEARCH
-    Provide one or more text strings to search for (case insensitive)
+  PATH
+    Path to use for creating the config file
+
+  DIR
+    Directory name for creating the project structure
+
+Examples:
+  voicemaker new config test.yml
+  voicemaker new project sample-project
+
+```
+
+### `$ voicemaker project --help`
+
+
+```
+Create multiple audio files
 
-  CONFIG
-    Path to config file
+Usage:
+  voicemaker project PATH [--debug]
+  voicemaker project (-h|--help)
 
-  OUTPUT
-    Path to output mp3/wav file. If not provided, the filename will be the same
-    as the config file, with wav/mp3 extension
+Options:
+  --debug
+    Show API parameters
 
-  INDIR
-    Path to input directory, containing config YAML files
+  -h --help
+    Show this help
 
-  OURDIR
-    Path to output directory, where mp3/wav files will be saved
+Parameters:
+  PATH
+    Path to the project directory
 
 Environment Variables:
   VOICEMAKER_API_KEY
@@ -150,15 +282,22 @@ Environment Variables:
   VOICEMAKER_API_HOST
     Override the API host URL
 
+  VOICEMAKER_CACHE_DIR
+    API cache diredctory [default: cache]
+
+  VOICEMAKER_CACHE_LIFE
+    API cache life. These formats are supported:
+    off - No cache
+    20s - 20 seconds
+    10m - 10 minutes
+    10h - 10 hours
+    10d - 10 days
+
 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
+  voicemaker project sample-project
 
 ```
+
 <!-- USAGE -->
 
 

data/lib/sample.yml

@@ -1,11 +1,9 @@
-Engine: neural
-VoiceId: ai3-Jony
-LanguageCode: en-US
-OutputFormat: mp3
-SampleRate: 48000
-Effect: default
-MasterSpeed: "0"
-MasterVolume: "0"
-MasterPitch: "0"
-Text: |
-  Hello world
+voice: Jony
+
+# All the below are optional
+output_format: mp3
+sample_rate: 48000
+effect: default
+master_speed: 0
+master_volume: 0
+master_pitch: 0

data/lib/voicemaker/api.rb

@@ -1,66 +1,81 @@
+require 'lightly'
 require 'http'
-require 'down'
 
 module Voicemaker
   class API
-    attr_reader :api_key
+    ROOT = 'https://developer.voicemaker.in/voice'
 
     class << self
-      attr_writer :base_uri
+      attr_writer :root, :key, :cache_life, :cache_dir
 
-      def base_uri
-        @base_uri ||= ENV['VOICEMAKER_API_HOST'] || 'https://developer.voicemaker.in/voice'
+      def root
+        @root ||= ENV['VOICEMAKER_API_ROOT'] || ROOT
       end
-    end
 
-    def initialize(api_key)
-      @api_key = api_key
-    end
+      def key
+        @key ||= ENV['VOICEMAKER_API_KEY'] || raise(MissingAuth, "Please set the 'VOICEMAKER_API_KEY' environment variable")
+      end
+
+      def cache_life
+        @cache_life ||= ENV['VOICEMAKER_CACHE_LIFE'] || '4h'
+      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
+      def cache_dir
+        @cache_dir ||= ENV['VOICEMAKER_CACHE_DIR'] || 'cache'
+      end
 
-      if search
-        voices.select do |voice|
-          search_string = voice.values.join(' ').downcase
-          search.any? { |query| search_string.include? query.downcase }
+      # Performs HTTP GET and cache it
+      # Returns a parsed body on success
+      # Raises BadResponse on error
+      def get(endpoint, params = {})
+        cache.get "#{root}/#{endpoint}+#{params}" do
+          response = get! endpoint, params
+          response.parse
         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}"
+      # Performs HTTP POST and cache it
+      # Returns a parsed body on success
+      # Raises BadResponse on error
+      def post(endpoint, params = {})
+        cache.get "#{root}/#{endpoint}+#{params}" do
+          response = post! endpoint, params
+          response.parse
+        end
       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
+      def cache
+        @cache ||= begin
+          lightly = Lightly.new life: cache_life, dir: cache_dir
+          lightly.disable if cache_life == 'off'
+          lightly
+        end
+      end
 
-  protected 
+  protected
 
-    def base_uri
-      self.class.base_uri
-    end
+      # Performs HTTP GET
+      # Returns a parsed body on success
+      # Raises BadResponse on error
+      def get!(endpoint, params = {})
+        response = HTTP.auth(auth_header).get "#{root}/#{endpoint}", json: params
+        raise BadResponse, "#{response.status}\n#{response.body}" unless response.status.success?
+        response
+      end
 
-    def auth_header
-      "Bearer #{api_key}"
-    end
+      # Performs HTTP POST
+      # Returns a parsed body on success
+      # Raises BadResponse on error
+      def post!(endpoint, params = {})
+        response = HTTP.auth(auth_header).post "#{root}/#{endpoint}", json: params
+        raise BadResponse, "#{response.status}\n#{response.body}" unless response.status.success?
+        response
+      end
+
+      def auth_header
+        "Bearer #{key}"
+      end
 
+    end
   end
-end
+end

data/lib/voicemaker/cli.rb

@@ -1,10 +1,25 @@
+require 'lp'
 require 'mister_bin'
-require 'voicemaker/command'
+require 'voicemaker/commands/base'
+require 'voicemaker/commands/voices_command'
+require 'voicemaker/commands/tts_command'
+require 'voicemaker/commands/new_command'
+require 'voicemaker/commands/project_command'
 
 module Voicemaker
   class CLI
     def self.runner
-      MisterBin::Runner.new handler: Command
+      router = MisterBin::Runner.new version: VERSION,
+        header: "Voicemaker Text-to-Speech",
+        footer: "API Documentation: https://developer.voicemaker.in/apidocs"
+
+      router.route "voices", to: Commands::VoicesCommand
+      router.route "tts", to: Commands::TTSCommand
+      router.route "new", to: Commands::NewCommand
+      router.route "project", to: Commands::ProjectCommand
+
+      router
+
     end
   end
 end

data/lib/voicemaker/commands/base.rb

@@ -0,0 +1,23 @@
+module Voicemaker
+  module Commands
+    class Base < MisterBin::Command
+
+      class << self
+        def api_environment
+          environment "VOICEMAKER_API_KEY", "Your Voicemaker API key [required]"
+          environment "VOICEMAKER_API_HOST", "Override the API host URL"
+          environment "VOICEMAKER_CACHE_DIR", "API cache diredctory [default: cache]"
+          environment "VOICEMAKER_CACHE_LIFE", <<~EOF
+            API cache life. These formats are supported:
+            off - No cache
+            20s - 20 seconds
+            10m - 10 minutes
+            10h - 10 hours
+            10d - 10 days
+          EOF
+        end
+      end
+
+    end
+  end
+end

data/lib/voicemaker/commands/new_command.rb

@@ -0,0 +1,48 @@
+module Voicemaker
+  module Commands
+    class NewCommand < Base
+      help "Create a new config file or a project directory"
+
+      usage "voicemaker new config PATH"
+      usage "voicemaker new project DIR"
+      usage "voicemaker new (-h|--help)"
+
+      command "config", "Create a config file to be used with the 'voicemaker tts' command"
+      command "project", "Generate a project directory to be used with the 'voicemaker project' command"
+
+      param "PATH", "Path to use for creating the config file"
+      param "DIR", "Directory name for creating the project structure"
+
+      example "voicemaker new config test.yml"
+      example "voicemaker new project sample-project"
+
+      def config_command
+        copy_config_template args['PATH']
+      end
+
+      def project_command
+        base = args['DIR']
+        copy_config_template "#{base}/config.yml"
+        Dir.mkdir "#{base}/in" unless Dir.exist? "#{base}/in"
+        Dir.mkdir "#{base}/out" unless Dir.exist? "#{base}/out"
+        File.write "#{base}/in/sample1.txt", "hello"
+        File.write "#{base}/in/sample2.txt", "hello"
+        say "created in and out folders in #{base}"
+      end
+
+    protected
+
+      def copy_config_template(path)
+        raise InputError, "File already exists: #{path}" if File.exist? path
+        content = File.read template
+        File.deep_write path, content
+        say "saved #{path}"
+      end
+
+      def template
+        @template ||= File.expand_path "../../sample.yml", __dir__
+      end
+
+    end
+  end
+end

data/lib/voicemaker/commands/project_command.rb

@@ -0,0 +1,72 @@
+module Voicemaker
+  module Commands
+    class ProjectCommand < Base
+      help "Create multiple audio files"
+
+      usage "voicemaker project PATH [--debug]"
+      usage "voicemaker project (-h|--help)"
+
+      param "PATH", "Path to the project directory"
+
+      option "--debug", "Show API parameters"
+
+      api_environment
+
+      example "voicemaker project sample-project"
+
+      def run
+        text_files.each do |file|
+          text = File.read file
+          tts.params.text = text
+          audio_file = File.basename(file, '.txt') + ".#{tts.params.output_format}"
+          output_path = "#{outdir}/#{audio_file}"
+
+          say "in:  !txtblu!#{file}"
+          say "url: !txtblu!#{tts.url}"
+          say "out: !txtblu!#{output_path}"
+          show_details tts if args['--debug']
+
+          tts.save output_path
+          say "---"
+        end
+      end
+
+    private
+
+      def tts
+        @tts ||= Voicemaker::TTS.new **config
+      end
+
+      def show_details(tts, output: nil)
+        lp tts.params.api_params
+      end
+
+      def text_files
+        @text_files ||= Dir["#{indir}/*.txt"]
+      end
+
+      def config
+        @config ||= begin
+          raise InputError, "Cannot find config file: #{config_path}" unless File.exist? config_path
+          YAML.load_file(config_path).transform_keys &:to_sym
+        end
+      end
+
+      def config_path
+        "#{project_dir}/config.yml"
+      end
+
+      def project_dir
+        args['PATH']
+      end
+
+      def indir
+        "#{project_dir}/in"
+      end
+
+      def outdir
+        "#{project_dir}/out"
+      end
+    end
+  end
+end

data/lib/voicemaker/commands/tts_command.rb

@@ -0,0 +1,90 @@
+module Voicemaker
+  module Commands
+    class TTSCommand < Base
+      help "Generate audio files from text"
+
+      usage "voicemaker tts [options]"
+      usage "voicemaker tts (-h|--help)"
+
+      option "-v --voice NAME", "Voice ID or Webname"
+      option "-t --text TEXT", "Text to say"
+      option "-f --file PATH", "Load text from file"
+      option "-c --config PATH", "Use a YAML configuration file"
+      option "-s --save PATH", <<~EOF
+        Save audio file.
+        If not provided, a URL to the audio file will be printed instead.
+        When used with the --config option, omit the file extension, as it will be determined based on the config file.
+      EOF
+      option "-d --debug", "Show API parameters"
+
+      api_environment
+
+      example %q[voicemaker tts --voice ai3-Jony --text "Hello world" --save out.mp3]
+      example %q[voicemaker tts -v ai3-Jony --file hello.txt --save out.mp3]
+      example %q[voicemaker tts --config english-female.yml -f text.txt -s outfile]
+
+      def run
+        verify_args
+        tts = Voicemaker::TTS.new **tts_params
+        say "url: !txtblu!#{tts.url}"
+
+        if output_file
+          tts.save output_file
+          say "out: !txtblu!#{output_file}"
+        end
+        
+        show_details tts if args['--debug']
+      end
+
+    private
+
+      def show_details(tts, output: nil)
+        lp tts.params.api_params
+      end
+
+      def verify_args
+        raise InputError, "Please provide either --config or --voice" unless args['--config'] || args['--voice']
+        raise InputError, "Please provide either --text or --file" unless args['--text'] || args['--file']
+      end
+
+      def voice
+        args['--voice']
+      end
+
+      def text
+        args['--text'] || text_from_file
+      end
+
+      def output_file
+        args['--save']
+      end
+
+      def tts_params
+        result = if config
+          YAML.load_file(config).transform_keys &:to_sym
+        else
+          {}
+        end
+
+        result[:voice] = voice if voice
+        result[:text] = text
+        result[:output_format] = File.extname(output_file)[1..] if output_file
+        result
+      end
+
+      def config
+        if args['--config']
+          raise InputError, "Cannot find config file #{args['--config']}" unless File.exist? args['--config']
+          args['--config']
+        end
+      end
+
+      def text_from_file
+        path = args['--file']
+        raise InputError, "Cannot find text file: #{path}" unless File.exist? path
+        File.read path
+      end
+
+    end
+  end
+end

data/lib/voicemaker/commands/voices_command.rb

@@ -0,0 +1,63 @@
+module Voicemaker
+  module Commands
+    class VoicesCommand < Base
+      help "Get a list of available voices"
+
+      usage "voicemaker voices [--save PATH --count --verbose] [SEARCH...]"
+      usage "voicemaker voices (-h|--help)"
+
+      option "-s --save PATH", "Save output to output YAML file"
+      option "-v --verbose", "Show the full voices data structure"
+      option "-c --count", "Add number of voices to the result"
+
+      param "SEARCH", "Provide one or more text strings to search for (case insensitive AND search)"
+
+      api_environment
+
+      example "voicemaker voices en-us"
+      example "voicemaker voices --save out.yml en-us"
+      example "voicemaker voices en-us female"
+      example "voicemaker voices en-us --verbose"
+
+      def run
+        result = voices.search *args['SEARCH']
+        result['count'] = result.count if args['--count'] and args['--verbose']
+        send_output result
+      end
+
+    private
+
+      def voices
+        @voices ||= Voicemaker::Voices.new
+      end
+
+      def send_output(data)
+        save = args['--save']
+        if save
+          say "saved #{save}"
+          File.write save, args['--verbose'] ? data.to_yaml : compact(data)
+        elsif args['--verbose']
+          lp data
+        else
+          puts compact(data)
+        end
+      end
+
+      def compact(data)
+        result = data.values.map do |v|
+          [
+            v['VoiceId'].ljust(16),
+            # v['VoiceWebname'].ljust(10),
+            v['Language'],
+            v['VoiceGender'].ljust(10),
+            v['Engine']
+          ].join "\t"
+        end
+
+        result.push "count: #{data.count}" if args['--count']
+        result.join "\n"
+      end
+
+    end
+  end
+end

data/lib/voicemaker/extensions/file.rb

@@ -0,0 +1,11 @@
+require "fileutils"
+
+class File
+  class << self
+    def deep_write(file, content)
+      dir = File.dirname file
+      FileUtils.mkdir_p dir unless Dir.exist? dir
+      File.write file, content
+    end
+  end
+end

data/lib/voicemaker/tts.rb

@@ -0,0 +1,24 @@
+require 'down'
+
+module Voicemaker
+  class TTS
+    attr_reader :params
+
+    def initialize(params = {})
+      @params = TTSParams.new params
+    end
+
+    # Returns the URL for the generated file
+    def url
+      response = API.post "api", params.api_params
+      url = response['path']
+      raise BadResponse, "Received empty URL: #{response}" unless url
+      url
+    end
+
+    # Saves the audio file
+    def save(outpath)
+      Down.download url, destination: outpath
+    end
+  end
+end

data/lib/voicemaker/tts_params.rb

@@ -0,0 +1,90 @@
+require 'down'
+
+module Voicemaker
+  # Provides normalized access to all parameters needed for the TTS endpoint,
+  # including the auto identification of the Engine and Language based on
+  # voice ID, and including sensible defaults.
+  class TTSParams
+    attr_reader :input_params
+    attr_writer :text, :voice, :output_format, :effect, :sample_rate,
+      :master_speed, :master_volume, :master_pitch
+
+    def initialize(input_params = {})
+      @input_params = input_params
+    end
+
+    def inspect
+      %Q[#<Voicemaker::TTSParams api_params="#{api_params}"]
+    end
+
+    def voice
+      @voice ||= find_voice || raise(InputError, "Missing or invalid parameter: voice")
+    end
+
+    def text
+      @text ||= input_params[:text] || raise(InputError, "Missing parameter: text")
+    end
+
+    def output_format
+      @output_format ||= input_params[:output_format] || 'mp3'
+    end
+
+    def effect
+      @effect ||= input_params[:effect] || 'default'
+    end
+
+    def sample_rate
+      @sample_rate ||= (input_params[:sample_rate] || 48000).to_s
+    end
+
+    def master_speed
+      @master_speed ||= (input_params[:master_speed] || 0).to_s
+    end
+
+    def master_volume
+      @master_volume ||= (input_params[:master_volume] || 0).to_s
+    end
+
+    def master_pitch
+      @master_pitch ||= (input_params[:master_pitch] || 0).to_s
+    end
+
+    def api_params
+      {
+        "Engine" => engine,
+        "VoiceId" => voice,
+        "LanguageCode" => language,
+        "OutputFormat" => output_format,
+        "SampleRate" => sample_rate,
+        "Effect" => effect,
+        "MasterSpeed" => master_speed,
+        "MasterVolume" => master_volume,
+        "MasterPitch" => master_pitch,
+        "Text" => text
+      }
+    end
+
+  protected
+
+    def engine
+      voice_params['Engine']
+    end
+
+    def language
+      voice_params['Language']
+    end
+
+    def find_voice
+      return nil unless input_params[:voice]
+      voices.find(input_params[:voice])&.dig 'VoiceId'
+    end
+
+    def voice_params
+      voices[voice] || raise(InputError, "Cannot find definition for voice: #{voice}")
+    end
+
+    def voices
+      @voices ||= Voices.new
+    end
+  end
+end

data/lib/voicemaker/version.rb

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

data/lib/voicemaker/voices.rb

@@ -0,0 +1,41 @@
+require 'forwardable'
+
+module Voicemaker
+  # Provides easy and cached access to the list of available voices.
+  class Voices
+    extend Forwardable
+    
+    # Enable some of the hash methods idrectly on the Voices object
+    def_delegators :all, :[], :count, :size, :first, :last, :select, :reject,
+      :map, :keys, :values, :each
+
+    # Returns all voices
+    def all
+      @all ||= begin
+        response = API.get "/list" 
+        result = response.dig 'data', 'voices_list'
+        raise BadResponse, "Unexpected response: #{response}" unless result
+        result.map { |voice| [voice['VoiceId'], voice] }
+          .sort_by { |_, v| v['VoiceId'] }.to_h
+      end
+    end
+
+    # Returns a filtered list of voices, with all queries partially included
+    # in the voice parameter values
+    def search(*queries)
+      queries = nil if queries&.empty?
+      return all unless queries
+
+      all.select do |key, data|
+        haystack = data.values.join(' ').downcase
+        queries.all? { |query| haystack.include? query.downcase }
+      end
+    end
+
+    # Returns a single voice, by Voice ID or Voice Webname
+    def find(id_or_webname)
+      all[id_or_webname] || all.find { |_, a| a['VoiceWebname'] == id_or_webname }&.last
+    end
+
+  end
+end

data/lib/voicemaker.rb

@@ -1,5 +1,9 @@
 require 'voicemaker/version'
 require 'voicemaker/exceptions'
+require 'voicemaker/extensions/file'
 require 'voicemaker/api'
+require 'voicemaker/voices'
+require 'voicemaker/tts_params'
+require 'voicemaker/tts'
 
 require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemaker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: lightly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: Easy to use API for Voicemaker.in TTS service, with a command line interface
 email: db@dannyben.com
 executables:
@@ -79,9 +93,17 @@ files:
 - lib/voicemaker.rb
 - lib/voicemaker/api.rb
 - lib/voicemaker/cli.rb
-- lib/voicemaker/command.rb
+- lib/voicemaker/commands/base.rb
+- lib/voicemaker/commands/new_command.rb
+- lib/voicemaker/commands/project_command.rb
+- lib/voicemaker/commands/tts_command.rb
+- lib/voicemaker/commands/voices_command.rb
 - lib/voicemaker/exceptions.rb
+- lib/voicemaker/extensions/file.rb
+- lib/voicemaker/tts.rb
+- lib/voicemaker/tts_params.rb
 - lib/voicemaker/version.rb
+- lib/voicemaker/voices.rb
 homepage: https://github.com/DannyBen/voicemaker
 licenses:
 - MIT

data/lib/voicemaker/command.rb

@@ -1,111 +0,0 @@
-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