punchblock 0.4.0

data/spec/punchblock/component_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+%w{
+  blather/client/dsl
+  punchblock/core_ext/blather/stanza
+  punchblock/core_ext/blather/stanza/presence
+}.each { |f| require f }
+
+module Punchblock
+  module Component
+    describe ComponentNode do
+      its(:event_queue) { should be_empty }
+
+      it "should not initially have a complete event set" do
+        subject.complete_event.set_yet?.should == false
+      end
+
+      describe "#add_event" do
+        let(:event) { Event::Complete.new }
+
+        before do
+          subject.request!
+          subject.execute!
+        end
+
+        let(:add_event) { subject.add_event event }
+
+        it "should add the event to the component's event queue" do
+          add_event
+          subject.event_queue.pop(false).should == event
+        end
+
+        it "should set the original event on the command" do
+          add_event
+          event.original_component.should == subject
+        end
+
+        it "should trigger state transition" do
+          subject.expects(:transition_state!).once.with event
+          add_event
+        end
+
+        describe "with a complete event" do
+          it "should set the complete event resource" do
+            add_event
+            subject.complete_event.set_yet?.should == true
+            subject.complete_event.resource.should == event
+          end
+        end
+
+        describe "with another event" do
+          let(:event) { Event::Answered.new }
+
+          it "should not set the complete event resource" do
+            add_event
+            subject.complete_event.set_yet?.should == false
+          end
+        end
+
+        describe "with an event callback set" do
+          let(:event_callback) { lambda { |event| @foo = :bar } }
+
+          before do
+            @foo = nil
+            subject.event_callback = event_callback
+            add_event
+          end
+
+          it "should trigger the callback" do
+            @foo.should == :bar
+          end
+
+          it "should not write the event to the event queue" do
+            subject.event_queue.should be_empty
+          end
+
+          describe "which returns a falsy value" do
+            let(:event_callback) do
+              lambda { |event| false }
+            end
+
+            it "should add the event to the event queue" do
+              subject.event_queue.should_not be_empty
+            end
+          end
+        end
+      end # #add_event
+
+      describe "#transition_state!" do
+        describe "with a complete" do
+          it "should call #complete!" do
+            subject.expects(:complete!).once
+            subject.transition_state! Event::Complete.new
+          end
+        end
+      end # #transition_state!
+
+      describe "#response=" do
+        before do
+          subject.request!
+          subject.connection = mock(:record_command_id_for_iq_id => true)
+        end
+
+        let(:component_id) { 'abc123' }
+
+        let :ref do
+          Ref.new.tap do |ref|
+            ref.id = component_id
+          end
+        end
+
+        let :iq do
+          Blather::Stanza::Iq.new(:result, 'blah').tap do |iq|
+            iq.from = "12345@call.rayo.net"
+            iq << ref
+          end
+        end
+
+        it "should set the component ID from the ref" do
+          subject.response = iq
+          subject.component_id.should == component_id
+        end
+      end
+    end # ComponentNode
+  end # Component
+end # Punchblock

data/spec/punchblock/connection_spec.rb

