punchblock 0.4.0

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

@@ -0,0 +1,360 @@
+require 'spec_helper'
+
+module Punchblock
+  module Component
+    module Tropo
+      describe Conference do
+        it 'registers itself' do
+          RayoNode.class_from_registration(:conference, 'urn:xmpp:tropo:conference:1').should == Conference
+        end
+
+        describe "when setting options in initializer" do
+          subject do
+            Conference.new :name              => '1234',
+                           :terminator        => '#',
+                           :moderator         => true,
+                           :tone_passthrough  => true,
+                           :mute              => false,
+                           :announcement      => {:text => "Welcome to Rayo", :voice => 'shelly'},
+                           :music             => {:text => "The moderator how not yet joined.. Listen to this awesome music while you wait.", :voice => 'frank'}
+          end
+
+          its(:name)              { should == '1234' }
+          its(:mute)              { should == false }
+          its(:terminator)        { should == '#' }
+          its(:tone_passthrough)  { should == true }
+          its(:moderator)         { should == true }
+          its(:announcement)      { should == Conference::Announcement.new(:text => "Welcome to Rayo", :voice => 'shelly') }
+          its(:music)             { should == Conference::Music.new(:text => "The moderator how not yet joined.. Listen to this awesome music while you wait.", :voice => 'frank') }
+        end
+
+        its(:mute_status_name) { should == :unknown_mute }
+        its(:hold_status_name) { should == :unknown_hold }
+
+        describe "#==" do
+          subject { Conference.new :name => 'the-conference' }
+          let(:conference2) { Conference.new :name => 'the-conference' }
+          let(:conference3) { Conference.new :name => 'other-conference' }
+
+          it { should == conference2 }
+          it { should_not == conference3 }
+        end
+
+        describe "#transition_state!" do
+          describe "with an on-hold" do
+            it "should call #onhold!" do
+              subject.expects(:onhold!).once
+              subject.transition_state! Conference::OnHold.new
+            end
+          end
+
+          describe "with an off-hold" do
+            it "should call #offhold!" do
+              subject.expects(:offhold!).once
+              subject.transition_state! Conference::OffHold.new
+            end
+          end
+        end # #transition_state!
+
+        describe "#requested" do
+          context "when requesting to be muted" do
+            subject { Conference.new :mute => true }
+            before { subject.request! }
+            its(:mute_status_name) { should == :muted }
+          end
+
+          context "when requesting not to be muted" do
+            subject { Conference.new :mute => false }
+            before { subject.request! }
+            its(:mute_status_name) { should == :unmuted }
+          end
+        end
+
+        describe "#onhold!" do
+          before do
+            subject.onhold!
+          end
+
+          its(:hold_status_name) { should == :onhold }
+
+          it "should raise a StateMachine::InvalidTransition when received a second time" do
+            lambda { subject.onhold! }.should raise_error(StateMachine::InvalidTransition)
+          end
+        end
+
+        describe "#offhold!" do
+          before do
+            subject.onhold!
+            subject.offhold!
+          end
+
+          its(:hold_status_name) { should == :offhold }
+
+          it "should raise a StateMachine::InvalidTransition when received a second time" do
+            lambda { subject.offhold! }.should raise_error(StateMachine::InvalidTransition)
+          end
+        end
+
+        describe "actions" do
+          let(:conference) { Conference.new :name => '1234' }
+
+          before do
+            conference.component_id = 'abc123'
+            conference.call_id = '123abc'
+            conference.connection = Connection.new :username => '123', :password => '123'
+          end
+
+          describe '#mute_action' do
+            subject { conference.mute_action }
+
+            it { should be_a Command::Mute }
+            its(:component_id) { should == 'abc123' }
+            its(:call_id) { should == '123abc' }
+          end
+
+          describe '#mute!' do
+            describe "when unmuted" do
+              before do
+                conference.request!
+                conference.execute!
+              end
+
+              it "should send its command properly" do
+                Connection.any_instance.expects(:write).with('123abc', conference.mute_action, 'abc123').returns true
+                conference.expects :muted!
+                conference.mute!
+              end
+            end
+
+            describe "when muted" do
+              before { conference.muted! }
+
+              it "should raise an error" do
+                lambda { conference.mute! }.should raise_error(InvalidActionError, "Cannot mute a Conference that is already muted")
+              end
+            end
+          end
+
+          describe "#muted!" do
+            before do
+              subject.request!
+              subject.execute!
+              subject.muted!
+            end
+
+            its(:mute_status_name) { should == :muted }
+
+            it "should raise a StateMachine::InvalidTransition when received a second time" do
+              lambda { subject.muted! }.should raise_error(StateMachine::InvalidTransition)
+            end
+          end
+
+          describe '#unmute_action' do
+            subject { conference.unmute_action }
+
+            it { should be_a Command::Unmute }
+            its(:component_id) { should == 'abc123' }
+            its(:call_id) { should == '123abc' }
+          end
+
+          describe '#unmute!' do
+            before do
+              conference.request!
+              conference.execute!
+            end
+
+            describe "when muted" do
+              before do
+                conference.muted!
+              end
+
+              it "should send its command properly" do
+                Connection.any_instance.expects(:write).with('123abc', conference.unmute_action, 'abc123').returns true
+                conference.expects :unmuted!
+                conference.unmute!
+              end
+            end
+
+            describe "when unmuted" do
+              it "should raise an error" do
+                lambda { conference.unmute! }.should raise_error(InvalidActionError, "Cannot unmute a Conference that is not muted")
+              end
+            end
+          end
+
+          describe "#unmuted!" do
+            before do
+              subject.request!
+              subject.execute!
+              subject.muted!
+              subject.unmuted!
+            end
+
+            its(:mute_status_name) { should == :unmuted }
+
+            it "should raise a StateMachine::InvalidTransition when received a second time" do
+              lambda { subject.unmuted! }.should raise_error(StateMachine::InvalidTransition)
+            end
+          end
+
+          describe '#stop_action' do
+            subject { conference.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
+                conference.request!
+                conference.execute!
+              end
+
+              it "should send its command properly" do
+                Connection.any_instance.expects(:write).with('123abc', conference.stop_action, 'abc123')
+                conference.stop!
+              end
+            end
+
+            describe "when the command is not executing" do
+              it "should raise an error" do
+                lambda { conference.stop! }.should raise_error(InvalidActionError, "Cannot stop a Conference that is not executing")
+              end
+            end
+          end # describe #stop!
+
+          describe '#kick_action' do
+            subject { conference.kick_action :message => 'bye!' }
+
+            its(:to_xml) { should == '<kick xmlns="urn:xmpp:tropo:conference:1">bye!</kick>' }
+            its(:component_id) { should == 'abc123' }
+            its(:call_id) { should == '123abc' }
+          end
+
+          describe '#kick!' do
+            describe "when the command is executing" do
+              before do
+                conference.request!
+                conference.execute!
+              end
+
+              it "should send its command properly" do
+                Connection.any_instance.expects(:write).with('123abc', conference.kick_action(:message => 'bye!'), 'abc123')
+                conference.kick! :message => 'bye!'
+              end
+            end
+
+            describe "when the command is not executing" do
+              it "should raise an error" do
+                lambda { conference.kick! }.should raise_error(InvalidActionError, "Cannot kick a Conference that is not executing")
+              end
+            end
+          end # describe #kick!
+        end
+
+        describe Conference::OnHold do
+          it 'registers itself' do
+            RayoNode.class_from_registration(:'on-hold', 'urn:xmpp:tropo:conference:1').should == Conference::OnHold
+          end
+
+          describe "from a stanza" do
+            let(:stanza) { "<on-hold xmlns='urn:xmpp:tropo:conference:1'/>" }
+
+            subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+            it { should be_instance_of Conference::OnHold }
+
+            it_should_behave_like 'event'
+          end
+        end
+
+        describe Conference::OffHold do
+          it 'registers itself' do
+            RayoNode.class_from_registration(:'off-hold', 'urn:xmpp:tropo:conference:1').should == Conference::OffHold
+          end
+
+          describe "from a stanza" do
+            let(:stanza) { "<off-hold xmlns='urn:xmpp:tropo:conference:1'/>" }
+
+            subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+            it { should be_instance_of Conference::OffHold }
+
+            it_should_behave_like 'event'
+          end
+        end
+
+        describe Conference::Speaking do
+          it 'registers itself' do
+            RayoNode.class_from_registration(:speaking, 'urn:xmpp:tropo:conference:1').should == Conference::Speaking
+          end
+
+          describe "from a stanza" do
+            let(:stanza) { "<speaking xmlns='urn:xmpp:tropo:conference:1' call-id='abc123'/>" }
+
+            subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+            it { should be_instance_of Conference::Speaking }
+
+            it_should_behave_like 'event'
+
+            its(:speaking_call_id) { should == 'abc123' }
+          end
+        end
+
+        describe Conference::FinishedSpeaking do
+          it 'registers itself' do
+            RayoNode.class_from_registration(:'finished-speaking', 'urn:xmpp:tropo:conference:1').should == Conference::FinishedSpeaking
+          end
+
+          describe "from a stanza" do
+            let(:stanza) { "<finished-speaking xmlns='urn:xmpp:tropo:conference:1' call-id='abc123'/>" }
+
+            subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+            it { should be_instance_of Conference::FinishedSpeaking }
+
+            it_should_behave_like 'event'
+
+            its(:speaking_call_id) { should == 'abc123' }
+          end
+        end
+
+        describe Conference::Complete::Kick do
+          let :stanza do
+            <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <kick xmlns='urn:xmpp:tropo:conference:complete:1'>wouldn't stop talking</kick>
+</complete>
+            MESSAGE
+          end
+
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Conference::Complete::Kick }
+
+          its(:name)    { should == :kick }
+          its(:details) { should == "wouldn't stop talking" }
+        end
+
+        describe Conference::Complete::Terminator do
+          let :stanza do
+            <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <terminator xmlns='urn:xmpp:tropo:conference:complete:1' />
+</complete>
+            MESSAGE
+          end
+
+          subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+          it { should be_instance_of Conference::Complete::Terminator }
+
+          its(:name) { should == :terminator }
+        end
+      end
+    end
+  end
+end # Punchblock

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

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+module Punchblock
+  module Component
+    module Tropo
+      describe Say do
+        it 'registers itself' do
+          RayoNode.class_from_registration(:say, 'urn:xmpp:tropo:say:1').should == Say
+        end
+
+        describe "for text" do
+          subject { Say.new :text => 'Once upon a time there was a message...', :voice => 'kate' }
+
+          its(:voice) { should == 'kate' }
+          its(:text) { should == 'Once upon a time there was a message...' }
+        end
+
+        describe "for SSML" do
+          subject { Say.new :ssml => '<say-as interpret-as="ordinal">100</say-as>', :voice => 'kate' }
+
+          its(:voice) { should == 'kate' }
+          it "should have the correct content" do
+            subject.child.to_s.should == '<say-as interpret-as="ordinal">100</say-as>'
+          end
+        end
+
+        describe "actions" do
+          let(:command) { Say.new :text => 'Once upon a time there was a message...', :voice => 'kate' }
+
+          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:tropo:say: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 Say 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:tropo:say: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 Say 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 Say that is not executing")
+              end
+            end
+          end # #stop!
+        end
+      end
+
+      describe Say::Complete::Success do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <success xmlns='urn:xmpp:tropo:say:complete:1' />
+</complete>
+          MESSAGE
+        end
+
+        subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+        it { should be_instance_of Say::Complete::Success }
+
+        its(:name) { should == :success }
+      end
+    end
+  end
+end # Punchblock

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

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+module Punchblock
+  module Component
+    module Tropo
+      describe Transfer do
+        it 'registers itself' do
+          RayoNode.class_from_registration(:transfer, 'urn:xmpp:tropo:transfer:1').should == Transfer
+        end
+
+        describe 'when setting options in initializer' do
+          subject do
+            Transfer.new :to              => 'tel:+14045551212',
+                         :from            => 'tel:+14155551212',
+                         :terminator      => '*',
+                         :timeout         => 120000,
+                         :answer_on_media => true,
+                         :media           => :direct,
+                         :ring            => {:voice => 'allison', :text => "Welcome to Rayo", :url => "http://it.doesnt.matter.does.it/?"}
+          end
+
+          its(:to)              { should == %w{tel:+14045551212} }
+          its(:from)            { should == 'tel:+14155551212' }
+          its(:terminator)      { should == '*' }
+          its(:timeout)         { should == 120000 }
+          its(:answer_on_media) { should == true }
+          its(:media)           { should == :direct }
+          its(:ring)            { should == Transfer::Ring.new(:voice => 'allison', :text => "Welcome to Rayo", :url => "http://it.doesnt.matter.does.it/?") }
+        end
+
+        it_should_behave_like 'command_headers'
+      end
+
+      describe "actions" do
+        let(:command) { Transfer.new :to => 'tel:+14045551212', :from => 'tel:+14155551212' }
+
+        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 Transfer that is not executing")
+            end
+          end
+        end
+      end
+
+      describe Transfer::Complete::Success do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <success xmlns='urn:xmpp:tropo:transfer:complete:1' />
+</complete>
+          MESSAGE
+        end
+
+        subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+        it { should be_instance_of Transfer::Complete::Success }
+
+        its(:name) { should == :success }
+      end
+
+      describe Transfer::Complete::Timeout do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <timeout xmlns='urn:xmpp:tropo:transfer:complete:1' />
+</complete>
+          MESSAGE
+        end
+
+        subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+        it { should be_instance_of Transfer::Complete::Timeout }
+
+        its(:name) { should == :timeout }
+      end
+
+      describe Transfer::Complete::Terminator do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <terminator xmlns='urn:xmpp:tropo:transfer:complete:1' />
+</complete>
+          MESSAGE
+        end
+
+        subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+        it { should be_instance_of Transfer::Complete::Terminator }
+
+        its(:name) { should == :terminator }
+      end
+
+      describe Transfer::Complete::Busy do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <busy xmlns='urn:xmpp:tropo:transfer:complete:1' />
+</complete>
+          MESSAGE
+        end
+
+        subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+        it { should be_instance_of Transfer::Complete::Busy }
+
+        its(:name) { should == :busy }
+      end
+
+      describe Transfer::Complete::Reject do
+        let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <reject xmlns='urn:xmpp:tropo:transfer:complete:1' />
+</complete>
+          MESSAGE
+        end
+
+        subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+        it { should be_instance_of Transfer::Complete::Reject }
+
+        its(:name) { should == :reject }
+      end
+    end
+  end
+end # Punchblock