punchblock 1.8.0 → 1.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73b10610c29750367e41a8f99669d79fd5b8bcb8
+  data.tar.gz: 66d4bd7dea9d5c33ca580ef361fbf20bfe147015
+SHA512:
+  metadata.gz: 6bdf955c26d3ebea75ce690c7feafd969c3542403f0e2c392a8eab91d05e5981514b1bc95bfe025eab8894f864e0638fae051221c7ec382f867baa9db5de2901
+  data.tar.gz: 1c9d7bb96f8112ce3e55dc83d5a847a27e73e11ac8d1c20c6907bfe9c7d22956d91de608f65d6f915cdb8de021562029ea84b1cd4956a5d974a42474567bd4b3

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v1.8.1](https://github.com/adhearsion/punchblock/compare/v1.8.0...v1.8.1) - [2013-03-25](https://rubygems.org/gems/punchblock/versions/1.8.1)
+  * Bugfix: FreeSWITCH was requiring a from attribute on a dial command
+  * Bugfix: Asterisk translator now properly checks for existence of the recordings directory
+  * Bugfix: Components should transition state before unblocking
+  * Bugfix: Asterisk joins are now more robustly responded to when the join begins
+  * Bugfix: On FreeSWITCH, only events relating to bridge start/end should be delivered to bridged calls
+  * Bugfix: On FreeSWITCH, a voice value on an audio-only output component should not prevent execution
+  * Bugfix: XMPP Ping should be an IQ get, not set
+  * Bugfix: Stop command should be in Rayo ext namespace
+  * Bugfix: XMPP specs were mistakenly resetting the logger object for other tests.
+  * CS: Avoid Celluloid deprecation warnings
+
 # [v1.8.0](https://github.com/adhearsion/punchblock/compare/v1.7.1...v1.8.0) - [2013-01-10](https://rubygems.org/gems/punchblock/versions/1.8.0)
   * Feature: Join command now enforces a list of valid direction attribute values
   * Feature: Added support for media direction to the Record component

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 gem 'bluecloth' unless RUBY_PLATFORM =~ /java/

data/lib/punchblock/component/component_node.rb

@@ -50,8 +50,8 @@ module Punchblock
       def complete_event=(other)
         return if @complete_event_resource.set_yet?
         client.delete_component_registration self if client
-        @complete_event_resource.resource = other
         complete!
+        @complete_event_resource.resource = other
       end
 
       ##

data/lib/punchblock/component/stop.rb

@@ -3,7 +3,7 @@
 module Punchblock
   module Component
     class Stop < CommandNode # :nodoc:
-      register :stop, :core
+      register :stop, :ext
     end
   end
-end
+end

data/lib/punchblock/connection/asterisk.rb

@@ -9,7 +9,7 @@ module Punchblock
       attr_accessor :event_handler
 
       def initialize(options = {})
-        @ami_client = RubyAMI::Client.new options.merge(:event_handler => lambda { |event| translator.handle_ami_event! event }, :logger => pb_logger)
+        @ami_client = RubyAMI::Client.new options.merge(:event_handler => lambda { |event| translator.async.handle_ami_event event }, :logger => pb_logger)
         @translator = Translator::Asterisk.new @ami_client, self, options[:media_engine]
         super()
       end
@@ -20,12 +20,12 @@ module Punchblock
       end
 
       def stop
-        translator.shutdown!
+        translator.async.shutdown
         ami_client.stop
       end
 
       def write(command, options)
-        translator.execute_command! command, options
+        translator.async.execute_command command, options
       end
 
       def handle_event(event)

data/lib/punchblock/connection/freeswitch.rb

@@ -27,7 +27,7 @@ module Punchblock
       end
 
       def write(command, options)
-        translator.execute_command! command, options
+        translator.async.execute_command command, options
       end
 
       def handle_event(event)
@@ -37,7 +37,7 @@ module Punchblock
       private
 
       def new_fs_stream
-        RubyFS::Stream.new(*@stream_options, lambda { |e| translator.handle_es_event! e })
+        RubyFS::Stream.new(*@stream_options, lambda { |e| translator.async.handle_es_event e })
       end
 
       def start_stream

data/lib/punchblock/connection/xmpp.rb

@@ -175,7 +175,7 @@ module Punchblock
       end
 
       def ping_rayo
-        client.write_with_handler Blather::Stanza::Iq::Ping.new(:set, root_domain) do |response|
+        client.write_with_handler Blather::Stanza::Iq::Ping.new(:get, root_domain) do |response|
           begin
             handle_error response if response.is_a? Blather::BlatherError
           rescue ProtocolError => e

data/lib/punchblock/translator.rb

@@ -9,6 +9,7 @@ module Punchblock
     autoload :Asterisk
     autoload :Freeswitch
 
+    autoload :DTMFRecognizer
     autoload :InputComponent
   end
 end

data/lib/punchblock/translator/asterisk.rb

@@ -57,7 +57,7 @@ module Punchblock
       end
 
       def shutdown
-        @calls.values.each(&:shutdown!)
+        @calls.values.each { |call| call.async.shutdown }
         terminate
       end
 
@@ -105,7 +105,7 @@ module Punchblock
 
       def execute_call_command(command)
         if call = call_with_id(command.target_call_id)
-          call.execute_command! command
+          call.async.execute_command command
         else
           command.response = ProtocolError.new.setup :item_not_found, "Could not find a call with ID #{command.target_call_id}", command.target_call_id
         end
@@ -113,7 +113,7 @@ module Punchblock
 
       def execute_component_command(command)
         if (component = component_with_id(command.component_id))
-          component.execute_command! command
+          component.async.execute_command command
         else
           command.response = ProtocolError.new.setup :item_not_found, "Could not find a component with ID #{command.component_id}", command.target_call_id, command.component_id
         end
@@ -124,11 +124,11 @@ module Punchblock
         when Punchblock::Component::Asterisk::AMI::Action
           component = Component::Asterisk::AMIAction.new command, current_actor
           register_component component
-          component.execute!
+          component.async.execute
         when Punchblock::Command::Dial
           call = Call.new_link command.to, current_actor
           register_call call
-          call.dial! command
+          call.async.dial command
         else
           command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command"
         end
@@ -149,10 +149,11 @@ module Punchblock
             pb_logger.error "Punchblock failed to add the #{REDIRECT_EXTENSION} extension to the #{REDIRECT_CONTEXT} context. Please add a [#{REDIRECT_CONTEXT}] entry to your dialplan."
           end
         end
+        check_recording_directory
       end
 
       def check_recording_directory
-        pb_logger.warning "Recordings directory #{Component::Record::RECORDING_BASE_PATH} does not exist. Recording might not work. This warning can be ignored if Adhearsion is running on a separate machine than Asterisk. See http://adhearsion.com/docs/call-controllers#recording" unless File.exists?(Component::Record::RECORDING_BASE_PATH)
+        pb_logger.warn "Recordings directory #{Component::Record::RECORDING_BASE_PATH} does not exist. Recording might not work. This warning can be ignored if Adhearsion is running on a separate machine than Asterisk. See http://adhearsion.com/docs/call-controllers#recording" unless File.exists?(Component::Record::RECORDING_BASE_PATH)
       end
 
       def actor_died(actor, reason)
@@ -181,9 +182,9 @@ module Punchblock
             call = call_for_channel channel
             if call
               if channel_is_bridged?(channel)
-                call.process_ami_event! event if EVENTS_ALLOWED_BRIDGED.include?(event.name.downcase)
+                call.async.process_ami_event event if EVENTS_ALLOWED_BRIDGED.include?(event.name.downcase)
               else
-                call.process_ami_event! event
+                call.async.process_ami_event event
               end
             end
           end
@@ -215,7 +216,7 @@ module Punchblock
         call = Call.new event['Channel'], current_actor, env
         link call
         register_call call
-        call.send_offer!
+        call.async.send_offer
       end
     end
   end

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

@@ -8,7 +8,7 @@ module Punchblock
         include Celluloid
         include DeadActorSafety
 
-        attr_reader :id, :channel, :translator, :agi_env, :direction, :pending_joins
+        attr_reader :id, :channel, :translator, :agi_env, :direction
 
         HANGUP_CAUSE_TO_END_REASON = Hash.new { :error }
         HANGUP_CAUSE_TO_END_REASON[0] = :hangup
@@ -29,6 +29,7 @@ module Punchblock
           @answered = false
           @pending_joins = {}
           @progress_sent = false
+          @block_commands = false
         end
 
         def register_component(component)
@@ -69,7 +70,7 @@ module Punchblock
           originate_action = Punchblock::Component::Asterisk::AMI::Action.new :name => 'Originate',
                                                                               :params => params
           originate_action.request!
-          translator.execute_global_command! originate_action
+          translator.async.execute_global_command originate_action
           dial_command.response = Ref.new :id => id
         end
 
@@ -100,6 +101,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?
@@ -123,9 +125,9 @@ module Punchblock
               send_end_event :error
             end
           when 'BridgeExec'
-            if join_command = pending_joins[ami_event['Channel2']]
-              join_command.response = true
-            end
+            join_command   = @pending_joins.delete ami_event['Channel1']
+            join_command ||= @pending_joins.delete ami_event['Channel2']
+            join_command.response = true if join_command
           when 'Bridge'
             other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
             if other_call = translator.call_for_channel(other_call_channel)
@@ -154,6 +156,10 @@ module Punchblock
         end
 
         def execute_command(command)
+          if @block_commands
+            command.response = ProtocolError.new.setup :item_not_found, "Could not find a call with ID #{id}", id
+            return
+          end
           if command.component_id
             if component = component_with_id(command.component_id)
               component.execute_command command
@@ -180,7 +186,7 @@ module Punchblock
             end
           when Command::Join
             other_call = translator.call_with_id command.call_id
-            pending_joins[other_call.channel] = command
+            @pending_joins[other_call.channel] = command
             send_agi_action 'EXEC Bridge', other_call.channel
           when Command::Unjoin
             other_call = translator.call_with_id command.call_id
@@ -217,6 +223,8 @@ module Punchblock
           else
             command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for call #{id}", id
           end
+        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)
@@ -276,7 +284,7 @@ module Punchblock
           type.new_link(command, current_actor).tap do |component|
             register_component component
             component.internal = true if options[:internal]
