ruby_speech 1.0.2 → 1.1.0

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # [develop](https://github.com/benlangfeld/ruby_speech)
 
+# [1.1.0](https://github.com/benlangfeld/ruby_speech/compare/v1.0.2...v1.1.0) - [2013-03-02](https://rubygems.org/gems/ruby_speech/versions/1.1.0)
+  * Feature: NLSML building & parsing
+
 # [1.0.2](https://github.com/benlangfeld/ruby_speech/compare/v1.0.1...v1.0.2) - [2012-12-26](https://rubygems.org/gems/ruby_speech/versions/1.0.2)
   * Bugfix: Get test suite passing on JRuby
 

data/README.md

@@ -1,10 +1,12 @@
 # RubySpeech
-RubySpeech is a library for constructing and parsing Text to Speech (TTS) and Automatic Speech Recognition (ASR) documents such as [SSML](http://www.w3.org/TR/speech-synthesis) and [GRXML](http://www.w3.org/TR/speech-grammar/). The primary use case is for construction of these documents to be processed by TTS and ASR engines.
+RubySpeech is a library for constructing and parsing Text to Speech (TTS) and Automatic Speech Recognition (ASR) documents such as [SSML](http://www.w3.org/TR/speech-synthesis), [GRXML](http://www.w3.org/TR/speech-grammar/) and [NLSML](http://www.w3.org/TR/nl-spec/). Such documents can be constructed to be processed by TTS and ASR engines, parsed as the result from such, or used in the implementation of such engines.
 
 ## Installation
     gem install ruby_speech
 
 ## Library
+
+### SSML
 RubySpeech provides a DSL for constructing SSML documents like so:
 
 ```ruby
@@ -45,6 +47,7 @@ Once your `Speak` is fully prepared and you're ready to send it off for processi
 
 You may also then need to call `to_s`.
 
+### GRXML
 
 Construct a GRXML (SRGS) document like this:
 
@@ -103,7 +106,7 @@ which becomes
 </grammar>
 ```
 
-### Grammar matching
+#### Grammar matching
 
 It is possible to match some arbitrary input against a GRXML grammar. In order to do so, certain normalization routines should first be run on the grammar in order to prepare it for matching. These are reference inlining, tokenization and whitespace normalization, and are described [in the SRGS spec](http://www.w3.org/TR/speech-grammar/#S2.1). This process will transform the above grammar like so:
 
@@ -198,6 +201,111 @@ Matching against some sample input strings then returns the following results:
 => #<RubySpeech::GRXML::NoMatch:0x00000101371660>
 ```
 
+### NLSML
+
+[Natural Language Semantics Markup Language](http://www.w3.org/TR/nl-spec/) is the format used by many Speech Recognition engines and natural language processors to add semantic information to human language. RubySpeech is capable of generating and parsing such documents.
+
+It is possible to generate an NLSML document like so:
+
+```ruby
+require 'ruby_speech'
+
+nlsml = RubySpeech::NLSML.draw(grammar: 'http://flight', 'xmlns:myApp' => 'foo') do
+  interpretation confidence: 0.6 do
+    input "I want to go to Pittsburgh", mode: :speech
+
+    model do
+      group name: 'airline' do
+        string name: 'to_city'
+      end
+    end
+
+    instance do
+      self['myApp'].airline do
+        to_city 'Pittsburgh'
+      end
+    end
+  end
+
+  interpretation confidence: 0.4 do
+    input "I want to go to Stockholm"
+
+    model do
+      group name: 'airline' do
+        string name: 'to_city'
+      end
+    end
+
+    instance do
+      self['myApp'].airline do
+        to_city "Stockholm"
+      end
+    end
+  end
+end
+
+nlsml.to_s
+```
+
+becomes:
+
+```xml
+<?xml version="1.0"?>
+<result xmlns:myApp="foo" xmlns:xf="http://www.w3.org/2000/xforms" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Pittsburgh</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Stockholm</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+</result>
+```
+
+It's also possible to parse an NLSML document and extract useful information from it. Taking the above example, one may do:
+
+```ruby
+document = RubySpeech.parse nlsml.to_s
+
+document.match? # => true
+document.interpretations # => [
+      {
+        confidence: 0.6,
+        input: { mode: :speech, content: 'I want to go to Pittsburgh' },
+        instance: { airline: { to_city: 'Pittsburgh' } }
+      },
+      {
+        confidence: 0.4,
+        input: { content: 'I want to go to Stockholm' },
+        instance: { airline: { to_city: 'Stockholm' } }
+      }
+    ]
+document.best_interpretation # => {
+          confidence: 0.6,
+          input: { mode: :speech, content: 'I want to go to Pittsburgh' },
+          instance: { airline: { to_city: 'Pittsburgh' } }
+        }
+```
+
 Check out the [YARD documentation](http://rdoc.info/github/benlangfeld/ruby_speech/master/frames) for more
 
 ## Features:
@@ -226,6 +334,10 @@ Check out the [YARD documentation](http://rdoc.info/github/benlangfeld/ruby_spee
 * `<tag/>`
 * `<token/>`
 
+### NLSML
+* Document construction
+* Simple data extraction from documents
+
 ## TODO:
 ### SSML
 * `<lexicon/>`
@@ -236,11 +348,11 @@ Check out the [YARD documentation](http://rdoc.info/github/benlangfeld/ruby_spee
 * `<example/>`
 * `<lexicon/>`
 
-
 ## Links:
 * [Source](https://github.com/benlangfeld/ruby_speech)
 * [Documentation](http://rdoc.info/gems/ruby_speech/frames)
 * [Bug Tracker](https://github.com/benlangfeld/ruby_speech/issues)
+* [CI](https://travis-ci.org/#!/benlangfeld/ruby_speech)
 
 ## Note on Patches/Pull Requests
 

data/lib/ruby_speech.rb

@@ -15,8 +15,22 @@ module RubySpeech
     autoload :GenericElement
     autoload :SSML
     autoload :GRXML
+    autoload :NLSML
     autoload :XML
   end
+
+  def self.parse(string)
+    document = Nokogiri::XML.parse string, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS
+    namespace = document.root.namespace
+    case namespace && namespace.href
+    when SSML::SSML_NAMESPACE
+      SSML::Element.import string
+    when GRXML::GRXML_NAMESPACE
+      GRXML::Element.import string
+    when NLSML::NLSML_NAMESPACE, nil
+      NLSML::Document.new document
+    end
+  end
 end
 
 ActiveSupport::Autoload.eager_autoload!

data/lib/ruby_speech/nlsml.rb

@@ -0,0 +1,19 @@
+module RubySpeech
+  module NLSML
+    extend ActiveSupport::Autoload
+
+    NLSML_NAMESPACE   = 'http://www.w3c.org/2000/11/nlsml'
+    XFORMS_NAMESPACE  = 'http://www.w3.org/2000/xforms'
+
+    eager_autoload do
+      autoload :Builder
+      autoload :Document
+    end
+
+    def self.draw(options = {}, &block)
+      Builder.new(options, &block).document
+    end
+  end
+end
+
+ActiveSupport::Autoload.eager_autoload!

data/lib/ruby_speech/nlsml/builder.rb

@@ -0,0 +1,47 @@
+module RubySpeech
+  module NLSML
+    class Builder
+      attr_reader :document
+
+      def initialize(options = {}, &block)
+        options = {'xmlns' => NLSML_NAMESPACE, 'xmlns:xf' => XFORMS_NAMESPACE}.merge(options)
+        @document = Nokogiri::XML::Builder.new do |builder|
+          builder.result options do |r|
+            apply_block r, &block
+          end
+        end.doc
+      end
+
+      def interpretation(*args, &block)
+        if args.last.respond_to?(:has_key?) && args.last.has_key?(:confidence)
+          args.last[:confidence] = (args.last[:confidence] * 100).to_i
+        end
+        @result.send :interpretation, *args, &block
+      end
+
+      def model(*args, &block)
+        xf_namespaced_element :model, *args, &block
+      end
+
+      def instance(*args, &block)
+        xf_namespaced_element :instance, *args, &block
+      end
+
+      def method_missing(method_name, *args, &block)
+        @result.send method_name, *args, &block
+      end
+
+      private
+
+      def apply_block(result, &block)
+        @result = result
+        instance_eval &block
+      end
+
+      def xf_namespaced_element(element_name, *args, &block)
+        namespace = @result.send :[], 'xf'
+        namespace.send element_name, &block
+      end
+    end
+  end
+end

data/lib/ruby_speech/nlsml/document.rb

@@ -0,0 +1,116 @@
+require 'delegate'
+
+module RubySpeech
+  module NLSML
+    class Document < SimpleDelegator
+      def initialize(xml)
+        super
+        @xml = xml
+      end
+
+      def grammar
+        result['grammar']
+      end
+
+      def interpretations
+        interpretation_nodes.map do |interpretation|
+          interpretation_hash_for_interpretation interpretation
+        end
+      end
+
+      def best_interpretation
+        interpretation_hash_for_interpretation interpretation_nodes.first
+      end
+
+      def match?
+        interpretation_nodes.count > 0 && !nomatch? && !noinput?
+      end
+
+      def ==(other)
+        to_xml == other.to_xml
+      end
+
+      def noinput?
+        noinput_elements.any?
+      end
+
+      private
+
+      def nomatch?
+        nomatch_elements.count >= input_elements.count
+      end
+
+      def nomatch_elements
+        result.xpath 'ns:interpretation/ns:input/ns:nomatch|interpretation/input/nomatch', 'ns' => NLSML_NAMESPACE
+      end
+
+      def noinput_elements
+        result.xpath 'ns:interpretation/ns:input/ns:noinput|interpretation/input/noinput', 'ns' => NLSML_NAMESPACE
+      end
+
+      def input_elements
+        result.xpath 'ns:interpretation/ns:input|interpretation/input', 'ns' => NLSML_NAMESPACE
+      end
+
+      def input_hash_for_interpretation(interpretation)
+        input_element = interpretation.at_xpath '(ns:input|input)', 'ns' => NLSML_NAMESPACE
+        { content: input_element.content }.tap do |h|
+          h[:mode] = input_element['mode'].to_sym if input_element['mode']
+        end
+      end
+
+      def instance_hash_for_interpretation(interpretation)
+        instances = instance_elements interpretation
+        return unless instances.any?
+        element_children_key_value instances.first
+      end
+
+      def instances_collection_for_interpretation(interpretation)
+        instances = instance_elements interpretation
+        instances.map do |instance|
+          element_children_key_value instance
+        end
+      end
+
+      def instance_elements(interpretation)
+        interpretation.xpath '(xf:instance|ns:instance|instance)', 'xf' => XFORMS_NAMESPACE, 'ns' => NLSML_NAMESPACE
+      end
+
+      def element_children_key_value(element)
+        element.children.inject({}) do |acc, child|
+          acc[child.node_name.to_sym] = case child.children.count
+          when 0
+            child.content
+          when 1
+            if child.children.first.is_a?(Nokogiri::XML::Text)
+              child.children.first.content
+            else
+              element_children_key_value child
+            end
+          else
+            element_children_key_value child
+          end
+          acc
+        end
+      end
+
+      def interpretation_hash_for_interpretation(interpretation)
+        {
+          confidence: interpretation['confidence'].to_f/100,
+          input: input_hash_for_interpretation(interpretation),
+          instance: instance_hash_for_interpretation(interpretation),
+          instances: instances_collection_for_interpretation(interpretation)
+        }
+      end
+
+      def result
+        root
+      end
+
+      def interpretation_nodes
+        nodes = result.xpath '(ns:interpretation|interpretation)', 'ns' => NLSML_NAMESPACE
+        nodes.sort_by { |int| -int[:confidence].to_i }
+      end
+    end
+  end
+end

data/lib/ruby_speech/version.rb

@@ -1,3 +1,3 @@
 module RubySpeech
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/spec/ruby_speech/nlsml_spec.rb

@@ -0,0 +1,395 @@
+require 'spec_helper'
+
+describe RubySpeech::NLSML do
+  let :example_document do
+    '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" xmlns:xf="http://www.w3.org/2000/xforms" xmlns:myApp="foo" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Pittsburgh</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Stockholm</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+</result>
+    '''
+  end
+
+  describe 'drawing a document' do
+    let :expected_document do
+      Nokogiri::XML(example_document, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).to_xml
+    end
+
+    it "should allow building a document" do
+      document = RubySpeech::NLSML.draw(grammar: 'http://flight', 'xmlns:myApp' => 'foo') do
+        interpretation confidence: 0.6 do
+          input "I want to go to Pittsburgh", mode: :speech
+
+          model do
+            group name: 'airline' do
+              string name: 'to_city'
+            end
+          end
+
+          instance do
+            self['myApp'].airline do
+              to_city 'Pittsburgh'
+            end
+          end
+        end
+
+        interpretation confidence: 0.4 do
+          input "I want to go to Stockholm"
+
+          model do
+            group name: 'airline' do
+              string name: 'to_city'
+            end
+          end
+
+          instance do
+            self['myApp'].airline do
+              to_city "Stockholm"
+            end
+          end
+        end
+      end
+
+      if RUBY_ENGINE == 'jruby'
+        expected_document.gsub! 'myApp:to_city', 'to_city'
+        expected_document.gsub! 'xf:group', 'group'
+        expected_document.gsub! 'xf:string', 'string'
+      end
+
+      document.to_xml.should == expected_document
+    end
+  end
+
+  describe "parsing a document" do
+    subject do
+      RubySpeech.parse example_document
+    end
+
+    let(:empty_result) { '<result xmlns="http://www.w3c.org/2000/11/nlsml" xmlns:xf="http://www.w3.org/2000/xforms"/>' }
+
+    its(:grammar) { should == 'http://flight' }
+
+    it { should be_match }
+
+    let(:expected_best_interpretation) do
+      {
+        confidence: 0.6,
+        input: { mode: :speech, content: 'I want to go to Pittsburgh' },
+        instance: { airline: { to_city: 'Pittsburgh' } },
+        instances: [{ airline: { to_city: 'Pittsburgh' } }]
+      }
+    end
+
+    let(:expected_interpretations) do
+      [
+        expected_best_interpretation,
+        {
+          confidence: 0.4,
+          input: { content: 'I want to go to Stockholm' },
+          instance: { airline: { to_city: 'Stockholm' } },
+          instances: [{ airline: { to_city: 'Stockholm' } }]
+        }
+      ]
+    end
+
+    its(:interpretations)     { should == expected_interpretations }
+    its(:best_interpretation) { should == expected_best_interpretation }
+
+    it "should be equal if the XML is the same" do
+      subject.should be == RubySpeech.parse(example_document)
+    end
+
+    it "should not be equal if the XML is different" do
+      subject.should_not be == RubySpeech.parse(empty_result)
+    end
+
+    context "with an interpretation that has no model/instance" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+  </interpretation>
+</result>
+        '''
+      end
+
+      let(:expected_best_interpretation) do
+        {
+          confidence: 0.6,
+          input: { mode: :speech, content: 'I want to go to Pittsburgh' },
+          instance: nil,
+          instances: []
+        }
+      end
+
+      let(:expected_interpretations) do
+        [
+          expected_best_interpretation,
+          {
+            confidence: 0.4,
+            input: { content: 'I want to go to Stockholm' },
+            instance: nil,
+            instances: []
+          }
+        ]
+      end
+
+      its(:interpretations)     { should == expected_interpretations }
+      its(:best_interpretation) { should == expected_best_interpretation }
+    end
+
+    context "without any interpretations" do
+      subject do
+        RubySpeech.parse empty_result
+      end
+
+      it { should_not be_match }
+    end
+
+    context "with interpretations out of confidence order" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" xmlns:myApp="foo" xmlns:xf="http://www.w3.org/2000/xforms" grammar="http://flight">
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Stockholm</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Pittsburgh</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+</result>
+        '''
+      end
+
+      its(:interpretations)     { should == expected_interpretations }
+      its(:best_interpretation) { should == expected_best_interpretation }
+    end
+
+    context "with multiple instances for a single interpretation" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" xmlns:myApp="foo" xmlns:xf="http://www.w3.org/2000/xforms" grammar="http://flight">
+  <interpretation confidence="100">
+    <input mode="speech">I want to go to Boston</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Boston, MA</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Boston, UK</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+</result>
+        '''
+      end
+
+      let(:expected_interpretation) do
+        {
+          confidence: 1.0,
+          input: { content: 'I want to go to Boston', mode: :speech },
+          instance: { airline: { to_city: 'Boston, MA' } },
+          instances: [
+            { airline: { to_city: 'Boston, MA' } },
+            { airline: { to_city: 'Boston, UK' } }
+          ]
+        }
+      end
+
+      its(:interpretations)     { should == [expected_interpretation] }
+      its(:best_interpretation) { should == expected_interpretation }
+    end
+
+    context "with no namespaces (because some vendors think this is ok)" do
+      let :example_document do
+        '''
+<result grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <model>
+      <group name="airline">
+        <string name="to_city"/>
+      </group>
+    </model>
+    <instance>
+      <airline>
+        <to_city>Pittsburgh</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <model>
+      <group name="airline">
+        <string name="to_city"/>
+      </group>
+    </model>
+    <instance>
+      <airline>
+        <to_city>Stockholm</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+</result>
+        '''
+      end
+
+      its(:interpretations)     { should == expected_interpretations }
+      its(:best_interpretation) { should == expected_best_interpretation }
+    end
+
+    context "with just an NLSML namespace (because we need something, damnit!)" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <model>
+      <group name="airline">
+        <string name="to_city"/>
+      </group>
+    </model>
+    <instance>
+      <airline>
+        <to_city>Pittsburgh</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <model>
+      <group name="airline">
+        <string name="to_city"/>
+      </group>
+    </model>
+    <instance>
+      <airline>
+        <to_city>Stockholm</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+</result>
+        '''
+      end
+
+      its(:interpretations)     { should == expected_interpretations }
+      its(:best_interpretation) { should == expected_best_interpretation }
+    end
+
+    context "with a single interpretation with a nomatch input" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" grammar="http://flight">
+  <interpretation>
+    <input>
+       <nomatch/>
+    </input>
+  </interpretation>
+</result>
+        '''
+      end
+
+      it { should_not be_match }
+    end
+
+    context "with multiple interpretations where one is a nomatch input" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <model>
+      <group name="airline">
+        <string name="to_city"/>
+      </group>
+    </model>
+    <instance>
+      <airline>
+        <to_city>Pittsburgh</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+  <interpretation>
+    <input>
+       <nomatch/>
+    </input>
+  </interpretation>
+</result>
+        '''
+      end
+
+      it { should be_match }
+    end
+
+    context "with a single interpretation with a noinput" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" grammar="http://flight">
+  <interpretation>
+    <input>
+       <noinput/>
+    </input>
+  </interpretation>
+</result>
+        '''
+      end
+
+      it { should_not be_match }
+      it { should be_noinput }
+    end
+  end
+end

data/spec/ruby_speech_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe RubySpeech do
+  describe ".parse" do
+    subject do
+      RubySpeech.parse example_document
+    end
+
+    context "with an SSML document" do
+      let :example_document do
+        '''<?xml version="1.0"?>
+<!DOCTYPE speak PUBLIC "-//W3C//DTD SYNTHESIS 1.0//EN"
+                  "http://www.w3.org/TR/speech-synthesis/synthesis.dtd">
+<speak version="1.0"
+       xmlns="http://www.w3.org/2001/10/synthesis"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://www.w3.org/2001/10/synthesis
+                   http://www.w3.org/TR/speech-synthesis/synthesis.xsd"
+       xml:lang="en-US">
+  <p>
+    <s>You have 4 new messages.</s>
+    <s>The first is from Stephanie Williams and arrived at <break/> 3:45pm.
+    </s>
+    <s>
+      The subject is <prosody rate="-20%">ski trip</prosody>
+    </s>
+
+  </p>
+</speak>
+        '''
+      end
+
+      it { should be_a RubySpeech::SSML::Element }
+    end
+
+    context "with a GRXML document" do
+      let :example_document do
+        '''<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE grammar PUBLIC "-//W3C//DTD GRAMMAR 1.0//EN"
+                  "http://www.w3.org/TR/speech-grammar/grammar.dtd">
+
+<grammar xmlns="http://www.w3.org/2001/06/grammar" xml:lang="en"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://www.w3.org/2001/06/grammar
+                             http://www.w3.org/TR/speech-grammar/grammar.xsd"
+         version="1.0" mode="voice" root="basicCmd">
+
+<meta name="author" content="Stephanie Williams"/>
+
+<rule id="basicCmd" scope="public">
+  <example> please move the window </example>
+  <example> open a file </example>
+
+  <ruleref uri="http://grammar.example.com/politeness.grxml#startPolite"/>
+
+  <ruleref uri="#command"/>
+  <ruleref uri="http://grammar.example.com/politeness.grxml#endPolite"/>
+
+</rule>
+
+<rule id="command">
+  <ruleref uri="#action"/> <ruleref uri="#object"/>
+</rule>
+
+<rule id="action">
+   <one-of>
+      <item weight="10"> open   <tag>TAG-CONTENT-1</tag> </item>
+      <item weight="2">  close  <tag>TAG-CONTENT-2</tag> </item>
+      <item weight="1">  delete <tag>TAG-CONTENT-3</tag> </item>
+      <item weight="1">  move   <tag>TAG-CONTENT-4</tag> </item>
+    </one-of>
+</rule>
+
+<rule id="object">
+  <item repeat="0-1">
+    <one-of>
+      <item> the </item>
+      <item> a </item>
+    </one-of>
+  </item>
+
+  <one-of>
+      <item> window </item>
+      <item> file </item>
+      <item> menu </item>
+  </one-of>
+</rule>
+
+</grammar>
+        '''
+      end
+
+      it { should be_a RubySpeech::GRXML::Element }
+    end
+
+    context "with an NLSML document" do
+      let :example_document do
+        '''
+<result xmlns="http://www.w3c.org/2000/11/nlsml" xmlns:xf="http://www.w3.org/2000/xforms" xmlns:myApp="foo" grammar="http://flight">
+  <interpretation confidence="60">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Pittsburgh</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+  <interpretation confidence="40">
+    <input>I want to go to Stockholm</input>
+    <xf:model>
+      <xf:group name="airline">
+        <xf:string name="to_city"/>
+      </xf:group>
+    </xf:model>
+    <xf:instance>
+      <myApp:airline>
+        <myApp:to_city>Stockholm</myApp:to_city>
+      </myApp:airline>
+    </xf:instance>
+  </interpretation>
+</result>
+        '''
+      end
+
+      it { should be_a RubySpeech::NLSML::Document }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_speech
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
@@ -266,6 +266,9 @@ files:
 - lib/ruby_speech/grxml/ruleref.rb
 - lib/ruby_speech/grxml/tag.rb
 - lib/ruby_speech/grxml/token.rb
+- lib/ruby_speech/nlsml.rb
+- lib/ruby_speech/nlsml/builder.rb
+- lib/ruby_speech/nlsml/document.rb
 - lib/ruby_speech/ssml.rb
 - lib/ruby_speech/ssml/audio.rb
 - lib/ruby_speech/ssml/break.rb
@@ -296,6 +299,7 @@ files:
 - spec/ruby_speech/grxml/tag_spec.rb
 - spec/ruby_speech/grxml/token_spec.rb
 - spec/ruby_speech/grxml_spec.rb
+- spec/ruby_speech/nlsml_spec.rb
 - spec/ruby_speech/ssml/audio_spec.rb
 - spec/ruby_speech/ssml/break_spec.rb
 - spec/ruby_speech/ssml/desc_spec.rb
@@ -310,6 +314,7 @@ files:
 - spec/ruby_speech/ssml/sub_spec.rb
 - spec/ruby_speech/ssml/voice_spec.rb
 - spec/ruby_speech/ssml_spec.rb
+- spec/ruby_speech_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
 homepage: https://github.com/benlangfeld/ruby_speech
@@ -326,7 +331,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1835658384396428015
+      hash: -2548283956083168054
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -335,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1835658384396428015
+      hash: -2548283956083168054
 requirements: []
 rubyforge_project: ruby_speech
 rubygems_version: 1.8.24
@@ -354,6 +359,7 @@ test_files:
 - spec/ruby_speech/grxml/tag_spec.rb
 - spec/ruby_speech/grxml/token_spec.rb
 - spec/ruby_speech/grxml_spec.rb
+- spec/ruby_speech/nlsml_spec.rb
 - spec/ruby_speech/ssml/audio_spec.rb
 - spec/ruby_speech/ssml/break_spec.rb
 - spec/ruby_speech/ssml/desc_spec.rb
@@ -368,6 +374,7 @@ test_files:
 - spec/ruby_speech/ssml/sub_spec.rb
 - spec/ruby_speech/ssml/voice_spec.rb
 - spec/ruby_speech/ssml_spec.rb
+- spec/ruby_speech_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
 has_rdoc: