punchblock 0.6.1 → 0.6.2

data/lib/punchblock/translator/asterisk/component/asterisk/agi_command.rb

@@ -0,0 +1,84 @@
+require 'uri'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module Asterisk
+          class AGICommand < Component
+            attr_reader :action
+
+            def initialize(component_node, call)
+              @component_node, @call = component_node, call
+              @id = UUIDTools::UUID.random_create.to_s
+              @action = create_action
+              pb_logger.debug "Starting up..."
+            end
+
+            def execute
+              @call.send_ami_action! @action
+            end
+
+            def handle_ami_event(event)
+              pb_logger.debug "Handling AMI event: #{event.inspect}"
+              if event.name == 'AsyncAGI'
+                if event['SubEvent'] == 'Exec'
+                  pb_logger.debug "Received AsyncAGI:Exec event, sending complete event."
+                  send_event complete_event(success_reason(event))
+                end
+              end
+            end
+
+            def parse_agi_result(result)
+              match = URI.decode(result).chomp.match(/^(\d{3}) result=(-?\d*) ?(\(?.*\)?)?$/)
+              if match
+                data = match[3] ? match[3].gsub(/(^\()|(\)$)/, '') : nil
+                [match[1].to_i, match[2].to_i, data]
+              end
+            end
+
+            private
+
+            def create_action
+              RubyAMI::Action.new 'AGI', 'Channel' => @call.channel, 'Command' => @component_node.name, 'CommandID' => id do |response|
+                handle_response response
+              end
+            end
+
+            def handle_response(response)
+              pb_logger.debug "Handling response: #{response.inspect}"
+              case response
+              when RubyAMI::Error
+                set_node_response false
+              when RubyAMI::Response
+                set_node_response Ref.new :id => id
+              end
+            end
+
+            def set_node_response(value)
+              pb_logger.debug "Setting response on component node to #{value}"
+              @component_node.response = value
+            end
+
+            def success_reason(event)
+              code, result, data = parse_agi_result event['Result']
+              Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new :code => code, :result => result, :data => data
+            end
+
+            def complete_event(reason)
+              Punchblock::Event::Complete.new.tap do |c|
+                c.reason = reason
+              end
+            end
+
+            def send_event(event)
+              event.component_id = id
+              pb_logger.debug "Sending event #{event.inspect}"
+              @component_node.add_event event
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/translator/asterisk/component/asterisk/ami_action.rb

@@ -0,0 +1,96 @@
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module Asterisk
+          class AMIAction < Component
+            attr_reader :action
+
+            def initialize(component_node, translator)
+              @component_node, @translator = component_node, translator
+              @action = create_action
+              @id = @action.action_id
+              pb_logger.debug "Starting up..."
+            end
+
+            def execute
+              send_action
+              send_ref
+            end
+
+            private
+
+            def create_action
+              headers = {}
+              @component_node.params_hash.each_pair do |key, value|
+                headers[key.to_s.capitalize] = value
+              end
+              RubyAMI::Action.new @component_node.name, headers do |response|
+                handle_response response
+              end
+            end
+
+            def send_action
+              @translator.send_ami_action! @action
+            end
+
+            def send_ref
+              @component_node.response = Ref.new :id => @action.action_id
+            end
+
+            def handle_response(response)
+              pb_logger.debug "Handling response #{response.inspect}"
+              case response
+              when RubyAMI::Error
+                send_event complete_event(error_reason(response))
+              when RubyAMI::Response
+                send_events
+                send_event complete_event(success_reason(response))
+              end
+            end
+
+            def error_reason(response)
+              Punchblock::Event::Complete::Error.new :details => response.message
+            end
+
+            def success_reason(response)
+              headers = response.headers
+              headers.merge! @extra_complete_attributes if @extra_complete_attributes
+              headers.delete 'ActionID'
+              Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => headers.delete('Message'), :attributes => headers
+            end
+
+            def complete_event(reason)
+              Punchblock::Event::Complete.new.tap do |c|
+                c.reason = reason
+              end
+            end
+
+            def send_events
+              return unless @action.has_causal_events?
+              @action.events.each do |e|
+                if e.name.downcase == @action.causal_event_terminator_name
+                  @extra_complete_attributes = e.headers
+                else
+                  send_event pb_event_from_ami_event(e)
+                end
+              end
+            end
+
+            def pb_event_from_ami_event(ami_event)
+              headers = ami_event.headers
+              headers.delete 'ActionID'
+              Event::Asterisk::AMI::Event.new :name => ami_event.name, :attributes => headers
+            end
+
+            def send_event(event)
+              event.component_id = id
+              pb_logger.debug "Sending event #{event}"
+              @component_node.add_event event
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/punchblock/connection/xmpp_spec.rb

@@ -19,8 +19,10 @@ module Punchblock
       end
 
       it 'should properly set the Blather logger' do
-        XMPP.new :wire_logger => :foo, :username => 1, :password => 1
+        Punchblock.logger = :foo
+        XMPP.new :username => '1@call.rayo.net', :password => 1
         Blather.logger.should be :foo