-            component.execute!
+            component.async.execute
           end
         end
 

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

@@ -42,7 +42,7 @@ module Punchblock
               end
               component = current_actor
               RubyAMI::Action.new @component_node.name, headers do |response|
-                component.handle_response! response
+                component.async.handle_response response
               end
             end
 

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

@@ -16,14 +16,13 @@ module Punchblock
           private
 
           def register_dtmf_event_handler
-            component = current_actor
-            call.register_handler :ami, :name => 'DTMF' do |event|
-              component.process_dtmf! event['Digit'] if event['End'] == 'Yes'
+            call.register_handler :ami, :name => 'DTMF', [:[], 'End'] => 'Yes' do |event|
+              @recognizer << event['Digit']
             end
           end
 
           def unregister_dtmf_event_handler
-            call.unregister_handler :ami, @dtmf_handler_id if instance_variable_defined?(:@dtmf_handler_id)
+            call.async.unregister_handler :ami, @dtmf_handler_id if instance_variable_defined?(:@dtmf_handler_id)
           end
         end
       end

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

@@ -55,13 +55,13 @@ module Punchblock
               playback opts
             when :unimrcp
               send_ref
-              @call.send_agi_action! 'EXEC MRCPSynth', escape_commas(escaped_doc), mrcpsynth_options do |complete_event|
-                output_component.send_complete_event! success_reason
+              @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
             when :swift
               send_ref
