punchblock 0.6.1 → 0.6.2

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

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module Asterisk
+          describe AMIAction do
+            let(:mock_translator) { mock 'Translator::Asterisk' }
+
+            let :command do
+              Punchblock::Component::Asterisk::AMI::Action.new :name => 'ExtensionStatus', :params => { :context => 'default', :exten => 'idonno' }
+            end
+
+            subject { AMIAction.new command, mock_translator }
+
+            let :expected_action do
+              RubyAMI::Action.new 'ExtensionStatus', 'Context' => 'default', 'Exten' => 'idonno'
+            end
+
+            context 'initial execution' do
+              let(:component_id) { UUIDTools::UUID.random_create }
+
+              let :expected_response do
+                Ref.new :id => component_id
+              end
+
+              before { UUIDTools::UUID.stubs :random_create => component_id }
+
+              it 'should send the appropriate RubyAMI::Action and send the component node a ref with the action ID' do
+                mock_translator.expects(:send_ami_action!).once.with(expected_action).returns(expected_action)
+                command.expects(:response=).once.with(expected_response)
+                subject.execute
+              end
+            end
+
+            context 'when the AMI action completes' do
+              before do
+                command.request!
+                command.execute!
+              end
+
+              let :response do
+                RubyAMI::Response.new.tap do |r|
+                  r['ActionID'] = "552a9d9f-46d7-45d8-a257-06fe95f48d99"
+                  r['Message']  = 'Channel status will follow'
+                  r["Exten"]    = "idonno"
+                  r["Context"]  = "default"
+                  r["Hint"]     = ""
+                  r["Status"]   = "-1"
+                end
+              end
+
+              let :expected_complete_reason do
+                Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => 'Channel status will follow', :attributes => {:exten => "idonno", :context => "default", :hint => "", :status => "-1"}
+              end
+
+              context 'for a non-causal action' do
+                it 'should send a complete event to the component node' do
+                  subject.action.response = response
+
+                  command.should be_complete
+
+                  complete_event = command.complete_event.resource(0.5)
+
+                  complete_event.component_id.should == subject.id
+                  complete_event.reason.should == expected_complete_reason
+                end
+              end
+
+              context 'for a causal action' do
+                let :command do
+                  Punchblock::Component::Asterisk::AMI::Action.new :name => 'CoreShowChannels'
+                end
+
+                let :expected_action do
+                  RubyAMI::Action.new 'CoreShowChannels'
+                end
+
+                let :event do
+                  RubyAMI::Event.new('CoreShowChannel').tap do |e|
+                    e['ActionID']         = "552a9d9f-46d7-45d8-a257-06fe95f48d99"
+                    e['Channel']          = 'SIP/127.0.0.1-00000013'
+                    e['UniqueID']         = '1287686437.19'
+                    e['Context']          = 'adhearsion'
+                    e['Extension']        = '23432'
+                    e['Priority']         = '2'
+                    e['ChannelState']     = '6'
+                    e['ChannelStateDesc'] = 'Up'
+                  end
+                end
+
+                let :terminating_event do
+                  RubyAMI::Event.new('CoreShowChannelsComplete').tap do |e|
+                    e['EventList'] = 'Complete'
+                    e['ListItems'] = '3'
+                    e['ActionID'] = 'umtLtvSg-RN5n-GEay-Z786-YdiaSLNXkcYN'
+                  end
+                end
+
+                let :event_node do
+                  Punchblock::Event::Asterisk::AMI::Event.new :name => 'CoreShowChannel', :component_id => subject.id, :attributes => {
+                    :channel          => 'SIP/127.0.0.1-00000013',
+                    :uniqueid         => '1287686437.19',
+                    :context          => 'adhearsion',
+                    :extension        => '23432',
+                    :priority         => '2',
+                    :channelstate     => '6',
+                    :channelstatedesc => 'Up'
+                  }
+                end
+
+                let :expected_complete_reason do
+                  Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => 'Channel status will follow', :attributes => {:exten => "idonno", :context => "default", :hint => "", :status => "-1", :eventlist => 'Complete', :listitems => '3'}
+                end
+
+                it 'should send events to the component node' do
+                  command.register_event_handler Punchblock::Event::Asterisk::AMI::Event do |event|
+                    @event = event
+                  end
+                  subject.action << event
+                  subject.action << response
+                  subject.action << terminating_event
+                  @event.should == event_node
+                end
+
+                it 'should send a complete event to the component node' do
+                  subject.action << response
+                  subject.action << terminating_event
+
+                  command.complete_event.resource(0.5).reason.should == expected_complete_reason
+                end
+              end
+
+              context 'with an error' do
+                let :error do
+                  RubyAMI::Error.new.tap { |e| e.message = 'Action failed' }
+                end
+
+                let :expected_complete_reason do
+                  Punchblock::Event::Complete::Error.new :component_id => subject.id, :details => 'Action failed'
+                end
+
+                it 'should send a complete event to the component node' do
+                  subject.action << error
+
+                  complete_event = command.complete_event.resource(0.5)
+
+                  complete_event.component_id.should == subject.id
+                  complete_event.reason.should == expected_complete_reason
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/punchblock/translator/asterisk_spec.rb

