punchblock 0.7.1 → 0.7.2

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

@@ -10,6 +10,41 @@ module Punchblock
           include Celluloid
 
           attr_reader :id
+
+          def initialize(component_node, call = nil)
+            @component_node, @call = component_node, call
+            @id = UUIDTools::UUID.random_create.to_s
+            setup
+            pb_logger.debug "Starting up..."
+          end
+
+          def setup
+          end
+
+          def set_node_response(value)
+            pb_logger.debug "Setting response on component node to #{value}"
+            @component_node.response = value
+          end
+
+          def send_ref
+            set_node_response Ref.new :id => id
+          end
+
+          def with_error(name, text)
+            set_node_response ProtocolError.new(name, text)
+          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}"
+            @component_node.add_event event
+          end
         end
       end
     end

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

@@ -7,6 +7,7 @@ module Punchblock
 
           autoload :AGICommand
           autoload :AMIAction
+          autoload :Output
         end
       end
     end

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

@@ -1,4 +1,5 @@
 require 'uri'
+require 'active_support/core_ext/string/filters'
 
 module Punchblock
   module Translator
@@ -8,11 +9,8 @@ module Punchblock
           class AGICommand < Component
             attr_reader :action
 
-            def initialize(component_node, call)
-              @component_node, @call = component_node, call
-              @id = UUIDTools::UUID.random_create.to_s
+            def setup
               @action = create_action
-              pb_logger.debug "Starting up..."
             end
 
             def execute
@@ -40,42 +38,35 @@ module Punchblock
             private
 
             def create_action
-              RubyAMI::Action.new 'AGI', 'Channel' => @call.channel, 'Command' => @component_node.name, 'CommandID' => id do |response|
+              RubyAMI::Action.new 'AGI', 'Channel' => @call.channel, 'Command' => agi_command, 'CommandID' => id do |response|
                 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 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
+                send_ref
               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

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

@@ -7,10 +7,13 @@ module Punchblock
             attr_reader :action
 
             def initialize(component_node, translator)
-              @component_node, @translator = component_node, translator
+              super
+              @translator = translator
+            end
+
+            def setup
               @action = create_action
               @id = @action.action_id
-              pb_logger.debug "Starting up..."
             end
 
             def execute
@@ -34,10 +37,6 @@ module Punchblock
               @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
@@ -60,12 +59,6 @@ module Punchblock
               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|
@@ -82,12 +75,6 @@ module Punchblock
               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

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

@@ -0,0 +1,94 @@
+require 'active_support/core_ext/string/filters'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module Asterisk
+          class Output < Component
+
+            def setup
+              @media_engine = @call.translator.media_engine
+            end
+
+            def execute
+              return with_error 'option error', 'An SSML document is required.' unless @component_node.ssml
+
+              return with_error 'option error', 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
+
+              [:start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time].each do |opt|
+                return with_error 'option error', "A #{opt} value is unsupported on Asterisk." if @component_node.send opt
+              end
+
+              case @media_engine
+              when :asterisk, nil
+                return with_error 'option error', "A voice value is unsupported on Asterisk." if @component_node.voice
+
+                @execution_elements = @component_node.ssml.children.map do |node|
+                  case node
+                  when RubySpeech::SSML::Audio
+                    lambda { current_actor.play_audio! node.src }
+                  end
+                end.compact
+
+                @pending_actions = @execution_elements.count
+
+                send_ref
+
+                @interrupt_digits = '0123456789*#' if [:any, :dtmf].include? @component_node.interrupt_on
+
+                @execution_elements.each do |element|
+                  element.call
+                  wait :continue
+                  process_playback_completion
+                end
+              when :unimrcp
+                doc = @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
+                send_ref
+                @call.send_agi_action! 'EXEC MRCPSynth', doc, mrcpsynth_options do |complete_event|
+                  pb_logger.debug "MRCPSynth completed with #{complete_event}."
+                  send_event complete_event(success_reason)
+                end
+              end
+            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_event 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"
+              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
+              end
+            end
+
+            private
+
+            def mrcpsynth_options
+              [].tap do |opts|
+                opts << 'i=any' if [:any, :dtmf].include? @component_node.interrupt_on
+                opts << "v=#{@component_node.voice}" if @component_node.voice
+              end.join '&'
+            end
+
+            def success_reason
+              Punchblock::Component::Output::Complete::Success.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

