ispeech 1.0.1

data/spec/ispeech/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Ispeech::Config, 'When created' do
+
+  default_config = YAML.load_file('config/ispeech.yml')
+  default_config['api_key'].should_not == nil
+
+  context 'with a given api_key' do
+    it 'should report those and other default values' do
+      config = Ispeech::Config.new(default_config['api_key'])
+      config.target_url.should == URI.parse(Ispeech::Config::DEFAULT_TARGET_URL)
+      config.api_key.should == default_config['api_key']
+    end
+  end
+
+  context 'from a config file' do
+    it 'should default to the local config/ispeech.yml' do
+      config = Ispeech::Config.read
+      config.api_key.should == default_config['api_key']
+    end
+
+    it 'should accept an arbitary config file argument' do
+      config = Ispeech::Config.read(test_config)
+      config.api_key.should_not be_nil
+      config.api_key.should_not == default_config['api_key']
+    end
+  end
+
+end

data/spec/ispeech/mock_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'ispeech/mock'
+
+describe Ispeech::Mock do
+
+  before(:each) do
+    Ispeech::Mock.enable!
+  end
+
+  after(:each) do
+    Ispeech::VoiceService.expect_ok_response
+    Ispeech::Mock.disable!
+  end
+
+  context 'When mock is on' do
+    text_string = 'This is a test'
+    service = Ispeech::VoiceService.new
+
+    it 'it should default to giving an working response without net access' do
+      response = service.generate_sound(text_string)
+
+      file = response.download_to_tempfile
+      file.should be_kind_of(Tempfile)
+      file.rewind
+      contents = file.read
+      file.close
+      contents.should == File.read(RESPONSE_TEST_FILE)
+
+      WebMock.should_not have_requested(:any, service.config.target_url.to_s)
+    end
+
+    it 'it should give an error response when that expectation has been set' do
+      Ispeech::VoiceService.expect_error_response
+
+      expect do
+        service.generate_sound(text_string)
+      end.to raise_error(Ispeech::Mock::FAKE_ERROR)
+
+      WebMock.should_not have_requested(:any, service.config.target_url.to_s)
+    end
+
+    it 'once set to an error and set back to ok should not raise an error' do
+      Ispeech::VoiceService.expect_error_response
+      Ispeech::VoiceService.expect_ok_response
+
+      expect do
+        service.generate_sound(text_string)
+      end.to_not raise_error
+
+      WebMock.should_not have_requested(:any, service.config.target_url.to_s)
+    end
+  end
+
+end

data/spec/ispeech/response_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'cgi'
+
+describe Ispeech::Response do
+
+  it 'should throw an error when created with bogus parameters' do
+    expect do
+      Ispeech::Response.new('take this!')
+    end.to raise_error(Ispeech::Error, Ispeech::Response::ERROR_UNEXPECTED_RESPONSE.message)
+  end
+
+  it 'should download and return a tempfile with the object contained in the response' do
+    service_url = URI.parse('http://somewhere.com/api')
+    stub_ok_response_for_url(service_url)
+    service_response = Net::HTTP.get_response(service_url)
+
+    response = Ispeech::Response.new(service_response)
+
+    file = response.download_to_tempfile
+    file.should be_kind_of(Tempfile)
+    file.rewind
+    contents = file.read
+    file.close
+    contents.should == File.read(RESPONSE_TEST_FILE)
+  end
+
+  it 'should raise an error when file download fails with non 200 response' do
+    expect do
+      Ispeech::Response.new(Net::HTTPNotFound.new("Body?", 404, "Something went wrong."))
+     end.to raise_error(Ispeech::Error)
+  end
+
+end

