punchblock 1.9.4 → 2.0.0.beta1

data/lib/punchblock/ref.rb

@@ -1,34 +1,55 @@
 # encoding: utf-8
 
+require 'ruby_jid'
+
 module Punchblock
   ##
-  # An rayo Ref message. This provides the command ID in response to execution of a command.
+  # A rayo Ref message. This provides the command ID in response to execution of a command.
   #
   class Ref < RayoNode
     register :ref, :core
 
-    def self.new(options = {})
-      super().tap do |new_node|
-        options.each_pair { |k,v| new_node.send :"#{k}=", v }
+    # @return [String] the command URI
+    attribute :uri
+    def uri=(other)
+      super URI(other)
+    end
+
+    def scheme
+      uri.scheme
+    end
+
+    def call_id
+      case scheme
+      when 'xmpp'
+        RubyJID.new(uri.opaque).node
+      when nil
+        uri.path
+      else
+        uri.opaque
       end
     end
 
-    ##
-    # @return [String] the command ID
-    #
-    def id
-      read_attr :id
+    def domain
+      case scheme
+      when 'xmpp'
+        RubyJID.new(uri.opaque).domain
+      end
     end
 
-    ##
-    # @param [String] ref_id the command ID
-    #
-    def id=(ref_id)
-      write_attr :id, ref_id
+    def component_id
+      case scheme
+      when 'xmpp'
+        RubyJID.new(uri.opaque).resource
+      else
+        call_id
+      end
     end
 
-    def inspect_attributes # :nodoc:
-      [:id] + super
+    def rayo_attributes
+      {}.tap do |atts|
+        atts[:uri] = uri if uri
+      end
     end
-  end # Offer
-end # Punchblock
+  end
+end

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

@@ -0,0 +1,15 @@
+module Punchblock
+  module Translator
+    class Asterisk
+      class AGIApp
+        def initialize(app, *args)
+          @app, @args = app, args
+        end
+
+        def execute(call)
+          call.execute_agi_command "EXEC #{@app}", @args.join(',')
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'active_support/core_ext/string/filters'
+require 'punchblock/translator/asterisk/ami_error_converter'
 
 module Punchblock
   module Translator
@@ -14,8 +15,9 @@ module Punchblock
           @id, @channel, @command, @params = id, channel, command, params
         end
 
+        # @raises RubyAMI::Error, ChannelGoneError
         def execute(ami_client)
-          ami_client.send_action 'AGI', 'Channel' => @channel, 'Command' => agi_command, 'CommandID' => id
+          AMIErrorConverter.convert { ami_client.send_action 'AGI', 'Channel' => @channel, 'Command' => agi_command, 'CommandID' => id }
         end
 
         def parse_result(event)

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

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module AMIErrorConverter
+        def self.convert
+          yield
+        rescue RubyAMI::Error => e
+          case e.message
+          when 'No such channel', /Channel (\S+) does not exist./
+            raise ChannelGoneError, e.message
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'punchblock/translator/asterisk/ami_error_converter'
+
 module Punchblock
   module Translator
     class Asterisk
@@ -11,6 +13,8 @@ module Punchblock
         extend ActorHasGuardedHandlers
         execute_guarded_handlers_on_receiver
 
+        InvalidCommandError = Class.new Punchblock::Error
+
         attr_reader :id, :channel, :translator, :agi_env, :direction
 
         HANGUP_CAUSE_TO_END_REASON = Hash.new { :error }
@@ -34,6 +38,7 @@ module Punchblock
           @progress_sent = false
           @block_commands = false
           @channel_variables = {}
+          @hangup_cause = nil
         end
 
         def register_component(component)
@@ -79,7 +84,7 @@ module Punchblock
                                                                               :params => params
           originate_action.request!
           translator.async.execute_global_command originate_action
-          dial_command.response = Ref.new :id => id
+          dial_command.response = Ref.new uri: id
         end
 
         def outbound?
@@ -105,11 +110,11 @@ module Punchblock
         end
 
         def process_ami_event(ami_event)
-          send_pb_event Event::Asterisk::AMI::Event.new(:name => ami_event.name, :attributes => ami_event.headers)
+          send_pb_event Event::Asterisk::AMI::Event.new(name: ami_event.name, headers: ami_event.headers)
 
           case ami_event.name
           when 'Hangup'