data/punchblock.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<has-guarded-handlers>, [">= 0.1.0"]
   s.add_runtime_dependency %q<celluloid>, [">= 0.6.0"]
   s.add_runtime_dependency %q<ruby_ami>, [">= 0.1.3"]
+  s.add_runtime_dependency %q<ruby_speech>, [">= 0.3.4"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
   s.add_development_dependency %q<rspec>, [">= 2.5.0"]

data/spec/punchblock/command/join_spec.rb

@@ -9,10 +9,10 @@ module Punchblock
       end
 
       describe "when setting options in initializer" do
-        subject { Join.new :other_call_id => 'abc123', :mixer_id => 'blah', :direction => :duplex, :media => :bridge }
+        subject { Join.new :other_call_id => 'abc123', :mixer_name => 'blah', :direction => :duplex, :media => :bridge }
 
         its(:other_call_id) { should == 'abc123' }
-        its(:mixer_id)      { should == 'blah' }
+        its(:mixer_name)    { should == 'blah' }
         its(:direction)     { should == :duplex }
         its(:media)         { should == :bridge }
       end
@@ -22,7 +22,7 @@ module Punchblock
           <<-MESSAGE
 <join xmlns="urn:xmpp:rayo:1"
       call-id="abc123"
-      mixer-id="blah"
+      mixer-name="blah"
       direction="duplex"
       media="bridge" />
           MESSAGE
@@ -33,7 +33,7 @@ module Punchblock
         it { should be_instance_of Join }
 
         its(:other_call_id) { should == 'abc123' }
-        its(:mixer_id)      { should == 'blah' }
+        its(:mixer_name)    { should == 'blah' }
         its(:direction)     { should == :duplex }
         its(:media)         { should == :bridge }
       end

data/spec/punchblock/command/unjoin_spec.rb

@@ -9,10 +9,10 @@ module Punchblock
       end
 
       describe "when setting options in initializer" do
-        subject { Unjoin.new :other_call_id => 'abc123', :mixer_id => 'blah' }
+        subject { Unjoin.new :other_call_id => 'abc123', :mixer_name => 'blah' }
 
         its(:other_call_id) { should == 'abc123' }
-        its(:mixer_id)      { should == 'blah' }
+        its(:mixer_name)    { should == 'blah' }
       end
 
       describe "from a stanza" do
@@ -20,7 +20,7 @@ module Punchblock
           <<-MESSAGE
 <unjoin xmlns="urn:xmpp:rayo:1"
       call-id="abc123"
-      mixer-id="blah" />
+      mixer-name="blah" />
           MESSAGE
         end
 
@@ -29,7 +29,7 @@ module Punchblock
         it { should be_instance_of Unjoin }
 
         its(:other_call_id) { should == 'abc123' }
-        its(:mixer_id)      { should == 'blah' }
+        its(:mixer_name)    { should == 'blah' }
       end
     end
   end

data/spec/punchblock/component/input_spec.rb

@@ -81,9 +81,19 @@ module Punchblock
         its(:min_confidence)      { should == 0.5 }
       end
 
+      def grxml_doc(mode = :dtmf)
+        RubySpeech::GRXML.draw :mode => mode.to_s, :root => 'digits' do
+          rule id: 'digits' do
+            one_of do
+              0.upto(1) { |d| item { d.to_s } }
+            end
+          end
+        end
+      end
+
       describe Input::Grammar do
-        describe "when not passing a grammar" do
-          subject { Input::Grammar.new :value => '[5 DIGITS]' }
+        describe "when not passing a content type" do
+          subject { Input::Grammar.new :value => grxml_doc }
           its(:content_type) { should == 'application/grammar+grxml' }
         end
 
@@ -98,40 +108,27 @@ module Punchblock
         end
 
         describe 'with a GRXML grammar' do
-          subject { Input::Grammar.new :value => grxml, :content_type => 'application/grammar+grxml' }
-
-          let :grxml do
-            <<-GRXML
-<grammar xmlns="http://www.w3.org/2001/06/grammar" root="MAINRULE">
-<rule id="MAINRULE">
-  <one-of>
-    <item>
-      <item repeat="0-1"> need a</item>
-      <item repeat="0-1"> i need a</item>
-        <one-of>
-          <item> clue </item>
-        </one-of>
-      <tag> out.concept = "clue";</tag>
-    </item>
-    <item>
-      <item repeat="0-1"> have an</item>
-      <item repeat="0-1"> i have an</item>
-        <one-of>
-          <item> answer </item>
-        </one-of>
-      <tag> out.concept = "answer";</tag>
-    </item>
-  </one-of>
-</rule>
-</grammar>
-            GRXML
-          end
+          subject { Input::Grammar.new :value => grxml_doc, :content_type => 'application/grammar+grxml' }
 
-          let(:expected_message) { "<![CDATA[ #{grxml} ]]>" }
+          its(:content_type) { should == 'application/grammar+grxml' }
+
+          let(:expected_message) { "<![CDATA[ #{grxml_doc} ]]>" }
 
           it "should wrap GRXML in CDATA" do
             subject.child.to_xml.should == expected_message.strip
           end
+
+          its(:value) { should == grxml_doc }
+
+          describe "comparison" do
+            let(:grammar2) { Input::Grammar.new :value => '<grammar xmlns="http://www.w3.org/2001/06/grammar" version="1.0" xml:lang="en-US" mode="dtmf" root="digits"><rule id="digits"><one-of><item>0</item><item>1</item></one-of></rule></grammar>' }
+            let(:grammar3) { Input::Grammar.new :value => grxml_doc }
+            let(:grammar4) { Input::Grammar.new :value => grxml_doc(:speech) }
+
+            it { should == grammar2 }
+            it { should == grammar3 }
+            it { should_not == grammar4 }
+          end
         end
       end
 

data/spec/punchblock/component/output_spec.rb

@@ -7,6 +7,16 @@ module Punchblock
         RayoNode.class_from_registration(:output, 'urn:xmpp:rayo:output:1').should == Output
       end
 
+      describe 'default values' do
+        its(:interrupt_on)     { should be nil }
+        its(:start_offset)     { should be nil }
+        its(:start_paused)     { should be false }
+        its(:repeat_interval)  { should be nil }
+        its(:repeat_times)     { should be nil }
+        its(:max_time)         { should be nil }
+        its(:voice)            { should be nil }
+      end
+
       describe "when setting options in initializer" do
         subject do
           Output.new  :interrupt_on     => :speech,
@@ -63,18 +73,26 @@ module Punchblock
       end
 
       describe "for SSML" do
-        subject { Output.new :ssml => '<output-as interpret-as="ordinal">100</output-as>', :voice => 'kate' }
+        def ssml_doc(mode = :ordinal)
+          RubySpeech::SSML.draw do
+            say_as(:interpret_as => mode) { 100 }
+          end
+        end
+
+        subject { Output.new :ssml => ssml_doc, :voice => 'kate' }
 
         its(:voice) { should == 'kate' }
 
-        its(:ssml) { should == '<output-as interpret-as="ordinal">100</output-as>' }
+        its(:ssml) { should == ssml_doc }
 
         describe "comparison" do
-          let(:output2) { Output.new :ssml => '<output-as interpret-as="ordinal">100</output-as>', :voice => 'kate'  }
-          let(:output3) { Output.new :ssml => '<output-as interpret-as="number">100</output-as>', :voice => 'kate'  }
+          let(:output2) { Output.new :ssml => '<speak xmlns="http://www.w3.org/2001/10/synthesis" version="1.0" xml:lang="en-US"><say-as interpret-as="ordinal"/></speak>', :voice => 'kate'  }
+          let(:output3) { Output.new :ssml => ssml_doc, :voice => 'kate'  }
+          let(:output4) { Output.new :ssml => ssml_doc(:normal), :voice => 'kate'  }
 
           it { should == output2 }
-          it { should_not == output3 }
+          it { should == output3 }
+          it { should_not == output4 }
         end
       end