win32-sapi 0.1.4 → 0.1.5

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.1.5 - 10-Aug-2009
+* Changed license to Artistic 2.0.
+* Some gemspec updates, including license and description.
+* Changed test and example file names.
+* Added some class level comments within the source file.
+
 == 0.1.4 - 29-Jul-2007
 * Added a Rakefile with tasks for installation and testing.
 * Removed the install.rb file. The Rakefile now handles installation.

data/MANIFEST

@@ -3,6 +3,6 @@
 * MANIFEST
 * Rakefile
 * win32-sapi.gemspec
-* examples/sapi5_test.rb
+* examples/example_sapi5.rb
 * lib/win32/sapi5.rb
-* test/tc_sapi5.rb
+* test/test_win32_sapi5.rb

data/README

@@ -1,15 +1,18 @@
 == Description
-   This is a Ruby interface to the Microsoft Speech API, 5.1
+   This is a Ruby interface to the Microsoft Speech API, 5.x.
 	
 == Prerequisites
-   The Microsoft Speech API 5.1. It can be downloaded for free from 
+   The Microsoft Speech API 5.x. It can be downloaded for free from 
    http://www.microsoft.com/speech.
    
    Ruby 1.8.2 or later.
    
 == Installation
-   rake test (optional)
-   rake install (non-gem) or rake install_gem (gem)
+=== Gem Installation
+   gem install win32-sapi
+   
+=== Local Installation
+   rake install
 	
 == Synopsis
    require 'win32/sapi5'
@@ -20,17 +23,17 @@
 	
 == Constants
 SAPI5::VERSION
-	The current version of this package.
+	The current version of this library.
 	
 == Notes
-   This module is a simple interface to the Microsoft Speech API 5.1.  There
+   This module is a simple interface to the Microsoft Speech API 5.x.  There
    are interfaces to all of the Automation classes that this API consists of.
    Each class is a subclass of the SAPI5 class, which is in turn a subclass
    of WIN32OLE. With your object you can then call the available methods for
    that particular Automation class.
 
    This documentation won't offer the complete documentation for every method.
-   Instead, download the Microsoft Speech API 5.1 documentation (a .chm file)
+   Instead, download the Microsoft Speech API 5.x documentation (a .chm file)
    and read the part that covers 'Automation'.
 	
 == Known Bugs
@@ -42,16 +45,16 @@ SAPI5::VERSION
    library is based.
 	
 == Support
-   The Microsoft SAPI 5.1 SDK is supported on news://microsoft.public.speech_tech.sdk
+   The Microsoft SAPI 5.x SDK is supported on news://microsoft.public.speech_tech.sdk
 	
 == Future Plans
    Suggestions welcome.
 	
 == License
-   Ruby's
+   Artistic 2.0
 	
 == Copyright
-   (C) 2003-2007 Daniel J. Berger
+   (C) 2003-2009 Daniel J. Berger
    All Rights Reserved	
 	
 == Warranty
@@ -60,10 +63,5 @@ SAPI5::VERSION
    warranties of merchantability and fitness for a particular purpose.
 	
 == Author(s)
-   Daniel J. Berger
-   djberg96 at gmail dot com
-   imperator on IRC (irc.freenode.net)
-	
-   Park Heesob
-   phasis at nownuri dot net
-   phasis68 on IRC (irc.freenode.net)
+   Daniel J. Berger	
+   Park Heesob

data/Rakefile

@@ -1,22 +1,26 @@
 require 'rake'
 require 'rake/testtask'
 
-desc "Install the win32-sapi package (non-gem)"
+desc 'Install the win32-sapi library (non-gem)'
 task :install do
    dest = File.join(Config::CONFIG['sitelibdir'], 'win32')
    Dir.mkdir(dest) unless File.exists? dest
    cp 'lib/win32/sapi5.rb', dest, :verbose => true
 end
 
-desc "Install the win32-sapi package as a gem"
+desc 'Install the win32-sapi library as a gem'
 task :install_gem do
    ruby 'win32-sapi.gemspec'
    file = Dir["*.gem"].first
    sh "gem install #{file}"
 end
 
+desc 'Run the example program'
+task :example do
+   ruby '-Ilib examples/example_sapi5.rb'
+end
+
 Rake::TestTask.new do |t|
-   t.libs << 'lib'
    t.warning = true
-   t.test_files = FileList['test/tc*']
+   t.verbose = true
 end

data/examples/example_sapi5.rb

@@ -0,0 +1,13 @@
+#######################################################################
+# example_sapi5.rb
+#
+# This is a simple demonstration of the win32-sapi library. You can
+# run this code via the 'rake example' task.
+#
+# Modify as you see fit.
+#######################################################################
+require 'win32/sapi5'
+include Win32
+
+v = SpVoice.new
+v.Speak('Shall we play a game?')

data/lib/win32/sapi5.rb