@@ -51,32 +51,43 @@ module Punchblock
       end
 
       describe '#register_call' do
-        it 'should make the call accessible by ID' do
-          call_id = 'abc123'
-          call    = mock 'Translator::Asterisk::Call', :id => call_id
+        let(:call_id) { 'abc123' }
+        let(:channel) { 'SIP/foo' }
+        let(:call)    { Translator::Asterisk::Call.new channel, subject }
+
+        before do
+          call.stubs(:id).returns call_id
           subject.register_call call
+        end
+
+        it 'should make the call accessible by ID' do
           subject.call_with_id(call_id).should be call
         end
+
+        it 'should make the call accessible by ID' do
+          subject.call_for_channel(channel).should be call
+        end
       end
 
       describe '#execute_call_command' do
         let(:call_id) { 'abc123' }
-        let(:call)    { mock 'Translator::Asterisk::Call', :id => call_id }
+        let(:call)    { Translator::Asterisk::Call.new 'SIP/foo', subject }
         let(:command) { mock 'Command::Answer', :call_id => call_id }
 
         before do
+          call.stubs(:id).returns call_id
           subject.register_call call
         end
 
         it 'sends the command to the call for execution' do
-          call.expects(:execute_command).once.with command
+          call.expects(:execute_command!).once.with command
           subject.execute_call_command command
         end
       end
 
       describe '#execute_component_command' do
         let(:call_id) { 'abc123' }
-        let(:call)    { Translator::Asterisk::Call.new }
+        let(:call)    { Translator::Asterisk::Call.new 'SIP/foo', subject }
 
         let(:component_id)  { '123abc' }
         let(:component)     { mock 'Translator::Asterisk::Component', :id => component_id }
@@ -90,7 +101,7 @@ module Punchblock
         end
 
         it 'sends the command to the component for execution' do
-          component.expects(:execute_command).once.with command
+          component.expects(:execute_command!).once.with command
           subject.execute_component_command command
         end
       end
@@ -105,16 +116,24 @@ module Punchblock
             Component::Asterisk::AMI::Action.new :name => 'Status', :params => { :channel => 'foo' }
           end
 
-          let(:mock_action) { mock 'Asterisk::AMIAction' }
+          let(:mock_action) { mock 'Asterisk::Component::Asterisk::AMIAction' }
 
           it 'should create a component actor and execute it asynchronously' do
-            Asterisk::AMIAction.expects(:new).once.with(command, subject.ami_client).returns mock_action
+            Asterisk::Component::Asterisk::AMIAction.expects(:new).once.with(command, subject).returns mock_action
             mock_action.expects(:execute!).once
             subject.execute_global_command command
           end
         end
       end
 
