punchblock 0.9.2 → 0.10.0

data/spec/punchblock/protocol_error_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -8,32 +10,32 @@ module Punchblock
     let(:component_id)  { 'abc123' }
     subject { ProtocolError.new name, text, call_id, component_id }
 
-    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">' }
+    its(:inspect) { should be == '#<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">' }
 
     describe "comparison" do
       context "with the same name, text, call ID and component ID" do
         let(:comparison) { ProtocolError.new name, text, call_id, component_id }
-        it { should == comparison }
+        it { should be == comparison }
       end
 
       context "with a different name" do
         let(:comparison) { ProtocolError.new :foo, text, call_id, component_id }
-        it { should_not == comparison }
+        it { should_not be == comparison }
       end
 
       context "with a different text" do
         let(:comparison) { ProtocolError.new name, 'foo', call_id, component_id }
-        it { should_not == comparison }
+        it { should_not be == comparison }
       end
 
       context "with a different call ID" do
         let(:comparison) { ProtocolError.new name, text, 'foo', component_id }
-        it { should_not == comparison }
+        it { should_not be == comparison }
       end
 
       context "with a different component ID" do
         let(:comparison) { ProtocolError.new name, text, call_id, 'foo' }
-        it { should_not == comparison }
+        it { should_not be == comparison }
       end
     end
   end

data/spec/punchblock/ref_spec.rb

@@ -1,9 +1,11 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
   describe Ref do
     it 'registers itself' do
-      RayoNode.class_from_registration(:ref, 'urn:xmpp:rayo:1').should == Ref
+      RayoNode.class_from_registration(:ref, 'urn:xmpp:rayo:1').should be == Ref
     end
 
     describe "from a stanza" do
@@ -15,13 +17,13 @@ module Punchblock
 
       it_should_behave_like 'event'
 
-      its(:id) { should == 'fgh4590' }
+      its(:id) { should be == 'fgh4590' }
     end
 
     describe "when setting options in initializer" do
       subject { Ref.new :id => 'foo' }
 
-      its(:id) { should == 'foo' }
+      its(:id) { should be == 'foo' }
     end
   end
 end # Punchblock

data/spec/punchblock/translator/asterisk/call_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -6,7 +8,6 @@ module Punchblock
       describe Call do
         let(:channel)         { 'SIP/foo' }
         let(:translator)      { stub_everything 'Translator::Asterisk' }
-        let(:env)             { "agi_request%3A%20async%0Aagi_channel%3A%20SIP%2F1234-00000000%0Aagi_language%3A%20en%0Aagi_type%3A%20SIP%0Aagi_uniqueid%3A%201320835995.0%0Aagi_version%3A%201.8.4.1%0Aagi_callerid%3A%205678%0Aagi_calleridname%3A%20Jane%20Smith%0Aagi_callingpres%3A%200%0Aagi_callingani2%3A%200%0Aagi_callington%3A%200%0Aagi_callingtns%3A%200%0Aagi_dnid%3A%201000%0Aagi_rdnis%3A%20unknown%0Aagi_context%3A%20default%0Aagi_extension%3A%201000%0Aagi_priority%3A%201%0Aagi_enhanced%3A%200.0%0Aagi_accountcode%3A%20%0Aagi_threadid%3A%204366221312%0A%0A" }
         let(:agi_env) do
           {
             :agi_request      => 'async',
@@ -57,12 +58,12 @@ module Punchblock
           }
         end
 
-        subject { Call.new channel, translator, env }
+        subject { Call.new channel, translator, agi_env }
 
         its(:id)          { should be_a String }
-        its(:channel)     { should == channel }
+        its(:channel)     { should be == channel }
         its(:translator)  { should be translator }
-        its(:agi_env)     { should == agi_env }
+        its(:agi_env)     { should be == agi_env }
 
         describe '#shutdown' do
           it 'should terminate the actor' do
@@ -93,7 +94,7 @@ module Punchblock
 
           it 'should make the call identify as inbound' do
             subject.send_offer
-            subject.direction.should == :inbound
+            subject.direction.should be == :inbound
             subject.inbound?.should be true
             subject.outbound?.should be false
           end
@@ -191,12 +192,12 @@ module Punchblock
           it 'sends the call ID as a response to the Dial' do
             subject.dial dial_command
             dial_command.response
-            dial_command.call_id.should == subject.id
+            dial_command.call_id.should be == subject.id
           end
 
           it 'should make the call identify as outbound' do
             subject.dial dial_command
-            subject.direction.should == :outbound
+            subject.direction.should be == :outbound
             subject.outbound?.should be true
             subject.inbound?.should be false
           end
@@ -230,10 +231,22 @@ module Punchblock
             it "should cause the actor to be terminated" do
               translator.expects(:handle_pb_event!).once
               subject.process_ami_event ami_event