+        Punchblock.reset_logger
       end
 
       it "looking up original command by command ID" do

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

@@ -4,6 +4,66 @@ module Punchblock
   module Translator
     class Asterisk
       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',
+            :agi_channel      => 'SIP/1234-00000000',
+            :agi_language     => 'en',
+            :agi_type         => 'SIP',
+            :agi_uniqueid     => '1320835995.0',
+            :agi_version      => '1.8.4.1',
+            :agi_callerid     => '5678',
+            :agi_calleridname => 'Jane Smith',
+            :agi_callingpres  => '0',
+            :agi_callingani2  => '0',
+            :agi_callington   => '0',
+            :agi_callingtns   => '0',
+            :agi_dnid         => '1000',
+            :agi_rdnis        => 'unknown',
+            :agi_context      => 'default',
+            :agi_extension    => '1000',
+            :agi_priority     => '1',
+            :agi_enhanced     => '0.0',
+            :agi_accountcode  => '',
+            :agi_threadid     => '4366221312'
+          }
+        end
+
+        let :sip_headers do
+          {
+            :x_agi_request      => 'async',
+            :x_agi_channel      => 'SIP/1234-00000000',
+            :x_agi_language     => 'en',
+            :x_agi_type         => 'SIP',
+            :x_agi_uniqueid     => '1320835995.0',
+            :x_agi_version      => '1.8.4.1',
+            :x_agi_callerid     => '5678',
+            :x_agi_calleridname => 'Jane Smith',
+            :x_agi_callingpres  => '0',
+            :x_agi_callingani2  => '0',
+            :x_agi_callington   => '0',
+            :x_agi_callingtns   => '0',
+            :x_agi_dnid         => '1000',
+            :x_agi_rdnis        => 'unknown',
+            :x_agi_context      => 'default',
+            :x_agi_extension    => '1000',
+            :x_agi_priority     => '1',
+            :x_agi_enhanced     => '0.0',
+            :x_agi_accountcode  => '',
+            :x_agi_threadid     => '4366221312'
+          }
+        end
+
+        subject { Call.new channel, translator, env }
+
+        its(:id)          { should be_a String }
+        its(:channel)     { should == channel }
+        its(:translator)  { should be translator }
+        its(:agi_env)     { should == agi_env }
+
         describe '#register_component' do
           it 'should make the component accessible by ID' do
             component_id = 'abc123'
@@ -12,6 +72,152 @@ module Punchblock
             subject.component_with_id(component_id).should be component
           end
         end
+
+        describe '#send_offer' do
+          it 'sends an offer to the translator' do
+            expected_offer = Punchblock::Event::Offer.new :call_id  => subject.id,
+                                                          :to       => '1000',
+                                                          :from     => 'sip:5678',
+                                                          :headers  => sip_headers
+            translator.expects(:handle_pb_event!).with expected_offer
+            subject.send_offer
+          end
+        end
+
+        describe '#process_ami_event' do
+          context 'with a Hangup event' 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
+
+            it 'should send an end 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 an event for a known AGI command component' do
+            let(:mock_component_node) { mock 'Punchblock::Component::Asterisk::AGI::Command', :name => 'EXEC ANSWER' }
+            let :component do
+              Component::Asterisk::AGICommand.new mock_component_node, subject.translator
+            end
+
+            let(:ami_event) do
+              RubyAMI::Event.new("AGIExec").tap do |e|
+                e["SubEvent"]   = "End"
+                e["Channel"]    = "SIP/1234-00000000"
+                e["CommandId"]  = component.id
+                e["Command"]    = "EXEC ANSWER"
+                e["ResultCode"] = "200"
+                e["Result"]     = "Success"
+                e["Data"]       = "FOO"
+              end
+            end
+
+            before do
+              subject.register_component component
+            end
+
+            it 'should send the event to the component' do
+              component.expects(:handle_ami_event!).once.with ami_event
+              subject.process_ami_event ami_event
+            end
+          end
+        end
+
+        describe '#execute_command' do
+          let :expected_agi_complete_event do
+            Punchblock::Event::Complete.new.tap do |c|
+              c.reason = Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new :code    => 200,
+                                                                                              :result  => 'Success',
+                                                                                              :data    => 'FOO'
+            end
+          end
+
+          before do
+            command.request!
+          end
+
+          context 'with an accept command' do
+            let(:command) { Command::Accept.new }
+
+            it "should send an EXEC RINGING AGI command and set the command's response" do
+              subject.execute_command command
+              agi_command = subject.actor_subject.instance_variable_get(:'@current_agi_command')
+              agi_command.name.should == "EXEC RINGING"
+              agi_command.execute!
+              agi_command.add_event expected_agi_complete_event
+              command.response(0.5).should be true
+            end
+          end
+
+          context 'with an answer command' do
+            let(:command) { Command::Answer.new }
+
+            it "should send an EXEC ANSWER AGI command and set the command's response" do
+              subject.execute_command command
+              agi_command = subject.actor_subject.instance_variable_get(:'@current_agi_command')
+              agi_command.name.should == "EXEC ANSWER"
+              agi_command.execute!
+              agi_command.add_event expected_agi_complete_event
+              command.response(0.5).should be true
+            end
+          end
+
+          context 'with a hangup command' do
+            let(:command) { Command::Hangup.new }
+
+            it "should send a Hangup AMI command and set the command's response" do
+              subject.execute_command command
+              ami_action = subject.actor_subject.instance_variable_get(:'@current_ami_action')
+              ami_action.name.should == "hangup"
+              ami_action << RubyAMI::Response.new
+              command.response(0.5).should be true
+            end
+          end
+
+          context 'with a component' do
+            let :command do
+              Punchblock::Component::Asterisk::AGI::Command.new :name => 'Answer'
+            end
+
+            let(:mock_action) { mock 'Component::Asterisk::AGI::Command', :id => 'foo' }
+
+            it 'should create a component actor and execute it asynchronously' do
+              Component::Asterisk::AGICommand.expects(:new).once.with(command, subject).returns mock_action
+              mock_action.expects(:execute!).once
+              subject.execute_command command
+            end
+          end
+        end
+
+        describe '#send_agi_action' do
+          it 'should send an appropriate AsyncAGI AMI action' do
+            pending
+            subject.actor_subject.expects(:send_ami_action).once.with('AGI', 'Command' => 'FOO', 'Channel' => subject.channel)
+            subject.send_agi_action 'FOO'
+          end
+        end
+
+        describe '#send_ami_action' do
+          let(:component_id) { UUIDTools::UUID.random_create }
+          before { UUIDTools::UUID.stubs :random_create => component_id }
+
+          it 'should send the action to the AMI client' do
+            action = RubyAMI::Action.new 'foo', :foo => :bar
+            translator.expects(:send_ami_action!).once.with action
+            subject.send_ami_action 'foo', :foo => :bar
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module Asterisk
+          describe AGICommand do
+            let(:channel)       { 'SIP/foo' }
+            let(:mock_call)     { mock 'Call', :channel => channel }
+            let(:component_id)  { UUIDTools::UUID.random_create }
+
+            before { UUIDTools::UUID.stubs :random_create => component_id }
+
+            let :command do
+              Punchblock::Component::Asterisk::AGI::Command.new :name => 'EXEC ANSWER'
+            end
+
+            subject { AGICommand.new command, mock_call }
+
+            let :expected_action do
+              RubyAMI::Action.new 'AGI', 'Channel' => channel, 'Command' => 'EXEC ANSWER', 'CommandID' => component_id
+            end
+
+            context 'initial execution' do
+              it 'should send the appropriate RubyAMI::Action' do
+                mock_call.expects(:send_ami_action!).once.with(expected_action).returns(expected_action)
+                subject.execute
+              end
+            end
+
+            context 'when the AMI action completes' do
+              before do
+                command.request!
+                command.execute!
+              end
+
+              let :expected_response do
+                Ref.new :id => component_id
+              end
+
+              let :response do
+                RubyAMI::Response.new.tap do |r|
+                  r['ActionID'] = "552a9d9f-46d7-45d8-a257-06fe95f48d99"
+                  r['Message']  = 'Added AGI command to queue'
+                end
+              end
+
+              it 'should send the component node a ref with the action ID' do
+                command.expects(:response=).once.with(expected_response)
+                subject.action << response
+              end
+
+              context 'with an error' do
+                let :error do
+                  RubyAMI::Error.new.tap { |e| e.message = 'Action failed' }
+                end
+
+                it 'should send the component node false' do
+                  command.expects(:response=).once.with false
+                  subject.action << error
+                end
+              end
+            end
+
+            describe 'when receiving an AsyncAGI event' do
+              before do
+                command.request!
+                command.execute!
+              end
+
+              context 'of type start'
+
+              context 'of type Exec' do
+                let(:ami_event) do
+                  RubyAMI::Event.new("AsyncAGI").tap do |e|
+                    e["SubEvent"]   = "Exec"
+                    e["Channel"]    = channel
+                    e["CommandId"]  = component_id
+                    e["Command"]    = "EXEC ANSWER"
+                    e["Result"]     = "200%20result=123%20(timeout)%0A"
+                  end
+                end
+
+                let :expected_complete_reason do
+                  Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new :code    => 200,
+                                                                                       :result  => 123,
+                                                                                       :data    => 'timeout'
+                end
+
+                it 'should send a complete event' do
+                  subject.handle_ami_event ami_event
+
+                  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
+            end
+
+            describe '#parse_agi_result' do
+              context 'with a simple result with no data' do
+                let(:result_string) { "200%20result=123%0A" }
+
+                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   == ''
+                end
+              end
+
+              context 'with a result and data in parens' do
+                let(:result_string) { "200%20result=-123%20(timeout)%0A" }
+
+                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'
+                end
+              end
+
+              context 'with a result and key-value data' do
+                let(:result_string) { "200%20result=123%20foo=bar%0A" }
+
+                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'
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end