@@ -0,0 +1,194 @@
+require 'spec_helper'
+
+module Punchblock
+  describe Connection do
+    let(:connection) { Connection.new :username => 1, :password => 1 }
+
+    subject { connection }
+
+    it 'should require a username and password to be passed in the options' do
+      expect { Connection.new :password => 1 }.to raise_error ArgumentError
+      expect { Connection.new :username => 1 }.to raise_error ArgumentError
+    end
+
+    it 'should properly set the Blather logger' do
+      Connection.new :wire_logger => :foo, :username => 1, :password => 1
+      Blather.logger.should be :foo
+    end
+
+    its(:event_queue) { should be_a Queue }
+
+    it "looking up original command by command ID" do
+      offer = Event::Offer.new
+      offer.call_id = '9f00061'
+      offer.to = 'sip:whatever@127.0.0.1'
+      say = <<-MSG
+<say xmlns='urn:xmpp:tropo:say:1' voice='allison'>
+  <audio url='http://acme.com/greeting.mp3'>
+  Thanks for calling ACME company
+  </audio>
+  <audio url='http://acme.com/package-shipped.mp3'>
+  Your package was shipped on
+  </audio>
+  <say-as interpret-as='date'>12/01/2011</say-as>
+</say>
+      MSG
+      Component::Tropo::Say
+      say = RayoNode.import parse_stanza(say).root
+      connection.event_queue = []
+      connection.expects(:write_to_stream).once.returns true
+      iq = Blather::Stanza::Iq.new :set, '9f00061@call.rayo.net'
+      connection.expects(:create_iq).returns iq
+
+      write_thread = Thread.new do
+        connection.write offer.call_id, say
+      end
+
+      result = import_stanza <<-MSG
+<iq type='result' from='16577@app.rayo.net/1' to='9f00061@call.rayo.net/1' id='#{iq.id}'>
+  <ref id='fgh4590' xmlns='urn:xmpp:rayo:1' />
+</iq>
+      MSG
+
+      sleep 0.5 # Block so there's enough time for the write thread to get to the point where it's waiting on an IQ
+
+      connection.__send__ :handle_iq_result, result
+
+      write_thread.join
+
+      say.state_name.should == :executing
+
+      connection.original_component_from_id('fgh4590').should == say
+
+      example_complete = import_stanza <<-MSG
+<presence to='16577@app.rayo.net/1' from='9f00061@call.rayo.net/fgh4590'>
+  <complete xmlns='urn:xmpp:rayo:ext:1'>
+  <success xmlns='urn:xmpp:tropo:say:complete:1' />
+  </complete>
+</presence>
+      MSG
+
+      connection.__send__ :handle_presence, example_complete
+      say.event_queue.pop(false).source.should == say
+
+      say.component_id.should == 'fgh4590'
+    end
+
+    describe '#handle_presence' do
+      let :offer_xml do
+        <<-MSG
+<presence to='16577@app.rayo.net/1' from='9f00061@call.rayo.net'>
+  <offer xmlns="urn:xmpp:rayo:1" to="sip:whatever@127.0.0.1" from="sip:ylcaomxb@192.168.1.9">
+  <header name="Max-Forwards" value="70"/>
+  <header name="Content-Length" value="367"/>
+  </offer>
+</presence>
+        MSG
+      end
+
+      let(:example_offer) { import_stanza offer_xml }
+
+      it { example_offer.should be_a Blather::Stanza::Presence }
+
+      let :complete_xml do
+        <<-MSG
+<presence to='16577@app.rayo.net/1' from='9f00061@call.rayo.net/fgh4590'>
+  <complete xmlns='urn:xmpp:rayo:ext:1'>
+  <success xmlns='urn:xmpp:tropo:say:complete:1' />
+  </complete>
+</presence>
+        MSG
+      end
+
+      let(:example_complete) { import_stanza complete_xml }
+
+      it { example_complete.should be_a Blather::Stanza::Presence }
+
+      describe "event placed on the event queue" do
+        before do
+          connection.event_queue = []
+        end
+
+        describe "from an offer" do
+          before do
+            connection.__send__ :handle_presence, example_offer
+          end
+
+          subject { connection.event_queue.first }
+
+          it { should be_instance_of Event::Offer }
+          its(:call_id) { should == '9f00061' }
+
+          it "should populate the call map with the domain for the call ID" do
+            callmap = connection.instance_variable_get(:'@callmap')
+            callmap['9f00061'].should == 'call.rayo.net'
+          end
+        end
+
+        describe "from a complete" do
+          before do
+            connection.__send__ :handle_presence, example_complete
+          end
+
+          subject { connection.event_queue.first }
+
+          it { should be_instance_of Event::Complete }
+          its(:call_id)     { should == '9f00061' }
+          its(:connection)  { should == connection }
+        end
+
+        describe "from something that's not a real event" do
+          let :irrelevant_xml do
+            <<-MSG
+<presence to='16577@app.rayo.net/1' from='9f00061@call.rayo.net/fgh4590'>
+  <foo/>
+</presence>
+            MSG
+          end
+
+          let(:example_irrelevant_event) { import_stanza irrelevant_xml }
+
+          before do
+            lambda { connection.__send__ :handle_presence, example_irrelevant_event }.should throw_symbol(:pass)
+          end
+
+          subject { connection.event_queue }
+
+          it { should be_empty }
+        end
+      end
+    end
+
+    describe "#handle_error" do
+      let(:call_id)       { "f6d437f4-1e18-457b-99f8-b5d853f50347" }
+      let(:component_id)  { 'abc123' }
+      let :error_xml do
+        <<-MSG
+<iq type="error" id="blather000e" from="f6d437f4-1e18-457b-99f8-b5d853f50347@10.0.1.11/abc123" to="usera@10.0.1.11/voxeo">
+  <output xmlns="urn:xmpp:rayo:output:1"/>
+  <error type="cancel">
+    <item-not-found xmlns="urn:ietf:params:xml:ns:xmpp-stanzas"/>
+    <text xmlns="urn:ietf:params:xml:ns:xmpp-stanzas" lang="en">Could not find call [id=f6d437f4-1e18-457b-99f8-b5d853f50347]</text>
+  </error>
+</iq>
+        MSG
+      end
+
+      let(:example_error) { import_stanza error_xml }
+      let(:cmd) { Component::Output.new }
+
+      before(:all) do
+        cmd.request!
+        connection.instance_variable_get(:'@iq_id_to_command')['blather000e'] = cmd
+        connection.__send__ :handle_error, example_error
+      end
+
+      subject { cmd.response }
+
+      its(:call_id)       { should == call_id }
+      its(:component_id)  { should == component_id }
+      its(:name)          { should == :item_not_found }
+      its(:text)          { should == 'Could not find call [id=f6d437f4-1e18-457b-99f8-b5d853f50347]' }
+    end
+  end # describe Connection
+end # Punchblock