-              sleep 0.5
+              sleep 5.5
               subject.should_not be_alive
             end
 
+            context "with an undefined cause" do
+              let(:cause)     { '0' }
+              let(:cause_txt) { 'Undefined' }
+
+              it 'should send an end (hangup) event to the translator' do
+                expected_end_event = Punchblock::Event::End.new :reason   => :hangup,
+                                                                :call_id  => subject.id
+                translator.expects(:handle_pb_event!).with expected_end_event
+                subject.process_ami_event ami_event
+              end
+            end
+
             context "with a normal clearing cause" do
               let(:cause)     { '16' }
               let(:cause_txt) { 'Normal Clearing' }
@@ -443,6 +456,172 @@ module Punchblock
               subject.process_ami_event ami_event
             end
           end
+
+          context 'with a BridgeExec event' do
+            let :ami_event do
+              RubyAMI::Event.new('BridgeExec').tap do |e|
+                e['Privilege'] = "call,all"
+                e['Response'] = "Success"
+                e['Channel1']  = "SIP/foo"
+                e['Channel2']  = "SIP/5678-00000000"
+              end
+            end
+
+            let(:other_channel) { 'SIP/5678-00000000' }
+            let(:other_call_id) { 'def567' }
+            let :command do
+              Punchblock::Command::Join.new :other_call_id => other_call_id
+            end
+
+            before do
+              subject.pending_joins[other_channel] = command
+              command.request!
+            end
+
+            it 'retrieves and sets success on the correct Join' do
+              subject.process_ami_event ami_event
+              command.response(0.5).should be == true
+            end
+          end
+
+          context 'with a Bridge event' do
+            let(:other_channel) { 'SIP/5678-00000000' }
+            let(:other_call_id) { 'def567' }
+            let :other_call do
+              Call.new other_channel, translator
+            end
+
+            let :ami_event do
+              RubyAMI::Event.new('Bridge').tap do |e|
+                e['Privilege']    = "call,all"
+                e['Bridgestate']  = state
+                e['Bridgetype']   = "core"
+                e['Channel1']     = channel
+                e['Channel2']     = other_channel
+                e['Uniqueid1']    = "1319717537.11"
+                e['Uniqueid2']    = "1319717537.10"
+                e['CallerID1']    = "1234"
+                e['CallerID2']    = "5678"
+              end
+            end
+
+            let :switched_ami_event do
+              RubyAMI::Event.new('Bridge').tap do |e|
+                e['Privilege']    = "call,all"
+                e['Bridgestate']  = state
+                e['Bridgetype']   = "core"
+                e['Channel1']     = other_channel
+                e['Channel2']     = channel
+                e['Uniqueid1']    = "1319717537.11"
+                e['Uniqueid2']    = "1319717537.10"
+                e['CallerID1']    = "1234"
+                e['CallerID2']    = "5678"
+              end
+            end
+
+            before do
+              translator.register_call other_call
+              translator.expects(:call_for_channel).with(other_channel).returns(other_call)
+              other_call.expects(:id).returns other_call_id
+            end
+
+            context "of state 'Link'" do
+              let(:state) { 'Link' }
+
+              let :expected_joined do
+                Punchblock::Event::Joined.new.tap do |joined|
+                  joined.call_id = subject.id
+                  joined.other_call_id = other_call_id
+                end
+              end
+
+              it 'sends the Joined event when the call is the first channel' do
+                translator.expects(:handle_pb_event!).with expected_joined
+                subject.process_ami_event ami_event
+              end
+
+              it 'sends the Joined event when the call is the second channel' do
+                translator.expects(:handle_pb_event!).with expected_joined
+                subject.process_ami_event switched_ami_event
+              end
+            end
+
+            context "of state 'Unlink'" do
+              let(:state) { 'Unlink' }
+
+              let :expected_unjoined do
+                Punchblock::Event::Unjoined.new.tap do |joined|
+                  joined.call_id = subject.id
+                  joined.other_call_id = other_call_id
+                end
+              end
+
+              it 'sends the Unjoined event when the call is the first channel' do
+                translator.expects(:handle_pb_event!).with expected_unjoined
+                subject.process_ami_event ami_event
+              end
+
+              it 'sends the Unjoined event when the call is the second channel' do
+                translator.expects(:handle_pb_event!).with expected_unjoined
+                subject.process_ami_event switched_ami_event
+              end
+            end
+          end
+
+          context 'with an Unlink event' do
+            let(:other_channel) { 'SIP/5678-00000000' }
+            let(:other_call_id) { 'def567' }
+            let :other_call do
+              Call.new other_channel, translator
+            end
+
+            let :ami_event do
+              RubyAMI::Event.new('Unlink').tap do |e|
+                e['Privilege']    = "call,all"
+                e['Channel1']     = channel
+                e['Channel2']     = other_channel
+                e['Uniqueid1']    = "1319717537.11"
+                e['Uniqueid2']    = "1319717537.10"
+                e['CallerID1']    = "1234"
+                e['CallerID2']    = "5678"
+              end
+            end
+
+            let :switched_ami_event do
+              RubyAMI::Event.new('Unlink').tap do |e|
+                e['Privilege']    = "call,all"
+                e['Channel1']     = other_channel
+                e['Channel2']     = channel
+                e['Uniqueid1']    = "1319717537.11"
+                e['Uniqueid2']    = "1319717537.10"
+                e['CallerID1']    = "1234"
+                e['CallerID2']    = "5678"
+              end
+            end
+
+            before do
+              translator.register_call other_call
+              translator.expects(:call_for_channel).with(other_channel).returns(other_call)
+              other_call.expects(:id).returns other_call_id
+            end
+
+            let :expected_unjoined do
+              Punchblock::Event::Unjoined.new.tap do |joined|
+                joined.call_id = subject.id
+                joined.other_call_id = other_call_id
+              end
+            end
+
+            it 'sends the Unjoined event when the call is the first channel' do
+              translator.expects(:handle_pb_event!).with expected_unjoined
+              subject.process_ami_event ami_event
+            end
+
+            it 'sends the Unjoined event when the call is the second channel' do
+              translator.expects(:handle_pb_event!).with expected_unjoined
+              subject.process_ami_event switched_ami_event
+            end
+          end
         end
 
         describe '#execute_command' do