@@ -1,4 +1,4 @@
-require "win32ole"
+require 'win32ole'
 
 # The Win32 module serves as a namespace only.
 module Win32
@@ -8,122 +8,189 @@ module Win32
    # registry. Look in HKLM\Software\Classes\CLSID.
    #++
 
-   # An abstract base class for the SAPI automation classes
+   # An abstract base class for the SAPI automation classes. You should not
+   # Win32::SAPI5 directly.
+   #
    class SAPI5 < WIN32OLE
-      VERSION = '0.1.4'
+      # The version of the win32-sapi library.
+      VERSION = '0.1.5'
    end
    
+   # The SpAudioFormat automation object represents an audio format.
+   #
    class SpAudioFormat < SAPI5
       def initialize
          super("{9EF96870-E160-4792-820D-48CF0649E4EC}")
       end
    end
    
+   # The SpCustomStream automation object supports the use of existing IStream
+   # objects in SAPI.
+   #
    class SpCustomStream < SAPI5
       def initialize
          super("{8DBEF13F-1948-4aa8-8CF0-048EEBED95D8}")
       end
    end
 
+   # The SpFileStream automation object enables data streams to be read and
+   # written as files.
+   #
    class SpFileStream < SAPI5
       def initialize
          super("{947812B3-2AE1-4644-BA86-9E90DED7EC91}")
       end
    end
    
+   # The SpInProcRecoContext automation object defines a recognition context.
+   # A recognition context is the primary means by which an application
+   # interacts with SAPI for speech recognition.
+   #
    class SpInProcRecoContext < SAPI5
       def initialize
          super("{73AD6842-ACE0-45E8-A4DD-8795881A2C2A}")
       end
    end
    
+   # The SpInProcRecognizer automation object represents a speech recognition
+   # engine.
+   #
    class SpInProcRecognizer < SAPI5
       def initialize
          super("{41B89B6B-9399-11D2-9623-00C04F8EE628}")
       end
    end
    
+   # The SpLexicon automation object provides access to lexicons. Lexicons
+   # contain information about words that can be recognized or spoken.
+   #
    class SpLexicon < SAPI5
       def initialize
          super("{0655E396-25D0-11D3-9C26-00C04F8EF87C}")
       end
    end
    
+   # The SpMemoryStream automation object supports audio stream operations in
+   # memory.
+   #
    class SpMemoryStream < SAPI5
       def initialize
          super("{5FB7EF7D-DFF4-468a-B6B7-2FCBD188F994}")
       end
    end
    
+   # The SpMMAudioIn automation object supports audio implementation for
+   # the standard Windows wave-in multimedia layer.
+   #
    class SpMMAudioIn < SAPI5
       def initialize
          super("{CF3D2E50-53F2-11D2-960C-00C04F8EE628}")
       end
    end
    
+   # The SpMMAudioIn automation object supports audio implementation for
+   # the standard Windows wave-out multimedia layer.
+   #
    class SpMMAudioOut < SAPI5
       def initialize
          super("{A8C680EB-3D32-11D2-9EE7-00C04F797396}")
       end
    end
    
+   # The SpObjectToken automation object represents an available resource
+   # of a type used by SAPI.
+   #
    class SpObjectToken < SAPI5
       def initialize
          super("{EF411752-3736-4CB4-9C8C-8EF4CCB58EFE}")
       end
    end
    
+   # The SpObjectTokenCategory automation object represents a class of object
+   # tokens. Object tokens are associated with specific folders in the Speech
+   # configuration database, and these folders are organized into categories,
+   # such as Recognizers, AudioInputs and Voices. An SpObjectTokenCategory
+   # object represents a single category of object tokens, and provides access
+   # to all the tokens within that category.
+   #
    class SpObjectTokenCategory < SAPI5
       def initialize
          super("{A910187F-0C7A-45AC-92CC-59EDAFB77B53}")
       end
    end
    
+   # The SpPhoneConverter automation object supports conversion between
+   # phoneme symbols and phoneme IDs.
+   #
    class SpPhoneConverter < SAPI5
       def initialize
          super("{9185F743-1143-4C28-86B5-BFF14F20E5C8}")
       end
    end
    
+   # The SpPhraseInfoBuilder automation object provides the ability to
+   # rebuild phrase information from audio data saved to memory.
+   #
    class SpPhraseInfoBuilder < SAPI5
       def initialize
          super("{C23FC28D-C55F-4720-8B32-91F73C2BD5D1}")
       end
    end
    
+   # The SpSharedRecoContext automation object defines a recognition context.
+   #
    class SpSharedRecoContext < SAPI5
       def initialize
          super("{47206204-5ECA-11D2-960F-00C04F8EE628}")
       end
    end
    
+   # The SpSharedRecognizer automation object represents a speech recognition
+   # engine.
+   #
    class SpSharedRecognizer < SAPI5
       def initialize
          super("{3BEE4890-4FE9-4A37-8C1E-5E7E12791C1F}")
       end
    end
    