data/spec/ispeech/voice_service_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Ispeech::VoiceService do
+
+  text_string = 'This is a test'
+
+  context 'When create without parameters' do
+    service = Ispeech::VoiceService.new
+
+    it 'should use the default config' do
+      service.config.should be_kind_of(Ispeech::Config)
+      service.config.should == Ispeech.config
+    end
+
+    it 'should allow generation of MP3 sound' do
+      if USE_MOCKS
+        stub_ok_response(service)
+      end
+
+      sound_url = service.generate_sound(text_string, :language => :en)
+      sound_url.should be_kind_of(Ispeech::Response)
+    end
+  end
+
+  it 'should throw an error when created with nil config' do
+    expect do
+      service = Ispeech::VoiceService.new(nil)
+    end.to raise_error(Ispeech::Error, Ispeech::VoiceService::ERROR_MISSING_CONFIG.message)
+  end
+
+  context 'When created with config with invalid api_key' do
+    service = Ispeech::VoiceService.new(Ispeech::Config.read(test_config))
+
+    it 'should raise the reported access error' do
+       if USE_MOCKS
+        stub_invalid_access_response(service)
+       end
+
+       expect do
+         service.generate_sound(text_string, :language => :en)
+       end.to raise_error(Ispeech::ServiceError, /Code: 1, Message: Invalid API key/)
+    end
+  end
+
+  context 'When generating sound' do
+    service = Ispeech::VoiceService.new
+
+    it 'should allow low quality setting' do
+      if USE_MOCKS
+        stub_ok_response(service).with(:body => hash_including(:voice => DEFAULT_ENGLISH_FEMALE_TEST_VOICES.first))
+        service.generate_sound(text_string, :speaker => DEFAULT_ENGLISH_FEMALE_TEST_VOICES.first, :quality => :low)
+      else
+        pending("Without mock, the returned file quality needs to be confirmed")
+      end
+    end
+
+    it 'should allow custom voice setting' do
+      if USE_MOCKS
+        stub_ok_response(service).with(:body => hash_including(:voice => 'johnny'))
+        voice = Ispeech::Voice.new('johnny', :male, 'en')
+        service.generate_with_voice(text_string, voice)
+      else
+        pending("Without mock, the returned file quality needs to be confirmed")
+      end
+    end
+  end
+
+end

