ispeech 1.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+config/
+vendor/
+Gemfile.lock
+pkg/
+tmp/
+script/voice_enumerator.out

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENCE.txt

@@ -0,0 +1,21 @@
+Copyright 2012 Birkir A. Barkarson
+Standard MIT licence:
+
+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,88 @@
+Ruby interface to Ispeech's API for generating speech from text. 
+More info on their API at http://www.ispeech.org/api/
+
+## Installation
+
+    gem install ispeech
+
+## Loading
+  
+    require 'ispeech'
+
+## Config
+
+  Automatically looks for a config/ispeech.yml file.
+  Configuration only requires the 'api_key'
+
+### Manual configuration
+
+    Ispeech.config = Ispeech::Config.new('some_api_key_hash')
+
+  or
+
+    Ispeech.config = Ispeech::Config.read(path_to_my_own_yaml_config_file)
+
+## Usage
+
+  Get the voice service object:
+
+    service = Ispeech.voice_service 
+
+  or 
+  
+    service = Ispeech::VoiceService.new(my_config_object)
+
+### Generate sounds 
+
+    response = service.generate_sound('speak this text', language_or_voice_options)
+ 
+  or
+
+    response = service.generate_with_voice('speak this text', my_voice_object)
+
+
+### Language and voice options
+
+  All available voices are defined in [voices/default.rb](https://github.com/birkirb/ispeech/blob/master/lib/ispeech/voices/default.rb)
+
+  You can specificy language, gender, voice name in any combination
+
+    response = service.generate_sound('speak this text', {:language => :en, :gender => :male, :speaker => :usenglishfemale})
+
+  If you have access to different set of voice there are rake tasks to generate a different voice map and any customization of the voice map should be easy.
+  Refer to the spec for details of that.
+
+### Saving generated sounds
+
+  The response is saved to a tempfile which can be moved, copied or otherwise streamed.
+
+    response = service.generate_sound('speak this text')
+    tempfile = response.download_to_tempfile
+    
+    FileUtils.mv(tempfile.path, 'speak_this_text.mp3')
+
+## Mocking
+  
+  For convinence purposes you can use an inbuilt mock to avoid web request while testing.
+
+    require 'ispeech/mock'
+    Ispeech::Mock.enable!
+
+### Turning off
+
+    Ispeech::Mock.disable!
+
+### Expectations
+
+  Only two expectations can be set
+
+    Ispeech::VoiceService.expect_ok_response
+
+  or
+
+    Ispeech::VoiceService.expect_error_response
+
+
+## Copyright
+
+Copyright (c) 2012 Birkir A. Barkarson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'ispeech/constants'
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = ["-fd", "-c"]
+end
+
+namespace :generate do
+  desc "Generates MP3 with test strings for all voices."
+  task :test_voices do
+    exec('ruby -I lib script/test_voices.rb')
+  end
+
+  desc "Generate default voice class based on a voice list retrieved from iSpeech's API"
+  task :default_voices_class do
+    exec('ruby -I lib script/create_voices.rb')
+  end
+end
+
+desc "Clean up generated and downloaded files"
+task :clean do
+  include Ispeech::Scripts
+  FileUtils.rm_rf(LOCAL_TEMP_DIR)
+  FileUtils.rm(VOICES_ENUMERATOR_FILE) rescue nil
+end
+
+task :default => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'ispeech'

data/ispeech.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ispeech/constants"
+
+Gem::Specification.new do |s|
+  s.name        = "ispeech"
+  s.version     = Ispeech::VERSION
+  s.authors     = ["Birkir A. Barkarson"]
+  s.email       = ["birkirb@stoicviking.net"]
+  s.homepage    = "https://github.com/birkirb/ispeech"
+  s.summary     = %q{Generate speech from the ispeech text to voice service.}
+  s.description = %q{Ruby interface to Ispeech's API for generating speech from text. More info at http://www.ispeech.org/api/}
+
+  s.rubyforge_project = "ispeech"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("backports")
+  s.add_development_dependency("rspec", '>= 2.6.0')
+  s.add_development_dependency("mocha", '>= 0.9.0')
+  s.add_development_dependency("webmock", '>= 1.8.0')
+end

data/lib/ispeech.rb

@@ -0,0 +1,31 @@
+require 'ispeech/error'
+require 'ispeech/config'
+require 'ispeech/voices/default'
+require 'ispeech/voice'
+require 'ispeech/constants'
+require 'ispeech/response'
+require 'ispeech/voice_service'
+
+if RUBY_VERSION < "1.9"
+  require 'backports'
+end
+
+module Ispeech
+
+  def self.config
+    @@config ||= Ispeech::Config.read rescue nil
+  end
+
+  def self.config=(config)
+    if config.is_a?(Ispeech::Config)
+      @@config = config
+    else
+      raise Error.new("Ispeech configuration required. Not #{config.class}")
+    end
+  end
+
+  def self.voice_service
+    VoiceService.new(config)
+  end
+
+end

data/lib/ispeech/config.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+require 'uri'
+
+module Ispeech
+  class Config
+    attr_reader :api_key,
+                :target_url
+
+    DEFAULT_TARGET_URL = 'http://api.ispeech.org/api/rest'
+
+    def initialize(api_key, target_url = nil)
+      @api_key = api_key
+      @target_url = URI.parse(target_url || DEFAULT_TARGET_URL)
+    end
+
+    def self.read(config_file = nil)
+      config_file ||= File.join('config', 'ispeech.yml')
+      begin
+        yaml = YAML.load_file(config_file)
+        self.new(yaml['api_key'], yaml['target_url'])
+      rescue => err
+        raise Error.new("Failed to read configuration file", err)
+      end
+    end
+
+  end
+end

data/lib/ispeech/constants.rb

@@ -0,0 +1,19 @@
+require 'uri'
+
+module Ispeech
+
+  VERSION = "1.0.1"
+
+  class Voice
+    QUALITY_LOW = 8000
+    QUALITY_HIGH = 22050
+    GENDER_FEMALE = :female
+    GENDER_MALE = :male
+  end
+
+  module Scripts
+    LOCAL_TEMP_DIR = 'tmp'
+    VOICES_ENUMERATOR_FILE = File.join('tmp', 'voice_enumerator.out')
+  end
+
+end

data/lib/ispeech/error.rb

@@ -0,0 +1,33 @@
+module Ispeech
+
+  class Error < StandardError
+    attr_accessor :original_error
+
+    def initialize(message, original_error = nil)
+      super(message)
+      @original_error = original_error
+    end
+
+    def to_s
+      if @original_error.nil?
+        super
+      else
+        "#{super}\nCause: #{@original_error.to_s}"
+      end
+    end
+  end
+
+  class ServiceError < Error
+    attr_accessor :code
+
+    def initialize(message, code = '')
+      super(message)
+      @code = code
+    end
+
+    def to_s
+      "Code: #{code}, Message: #{super}"
+    end
+  end
+
+end

data/lib/ispeech/mock.rb

@@ -0,0 +1,93 @@
+module Ispeech
+  module Mock
+
+    RESPONSE_MP3_FILE = File.join(File.dirname(__FILE__), '..', '..', 'spec', 'test_data', 'test_file.mp3')
+    FAKE_ERROR = Error.new("The mock wants you to fail!")
+    EMPTY_PROC = proc {}
+
+    def self.enable!
+      Ispeech::Response.class_eval(<<-EVAL, __FILE__, __LINE__)
+        def download_to_tempfile
+          download_to_tempfile_with_mock
+        end
+        def initialize(response)
+          initialize_with_fake_response
+        end
+      EVAL
+      Ispeech::VoiceService.class_eval(<<-EVAL, __FILE__, __LINE__)
+        def post(params)
+          post_with_set_response(params)
+        end
+      EVAL
+    end
+
+    def self.disable!
+      Ispeech::Response.class_eval(<<-EVAL, __FILE__, __LINE__)
+        def download_to_tempfile
+          download_to_tempfile_without_mock
+        end
+        def initialize(response)
+          initalize_without_fake_response(response)
+        end
+      EVAL
+      Ispeech::VoiceService.class_eval(<<-EVAL, __FILE__, __LINE__)
+        def post(params)
+          post_without_set_response(params)
+        end
+      EVAL
+    end
+
+  end
+end
+
+module Ispeech
+  class Response
+
+    private
+
+    alias :download_to_tempfile_without_mock :download_to_tempfile
+    alias :initalize_without_fake_response :initialize
+
+    def download_to_tempfile_with_mock
+      tempfile = Tempfile.new(SecureRandom.uuid)
+      File.open(Mock::RESPONSE_MP3_FILE) do |f|
+        tempfile.write(f.read)
+        tempfile.flush
+      end
+      tempfile
+    end
+
+    def initialize_with_fake_response
+      VoiceService.expected_response.call
+    end
+
+  end
+end
+
+module Ispeech
+  class VoiceService
+
+    @@expected_response = Mock::EMPTY_PROC
+
+    def self.expected_response
+      @@expected_response
+    end
+
+    def self.expect_ok_response
+      @@expected_response = Mock::EMPTY_PROC
+    end
+
+    def self.expect_error_response
+      @@expected_response = proc { raise Mock::FAKE_ERROR }
+    end
+
+    private
+
+    alias :post_without_set_response :post
+
+    def post_with_set_response(params)
+      self.class.expected_response
+    end
+
+  end
+end

data/lib/ispeech/response.rb

@@ -0,0 +1,45 @@
+require 'cgi'
+require 'net/http'
+require 'tempfile'
+require 'securerandom'
+
+module Ispeech
+  class Response
+
+    RESPONSE_ERROR_MESSAGE = 'message'
+    RESPONSE_ERROR_CODE = 'code'
+    ERROR_UNEXPECTED_RESPONSE = Error.new("Response was not a valid HTTP response.")
+
+    def initialize(response)
+      if response.is_a?(Net::HTTPResponse)
+        if 200 == response.code.to_i
+          @response = response
+        else
+          if response.content_length.to_i > 0
+            params = CGI::parse(response.body)
+            raise ServiceError.new(params[RESPONSE_ERROR_MESSAGE].first, params[RESPONSE_ERROR_CODE].first)
+          else
+            raise ServiceError.new(response.code_type, response.code)
+          end
+        end
+      else
+        raise ERROR_UNEXPECTED_RESPONSE
+      end
+    end
+
+    def download_to_tempfile
+      content = generated_file
+      file = Tempfile.new(SecureRandom.uuid)
+      file.write(content)
+      file.flush
+      file # Leaving open. Will be closed once object is finalized.
+    end
+
+    private
+
+    def generated_file
+      @response.body
+    end
+
+  end
+end