+   # The SpTextSelectionInformation automation object provides access to the
+   # text selection information pertaining to a word sequence buffer.
+   #
    class SpTextSelectionInformation < SAPI5
       def initialize
          super("{0F92030A-CBFD-4AB8-A164-FF5985547FF6}")
       end
    end
    
+   # The SpUnCompressedLexicon automation object provides access to lexicons,
+   # which contain information about words that can be recognized or spoken.
+   #
    class SpUnCompressedLexicon < SAPI5
       def initialize
          super("{C9E37C15-DF92-4727-85D6-72E5EEB6995A}")
       end
    end
       
+   # The SpVoice object brings the text-to-speech (TTS) engine capabilities
+   # to applications using SAPI automation. An application can create numerous
+   # SpVoice objects, each independent of and capable of interacting with the
+   # others. An SpVoice object, usually referred to simply as a voice, is
+   # created with default property settings so that it is ready to speak
+   # immediately.
+   #
    class SpVoice < SAPI5
       def initialize
          super("{96749377-3391-11D2-9EE3-00C04F797396}")
       end
    end
    
+   # The SpWaveFormatEx automation object represents the format of
+   # waveform-audio data.
+   #
    class SpWaveFormatEx < SAPI5
       def initialize
          super("{C79A574C-63BE-44b9-801F-283F87F898BE}")
       end
    end
-end
+end

data/test/{tc_sapi5.rb → test_win32_sapi5.rb}

@@ -1,5 +1,5 @@
 #############################################################################
-# tc_sapi5.rb
+# test_win32_sapi5.rb
 #
 # Test suite for the sapi5 class.  For now, we're simply going to test that
 # the constructors work without incident.  There are simply too many methods
@@ -10,8 +10,8 @@
 #
 # You should run this test case via the 'rake test' Rake task.
 #############################################################################
-require "win32/sapi5"
-require "test/unit"
+require 'win32/sapi5'
+require 'test/unit'
 include Win32
 
 class TC_Win32_SAPI5 < Test::Unit::TestCase
@@ -19,7 +19,7 @@ class TC_Win32_SAPI5 < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal("0.1.4", SAPI5::VERSION)
+      assert_equal('0.1.5', SAPI5::VERSION)
    end
    
    def test_SpAudioFormat

data/win32-sapi.gemspec

@@ -1,23 +1,25 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   gem.name        = "win32-sapi"
-   gem.version     = "0.1.4"
-   gem.author      = "Daniel J. Berger"
-   gem.email       = "djberg96@gmail.com"
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
-   gem.platform    = Gem::Platform::RUBY
-   gem.summary     = "An interface to the MS SAPI (Sound API) library."
-   gem.description = "An interface to the MS SAPI (Sound API) library."
-   gem.test_file   = "test/tc_sapi5.rb"
-   gem.has_rdoc    = true
-   gem.files = Dir['lib/win32/*.rb'] + Dir['[A-Z]*']  + Dir['test/*']
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST']
+   gem.name      = 'win32-sapi'
+   gem.version   = '0.1.5'
+   gem.author    = 'Daniel J. Berger'
+   gem.license   = 'Artistic 2.0'
+   gem.email     = 'djberg96@gmail.com'
+   gem.homepage  = 'http://www.rubyforge.org/projects/win32utils'
+   gem.platform  = Gem::Platform::RUBY
+   gem.summary   = 'An interface to the MS SAPI (Sound API) library.'
+   gem.test_file = 'test/test_win32_sapi5.rb'
+   gem.has_rdoc  = true
+   gem.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'win32utils'
+   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+
+   gem.description = <<-EOF
+      The win32-sapi library provides an interface to the MS Windows sound
+      interface, otherwise known as SAPI, using OLE.
+   EOF
 end
 
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
-end
+Gem::Builder.new(spec).build

metadata

@@ -1,59 +1,64 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: win32-sapi
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
-date: 2007-07-30 00:00:00 -06:00
-summary: An interface to the MS SAPI (Sound API) library.
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: 
-description: An interface to the MS SAPI (Sound API) library.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.1.5
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-10 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: "      The win32-sapi library provides an interface to the MS Windows sound\n      interface, otherwise known as SAPI, using OLE.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
 files: 
-- lib/win32/sapi5.rb
 - CHANGES
-- CVS
-- examples
-- lib
+- examples/example_sapi5.rb
+- lib/win32/sapi5.rb
 - MANIFEST
 - Rakefile
 - README
-- test
+- test/test_win32_sapi5.rb
 - win32-sapi.gemspec
-- test/CVS
-- test/tc_sapi5.rb
-test_files: 
-- test/tc_sapi5.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- CHANGES
-- MANIFEST
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: win32utils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An interface to the MS SAPI (Sound API) library.
+test_files: 
+- test/test_win32_sapi5.rb