-            handle_hangup_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
+            handle_hangup_event ami_event['Cause'].to_i
           when 'AsyncAGI'
             if component = component_with_id(ami_event['CommandID'])
               component.handle_ami_event ami_event
@@ -135,23 +140,16 @@ module Punchblock
             if other_call = translator.call_for_channel(other_call_channel)
               event = case ami_event['Bridgestate']
               when 'Link'
-                Event::Joined.new.tap do |e|
-                  e.call_id = other_call.id
-                end
+                Event::Joined.new call_uri: other_call.id
               when 'Unlink'
-                Event::Unjoined.new.tap do |e|
-                  e.call_id = other_call.id
-                end
+                Event::Unjoined.new call_uri: other_call.id
               end
               send_pb_event event
             end
           when 'Unlink'
             other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
             if other_call = translator.call_for_channel(other_call_channel)
-              event = Event::Unjoined.new.tap do |e|
-                e.call_id = other_call.id
-              end
-              send_pb_event event
+              send_pb_event Event::Unjoined.new(call_uri: other_call.id)
             end
           when 'VarSet'
             @channel_variables[ami_event['Variable']] = ami_event['Value']
@@ -184,28 +182,28 @@ module Punchblock
             @answered = true
             command.response = true
           when Command::Hangup
-            send_ami_action 'Hangup', 'Channel' => channel, 'Cause' => 16
+            send_hangup_command
+            @hangup_cause = :hangup_command
             command.response = true
           when Command::Join
-            other_call = translator.call_with_id command.call_id
+            other_call = translator.call_with_id command.call_uri
             @pending_joins[other_call.channel] = command
             execute_agi_command 'EXEC Bridge', other_call.channel
           when Command::Unjoin
-            other_call = translator.call_with_id command.call_id
+            other_call = translator.call_with_id command.call_uri
             redirect_back other_call
             command.response = true
           when Command::Reject
-            rejection = case command.reason
+            case command.reason
             when :busy
-              'EXEC Busy'
+              execute_agi_command 'EXEC Busy'
             when :decline
-              'EXEC Busy'
+              send_hangup_command 21
             when :error
-              'EXEC Congestion'
+              execute_agi_command 'EXEC Congestion'
             else
-              'EXEC Congestion'
+              execute_agi_command 'EXEC Congestion'
             end
-            execute_agi_command rejection
             command.response = true
           when Punchblock::Component::Asterisk::AGI::Command
             execute_component Component::Asterisk::AGICommand, command
@@ -213,22 +211,40 @@ module Punchblock
             execute_component Component::Output, command
           when Punchblock::Component::Input
             execute_component Component::Input, command
+          when Punchblock::Component::Prompt
+            component_class = case command.input.recognizer
+            when 'unimrcp'
+              case command.output.renderer
+              when 'unimrcp'
+                Component::MRCPPrompt
+              when 'asterisk'
+                Component::MRCPNativePrompt
+              else
+                raise InvalidCommandError, 'Invalid recognizer/renderer combination'
+              end
+            else
+              Component::ComposedPrompt
+            end
+            execute_component component_class, command
           when Punchblock::Component::Record
             execute_component Component::Record, command
           else
             command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for call #{id}", id
           end
+        rescue InvalidCommandError => e
+          command.response = ProtocolError.new.setup :invalid_command, e.message, id
+        rescue ChannelGoneError
+          command.response = ProtocolError.new.setup :item_not_found, "Could not find a call with ID #{id}", id
         rescue RubyAMI::Error => e
-          command.response = case e.message
-          when 'No such channel'
-            ProtocolError.new.setup :item_not_found, "Could not find a call with ID #{id}", id
-          else
-            ProtocolError.new.setup 'error', e.message, id
-          end
+          command.response = ProtocolError.new.setup 'error', e.message, id
         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
 
+        #
+        # @return [Hash] AGI result
+        #
+        # @raises RubyAMI::Error, ChannelGoneError
         def execute_agi_command(command, *params)
           agi = AGICommand.new Punchblock.new_uuid, channel, command, *params
           condition = Celluloid::Condition.new
