punchblock 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1695be81bb0d8afb829d648392c00705f8ec56a
-  data.tar.gz: 1a2fd855be244f16d1858b00aeca5309bd865af8
+  metadata.gz: 1152b11b0e04b0b908129ed719d27c5d82c3e840
+  data.tar.gz: 8680c53051c70725c6b3aeb1b1fd05af8e416ceb
 SHA512:
-  metadata.gz: 8fc40e0dbcad7bf5435a1fff4e37a3237c0768cea38bab9bdacc5bcce20df41baf74cff01160a3a39db566198c92a049461ebcd7e9f8152ace80d05b65be23a4
-  data.tar.gz: 43917ff261fa61ddfce65cc0260e07a04d7b673d59bce5fc73149ab8e29056e9fbb04747bafcd8fba949274ad4fef45453e7ba36347d2da3d733997b7cff5434
+  metadata.gz: 26766a491387d61395c7ebb9cd6302ee7e0ac0c981ec6043b83f5ee098cb11684711b147e4094b2ad7da1c20d23fa9a2e5f39521f7197e90eeb8a1e4d360da92
+  data.tar.gz: e214e5d8e43088da4105ce7c3f4b20cba314440208cddfcf19887d6386ac517598e9cd7c151735e851abc20c6a93f1d73af589330ad40f71d14bb33ab866af7b

data/.travis.yml

@@ -3,8 +3,9 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.1.1
   - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # [develop](https://github.com/adhearsion/punchblock)
 
+# [v2.2.0](https://github.com/adhearsion/punchblock/compare/v2.1.1...v2.2.0) - [2014-01-15](https://rubygems.org/gems/punchblock/versions/2.2.0)
+  * Feature: Support Rayo CPA and Fax specifications
+  * Feature: Implement a simple filter for AMI events -> Rayo events in `Punchblock::Translator::Asterisk.event_filter=`
+  * Feature: Output on Asterisk supports a new `:native_or_unimrcp` renderer which allows for fallback of output rendering from Asterisk native when possible, to a TTS engine when it's not.
+  * Feature: Support output `repeat-times` on Asterisk.
+  * Bugfix: Remove per-call/component actors from Asterisk translator for performance/stability super-charge
+
 # [v2.1.1](https://github.com/adhearsion/punchblock/compare/v2.1.0...v2.1.1) - [2013-12-19](https://rubygems.org/gems/punchblock/versions/2.1.1)
   * Bugfix: Allow sending string SSML docs via Rayo
   * Bugfix: Ensure that joined calls on Asterisk do not have implicitly linked lifecycles. Previously, joinees would be hungup when the joiner exited the bridge.

data/lib/punchblock.rb

@@ -75,7 +75,7 @@ module Punchblock
   RAYO_VERSION            = '1'
   RAYO_NAMESPACES         = {:core => [BASE_RAYO_NAMESPACE, RAYO_VERSION].compact.join(':')}
 
-  [:ext, :record, :output, :input, :prompt].each do |ns|
+  [:ext, :record, :output, :input, :prompt, :cpa, :fax].each do |ns|
     RAYO_NAMESPACES[ns] = [BASE_RAYO_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
     RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_RAYO_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
   end

data/lib/punchblock/component.rb

@@ -9,7 +9,9 @@ module Punchblock
     autoload :Input
     autoload :Output
     autoload :Prompt
+    autoload :ReceiveFax
     autoload :Record
+    autoload :SendFax
     autoload :Stop
 
     InvalidActionError = Class.new StandardError

data/lib/punchblock/component/input.rb

@@ -98,7 +98,7 @@ module Punchblock
         end
 
         def rayo_children(root)
-          root.cdata value
+          root.cdata value if value
         end
 
         private
@@ -108,6 +108,14 @@ module Punchblock
         end
       end
 
+      class Signal < Event::Complete::Reason
+        register :signal, :cpa
+
+        attribute :type, String
+        attribute :duration, Integer
+        attribute :value, String
+      end
+
       class Complete
         class Match < Event::Complete::Reason
           register :match, :input_complete

data/lib/punchblock/component/output.rb

@@ -80,7 +80,7 @@ module Punchblock
       attribute :start_offset, Integer
 
       # @return [true, false] Indicates wether or not the component should be started in a paused state to be resumed at a later time.
-      attribute :start_paused, Boolean, default: false
+      attribute :start_paused, Boolean
 
       # @return [Integer] Indicates the duration of silence that should space repeats of the rendered document.
       attribute :repeat_interval, Integer

data/lib/punchblock/component/receive_fax.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Punchblock
+  module Component
+    class ReceiveFax < ComponentNode
+      register :receivefax, :fax
+
+      class Fax < RayoNode
+        register :fax, :fax_complete
+
+        attribute :url, String
+        attribute :resolution, String
+        attribute :pages, Integer
+        attribute :size, Integer
+      end
+
+      class Complete
+        class Finish < Event::Complete::Reason
+          register :finish, :fax_complete
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/component/send_fax.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+module Punchblock
+  module Component
+    class SendFax < ComponentNode
+      register :sendfax, :fax
+
+      class FaxDocument < RayoNode
+        register :document, :fax
+
+        attribute :url, String
+        attribute :identity, String
+        attribute :header, String
+        attribute :pages, String
+
+        def inherit(xml_node)
+          super
+          if pages = xml_node[:pages]
+            self.pages = pages.split(',').map { |p| p.include?('-') ? Range.new(*p.split('-').map(&:to_i)) : p.to_i }
+          end
+          self
+        end
+
+        def rayo_attributes
+          {
+            'url'      => url,
+            'identity' => identity,
+            'header'   => header,
+            'pages'    => rayo_pages
+          }
+        end
+
+      private
+
+        def rayo_pages
+          pages ? pages.map { |p| p.is_a?(Range) ? "#{p.min}-#{p.max}" : p }.join(',') : nil
+        end
+      end
+
+      def inherit(xml_node)
+        document_nodes = xml_node.xpath 'ns:document', ns: self.class.registered_ns
+        self.render_documents = document_nodes.to_a.map { |node| FaxDocument.from_xml node }
+
+        super
+     end
+
+      def rayo_children(root)
+        render_documents.each do |render_document|
+          render_document.to_rayo root.parent
+        end
+        super
+      end
+
+      # @return [Document] the document to render
+      attribute :render_documents, Array[FaxDocument], default: []
+
+      def render_document=(other)
+        self.render_documents = [other].compact
+      end
+    end
+  end
+end

data/lib/punchblock/connection/asterisk.rb

@@ -21,7 +21,7 @@ module Punchblock
       end
 
       def stop
-        translator.async.shutdown
+        translator.terminate
         ami_client.terminate
       end
 

data/lib/punchblock/event/complete.rb

@@ -9,6 +9,9 @@ module Punchblock
 
       attribute :recording
 
+      attribute :fax
+      attribute :fax_metadata, Hash, default: {}
+
       def inherit(xml_node)
         if reason_node = xml_node.at_xpath('*')
           self.reason = RayoNode.from_xml(reason_node).tap do |reason|
@@ -24,11 +27,22 @@ module Punchblock
           end
         end
 
+        if fax_node = xml_node.at_xpath('//ns:fax', ns: RAYO_NAMESPACES[:fax_complete])
+          self.fax = RayoNode.from_xml(fax_node).tap do |fax|
+            fax.target_call_id = target_call_id
+            fax.component_id = component_id
+          end
+        end
+
+        xml_node.xpath('//ns:metadata', ns: RAYO_NAMESPACES[:fax_complete]).each do |md|
+          fax_metadata[md['name']] = md['value']
+        end
+
         super
       end
 
       class Reason < RayoNode
-        attribute :name
+        attribute :name, Symbol, default: ->(node,_) { node.class.registered_name.to_sym }
 
         def inherit(xml_node)
           self.name = xml_node.name.to_sym

data/lib/punchblock/translator/asterisk.rb

@@ -28,6 +28,23 @@ module Punchblock
 
       trap_exit :actor_died
 
+      # Set the AMI event filter to be applied to incoming AMI events. A truthy return value will send the event via Rayo to the client (Adhearsion).
+      #
+      # @param [#[<RubyAMI::Event>]] filter
+      #
+      # @example A lambda
+      #   Punchblock::Translator::Asterisk.event_filter = ->(event) { event.name == 'AsyncAGI' }
+      #
+      def self.event_filter=(filter)
+        @event_filter = filter
+      end
+
+      def self.event_passes_filter?(event)
+        @event_filter ? !!@event_filter[event] : true
+      end
+
+      event_filter = nil
+
       def initialize(ami_client, connection)
         @ami_client, @connection = ami_client, connection
         @calls, @components, @channel_to_call_id = {}, {}, {}
@@ -59,11 +76,6 @@ module Punchblock
         @components[component_id]
       end
 
-      def shutdown
-        @calls.values.each { |call| call.async.shutdown }
-        terminate
-      end
-
       def handle_ami_event(event)
         return unless event.is_a? RubyAMI::Event
 
@@ -77,11 +89,10 @@ module Punchblock
 
         ami_dispatch_to_or_create_call event
 
-        unless ami_event_known_call?(event)
+        if !ami_event_known_call?(event) && self.class.event_passes_filter?(event)
           handle_pb_event Event::Asterisk::AMI::Event.new(name: event.name, headers: event.headers)
         end
       end
-      exclusive :handle_ami_event
 
       def handle_pb_event(event)
         connection.handle_event event
@@ -104,7 +115,11 @@ module Punchblock
 
       def execute_call_command(command)
         if call = call_with_id(command.target_call_id)
-          call.async.execute_command command
+          begin
+            call.execute_command command
+          rescue => e
+            deregister_call call.id, call.channel
+          end
         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
@@ -112,7 +127,7 @@ module Punchblock
 
       def execute_component_command(command)
         if (component = component_with_id(command.component_id))
-          component.async.execute_command command
+          component.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
@@ -123,11 +138,11 @@ module Punchblock
         when Punchblock::Component::Asterisk::AMI::Action
           component = Component::Asterisk::AMIAction.new command, current_actor, ami_client
           register_component component
-          component.async.execute
+          component.execute
         when Punchblock::Command::Dial
-          call = Call.new_link command.to, current_actor, ami_client, connection
+          call = Call.new command.to, current_actor, ami_client, connection
           register_call call
-          call.async.dial command
+          call.dial command
         else
           command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command"
         end
@@ -182,7 +197,7 @@ module Punchblock
         if !calls_for_event.empty?
           calls_for_event.each_pair do |channel, call|
             next if channel.bridged? && !EVENTS_ALLOWED_BRIDGED.include?(event.name)
-            call.async.process_ami_event event
+            call.process_ami_event event
           end
         elsif event.name == "AsyncAGI" && event['SubEvent'] == "Start"
           handle_async_agi_start_event event
@@ -204,9 +219,9 @@ module Punchblock
 
         return if env[:agi_extension] == 'h' || env[:agi_type] == 'Kill'
 
-        call = Call.new_link event['Channel'], current_actor, ami_client, connection, env
+        call = Call.new event['Channel'], current_actor, ami_client, connection, env
         register_call call
-        call.async.send_offer
+        call.send_offer
       end
     end
   end

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

@@ -7,12 +7,8 @@ module Punchblock
     class Asterisk
       class Call
         include HasGuardedHandlers
-        include Celluloid
         include DeadActorSafety
 
-        extend ActorHasGuardedHandlers
-        execute_guarded_handlers_on_receiver
-
         InvalidCommandError = Class.new Punchblock::Error
 
         OUTBOUND_CHANNEL_MATCH = /.* <(?<channel>.*)>/.freeze
@@ -29,8 +25,6 @@ module Punchblock
         HANGUP_CAUSE_TO_END_REASON[22] = :reject
         HANGUP_CAUSE_TO_END_REASON[102] = :timeout
 
-        trap_exit :actor_died
-
         def initialize(channel, translator, ami_client, connection, agi_env = nil)
           @channel, @translator, @ami_client, @connection = channel, translator, ami_client, connection
           @agi_env = agi_env || {}
@@ -47,6 +41,10 @@ module Punchblock
           @components[component.id] ||= component
         end
 
+        def deregister_component(id)
+          @components.delete id
+        end
+
         def component_with_id(component_id)
           @components[component_id]
         end
@@ -56,10 +54,6 @@ module Punchblock
           send_pb_event offer_event
         end
 
-        def shutdown
-          terminate
-        end
-
         def channel_var(variable)
           @channel_variables[variable] || fetch_channel_var(variable)
         end
@@ -113,7 +107,9 @@ module Punchblock
         end
 
         def process_ami_event(ami_event)
-          send_pb_event Event::Asterisk::AMI::Event.new(name: ami_event.name, headers: ami_event.headers)
+          if Asterisk.event_passes_filter?(ami_event)
+            send_pb_event Event::Asterisk::AMI::Event.new(name: ami_event.name, headers: ami_event.headers)
+          end
 
           case ami_event.name
           when 'Hangup'
@@ -258,8 +254,6 @@ module Punchblock
           event = condition.wait
           return unless event
           agi.parse_result event
-        rescue ChannelGoneError, RubyAMI::Error => e
-          abort e
         end
 
         def logger_id
@@ -285,21 +279,14 @@ module Punchblock
         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
+          @components.each_pair do |id, component|
+            component.call_ended
           end
           send_end_event reason, code
         end
 
-        def actor_died(actor, reason)
-          if id = @components.key(actor)
-            @components.delete id
-            return unless reason
-            complete_event = Punchblock::Event::Complete.new :component_id => id, source_uri: id, :reason => Punchblock::Event::Complete::Error.new
-            send_pb_event complete_event
-          end
+        def after(*args, &block)
+          translator.after(*args, &block)
         end
 
         private
@@ -320,13 +307,12 @@ module Punchblock
         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 = {})
