# encoding: utf-8 require 'spec_helper' module Punchblock module Component describe Output do it 'registers itself' do RayoNode.class_from_registration(:output, 'urn:xmpp:rayo:output:1').should be == described_class end describe 'default values' do its(:interrupt_on) { should be nil } its(:start_offset) { should be nil } its(:start_paused) { should be nil } its(:repeat_interval) { should be nil } its(:repeat_times) { should be nil } its(:max_time) { should be nil } its(:voice) { should be nil } its(:renderer) { should be nil } its(:render_documents) { should be == [] } end def ssml_doc(mode = :ordinal) RubySpeech::SSML.draw do say_as(:interpret_as => mode) { string '100' } end end describe "when setting options in initializer" do subject do Output.new :interrupt_on => :voice, :start_offset => 2000, :start_paused => false, :repeat_interval => 2000, :repeat_times => 10, :max_time => 30000, :voice => 'allison', :renderer => 'swift', :render_document => {:value => ssml_doc} end its(:interrupt_on) { should be == :voice } its(:start_offset) { should be == 2000 } its(:start_paused) { should be == false } its(:repeat_interval) { should be == 2000 } its(:repeat_times) { should be == 10 } its(:max_time) { should be == 30000 } its(:voice) { should be == 'allison' } its(:renderer) { should be == 'swift' } its(:render_documents) { should be == [Output::Document.new(:value => ssml_doc)] } context "using #ssml=" do subject do Output.new :ssml => ssml_doc end its(:render_documents) { should be == [Output::Document.new(:value => ssml_doc)] } end context "with multiple documents" do subject do Output.new :render_documents => [ {:value => ssml_doc}, {:value => ssml_doc(:cardinal)} ] end its(:render_documents) { should be == [ Output::Document.new(:value => ssml_doc), Output::Document.new(:value => ssml_doc(:cardinal)) ]} end context "with a urilist" do subject do Output.new render_document: { content_type: 'text/uri-list', value: Punchblock::URIList.new('http://example.com/hello.mp3') } end its(:render_documents) { should be == [Output::Document.new(content_type: 'text/uri-list', value: ['http://example.com/hello.mp3'])] } describe "exporting to Rayo" do it "should export to XML that can be understood by its parser" do new_instance = RayoNode.from_xml Nokogiri::XML(subject.to_rayo.to_xml, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).root new_instance.render_documents.should be == [Output::Document.new(content_type: 'text/uri-list', value: ['http://example.com/hello.mp3'])] end end end context "with a nil document" do it "removes all documents" do subject.render_document = nil subject.render_documents.should == [] end end context "without any documents" do subject { described_class.new } its(:render_documents) { should == [] } end describe "exporting to Rayo" do it "should export to XML that can be understood by its parser" do new_instance = RayoNode.from_xml Nokogiri::XML(subject.to_rayo.to_xml, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).root new_instance.should be_instance_of described_class new_instance.interrupt_on.should be == :voice new_instance.start_offset.should be == 2000 new_instance.start_paused.should be == false new_instance.repeat_interval.should be == 2000 new_instance.repeat_times.should be == 10 new_instance.max_time.should be == 30000 new_instance.voice.should be == 'allison' new_instance.renderer.should be == 'swift' new_instance.render_documents.should be == [Output::Document.new(:value => ssml_doc)] end it "should wrap the document value in CDATA" do grammar_node = subject.to_rayo.at_xpath('ns:document', ns: described_class.registered_ns) grammar_node.children.first.should be_a Nokogiri::XML::CDATA end it "should render to a parent node if supplied" do doc = Nokogiri::XML::Document.new parent = Nokogiri::XML::Node.new 'foo', doc doc.root = parent rayo_doc = subject.to_rayo(parent) rayo_doc.should == parent end context "with a string SSML document" do let(:ssml_string) { "" } subject do Output.new ssml: ssml_string end it "passes the string right through" do content = subject.to_rayo.at_xpath('//ns:output/ns:document/text()', ns: described_class.registered_ns).content content.should == ssml_string end end end end describe "from a stanza" do let :stanza do <<-MESSAGE 100 ]]> 100 ]]> MESSAGE end subject { RayoNode.from_xml parse_stanza(stanza).root, '9f00061', '1' } it { should be_instance_of Output } its(:interrupt_on) { should be == :voice } its(:start_offset) { should be == 2000 } its(:start_paused) { should be == false } its(:repeat_interval) { should be == 2000 } its(:repeat_times) { should be == 10 } its(:max_time) { should be == 30000 } its(:voice) { should be == 'allison' } its(:renderer) { should be == 'swift' } its(:render_documents) { should be == [Output::Document.new(:value => ssml_doc), Output::Document.new(:value => ssml_doc)] } context "with a urilist" do let :stanza do <<-MESSAGE MESSAGE end its(:render_documents) { should be == [Output::Document.new(content_type: 'text/uri-list', value: ['http://example.com/hello.mp3', 'http://example.com/goodbye.mp3'])] } end end describe Output::Document do describe "when not passing a content type" do subject { Output::Document.new :value => ssml_doc } its(:content_type) { should be == 'application/ssml+xml' } end describe 'with an SSML document' do subject { Output::Document.new :value => ssml_doc, :content_type => 'application/ssml+xml' } its(:content_type) { should be == 'application/ssml+xml' } its(:value) { should be == ssml_doc } describe "comparison" do let(:document2) { Output::Document.new :value => ssml_doc } let(:document3) { Output::Document.new :value => ssml_doc(:normal) } it { should be == document2 } it { should_not be == document3 } end end describe 'with a urilist' do subject { Output::Document.new content_type: 'text/uri-list', value: Punchblock::URIList.new('http://example.com/hello.mp3', 'http://example.com/goodbye.mp3') } its(:value) { should be == Punchblock::URIList.new('http://example.com/hello.mp3', 'http://example.com/goodbye.mp3') } describe "comparison" do let(:document2) { Output::Document.new content_type: 'text/uri-list', value: Punchblock::URIList.new('http://example.com/hello.mp3', 'http://example.com/goodbye.mp3') } let(:document3) { Output::Document.new value: '100' } let(:document4) { Output::Document.new content_type: 'text/uri-list', value: Punchblock::URIList.new('http://example.com/hello.mp3') } let(:document5) { Output::Document.new content_type: 'text/uri-list', value: Punchblock::URIList.new('http://example.com/goodbye.mp3', 'http://example.com/hello.mp3') } it { should be == document2 } it { should_not be == document3 } it { should_not be == document4 } it { should_not be == document5 } end end describe 'with a document reference by URL' do let(:url) { 'http://foo.com/bar.grxml' } subject { Output::Document.new :url => url } its(:url) { should be == url } its(:content_type) { should be nil} describe "comparison" do it "should be the same with the same url" do Output::Document.new(:url => url).should be == Output::Document.new(:url => url) end it "should be different with a different url" do Output::Document.new(:url => url).should_not be == Output::Document.new(:url => 'http://doo.com/dah') end end end end describe "actions" do let(:mock_client) { double 'Client' } let(:command) { described_class.new } before do command.component_id = 'abc123' command.target_call_id = '123abc' command.client = mock_client end describe '#pause_action' do subject { command.pause_action } its(:to_xml) { should be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '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 mock_client.should_receive(:execute_command).with(command.pause_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :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 Output that is not executing") end end end describe "#paused!" do before do subject.request! subject.execute! subject.paused! end its(:state_name) { should be == :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 be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '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 mock_client.should_receive(:execute_command).with(command.resume_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :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 Output 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 be == :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 be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '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 mock_client.should_receive(:execute_command).with(command.stop_action, :target_call_id => '123abc', :component_id => '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 Output that is new") end end end # #stop! describe "seeking" do let(:seek_options) { {:direction => :forward, :amount => 1500} } describe '#seek_action' do subject { command.seek_action seek_options } its(:to_xml) { should be == Nokogiri::XML('').root.to_xml } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '123abc' } end describe '#seek!' do describe "when not seeking" do before do command.request! command.execute! end it "should send its command properly" do seek_action = command.seek_action seek_options command.stub(:seek_action).and_return seek_action mock_client.should_receive(:execute_command).with(seek_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :seeking! command.should_receive :stopped_seeking! command.seek! seek_options seek_action.request! seek_action.execute! end end describe "when seeking" do before { command.seeking! } it "should raise an error" do lambda { command.seek! }.should raise_error(InvalidActionError, "Cannot seek an Output that is already seeking.") end end end describe "#seeking!" do before do subject.request! subject.execute! subject.seeking! end its(:seek_status_name) { should be == :seeking } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.seeking! }.should raise_error(StateMachine::InvalidTransition) end end describe "#stopped_seeking!" do before do subject.request! subject.execute! subject.seeking! subject.stopped_seeking! end its(:seek_status_name) { should be == :not_seeking } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.stopped_seeking! }.should raise_error(StateMachine::InvalidTransition) end end end describe "adjusting speed" do describe '#speed_up_action' do subject { command.speed_up_action } its(:to_xml) { should be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '123abc' } end describe '#speed_up!' do describe "when not altering speed" do before do command.request! command.execute! end it "should send its command properly" do speed_up_action = command.speed_up_action command.stub(:speed_up_action).and_return speed_up_action mock_client.should_receive(:execute_command).with(speed_up_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :speeding_up! command.should_receive :stopped_speeding! command.speed_up! speed_up_action.request! speed_up_action.execute! end end describe "when speeding up" do before { command.speeding_up! } it "should raise an error" do lambda { command.speed_up! }.should raise_error(InvalidActionError, "Cannot speed up an Output that is already speeding.") end end describe "when slowing down" do before { command.slowing_down! } it "should raise an error" do lambda { command.speed_up! }.should raise_error(InvalidActionError, "Cannot speed up an Output that is already speeding.") end end end describe "#speeding_up!" do before do subject.request! subject.execute! subject.speeding_up! end its(:speed_status_name) { should be == :speeding_up } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.speeding_up! }.should raise_error(StateMachine::InvalidTransition) end end describe '#slow_down_action' do subject { command.slow_down_action } its(:to_xml) { should be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '123abc' } end describe '#slow_down!' do describe "when not altering speed" do before do command.request! command.execute! end it "should send its command properly" do slow_down_action = command.slow_down_action command.stub(:slow_down_action).and_return slow_down_action mock_client.should_receive(:execute_command).with(slow_down_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :slowing_down! command.should_receive :stopped_speeding! command.slow_down! slow_down_action.request! slow_down_action.execute! end end describe "when speeding up" do before { command.speeding_up! } it "should raise an error" do lambda { command.slow_down! }.should raise_error(InvalidActionError, "Cannot slow down an Output that is already speeding.") end end describe "when slowing down" do before { command.slowing_down! } it "should raise an error" do lambda { command.slow_down! }.should raise_error(InvalidActionError, "Cannot slow down an Output that is already speeding.") end end end describe "#slowing_down!" do before do subject.request! subject.execute! subject.slowing_down! end its(:speed_status_name) { should be == :slowing_down } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.slowing_down! }.should raise_error(StateMachine::InvalidTransition) end end describe "#stopped_speeding!" do before do subject.request! subject.execute! subject.speeding_up! subject.stopped_speeding! end its(:speed_status_name) { should be == :not_speeding } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.stopped_speeding! }.should raise_error(StateMachine::InvalidTransition) end end end describe "adjusting volume" do describe '#volume_up_action' do subject { command.volume_up_action } its(:to_xml) { should be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '123abc' } end describe '#volume_up!' do describe "when not altering volume" do before do command.request! command.execute! end it "should send its command properly" do volume_up_action = command.volume_up_action command.stub(:volume_up_action).and_return volume_up_action mock_client.should_receive(:execute_command).with(volume_up_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :voluming_up! command.should_receive :stopped_voluming! command.volume_up! volume_up_action.request! volume_up_action.execute! end end describe "when voluming up" do before { command.voluming_up! } it "should raise an error" do lambda { command.volume_up! }.should raise_error(InvalidActionError, "Cannot volume up an Output that is already voluming.") end end describe "when voluming down" do before { command.voluming_down! } it "should raise an error" do lambda { command.volume_up! }.should raise_error(InvalidActionError, "Cannot volume up an Output that is already voluming.") end end end describe "#voluming_up!" do before do subject.request! subject.execute! subject.voluming_up! end its(:volume_status_name) { should be == :voluming_up } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.voluming_up! }.should raise_error(StateMachine::InvalidTransition) end end describe '#volume_down_action' do subject { command.volume_down_action } its(:to_xml) { should be == '' } its(:component_id) { should be == 'abc123' } its(:target_call_id) { should be == '123abc' } end describe '#volume_down!' do describe "when not altering volume" do before do command.request! command.execute! end it "should send its command properly" do volume_down_action = command.volume_down_action command.stub(:volume_down_action).and_return volume_down_action mock_client.should_receive(:execute_command).with(volume_down_action, :target_call_id => '123abc', :component_id => 'abc123').and_return true command.should_receive :voluming_down! command.should_receive :stopped_voluming! command.volume_down! volume_down_action.request! volume_down_action.execute! end end describe "when voluming up" do before { command.voluming_up! } it "should raise an error" do lambda { command.volume_down! }.should raise_error(InvalidActionError, "Cannot volume down an Output that is already voluming.") end end describe "when voluming down" do before { command.voluming_down! } it "should raise an error" do lambda { command.volume_down! }.should raise_error(InvalidActionError, "Cannot volume down an Output that is already voluming.") end end end describe "#voluming_down!" do before do subject.request! subject.execute! subject.voluming_down! end its(:volume_status_name) { should be == :voluming_down } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.voluming_down! }.should raise_error(StateMachine::InvalidTransition) end end describe "#stopped_voluming!" do before do subject.request! subject.execute! subject.voluming_up! subject.stopped_voluming! end its(:volume_status_name) { should be == :not_voluming } it "should raise a StateMachine::InvalidTransition when received a second time" do lambda { subject.stopped_voluming! }.should raise_error(StateMachine::InvalidTransition) end end end end end { Output::Complete::Finish => :finish, Output::Complete::MaxTime => :'max-time', }.each do |klass, element_name| describe klass do let :stanza do <<-MESSAGE <#{element_name} xmlns='urn:xmpp:rayo:output:complete:1' /> MESSAGE end subject { RayoNode.from_xml(parse_stanza(stanza).root).reason } it { should be_instance_of klass } its(:name) { should be == element_name } end end end end