@@ -465,7 +644,7 @@ module Punchblock
               component = subject.execute_command command
               component.internal.should be_true
               agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
-              agi_command.name.should == "EXEC RINGING"
+              agi_command.name.should be == "EXEC RINGING"
               agi_command.execute!
               agi_command.add_event expected_agi_complete_event
               command.response(0.5).should be true
@@ -479,7 +658,7 @@ module Punchblock
               component = subject.execute_command command
               component.internal.should be_true
               agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
-              agi_command.name.should == "EXEC ANSWER"
+              agi_command.name.should be == "EXEC ANSWER"
               agi_command.execute!
               agi_command.add_event expected_agi_complete_event
               command.response(0.5).should be true
@@ -492,7 +671,7 @@ module Punchblock
             it "should send a Hangup AMI command and set the command's response" do
               subject.execute_command command
               ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
-              ami_action.name.should == "hangup"
+              ami_action.name.should be == "hangup"
               ami_action << RubyAMI::Response.new
               command.response(0.5).should be true
             end
@@ -566,7 +745,7 @@ module Punchblock
             context "for an unknown component ID" do
               it 'sends an error in response to the command' do
                 subject.execute_command command
-                command.response.should == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id} for call #{subject.id}", subject.id, component_id)
+                command.response.should be == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id} for call #{subject.id}", subject.id, component_id)
               end
             end
           end
@@ -578,10 +757,78 @@ module Punchblock
 
             it 'sends an error in response to the command' do
               subject.execute_command command
-              command.response.should == ProtocolError.new('command-not-acceptable', "Did not understand command for call #{subject.id}", subject.id)
+              command.response.should be == ProtocolError.new('command-not-acceptable', "Did not understand command for call #{subject.id}", subject.id)
             end
           end