data/spec/ispeech/voice_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe Ispeech::Voice do
+
+  context 'When created' do
+    speaker_name = 'tom'
+    test_voice = Ispeech::Voice.new(speaker_name, Ispeech::Voice::GENDER_FEMALE)
+
+    it 'with name and gender should report default values' do
+      test_voice.speaker.should == speaker_name
+      test_voice.gender.should == Ispeech::Voice::GENDER_FEMALE
+      test_voice.quality.should == Ispeech::Voice::QUALITY_HIGH
+      test_voice.languages.should be_kind_of(Set)
+      test_voice.languages.should be_empty
+      test_voice.language.should be_nil
+      test_voice.id.should == "#{speaker_name}"
+    end
+
+    it 'should allow flipping quality setting' do
+      test_voice.low_quality!
+      test_voice.quality.should == Ispeech::Voice::QUALITY_LOW
+      test_voice.high_quality!
+      test_voice.quality.should == Ispeech::Voice::QUALITY_HIGH
+    end
+  end
+
+  context 'With a set of defined voices' do
+    it 'should throw an error if the voice does not exist' do
+      expect do
+        Ispeech::Voice.named_voice('Birkir')
+      end.to raise_error(Ispeech::Error, "Voice does not exist.")
+    end
+
+    it 'should return the active voice map' do
+      Ispeech::Voice.map.should == Ispeech::Voices::PER_LANGUAGE
+    end
+
+    context 'should find a voice' do
+      it 'given an existing speaker name' do
+        voice = Ispeech::Voice.named_voice(DEFAULT_ENGLISH_FEMALE_TEST_VOICES.first)
+        voice.speaker.should == DEFAULT_ENGLISH_FEMALE_TEST_VOICES.first
+        voice.language.should == 'en'
+        voice.gender.should == Ispeech::Voice::GENDER_FEMALE
+        voice.languages.to_a.should == ['en']
+        voice.id.should == DEFAULT_ENGLISH_FEMALE_TEST_VOICES.first
+      end
+
+      it 'given an existing speaker name in lower case' do
+        voice = Ispeech::Voice.named_voice('bruno')
+        voice.speaker.should == 'Bruno'
+        voice.gender.should == Ispeech::Voice::GENDER_MALE
+        voice.language.should == 'fr'
+      end
+
+      it 'given an existing speaker name as a symbol' do
+        voice = Ispeech::Voice.named_voice(:rosa)
+        voice.speaker.should == 'Rosa'
+        voice.gender.should == Ispeech::Voice::GENDER_FEMALE
+        voice.language.should == 'es'
+      end
+    end
+
+    context 'should extract a voice when given an option that' do
+      it 'specifies nothing, defaulting to English' do
+        voice = Ispeech::Voice.extract_from_options
+        (DEFAULT_ENGLISH_FEMALE_TEST_VOICES + DEFAULT_ENGLISH_MALE_TEST_VOICES).should include(voice.speaker)
+      end
+
+      it 'specifies a speaker' do
+        voice = Ispeech::Voice.extract_from_options(:speaker => 'antoine')
+        voice.speaker.should == 'Antoine'
+        voice.gender.should == Ispeech::Voice::GENDER_MALE
+        voice.language.should == 'fr'
+      end
+
+      it 'specifies a language' do
+        voice = Ispeech::Voice.extract_from_options(:language => :es)
+        voice.speaker.should == 'Rosa'
+      end
+
+      it 'specifies a language and no gender' do
+        voice = Ispeech::Voice.extract_from_options(:language => :fr)
+        voice.should_not be_nil
+        ['Antoine', 'Bruno'].should include(voice.speaker)
+      end
+
+      it 'specifies a language and gender' do
+        voice = Ispeech::Voice.extract_from_options(:language => :es, :gender => Ispeech::Voice::GENDER_FEMALE)
+        voice.speaker.should == 'Rosa'
+
+        voice = Ispeech::Voice.extract_from_options(:language => :es, :gender => Ispeech::Voice::GENDER_MALE)
+        voice.should be_nil
+      end
+    end
+  end
+
+  context 'Allows for voices to be overriden or changed' do
+    after(:each) do
+      Ispeech::Voice.reset_map
+    end
+
+    it 'should allow removing specific entries' do
+      Ispeech::Voice.map[:en][:male].first.should == DEFAULT_ENGLISH_MALE_TEST_VOICES.first
+      Ispeech::Voice.override_map(:en => nil)
+      Ispeech::Voice.map[:en].should be_nil
+    end
+
+    it 'should allow mapping one entry to another' do
+      Ispeech::Voice.map[:en][:male].first.should == DEFAULT_ENGLISH_MALE_TEST_VOICES.first
+      Ispeech::Voice.override_map(:en => :fr)
+      Ispeech::Voice.map[:en][:male].first.should == 'Antoine'
+    end
+
+    it 'should allow replacing an entry' do
+      Ispeech::Voice.map[:en][:male].first.should == DEFAULT_ENGLISH_MALE_TEST_VOICES.first
+      Ispeech::Voice.override_map(:en => {:male => ['Johnny']})
+      Ispeech::Voice.map[:en][:male].should == ['Johnny']
+      Ispeech::Voice.map[:en][:female].first.should == DEFAULT_ENGLISH_FEMALE_TEST_VOICES.first
+    end
+
+    it 'should allow adding an entry' do
+      Ispeech::Voice.map[:is].should be_nil
+      Ispeech::Voice.override_map(:is => {:male => ['Birkir'], :female => ['Harpa']})
+      Ispeech::Voice.map[:is][:male].first.should == 'Birkir'
+      Ispeech::Voice.map[:is][:female].first.should == 'Harpa'
+    end
+  end
+end