-          type.new_link(command, current_actor).tap do |component|
+          type.new(command, self).tap do |component|
             register_component component
-            component.async.execute
+            component.execute
           end
         end
 

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

@@ -17,14 +17,11 @@ module Punchblock
         autoload :StopByRedirect
 
         class Component
-          include Celluloid
-          include DeadActorSafety
-
           attr_reader :id, :call, :call_id
 
           def initialize(component_node, call = nil)
             @component_node, @call = component_node, call
-            @call_id = safe_from_dead_actors { call.id } if call
+            @call_id = call.id if call
             @id = Punchblock.new_uuid
             @complete = false
             setup
@@ -37,19 +34,19 @@ module Punchblock
             command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for component #{id}", call_id, id
           end
 
-          def send_complete_event(reason, recording = nil, should_terminate = true)
+          def send_complete_event(reason, recording = nil)
             return if @complete
             @complete = true
             event = Punchblock::Event::Complete.new reason: reason, recording: recording
             send_event event
-            terminate if should_terminate
+            call.deregister_component id if call
           end
 
           def send_event(event)
             event.component_id    = id
             event.target_call_id  = call_id
             event.source_uri      = id
-            safe_from_dead_actors { translator.handle_pb_event event }
+            translator.handle_pb_event event
           end
 
           def logger_id