-              @call.send_agi_action! 'EXEC Swift', swift_doc do |complete_event|
-                output_component.send_complete_event! success_reason
+              @call.async.send_agi_action 'EXEC Swift', swift_doc do |complete_event|
+                output_component.async.send_complete_event success_reason
               end
             else
               raise OptionError, 'The renderer foobar is unsupported.'
@@ -92,8 +92,8 @@ module Punchblock
 
           def playback(path)
             op = current_actor
-            @call.send_agi_action! 'EXEC Playback', path do |complete_event|
-              op.send_complete_event! success_reason
+            @call.async.send_agi_action 'EXEC Playback', path do |complete_event|
+              op.async.send_complete_event success_reason
             end
           end
 

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

@@ -31,16 +31,16 @@ module Punchblock
             send_ref
 
             if @component_node.start_beep
-              @call.send_agi_action! 'STREAM FILE', 'beep', '""' do
-                component.signal! :beep_finished
+              @call.async.send_agi_action 'STREAM FILE', 'beep', '""' do
+                component.async.signal :beep_finished
               end
               wait :beep_finished
             end
 
-            call.send_ami_action! 'Monitor', 'Channel' => call.channel, 'File' => filename, 'Format' => @format, 'Mix' => true
+            call.async.send_ami_action 'Monitor', 'Channel' => call.channel, 'File' => filename, 'Format' => @format, 'Mix' => true
             unless max_duration == -1
               after max_duration/1000 do
-                call.send_ami_action! 'StopMonitor', 'Channel' => call.channel
+                call.async.send_ami_action 'StopMonitor', 'Channel' => call.channel
               end
             end
           rescue OptionError => e
@@ -52,17 +52,17 @@ module Punchblock
             when Punchblock::Component::Stop
               command.response = true
               a = current_actor
-              call.send_ami_action! 'StopMonitor', 'Channel' => call.channel do |complete_event|
+              call.async.send_ami_action 'StopMonitor', 'Channel' => call.channel do |complete_event|
                 @complete_reason = stop_reason
               end
             when Punchblock::Component::Record::Pause
               a = current_actor
-              call.send_ami_action! 'PauseMonitor', 'Channel' => call.channel do |complete_event|
+              call.async.send_ami_action 'PauseMonitor', 'Channel' => call.channel do |complete_event|
                 command.response = true
               end
             when Punchblock::Component::Record::Resume
               a = current_actor
-              call.send_ami_action! 'ResumeMonitor', 'Channel' => call.channel do |complete_event|
+              call.async.send_ami_action 'ResumeMonitor', 'Channel' => call.channel do |complete_event|
                 command.response = true
               end
             else

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

@@ -9,7 +9,7 @@ module Punchblock
         module StopByRedirect
           def execute_command(command)
             return super unless command.is_a?(Punchblock::Component::Stop)
-            if @complete  
+            if @complete
               command.response = ProtocolError.new.setup 'component-already-stopped', "Component #{id} is already stopped", call_id, id
             else
               stop_by_redirect Punchblock::Event::Complete::Stop.new
@@ -20,9 +20,9 @@ module Punchblock
           def stop_by_redirect(complete_reason)
             component_actor = current_actor
             call.register_handler :ami, lambda { |e| e['SubEvent'] == 'Start' }, :name => 'AsyncAGI' do |event|
-              component_actor.send_complete_event! complete_reason
+              component_actor.async.send_complete_event complete_reason
             end
-            call.redirect_back!
+            call.async.redirect_back
           end
         end
       end

data/lib/punchblock/translator/dtmf_recognizer.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+module Punchblock
+  module Translator
+    class DTMFRecognizer
+      include Celluloid
+
+      finalizer :finalize
+
+      def initialize(responder, grammar, initial_timeout = nil, inter_digit_timeout = nil)
+        @responder = responder
+        self.grammar = grammar
+        self.initial_timeout = initial_timeout || -1
+        self.inter_digit_timeout = inter_digit_timeout || -1
+
+        @buffer = ""
+
+        begin_initial_timer @initial_timeout/1000 unless @initial_timeout == -1
+      end
+
+      def <<(digit)
+        @buffer << digit
+        cancel_initial_timer
+        case (match = @grammar.match @buffer.dup)
+        when RubySpeech::GRXML::Match
+          @responder.match match.mode, match.confidence, match.utterance, match.interpretation
+        when RubySpeech::GRXML::NoMatch
+          @responder.nomatch
+        when RubySpeech::GRXML::PotentialMatch
+          reset_inter_digit_timer
+        end
+      end
+
+      def finalize
+        cancel_initial_timer
+        cancel_inter_digit_timer
+      end
+
+      private
+
+      def grammar=(other)
+        @grammar = RubySpeech::GRXML.import other.to_s
+        @grammar.inline!
+        @grammar.tokenize!
+        @grammar.normalize_whitespace
+      end
+
+      def initial_timeout=(other)
+        raise OptionError, 'An initial timeout value that is negative (and not -1) is invalid.' if other < -1
+        @initial_timeout = other
+      end
+
+      def inter_digit_timeout=(other)
+        raise OptionError, 'An inter-digit timeout value that is negative (and not -1) is invalid.' if other < -1
+        @inter_digit_timeout = other
+      end
+
+      def begin_initial_timer(timeout)
+        @initial_timer = after timeout do
+          @responder.noinput
+        end
+      end
+
+      def cancel_initial_timer
+        return unless instance_variable_defined?(:@initial_timer) && @initial_timer
+        @initial_timer.cancel
+        @initial_timer = nil
+      end
+
+      def reset_inter_digit_timer
+        return if @inter_digit_timeout == -1
+        @inter_digit_timer ||= begin
+          after @inter_digit_timeout/1000 do
+            @responder.nomatch
+          end
+        end
+        @inter_digit_timer.reset
+      end
+
+      def cancel_inter_digit_timer
+        return unless instance_variable_defined?(:@inter_digit_timer) && @inter_digit_timer
+        @inter_digit_timer.cancel
+        @inter_digit_timer = nil
+      end
+    end
+  end
+end