punchblock 1.2.0 → 1.3.0

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

@@ -16,13 +16,15 @@ module Punchblock
           OptionError = Class.new Punchblock::Error
 
           include Celluloid
+          include DeadActorSafety
 
-          attr_reader :id, :call
+          attr_reader :id, :call, :call_id
           attr_accessor :internal
 
           def initialize(component_node, call = nil)
             @component_node, @call = component_node, call
-            @id = UUIDTools::UUID.random_create.to_s
+            @call_id = safe_from_dead_actors { call.id } if call
+            @id = Punchblock.new_uuid
             @complete = false
             setup
             pb_logger.debug "Starting up..."
@@ -53,16 +55,12 @@ module Punchblock
             if internal
               @component_node.add_event event
             else
-              translator.handle_pb_event! event
+              safe_from_dead_actors { translator.handle_pb_event event }
             end
           end
 
           def logger_id
-            "#{self.class}: #{call ? "Call ID: #{call.id}, Component ID: #{id}" : id}"
-          end
-
-          def call_id
-            call.id if call
+            "#{self.class}: #{call_id ? "Call ID: #{call_id}, Component ID: #{id}" : id}"
           end
 
           def call_ended

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

@@ -1,6 +1,5 @@
 # encoding: utf-8
 
-require 'uri'
 require 'active_support/core_ext/string/filters'
 
 module Punchblock
@@ -16,7 +15,8 @@ module Punchblock
             end
 
             def execute
-              @call.send_ami_action! @action
+              send_ref
+              @call.send_ami_action @action
             end
 
             def handle_ami_event(event)
@@ -29,19 +29,22 @@ module Punchblock
               end
             end
 
-            def parse_agi_result(result)
-              match = URI::Parser.new.unescape(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]
+            def handle_response(response)
+              pb_logger.debug "Handling response: #{response.inspect}"
+              case response
+              when RubyAMI::Error
+                set_node_response false
+              when RubyAMI::Response
+                send_ref
               end
             end
 
             private
 
             def create_action
+              command = current_actor
               RubyAMI::Action.new 'AGI', 'Channel' => @call.channel, 'Command' => agi_command, 'CommandID' => id do |response|
-                handle_response response
+                command.handle_response response
               end
             end
 