-        end
+
+          context "with a join command" do
+            let(:other_call_id)         { "abc123" }
+            let(:other_channel)         { 'SIP/bar' }
+            let(:other_translator)      { stub_everything 'Translator::Asterisk' }
+
+            let :other_call do
+              Call.new other_channel, other_translator
+            end
+
+            let :command do
+              Punchblock::Command::Join.new :other_call_id => other_call_id
+            end
+
+            it "executes the proper dialplan Bridge application" do
+              translator.expects(:call_with_id).with(other_call_id).returns(other_call)
+              subject.execute_command command
+              agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
+              agi_command.name.should be == "EXEC Bridge"
+              agi_command.params_array.should be == [other_channel]
+            end
+
+            it "adds the join to the @pending_joins hash" do
+              translator.expects(:call_with_id).with(other_call_id).returns(other_call)
+              subject.execute_command command
+              subject.pending_joins[other_channel].should be command
+            end
+          end
+
+          context "with an unjoin command" do
+            let(:other_call_id)         { "abc123" }
+            let(:other_channel)         { 'SIP/bar' }
+
+            let :other_call do
+              Call.new other_channel, translator
+            end
+
+            let :command do
+              Punchblock::Command::Unjoin.new :other_call_id => other_call_id
+            end
+
+            it "executes the unjoin through redirection" do
+              translator.expects(:call_with_id).with(other_call_id).returns(nil)
+              subject.execute_command command
+              ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
+              ami_action.name.should be == "redirect"
+              ami_action.headers['Channel'].should be == channel
+              ami_action.headers['Exten'].should be == Punchblock::Translator::Asterisk::REDIRECT_EXTENSION
+              ami_action.headers['Priority'].should be == Punchblock::Translator::Asterisk::REDIRECT_PRIORITY
+              ami_action.headers['Context'].should be == Punchblock::Translator::Asterisk::REDIRECT_CONTEXT
+            end
+
+            it "executes the unjoin through redirection, on the subject call and the other call" do
+              translator.expects(:call_with_id).with(other_call_id).returns(other_call)
+              subject.execute_command command
+              ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
+              ami_action.name.should be == "redirect"
+              ami_action.headers['Channel'].should be == channel
+              ami_action.headers['Exten'].should be == Punchblock::Translator::Asterisk::REDIRECT_EXTENSION
+              ami_action.headers['Priority'].should be == Punchblock::Translator::Asterisk::REDIRECT_PRIORITY
+              ami_action.headers['Context'].should be == Punchblock::Translator::Asterisk::REDIRECT_CONTEXT
+
+              ami_action.headers['ExtraChannel'].should be == other_channel
+              ami_action.headers['ExtraExten'].should be == Punchblock::Translator::Asterisk::REDIRECT_EXTENSION
+              ami_action.headers['ExtraPriority'].should be == Punchblock::Translator::Asterisk::REDIRECT_PRIORITY
+              ami_action.headers['ExtraContext'].should be == Punchblock::Translator::Asterisk::REDIRECT_CONTEXT
+            end
+          end
+        end#execute_command
 
         describe '#send_agi_action' do
           it 'should send an appropriate AsyncAGI AMI action' do

data/spec/punchblock/translator/asterisk/component/asterisk/agi_command_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -118,8 +120,8 @@ module Punchblock
 
                   complete_event = command.complete_event 0.5
 
-                  complete_event.component_id.should == component_id.to_s
-                  complete_event.reason.should == expected_complete_reason
+                  complete_event.component_id.should be == component_id.to_s
+                  complete_event.reason.should be == expected_complete_reason
                 end
               end
             end
@@ -130,9 +132,9 @@ module Punchblock
 
                 it 'should provide the code and result' do
                   code, result, data = subject.parse_agi_result result_string
-                  code.should   == 200
-                  result.should == 123
-                  data.should   == ''
+                  code.should be == 200
+                  result.should be == 123
+                  data.should be == ''
                 end
               end
 
@@ -141,9 +143,9 @@ module Punchblock
 
                 it 'should provide the code and result' do
                   code, result, data = subject.parse_agi_result result_string
-                  code.should   == 200
-                  result.should == -123
-                  data.should   == 'timeout'
+                  code.should be == 200
+                  result.should be == -123
+                  data.should be == 'timeout'
                 end
               end
 
@@ -152,9 +154,9 @@ module Punchblock
 
                 it 'should provide the code and result' do
                   code, result, data = subject.parse_agi_result result_string
-                  code.should   == 200
-                  result.should == 123
-                  data.should   == 'foo=bar'
+                  code.should be == 200
+                  result.should be == 123
+                  data.should be == 'foo=bar'
                 end
               end
             end

data/spec/punchblock/translator/asterisk/component/asterisk/ami_action_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -122,14 +124,14 @@ module Punchblock
                   action << event
                   subject.handle_response response
                   action << terminating_event
-                  @event.should == event_node
+                  @event.should be == event_node
                 end
 
                 it 'should send a complete event to the component node' do
                   subject.action << response
                   subject.action << terminating_event
 
-                  command.complete_event(0.5).reason.should == expected_complete_reason
+                  command.complete_event(0.5).reason.should be == expected_complete_reason
                 end
               end
 

data/spec/punchblock/translator/asterisk/component/input_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -98,7 +100,7 @@ module Punchblock
                   end
 
                   it "should send a success complete event with the relevant data" do
-                    reason.should == expected_event
+                    reason.should be == expected_event
                   end
                 end
 
@@ -114,7 +116,7 @@ module Punchblock
                   end
 
                   it "should send a nomatch complete event" do
-                    reason.should == expected_event
+                    reason.should be == expected_event
                   end
                 end
               end
@@ -125,7 +127,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A grammar document is required.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -136,7 +138,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A mode value other than DTMF is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
 
@@ -145,7 +147,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A mode value other than DTMF is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
 
@@ -154,7 +156,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A mode value other than DTMF is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -212,7 +214,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'An initial timeout value that is negative (and not -1) is invalid.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -264,7 +266,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'An inter-digit timeout value that is negative (and not -1) is invalid.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end