@@ -239,7 +255,7 @@ module Punchblock
           event = condition.wait
           return unless event
           agi.parse_result event
-        rescue RubyAMI::Error => e
+        rescue ChannelGoneError, RubyAMI::Error => e
           abort e
         end
 
@@ -263,14 +279,15 @@ module Punchblock
           send_ami_action 'Redirect', redirect_options
         end
 
-        def handle_hangup_event(reason = :hangup)
+        def handle_hangup_event(code = 16)
+          reason = @hangup_cause || HANGUP_CAUSE_TO_END_REASON[code]
           @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
+          send_end_event reason, code
         end
 
         def actor_died(actor, reason)
@@ -289,14 +306,18 @@ module Punchblock
           result['Value'] == '(null)' ? nil : result['Value']
         end
 
+        def send_hangup_command(cause_code = 16)
+          send_ami_action 'Hangup', 'Channel' => channel, 'Cause' => cause_code
+        end
+
         def send_ami_action(name, headers = {})
-          @ami_client.send_action name, headers
+          AMIErrorConverter.convert { @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
-          after(5) { shutdown }
+        def send_end_event(reason, code = nil)
+          send_pb_event Event::End.new(reason: reason, platform_code: code)
+          translator.deregister_call id, channel
+          terminate
         end
 
         def execute_component(type, command, options = {})
@@ -319,7 +340,7 @@ module Punchblock
 
         def sip_headers
           agi_env.to_a.inject({}) do |accumulator, element|
-            accumulator[('x_' + element[0].to_s).to_sym] = element[1] || ''
+            accumulator['X-' + element[0].to_s] = element[1] || ''
             accumulator
           end
         end
@@ -327,8 +348,8 @@ module Punchblock
         def variable_for_headers(headers)
           variables = { :punchblock_call_id => id }
           header_counter = 51
-          headers.each do |header|
-            variables["SIPADDHEADER#{header_counter}"] = "\"#{header.name}: #{header.value}\""
+          headers.each do |name, value|
+            variables["SIPADDHEADER#{header_counter}"] = "\"#{name}: #{value}\""
             header_counter += 1
           end
           variables.inject([]) do |a, (k, v)|

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

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Punchblock
+  module Translator
+    class Asterisk
+      class Channel < SimpleDelegator
+        NORMALIZATION_REGEXP = /^(?<prefix>Bridge\/)*(?<name>[^<>]*)(?<suffix><.*>)*$/.freeze
+
+        def self.new(other)
+          other.is_a?(self) ? other : super
+        end
+
+        def name
+          matchdata[:name]
+        end
+
+        def prefix
+          matchdata[:prefix]
+        end
+
+        def suffix
+          matchdata[:suffix]
+        end
+
+        def bridged?
+          @bridged ||= (prefix || suffix)
+        end
+
+        def to_s
+          __getobj__
+        end
+
+        private
+
+        def matchdata
+          @matchdata ||= __getobj__.match(NORMALIZATION_REGEXP)
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Punchblock
         module Asterisk
           class AGICommand < Component
             def setup
-              @agi = Punchblock::Translator::Asterisk::AGICommand.new id, @call.channel, @component_node.name, *@component_node.params_array
+              @agi = Punchblock::Translator::Asterisk::AGICommand.new id, @call.channel, @component_node.name, *@component_node.params
             end
 
             def execute
@@ -16,6 +16,9 @@ module Punchblock
             rescue RubyAMI::Error
               set_node_response false
               terminate
+            rescue ChannelGoneError
+              set_node_response ProtocolError.new.setup(:item_not_found, "Could not find a call with ID #{call_id}", call_id)
+              terminate
             end
             exclusive :execute
 

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

@@ -29,14 +29,14 @@ module Punchblock
             end
 
             def error_reason(response)
-              Punchblock::Event::Complete::Error.new :details => response.message
+              Punchblock::Event::Complete::Error.new details: response.message
             end
 
             def success_reason(response, final_event = nil)
               headers = response.headers
               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
+              Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new message: headers.delete('Message'), text_body: response.text_body, headers: headers
             end
 
             def send_events(response)
@@ -50,12 +50,12 @@ module Punchblock
             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
+              Event::Asterisk::AMI::Event.new name: ami_event.name, headers: headers
             end
 
             def action_headers
               headers = {}
-              @component_node.params_hash.each_pair do |key, value|
+              @component_node.params.each_pair do |key, value|
                 headers[key.to_s.capitalize] = value
               end
               headers

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

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        class ComposedPrompt < Component
+          include InputComponent
+          include StopByRedirect
+
+          def execute
+            validate
+            output_command.request!
+            setup_dtmf_recognizer
+
+            output_component = Output.new_link(output_command, @call)
+            call.register_component output_component
+            fut = output_component.future.execute
+
+            case output_command.response
+            when Ref
+              send_ref
+            else
+              set_node_response output_command.response
+            end
+
+            fut.value unless @component_node.barge_in # Block until output is complete
+
+            register_dtmf_event_handler
+            start_timers
+          end
+
+          def process_dtmf(digit)
+            call.async.redirect_back if @component_node.barge_in
+            super
+          end
+
+          def output_command
+            @output_command ||= @component_node.output
+          end
+
+          private
+
+          def input_node
+            @input_node ||= @component_node.input
+          end
+
+          def register_dtmf_event_handler
+            component = current_actor
+            @dtmf_handler_id = call.register_handler :ami, :name => 'DTMF', [:[], 'End'] => 'Yes' do |event|
+              component.process_dtmf event['Digit']
+            end
+          end
+
+          def unregister_dtmf_event_handler
+            call.async.unregister_handler :ami, @dtmf_handler_id if instance_variable_defined?(:@dtmf_handler_id)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,7 @@ module Punchblock
           def execute
             @call.send_progress
             super
+            @dtmf_handler_id = register_dtmf_event_handler
           end
 
           private

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

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        class MRCPNativePrompt < Component
+          include StopByRedirect
+          include MRCPRecogPrompt
+
+          private
+
+          def validate
+            raise OptionError, "The renderer #{renderer} is unsupported." unless renderer == 'asterisk'
+            raise OptionError, "The recognizer #{recognizer} is unsupported." unless recognizer == 'unimrcp'
+
+            raise OptionError, 'A document is required.' unless output_node.render_documents.count > 0
+            raise OptionError, 'Only one document is allowed.' if output_node.render_documents.count > 1
+            raise OptionError, 'Only inline documents are allowed.' if first_doc.url
+            raise OptionError, 'Only one audio file is allowed.' if first_doc.value.size > 1
+
+            raise OptionError, 'A grammar is required.' unless input_node.grammars.count > 0
+
+            super
+          end
+
+          def renderer
+            (output_node.renderer || :asterisk).to_s
+          end
+
+          def recognizer
+            (input_node.recognizer || :unimrcp).to_s
+          end
+
+          def execute_unimrcp_app
+            execute_app 'MRCPRecog', grammars
+          end
+
+          def first_doc
+            output_node.render_documents.first
+          end
+
+          def audio_filename
+            first_doc.value.first
+          end
+
+          def unimrcp_app_options
+            super do |opts|
+              opts[:f] = audio_filename
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        class MRCPPrompt < Component
+          include StopByRedirect
+          include MRCPRecogPrompt
+
+          private
+
+          def validate
+            raise OptionError, "The renderer #{renderer} is unsupported." unless renderer == 'unimrcp'
+            raise OptionError, "The recognizer #{recognizer} is unsupported." unless recognizer == 'unimrcp'
+            raise OptionError, 'An SSML document is required.' unless output_node.render_documents.count > 0
+            raise OptionError, 'A grammar is required.' unless input_node.grammars.count > 0
+
+            super
+          end
+
+          def renderer
+            (output_node.renderer || :unimrcp).to_s
+          end
+
+          def recognizer
+            (input_node.recognizer || :unimrcp).to_s
+          end
+
+          def execute_unimrcp_app
+            execute_app 'SynthAndRecog', render_docs, grammars
+          end
+
+          def render_docs
+            output_node.render_documents.map do |d|
+              if d.content_type
+                d.value.to_doc.to_s
+              else
+                d.url
+              end
+            end.join ','
+          end
+
+          def unimrcp_app_options
+            super do |opts|
+              opts[:vn] = output_node.voice if output_node.voice
+            end
+          end
+        end
+      end
+    end
+  end
+end