data/spec/ispeech_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Ispeech do
+  it 'should reference a config file' do
+    config = Ispeech.config
+
+    config.should_not be_nil
+    config.should be_a_kind_of(Ispeech::Config)
+  end
+
+  it 'should allow setting of the config file' do
+    default_config = Ispeech.config
+
+    begin
+      test_config = Ispeech::Config.read(test_config)
+
+      Ispeech.config = test_config
+      Ispeech.config.should == test_config
+    ensure
+      Ispeech.config = default_config
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,69 @@
+RESPONSE_TEST_FILE = File.join('spec', 'test_data', 'test_file.mp3')
+DEFAULT_ENGLISH_FEMALE_TEST_VOICES = ["usenglishfemale", "auenglishfemale"]
+DEFAULT_ENGLISH_MALE_TEST_VOICES = ["usenglishmale"]
+USE_MOCKS = true
+CONFIG_DIR = 'config'
+CONFIG_FILE = File.join(CONFIG_DIR, 'ispeech.yml')
+DEFAULT_CONFIG_FILE = <<-YAML
+api_key: 'developerdemokeydeveloperdemokey'
+YAML
+
+def create_missing_config_file
+  unless File.exists?(CONFIG_FILE)
+    Dir.mkdir(CONFIG_DIR)
+    File.open(CONFIG_FILE, 'w') do |f|
+      f.write(DEFAULT_CONFIG_FILE)
+    end
+  end
+end
+
+create_missing_config_file
+
+require File.join(File.dirname(__FILE__), '..', 'init')
+require 'bundler'
+Bundler.require(:development)
+require 'webmock/rspec'
+
+if USE_MOCKS
+  WebMock.disable_net_connect!
+else
+  WebMock.allow_net_connect!
+end
+
+def silence_warnings
+  begin
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end
+
+# Some test voices.
+silence_warnings do
+  Ispeech::Voices::PER_LANGUAGE = {
+    :en => {:female => DEFAULT_ENGLISH_FEMALE_TEST_VOICES, :male => DEFAULT_ENGLISH_MALE_TEST_VOICES},
+    :es => {:female => ["Rosa"], :male => []},
+    :fr => {:female => [], :male => ["Antoine", "Bruno"]},
+  }
+end
+
+# Helper methods
+
+def test_config
+  File.join('spec', 'test_data', 'test_config.yml')
+end
+
+def stub_invalid_access_response(service)
+  body_string = "result=error&code=1&message=Invalid+API+key"
+  stub_request(:any, service.config.target_url.to_s).to_return(:headers => {:content_length => body_string.size}, :body => body_string, :status => 202)
+end
+
+def stub_ok_response_for_url(target_url)
+  body_string = File.new(RESPONSE_TEST_FILE)
+  stub_request(:any, target_url.to_s).to_return(:headers => {:content_length => body_string.size}, :body => body_string, :status => 200)
+end
+
+def stub_ok_response(service)
+  stub_ok_response_for_url(service.config.target_url)
+end

data/spec/test_data/test_config.yml

@@ -0,0 +1 @@
+api_key: 'TEST_KEY'

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ispeech
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Birkir A. Barkarson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Ruby interface to Ispeech's API for generating speech from text. More
+  info at http://www.ispeech.org/api/
+email:
+- birkirb@stoicviking.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- init.rb
+- ispeech.gemspec
+- lib/ispeech.rb
+- lib/ispeech/config.rb
+- lib/ispeech/constants.rb
+- lib/ispeech/error.rb
+- lib/ispeech/mock.rb
+- lib/ispeech/response.rb
+- lib/ispeech/voice.rb
+- lib/ispeech/voice_service.rb
+- lib/ispeech/voices/default.rb
+- script/create_voices.rb
+- script/test_voices.rb
+- spec/ispeech/config_spec.rb
+- spec/ispeech/mock_spec.rb
+- spec/ispeech/response_spec.rb
+- spec/ispeech/voice_service_spec.rb
+- spec/ispeech/voice_spec.rb
+- spec/ispeech_spec.rb
+- spec/spec_helper.rb
+- spec/test_data/test_config.yml
+- spec/test_data/test_file.mp3
+homepage: https://github.com/birkirb/ispeech
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ispeech
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generate speech from the ispeech text to voice service.
+test_files: []
+has_rdoc: