punchblock 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90ceeeef84eac2fec034a32edbc3fdd387c8d1f2
-  data.tar.gz: ca82c8ffbfa67c81369eb3146b5c4f333d443613
+  metadata.gz: 64729c9456c13c6897d13dbac65657a51951f67a
+  data.tar.gz: aa7522da6cf77ebfbbb044865e7c43b79a1939d3
 SHA512:
-  metadata.gz: 333ac7e2473e30d84f38f23493dba4c33d4422cb4725e7c5da3fd98c468ab170156922ad5f540936e871653a34993bf57dd9e227ebcf6b9091335ab27d5a1445
-  data.tar.gz: bb079007e70f4e27552354c8327c5d602961b7335c6a102ef51d106c2ca847d972bec2852a99f5623381c88e1c377ce88d74e93cba5b49ec4cc88719e1f24041
+  metadata.gz: d39f61aaa9ffb224dfa32e9bd898fadc359a9ec6881682e709ee3d0df36afff2c26854baa30e0fc99794a73c18309e8f4922c17d065cb2f5402573947dfabba1
+  data.tar.gz: 5c93e10769dbbd141b71732f163783bf7ff653faa30d3886f382a87c5a3402c5e6bcd8784701d7b55adbfdf1a728f3841a0093d455c1a16e10e94e161473b902

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-19mode
   - rbx-19mode
   - ruby-head

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.9.0](https://github.com/adhearsion/punchblock/compare/v1.8.2...v1.9.0) - [2013-05-03](https://rubygems.org/gems/punchblock/versions/1.9.0)
+  * Feature: Use RubyAMI 2.0 with a single AMI connection.
+  * Feature: Cache channel variables on Asterisk calls.
+  * Feature: Allow optional sending of end event when breaking from AsyncAGI on Asterisk. This enables dialplan handback. Only triggers if the channel variable 'PUNCHBLOCK_END_ON_ASYNCAGI_BREAK' is set.
+  * Bugfix: Avoid DTMF recognizer failures and race conditions by bringing DTMFRecognizer back into the Input component actor.
+  * Bugfix: Catch Asterisk AMI errors in all cases and fail accordingly, instead of ploughing ahead in the face of adversity.
+  * Bugfix: Improve performance of Asterisk implementation by no longer spinning up a component actor for AGI command execution.
+
 # [v1.8.2](https://github.com/adhearsion/punchblock/compare/v1.8.1...v1.8.2) - [2013-04-19](https://rubygems.org/gems/punchblock/versions/1.8.2)
   * Bugfix: Input initial timeout was being set as a float rather than an integer
 

data/lib/punchblock/component/asterisk/agi/command.rb

@@ -86,17 +86,6 @@ module Punchblock
             class Success < Event::Complete::Reason
               register :success, :agi_complete
 
-              def self.new(options = {})
-                super().tap do |new_node|
-                  case options
-                  when Nokogiri::XML::Node
-                    new_node.inherit options
-                  else
-                    options.each_pair { |k,v| new_node.send :"#{k}=", v }
-                  end
-                end
-              end
-
               def node_with_name(name)
                 n = if self.class.registered_ns
                   find_first "ns:#{name}", :ns => self.class.registered_ns

data/lib/punchblock/connection/asterisk.rb

@@ -9,19 +9,19 @@ module Punchblock
       attr_accessor :event_handler
 
       def initialize(options = {})
-        @ami_client = RubyAMI::Client.new options.merge(:event_handler => lambda { |event| translator.async.handle_ami_event event }, :logger => pb_logger)
+        @ami_client = RubyAMI::Stream.new options[:host], options[:port], options[:username], options[:password], ->(event) { translator.async.handle_ami_event event }, pb_logger
         @translator = Translator::Asterisk.new @ami_client, self, options[:media_engine]
         super()
       end
 
       def run
-        ami_client.start
+        ami_client.run
         raise DisconnectedError
       end
 
       def stop
         translator.async.shutdown
-        ami_client.stop
+        ami_client.terminate
       end
 
       def write(command, options)

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

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'active_support/core_ext/string/filters'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      class AGICommand
+        ARG_QUOTER = /["\\]/.freeze
+
+        attr_reader :id
+
+        def initialize(id, channel, command, *params)
+          @id, @channel, @command, @params = id, channel, command, params
+        end
+
+        def execute(ami_client)
+          ami_client.send_action 'AGI', 'Channel' => @channel, 'Command' => agi_command, 'CommandID' => id
+        end
+
+        def parse_result(event)
+          parser = RubyAMI::AGIResultParser.new event['Result']
+          {code: parser.code, result: parser.result, data: parser.data}
+        end
+
+        private
+
+        def agi_command
+          "#{@command} #{@params.map { |arg| quote_arg(arg) }.join(' ')}".squish
+        end
+
+        # Arguments surrounded by quotes; quotes backslash-escaped.
+        # See parse_args in asterisk/res/res_agi.c (Asterisk 1.4.21.1)
+        def quote_arg(arg)
+          '"' + arg.to_s.gsub(ARG_QUOTER) { |m| "\\#{m}" } + '"'
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/translator/asterisk/call.rb

@@ -22,14 +22,15 @@ module Punchblock
 
         trap_exit :actor_died
 
-        def initialize(channel, translator, agi_env = nil)
-          @channel, @translator = channel, translator
+        def initialize(channel, translator, ami_client, connection, agi_env = nil)
+          @channel, @translator, @ami_client, @connection = channel, translator, ami_client, connection
           @agi_env = agi_env || {}
           @id, @components = Punchblock.new_uuid, {}
           @answered = false
           @pending_joins = {}
           @progress_sent = false
           @block_commands = false
+          @channel_variables = {}
         end
 
         def register_component(component)
@@ -49,6 +50,10 @@ module Punchblock
           terminate
         end
 
+        def channel_var(variable)
+          @channel_variables[variable] || fetch_channel_var(variable)
+        end
+
         def to_s
           "#<#{self.class}:#{id} Channel: #{channel.inspect}>"
         end
@@ -89,7 +94,7 @@ module Punchblock
         def send_progress
           return if answered? || outbound? || @progress_sent
           @progress_sent = true
-          send_agi_action "EXEC Progress"
+          execute_agi_command "EXEC Progress"
         end
 
         def channel=(other)
@@ -101,13 +106,7 @@ module Punchblock
 
           case ami_event.name
           when 'Hangup'
-            @block_commands = true
-            @components.dup.each_pair do |id, component|
-              safe_from_dead_actors do
-                component.call_ended if component.alive?
-              end
-            end
-            send_end_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
+            handle_hangup_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
           when 'AsyncAGI'
             if component = component_with_id(ami_event['CommandID'])
               component.handle_ami_event ami_event
@@ -151,6 +150,8 @@ module Punchblock
               end
               send_pb_event event
             end
+          when 'VarSet'
+            @channel_variables[ami_event['Variable']] = ami_event['Value']
           end
           trigger_handler :ami, ami_event
         end
@@ -172,32 +173,23 @@ module Punchblock
             if outbound?
               command.response = true
             else
-              send_agi_action 'EXEC RINGING' do |response|
-                command.response = true
-              end
-            end
-          when Command::Answer
-            send_agi_action 'ANSWER' do |response|
+              execute_agi_command 'EXEC RINGING'
               command.response = true
             end
+          when Command::Answer
+            execute_agi_command 'ANSWER'
+            command.response = true
           when Command::Hangup
-            send_ami_action 'Hangup', 'Channel' => channel, 'Cause' => 16 do |response|
-              command.response = true
-            end
+            send_ami_action 'Hangup', 'Channel' => channel, 'Cause' => 16
+            command.response = true
           when Command::Join
             other_call = translator.call_with_id command.call_id
             @pending_joins[other_call.channel] = command
-            send_agi_action 'EXEC Bridge', other_call.channel
+            execute_agi_command 'EXEC Bridge', other_call.channel
           when Command::Unjoin
             other_call = translator.call_with_id command.call_id
-            redirect_back other_call do |response|
-              case response
-              when RubyAMI::Error
-                command.response = ProtocolError.new.setup 'error', response.message
-              else
-                command.response = true
-              end
-            end
+            redirect_back other_call
+            command.response = true
           when Command::Reject
             rejection = case command.reason
             when :busy
@@ -209,9 +201,8 @@ module Punchblock
             else
               'EXEC Congestion'
             end
-            send_agi_action rejection do |response|
-              command.response = true
-            end
+            execute_agi_command rejection
+            command.response = true
           when Punchblock::Component::Asterisk::AGI::Command
             execute_component Component::Asterisk::AGICommand, command
           when Punchblock::Component::Output
@@ -223,31 +214,31 @@ module Punchblock
           else
             command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for call #{id}", id
           end
+        rescue RubyAMI::Error => e
+          command.response = ProtocolError.new.setup 'error', e.message
         rescue Celluloid::DeadActorError
           command.response = ProtocolError.new.setup :item_not_found, "Could not find a component with ID #{command.component_id} for call #{id}", id, command.component_id
         end
 
-        def send_agi_action(command, *params, &block)
-          @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :params => params, :target_call_id => id
-          @current_agi_command.request!
-          @current_agi_command.register_handler :internal, Punchblock::Event::Complete do |e|
-            block.call e if block
-          end
-          execute_component Component::Asterisk::AGICommand, @current_agi_command, :internal => true
-        end
-
-        def send_ami_action(name, headers = {}, &block)
-          (name.is_a?(RubyAMI::Action) ? name : RubyAMI::Action.new(name, headers, &block)).tap do |action|
-            @current_ami_action = action
-            translator.send_ami_action action
+        def execute_agi_command(command, *params)
+          agi = AGICommand.new Punchblock.new_uuid, channel, command, *params
+          condition = Celluloid::Condition.new
+          register_tmp_handler :ami, name: 'AsyncAGI', [:[], 'SubEvent'] => 'Exec', [:[], 'CommandID'] => agi.id do |event|
+            condition.signal event
           end
+          agi.execute @ami_client
+          event = condition.wait
+          return unless event
+          agi.parse_result event
+        rescue RubyAMI::Error => e
+          abort e
         end
 
         def logger_id
           "#{self.class}: #{id}"
         end
 
-        def redirect_back(other_call = nil, &block)
+        def redirect_back(other_call = nil)
           redirect_options = {
             'Channel'   => channel,
             'Exten'     => Asterisk::REDIRECT_EXTENSION,
@@ -260,7 +251,17 @@ module Punchblock
             'ExtraPriority'  => Asterisk::REDIRECT_PRIORITY,
             'ExtraContext'   => Asterisk::REDIRECT_CONTEXT
           }) if other_call
-          send_ami_action 'Redirect', redirect_options, &block
+          send_ami_action 'Redirect', redirect_options
+        end
+
+        def handle_hangup_event(reason = :hangup)
+          @block_commands = true
+          @components.dup.each_pair do |id, component|
+            safe_from_dead_actors do
+              component.call_ended if component.alive?
+            end
+          end
+          send_end_event reason
         end
 
         def actor_died(actor, reason)
@@ -274,6 +275,15 @@ module Punchblock
 
         private
 
+        def fetch_channel_var(variable)
+          result = @ami_client.send_action 'GetVar', 'Channel' => channel, 'Variable' => variable
+          result['Value'] == '(null)' ? nil : result['Value']
+        end
+
+        def send_ami_action(name, headers = {})
+          @ami_client.send_action name, headers
+        end
+
         def send_end_event(reason)
           send_pb_event Event::End.new(:reason => reason)
           translator.deregister_call current_actor
@@ -283,7 +293,6 @@ module Punchblock
         def execute_component(type, command, options = {})
           type.new_link(command, current_actor).tap do |component|
             register_component component
-            component.internal = true if options[:internal]
             component.async.execute
           end
         end

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

@@ -1,63 +1,39 @@
 # encoding: utf-8
 
-require 'active_support/core_ext/string/filters'
-
 module Punchblock
   module Translator
     class Asterisk
       module Component
         module Asterisk
           class AGICommand < Component
-            attr_reader :action
-
             def setup
-              @action = create_action
+              @agi = Punchblock::Translator::Asterisk::AGICommand.new id, @call.channel, @component_node.name, *@component_node.params_array
             end
 
             def execute
+              @agi.execute ami_client
               send_ref
-              @call.send_ami_action @action
+            rescue RubyAMI::Error
+              set_node_response false
+              terminate
             end
+            exclusive :execute
 
             def handle_ami_event(event)
-              if event.name == 'AsyncAGI'
-                if event['SubEvent'] == 'Exec'
-                  send_complete_event success_reason(event)
+              if event.name == 'AsyncAGI' && event['SubEvent'] == 'Exec'
+                send_complete_event success_reason(event), nil, false
+                if @component_node.name == 'ASYNCAGI BREAK' && @call.channel_var('PUNCHBLOCK_END_ON_ASYNCAGI_BREAK')
+                  @call.handle_hangup_event
                 end
-              end
-            end
-
-            def handle_response(response)
-              case response
-              when RubyAMI::Error
-                set_node_response false
-              when RubyAMI::Response
-                send_ref
+                terminate
               end
             end
 
             private
 
-            def create_action
-              command = current_actor
-              RubyAMI::Action.new 'AGI', 'Channel' => @call.channel, 'Command' => agi_command, 'CommandID' => id do |response|
-                command.handle_response response
-              end
-            end
-
-            def agi_command
-              "#{@component_node.name} #{@component_node.params_array.map { |arg| quote_arg(arg) }.join(' ')}".squish
-            end
-
-            # Arguments surrounded by quotes; quotes backslash-escaped.
-            # See parse_args in asterisk/res/res_agi.c (Asterisk 1.4.21.1)
-            def quote_arg(arg)
-              '"' + arg.to_s.gsub(/["\\]/) { |m| "\\#{m}" } + '"'
-            end
-
             def success_reason(event)
-              parser = RubyAMI::AGIResultParser.new event['Result']
-              Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new :code => parser.code, :result => parser.result, :data => parser.data
+              result = @agi.parse_result event
+              Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new result
             end
           end
         end

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

@@ -6,70 +6,45 @@ module Punchblock
       module Component
         module Asterisk
           class AMIAction < Component
-            attr_reader :action, :translator
+            attr_reader :translator
 
-            def initialize(component_node, translator)
+            def initialize(component_node, translator, ami_client)
               super component_node, nil
-              @translator = translator
-            end
-
-            def setup
-              @action = create_action
-              @id = @action.action_id
+              @translator, @ami_client = translator, ami_client
             end
 
             def execute
-              send_action
               send_ref
-            end
-
-            def handle_response(response)
-              case response
-              when RubyAMI::Error
-                send_complete_event error_reason(response)
-              when RubyAMI::Response
-                send_events
-                send_complete_event success_reason(response)
-              end
+              response = send_action
+              final_event = send_events response
+              send_complete_event success_reason(response, final_event)
+            rescue RubyAMI::Error => e
+              send_complete_event error_reason(e)
             end
 
             private
 
-            def create_action
-              headers = {}
-              @component_node.params_hash.each_pair do |key, value|
-                headers[key.to_s.capitalize] = value
-              end
-              component = current_actor
-              RubyAMI::Action.new @component_node.name, headers do |response|
-                component.async.handle_response response
-              end
-            end
-
             def send_action
-              @translator.send_ami_action @action
+              @ami_client.send_action @component_node.name, action_headers
             end
 
             def error_reason(response)
               Punchblock::Event::Complete::Error.new :details => response.message
             end
 
-            def success_reason(response)
+            def success_reason(response, final_event = nil)
               headers = response.headers
-              headers.merge! @extra_complete_attributes if instance_variable_defined?(:@extra_complete_attributes)
+              headers.merge! final_event.headers if final_event
               headers.delete 'ActionID'
               Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => headers.delete('Message'), :attributes => headers
             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
+            def send_events(response)
+              final_event = response.events.pop
+              response.events.each do |e|
+                send_event pb_event_from_ami_event(e)
               end
+              final_event
             end
 
             def pb_event_from_ami_event(ami_event)
@@ -77,6 +52,14 @@ module Punchblock
               headers.delete 'ActionID'
               Event::Asterisk::AMI::Event.new :name => ami_event.name, :attributes => headers
             end
+
+            def action_headers
+              headers = {}
+              @component_node.params_hash.each_pair do |key, value|
+                headers[key.to_s.capitalize] = value
+              end
+              headers
+            end
           end
         end
       end

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

@@ -16,8 +16,9 @@ module Punchblock
           private
 
           def register_dtmf_event_handler
+            component = current_actor
             call.register_handler :ami, :name => 'DTMF', [:[], 'End'] => 'Yes' do |event|
-              @recognizer << event['Digit']
+              component.process_dtmf event['Digit']
             end
           end
 

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

@@ -9,7 +9,7 @@ module Punchblock
         class Output < Component
           include StopByRedirect
 
-          UnrenderableDocError = Class.new OptionError
+          UnrenderableDocError  = Class.new OptionError
 
           def setup
             @media_engine = @call.translator.media_engine
@@ -25,8 +25,6 @@ module Punchblock
 
             early = !@call.answered?
 
-            output_component = current_actor
-
             rendering_engine = @component_node.renderer || @media_engine || :asterisk
 
             case rendering_engine.to_sym
@@ -46,26 +44,26 @@ module Punchblock
               @call.send_progress if early
 
               if interrupt
-                call.register_handler :ami, :name => 'DTMF' do |event|
-                  output_component.stop_by_redirect Punchblock::Component::Output::Complete::Success.new if event['End'] == 'Yes'
+                output_component = current_actor
+                call.register_handler :ami, :name => 'DTMF', [:[], 'End'] => 'Yes' do |event|
+                  output_component.stop_by_redirect Punchblock::Component::Output::Complete::Success.new
                 end
               end
 
               opts = early ? "#{path},noanswer" : path
-              playback opts
+              @call.execute_agi_command 'EXEC Playback', opts
             when :unimrcp
               send_ref
-              @call.async.send_agi_action 'EXEC MRCPSynth', escape_commas(escaped_doc), mrcpsynth_options do |complete_event|
-                output_component.async.send_complete_event success_reason
-              end
+              @call.execute_agi_command 'EXEC MRCPSynth', escape_commas(escaped_doc), mrcpsynth_options
             when :swift
               send_ref
-              @call.async.send_agi_action 'EXEC Swift', swift_doc do |complete_event|
-                output_component.async.send_complete_event success_reason
-              end
+              @call.execute_agi_command 'EXEC Swift', swift_doc
             else
-              raise OptionError, 'The renderer foobar is unsupported.'
+              raise OptionError, "The renderer #{rendering_engine} is unsupported."
             end
+            send_success
+          rescue RubyAMI::Error => e
+            complete_with_error "Terminated due to AMI error '#{e.message}'"
           rescue UnrenderableDocError => e
             with_error 'unrenderable document error', e.message
           rescue OptionError => e
@@ -90,19 +88,12 @@ module Punchblock
             raise UnrenderableDocError, 'The provided document could not be rendered. See http://adhearsion.com/docs/common_problems#unrenderable-document-error for details.'
           end
 
-          def playback(path)
-            op = current_actor
-            @call.async.send_agi_action 'EXEC Playback', path do |complete_event|
-              op.async.send_complete_event success_reason
-            end
-          end
-
           def escaped_doc
             @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
           end
 
           def escape_commas(text)
-            text.gsub(/,/, '\\,')
+            text.gsub(',', '\\,')
           end
 
           def mrcpsynth_options
@@ -119,6 +110,10 @@ module Punchblock
             doc
           end
 
+          def send_success
+            send_complete_event success_reason
+          end
+
           def success_reason
             Punchblock::Component::Output::Complete::Success.new
           end

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

@@ -22,7 +22,6 @@ module Punchblock
 
             @format = @component_node.format || 'wav'
 
-
             component = current_actor
             call.register_tmp_handler :ami, :name => 'MonitorStop' do |event|
               component.finished
@@ -31,18 +30,17 @@ module Punchblock
             send_ref
 
             if @component_node.start_beep
-              @call.async.send_agi_action 'STREAM FILE', 'beep', '""' do
-                component.async.signal :beep_finished
-              end
-              wait :beep_finished
+              @call.execute_agi_command 'STREAM FILE', 'beep', '""'
             end
 
-            call.async.send_ami_action 'Monitor', 'Channel' => call.channel, 'File' => filename, 'Format' => @format, 'Mix' => true
+            ami_client.send_action 'Monitor', 'Channel' => call.channel, 'File' => filename, 'Format' => @format, 'Mix' => true
             unless max_duration == -1
               after max_duration/1000 do
-                call.async.send_ami_action 'StopMonitor', 'Channel' => call.channel
+                ami_client.send_action 'StopMonitor', 'Channel' => call.channel
               end
             end
+          rescue RubyAMI::Error => e
+            complete_with_error "Terminated due to AMI error '#{e.message}'"
           rescue OptionError => e
             with_error 'option error', e.message
           end
@@ -51,20 +49,14 @@ module Punchblock
             case command
             when Punchblock::Component::Stop
               command.response = true
-              a = current_actor
-              call.async.send_ami_action 'StopMonitor', 'Channel' => call.channel do |complete_event|
-                @complete_reason = stop_reason
-              end
+              ami_client.send_action 'StopMonitor', 'Channel' => call.channel
+              @complete_reason = stop_reason
             when Punchblock::Component::Record::Pause
-              a = current_actor
-              call.async.send_ami_action 'PauseMonitor', 'Channel' => call.channel do |complete_event|
-                command.response = true
-              end
+              ami_client.send_action 'PauseMonitor', 'Channel' => call.channel
+              command.response = true
             when Punchblock::Component::Record::Resume
-              a = current_actor
-              call.async.send_ami_action 'ResumeMonitor', 'Channel' => call.channel do |complete_event|
-                command.response = true
-              end
+              ami_client.send_action 'ResumeMonitor', 'Channel' => call.channel
+              command.response = true
             else
               super
             end