punchblock 0.4.0

data/spec/punchblock/component/record_spec.rb

@@ -0,0 +1,235 @@
+require 'spec_helper'
+
+module Punchblock
+  module Component
+    describe Record do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:record, 'urn:xmpp:rayo:record:1').should == Record
+      end
+
+      describe "when setting options in initializer" do
+        subject do
+          Record.new :format          => 'WAV',
+                     :start_beep      => true,
+                     :start_paused    => false,
+                     :stop_beep       => true,
+                     :max_duration    => 500000,
+                     :initial_timeout => 10000,
+                     :final_timeout   => 30000
+        end
+
+        its(:format)          { should == 'WAV' }
+        its(:start_beep)      { should == true }
+        its(:start_paused)    { should == false }
+        its(:stop_beep)       { should == true }
+        its(:max_duration)    { should == 500000 }
+        its(:initial_timeout) { should == 10000 }
+        its(:final_timeout)   { should == 30000 }
+      end
+
+      describe "actions" do
+        let(:command) { Record.new }
+
+        before do
+          command.component_id = 'abc123'
+          command.call_id = '123abc'
+          command.connection = Connection.new :username => '123', :password => '123'
+        end
+
+        describe '#pause_action' do
+          subject { command.pause_action }
+
+          its(:to_xml) { should == '<pause xmlns="urn:xmpp:rayo:record:1"/>' }
+          its(:component_id) { should == 'abc123' }
+          its(:call_id) { should == '123abc' }
+        end
+
+        describe '#pause!' do
+          describe "when the command is executing" do
+            before do
+              command.request!
+              command.execute!
+            end
+
+            it "should send its command properly" do
+              Connection.any_instance.expects(:write).with('123abc', command.pause_action, 'abc123').returns true
+              command.expects :paused!
+              command.pause!
+            end
+          end
+
+          describe "when the command is not executing" do
+            it "should raise an error" do
+              lambda { command.pause! }.should raise_error(InvalidActionError, "Cannot pause a Record that is not executing")
+            end
+          end
+        end
+
+        describe "#paused!" do
+          before do
+            subject.request!
+            subject.execute!
+            subject.paused!
+          end
+
+          its(:state_name) { should == :paused }
+
+          it "should raise a StateMachine::InvalidTransition when received a second time" do
+            lambda { subject.paused! }.should raise_error(StateMachine::InvalidTransition)
+          end
+        end
+
+        describe '#resume_action' do
+          subject { command.resume_action }
+
+          its(:to_xml) { should == '<resume xmlns="urn:xmpp:rayo:record:1"/>' }
+          its(:component_id) { should == 'abc123' }
+          its(:call_id) { should == '123abc' }
+        end
+
+        describe '#resume!' do
+          describe "when the command is paused" do
+            before do
+              command.request!
+              command.execute!
+              command.paused!
+            end
+
+            it "should send its command properly" do
+              Connection.any_instance.expects(:write).with('123abc', command.resume_action, 'abc123').returns true
+              command.expects :resumed!
+              command.resume!
+            end
+          end
+
+          describe "when the command is not paused" do
+            it "should raise an error" do
+              lambda { command.resume! }.should raise_error(InvalidActionError, "Cannot resume a Record that is not paused.")
+            end
+          end
+        end
+
+        describe "#resumed!" do
+          before do
+            subject.request!
+            subject.execute!
+            subject.paused!
+            subject.resumed!
+          end
+
+          its(:state_name) { should == :executing }
+
+          it "should raise a StateMachine::InvalidTransition when received a second time" do
+            lambda { subject.resumed! }.should raise_error(StateMachine::InvalidTransition)
+          end
+        end
+
+        describe '#stop_action' do
+          subject { command.stop_action }
+
+          its(:to_xml) { should == '<stop xmlns="urn:xmpp:rayo:1"/>' }
+          its(:component_id) { should == 'abc123' }
+          its(:call_id) { should == '123abc' }
+        end
+
+        describe '#stop!' do
+          describe "when the command is executing" do
+            before do
+              command.request!
+              command.execute!
+            end
+
+            it "should send its command properly" do
+              Connection.any_instance.expects(:write).with('123abc', command.stop_action, 'abc123')
+              command.stop!
+            end
+          end
+
+          describe "when the command is not executing" do
+            it "should raise an error" do
+              lambda { command.stop! }.should raise_error(InvalidActionError, "Cannot stop a Record that is not executing")
+            end
+          end
+        end
+      end
+
+      describe Record::Complete::Success do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+<success xmlns='urn:xmpp:rayo:record:complete:1'/>
+<recording xmlns='urn:xmpp:rayo:record:complete:1' uri="file:/tmp/rayo7451601434771683422.mp3"/>
+</complete>
+          MESSAGE
+        end
+
+        describe "#reason" do
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Record::Complete::Success }
+
+          its(:name)  { should == :success }
+        end
+
+        describe "#recording" do
+          subject { RayoNode.import(parse_stanza(stanza).root).recording }
+
+          it { should be_instance_of Record::Recording }
+          its(:uri) { should == "file:/tmp/rayo7451601434771683422.mp3" }
+        end
+      end
+
+      describe Event::Complete::Stop do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+<stop xmlns='urn:xmpp:rayo:ext:complete:1' />
+<recording xmlns='urn:xmpp:rayo:record:complete:1' uri="file:/tmp/rayo7451601434771683422.mp3"/>
+</complete>
+          MESSAGE
+        end
+
+        describe "#reason" do
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Event::Complete::Stop }
+
+          its(:name)  { should == :stop }
+        end
+
+        describe "#recording" do
+          subject { RayoNode.import(parse_stanza(stanza).root).recording }
+
+          it { should be_instance_of Record::Recording }
+          its(:uri) { should == "file:/tmp/rayo7451601434771683422.mp3" }
+        end
+      end
+
+      describe Event::Complete::Hangup do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+<hangup xmlns='urn:xmpp:rayo:ext:complete:1' />
+<recording xmlns='urn:xmpp:rayo:record:complete:1' uri="file:/tmp/rayo7451601434771683422.mp3"/>
+</complete>
+          MESSAGE
+        end
+
+        describe "#reason" do
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Event::Complete::Hangup }
+
+          its(:name)  { should == :hangup }
+        end
+
+        describe "#recording" do
+          subject { RayoNode.import(parse_stanza(stanza).root).recording }
+
+          it { should be_instance_of Record::Recording }
+          its(:uri) { should == "file:/tmp/rayo7451601434771683422.mp3" }
+        end
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/component/tropo/ask_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+module Punchblock
+  module Component
+    module Tropo
+      describe Ask do
+        it 'registers itself' do
+          RayoNode.class_from_registration(:ask, 'urn:xmpp:tropo:ask:1').should == Ask
+        end
+
+        describe "when setting options in initializer" do
+          subject do
+            Ask.new :choices        => {:value => '[5 DIGITS]', :content_type => 'application/grammar+custom'},
+                    :prompt         => {:text => 'Please enter your postal code.', :voice => 'kate'},
+                    :bargein        => true,
+                    :min_confidence => 0.3,
+                    :mode           => :speech,
+                    :recognizer     => 'en-US',
+                    :terminator     => '#',
+                    :timeout        => 12000
+          end
+
+
+          its(:choices)         { should == Ask::Choices.new(:value => '[5 DIGITS]', :content_type => 'application/grammar+custom') }
+          its(:prompt)          { should == Ask::Prompt.new(:voice => 'kate', :text => 'Please enter your postal code.') }
+          its(:bargein)         { should == true }
+          its(:min_confidence)  { should == 0.3 }
+          its(:mode)            { should == :speech }
+          its(:recognizer)      { should == 'en-US' }
+          its(:terminator)      { should == '#' }
+          its(:timeout)         { should == 12000 }
+        end
+
+        describe Ask::Choices do
+          describe "when not passing a grammar" do
+            subject { Ask::Choices.new :value => '[5 DIGITS]' }
+            its(:content_type) { should == 'application/grammar+grxml' }
+          end
+
+          describe 'with a simple grammar' do
+            subject { Ask::Choices.new :value => '[5 DIGITS]', :content_type => 'application/grammar+custom' }
+
+            let(:expected_message) { "<![CDATA[ [5 DIGITS] ]]>" }
+
+            it "should wrap grammar in CDATA" do
+              subject.child.to_xml.should == expected_message.strip
+            end
+          end
+
+          describe 'with a GRXML grammar' do
+            subject { Ask::Choices.new :value => grxml, :content_type => 'application/grammar+grxml' }
+
+            let :grxml do
+              <<-GRXML
+<grammar xmlns="http://www.w3.org/2001/06/grammar" root="MAINRULE">
+  <rule id="MAINRULE">
+    <one-of>
+      <item>
+        <item repeat="0-1"> need a</item>
+        <item repeat="0-1"> i need a</item>
+          <one-of>
+            <item> clue </item>
+          </one-of>
+        <tag> out.concept = "clue";</tag>
+      </item>
+      <item>
+        <item repeat="0-1"> have an</item>
+        <item repeat="0-1"> i have an</item>
+          <one-of>
+            <item> answer </item>
+          </one-of>
+        <tag> out.concept = "answer";</tag>
+      </item>
+    </one-of>
+  </rule>
+</grammar>
+              GRXML
+            end
+
+            let(:expected_message) { "<![CDATA[ #{grxml} ]]>" }
+
+            it "should wrap GRXML in CDATA" do
+              subject.child.to_xml.should == expected_message.strip
+            end
+          end
+        end
+
+        describe "actions" do
+          let(:command) { Ask.new :choices => '[5 DIGITS]' }
+
+          before do
+            command.component_id = 'abc123'
+            command.call_id = '123abc'
+            command.connection = Connection.new :username => '123', :password => '123'
+          end
+
+          describe '#stop_action' do
+            subject { command.stop_action }
+
+            its(:to_xml) { should == '<stop xmlns="urn:xmpp:rayo:1"/>' }
+            its(:component_id) { should == 'abc123' }
+            its(:call_id) { should == '123abc' }
+          end
+
+          describe '#stop!' do
+            describe "when the command is executing" do
+              before do
+                command.request!
+                command.execute!
+              end
+
+              it "should send its command properly" do
+                Connection.any_instance.expects(:write).with('123abc', command.stop_action, 'abc123')
+                command.stop!
+              end
+            end
+
+            describe "when the command is not executing" do
+              it "should raise an error" do
+                lambda { command.stop! }.should raise_error(InvalidActionError, "Cannot stop a Ask that is not executing")
+              end
+            end
+          end
+        end
+
+        describe Ask::Complete::Success do
+          let :stanza do
+            <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <success mode="speech" confidence="0.45" xmlns='urn:xmpp:tropo:ask:complete:1'>
+    <interpretation>1234</interpretation>
+    <utterance>one two three four</utterance>
+  </success>
+</complete>
+            MESSAGE
+          end
+
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Ask::Complete::Success }
+
+          its(:name)            { should == :success }
+          its(:mode)            { should == :speech }
+          its(:confidence)      { should == 0.45 }
+          its(:interpretation)  { should == '1234' }
+          its(:utterance)       { should == 'one two three four' }
+        end
+
+        describe Ask::Complete::NoMatch do
+          let :stanza do
+            <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <nomatch xmlns='urn:xmpp:tropo:ask:complete:1' />
+</complete>
+            MESSAGE
+          end
+
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Ask::Complete::NoMatch }
+
+          its(:name) { should == :nomatch }
+        end
+
+        describe Ask::Complete::NoInput do
+          let :stanza do
+            <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <noinput xmlns='urn:xmpp:tropo:ask:complete:1' />
+</complete>
+            MESSAGE
+          end
+
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Ask::Complete::NoInput }
+
+          its(:name) { should == :noinput }
+        end
+      end
+    end
+  end
+end # Punchblock