data/spec/punchblock/event/answered_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Answered do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:answered, 'urn:xmpp:rayo:1').should == Answered
+      end
+
+      describe "from a stanza" do
+        let(:stanza) { '<answered xmlns="urn:xmpp:rayo:1"/>' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Answered }
+
+        it_should_behave_like 'event'
+
+        its(:xmlns) { should == 'urn:xmpp:rayo:1' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/complete_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Complete do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:complete, 'urn:xmpp:rayo:ext:1').should == Complete
+      end
+
+      describe "from a stanza" 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, '9f00061', '1' }
+
+        it { should be_instance_of Complete }
+
+        it_should_behave_like 'event'
+
+        its(:reason) { should be_instance_of Component::Tropo::Say::Complete::Success }
+      end
+    end
+
+    describe Complete::Stop do
+      let :stanza do
+        <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <stop xmlns='urn:xmpp:rayo:ext:complete:1' />
+</complete>
+        MESSAGE
+      end
+
+      subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+      it { should be_instance_of Complete::Stop }
+
+      its(:name) { should == :stop }
+    end
+
+    describe Complete::Hangup do
+      let :stanza do
+        <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <hangup xmlns='urn:xmpp:rayo:ext:complete:1' />
+</complete>
+        MESSAGE
+      end
+
+      subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+      it { should be_instance_of Complete::Hangup }
+
+      its(:name) { should == :hangup }
+    end
+
+    describe Complete::Error do
+      let :stanza do
+        <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+  <error xmlns='urn:xmpp:rayo:ext:complete:1'>
+    Something really bad happened
+  </error>
+</complete>
+        MESSAGE
+      end
+
+      subject { RayoNode.import(parse_stanza(stanza).root).reason }
+
+      it { should be_instance_of Complete::Error }
+
+      its(:name) { should == :error }
+      its(:details) { should == "Something really bad happened" }
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/dtmf_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe DTMF do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:dtmf, 'urn:xmpp:rayo:1').should == DTMF
+      end
+
+      describe "from a stanza" do
+        let(:stanza) { "<dtmf xmlns='urn:xmpp:rayo:1' signal='#' />" }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of DTMF }
+
+        it_should_behave_like 'event'
+
+        its(:signal) { should == '#' }
+        its(:xmlns) { should == 'urn:xmpp:rayo:1' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/end_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe End do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:end, 'urn:xmpp:rayo:1').should == End
+      end
+
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<end xmlns="urn:xmpp:rayo:1">
+  <timeout />
+</end>
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of End }
+
+        it_should_behave_like 'event'
+
+        its(:reason) { should == :timeout }
+        its(:xmlns) { should == 'urn:xmpp:rayo:1' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/info_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Info do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:info, 'urn:xmpp:rayo:1').should == Info
+      end
+
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<info xmlns='urn:xmpp:rayo:1'>
+  <something/>
+</info>
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Info }
+
+        it_should_behave_like 'event'
+
+        its(:event_name) { should == :something }
+        its(:xmlns) { should == 'urn:xmpp:rayo:1' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/joined_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Joined do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:joined, 'urn:xmpp:rayo:1').should == Joined
+      end
+
+      describe "from a stanza" do
+        let(:stanza) { '<joined xmlns="urn:xmpp:rayo:1" call-id="b" mixer-id="m" />' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Joined }
+
+        it_should_behave_like 'event'
+
+        its(:other_call_id) { should == 'b' }
+        its(:mixer_id)      { should == 'm' }
+        its(:xmlns)         { should == 'urn:xmpp:rayo:1' }
+      end
+
+      describe "when setting options in initializer" do
+        subject { Joined.new :other_call_id => 'abc123', :mixer_id => 'blah' }
+
+        its(:other_call_id) { should == 'abc123' }
+        its(:mixer_id)      { should == 'blah' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/offer_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Offer do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:offer, 'urn:xmpp:rayo:1').should == Offer
+      end
+
+      describe "from a stanza" do
+        let :stanza do
+          <<-MESSAGE
+<offer xmlns='urn:xmpp:rayo:1'
+    to='tel:+18003211212'
+    from='tel:+13058881212'>
+  <!-- Signaling (e.g. SIP) Headers -->
+  <header name="x-skill" value="agent" />
+  <header name="x-customer-id" value="8877" />
+</offer>
+          MESSAGE
+        end
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Offer }
+
+        it_should_behave_like 'event'
+        it_should_behave_like 'event_headers'
+
+        its(:to) { should == 'tel:+18003211212' }
+        its(:from) { should == 'tel:+13058881212' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/ringing_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Ringing do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:ringing, 'urn:xmpp:rayo:1').should == Ringing
+      end
+
+      describe "from a stanza" do
+        let(:stanza) { '<ringing xmlns="urn:xmpp:rayo:1"/>' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Ringing }
+
+        it_should_behave_like 'event'
+
+        its(:xmlns) { should == 'urn:xmpp:rayo:1' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/event/unjoined_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Punchblock
+  class Event
+    describe Unjoined do
+      it 'registers itself' do
+        RayoNode.class_from_registration(:unjoined, 'urn:xmpp:rayo:1').should == Unjoined
+      end
+
+      describe "from a stanza" do
+        let(:stanza) { '<unjoined xmlns="urn:xmpp:rayo:1" call-id="b" mixer-id="m" />' }
+
+        subject { RayoNode.import parse_stanza(stanza).root, '9f00061', '1' }
+
+        it { should be_instance_of Unjoined }
+
+        it_should_behave_like 'event'
+
+        its(:other_call_id) { should == 'b' }
+        its(:mixer_id)      { should == 'm' }
+        its(:xmlns)         { should == 'urn:xmpp:rayo:1' }
+      end
+
+      describe "when setting options in initializer" do
+        subject { Unjoined.new :other_call_id => 'abc123', :mixer_id => 'blah' }
+
+        its(:other_call_id) { should == 'abc123' }
+        its(:mixer_id)      { should == 'blah' }
+      end
+    end
+  end
+end # Punchblock

data/spec/punchblock/header_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Punchblock
+  describe Header do
+    it 'will auto-inherit nodes' do
+      n = parse_stanza "<header name='boo' value='bah' />"
+      h = Header.new n.root
+      h.name.should == :boo
+      h.value.should == 'bah'
+    end
+
+    it 'has a name attribute' do
+      n = Header.new :boo, 'bah'
+      n.name.should == :boo
+      n.name = :foo
+      n.name.should == :foo
+    end
+
+    it "substitutes - for _ on the name attribute when reading" do
+      n = parse_stanza "<header name='boo-bah' value='foo' />"
+      h = Header.new n.root
+      h.name.should == :boo_bah
+    end
+
+    it "substitutes _ for - on the name attribute when writing" do
+      h = Header.new :boo_bah, 'foo'
+      h.to_xml.should == '<header name="boo-bah" value="foo"/>'
+    end
+
+    it 'has a value attribute' do
+      n = Header.new :boo, 'en'
+      n.value.should == 'en'
+      n.value = 'de'
+      n.value.should == 'de'
+    end
+
+    it 'can determine equality' do
+      a = Header.new :boo, 'bah'
+      a.should == Header.new(:boo, 'bah')
+      a.should_not == Header.new(:bah, 'bah')
+      a.should_not == Header.new(:boo, 'boo')
+    end
+  end
+end # Punchblock

data/spec/punchblock/protocol_error_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+module Punchblock
+  describe ProtocolError do
+    subject { ProtocolError.new :item_not_found, 'Could not find call [id=f6d437f4-1e18-457b-99f8-b5d853f50347]', 'f6d437f4-1e18-457b-99f8-b5d853f50347', 'abc123' }
+
+    its(:inspect) { should == '#<Punchblock::ProtocolError: name=:item_not_found text="Could not find call [id=f6d437f4-1e18-457b-99f8-b5d853f50347]" call_id="f6d437f4-1e18-457b-99f8-b5d853f50347" component_id="abc123">' }
+  end
+end