+      describe '#handle_pb_event' do
+        it 'should forward the event to the connection' do
+          event = mock 'Punchblock::Event'
+          subject.connection.expects(:handle_event).once.with event
+          subject.handle_pb_event event
+        end
+      end
+
       describe '#handle_ami_event' do
         let :ami_event do
           RubyAMI::Event.new('Newchannel').tap do |e|
@@ -145,7 +164,6 @@ module Punchblock
           end
         end
 
-
         describe 'with a FullyBooted event' do
           let(:ami_event) { RubyAMI::Event.new 'FullyBooted' }
 
@@ -164,6 +182,68 @@ module Punchblock
             end
           end
         end
+
+        describe 'with an AsyncAGI Start event' do
+          let :ami_event do
+            RubyAMI::Event.new('AsyncAGI').tap do |e|
+              e['SubEvent'] = "Start"
+              e['Channel']  = "SIP/1234-00000000"
+              e['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"
+            end
+          end
+
+          before { subject.actor_subject.stubs :handle_pb_event }
+
+          it 'should be able to look up the call by channel ID' do
+            subject.handle_ami_event ami_event
+            call_actor = subject.call_for_channel('SIP/1234-00000000')
+            call_actor.actor_subject.should be_a Asterisk::Call
+            call_actor.agi_env.should be_a Hash
+            call_actor.agi_env[:agi_request].should == 'async'
+          end
+
+          it 'should instruct the call to send an offer' do
+            mock_call = stub_everything 'Asterisk::Call'
+            Asterisk::Call.expects(:new).once.returns mock_call
+            mock_call.expects(:send_offer!).once
+            subject.handle_ami_event ami_event
+          end
+        end
+
+        describe 'with an AMI event for a known channel' do
+          let :ami_event do
+            RubyAMI::Event.new('Hangup').tap do |e|
+              e['Uniqueid']     = "1320842458.8"
+              e['Calleridnum']  = "5678"
+              e['Calleridname'] = "Jane Smith"
+              e['Cause']        = "0"
+              e['Cause-txt']    = "Unknown"
+              e['Channel']      = "SIP/1234-00000000"
+            end
+          end
+
+          let(:call) do
+            Asterisk::Call.new "SIP/1234-00000000", subject, "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"
+          end
+
+          before do
+            subject.actor_subject.stubs :handle_pb_event
+            subject.register_call call
+          end
+
+          it 'sends the AMI event to the call and to the connection as a PB event' do
+            subject.actor_subject.expects(:handle_pb_event).once
+            call.expects(:process_ami_event!).once.with ami_event
+            subject.handle_ami_event ami_event
+          end
+        end
+      end
+
+      describe '#send_ami_action' do
+        it 'should send the action to the AMI client' do
+          ami_client.expects(:send_action).once.with 'foo', :foo => :bar
+          subject.send_ami_action 'foo', :foo => :bar
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-08 00:00:00.000000000 Z
+date: 2011-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2164783340 !ruby/object:Gem::Requirement
+  requirement: &2156247020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2164783340
+  version_requirements: *2156247020
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2164802760 !ruby/object:Gem::Requirement
+  requirement: &2156233680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.7
   type: :runtime
   prerelease: false
-  version_requirements: *2164802760
+  version_requirements: *2156233680
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2164801920 !ruby/object:Gem::Requirement
+  requirement: &2156232040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *2164801920
+  version_requirements: *2156232040
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2164800700 !ruby/object:Gem::Requirement
+  requirement: &2156214220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164800700
+  version_requirements: *2156214220
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2164799620 !ruby/object:Gem::Requirement
+  requirement: &2156212640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2164799620
+  version_requirements: *2156212640
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2164798360 !ruby/object:Gem::Requirement
+  requirement: &2156189020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2164798360
+  version_requirements: *2156189020
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2164797820 !ruby/object:Gem::Requirement
+  requirement: &2156162060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164797820
+  version_requirements: *2156162060
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2164797340 !ruby/object:Gem::Requirement
+  requirement: &2156159460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164797340
+  version_requirements: *2156159460
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2164796840 !ruby/object:Gem::Requirement
+  requirement: &2156158160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2164796840
+  version_requirements: *2156158160
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2164796320 !ruby/object:Gem::Requirement
+  requirement: &2156155900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2164796320
+  version_requirements: *2156155900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164795840 !ruby/object:Gem::Requirement
+  requirement: &2156042060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +133,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2164795840
+  version_requirements: *2156042060
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2164795280 !ruby/object:Gem::Requirement
+  requirement: &2156026360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2164795280
+  version_requirements: *2156026360
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2164746600 !ruby/object:Gem::Requirement
+  requirement: &2155997320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2164746600
+  version_requirements: *2155997320
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2164745540 !ruby/object:Gem::Requirement
+  requirement: &2151923240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164745540
+  version_requirements: *2151923240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164744600 !ruby/object:Gem::Requirement
+  requirement: &2151910900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164744600
+  version_requirements: *2151910900
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2164744080 !ruby/object:Gem::Requirement
+  requirement: &2151908900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164744080
+  version_requirements: *2151908900
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2164743260 !ruby/object:Gem::Requirement
+  requirement: &2151907680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164743260
+  version_requirements: *2151907680
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2164742420 !ruby/object:Gem::Requirement
+  requirement: &2151906080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,7 +210,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164742420
+  version_requirements: *2151906080
 description: Like Rack is to Rails and Sinatra, Punchblock provides a consistent API
   on top of several underlying third-party call control protocols.
 email: punchblock@adhearsion.com
@@ -270,6 +270,7 @@ files:
 - lib/punchblock/core_ext/blather/stanza.rb
 - lib/punchblock/core_ext/blather/stanza/presence.rb
 - lib/punchblock/core_ext/celluloid.rb
+- lib/punchblock/core_ext/ruby.rb
 - lib/punchblock/dsl.rb
 - lib/punchblock/event.rb
 - lib/punchblock/event/answered.rb
@@ -293,9 +294,11 @@ files:
 - lib/punchblock/ref.rb
 - lib/punchblock/translator.rb
 - lib/punchblock/translator/asterisk.rb
-- lib/punchblock/translator/asterisk/ami_action.rb
 - lib/punchblock/translator/asterisk/call.rb
 - lib/punchblock/translator/asterisk/component.rb
+- lib/punchblock/translator/asterisk/component/asterisk.rb
+- lib/punchblock/translator/asterisk/component/asterisk/agi_command.rb
+- lib/punchblock/translator/asterisk/component/asterisk/ami_action.rb
 - lib/punchblock/version.rb
 - log/.gitkeep
 - punchblock.gemspec
@@ -336,8 +339,9 @@ files:
 - spec/punchblock/header_spec.rb
 - spec/punchblock/protocol_error_spec.rb
 - spec/punchblock/ref_spec.rb
-- spec/punchblock/translator/asterisk/ami_action_spec.rb
 - spec/punchblock/translator/asterisk/call_spec.rb
+- spec/punchblock/translator/asterisk/component/asterisk/agi_command_spec.rb
+- spec/punchblock/translator/asterisk/component/asterisk/ami_action_spec.rb
 - spec/punchblock/translator/asterisk/component_spec.rb
 - spec/punchblock/translator/asterisk_spec.rb
 - spec/spec_helper.rb
@@ -404,8 +408,9 @@ test_files:
 - spec/punchblock/header_spec.rb
 - spec/punchblock/protocol_error_spec.rb
 - spec/punchblock/ref_spec.rb
-- spec/punchblock/translator/asterisk/ami_action_spec.rb
 - spec/punchblock/translator/asterisk/call_spec.rb
+- spec/punchblock/translator/asterisk/component/asterisk/agi_command_spec.rb
+- spec/punchblock/translator/asterisk/component/asterisk/ami_action_spec.rb
 - spec/punchblock/translator/asterisk/component_spec.rb
 - spec/punchblock/translator/asterisk_spec.rb
 - spec/spec_helper.rb