@@ -55,19 +58,9 @@ module Punchblock
               '"' + arg.to_s.gsub(/["\\]/) { |m| "\\#{m}" } + '"'
             end
 
-            def handle_response(response)
-              pb_logger.debug "Handling response: #{response.inspect}"
-              case response
-              when RubyAMI::Error
-                set_node_response false
-              when RubyAMI::Response
-                send_ref
-              end
-            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
+              parser = RubyAMI::AGIResultParser.new event['Result']
+              Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new :code => parser.code, :result => parser.result, :data => parser.data
             end
           end
         end

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

@@ -48,7 +48,7 @@ module Punchblock
             end
 
             def send_action
-              @translator.send_ami_action! @action
+              @translator.send_ami_action @action
             end
 
             def error_reason(response)

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

@@ -13,7 +13,7 @@ module Punchblock
           end
 
           def execute
-            @call.answer_if_not_answered
+            @call.send_progress
             initial_timeout = @component_node.initial_timeout || -1
             @inter_digit_timeout = @component_node.inter_digit_timeout || -1
 
@@ -33,9 +33,7 @@ module Punchblock
 
             component = current_actor
 
-            @active = true
-
-            call.register_handler :ami, :name => 'DTMF' do |event|
+            @dtmf_handler_id = call.register_handler :ami, :name => 'DTMF' do |event|
               component.process_dtmf! event['Digit'] if event['End'] == 'Yes'
             end
           rescue OptionError => e
@@ -43,7 +41,6 @@ module Punchblock
           end
 
           def process_dtmf(digit)
-            return unless @active
             pb_logger.trace "Processing incoming DTMF digit #{digit}"
             buffer << digit
             cancel_initial_timer
@@ -113,7 +110,7 @@ module Punchblock
           end
 
           def complete(reason)
-            @active = false
+            call.unregister_handler :ami, @dtmf_handler_id if instance_variable_defined?(:@dtmf_handler_id)
             cancel_initial_timer
             cancel_inter_digit_timer
             send_complete_event reason

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

@@ -16,8 +16,6 @@ module Punchblock
           end
 
           def execute
-            @call.answer_if_not_answered
-
             raise OptionError, 'An SSML document is required.' unless @component_node.ssml
             raise OptionError, 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
 
@@ -25,40 +23,43 @@ module Punchblock
               raise OptionError, "A #{opt} value is unsupported on Asterisk." if @component_node.send opt
             end
 
+            early = !@call.answered?
+
+            output_component = current_actor
+
             case @media_engine
             when :asterisk, nil
               raise OptionError, "A voice value is unsupported on Asterisk." if @component_node.voice
+              raise OptionError, 'Interrupt digits are not allowed with early media.' if early && @component_node.interrupt_on
+
+              case @component_node.interrupt_on
+              when :any, :dtmf
+                interrupt = true
+              end
 
-              @execution_elements = collect_executable_elements
-              @pending_actions = @execution_elements.count
+              path = filenames.join '&'
 
               send_ref
 
-              @interrupt_digits = if [:any, :dtmf].include? @component_node.interrupt_on
-                '0123456789*#'
-              else
-                nil
-              end
+              @call.send_progress if early
 
-              @execution_elements.each do |element|
-                element.call
-                wait :continue
-                process_playback_completion
+              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'
+                end
               end
+
+              opts = early ? "#{path},noanswer" : path
+              playback opts
             when :unimrcp
               send_ref
-              output_component = current_actor
               @call.send_agi_action! 'EXEC MRCPSynth', escaped_doc, mrcpsynth_options do |complete_event|
                 pb_logger.debug "MRCPSynth completed with #{complete_event}."
                 output_component.send_complete_event! success_reason
               end
             when :swift
-              doc = escaped_doc
-              doc << "|1|1" if [:any, :dtmf].include? @component_node.interrupt_on
-              doc.insert 0, "#{@component_node.voice}^" if @component_node.voice
               send_ref
-              output_component = current_actor
-              @call.send_agi_action! 'EXEC Swift', doc do |complete_event|
+              @call.send_agi_action! 'EXEC Swift', swift_doc do |complete_event|
                 pb_logger.debug "Swift completed with #{complete_event}."
                 output_component.send_complete_event! success_reason
               end
@@ -69,46 +70,33 @@ module Punchblock
             with_error 'option error', e.message
           end
 
-          def collect_executable_elements
-            @component_node.ssml.children.map do |node|
+          private
+
+          def filenames
+            @filenames ||= @component_node.ssml.children.map do |node|
               case node
               when RubySpeech::SSML::Audio
-                lambda { current_actor.play_audio! node.src }
+                node.src
               when String
-                raise UnrenderableDocError, 'The provided document could not be rendered.' if node.include?(' ')
-                lambda { current_actor.play_audio! node }
+                raise if node.include?(' ')
+                node
               else
-                raise UnrenderableDocError, 'The provided document could not be rendered.'
+                raise
               end
             end.compact
           rescue
             raise UnrenderableDocError, 'The provided document could not be rendered.'
           end
 
-          def process_playback_completion
-            @pending_actions -= 1
-            pb_logger.debug "Received action completion. Now waiting on #{@pending_actions} actions."
-            if @pending_actions < 1
-              pb_logger.debug "Sending complete event"
-              send_complete_event success_reason
-            end
-          end
-
-          def continue(event = nil)
-            signal :continue, event
-          end
-
-          def play_audio(path)
-            pb_logger.debug "Playing an audio file (#{path}) via STREAM FILE"
+          def playback(path)
+            pb_logger.debug "Playing an audio file (#{path}) via Playback"
             op = current_actor
-            @call.send_agi_action! 'STREAM FILE', path, @interrupt_digits do |complete_event|
-              pb_logger.debug "STREAM FILE completed with #{complete_event}. Signalling to continue execution."
-              op.continue! complete_event
+            @call.send_agi_action! 'EXEC Playback', path do |complete_event|
+              pb_logger.debug "File playback completed with #{complete_event}. Sending complete event"
+              op.send_complete_event! success_reason
             end
           end
 
-          private
-
           def escaped_doc
             @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
           end
@@ -120,6 +108,13 @@ module Punchblock
             end.join '&'
           end
 
+          def swift_doc
+            doc = escaped_doc
+            doc << "|1|1" if [:any, :dtmf].include? @component_node.interrupt_on
+            doc.insert 0, "#{@component_node.voice}^" if @component_node.voice
+            doc
+          end
+
           def success_reason
             Punchblock::Component::Output::Complete::Success.new
           end

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

@@ -14,6 +14,7 @@ module Punchblock
           def execute
             max_duration = @component_node.max_duration || -1
 
+            raise OptionError, 'Record cannot be used on a call that is not answered.' unless @call.answered?
             raise OptionError, 'A start-paused value of true is unsupported.' if @component_node.start_paused
             raise OptionError, 'An initial-timeout value is unsupported.' if @component_node.initial_timeout && @component_node.initial_timeout != -1
             raise OptionError, 'A final-timeout value is unsupported.' if @component_node.final_timeout && @component_node.final_timeout != -1
@@ -21,7 +22,6 @@ module Punchblock
 
             @format = @component_node.format || 'wav'
 
-            @call.answer_if_not_answered
 
             component = current_actor
             call.register_handler :ami, :name => 'MonitorStop' do |event|

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

@@ -9,12 +9,15 @@ module Punchblock
         module StopByRedirect
           def execute_command(command)
             return super unless command.is_a?(Punchblock::Component::Stop)
+            stop_by_redirect Punchblock::Event::Complete::Stop.new
+            command.response = true
+          end
 
+          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! Punchblock::Event::Complete::Stop.new
+              component_actor.send_complete_event! complete_reason
             end
-            command.response = true
             call.redirect_back!
           end
         end

data/lib/punchblock/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Punchblock
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/punchblock.gemspec

@@ -29,13 +29,13 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<future-resource>, ["~> 1.0"]
   s.add_runtime_dependency %q<has-guarded-handlers>, ["~> 1.0"]
   s.add_runtime_dependency %q<celluloid>, [">= 0.10.0"]
-  s.add_runtime_dependency %q<ruby_ami>, ["~> 1.0"]
+  s.add_runtime_dependency %q<ruby_ami>, ["~> 1.2", ">= 1.2.1"]
   s.add_runtime_dependency %q<ruby_speech>, ["~> 1.0"]
 
-  s.add_development_dependency %q<bundler>, [">= 1.0.0"]
-  s.add_development_dependency %q<rspec>, ["~> 2.7.0"]
-  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
-  s.add_development_dependency %q<yard>, [">= 0.6.0"]
+  s.add_development_dependency %q<bundler>, ["~> 1.0"]
+  s.add_development_dependency %q<rspec>, ["~> 2.7"]
+  s.add_development_dependency %q<ci_reporter>, ["~> 1.6"]
+  s.add_development_dependency %q<yard>, ["~> 0.6"]
   s.add_development_dependency %q<rake>, [">= 0"]
   s.add_development_dependency %q<mocha>, [">= 0"]
   s.add_development_dependency %q<i18n>, [">= 0"]

data/spec/punchblock/command/reject_spec.rb

@@ -37,7 +37,7 @@ module Punchblock
       end
 
       describe "with the reason" do
-        [:decline, :busy, :error].each do |reason|
+        [nil, :decline, :busy, :error].each do |reason|
           describe reason do
             subject { Reject.new :reason => reason }
 
@@ -45,6 +45,12 @@ module Punchblock
           end
         end
 
+        describe "no reason" do
+          subject { Reject.new }
+
+          its(:reason) { should be_nil }
+        end
+
         describe "blahblahblah" do
           it "should raise an error" do
             expect { Reject.new(:reason => :blahblahblah) }.to raise_error ArgumentError

data/spec/punchblock/command_node_spec.rb

@@ -5,6 +5,11 @@ require 'spec_helper'
 module Punchblock
   module Command
     describe CommandNode do
+      let(:args) { [] }
+      subject do
+        Class.new(described_class) { register 'foo'}.new(*args)
+      end
+
       its(:state_name) { should be == :new }
 
       describe "#new" do
@@ -13,8 +18,6 @@ module Punchblock
           let(:component_id)  { 'abc123' }
           let(:args)          { [{:target_call_id => call_id, :component_id => component_id}] }
 
-          subject { CommandNode.new(*args) }
-
           its(:target_call_id)  { should be == call_id }
           its(:component_id)    { should be == component_id }
         end

data/spec/punchblock/component/component_node_spec.rb

@@ -5,6 +5,10 @@ require 'spec_helper'
 module Punchblock
   module Component
     describe ComponentNode do
+      subject do
+        Class.new(described_class) { register 'foo'}.new
+      end
+
       it { should be_new }
 
       describe "#add_event" do

data/spec/punchblock/component/output_spec.rb

@@ -230,7 +230,7 @@ module Punchblock
           describe '#seek_action' do
             subject { command.seek_action seek_options }
 
-            its(:to_xml) { should be == '<seek xmlns="urn:xmpp:rayo:output:1" direction="forward" amount="1500"/>' }
+            its(:to_xml) { should be == Nokogiri::XML('<seek xmlns="urn:xmpp:rayo:output:1" direction="forward" amount="1500"/>').root.to_xml }
             its(:component_id) { should be == 'abc123' }
             its(:target_call_id) { should be == '123abc' }
           end

data/spec/punchblock/component/record_spec.rb

@@ -154,6 +154,36 @@ module Punchblock
           end
         end
 
+          context "direct recording accessors" do
+            let :stanza do
+          <<-MESSAGE
+<complete xmlns='urn:xmpp:rayo:ext:1'>
+<success xmlns='urn:xmpp:rayo:record:complete:1'/>
+<recording xmlns='urn:xmpp:rayo:record:complete:1' uri="file:/tmp/rayo7451601434771683422.mp3" duration="34000" size="23450"/>
+</complete>
+          MESSAGE
+            end
+            let(:event) { RayoNode.import(parse_stanza(stanza).root) }
+
+            before do
+              subject.request!
+              subject.execute!
+              subject.add_event event
+            end
+
+            describe "#recording" do
+              it "should be a Punchblock::Component::Record::Recording" do
+                subject.recording.should be_a Punchblock::Component::Record::Recording
+              end
+            end
+
+            describe "#recording_uri" do
+              it "should be the recording URI set earlier" do
+                subject.recording_uri.should be == "file:/tmp/rayo7451601434771683422.mp3"
+              end
+            end
+          end
+
         describe '#stop_action' do
           subject { command.stop_action }